TIBCO Scribe® Online Connector For Variables

Use the Variables Connector to store and retrieve variables as key/value pairs within the execution of a Map. The stored value is retrievable at any point in the Map, regardless of the scope in which it was set. Variables are useful for concatenating strings, finding Min or Max values of numbers or dates, and setting a calculated variable for values that are used throughout the Map execution.

Connector Specifications

  Supported
Agent Types
On Premise X
Cloud X
Replication Services
Source  
Target  
Integration Services
Source X
Target X
Migration Services
Source X
Target X
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 Connector supports the following entities. Click a linked entity name for additional information when using that entity in TIBCO Scribe® Online. For a list of additional operations by entity see TIBCO Scribe® Online Connector For Variables.

Note: In the metadata for the Variables Connector, entities are the data types of the variables being stored.

Standard Operations By Data Type

Entity

Data Type

*Query Create Update Delete Upsert

BoolVariable

Boolean

 

 

 

 

X

DateVariable

DateTime

 

 

 

 

X

GuidVariable

GUID

 

 

 

 

X

IntVariable

Integer32

 

 

 

 

X

NumVariable

Decimal

 

 

 

 

X

StringVariable

String

 

 

 

 

X

*Note: For the Variables, the only Query operation is Lookup. Query and Fetch are displayed but are not useful operations in this scenario.

Selecting An Agent Type For Variables

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

Connecting To Variables

  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.
  4. 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.
  5. Select OK to save the Connection.

Metadata Notes

The Variables Connector provides special entities that represent the data types of key value pairs that can be used in a Map. These entities can be used in Lookup and Upsert Blocks.

Relationships

Relationships are not supported for this Connector.

Variables Connector As IS/MS Source

Consider the following when using the Variables Connector as an Integration or Migration Solution source.

Retrieving Variables

Use a Lookup Block to retrieve a stored variable. Configure the Block as follows:

  1. In the Entity drop-down select the entity that corresponds to the data type of the variable you want to retrieve, such as StringVariable. See the Standard Operations By Data Type table for a list of data type entities.
  2. On the Lookup Criteria tab, in the Field drop-down select name, set the Operator to equals, and enter the name of the variable in the Value field, such as "MyVariable".
  3. On the Field list tab select the val field.

    Note: When retrieving a Variable, include logic to handle a missing Key / Value pair. You can use Error Handling or if Result.RecordsMatched = 0.

Variables Connector As IS/MS Target

Consider the following when using the Variables Connector as an Integration or Migration Solution target.

Storing Variables

Use Upsert to initialize a variable or store the variable information you have collected, calculated, or generated until you need it in a different area of the Map. For example, if you have counted the number of customers you have in a specific region of the country, you can Upsert that count using the Variables Connector. Later you can use a Lookup Block to retrieve the stored value and use it in another Block. To store a variable, add an Upsert Block to your Map and configure it as follows:

  1. In the Entity drop-down select the entity that corresponds to the data type of the variable you want to store, such as StringVariable. See the Standard Operations By Data Type table for a list of data type entities.
  2. On the Fields tab, assign a name to the variable in the name field. This field must always be a string, such as "MyVariable".
  3. Configure the val field with the value of the variable. This can be generated using a formula, it can be a value from the result of a previous Block, or it can be hard coded.

    Note: Best practice is to set the value to NULL to initialize an empty variable in one Upsert Block and then add a second Upsert Block to store the real value.

Sample Map

Note: To download the Sample Map go to the Variables Sample Map Knowledge Base article in the TIBCO Community

In TIBCO Scribe® Online, as data is being processed by a Map, you can use the results of one operation in a subsequent operation.In some cases, the operation results do not persist through the entire Map. For example, operation results for operations within a Fetch Block do not persist outside of the Fetch Block. Using the Variables Connector to set and retrieve variables in a Map resolves this issue.

The example problem solved by the Sample Map is a scenario where a company has duplicate Customer Account records in their database. The company needs to determine which Account record is the most recent and retain the Customer Number to perform an operation using that number later in the Map. The attached Sample Map file illustrates one way to find the Account record that was modified most recently and to set a variable for the associated Customer Number. That variable can be used later in the Map to update the correct Account record or write that record to another datastore or any other operation you might find necessary. The Map is very simple and does not get into determining which records are duplicates. It only demonstrates the use of variables. Each Block in the Map has a brief description that explains the purpose of that Block.

In this Map there are two variables that are being set. The first is a DateVariable, MaxModifiedOn, that contains the modified on date of a record and the second is a StringVariable, CustomerNumber, that contains the Customer Number for the associated Account record. Each time an Account record is retrieved, the Map checks to see if the modified on date for the new record is higher than the prior record. If the date is higher, both the date variable and the Customer Number variable are updated. If the date is lower, the variables are not updated.

The Customer Number variable is retrieved using a Lookup Block outside the Fetch Block.

TIBCO Scribe® Online API Considerations

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

Connector Name

Variables

Connector ID

4C768F92-2C65-442F-9A24-8C3E35D7A37C

License Agreement

The TIBCO Scribe® Online End User License Agreement for the Variables 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.