From the Tools menu, select Manage Workflows
The Workflow manager allows for user defined workflows to be configured. You can define workflows at Version, Model, and Category levels.
Workflow Sets Pane
Icons | Description |
|---|---|
| Click to Add a workflow set to the list. When creating a new wrokflow you must select the type. |
| Click to Edit the selected workflow set. |
| Click to make a Copy of the selected workflow set. |
| Click to Delete the selected workflow set. |
| Click to move the selected workflow set a level Up. |
| Click to move the selected workflow set a level Down. |
| Click to Import a workflow set. |
| Click to Export a workflow set. |
Preview Pane
Icons | Description |
|---|---|
| Click to Add a button to the workflow set. |
Right Click > Delete | Click to Delete a button from the workflow set. |
Right Click > Move up/down | Click to Reorder buttons within the workflow set. |
Settings Pane
Fields | Description |
|---|---|
Name | Define a button name. |
Description | Provide a description for the button. |
Icon | Select an icon to associate with the button or upload your own PNG image file. (Maximum file size 250 kb.) |
| Type | When a Version workflow is selected you can choose a set of model conversions, a script, or WhereScape default. |
| Display | Display the buttons in the preview pane. |
Model Conversion Rules
The "Model Conversion Rules" workflow button type allows model conversion rules to be applied to existing models. This option is only available for version level workflow sets.
| Fields | Description |
|---|---|
| MCRs | Select the list of model conversion sets to be executed when the button is clicked in the order that they should be applied. |
| Create new model | If checked then the button will function similar to an Advanced Copy, otherwise the conversion sets will be applied without creating a new model. |
| Use original source mappings |
|
| Import hidden objects | This option enables hidden objects to be imported with the copied model and later on manipulated.
|
Workflow Scripts
The Script workflow button type allows scripts to be executed. Workflow scripts are defined in the Script & Template manager. Select the Refresh option to auto refresh the Repository Tree when a script is executed. This checkbox is available only when a Script type is selected. The following script environment variables are available to all workflow scripts.
Variable | Description |
|---|---|
WSL_BINDIR | The WhereScape 3D installation path. (The default location is 'C:\Program Files\WhereScape\WhereScape 3D'.) |
WSL_WORKDIR | The working directory where the script is executed. (The working directory will be in %UserProfile%\WhereScape\3D\scriptExecution.) |
WSL_TASK_NAME | A name used to identify the workflow task. |
WSL_SEQUENCE | A sequence id to identify each workflow process. |
WSL_WRKFL_Repo | The repository name associated with the object selected in the repositories pane. |
WSL_WRKFL_Category | The category name associated with the object selected in the repositories pane. |
WSL_WRKFL_Model | The model name associated with the object selected in the repositories pane. |
WSL_WRKFL_Version | The version name associated with the object selected in the repositories pane. |
WSL_WRKFL_Group | The group name associated with the object selected in the repositories pane. |
WSL_SCRIPT_<Script_Name>_CODE | The full path to the script specified. The script should be stored in the WhereScape 3D metadata and will be automatically copied to the working directory before the workflow script is executed. |
Validation Templates
The "Validation" workflow button type allows Validation templates to be executed against models. This option is only available for version level workflow sets.
WhereScape Default
Any of the standard WhereScape workflow buttons can be used within user configured workflow sets.