Creating and managing packaged components

Creating and managing a packaged component is the first step in deploying components.

Processes and components must be converted into a packaged component before they can be deployed or shared in the Process Library or as part of an integration pack. You create an individual "package" per component. However, a packaged component can consist of a primary component and all the dependent components that are required to support that component. For processes, API Service components, and Processing Group components, a packaged component might include connectors, maps, or process properties.

For other deployable components (such as certificates or custom libraries), the component comprises the packaged component by itself.

You can create a package from:

• The Build page, while the component is open and saved
• The Packaged Components page in the Deploy menu

When you select Packaged Components from the Deploy menu, the Packaged Components page is displayed, and shows a list of all packaged components that are created on the account.

Packaged components table

The Packaged Components table shows the following information for each packaged component:

Fields	Description
Actions	You can use the Actions menu to perform the following actions for a packaged component: Deploy a packaged component View the details for a packaged component View the version history of a packaged component Compare two versions of a packaged component Copy a component to the Component Explorer on the Build tab Delete a packaged component version Restore a deleted packaged component version (applicable for deleted packaged component versions)
Component Name	The name of the component that is used to create a packaged component.
Component Type	The type of component selected to create the packaged component. For example, a process, Flow Service, Certificate, etc.
Version	An alphanumeric value that identifies the version of the packaged component. The version was specified by the user who created the packaged component.
Created Date	The date and time at which the version of packaged component was created.
Notes	Describes the version of the packaged component, if any were provided in the wizard for creating packaged components.
Deployed To	If the packaged component is currently deployed, the Deployed To column indicates to which environment the component is deployed. This column shows information only for those packaged components that are actively deployed; if a packaged component is undeployed or has not yet been deployed, the column shows a "––" symbol.
Sharing	Indicates whether the packaged component can be shared in the Process Library or as part of an integration pack. All packaged components can be deployed, but only packages that were marked as shareable when they were created can be published in the Process Library or added to an integration pack. This field appears only for API Service components and processes that do not contain Process Route components. Other types of deployable components (such as certificates, custom libraries, and API Proxy components) can be deployed, but they cannot be shared.
Status	A status of Active indicates that this packaged component version is operative and is eligible for use in a deployment, the Process Library, or part of an integration pack. A status of Deleted indicates this packaged component version is deleted from the account and cannot be used in a deployment, the Process Library, or an integration pack.

Creating packaged components

You must have the Build Read and Write Access privilege and the Packaged Component Management privilege to perform this task. Only deployable components have the ability to be packaged.

The following topics describe how to create packaged components in the Integration service.

Creating a packaged component from the Build page

Creating a packaged component from the Build page

After configuring and saving a process or component on the Build page, use the Create Packaged Component button to begin the deployment process by creating a packaged component.

1. With the component that you want to package open on the Build page, click Create Packaged Component.

   note

   You must save the component at least once before the Create Packaged Component button is available.

2. In the Create Packaged Components dialog that appears, verify the component you selected is correct, then click the Next: Add Details.

   The Create Packaged Components: Add Details dialog opens.

3. Optional: In the Packaged Component table, click View Included Components to review the list of components that are included in the packaged component.

   For processes, API Service components, and Processing Group components, a packaged component consists of the primary component and all the dependent components that are required to support that component (such as subprocesses, connectors, or maps). For other deployable components (such as certificates), a packaged component is the component itself.

   You can review the list of components, but you cannot modify it.

4. Optional: Provide the following information:

   • Version for All — Enter the unique version ID that you want to apply to the selected component. The version must be unique from previously packaged components and can contain alphanumeric characters. If you do not populate the field, a version number for each component is automatically generated, which increments based on the latest revision number respectively.

   • Package Notes for All — Define any notes that provide helpful or specific information about the particular version of the packaged component. Remember that though you may have several components selected, each component results in its own individual package at the completion of the dialog; only the version number, notes, and sharing options are applied in bulk to each selected packaged component.

   • Sharing — (Disabled by default) Enable the Sharing option to allow Process or API component types to be shared to the Process Library or added to Integration Packs once they are created as a packaged component.

5. Click Create Packaged Component.

   Your new packaged component is created. Information about your new packaged component is immediately available from the Deploy > Packaged Components page.

   A dialog appears asking if you want to deploy your new packaged component.

6. To deploy your new packaged component, click Deploy. Otherwise, click Close.

   If you do not wish to deploy the packaged component at this time, you can do so at any time from the Deployments page (Deploy > Deployments).

Creating a single packaged component from the Packaged Components page

