Packaging configurations and components for migration or backup

Overview

As a system administrator, you can package configurations and components into an application to move them between Clarizen environments in a few easy steps.

You can package the following:

  • Configurations
    • Custom fields
    • Validation rules
    • Workflow rules
    • Scheduled workflow rules
    • Custom actions
    • Custom panels
  • Components
    • Profiles
    • Views
    • Reports and dashboards
    • Configurations
    • Mailboxes
    • System Settings
    • Templates

Supported scenarios

The decision tree below demonstrates supported scenarios and helps you identify the best approach for moving configurations and data between Clarizen production and sandbox environments.

Functionality

Sharing the installation URL for a published application

Use the installation URL when copying configurations between two production environments or two sandbox environments.

To obtain the installation URL for a published application:

  1. As a System administrator, navigate to Settings > Applications.
  2. Click the Published Applications menu item.
  3. In the Source Application column, click the name of the application.
  4. In the Application Details page, find the Application URL field and copy the URL value. You can share the URL to install the application in a different environment.

Pushing a published application

If you are an administrator for both sandbox and production environments, you can push a published application from your sandbox environment to your production environment.

To push an application:

  1. As a System administrator, navigate to Settings > Applications.
  2. Click the Published Applications menu item.
  3. Click the Push link for the application. When prompted, enter your login credentials for your production environment. Use Federated Authentication if required.
  4. Once the application is installed in the production environment, enable the application by clicking the Enable link in Settings > Applications > Installed Applications.

Creating, downloading and importing an application

You may want to package your configurations to an application and download it to your desktop as a CAP file to:

  • Copy configurations from production to sandbox. Optionally, you can also wait for sandbox refresh which copies configurations together with the data
  • Create a backup of your sandbox configurations before sandbox refresh

Steps:

  1. Package configurations into an application:
    1. As a system administrator, navigate to Settings > Applications > New Application.
    2. Complete the required fields.
    3. Select the configurations and components you wish to include.
    4. Click Save. The application appears in the Developed Applications
  2. Publish the application:
    1. In the Actions column, click Publish for the newly created application.
  3. Download the application:
    1. In the Published Applications page, click the Download link to download the application as a CAP file to your Desktop.
  4. Import the application to your sandbox or production environment:
    1. In the destination environment, navigate to Settings >Applications > Import Application.
    2. Browse to the location of the CAP file on your computer to install it.
      After the application is installed, you must enable it to enable the configurations and components.
  5. Enable the installed application:
    1. Navigate to Settings > Applications > Installed Applications.
    2. In the Actions column, click the Enable link for the application.
Have more questions? Submit a request

Comments

Powered by Zendesk