Create, enable, pause, and disable subscriptions, get previous publications for a subscription, and run a subscription manually, including disabled subscriptions.
Creating a subscription that triggers a Data Integration task
Use the Navigator to create subscriptions that trigger a Data Integration task to retrieve the data from the topic or topics in the Cloud Integration Hub relational publication repository.
The following conditions must exist before you create a subscription:
•An application or applications that consume data must exist. You can either use existing applications, or create and save new applications.
•A relational topic to consume data from must exist. You can either use an existing topic, or create and save a new topic.
•If the subscription triggers a mapping task, a subscription task must exist in Data Integration. If the subscription triggers a synchronization task, you can either select a subscription task that exists in Data Integration or create the task.
1On the Navigator, click New > Subscription.
The New Subscription page appears.
2Enter the subscription name. Optionally, enter a description for the subscription.
3Select the subscription mode. Choose one of the following options:
- Enable. The subscription runs according to the schedule that you define in the Schedule page. You can also run the subscription manually from Cloud Integration Hub.
- Pause. The subscription does not run according to a schedule or by an external API. You can only run the subscription manually from Cloud Integration Hub to consume the delayed events.
- Disable. The subscription does not run according to a schedule or by an external API. You cannot run a disabled subscription manually from Cloud Integration Hub. If the related publication runs successfully, the disabled subscription doesn't create a delayed event. You cannot consume the published data when the subscription is in disabled mode.
4Select Consume data with a Data Integration task.
5Optionally, select Unbound Subscription.
A subscription that is not restricted to specific publication instances. It consumes all the publication events data in the publication repository for the topics that the subscription subscribes to. Applies to subscriptions that consume data with a Data Integration task.
6Select the application that subscribes to the data.
7Select the topic that stores data in a relational database from which the application consumes the data and then click Add Topic. Add as many topics as required.
8If you add more than one mandatory or optional topic to the subscription, specify the maximum number of hours to wait for all associated publications to finish publishing the data, after the first publication is ready for consumption.
- If all the publications finish publishing data within the maximum time interval, the subscription process starts after the last publication is ready for consumption.
- If one or more of the publications do not finish publishing data to all the mandatory topics within the maximum time interval, the subscription process is cancelled without consuming any data.
- If one or more of the publications finish publishing data to all the mandatory topics and not all optional topics within the maximum time interval, the subscription process starts only with the data published to the topics.
9If the task that defines the subscription mapping exists in Data Integration, choose the task. If not, click Create New Task to create a synchronization task.
10To create a synchronization task, enter the following properties in the Create New Task window and click Create:
Task Name
Enter a name for the task.
The name of the task must be unique within the organization. The task name is not case sensitive.
The task name can contain alphanumeric characters, spaces, and the following special characters: _ . + -
Source
Select the topic table to consume data from. The format of the object is TopicName/tableName.
Connection
Select the connection that connects to the target to consume data to.
Target
Select the target table to consume the data to. The Create New Task window shows the first 200 tables in the list.
Cloud Integration Hub creates the task in the default folder and assigns the task to the subscription.
11If the subscription subscribes to large amounts of data, increase the read batch size to optimize the performance of the subscription.
Note: Increasing the batch size increases the memory consumption of the Secure Agent and might impact the performance of the Secure Agent machine.
12Select the method and the frequency of data consumption.
When published data is ready
Runs the subscription immediately after the published data is ready.
Manually or by an external trigger
No schedule. You can use the following methods to run the subscription:
▪ Run manually from the Cloud Integration Hub explorer.
▪ Run by an API. Call a REST API that starts the subscription.
If a file subscription uses this scheduling option and publishes multiple files, all the files must be present in the source location when the subscription starts.
By schedule
Runs the subscription according to the defined schedule. Select one of the following options:
▪ Every n minutes. Runs the subscription in intervals of up to 60 minutes. You select the number of minutes from the list.
▪ Hourly. Runs the subscription in intervals of up to 24 hours. You select the number of hours from the list.
▪ Daily. Runs the subscription at the same hour every day.
▪ Weekly. Runs the subscription every week on one or more days at the same hour. Select the check boxes of the days of the week that the subscription runs on. For example, select Saturday and Sunday to schedule the subscription to run on weekends.
▪ Monthly. Runs the subscription every month on a specific date or a specific day at the same hour.
For minutes and hourly intervals, you can define a period of the day when the subscription runs. For example, schedule the subscription to run during nighttime hours.
Select a time zone for the schedule. The schedule runs the subscription in the selected time zone. You can change the default time zone in the user profile.
Define the delivery intervals in the Repeat running area.
Data to Consume
If a subscription runs manually or by an external trigger, or runs by a schedule, multiple files from the same publication might be available for consumption at the scheduled time, or at the time the subscription is triggered. Select one of the following options:
▪ All available publications. Consumes data or files from all available publications.
▪ Latest publication only. Consumes data or files from only the latest publication.
13Optionally, in the Retry Policy area, select Reprocess Events in Error Status and then select the number of times Cloud Integration Hub retries to run the subscription in case of failure and the retry interval. You can define a policy of up to nine retry attempts with a retry interval that is between five minutes and 23 hours.
14Click Save.
Creating a subscription that triggers a file ingestion task
Use the Navigator to create subscriptions that trigger a file ingestion task to retrieve the files from a specific topic in the Cloud Integration Hub file store publication repository.
The following conditions must exist before you create a subscription:
•An application or applications that consume files must exist. You can either use existing applications, or create and save new applications.
•A file store topic from which to consume files must exist. You can either use an existing topic, or create and save a new topic.
•A subscription file ingestion task must exist.
1On the Navigator, click New > Subscription.
The New Subscription page appears.
2Enter the subscription name. Optionally, enter a description for the subscription.
3Select the subscription mode. Choose one of the following options:
- Enable. The subscription runs according to the schedule that you define in the Schedule page. You can also run the subscription manually from Cloud Integration Hub.
- Pause. The subscription does not run according to a schedule or by an external API. You can only run the subscription manually from Cloud Integration Hub to consume the delayed events.
- Disable. The subscription does not run according to a schedule or by an external API. You cannot run a disabled subscription manually from Cloud Integration Hub. If the related publication runs successfully, the disabled subscription doesn't create a delayed event. You cannot consume the published data when the subscription is in disabled mode.
4Select Consume files with a file ingestion task.
5Select the application that subscribes to the files.
6Select the topic that stores files in a file store from which the application consumes the files and then click Add Topic.
7Select the file ingestion task that defines the subscription mapping.
8Select the method and the frequency of file consumption.
When published data is ready
Runs the subscription immediately after the published files are ready
Manually or by an external trigger
No schedule. You can use the following methods to run the subscription:
▪ Run manually from the Cloud Integration Hub explorer.
▪ Run by an API. Call a REST API that starts the subscription.
If a file subscription uses this scheduling option and publishes multiple files, all the files must be present in the source location when the subscription starts.
By schedule
Runs the subscription according to the defined schedule. Select one of the following options:
▪ Every n minutes. Runs the subscription in intervals of up to 60 minutes. You select the number of minutes from the list.
▪ Hourly. Runs the subscription in intervals of up to 24 hours. You select the number of hours from the list.
▪ Daily. Runs the subscription at the same hour every day.
▪ Weekly. Runs the subscription every week on one or more days at the same hour. Select the check boxes of the days of the week that the subscription runs on. For example, select Saturday and Sunday to schedule the subscription to run on weekends.
▪ Monthly. Runs the subscription every month on a specific date or a specific day at the same hour.
For minutes and hourly intervals, you can define a period of the day when the subscription runs. For example, schedule the subscription to run during nighttime hours.
Select a time zone for the schedule. The schedule runs the subscription in the selected time zone. You can change the default time zone in the user profile.
Define the delivery intervals in the Repeat running area.
Data to Consume
If a subscription runs manually or by an external trigger, or runs by a schedule, multiple files from the same publication might be available for consumption at the scheduled time, or at the time the subscription is triggered. Select one of the following options:
▪ All available publications. Consumes data or files from all available publications.
▪ Latest publication only. Consumes data or files from only the latest publication.
9Click Save.
Creating a subscription that consumes data with an API
Use the Navigator to create subscriptions that use the Consume Data REST API to consume the data from a specific topic in the Cloud Integration Hub relational publication repository.
The following conditions must exist before you create a subscription:
•An application or applications that consume data must exist. You can either use existing applications, or create and save new applications.
•A relational topic to consume data from must exist. You can either use an existing topic, or create and save a new topic.
1On the Navigator, click New > Subscription.
The New Subscription page appears.
2Enter the subscription name. Optionally, enter a description for the subscription.
3Select the subscription mode. Choose one of the following options:
- Enable. The subscription runs according to the schedule that you define in the Schedule page. You can also run the subscription manually from Cloud Integration Hub.
- Pause. The subscription does not run according to a schedule or by an external API. You can only run the subscription manually from Cloud Integration Hub to consume the delayed events.
- Disable. The subscription does not run according to a schedule or by an external API. You cannot run a disabled subscription manually from Cloud Integration Hub. If the related publication runs successfully, the disabled subscription doesn't create a delayed event. You cannot consume the published data when the subscription is in disabled mode.
4Select Consume data with an API.
5Optionally, enter a notification URL. Cloud Integration Hub sends notifications to this URL when data is ready to consume. You can either enter an unauthenticated URL or a basic authenticated URL.
6Select the application that subscribes to the data.
7Select the topic that stores data in a relational database from which the application consumes the data and then click Add Topic. You can add as many topis as required.
8Click Save.
You can copy the following URLs and use them in the request that runs the subscription:
- URL of the REST API. Use this URL to consume the data.
- URL of the Swagger structure for the topic that the subscription consumes data from. If a Swagger structure base URL is configured for the organization, Cloud Integration Hub appends the base URL to the topic Swagger structure URL. For more information, see System Properties.
Running a subscription manually
Use the Explore page to manually run subscriptions that trigger Data Integration tasks.
Tip: You can also run subscriptions manually on the topic page. For more information, see Topic properties.
1In the Navigator, click Explore. Click the All Assets list and then select Hub Management > Subscriptions.
The Explore page shows all existing subscriptions. You can sort the display by name, description, mode, topic, or last modified.
2Rest on the subscription and click the Actions menu at the right end of the line. From the menu select Run.
Getting previous publications for a subscription
Use the Explore page to get data that was published before the subscription subscribed to the topic and therefore was not consumed by the subscriber. The generated subscription events will run according to the subscription schedule.
Tip: You can also get previous publications for a subscription on the topic page. For more information, see Subscriptions properties.
1In the Navigator, click Explore.
The Explore page shows all existing subscriptions. You can sort the subscriptions by name, description, mode, topic, or last modified.
2Right click the asset and select Get Previous Publications.
3You can define a date range and a time range for which to get the publication.
4Click OK.
Note: You can get previous publications for a subscription for a maximum of 2000 events. You must change the date and time range if there are more than 2000 events.
Enabling, pausing, and disabling a subscription
Use the Explore page to enable, pause, or disable subscriptions. An enabled subscription runs according to the schedule that you define in the Schedule page. You can also run the subscription manually from Cloud Integration Hub. A paused subscription does not run according to schedule or by an external API. You can only run the subscription manually from Cloud Integration Hub to consume the delayed events. A disabled subscription does not run according to a schedule or by an external API. You cannot run a disabled subscription manually from Cloud Integration Hub. If the related publication runs successfully, the disabled subscription doesn't create a delayed event. You cannot consume the published data when the subscription is in disabled mode.
An enabled subscription runs according to the schedule that you define in the Schedule page. You can also run the subscription manually from Cloud Integration Hub.
A paused subscription does not run according to a schedule or by an external API. You can only run the subscription manually from Cloud Integration Hub to consume the delayed events.
A disabled subscription does not run according to a schedule or by an external API. You cannot run a disabled subscription manually from Cloud Integration Hub. If the related publication runs successfully, the disabled subscription doesn't create a delayed event. You cannot consume the published data when the subscription is in disabled mode.
Tip: You can also enable, pause, and disable subscriptions on the topic page. For more information, see Subscriptions properties.
1In the Navigator, click Explore. Click the All Assets list and then select Hub Management > Subscriptions.
The Explore page shows all existing subscriptions. You can sort the display by name, description, mode, topic, or last modified.
2Rest on the subscription and click the Action menu at the right end of the line to enable, pause, or disable the subscription. From the menu select Enable, Pause, or Disable, as required.