TIBCO Scribe® Online Connector For Mapper

The TIBCO Scribe® Online Connector For Mapper serializes and deserializes content based on a sample data structure, such as JSON. It can be used in conjunction with other connector extensions, such as the HTTP Connector.

Connector Specifications

  Supported
Agent Types
On Premise X
Cloud X
Replication Services
Source  
Target  
Integration Services
Source X
Target X
Migration Services
Source  
Target  
Maps
Integration X
Request-Reply X
Message  

This Connector is available from the TIBCO Scribe® Online Marketplace. See Marketplace TIBCO Scribe® Certified Connectors for more information.

Supported Entities

The Mapper Connector derives the entities and related entities from the entity names and samples that you provide when you configure the Connection.

Operation Details

The Query Block displays but does not return any data since the Mapper Connector does not connect to a source datastore, but instead serializes and deserializes content returned by other Connectors.

Fetch

Use the Fetch Block to deserialize a string, for example, the response to an HTTP GET request or an inbound HTTP message received from an API.

This Map illustrates using the Fetch Block to deserialize a response to an HTTP GET request.

The Fetch Block Filter tab captures the content returned by an HTTP GET request and deserializes it based on the sample for the selected entity in the Mapper connection dialog.

The results of the Fetch Block are used to Create records in another target datastore.

This Map illustrates using a Fetch Block to deserialize an inbound HTTP message received from an API.

The Fetch Block Filter tab captures the content received in the message and deserializes it.

The results of the Fetch Block are used to Create records in another target datastore.

Serialize

Setup Considerations

API Usage Limits

Some APIs limit the number of calls in a 24 hour period, or some other sliding window. Refer to the documentation for the API you are accessing and review the limits.

Selecting An Agent Type For Mapper

Refer to TIBCO Scribe® Online Agents for information on available Agent types and how to select the best Agent for your Solution.

Connecting To Mapper

  1. Select More > Connections from the menu.
  2. From the Connections page select Add to open the Add a New Connection dialog.
  3. Select the Connector from the drop-down list in the Connection Type field, and then enter the following information for this Connection:
    • Name — This can be any meaningful name, up to 25 characters.
    • Alias — An alias for this Connection name. The alias is generated from the Connection name, and can be up to 25 characters. The Connection alias can include letters, numbers, and underscores. Spaces and special characters are not accepted. You can change the alias. For more information, see Connection Alias.
    • Entity — Name of the entity as it should display in the Map.
    • Content — Currently Sample JSON is the only option supported.
    • Sample — Sample content, such as JSON, used by the Connector to determine the schema for the metadata.

    Note:

    • At least one Sample is required to save the Connection.
    • Best practice is to test the Connection after adding each sample to allow the Connector to check samples individually for errors.
  4. To add an Entity and associated sample, select the Add Entity link.
  5. To delete an Entity and associated sample, select Delete from the Gear menu next to the Content field.
  6. Select Test to ensure that the Agent can connect to your database. Be sure to test the Connection against all Agents that use this Connection. See Testing Connections.
  7. Select OK to save the Connection.

Metadata Notes

Naming

Connection metadata must have unique entity, relationship, and field names. If your Connection metadata has duplicate names, review the source system to determine if the duplicates can be renamed.

Mapper Connector As IS Source

Consider the following when using the Connector as an IS source.

Filtering

Mapper Connector As IS Target

Consider the following when using the Connector as an IS target.

Batch processing is not supported.

Sample Maps

Note: To download the Sample Maps go to the Mapper Sample Maps Knowledge Base article in the TIBCO Community

Storing a variable (or state) of fields/values, multiple entities, and child records can be complex to design and even more difficult to maintain using out-of-the-box functions. In addition, you may want to store a JSON format of your data when using Connectors such as Files, HTTP, and Variables. Mapper can help you create a blueprint for your dataset, such as JSON, and provide the ability to get and set the entities and fields in that variable/state.

These simple Maps attempt to demonstrate some concepts and how they can be achieved using the Mapper Connector. Review the Group Block labels in the Maps that explain the purpose of the Blocks inside the Group.

The Serialize and Deserialize (JSON) map demonstrates the following: 

The Working with Arrays Map demonstrates the following: 

When configuring sample JSON in the Mapper Connection dialog, the square brackets [ ] indicate that the sample is an array. The top level of this array corresponds to the object labeled Anonymous in the Include tab of the Serialize and Fetch Blocks. To reveal and access the objects within the array, you must select the Anonymous object on the Include tab. The Include tab displays the format of the JSON as TIBCO Scribe® Online interprets it.

The Working with HTTP Map is a more complete scenario and demonstrates the following: 

TIBCO Scribe® Online API Considerations

To create connections with the TIBCO Scribe® Online API, the Mapper Connector requires the following information:

Connector Name

Mapper

Connector ID

EFCAFD59-08C7-4F26-BF0E-67DD85D7290B

TIBCO Scribe® Online Connection Properties

In addition, this Connector uses the Connection properties shown in the following table.

Note: Connection property names are case-sensitive.

Name Data Type Required Secured Usage

Entities

String

Y

Y

 

JsonFormatVersion

String

Y

Y

 

License Agreement

The TIBCO Scribe® Online End User License Agreement for the Mapper Connector describes TIBCO and your legal obligations and requirements. TIBCO suggests that you read the End User License Agreement.

More Information

For additional information on this Connector, refer to the Knowledge Base and Discussions in the TIBCO Community.