Complete this task to install a package after you have imported the package file. You can queue multiple packages, however Archer only installs 1 package at a time.
When installing a package with a core module in to a target instance in which it does not exist currently, that core module must be licensed prior to the package installation in the target instance.
Important: Ensure that you have backed up your database before beginning this procedure. The package installation cannot be reversed. The only way to reverse a package installation is to restore the Archer database backup.
The Install Package process is queued into the asynchronous job engine. This jobs may or may not run immediately, depending on the jobs currently queued in the job engine. The Install Package process impersonates the user who runs the install, so any objects modified or created during the package installation will be associated with that user.
Objects are installed in the following order:
- Applications (and levels of the application)
- Questionnaires
- Sub-forms
- Folders
- Questionnaire values lists
- Question filter properties
- Fields
- Reports
- Layout
- Workpoint Action (Advanced Workflow)
- Navigation Menu items
- Calculation formulas
- Letterhead templates
- Notifications
- Workflows
- Data Driven Event actions
- Data Driven Event rules
- Questionnaire campaigns
- Questionnaire show/hide rules
- Mail Merge Templates
- Repository Install
- Access Roles
- Widgets
- Dashboards
- Workspaces
All objects from the source instance are installed in the target instance unless the object cannot be found or is flagged to not be installed in the target instance. A list of conditions that can cause objects not to be installed is provided in the Log Messages section. A log entry displays in the Package Installation Log section.
Install a package
If installing a package that contains Record Permissions fields, verify that users and groups already exist in the target instance. If they do not, these fields might not install properly. If necessary, create the users and groups in the target instance before installing the package.
-
From the menu bar, click
> Application Builder > Install Packages. - In the Available Packages section, locate the package file that you want to install, and click the file name or
at end of the row to open the Options menu. - In the Selected Components section, click the Lookup button to open the Package Selector window.
- To select all components, select the top-level checkbox.
- To install only specific global reports in an already installed application, select the checkbox associated with each report that you want to install.
Note: Items in the package that do not match an existing item in the target instance are selected by default.
- Under the Translation Option drop-down menu, select an option for each selected component. To use the same Translation Option for all selected components, select a method from the top-level drop-down list.
Note: The Translation Option is enabled only when a language is selected.The following table describes the options. Option
Description
Full Install
Installs the component and its translations from the selected languages.
Translations Only
Only installs the translations from the selected languages.
- Under the Install Method drop-down menu, select an option for each selected component. To use the same Install Method for all selected components, select a method from the top-level drop-down list.
The following table describes the options. Option
Description
Create New Only
Only creates new fields and other elements in the applications, questionnaires, workspaces, data feeds, and dashboards specified in the package file. This option does not modify any existing elements on your instance of Archer. This is useful when you want to add functionality to an existing application, questionnaire, workspace, dashboard, data feed, or access role, but you do not want to risk making any unwanted changes to the existing elements of workspaces, data feeds, or dashboards.
Note: The Create New Only option does not apply to access roles or languages.
Create New and Update
Updates all elements in the applications, questionnaires, workspaces, data feeds, and dashboards as specified in the package file. This includes adding new elements and updating existing elements.
Note: The Create New and Update option does not apply to access roles or languages.
- Under the Install Option drop-down menu, select an option for each selected component. To use the same Install Option for all selected components, select an option from the top-level drop-down list.
The following table describes the options. Option
Description
Do not Override Layout
Installs the component, but does not change the existing layout. This is useful if you have a lot of custom fields and formatting in your layout that you do not want to risk losing.
You may have to modify the layout after installing the package to use the changes made by the package.
Note: The Do not Override Layout option does not apply to access roles or languages.
Override Layout
Updates the layout as specified in the package file, overwriting the existing layout.
Note: The Override Layout option does not apply to access roles or languages.
- Click Continue to advance to the next object category in the Package Selector, and repeat steps 4 to 6. After reviewing all object categories, click OK.
- To deactivate target fields and data-driven events that are not in the package, in the Post-Install Actions section, select the Deactivate target fields and data-driven events that are not in the package checkbox. To rename the deactivated target fields and data-driven events with a user-defined prefix, select Apply a prefix to all deactivated objects, and enter a prefix. This can help you identify any fields or data-driven events that you may want to review for cleanup post-install.
- Click Install.
- Click OK.
Note: Successfully installed applications do not appear in the applications list until the next time the web page is refreshed. You can manually refresh the page in your web browser to view a new application in the list immediately.
