Figure: Model Management
The Model Management allows to view deployed models, as well as perform various operations on them. It displays disjoint models, referenced models (provider) as well as referencing models (consumer). To be able to modify and deploy models in this view, users need to either have administrator rights or, if the requiredRoles is not set to "Administrator", to have the permission to deploy and modify models. Refer to the Authorization Manager view for details on how to set this permission. For details on setting the requiredRoles attribute, refer to chapter Administration Perspective Access Control.
Figure: Model Management
The system defined and deployed Predefined model also get displayed in the Model Management view. You cannot perform any operation on this model.
For more information, please refer to the Predefined Model section of chapter Case - Grouping Processes in the Stardust Concepts Predefined Model section of the Case - Grouping Processes chapter of the Concepts guide.
Figure: Model Management - Predefined Model
The Model Management View displays the following details of the deployed models:
If the Description is added in the Properties page for the model in modeler, then it is displayed as tooltip text in the portal when you hover the mouse over the model name.
Figure: Tooltip Text of a Model
Following icons are provided above the Model Management table:
Figure: Model Management Table - Toolbar
By default, only active models are displayed. If enabled, all the models (active and inactive) are displayed.
Figure: Show Inactive Models
By default, all the provider models are displayed. If clicked, hides provider models.
Figure: Show Provider Model
By default, all the consumer models are displayed. If clicked, hides consumer models.
Figure: Show Consumer Model
By default, all the process interfaces are displayed. If clicked, hides process interface.
Figure: Hide Process Interface
Expands the model tree, if collapsed.
Figure: Expand All
Collapses the model tree, if expanded.
Figure: Collapse All
Generates report of all active deployed models.
Figure: Generate Report
Each time you generate report the progress dialog is displayed. You should wait until the report viewer is displayed.
Figure: Report Progress Bar
Figure: Active Deployed Model Report
To view the detail report of each active deployed model, click on Details in Action column of the report.
The Stardust Portal allows to deploy and overwrite models from the Model Management View. Models are deployed via the Deploy Model Wizard that is launched via the Deploy Model icon in the table toolbar and Actions column.
Figure: Deploy Model
Note
In case you use non-ASCII characters in model element names, you have to
add the property carnot.engine.xml.encoding to your
carnot.properties file and set it to UTF-8.
Otherwise you get an exception during the deployment.
Note that if the requiredRoles attribute is not set to "Administrator" and you have no administrator rights, but have the permission to modify and deploy models, you also need the permission to manage daemons to be able to deploy models from the Model Management view. Refer to chapter Authorization Manager view for details on how to set this permission.
When launched via the Deploy Model icon in the table toolbar, the model or models deployed are deployed as new versions using current semantics.
To deploy the new version of the model:
Click the Deploy Model icon in the table toolbar. The Deploy New Model wizard gets displayed.
Figure: Deploy New Model
Click the Browse button and select the model you want to upload. Once the model is uploaded, following details of the uploaded model are provided:
is provided
if you choose to delete the uploaded file.
Figure: Deploy New Model Details
Note that administrator can upload a single file or zip file that contains multiple XPDL files. Deploying zip files is strongly recommended when referencing is used. In that case, references are automatically established.
You can also specify following deployment options:
Click Deploy if you want to proceed with deployment or else click Cancel to cancel the deployment.
Figure: Deploy New Model
If the deployment is successful then the Deployment Status and warnings are displayed. In this case, if any of the models to be deployed do not have default values for any configuration variables, the Deploy Model (continued)- Missing Configuration Values dialog is displayed.
Figure: Missing Configuration Values
You can specify the values in the Value column for each missing configuration variable. This creates a consistent value set for Configuration Variables. Alternatively, an appropriate Preferences set can be uploaded prior to Model Deployment via the Configuration Variables View. For more information, please refer to the Configuration Variables View chapter.
The Validate Variables dialog contains warnings for the default values. It also displays the validation warning for the wrong value of variable provided in the Missing Configuration Values dialog. Click Finish to proceed with warnings.
Figure: Validate Variables
If the deployment fails then the Deployment Status is displayed as
icon along with errors and warnings. In this
case, the model does not get deployed.
Figure: Deploy New Model - Errors and Warnings
From the Actions column, you can perform following actions on the deployed models:
You can delete model versions using this option. To delete the model version:
icon and choose
Delete in the Actions column.
Figure: Delete Model
Note that deleting a model is not allowed if there are running process instances that are using this model, either via model element references or as a primary implementation.
Figure: Delete error message in case of running process instances
You can only overwrite a model when the model to be overwritten has the same ID as the model to be deployed. To overwrite the model version:
icon and choose
Overwrite in the Actions column.
Figure: Overwrite Model
is provided
if you choose to delete the uploaded file.You can also specify the following deployment options:
The Export option provides the facility to export model with its referenced models as well. To export models:
icon and choose
Export in the Actions column.
Figure: Export Model
Note that when you select the option Selected model only or the model contains no references to other models, the system generates a single XPDL file.
When you select the option Selected model and All referenced models, the system creates a single zip file containing all the XPDL files of the referenced models.
Figure: File Download
Enables you to view the report of the specific model. The report is generated based on the model ID. If the model is a provider or consumer model then according references are also displayed along with the model information.
icon and choose
Run Report in the Actions column for any deployed model.
Figure: Report of the Provider Model
Click on Home to view the Active Models report.
For more information on how to view the reports, refer to chapter Definition Reports of the Stardust Documentation - Business Analysis and Reporting Component Definition Reports of the of the Business Analysis and Reporting Component guide.
The Modify Implementation option enables you to provide alternate implementation which also includes the default implementation for the primary implementation of process interface. If you have implemented the process interface in one of your models for its process definition then only you can modify implementation for its process interface. For more information, please refer to the Implements Process Interface section of chapter Working with Process Interface in the Stardust Documentation - Developer Handbook. Implements Process Interface section of the Working with Process Interface chapter of the Developers Handbook.
icon in the Actions column.
The Modify Implementation dialog is displayed. The default implementation is selected.
If more than one process definition is implementing the interface of the same model then the same Model OID is displayed
for mutliple processes.
Figure: Modify Implementation
Figure: Modify Implementation - Select alternate implementation
For the detail usage, please refer to the Business Case 3: Specific Implementations section of chapter Common Usage Pattern in the Stardust Concepts Business Case 3: Specific Implementations section of the Common Usage Pattern chapter of the Concepts guide.
Switching the primary implementation for a running process has the following restrictions: