Model Properties

To view model properties, click the model name in the My Process Models panel. The property panel of the selected model opens, where you can set and edit model properties.

Figure: Model Properties

Specific property tabs are provided for viewing problems, editing comments or setting specific model properties.

• General Properties
• Problems Tab
• Comments
• Configuration Variables
• Read-only Model
  • Securing a Model
  • Removing Model Security
  • Eclipse Compatibility of Read-only Models
  • Cross Model Support of Read-only Models
• Edit Lock of Models

General Properties

The following general properties are displayed for a model:

• UUID - A unique identifier ID gets generated as an identifier for client server communication. This option is visible in the Integrator profile only.
• ID - A unique ID generated automatically for each model. However, it is editable and visible in the Integrator profile.

  
  Figure: Model ID - Editable

  For more information, please refer to the section Editing Model ID.

• Model Name - specify the model name
• Creation Date - displays the creation date and time of the model.
• Last Modification Date - displays the modification date and time of the model.
• Valid From - You can select the date from the calendar since when the model would be valid.
• Version - the model version number
• Description - optionally you can specify a description for the model.

Editing Model ID

You can edit model ID in the Integrator profile only.

To edit the model ID:

1. Click the Edit icon
2. Specify unique model ID
3. Click OK or press Enter key to submit the changes. Note that this operation will save all models and close all open Modeler views.
4. Click Cancel or press Esc key to close the dialog

Figure: Edit Model ID

If the model ID matches with another model ID, then a validation message is displayed and the ID automatically changes back to the original ID.

Figure: Edit Model ID - Validation

Problems Tab

Problems - This tab displays validations (errors and warnings) that are performed on all the elements included in the model. Click the Refresh Validation icon to view the validations. It displays Severity, Element and Description for the validation.

Figure: Model Properties - Problems

Note that validations are not performed on sequence flows, conditional sequence flows and message transformation application.

Comments

You can specify comment in the text box and click Submit. The newest comment gets displayed at the top of the table. To delete the comment, select the comment and click the Delete icon. The user, who has submitted the comment, only that user can delete the comment. If the other user selects the comment or no comment is selected, the Delete icon remains in disabled state.

Figure: Model Properties - Comments

Configuration Variable

The Configuration Variables tab displays the configuration variables in the following scenario:

• When you import an Eclipse-based model, the default configuration variables are displayed.
• If you define the configuration variable for the string type model element in the Web-based modeler then it gets displayed.

The Activity criticality is calculated for web base models with Engine side Criticality formula after deployment though there is no way to define criticality formula.

The following columns are displayed:

• Name - This column displays the name of the configuration variable.
• Default Value - This column displays the default value associated with the variable and it is editable. For a configuration variable of Password type, the default value is masked.
• Description - You can specify description in this column. The tooltip text is provided to view the complete description.
• References - This column displays the references of the configuration variable.

Figure: Configuration Variable

Click the Refresh icon to refresh the view. You cannot add configuration variable in the configuration variable property of the Web-based modeler. However, you can delete the configuration variable. To delete the configuration variable, perform the following steps:

• Click the Delete icon displayed next to the variable name
• Select the appropriate option to delete the configuration variable:
  • Substitute all occurrences of the variable to be removed with an empty literal
  • Substitute all occurrences of the variable with the default value of the variable to be removed
  • Substitute all occurrences of the variable with a literal if specified by the user in the adjacent text box. For example, you specified the string "test" in this text box for the configuration variable defined for the default value of the primitive data. The specified string gets substituted for the deleted variable and gets displayed in the Default Value field of that primitive data.

  
  Figure: Delete Configuration Variable

Defining Configuration Variables

• You can define variables in the properties of all model elements that are accessible via String properties. To define the variable in element properties, use the following syntax:

  ${variable name}

  The validation on the configuration variable is performed and displayed in the Problems tab of the model properties. Note that the variable name must not contain invalid characters like "/ $ { } *".
• Configuration variables, their values and references are stored in the model file as extended attributes:

  <carnot:Attribute Name="ipp:variables[7]:name" Value="Environment" Type="String"/>
  <carnot:Attribute Name="ipp:variables[7]:defaultValue" Value="TEST" Type="String"/>
  <carnot:Attribute Name="ipp:variables[7]:description" Value="Environment variable to decide whether working in production or test mode." Type="String"/>

  For more information, please refer to the chapter Configuration Variables View in the Administration Perspective of the Stardust Portal .

Defining Configuration Variable Type for Security Information

You can define data type for configuration variable which allows a type validation of default values respectively actual values given via API or from within configuration variable administration view. This allows runtime configuration of arbitrary server-side security-relevant data at required places in the model.

So, following two types are supported for configuration variables:

• String(default type)
• Password

To create a configuration variable of Password type, perform the following steps:

1. Specify default value of the element as ${name:type}. For example, ${token:Password}. Note that the type must be specified as Password.

   
   Figure: Define Password Type

