Skip to main content

xSuite Interface Windows Prism 5.x – Online Help

Task "XSuiteHelixLookupImport"

The following properties apply specifically to the task of type "XSuiteHelixLookupImport." This task transfers master data from SAP or another local data source to the Lookup Service in the xSuite Helix Cloud.

Notice

This procedure is obsolete. Use the "XSuiteHelixDataImport" task instead.

Property

Description

Schedule[].Task[].Database.ConnectionString*(§)

Schedule[].Task[].Database.Select*

Schedule[].Task[].Database.Password(§)

In the .ConnectionString property, specify the connection string to the source database from which data is transferred to the xSuite Helix Cloud. In .Select, specify the appropriate database query.

For both properties, use the same syntax as for the connection of external data sources in the context of a scenario configuration (see External Data Sources). The same data sources are also supported.

The password required in the connection string can be defined separately in .Password. The variable %Password% can then be used to include the password in the string.

Schedule[].Task[].Lookup.Url*

Schedule[].Task[].Lookup.RequestTimeout

Schedule[].Task[].Lookup.Keycloak*

Schedule[].Task[].Lookup.ProxyServer

Connection data for the lookup service in the xSuite Helix Cloud

In .Url, specify the base address of the web service. Omit sub-paths, but include the port number. In RequestTimeout, specify a timeout value in seconds, to define how long the web service will wait for a response before an error is thrown (default value: 100).

For .Keycloak, always set the properties for authentication (see Keycloak Authentication).

For .ProxyServer, specify the proxy server used for the connection to the cloud (see Proxy Server Connection) (optional).

Schedule[].Task[].Lookup.DataSource.Name*

Schedule[].Task[].Lookup.DataSource.KeyField

Schedule[].Task[].Lookup.DataSource.Clear

Schedule[].Task[].Lookup.DataSource.MaxBatchSize

Schedule[].Task[].Lookup.DataSource.SignalUpdate

Properties of the target data source in the lookup service

When specifying .Name, always use the name of the target data source.

.KeyField (optional) defines the name of a field from the .Field[] list, whose value is set as an additional key (Key property) of each transferred record.

The Boolean value .Clear specifies whether the content of the data source will be cleared before a new data transfer is started (default value: true).

.MaxBatchSize defines how many records are transferred in one call of the lookup service at maximum at the same time (default value: 100). With the value 1, a record-by-record transmission is performed instead of batch-by-batch transmission.

.SignalUpdate defines whether and the in which way the lookup service will be signaled after all records have been sent, indicating that the transfer is complete for the data source. Choose one of the following options:

  • None: no immediate signaling

  • Self: immediate signaling for the current data source (default value)

  • All: signaling for current data sources and all data sources from previous tasks of the same schedule worker instance that have not yet been signaled, as a result of the None mode preventing it

To ensure that for all data sources transfer and common signaling is not performed until the end, define one task per data source within a schedule-worker instance. For all tasks but the last, use the None mode; for the last task, use the All mode.

Schedule[].Task[].Localize.GroupByField[]*

Schedule[].Task[].Localize.KeyField*

Schedule[].Task[].Localize.ValueField*

Schedule[].Task[].Localize.PropertyName

Schedule[].Task[].Localize.KeyMapping[]

Properties for localizing data records to be transferred (optional)

This requires specially structured source data records. Related data sets that represent the same content in different languages must be returned in immediate succession in the query result. A language-specific value (e.g., an article description) is permitted for one field only. In some predefined queries, these kinds of source data records are provided by systems such as "SAPWMDQUERY."

In .GroupByField[], specify the names of field(s) from the .Field[] list. The names must share a common key value for common records. These data sets will be flagged as belonging to one common group. When specifying language-specific parts of a data set, define .KeyField and .ValueField as the fields that contain the language identifier and value in that language.

When transferred to the lookup service, the records defined with a common key value are combined to form a single group. Only for the corresponding language-dependent part of a data set is a multiple value transferred. The value is composed of pairs consisting of language indicator and value specification. You can configure the name of the property for these value pairs by using .PropertyName (default value: Localization).

If the language tags from the source records do not match those expected by the lookup service, you can map them as needed (e.g., from "E" to "en-US").

Map them in .KeyMapping[] as values with 2 subparameters:

  1. Key*: source language code

  2. Value*: target language code

Schedule[].Task[].Field[]*

Definition of the fields to be transferred from the source system to the target system

Make field specifications in the form of multiple subparameters. Source fields that are not explicitly specified will be ignored.

  1. Name(*): name of the field in the source record

  2. JsonProp*: name of the property in the target data set

  3. Macro: field macro expression for generating or formatting field content

Base the name of the source field on the source system. In a relational database, for instance, the name should correspond to the field name returned by the SELECT query. However, do not give calculated or aggregated fields a dedicated name. If you have not given these fields an explicit name per AS clause, the fields will be given the pseudonym "Column {field number}". For the source system "SAPWMDQUERY," the name always corresponds to the value in the metadata field "E_LISTDESC.FNAME" of the query result.

The Name parameter is also used to reference a source field by name in other configuration properties (e.g., .Lookup.DataSource.KeyField). If the field value does not come from the source record, but rather is generated by a macro function out of an artificially created field, then you can leave the parameter empty.

The target dataset is a JSON object. The JsonProp parameter is the name of the property in this object. If the parameter value consists of several properties separated by a point, you can create structured sub-objects. Each property represents a single structural level.

By default, the data types of the values are retained in the form in which they have been read from the source system. You can integrate required transformation functions into an SQL-SELECT query. Alternatively, the Macro parameter can be used for a conversion.

The primary purpose of the Macro parameter is to prepare the content of the value of a read field before transferring it to the lookup service. Syntactically, this must be a field macro expression that returns the modified value. Within the expression, the original field value can be addressed via the variable @Value. However, this option does not apply if the macro is used to generate the value of an artificially generated field (i.e., a field that does not originate from the source data).

Schedule[].Task[].ContentLogFolder

Folder path where the full contents of the records transferred to the lookup service are logged (optional)

This feature is primarily for the purposes of analysis and should not be used in normal operation.