Quote Model Versioning
Definition
Quote models are created for a given tenant. The dashboard lists all quote models created for this tenant.
A quote model is defined with a Name and a Status:
- The Name is the identifier of the quote model. It must be unique for a tenant. This name is used by external systems to identify the quote model (for example, the name is used for CRM integration).
- The Status defines the quote model status:
- DRAFT - A draft version corresponds to a working version. This means that the quote model is being defined and not available at runtime.
- ACTIVE - An active version corresponds to a version that is available at runtime (from the CRM by example).
The activation process allows you to change the quote model status from DRAFT to ACTIVE. Once a model is activated, it cannot be updated. However, you can create a new draft version of an active quote model if you need to modify it. See Creating a Draft below.
Active Version: For a given quote model (represented by its name), there is only 1 ACTIVE version.
Creating a Draft
A DRAFT is created when:
- A new quote model is created
- An ACTIVE quote model is updated
- A DRAFT is available only on the Quote Designer side and not available at runtime in Performance Quoting. Only ACTIVE quote models are available at runtime.
When a DRAFT is created from an active version, a suffix is added to the quote model name in order to identify the DRAFT (DRAFT (current date time)). In addition, the DRAFT is displayed as a child of the ACTIVE version.
Multiple Drafts A quote model can have several drafts under an active version. For example, you can work on the next version of your quote model (for a deployment next year for example) but still need to fix something in the current quote model. You will have 1 DRAFT for the next version next year and 1 DRAFT for the fix.
Activation Process
When a quote model is implemented and ready for test, you need to activate your draft.
Activating a DRAFT will allow you to use it at runtime. The status of the quote model will be ACTIVE. You can activate a quote model from the Dashboard or during editing with the Activate button displayed in the top right corner.
Quote Model Validation Only valid quote models can be activated. If there are errors in the quote model (displayed in the footer), you must fix them in order to activate the quote model.
If an active quote model already exists, the new active version will replace the previous one. The old version is stored as backup.
In order to ACTIVATE a quote model, you must enter an activation label. This label allows you to identify the version that is activated. In addition, a fingerprint will be generated in order to identify your quote model. This fingerprint is based on the quote model content. Two identical models deployed in different environments will have the same fingerprint.
Backup process
If needed, you can reactivate a quote model that was previously ACTIVE. To do this, in the action dropdown list, select History. In the History popup, you can edit a backup version. This creates a new DRAFT of that version that you can activate.
The fingerprint is displayed on the Dashboard on ACTIVE quote models. This information can be also retrieved at runtime using the error inspector (under the Global tab).
Deployment process
In order to manage several environments for your project, tenants are defined for each of them.
In order to deploy a quote model from DEV to TEST, the following steps are needed:
- Export your quote model from Tenant A (export the ACTIVE version which has been validated)
- Import your quote model in Tenant B
- Activate the imported model in the Tenant B
Because of the fingerprint, you can see that the model on Tenant A and Tenant B have the same content.
