Modify the configuration

When you modify a configuration with the Designer at deployment time, these changes may impact the database schema or the components settings. Depending on the impact, it might be necessary to create a new deployment version.

Create new deployment version

The deployment of a configuration from Designer is made in 3 steps:

  1. Write configuration files
  2. The deployed configuration files are written into the deploy folder from the Designer work directory. A subfolder is created in the deploy folder per application.
  3. Publish to Repository
  4. The configuration from the deploy folder is imported into Repository. Depending on updates, the application version is incremented or not.
  5. Update configuration REST call
  6. A REST call is sent to InterPlay to adapt its database structures to manage the updated configuration.
Note   If the changes from the Repository configuration are not compatible with the InterPlay configuration, you can clean the configuration from the Repository only and redeploy a valid configuration into the Repository and InterPlay.

Configuration updates in InterPlay

To change the structure of an existing Collection Type or Object Type, a new version for the Collection Type or the Object Type must be created.

The usual changes that require creating a new version are the following:

For Collection Type:

  • Add a new property
  • Remove an existing property
  • Change the following attributes of a property:
    • Name
    • Type
    • Minimum length
    • Maximum length
    • Total digits
    • Fraction digits

For Object Type:

  • Add a new property
  • Remove an existing property
  • Change the following attributes of a property:
    • Name
    • Type
    • Maximum length
    • Unicode
    • Total digits
    • Fraction digits
    • Variable
  • Add a new Element Type
  • Remove an existing Element Type
  • Add a new property to an Element Type
  • Remove an existing property from an Element Type
  • Change the attributes of an Element Type property:
    • Name
    • Type
    • Maximum length
    • Unicode
    • Total digits
    • Fraction digits
Note   If you are in a test environment and you do not want to create a new version for an Object Type or a Collection Type, in order to deploy the above modifications, you can clean the configuration from Repository and component and redeploy the modified one.

For InterPlay, if the configuration containing the new versions is deployed into Repository, the new versions are added to the associated application and the application version is increased. InterPlay adapts its database structures to manage the updated configuration and increases its runtime version.

Adding new types as a new Collection Type or a new Object Type has the same effect.

Besides these structural changes, there are other changes that imply increasing only the application version at deploy, such as:

  • All the modifications on Collection Type conditions:
    • Add a new Collection Type condition
    • Remove an existing Collection Type condition
    • Modify an existing Collection Type condition
  • All the modifications on Object Type conditions:
    • Add a new Object Type condition
    • Remove an existing Object Type condition
    • Modify an existing Object Type condition
  • For a Collection Type, change the following property attribute: Format
  • For an Object Type or an Element Type, change the following property attributes:
    • Format
    • Formatter

Related Links