Configure the Artifacts
- Last UpdatedJun 20, 2024
- 5 minute read
The Settings tab and the Install, Update, and Uninstall sub tabs in the Package Template page allow you to set the properties for each of the artifacts added to the Package Template. Every single artifact has its own unique properties that you can configure based on the requirement. These properties decide the behavior of the artifacts while installing, updating or uninstalling the package.
The Associated Artifacts and the Child Artifacts tab is available only if the child and associated artifacts are added to the Package template.
To configure the artifacts within the package template
-
Select the artifact that you want to package and add it to a package template. The Add to Package Template page appears.
-
Expand Package Template under the Configuration section and set the Prerequisite and Runtime Initialization Settings.
-
Select the artifact for which you want to configure the properties.
All similar artifacts will be grouped under one heading. For example: All Database Connections within the Package Template will be grouped under Database Connections, similarly all Lookups will be grouped under the heading Lookup Settings. The Settings tab along with its Install, Update, and Uninstall sub tabs appears on the right side of the page. The following section gives you in-depth knowledge of the properties in each of the Install, Update, and Uninstall tabs.
The properties of the Database Connection artifact is explained in the Install, Update, and Uninstall tabs.
Settings
Install: The settings in this tab are referred when you install the Package.
-
Connection Exists: This property allows you to take appropriate action when the Database Connection present in the package is already present in the target environment.
-
Install to overwrite existing Connection: select this option if you want to use the database connection that is present in the target environment.
-
Do not install Connection: select this option if you want to overwrite the database connection that is present in the target environment with the one that is present in the packaged.
-
-
Connect To Repository Data Source: Using this property you can choose to use the current repository's connection string or choose a different connection string.
-
The Connect To Repository Data Source option in the Source section allows you to view the connection string that is used in the source environment.
-
The Connect To Repository Data Source option in the Target section allows you to edit the connection string of the target environment. You can either select Yes or No.
-
Yes: Select this option if you want to open the database connection using the current source repository's connection string.
-
No: Select this option if you want to define a new connection string.
-
Update: The settings in this tab are referred to when the same Package is installed for the consecutive time.
-
Delete Connection: Select this option if you want to delete the Connection that is present in the target environment.
-
Yes: Select this option to remove the Connection in the target environment. On selection of this option, the property Connection Is Modified appears. For more information, refer to the following table:
Connection Is Modified
Retain
Select this option if you want to retain the Connection along with the modifications, in the target environment.
Rollback
Select this option if you want to roll back to the original state. All modifications that were done to the Connection after it was installed in the target environment will be reverted and the connection will be retained.
Delete
Select this option if you want to delete the Connection from the target environment when uninstalling the Package.
-
No: Select this option if you want to retain the Connection in the target environment. On selection of this option, the property Connection Exists and Associated Artifacts not present appears. For more information, refer to the following table:
Connection Exists
Use Existing Connection
Select this option if you want to use the Connection that is present in the target environment.
Do not update Connection
Select this option if you want to overwrite the Connection that is present in the target environment with the one that is currently being packaged.
Associated Artifacts not present
Update Connection
Select this option if you want to update the Connection.
Do not update Connection
Select this option if you want to do not want to update the Connection as associated artifacts are not present.
-
-
Connect To Repository Data Source: Using this property, you can choose to use the current repository's connection string or choose a different connection string.
Note: The Connect To Repository Data Source option in the Source section allows you to view the connection string that is used in the source environment. The Connect To Repository Data Source option in the Target section allows you to edit the connection string of the target environment.
-
In the Target > Connect To Repository Data Source section, if Yes is selected then the database connection will be connected using the current repository's connection string.
-
In the Target > Connect To Repository Data Source section, if No is selected, then you can define a new connection string. For more information about defining a new connection, see Database Connection.
-
Uninstall: This settings in this tab is referred to when the Package is being uninstalled in the target environment.
-
Delete Connection: This property allows you to decide if you want to retain or delete the Database Connection in the target environment even after the Package is uninstalled.
-
Yes: Select this option if you want to delete the Database Connection from the target environment when the Package is uninstalled.
-
No: Select this option if you want to retain the Database Connection in the target environment even after the Package is uninstalled.
-
-
Connection Is Modified: This option allows you to decide if you want to retain, roll back to original state or delete the Database Connection in the target environment even after the Package is uninstalled.
Note: This property is applicable only if Delete Connection is set to Yes and the connection is modified.
-
Retain: Select this option if you want to retain the Database Connection along with the modifications in the target environment even after the Package is uninstalled.
-
Roll back to original State: Select this option if you want to roll back to the original state, reverted and the connection will be retained.
-
Delete: Select this option if you want to delete the Database Connection from the target environment when uninstalling the Package.
-
Associated Artifacts
The Associated Artifacts tab is disabled for Database Connection artifact as it cannot have any associated artifacts.
Child Artifacts
The Child Artifacts tab is disabled for Database Connection artifact as it cannot have any child artifacts.