Packages

Understand about packages.

Important
The Packages feature is part of the Develop Anywhere, Deploy Anywhere capability which is currently available only with the Enterprise Plus tier. Contact your Account Executive to discuss upgrading your contract to the Enterprise Plus tier.

What are Packages?

A package comprises services and associated files, including specifications and document types. Upon project creation, a package is generated with a name identical to that of the project. For instance, creating a project called ProjectAny results in an automatic creation of a corresponding package named ProjectAnyProject within the system.

Apart from your project assets, you can add your own integration packages stored in any external repositories to a project and use it along with other assets in the project. Currently, you can add packages that are stored in GitHub.

For more information about packages, add and manage packages, see Packages.

Any services that are part of the package are known as Package Services. You can access the services in these packages in your integrations as follows:

Workflows

Flow Services

How to Configure Runtimes for Packages in Workflows

Assume that you have added your own integration packages stored in any external repositories to a project. For more information on how to add packages, see Adding Packages to a Project. Let us see how to use these services in a workflow and configure runtimes for these services.

Note
You can access only flow services and java services in a workflow.
  1. Go to the project where the services are added.

  2. Click Integrations > Workflows.

  3. Click the (plus icon). The workflow page appears. You can search and filter package services by either their service name or by the package name.

  4. Click Create New Workflow. The workflow canvas appears.

  5. Click Flow Services to view the package services.

  6. Select the package, and drag and drop the package into the canvas. For example, Addint.

  7. Click the Addint package and select Settings.

    The AddInt settings dialog box along with the service name appears.

  8. Select a runtime from the Select Integration Runtime drop-down list.

  9. Click Next. The Incoming data page appears.

  10. Add the input values.

  11. Click Next. The Test this action page appears.

  12. Click the Sync button to sync the packages to the runtime.

  13. Click Test.

  14. Click Done.

How to Configure Runtimes for Packages in Flow Services

Assume that you have added your own integration packages stored in any external repositories to a project. For more information on how to add packages, see Adding Packages to a Project. Let us see how to use these services in a flow service and configure runtimes for these services.

  1. Go to the project where the services are added.

  2. Click Integrations > Flow services.

  3. Click the (plus icon). The Flow Editor page appears.

  4. In the flow step, click All > Package Services.

  5. Select a service.

  6. Select an operation.

  7. Select a runtime.

  8. Click to sync the packages.
    An orange or red dot appears on the Sync button when user actions are required. Hover over the Sync button to view the information.
    For more information on scenarios and actions, see Indications for the Sync and Run buttons in Flow Editor.

  9. Click Save. The services are now configured to your runtime.

View Package Services Configured in your Project

The Deploy Anywhere page under Projects > Connectors displays services used in packages that you imported into your project and consists of the following sections:

Filters

You can use filters to view the desired package services based on the following options:

You can use any of these filter options individually or in combination to search for package services.

Connector Table

You can view the list of all connectors that are used in a package. The table lists the following details:

Publish and Deploy Projects with Packages

Publish

The Publish wizard does not display the package services if any integrations are using them. If you publish a project all packages added to the project are automatically published, irrespective of whether you have used any package services or not in the integration.

Deploy

The Deploy wizard includes the Integration Runtimes page allowing you to remap, sync, and restart the runtimes.

The Integration Runtimes page lists all runtimes configured for the services used in the integrations. By default, the runtimes configured in the source environment are considered in the target environment during the first deployment. Otherwise, the most recently configured runtime is considered.

Additionally, you have options to synchronize or restart runtimes after a successful deployment.

Some key points to note for successful deployments are as follows:

Deploying Projects with Packages

Before you Begin

Basic Flow

  1. Log in to your tenant (destination).

  2. Go to Projects dashboard. If a new deployment is available for a project, then a message appears on the project card.

  3. Click the project card that has the deployment message. A confirmation messages appears.

  4. Click Yes. The Deployments page appears listing all deployments.

  5. Click Deploy. The Integration Runtimes page in the Deployment wizard appears.

  6. Select the runtime from the Target Integration Runtime drop-down list.

    • If the integration is already present in this project and has the same package services configured in it, then the runtime is selected based on the current configuration instead of what is present in the deployment.

    • If the runtime does not exist in the target environment, then an error message appears, and you need to either create a runtime or select a runtime from the existing list.

  7. Do one of the following actions:

    • Select Sync all the target runtimes on deployment if you do not want to reconfigure the package service connections after deployment. The Restart Options appears.

    • Clear Sync all the target runtimes on deployment if you need to reconfigure the package services connections after deployment.

  8. Click Restart Options to select specific runtimes that must be restarted after a successful deployment in the Selected target integration runtimes to restart page.

    Note
    • Offline runtimes are not listed in the Selected target integration runtimes to restart page.

    • Syncing and restarting happens only for the running runtimes.

    • Cloud runtime cannot be restarted.

    • The sync and restart operations are asynchronous process and may take additional time even after the project has been deployed.

  9. Click Next. The Accounts page appears. Follow the steps mentioned in the Deploying Projects section from step 5.

    Note
    After deployment, all projects use the internal repository, regardless of their initial linkage to external or internal repositories in the source environment.

Post Deployment Steps

  1. Verify your configurations. For example,

    • Reconfigure the package service connections, if any.

    • In REST or SOAP APIs, if you are using flow service containing package services, then you must reconfigure the runtime configurations post deployment. This is because the runtime details selected during the deployment are not retained.

  2. Test and monitor your integrations in the target environment after successful deployment.