Working With Blocks
Integration Maps are built using a series of Blocks that represent operations. To create a Map, drag and drop Blocks from the Connections panel to the Map workspace. Each Block represents an operation. For example, the Query Block, which is only available as a source, creates an operation similar to a SQL SELECT statement to define which source entity and source records drive the execution of your entire Map.
Integration Maps include the following Block types:
- Source and Target Blocks —Allow you to perform operations on source or target data, respectively. Except for the Query Block and Native Query Block, which are only available with Source data, the following Source and Target operation Blocks may be available, depending on the operations supported by the selected Connector:
- Control Blocks — Determine the flow of execution for a Map. Every Map requires a For Each Result Block, but within the For Each Result loop, you can include an If/Else Block or a For Each Child Block to add complex processing options. Some Connectors have specialized Blocks, such as the Void Block for the Connector for Microsoft Dynamics GP. See Control Blocks for more information.
- Comment Blocks — Group sets of Blocks together and add useful information about the Blocks. See Comment Blocks for more information.
Note: When you use a Source Block within the Map to request an operation on a Source entity, the source-side entity is called the Target within the Block.
Each Map type has some Blocks that are unique to that type of Map, such as a Query Block for Integration Maps and a Wait For Message Block for Event Message Maps. However, most Blocks can be used across all Map types.
Manipulating Blocks In The Workspace
As you drag and drop Blocks onto the workspace, the top border of the Block changes color when the Block is in position.
Hold down the Shift key to select multiple Blocks in a Map. From the Gear menu for the first selected Block select standard cut, copy, and paste operations to manipulate Blocks, or stacks of Blocks, in the workspace. When you cut or copy one or more Blocks, those Blocks are saved to the clipboard. Blocks can be pasted into another Map in another Solution or even a Map in a different Organization.
Tip: Blocks pasted into another program, such as NotePad++, are pasted in the JSON format generated by the Export Maps option and used by the TIBCO Scribe® Online API and export Maps.
Note: When you select a Block to copy or delete, ALL of the Blocks below the selected Block are treated as a "stack" and copied or deleted along with the original Block. If the series of Blocks is very large you could have difficulty dragging the entire "stack" to a new location.
Select the workspace canvas to paste Blocks there without pasting them into an existing stack of Blocks.
Gear Menu Options
Note: The Block can either be part of a Map or elsewhere in the workspace.
Block properties for Blocks that are moved out of the active stack of Blocks cannot be modified, nor can you use Query Preview. Move the Block into the active stack, edit the Block, and then move it back out of the active stack. See Query Block for more information on active and inactive stacks.
- From the workspace, select a Block. The Gear menu displays.
- Select the Gear menu to:
- Edit — Open the Properties dialog for the selected Block.
- Cut — Cut the selected Block and save it to the clipboard to be pasted elsewhere.
- Copy — Copy the selected Block and save it to the clipboard.
- Paste — Paste the current contents of the clipboard to the workspace. Drag the Block into a Map.
Note: You can paste stacks to another Map in either the same or a different Solution. However, you cannot paste Blocks to another type of Map, for example, you cannot paste Blocks from a Map to a Message Map.
- Delete — Permanently delete the selected Block. If this is the Query Block, all Blocks below the Query Block are also deleted.
- Assign Connection — Assign a Connection to the selected Operation Block. Only enabled when a Block's Connection does not match a Connection in the Map. For example, if you have pasted Blocks from one Map into a second Map and the Connections for those Blocks do not exist in the second Map, you can use the Assign Connection option to Assign one of the current Map Connections to the new Block or Blocks. Any other Blocks in the stack with the same Connection in the prior Map are also updated. Control Blocks are not associated with a Connection and never have the Assign Connection option enabled.
Note: If you have added a new Connection, but have not saved the Map, the new Connection is not available under the Assign Connection option.
- Set Active Stack — If you have more than one stack of Blocks on the workspace, this option marks one stack as Active. The Active Stack executes when the Map is run and all other stacks are ignored. This option is only available on the Query Block.
- Rename — Renames the selected Block and updates all references to that Block throughout the Map. If you enter a duplicate name, an error is displayed. The first Block in the map, such as Query or NativeQuery, cannot be renamed. Names must start with a letter and cannot contain spaces, or special characters, such as an underscore.
Note: Text displayed in the Block on the Map is a label, not the name of the Block. The Block Label can be changed in the Edit dialog for the selected Block. Block name is displayed in the Properties tab on the right side of the workspace when you select the Block, and in the Edit dialog for the Block. Name is used when referring to the block elsewhere in the Map and can only be changed using the Rename menu option.
- Change Block Type — Modify the operation type of an existing operation Block configured in a Map. For example, you can change the operation within the Block from Insert to Upsert instead of deleting the old Block and configuring a new Block. See Changing Block Operation Type.
- Cut, copy, and paste Blocks as needed. When you are done, save your Map.
Tip: Before you cut or delete one or more Blocks, a warning message displays. Select Cancel if you want to stop the operation.
Note: Once you delete a Block, you cannot retrieve it. You must to move a new Block into the workspace and reconfigure it. If you accidentally delete one or more Blocks, you can select Cancel to close the Map without saving it. All work done on the Map since the last time you saved the Map is lost.
Select a Block in a Map to edit or view useful information about the Block in the Properties panel without opening the Block. The information displayed depends on the Block, but generally includes:
- Description — User specified text with a description of the Block.
- Block Label — The label is also a combination of the operation type for this Block and the selected Entity. It is the display name for the Block in the Map editor and can be changed to better describe steps in this Map.
- Block Name — Specified by TIBCO Scribe® Online. The Block Name is a combination of the Connection Alias, operation type, and the selected Entity if required. You must use this name to refer to this Block in mapping formulas in the Formula Editor. To rename a Block, select the Edit icon to open the Rename Block dialog.
- Entity — Source or target entity. You can select an entity using the drop-down menu.
As you enter data into each of the tabs on the Block Properties dialog, select the Validate button to ensure that all of the entries are correct. The Errors and Warnings tab displays the number of Errors and Warnings at the top and lists each issue individually. Selecting OK also validates as it saves the Block information.
If your Map is complex, it may become long enough that it no longer fits in your workspace. In this case, you can:
- Use the Group Block to group and collapse sets of related Blocks, such as an If/Else Block.
- Use the scroll bar on the right side of the palette to view portions of the Map