Using the Lookup mode
The most common pattern for using a Connector in Lookup mode is:
- Using the Config Editor, add a Connector in Lookup mode to your workspace. See Create a Connector.
- Set the mode (Lookup) and other connection parameters for this Connector in the Connection tab; required parameters are marked with an asterisk (*). Some Connectors require you to configure a Parser as well in the Parser tab.
- Set up the Attribute Map; see Input Attribute mapping.
- Open the Link Criteria tab on the Connector configuration window and set up the rules for attribute matching. The outcome of this process will determine which entries are retrieved from the connected system, and here you have a couple of choices:
- Click Add to add a new Link Criterion and select an attribute from the connected system, the matching operator (for example, Equals, Begins With, and so forth) and then the Work Entry attribute to be matched. When the Connector performs the Lookup, it creates the underlying API or protocol syntax based on the Link Criteria you have specified, keeping the solution independent of the type of system used. We can add multiple Link Criteria, which are connected by the Boolean operator AND, together to build the search call.
- We can also select Build criteria with custom script, which opens a script editor window where we can create our own search string, passing this back to the Connector using the ret.filter object. For example:
ret.filter = "uid=" + work.getString("uid");
Note that Expressions can also be used to dynamically specify the Attribute or Value to use for any Link Criteria. See Expressions for information. Also see Link Criteria for more details about Link Criteria.
The attributes that you read (and compute) in the Input Map are available to other downstream Connectors and script logic using the Work entry object.
If you did not create the Connector directly inside an AssemblyLine, then to use the Connector in an AssemblyLine, drag it from its location in <workspace>/Resources/Connectors to the Flow section of the AssemblyLine.
Parent topic:
Lookup mode