Table of Contents

Search

  1. Preface
  2. Introduction to Cloud Integration Hub
  3. Hub administration
  4. Project and Asset Management
  5. Applications
  6. Topics
  7. Data Integration tasks
  8. Publications
  9. Subscriptions
  10. Tracking and monitoring
  11. Cloud Integration Hub REST APIs
  12. Glossary

Cloud Integration Hub

Cloud Integration Hub

Subscription properties

Subscription properties

Subscription properties include general information about the subscription, the applications, topic, and task to use for the subscription, and subscription scheduling.
The subscription page can include the following properties:
Subscription Name
Name of the subscription. The name can contain up to 60 characters and can contain special characters.
Description
Description of the subscription. The description can contain up to 255 characters.
Mode
Subscription mode, enabled or disabled.
A disabled subscription does not run according to schedule or by an external API. You can only run a disabled subscription from the
Explore
page or from the topic page of the topic that the subscription subscribes to.
Consumption Method
Method by which the subscription consumes data:
  • Consume data with a Data Integration task
    . The subscription process triggers a
    Data Integration
    task to retrieve the data from the topic or topics in the
    Cloud Integration Hub
    publication repository and write the data to the subscribing application. Select this method to consume batch data into files, applications, and repositories.
  • Consume data with an API
    . Use the Consume Data REST API to consume the data from a specific topic in the
    Cloud Integration Hub
    publication repository. Select this method for high frequency, event-driven subscriptions.
    After you configure the subscription properties, you can copy the following URLs from the subscription page:
    • URL of the REST API. Use this URL to consume the data.
    • URL of the Swagger structure for the topic from which the subscription consumes data. Use the structure in the subscription request.
    You use the URLs when you create the request that runs the subscription.
Unbound Subscription
An unbound subscription is not restricted to specific publication instances. It consumes all the data that exists in the publication repository for the topics that the subscription subscribes to.
Application
Application that consumes the data.
Topics
Topic or topics from which the application consumes the data.
Notification URL
URL to where
Cloud Integration Hub
sends notifications when data is ready to consume. Applies to subscriptions that consume data with an API.
The notification URL cannot be authenticated and the HTTP request method must be POST. The payload of the POST request must include the following parameters:
Parameter
Description
publicationEventId
ID of the event of the publication that published the data to consume.
subscriptionEventId
ID of the event of the subscription to consume the data.
subscriptionName
Name of of the subscription to consume the data.
For example:
{"publicationEventId":123, "subscriptionEventId" : 234, "subscriptionName" : "payrollSubscription"}
Wait for all topics to be available for consumption for ... hours
Maximum time to wait until all published data is available from the time that the first topic is ready to consume. Applies to compound subscriptions that consume data from multiple topics.
If all of the publications in all topics finish publishing the data before the maximum time, the subscription process runs immediately after the last publication is ready to consume. If some publications are not ready to consume within the maximum time, the subscription process does not run. An error event is created, and no data is delivered.
Task
Task that defines the subscription mapping. Applies to subscriptions that trigger a
Data Integration
task.
Create New Task
Create a synchronization task that defines the subscription mapping. Applies to subscriptions that trigger a
Data Integration
task.
The Create New Task window includes the following properties:
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.
Read Batch Size
Number of records that the
Cloud Integration Hub
connector reads from the publication repository in a single batch. Applies to subscriptions that trigger a
Data Integration
task.
Scheduling
Method and frequency of data consumption. Applies to subscriptions that trigger a
Data Integration
task.
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 command-line API or 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.
  • Monthly. Runs the subscription every month on a specific date or a specific day at the same hour.
Define the delivery intervals in the
Repeat running
area.
Retry Policy
Defines the number of times
Cloud Integration Hub
retries to run the subscription in case of failure and the retry interval. Applies to subscriptions that trigger a
Data Integration
task. Configure the following parameters:
  • Reprocess Events in Error Status
    . Enables the retry policy.
  • Retry ... times at ... interval.
    . Select the number of retry attempts and the time interval.
    You can define a policy of up to nine retry attempts with a retry interval that is between five minutes and 23 hours.