Defining An Integration Map
Use TIBCO Scribe® Online Integration Maps to create visual Maps by pulling the elements, or Blocks, from the palette to the mapping workspace. When you run a Solution with a Map, TIBCO Scribe® Online processes each record from the source entity through the Map you define, running each of the Blocks in order.
When you open a Map the Connections panel and workspace display. The Connections panel contains all of the Blocks required to easily create Maps used to integrate your source data into one or more target datastores. To build your Map, move the Blocks into the workspace.
Each time you save your Map a separate revision of the Map is stored. Before saving, enter a comment in the Comment field at the bottom of the workspace to associate a comment with the new revision. You can revert to a prior revision from the Revisions dialog. See Map Revisions for additional information.
Accessing Integration Maps
- Select Solutions from the Menu bar.
- On the Solutions page, select an existing Solution or select Add to start a new Solution.
- At the top of the Solution Edit page enter a name for the Solution.
- Select an Agent from the Agent drop-down.
- In the Trigger section, select the method that triggers the Solution to run.
- In the Maps section, select Create Integration Map from the Menu to display the Create Map dialog.
Naming A Map
When you first open a new Map it is given the default name, Map, followed by a number, such as Map 0 or Map 1. TIBCO suggests that you change this to a meaningful name and add a description in the Description field. Rename a Map at any time and save under the new name.
Note: Integration Maps are limited to a maximum of 11 Connections per Map.
Each Connection in a Map can be used for both Source and Target operations based on what the Connector and the associated datastore support. For example, if you have a Salesforce Connection and you use a Query Block for that Connection in the Map, the Query is a Source operation, therefore, Salesforce is the Source for that Block. If you use a Create Block for the Salesforce Connection in the Map, Create is a Target operation, and Salesforce is the Target for that Block.
Connections are sorted based on the order in which they were added to the Map. The color of the Blocks associated with a Connection is determined by the order of the Connections. Control Blocks are always light blue, the first Connection Blocks are always orange, and Blocks for the second Connection are yellow, Blocks for the third Connection are green, and so on up to eleven Connections.
TIBCO Scribe® Online supports multiple target datastores in Integration Maps. You can integrate data from one source into multiple targets. For example, while integrating your Microsoft Dynamics GP data into Salesforce, you can also send data from the same run to a CSV Text file for reporting purposes. Add Connections to a Map to connect to one or more target datastores.
The first step is to select or create Connections in the Connections panel on the left side of the Map. From the Connections panel, you can:
- Select Add Connection and select an existing Connection from the Connection dialog.
- Select Add Connection and select Create a New Connection in the Connection dialog.
- After selecting a Connection, you can use the Gear menu to do the following:
- Edit — Make changes to the selected Connection. See Editing Connections.
- Reassign Connections — Change a Connection within a Map without recreating each Block that calls that Connection.
- Reset Metadata — Update the metadata for this Connection.
See Resetting Metadata.
Note: Metadata for Text Connections cannot be reset here. See Resetting Metadata For Text Connections.
- Metatdata Status — View a list of the most recent set of metadata requests and the request status for this Connection. See Metadata Status.
- Remove — Delete the Connection. Connections can only be removed if they are not used in the Map.
As soon as a valid Connection is selected, all of the Blocks supported by the Connection display in the Connection panel.
Starting A Map
After you select your Connections, you can begin to create a Map. A Map is a visual representation of the instructions needed to integrate your data. For Integration Maps, the Map always starts with a query.
- From the Connections panel, select the Query Block associated with the Connection you want to use as a data source and drag it to the workspace.
- From the Control section, drag a For Each Result Block and attach it beneath the Query Block.
Note: All Maps require a Query Block, a For Each Result Block, and at least one Source or Target operation Block.
If the For Each Result Block remains transparent, it is not properly attached to the Query Block and the Map does not run. Adjust the Block until it is opaque and attached correctly to the previous Block.
- Select the Query Block.
- Select the General link in the Properties panel to open the Query Block properties.
- Select a source entity.
- Add linked entities and filtering criteria for this Map. After defining the Query criteria, you can open the Block Properties Preview Tab to view the first 25 records in your source.
Note: For certain Connectors, such as Microsoft SQL Server, the Native Query Block is also available. Use the Native Query Block to enter queries in the language provided by that Connector.
When the Query Block is selected, the border changes color:
Building The Map
- Once you have added the Query and For Each Result Blocks, drag and drop the additional Blocks you need from the Connections panel.
- As you add Blocks to your Map, select each Block to open the Properties panel on the right side of the workspace. Select the Block Properties General Tab for that Block. The information available under Properties depends on the specific Block.
Note: Mapping formulas in one Block can access the values returned in preceding Blocks.
- Select Apply to save the Map in its current state. You must save the Map before using Debug mode. See Debugging Maps.
- Continue to add Blocks as needed. For information about how to use each type of Block, see Working With Blocks.