2. Open the property page of the model and view the configuration variable panel. Note that for variable named token, the type is displayed as Password. For a configuration variable of Password type, the default value is masked.

   
   Figure: Configuration Variable - Password Type

Expanding and Collapsing Configuration Variable Reference List

If more than three references of configuration variable exist then the Show All References link is displayed below the third reference. Click the link to view all the references.

Figure: Show All References

To hide the expanded references, click the Collapse References link.

Figure: Collapse References

Read-only Models

You can secure the model using the Read-only tab.

Securing a Model

The read-only action locks the model from any editing and requires the password to make it editable. For models that are editable, the status is displayed as Writable. To secure a model, perform the following steps:

1. Click the Read-only Model tab of the model properties. For the editable model, the following details get displayed.

   
   Figure: Read-only tab - Editable Model

2. Status - Following values are displayed for this field:
   • Writable - Indicates that the model is editable and hence not secure
   • Read-only - Indicates that the model is not editable and hence secure
3. Password - Specify the password. The password must have:
   • At least four characters
   • The password and reentered passwords must match If they do not match, the validation message is displayed
4. Reenter - Specify the same password in this field. It should match with the password specified in the Password field.

   
   Figure: Specify Password

5. Click Make Read-only. Note the following changes:
   • a Lock icon is displayed in the My Process Model panel

     
     Figure: My Process Models - Lock icon for Read-only Model

   • If there are unsaved models, the following message gets displayed prior to secure model operation.

     
     Figure: Warning - Save Models

   • The status of the model is displayed as Read-only. Note that after the read-only action, the status of the model gets saved automatically.

Note that the context menu of the read-only model displays only Download Model and Deploy options.

Figure: Read-only Model - Context Menu Options

Also, the Undo and Redo icons are disabled when you mark the model as read-only.

All the other operations on all the elements of a model are not displayed for a read-only model. All fields and controls in all views and property panels are disabled except the Test tab of the applications. The process diagram canvas and the main toolbar icons are also disabled except the Zoom In, Zoom Out and Print icons. If you try to click the element added in process diagram canvas, the following message is displayed.

Figure: Read-only Model - Process Diagram Canvas

Removing Model Security

If the model is marked as Read-only then you can again provide the password and remove the security. To remove the model security, perform the following steps:

• Specify the password that was specified to make the model read-only. If the password does not match, the validation message is displayed. An unlimited number of unsuccessful attempts are allowed.

  
  Figure: Make Writable

• Click Make Writable. The model becomes editable and the lock icon gets removed from the model in the My Process Models panel. Note that after the make writable action, the status of the model gets saved automatically. Note that though the Undo icon is enabled, you cannot undo the Make Writable action.

Eclipse Compatibility of Read-only Models

In the following scenarios, Eclipse compatibility of read-only models is required.

Importing a Read-only Model in the Eclipse-based Modeler

If you download a read-only model and import it in the Eclipse-based modeler, the model becomes editable.

Importing Back from the Eclipse-based modeler to Web-based Modeler

However, if you import the same model (which was marked as read-only in the Web-based modeler) from the Eclipse-based modeler to Web-based modeler, the Read-only status is maintained.

Removing Hash attribute from XPDL

When the model is marked as read-only, stardust:security:hash attribute is added to the XPDL file of the model. If you download and remove this attribute from the XPDL file of the read-only model then the read-only status is not maintained when imported in the Web-based modeler.

<carnot:Attribute Name="stardust:security:hash" Value=""/>

Importing a Model in the Web-based Modeler that matches Model Name

While importing an Eclipse-based model, if the same name exists in the Web-based modeler then a new version of the model is created and the following message is displayed. Click Continue, if you want to import a new version of the model in the web-based modeler.

Figure: Create New Version of Model

Cross Model Support for Read-only Models

Note that you can reference the read-only model in any other model. But you cannot modify any element of the referenced read-only model.

Edit Lock of Models

To avoid undetected overwrites, the edit lock functionality is provided. If a user is editing a model then any other user won't be able to edit the same model from any other user session. If a user is working on model A, then any other user session displays the lock icon on the model node and a tooltip text in the My Process Models panel.

Figure: Model Node - Lock icon and Tooltip Text

Note that right-clicking on any element of the locked model in the My Process Models panel, won't open the context menu for it. Only Download and Deploy operations are supported from the context menu of the locked model.

Open the Edit Lock tab in the Model Properties and note the status of a locked model. Lock is released when the owner triggers the Save All operation.

Figure: Edit Lock

Locks can be broken manually by:

• logging out of the owner's session
• using Break Edit Lock operation by the super user having administrator rights

Click Yes in the Break Edit Lock dialog. Any edit or save operation from the previous owner's session will be prevented.

Figure: Break Edit Lock

Then, check the current state of the model in the Edit Lock tab of model properties.

Figure: Edit Lock