Using candidate software instances
The system creates Candidate Software Instances (CSIs) to represent software processes that are not identified by patterns but are observed to be communicating in an interesting manner. However, if a CSI is a part of your application and you want to model it, then you can convert it into a Software Instance (SI). When you create an SI from a CSI, all matching CSIs in the current view are converted and the system creates and activates a pattern to do the same.
After the pattern is activated, it converts all matching CSIs in the datastore. Because the pattern is not yet created when the CSIs in the UI are being converted, there is no relationship to a maintaining pattern. The relationship is updated after the pattern has been created and activated. However, the update might take some time.
If a CSI is not required, you can create a rule that prevents the CSI from being created. When the rule is created, the system deletes all existing CSIs of that kind from the datastore. The delete operation might also affect other existing models.
To create an SI from a CSI
- Right-click the CSI and select Create Software Instance. The Define Software Instance Pattern dialog box is displayed.
- Enter the following information:
- Type—Specify the type of SI that you want to create. This field is prepopulated with the name of the CSI.
- Publisher—Provide the publisher name for the software.
- Category—Select a software category from the drop-down list. This determines the location of the SI pattern in the tree on the Knowledge management page.
- Clustering—If the SI can run on a cluster, select Software Instance may run on a cluster.
- Attribute—To add a custom attribute, click Attribute.
Enter the attribute details in name/value pairs. You can add as many attributes as needed. Attribute names must start with a letter or an underscore and can contain only ASCII letters, numbers, and underscores.
- If the condition is suitable to identify the process accurately, create the SI by clicking Create, and the procedure is complete. However, if the condition does not correctly match all instances, or matches too many, you can modify the condition.
To create a rule to delete CSIs
This operation deletes matching CSIs throughout the datastore and might affect other existing models.
- Right-click the CSI and select the Do not create name menu item.
The Prevent Candidate Software Instance Creation dialog box is displayed.
- The following information is displayed:
- Rule name—The rule name. You can modify this.
- CSI Type—The CSI node kind.
- Condition—The matching condition for CSIs of this kind. This is used to suppress creation of new CSIs and deletion of existing CSIs.
- Process Count—The number of matching processes.
- To create the rule and delete matching CSIs, click Create.
If the condition is suitable to identify the process accurately, create the rule and delete matching CSIs by clicking Create, and the procedure is complete. However, if the condition does not correctly match all instances, or matches too many, you can modify the condition.
Modifying the condition used to match CSIs
If the condition shown in the Process Information field of the Define Software Instance Pattern or Prevent Candidate Software Instance Creation dialog box does not correctly match the required CSIs, you can modify it.
- To do so, on the Define Software Instance Pattern dialog box, click Modify Condition.
The Generate Software Instance Pattern page is displayed on a new browser page or tab.
- Add the required condition.
In this example, we specify a user name to prevent CSIs run by other users from being converted to SIs. The same UI is used to delete matching CSIs.
- Using the Query builder, add a condition, or conditions, to ensure that the query matches only the required CSIs. For information on using the query builder, see the Query Builder.
- Refresh the results, and if they are correct, showing only the instances that you require, click Generate TPL. The Knowledge Management page is displayed.
- To see the generated pattern module, click the Generated Modules link. You might also need to use filtering to see the module.
- Return to the browser window or tab to see the visualization. Refresh this to see that the CSI has been replaced with an SI.