Subscriptions

List subscriptions

You can check the list of subscriptions in the Subscriptions List. Information includes:

  • Name: Subscription name
  • Status: Subscription status
  • Tags: Tags associated with the subscription
  • Participant: Subscriber(s) name(s)
  • Template Name: Flow Manager template to which the partner subscribed
  • Template Version: Version of the published template when the subscription is based on a published template. Currently, this version is not used
  • Pattern: Name of the flow pattern, when the subscription is based on a flow pattern
  • Flow: Name of the flow created by the subscription

The following table lists the operations allowed on a subscription depending on its current status:

Subscription status Edit Deploy Delete Force delete
Saved Yes Yes Yes No
Deploying No No No No
Deployed Yes No Yes No
Deployed in error Yes Yes Yes No
Removing No No No No
Removing in error No No No No
Removed in error Yes No No Yes

View a subscription

In the Subscription List, select an individual subscription to check the Subscription Details.

Add a subscription

You can either create the subscription starting from a flow template or a flow pattern.

In the Subscription List, click Add subscription. A subscription has the following fields:

Name

Set the name of the subscription

Source

Select to subscribe to a flow pattern or flow template

Subscribe to the flow template

By default, you subscribe to a flow template.

Prerequisites:

  • The template to which you subscribe is Published. See Templates.
  • The subscribers and communication profiles of subscribers. See Participants.

When you subscribe to a flow template, you set the fields defined in the flow template as follows:

Template

Select an existing template.

You can check the description of the template together with its graphical representation. This information is also present when viewing or editing the subscription.

Flow Nodes

Select an exiting partner as the Sending partner

Communication profiles

Depending on the template's protocol parameters, you are prompted to use a specific client communication profile.

The client communication profile contains connectivity data, such as:

  • Login and password
  • Certificate
  • SSH key
  • Client authentication type
  • Fingerprint verification
  • Password stored locally
  • FIPS enabled

An information button displays next to each communication profile so you can view its details without having to exit the subscription menu.

Other fields 

The template you are subscribing to may require additional parameters during the subscription. See Subscription parameters in a template definition.

Subscribe to flow pattern

If you have only one flow to generate starting from a flow pattern, you can subscribe the flow participants directly to this pattern to avoid the additional template step.

Prerequisites:

  • Upload the subscription pattern to Flow Manager. See Patterns.
  • Subscribers and subscriber communication profiles. See Participants.

To subscribe to a flow pattern, set the Source as the Flow pattern. You can check the description of the pattern along with its graphical representation. This information is also available when viewing or editing the subscription.

The same fields set in a flow template are set during the subscription except the subscription parameters set in the template and appear as fields during the subscription. When subscribing to a flow pattern, these fields are not necessary.

Edit a subscription

In the Subscription List, please select the name of a subscription to open it for editing.

You can edit a subscription to add a new partner, application, or communication profile.

Add partner

While a subscription is in edit mode, click the +Add button next to the Partner field.

The Partner Detail page opens, which allows you to set the general partner information. Set the Name and click Save.

The newly created partner is by default selected in the subscription.

Add application

While a subscription is in edit mode, click the +Add button next to the Application field.

The Application Detail page opens, which allows you to set the general application information. Set the Name and click Save.

The newly created application is by default selected in the subscription.

Communication profile

You can create a new communication profile for the partner or application selected in a subscription as follows:

While a subscription is in edit mode, click the +Add button next to a Communication profile field.

The partner or application Communication Profile page opens, which allows you to create a new communication profile. The protocol and type that match the subscription are pre-selected. You may also add ssh keys or certificates if needed.

Click Save to return to the Subscription menu.

You can use the back browser button to return to the previous page.

The newly created communication is selected in the subscription by default.

Add PGP Key

While a subscription is in edit mode, click the +Add button next to the PGP key field.

The PGP Detail page opens, which allows you to set a new PGP Key.  Let the type PGP Key and set alias and content. The content of the product SSH key has to be encoded using base64. If the PGP Key belongs to a product, you must also provide the private key's password. Click Save.

The newly created PGP key is by default selected in the subscription.

Deploy a subscription

You can select one or more subscriptions and click Deploy. Only subscriptions with status Saved, Not Deployed, or Deployed in error are deployed.

This triggers flow deployment. The flow status is recalculated. The subscription and the flow have the same status: Deploying, Deployed, Saved, Not Deployed, or Deployed in error.

The user that triggers Deploy should have a role that contains the Manage Subscription privilege. For more information about Flow Manager roles and privileges, see Identity and access management.

Delete a subscription

In the Subscription List, choose a subscription and select Delete:

  • The status of the subscription changes to the intermediary status Removing.
  • Flow Manager attempts to remove the flow associated with the subscription:
    • The flow is removed. The subscription is removed from the Subscription List.
    • If the flow cannot be removed, the flow status changes to Removed, In error. The subscription status also becomes Removed, In error, and a message in the Subscription List describes the issue.

Deleting a subscription may fail for the following reasons:

  • Products connectivity is down.
  • Some configuration to be removed is no longer available.

Users with a role containing the Manage Flow Template privilege are allowed to delete a subscription. For more information about Flow Manager roles and privileges, see Identity and access management.

Force delete a subscription

The Force delete operation does the following:

  • Remove flow from Flow Manager. If this action fails, the issue is logged in Flow Manager, and the process continues with the following step.
  • Remove the subscription from Flow Manager.

Force deleting a subscription may fail for the following reasons:

  • Some configuration to be removed is no longer available.
  • Product connectivity is down.

Users with a role containing the Force Remove Subscription privilege can force delete a subscription with the Removed, In error status. For more information about Flow Manager roles and privileges, see Identity and access management.

Related Links