Lookup Editor Editor Tab

Use the Editor tab for defining the input parameters to the lookup and output parameters produced by the lookup.

Lookup and Lookup Properties

Field Use

Description

Specify a description for the Lookup editor.

Type

Select one of the following to specify the format of the lookup:

  • JAR

    This option requires no parameters as the lookup logic is in the lookup class selected in the Class field.

  • SQL

    This option requires the parameters jdbc:sqlStatement and jdbc:dataSource.

  • javascript

    This option requires the parameters bsf:scriptEngine and bsf:script.

  • webservice

    This option requires the parameters WebServiceEndPoint, WebServiceName, TargetNamesapce, NSPrefix, RequestOperationName, RequestMessage, ResponseOperationName, and ResponseMessage.

  • xpath

    This option requires the parameter xpath:function.

Notes:

  • The specified file type should have the same file name as the lookup and its filename extension must be .js or .sql, depending on the type of file (javascript or SQL).

  • The specified file must be packaged in the cartridge.

Class

If you selected JAR in the Type field, select the class in the jar file that performs the lookup. See "Selecting Lookup Class for JAR Format" for more information.

ASAP will run the main method within the specified class when the lookup is called.

No Caching

Select if the results of the lookup are not to be cached in the memory. Use this option if the data is variable, and therefore no benefit is derived from caching in memory and retrieving (but is slower than cached information).

Session Caching

Select if the results of the lookup are to be cached in the memory for the duration of the session (should the results be needed again by another lookup or service bundle). A session is the time it takes to fulfill the upstream request. Use this option if multiple clients with different information want to share a cache.

Global Caching

Select if the results of the lookup will remain available until the cache timeout expires.

Cache Max Size (entry)

Specify the maximum number of actual entries in the cache that will be maintained at any one time. In this field, you can enter a maximum value of eight numeric characters. This field is available for Session Caching and Global Caching.

Cache Timeout (ms)

Specify the number of milliseconds for which the cache is valid. In this field, you can enter a maximum value of eight numeric characters. This field is available for Session Caching and Global Caching.

Lookup Details

Field Use

Add

In the Input Parameters tab, click to add input parameters to the lookup. The parameters you specify here could represent parameters being passed in from the upstream on the work order, or parameters that have been generated by another lookup, or both.

Name

In the Input Parameters tab, click on a parameter and edit in the Input Parameter Details area, as required, the name of the parameter.

Mapping Type

In the Input Parameters tab, click on a parameter and select any one of the following from the list:

  • Select Environment Setting to enable you to configure an environment variable as an input to the lookup. You may also specify a default value to assign to the variable if the environment variable is not actually defined at runtime.

    Note: The Use Environment ID check box is not applicable to ASAP.

  • Select Input Parameter to specify that a parameter will be provided to the lookup, as specified in the Upstream Interface Parameter field, from the incoming transformed XML document.

  • Select Lookup to specify that a parameter will be provided to the lookup from the output of another lookup that executes prior to this one. You must select the Lookup name and Lookup Output Parameter as follows:

    - Lookup: Name of another lookup in the same project.

    - Lookup Output Parameter: Another lookup's output parameter which will be an input to this lookup.

Add

In the Output Parameters tab, click to specify the new output parameters produced by the lookup.

Name

In the Output Parameters tab, click on a parameter and edit in the Output Parameter Details area, as required, the name of the parameter.

XPath

In the Output Parameters tab, click on a parameter and specify the xpath, in the Output Parameter Details area, associated with the parameter created by the lookup (all Design Studio lookups return an XML document. The xpath is used to specify the location of the desired parameter within the XML document). An example of a simple XPath would be //MCLII.

Description

In the Output Parameters tab, click on a parameter and enter a description of the parameter in the Output Parameter Details area.

Related Topics

Configuring Lookups