Create And Test A Connection
A Connector is a piece of software used to move data between specific applications using those applications' APIs. A Connection is the configuration of the parameters required by the Connector to access the datastore for a specific application. For example, the Salesforce Connector connects to the Salesforce API to read and write data. The credentials that permit that Connector to communicate with the Salesforce API are stored in a Connection.
Connections are needed to transfer data from a source or target system. OAuth Connectors and their corresponding Connections require a special configuration, which is described in Create Or Modify An OAuth Connection.
When testing a Connection using a Cloud Agent that was recently provisioned, the API indicates that the Agent is not available until the Agent has contacted the cloud for the first time. This could take several minutes.
- Verify that you have the Connector ID for the type of Connection you are creating. If you do not have that ID:
- Call the GET connectors method. The list of Connectors available to your Organization is returned.
- Choose the Connector for your new Connection. The Connector ID is used in later calls.
- Determine the Connector Connection properties. Each Connector has a specific list of properties that must be provided to successfully create a Connection.
For details on the properties of your Connector, see the Connections topic in the TIBCO Scribe® Help Center.
- Call the POST connections method.
- You must encrypt all Connection properties in this request. For more information, see Connection Properties.
- When the POST connections method completes successfully, the new Connection is returned.
- Verify that you have an Agent that supports the Connector:
- Call the GET agents method and filter on Connector ID.
- Choose an Agent from the list of Agents that support the Connector that is returned.
- Call the POST test connection method, using the Connection ID and the Agent ID. You must test all Connections before using them. Because this is an asynchronous process, the information that the command returns includes an ID that you can use to query the test results.
- After 15 to 30 seconds, call the GET connection test commandId method.
- Call the GET connection test commandId method every 15 to 30 seconds, until the Status property of the command object is Completed.
- Examine the model to determine if the Connection test was successful.
The step above only creates a Connection. TIBCO Scribe® does not automatically retrieve actions, entities, fields, or relationships. To retrieve metatdata see Manually Load Metadata.
See