Creating and viewing package or repository instances

This topic provides information about creating instances for a package or a repository.

Before you begin

Before you can create or deploy a package (or repository) instance, you must have already created a package (or repository) definition. For more information about creating a package or a repository, see:

To create a package or repository instance

  1. Click the Deploy tab.
  2. From the left menu, select Packages or Repositories as appropriate.
  3. Click the New Instance icon next to the package (or repository) for which you want to create an instance.
  4. Enter a name in the InstanceLabel box to identify the instance (a default name is automatically suggested).
  5. Specify whether the instance is locked by selecting the appropriate option from the Locked box.
  6. If you want to modify the set of contents for this instance, change the state associated with each package reference under the Content tab.
  7. Click Create.
    If the deployment is queued before the instance is ready, you can immediately deploy the new instance.


    No deployment activity occurs until the instance has completed construction and is ready to be deployed. If a deployment is queued and the instance creation fails, the deployment also fails.


  • When you create an instance for a package or repository that has references to a server that was added to the default "Undefined" zone, then only engines assigned to the "Undefined" zone perform the instance creation tasks for those references.
  • When you create an instance for a package or repository that has references to server added to some custom zone, then only engines assigned to that custom zone perform the instance creation tasks for those references. If those engines cannot perform a task at a specific moment, that task waits in a queue until the engine can perform it. For more information about zones, see Zones and Managing zones.

To view an instance

To view detailed information for an instance, navigate to the Deploy > Package page or the Deploy > Repositories page, as appropriate, and use one of the following options:

  • Click the instance name that is displayed as a link under the package or repository.
  • For an instance, in the associated Actions menu at the right side of your screen, click View.

The instance detail view has these sections:

Instance detail view section



Details the high-level information about the instance, the package to which it belongs, when it was created, the deployment route, the instance status, whether the instance is locked or not, and the role to which this instance is assigned.


Identifies each piece of content that is stored by the instance, as well as high-level details for each piece of content, including its URI, archived size, and table of contents. If the archived content is less than 8 KB in size, you can view an extract of the content.


Identifies the set of properties associated with the instance. Such a set of properties is a snapshot of the package properties, taken when the instance was created.


Displays any configuration data associated with the instance.


Contains a record of the activity of the instance, including its content population, as well as authorization and restart events


Provides information about the processes associated with that repository instance. This information is only available in case of a repository instance.

To view a list of package or repository instances

  1. Click the Deploy tab.
  2. From the left menu, select Packages or Repositories as appropriate.
  3. Click the name of a package or repository to view all the instances added for that package or repository.
    You can see summary information about the package and each instance. Click the instance name to view the instance details.

The following table describes the potential actions that are available for each instance:




Initiates a deployment of the instance. The Deploy pane has a menu of all available deployment environments.


Displays the instance detail pane


Locks the instance to prevent deletion by the automatic cleanup mechanism


Unlocks the instance to enable deletion on the expiration date (default is 30 days)


Edits the role(s) that are allowed to access the instance. For more information, see Enabling role-based access permissions for an instance.


Recreates the instance content. All existing content associated with the instance and all deployment records associated with the instance are destroyed. The instance is recreated from the package content references.


Generates a report showing the deployment history for an instance.


Deletes the instance and purges all its deployment records from the database.

For more information about viewing and managing repositories, see Managing repositories and instances.

To modify or delete instances

  1. Click the Define tab.
  2. On the left menu, click Instances to see a list of instances created. 
  3. Perform one of the following actions as appropriate:
    1. To modify an instance, click an instance name that appears as a link under the Instance column to open it and then modify the settings available.
    2. To delete an instance, click the Delete link on the Actions menu  available at the right side of your screen (in line with the instance that you want to delete).


      You can modify or delete an instance only in the following situations:

      • The instance is not yet deployed.
      • The instance is not locked.

Where to go from here

Deploying an instance

Was this page helpful? Yes No Submitting... Thank you