This section describes operations that apply to the general aspects of models.
Creating a new model
- Navigate to Models Management and click New on the left sidebar.
-
In the New Model dialog, enter a name for your model.
- Decide whether you want to create from scratch or create from an existing model.
- Create from scratch: Select this option and click Create model.
-
Create from an existing model: Select this option and complete the required steps:
- Select an existing model from the Create from dropdown.
- Model version, select a version available from the dropdown, the current version, the last published version, or the last published Kiuwan default model.
- In the Select Languages dropdown, select all the languages you want to include. All configurations and rules for all the selected languages will be copied.
- Click Create Model.
Publishing a model
Typically, if our software is developed by third parties, at some point, "we freeze" our model to provide it to them, so they can study and apply it. The action of publishing a model is made using the Publish button on the top right of the screen.
- On the top right corner, click Publish.
-
In the Publish Model dialog, the following fields are available:
Name Description Publication tag A literal, or "tag", to facilitate the configuration management tasks and versioning of project artifacts. New technologies The automatically generated weights for the new languages added (if exist), with the possibility to change the value. Mandatory rules The list of mandatory rules that will be automatically added to the model (if necessary) Related rules The list of related rules that you should check before publishing (incompatibilities, generalizations, and deprecations). Mandatory metrics The list of mandatory metrics that will be automatically added to the model (if necessary).
Model Actions
Once the model is published, you have the following actions:
-
Remove versions: Click Remove versions to delete the selected versions. In the Remove Versions dialog, select the versions you want to remove and click Remove Versions.
-
Edit model: Click Edit model to edit the model name and description. Click Save to save the edits and close the window.
-
Remove model: Depending on whether you have used the model or not, two different results will appear after clicking Remove model.
- If the model is never used in any analysis or applications, the following window will appear: Click Ok to remove the model completely.
- If the model has been used, the following message will appear:
- Click Ok to remove the versions that aren't used. The used versions will be available only through the analysis in read-only mode.
- If the model is never used in any analysis or applications, the following window will appear: Click Ok to remove the model completely.
-
Set as a default model: Use this option to set the selected model to the default. (An asterisk will appear next to the model name on the left.)
Export to PDF
Open the menu located next to the Summary title. Select PDF to generate a report, which will be downloaded automatically in .pdf format.
Compare models and versions
To compare the selected version with another model and/version, select Compare. Read more details about it here: Comparing Models.
Model versions
A model is versioned each time it is published. There are two types of versions:
- Draft: The latest version of the model, which can be edited. However, precisely because it is being edited, and thus unpublished, this version still can't be used in the analysis.
- Published: All released versions of the model have this state. A published version cannot be edited. Only the last published version can be used to run an analysis. Other versions are kept to manage historical data.
All versions of a quality model can be accessed through the drop-down box in the Models Manager toolbar: