Runtime Initialization Settings

The Runtime Initialization Settings option in the Add to Package Template allows you to select a form, map the fields of a form to the properties of the artifacts. The values mapped to the artifacts are populated when the package is installed. This feature is useful when the same data has to be entered in multiple places. The following section allows you to create a form, fill a form, and map the values of the form to the properties of the artifacts.

Note: Runtime initialization is not supported for the following artifacts:
- All Event Providers such as Event Associations and Scheduler
- Report Connection, Report Templates, and Reports
- All layouts such as Global Work Item Layout and Custom Layout
- List Views
- Navigation Lists

The following sample topics provide the procedures to use the Runtime Initialization Settings form values in the Database Connection properties. Similarly, you can configure the runtime initialization settings for other artifacts.

Add a database connection to package

For more information about creating a database connection and adding a database connection to a package, refer to the Creating a Database Connection and Adding Database Connection to Package Template sections respectively.

To create a Form

1. In the Enterprise Console, click the Menu button, and then click Forms. The Forms page appears.

2. Right-click on a form, and then click Design Form (or click on a form, and then on the action bar, click Design). The Forms Designer page appears.

3. In the Name box, type the name for the form as Database Connection Details.

4. In the Description box, type the description for the form as Database Connection Details.

5. Click Save & Continue.

   The Form Tasks page appears.

6. Click Design this form and then click Finish. The Forms Designer page appears.

7. Drag the text input control to the canvas.

8. Edit the properties of the control and change the Name to Server Name.

9. Click Apply to save the properties.

10. Repeat steps 7 to 9 to create the following fields:

    • User Name

    • Authentication Type

    • Database Name

      For more information about creating and designing forms, refer the Forms and Forms Designer sections in the Use Forms and Lists section.

11. Click Publish from the action bar.

12. Click Close on the BellyBar.

13. Close the Forms Designer page.

    Note: Form designed for runtime initialization settings support only the text input, number, drop-down, and hyperlink controls in Package.

To configure Runtime Initialization settings

14. To add a DB connection to package, in the Enterprise Console, click the Menu button, click Settings, and then click Database Connection. Right-click any existing database connection and then click Add to Package. The Add to Package Template dialog box appears.

    OR

    To edit an existing package, in the Enterprise Console, click the Menu button, click Package, and then click Package Template. The Package Template page appears.

    Select the package template for which you want to configure the Runtime Initialization Settings, and then click Edit. The Edit Package Template dialog box appears.

15. Under Configuration tree on the left pane, click Runtime Initialization Settings. The Runtime Initialization Settings form appears.

16. In the Form Name list, select the Database Connection Details form.

17. In the Form Version list, select the version of the form that you want to use. By default, the Form Version takes the latest version.

18. Click Next. The selected form with all the fields appear.

19. Fill the selected form and then click Finish.

Note: You can fill the form while installing the package as well.

To map the Runtime Initialization settings to the properties of the artifacts

The following steps allow you to map the properties of a Database Connection to the Runtime Initialization Settings.

20. Under Configuration tree on the left pane, select a Database Connection listed under the Artifacts section.

21. Click the Install tab.

22. Under Connection Details > Target section, click No for the property Connect To Repository DataSource.

23. Select the value for Server name.

    • In this example, the Server Name property can be mapped to the Server Name box of the Database Connection Details. When the package is installed the value of the Server Name property will be populated with the value entered in the Database Connection Details form selected in Runtime Initialization Settings.

    • Multiple selection from the list will append the value in the property.

    Note:

    - You can select the values by typing and/or selecting from the drop-down list. All the fields of Database Connection Details form are available for selection in the drop-down list. The value can be a combination of values entered manually and values selected from the drop-down list.
    
    - If a value is already available, and if you select another value from the drop-down list to be added to this value, the selected value is always appended at the end of the existing value.
    
    - If you enter or select a value, then the drop-down icon is changed to + icon. Click the + icon to select another value from the drop-down list. The selected value is always appended at the end of the existing value.
    
    - It is recommended that you do not edit the text within <% Control Name %>, where "Control Name" is the name of a control available in the Runtime Initialization Settings form. If you edit the text, then ensure that the "Control Name" is available in the Runtime Initialization Settings form.
    
    - You can select the values from the drop-down list only if the Runtime Initialization Settings are configured.
    
    - If you select another form in the Runtime Initialization Settings, the value is not cleared. You have to manually change the value.

24. Similarly map all the other properties (Authentication type, User ID, Advanced settings, and Database name) of the artifacts to the appropriate fields of the Database Connection Details form.

    Note: If the Package Settings form has a Password field, then its value can be set from the Runtime Initialization Settings by selecting one of the available password controls. Ensure to select a password controls whose Security Mode property is set to Encryption and Persist Password property is set to Yes.

All the values entered in the Runtime Initialization Settings form will be populated to the properties of the artifacts when the package is installed.