Subscription properties include general information about the subscription, the applications, topic, and task to use for the subscription, and subscription scheduling.
- 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
- Mode of the subscription. Choose one of the following options:
- - Enable. The subscription runs according to a 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.
Note: If you choose the When published data is ready option for scheduling a paused data integration or file ingestion task subscription, no delayed event is created when you run the associated publication. However, you can manually run the subscription in the Cloud Integration Hub only if there are delayed events for the subscription before setting it to paused.
- Consumption Method
- Method by which the subscription consumes data or files:
- - 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 relational publication repository and write the data to the subscribing application. Select this method to consume batch data into files, applications, and repositories.
- - Consume files with a file ingestion task. The subscription process triggers a file ingestion task to retrieve the files from a specific topic in the Cloud Integration Hub file store publication repository and write the files to the subscribing application. Select this method to consume files into a target location.
- - Consume data with an API. Use the Consume Data REST API to consume the data from a specific topic in the Cloud Integration Hub relational 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
- 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.
- Application
- Application that consumes the data or files.
- Topics
- Topic or topics from which the application consumes the data or files. This list is mandatory.
- Optional Topics
- When you create a compound subscription you can define optional topics in addition to the mandatory topics. Cloud Integration Hub runs the subscription after the defined time-frame with the data set published to the mandatory topics even if there is no data published to the optional topic.
- Notification URL
URL to which Cloud Integration Hub sends notifications when the data is ready to consume. Applies to subscriptions that consume data with an API.
The notification URL can 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"}
You must immediately return the notification URL with an HTTP 200 SUCCESS response.
You can parameterize the notification URL by using the cih.sub.notification.base.url parameter. Use the following syntax:
${cih.sub.notification.base.url}
Define the cih.sub.notification.base.url parameter as a system property before you use it in a notification URL.
- Derived Notification URL
Displays the actual notification URL after deriving the parameter values.
For example, if the notification URL is ${cih.sub.notification.base.url}/services/notify, and the value of the ${cih.sub.notification.base.url} parameter is https://apigw.net, the derived notification URL would be https://apigw.net/services/notify.
- Credential required to access the URL
- Select this option to authenticate a basic authenticated notification URL. If you enable this option, you must enter a user name and password to authenticate the URL.
- User name
- Enter your user name to authenticate the notification URL. You can enter a maximum of 50 characters.
- Password
- Enter the password to authenticate the notification URL. You can enter a maximum of 50 characters.
- 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 mandatory and optional 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 the publications don't publish data to all the mandatory topics within the maximum wait time, the subscription fails and creates an error event without consuming any data. However, if publications publish data to all mandatory topics but not all optional topics, the subscription runs successfully with the data published to the topics, after the defined wait time.
- Task
- Task that defines the subscription mapping. Applies to subscriptions that trigger a Data Integration task or a file ingestion 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 or a file ingestion 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 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.
- 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 ... intervals. 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.