Data Provider Editor

Use the Data Provider editor to configure the system settings and interface parameters necessary to retrieve information from external systems. You use data providers in conjunction with Data Instance behaviors to augment order information by retrieving information from external systems.

When configuring system settings and interface parameters in the Data Provider editor, see the following topics:

Data Provider Editor Settings Tab

Use the Data Provider editor Settings tab to configure the external system settings for data providers.

Field Use
Provider Type Select a built-in data provider or a custom data provider that you will create.

You can switch between one provider type and another. If at least one parameter value already exists for the provider type you are changing, a warning message appears indicating that the parameters of the new provider type will replace the existing provider type parameters.

Provider Class If you select Custom in the Provider Type field, you must provide a class name.
Scope Specify how OSM should cache external data instances. Select one of the following cache levels from the Scope field:
  • System (the default): The system caches and reuses external data instances system-wide. Use this scope level if retrieving the external instance is expensive and performed frequently. The system reuses the cached instance results only if the actual resolved values of all parameters are identical and the lookup adapter class is the same.

  • Node: The system caches external data instances at the node level. This level of cache is specific to the user, session, and task. For example, the system retrieves any given external instance when a view node on an order is instantiated. The system reuses the external instance across all instances of the node regardless of how many instances of that view node exist in the order. Use this setting if it is moderately expensive to retrieve the external instance and the field referencing the external instance is a multi-instance node. The system only re-uses cached instances across multi-instance nodes if the actual resolved values of all parameters are identical and the lookup adapter class is the same.

  • None: The system retrieves external data instances for each instance of the field on the order and they are not cached.

Maximum Time, Maximum number cached If you select System or Node in the Scope field, specify the following cache settings:
  • In Maximum Time, specify the maximum time (in milliseconds) for which a cached external instance is valid. For example, enter 5000 to define the <timeout> as 5 seconds.

  • In Maximum number cached, specify the maximum number of actual entries in the cache that is maintained at any one time for this defined external instance.


For information about building a custom Data Provider, see the OSM Developer's Guide.

Related Topics

Working with Data Providers

Data Provider Editor

Defining Data Instance Behavior Properties

Data Provider Editor Interface Tab

Use the Data Provider editor Interface tab to define the input parameters and default settings for the external system and specify the provider class and cache settings.

Field Use
Parameters When you create a new data provider, Design Studio displays all of the mandatory and optional parameters based on the selected provider type. Mandatory parameters are shown with an asterisk (*) to differentiate them from optional parameters.

Click Add to add an input parameter, and select the new parameter to rename it. Input parameters specify named parameters whose values are used when retrieving an external instance. The value is determined at run time and is based on the XPath or XQuery expression you define in the Default Value field.

Default Value Define the content of the associated parameter element as an XPath to a node or as an XQuery expression.
  • XPath supports functions in expressions and provides for a core library of functions dealing with strings, numbers, Booleans, and node sets. In addition to the core XPath functions defined by the XPath standard, a number of extended functions are supported with OSM. These extended functions provide additional functionality that is useful to create behaviors but does not conform to the XPath standard. For more information about XPath functions, see OSM Developer's Guide.

  • XQuery enables the use of sophisticated expressions and XML transformations. XQuery syntax is backwards compatible with XPath 1.0 and contains additional syntax elements. You can use XQuery in situations where a more expressive language or transformation abilities are needed.

Result Document (Optional) Specify the structure of the XML document. Though this field is optional, if you do not provide an XML structure, the system will not display the parameters on the Data Instance Behavior Properties tab.

Note:

XPath and XQuery fields are limited to 4000 characters

Related Topics

Working with Data Providers

Data Provider Editor Settings Tab

Defining Data Instance Behavior Properties