Creating Packages

This process creates the package and the package description, generates the package file, and downloads the package file to a location accessible by the target instance.

On this page

Task 1: Create the package definition

A package is a collection of settings that define the components that you want to migrate. Once the package is defined, it can be generated into a package file.

Note: To create a copy of an application in the same instance of Archer, create a new application and select the option to create a copy of an existing application.

  1. From the menu, click Admin menu > Application Builder > Packages.
  2. Click Add New, and do 1 of the following:
    • To create a new package, click Create a new Package from scratch.
    • To create a package from an existing package, click Copy an existing Package, and select the package you want to copy.
  3. Click OK.
  4. In the General Information section, enter the name and description of the package.

  5. Click Save or Save and Close.

    • To apply the changes and continue working, click Save.
    • To save and exit, click Save and Close.

Task 2: Add components to the package definition

  2. From the menu, click Admin menu > Application Builder > Packages.
  3. In the Components section, review the list of Access Roles, Applications, Dashboards, Data Feeds, Questionnaires, Reports, and Workspaces currently included in the package.
  4. To add a new component, click Lookup.
  5. Use the drop-down menu to select Applications, Access Roles, Dashboards, Data Feeds, Questionnaires, and Workspaces.

    Note: You cannot package unlicensed objects. You can view your licensed objects and any unlicensed dependencies on the Licensing Information page. For more information see, Viewing Licensing Information.

  6. For each drop-down option, select the items that you want to include in the package.

    Note: Selecting a Workspace, Application, or Questionnaire does not automatically add the associated dashboards or data feeds.

  7. To select all dashboards associated with selected workspaces, click Select Related Dashboards on the Dashboards page.
  8. To select all data feeds associated with selected applications or questionnaires, click Select Related Data Feeds on the Data Feeds page.
  9. Click OK.

  10. Click Save or Save and Close.

    • To apply the changes and continue working, click Save.
    • To save and exit, click Save and Close.

Task 3: Generate the package file

When you generate a package, Archer creates a package file using the most current information in the instance of Archer

  2. From the menu, click Admin menu > Application Builder > Packages.
  3. Select the package that you want to generate and review the date listed in the Last Updated column.

    The Last Updated column indicates when the package was last modified. Any changes that were made to the source instance of Archer after this date are not reflected in the package.

  4. Review the date listed in the Last Generated column.

    The date in the Last Generated column indicates when the package file was generated. If the field is blank, the package has not been generated and a package file has not been created. If a date is listed, but does not match the date in the Last Updated column, the package file may be out of date. You may need to generate the package again to ensure that any recent changes to the package are reflected in the package file.

  5. To generate the package and a new package file, click Generate.

    The Generate Package File process is queued into the asynchronous job engine. The job may or may not run immediately, depending on the jobs currently queued in the job engine. By default, the generated package file is stored in the file repository.

    Note: After a package file is generated, it is not automatically updated. If any changes are subsequently made to the source instance, you will need to generate a new package file to ensure that the information in the package file is current.

  6. To view detailed package generation progress, click Run History.
  7. If you receive the status Failed or Partially Successful, review the Package Generation Log.

Task 4: Download the package file

To download a package that was imported on a target instance, click Packages and click Download for the package.

  1. From the menu, click Admin menu > Application Builder > Packages.
  2. In the Last Updated column, review the date listed.
  3. In the Last Generated column, review the date listed.
  4. Click Download.
  5. In the Download dialog box, click click here, and select Open or Save.
  6. To save the file, click the arrow next to Save, select Save as, and set the file location.

    Note: Save the file in a location that is accessible to the Archer administrator of the instance who plans to import the package file.