Adding Or Editing An Integration Event Solution
Use Integration Event Solutions to create integration tasks triggered by calls to the TIBCO Scribe® Online API web service. These API calls may be generated by a datastore, if it supports Outbound Messages, or your own source code, if you are building a software application that makes use of a TIBCO Scribe® Online integration.
Note: TIBCO Scribe® Online uses the lower camel case naming convention for JSON data across the endpoints. For example, the convention to write the object holding a last name would be: lastName.
Use Integration Event Solutions to access data from other applications via the TIBCO Scribe® Online API.
Two types of Maps are available for Event Solutions:
- Message Maps — Use Outbound Messaging on an application to trigger a TIBCO Scribe® Online Map.
- Request/Reply Maps — Request data from any TIBCO Scribe® Online Connection with any application that can call a REST API and return a Reply to the sending application.
Generating OAS documentation for a single Request/Reply Map, all Request/Reply Maps in a Solution, or all Request/Reply Maps in an Organization is supported. See Generate An OAS Document For Request/Reply Maps.
Note: Unlike Scheduled Integration Solutions, there are no dependencies between Maps in an Event Solution. Each Map within an Event Solution runs independently, depending on when an event occurs to trigger a specific Map.
When you configure a TIBCO Scribe® Online IS Solution, you create an instance of that Solution that is unique to your Organization. Each TIBCO Scribe® Online IS Solution performs one or more integration tasks.
The processes for configuring and editing a Solution are the same.
Tip: See TIBCO Scribe® Online Tutorials for links to useful videos.
Prerequisites
- Make sure an Agent is available. Select Dashboard on the menu bar.
- The Agents displays your available Agents.
- If there are no Agents available, determine whether you want to:
- Download and install an On-Premise Agent
- Provision a
Cloud Agent
See TIBCO Scribe® Online Agents for additional information.
- Create your Connections. Configuring Connections to one or more datastores can be done as you add or edit a Solution, but it may be easier to create them first. If you were invited into this Organization, the Connections may already exist. For information about creating Connections, see Adding A Connection.
Configure The Solution
Accessing The Solution Edit Page
- Select Solutions on the Menu bar to open the Solutions page.
- Select an existing IS Solution to edit it or select the Add button and then select Integration Event) to start configuring an Event Solution. The Solution Edit page is displayed.
Adding/Editing An Event Solution
Note: Changes to Solutions are saved when you move the cursor off of the modified field.
- At the top of the Solution, enter a name for this Solution.
Note: The name of this Solution must be unique within this Organization.
- From the Agent drop-down,
select an Agent from the list. If no Agent is available, return to the Dashboard and add one from the Agents . See Installing A TIBCO Scribe® Online On-Premise Agent or Provisioning A TIBCO Scribe® Online Cloud Agent for more information.Note: The Cloud Agent is disabled if the Solution contains Connections that do not support the Cloud Agent.
- The Solution is enabled by default. To disable the Solution, remove the checkmark from the Enabled option. See Disabled Solutions for additional information.
- In the Description section, add a brief description for this Solution.
- In the Maps section, determine the type of Event Map; then create the Maps you need to accomplish your integration goals.
- To create a Message-based Map, select the Menu button , and select Create Message Map from the drop-down list. Follow the instructions in Defining An Event Message Map.
- To create a Request/Reply Map, select the Menu button , and select Create Request/Reply Map from the drop-down list. Follow the instructions in Defining An Event Request/Reply Map.
- In the Connections section, view a list of the Connections used by the Maps in this Solution. You can select an existing Connection and edit its settings. Refer to the help for the specific Connector for additional information .
- In the Execution History section, view the status of the last five executions of this Solution. Select the View All link at the bottom of the section to see up to 45 days of Execution History for this Solution.
Note: Event Solution Execution History does not update automatically. Select Refresh to update the status and record counts for an Event Solution.
Additional Steps
Configure Your Source
As described in Defining An Event Message Map and Defining An Event Request/Reply Map, after you save the Map, TIBCO Scribe® Online generates a unique Endpoint URL for each Map. Configure your source datastore or application code to call this URL.
Set Security Rules
From the Security Tab on the Organization page, specify the security rules for the Event Solutions in this Organization.
Important: When an Event Solution runs, TIBCO Scribe® Online sends a response to Messages or Requests for data from any one of three static IP addresses. Configure your Proxy Server, Firewall, or other network security devices to allow responses from these IP addresses to access your network. Static IP Addresses include:
- 54.204.16.213
- 54.83.47.195
- 23.23.251.57
Note: With a TIBCO Scribe® Online trial subscription, your Organization supports up to 3 Solutions.