Creating a single packaged component from the Packaged Components page

To create a deployable packaged component, go to Deploy > Packaged Components.

1. From the Deploy menu, select Packaged Components.

   The Packaged Components page appears.

2. Click Create Packaged Component.

   The Create Packaged Components dialog appears. The Component Explorer displays only the list of components eligible for deployment.

3. From the Component Explorer, select the checkbox next to a single component that you wish to create in the packaged component.

   You can use the search bar in the components list to search for a component by name or component ID, or use the filter icon to narrow results by deployed status, component type, packaged component status, or packaged component ID.

   If the component was created as a packaged component previously, a version history of the component appears in the right-most pane.

4. Optional: Use the Action menu to view details about your selected component and its dependent components, view historical details of all packaged component versions created for the selected component, or deselect the component as a candidate for packaging.

5. Click Next: Add Details.

6. Optional: Click the View Included Components to see the primary component and all dependent components included with your selected component.

7. Optional: Provide the following information:

   • Version For All— Enter the unique version ID that you want to apply to the selected component. The version must be unique from previously packaged components and can contain alphanumeric characters. If you do not populate the field, a version number for each component is automatically generated, which increments based on the latest revision number respectively.

   • Package Notes for All— Define any notes that provide helpful or specific information about the particular version of the packaged component.

   • Sharing— (Disabled by default) Enable the Sharing option to allow Process or API component types to be shared to the Process Library or Integration Packs once they are created as a packaged component.

8. Once you are finished, click the Create Packaged Component. The Create Packaged Component button shows that one component is selected for creation as a packaged component.

   Your selected component is created as a new version of the packaged component, and is added to the version history table on the Packaged Component dialog. Additionally, you are presented with a dialog in which you can choose to immediately deploy the new version of the packaged component.

9. Click Deploy to deploy the new version of your packaged component, or click Close to cancel and deploy at a later time.

Results

The newest version of your packaged component is now available in the list of packaged components on the Deploy > Packaged Components page.

Creating multiple packaged components from the Packaged Components page

Creating multiple packaged components from the Packaged Components page

To create multiple packaged components at a single time, go to Deploy > Packaged Components.

When you create multiple packaged components at one time, the version number, note, and Sharing option that you apply in the dialog (Step 7) are applied to all components that are selected, though each selection will result in its own individual packaged component so that they can be deployed independently from one another.

note

Because the same version, note, and sharing option are applied to all selections in the Create Packaged Components dialog, it is advised that you only do a bulk creation when you have made minor adjustments across the various selected components in support of some common purpose. Otherwise, it is recommended that you create packaged components one-by-one.

1. From the Deploy menu, select Packaged Components.

   The Packaged Components page appears.

2. Click Create Packaged Component.
   The Create Packaged Components dialog appears. The Component Explorer displays only the list of components eligible for deployment.

3. From the Component Explorer, select one or more checkboxes for the components that you want to use to create your packaged components.

   You can use the search bar in the components list to search for a component by name or component ID, or use the filter icon to narrow results by deployed status, component type, packaged component status, or packaged component ID.

   Version history of each component appears in the right-most pane.

4. Optional: Use the Action menu to view details about your selected component and its dependent components, view historical details of all packaged component versions created for the selected component, or deselect the component as a candidate for packaging.

5. Click Next: Add Details.

6. Optional: Click the View Included Components action to view all dependent components included in each selected component.

7. Optional: Provide the following information:

   • Version For All— Enter the unique version ID that you want to apply to the selected component(s). The version must be unique from previously packaged components and can contain alphanumeric characters. If you do not populate the field, a version number for each component is automatically generated, which increments based on the latest revision number, respectively.

     Remember that though you may have several components selected at this point for packaging, each component results in its own individual package at completion; only the version number, notes, and sharing options are applied in bulk to each selected packaged component.

   • Package Notes for All— Define any notes that provide helpful or specific information about the particular version of the packaged component.

   • Sharing— (Disabled by default) Enable the Sharing option to allow Process or API component types to be shared to the Process Library or Integration Packs once they are created as a packaged component.

8. Once you are finished, click the Create Packaged Component button. The button shows the number of components that are selected for creation as their own individual packaged component.

   The Deploy dialog appears.

9. Click Deploy to deploy the new version of your packaged component, or click Close to cancel and deploy at a later time.

Results

The newest version of your packaged component is now available in the list of packaged components on the Deploy > Packaged Components screen. To learn about different filters you can use to search for specific packaged components or to learn how to create a single packaged component, see the Related Links section.