Creating a subscription that triggers a Data Integration task
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.
On the Navigator, click
New
Subscription
.
The
New Subscription
page appears.
Enter the subscription name. Optionally, enter a description for the subscription.
Select 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.
Select
Consume data with a Data Integration task
.
Optionally, 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.
Select the application that subscribes to the data.
Select 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.
If 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.
If 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.
To 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.
If the subscription subscribes to large amounts of data, increase the read batch size to optimize the performance of the subscription.
Increasing the batch size increases the memory consumption of the Secure Agent and might impact the performance of the Secure Agent machine.
Select 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.
Optionally, 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.