Data Acquisition Operation

Operation Name

Data Acquisition

Function Overview

Data extraction by specifying table name, Data acquisition by calling SAP query

Data Model

Data model of this type of component is table model type.

Properties

For information about using variables, refer to "variables".

Basic Settings

Item name	Required / Optional	Use of Variables	Description	Remarks
Name	Required	Not available	Enter the name on the script canvas.

Required Settings

Item name	Required / Optional	Use of Variables	Description	Remarks
Type	Required	Not available	Select SAP Query or SAP Table. [QUERY]:(Default) [TABLE]:	If you change [Type], the following items will be changed. [CONFIG ID]:The [CONFIG ID] defined by the configuration tool is set in the list. [CONFIG TEXT]:The set value is cleared. [Item List]:The set value is cleared. [Execution Parameters]:The set value is cleared. [Definition Information]: The set value is cleared. Changing the [type] value changes the display format of the extraction condition and the configuration of the definition information.
CONFIG ID	Required	Not available	Select the [CONFIG ID] defined in the configuration tool.	If you change the value of [CONFIG ID], the following items will be changed. [Setting text]: The value defined in [CONFIG ID] after change is set. [Item List]: The value defined in the changed [CONFIG ID] is set. [Distinguish between uppercase and lowercase letters]: The value defined in the changed [CONFIG ID] is set. [Extraction condition]: The value defined in [CONFIG ID] after change is set. [Variable parameter / variable name]: The value defined in the changed [CONFIG ID] is set. [Variable parameter / value]: The set value is cleared.
CONFIG TEXT	-	-	Display the configuration text defined in [CONFIG ID]
Item List	Required	-	Displays a list of acquisition items defined in [CONFIG ID].	Read the data by the number of items set in the [Item List].
Field Name(Technical Name)	Required	Not available	Displays the item name of the item to be acquired.	The setting value of [Item Name] is reflected in the Mapper's schema.
Description(Text)	Required	Not available	The item name text of the item to be acquired is displayed.

Execution Parameters

Type:QUERY

Item name	Required / Optional	Use of Variables	Description	Remarks
Conditions	-	-	The condition of data selection which you created in Configuration Tool is displayed.
Fields	-	-	The name of selection field is displayed.	The name of the item that defined the extraction condition is displayed in the configuration tool.
Comparison	-	-	The way of comparison you specified is displayed.	The value of the "selection option" of the item for which the extraction condition is defined by the configuration tool is displayed.
Range Type	-	-	The range type is displayed.	The "range" value of the extraction condition defined by the configuration tool is displayed.
Value1	-	-	The value of the condition of data selection which you specified in Configuration Tool is displayed.	The value of "lower limit" or "specified value" of the item for which the extraction condition is defined by the configuration tool is displayed.
Value2	-	-	The value of the condition of data selection which you specified in Configuration Tool is displayed.	The "upper limit" value of the item for which the extraction condition is defined by the configuration tool is displayed.

type:TABLE

Item name	Required / Optional	Use of Variables	Description	Remarks
Conditions	-	-	Display extraction conditions when acquiring SAP table data.	The extraction condition defined by the configuration tool is displayed.

Commons

Item name	Required / Optional	Use of Variables	Description	Remarks
Uppercase/Lowercase	-	-	Displays whether or not uppercase / lowercase letters are distinguished for the extraction condition value defined in [CONFIG ID].	If the setting value is "not do", the extraction condition is converted to all capital letters.
Variable Parameters	Optional	-	Set the dynamic extraction condition value defined in [CONFIG ID].
Variable Name	-	-	The name of the variable set in the extraction condition is displayed by the configuration tool.
Value	Optional	Available	Enter the extraction condition value.

Definition

Type:QUERY

Item name	Required / Optional	Use of Variables	Description
Work Areas	-	-	It shows whether the SAP query to be executed is client dependent or independent type.
User Group	-	-	The user group of the SAP query to be executed is displayed.
SAP Query	-	-	The name of the SAP query to be executed is displayed.
Variant	-	-	Displays the variant used in the SAP query to be executed.
Conversion Type	-	-	The type that shows how to convert the execution result of SAP query is displayed.

Type:TABLE

Item name	Required / Optional	Use of Variables	Description	Remarks
Table	-	-	Displays the SAP table name for which data is to be acquired.
Blank Space Cut	-	-	Displays whether or not to delete the space at both ends of the acquired data.

Commons

Item name	Required / Optional	Use of Variables	Description	Remarks
Login ID	-	-	The login ID used to retrieve SAP data is displayed.	A value that uniquely identifies the login information to the SAP system within the SAP table query adapter.
Header	-	-	Displays whether or not to capture the heading of output data.

Comment

Item name	Required / Optional	Use of Variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this adapter. The description will be reflected in the specifications.

Schema

Input Schema

None.

Output Schema

Depending on the [Item List] setting, the number of columns may be different.

See "Schema of Table Model" for information about output schema.

Loading schema in Mapper

Schema is loaded automatically.

See "Edit Schema" for any details.

Mass data processing

Mass data processing is not supported.

PSP Usage

PSP can not be used.

Available Component Variables

Component variable name	Description	Remarks
count	The number of retrieving the data from SAP system.	The value defaults to null. If error occurs, 0 is returned.
loginId	Contains the login ID used to retrieve the data.	The value defaults to null.
tableName	The name of the SAP table from which data was acquired is stored.	The value defaults to null. if [Type] is [QUERY], an empty string is returned.
userGroup	Contains the user group of the SAP query executed.	The value defaults to null. if [Type] is [TABLE], an empty string is returned.
queryName	Contains the name of the SAP query executed.	The value defaults to null. if [Type] is [TABLE], an empty string is returned.
variant	Contains the variant used to retrieve the SAP query data.	The value defaults to null. if [Type] is [TABLE], an empty string is returned.
message_category	When an error occurs, the category of the message code corresponding to the error that occurred is stored.	The value defaults to null.
message_code	When an error occurs, the code of the message code corresponding to the error that occurred is stored.	The value defaults to null.
message_level	When an error occurs, the importance of the message code corresponding to the error that occurred is stored.	The value defaults to null.
error_type	When an error occurs, the type of error that occurred is stored. java.io.FileNotFoundException format.	The value defaults to null. If no error occurred, returns null. The contents may change depending on version.
error_message	When an error occurs, the message of the error that occurred is stored.	The value defaults to null. The contents may change depending on version.
error_trace	Returns trace information when error occurred.	The value defaults to null. The contents may change depending on version.

About Configuration Tool

The configuration tool is used to configure communication with the SAP system. For details, refer to [DataSpider Servista SAP TableQuery Adapter User's Guide] in the PDF document.

Specification Limits

It is not possible to execute subsequent processing without waiting for the acquisition of SAP data by this component to be completed.
Restrictions on acquiring SAP table data when [TABLE] is specified in [Type] are as follows.
- When acquiring a numeric item, if an item including a decimal point is acquired, part of the value may be converted to "*".
  Example: For items defined as length "10" and number of digits after the decimal point "2" in the SAP system, the decimal point and the numerical value of "10" digit except for the sign are stored up to the maximum. The acquisition length is "10", but the decimal point, the sign "2", the item value is "8" digit.
  When the item value exceeds the length "8" digits, the start value is converted as "*" so that the total length including the decimal point and sign becomes "10" digits.
  If this event occurs, create an SAP query containing the table and obtain the data.
- If the acquisition target table contains the following ABAP data types, an error will occur when acquiring data.
  - FLTP
  - RAWSTRING byte string of variable length
  - SSTRING byte string of variable length(Short)
  - STRING byte string of variable length
- If the total length of selected items is larger than 512, the following conditions must be satisfied.
  - The primary key item exists in the table
  - The sum of the total length of the primary key item and the selected item of the table is not more than 512
  Table data and items that do not match the conditions cannot be retrieved.

Main Exceptions

Exception name	Causes	Solution
InvalidConfigIdException No CONFIG ID found. CONFIG ID:<CONFIG ID>	The tool failed to get [CONFIG ID] with specified ID.	Please change [CONFIG ID] or register the corresponding [CONFIG ID] with the configuration tool.
InvalidConfigIdException Invalid CONFIG ID found. CONFIG ID:<CONFIG ID>	[CONFIG ID] has not been set or the definition information of [CONFIG ID] set is in an illegal format.	When [CONFIG ID] is not set Please set [CONFIG ID]. When [QUERY] is selected for [Type] and [CONFIG ID] is set Please check the access privilege to the following directories. Windows $DATASPIDER_HOME\SAPTableQueryAdapter\config\query UNIX/Linux $DATASPIDER_HOME/SAPTableQueryAdapter/config/query When [TABLE] is selected for [Type] and [CONFIG ID] is set Please check the access privilege to the following directories. Windows $DATASPIDER_HOME\SAPTableQueryAdapter\config\table UNIX/Linux $DATASPIDER_HOME/SAPTableQueryAdapter/config/table
ExecuteCommandFailedException Process canceled. Code:<value>	This adapter failed to connect to SAP system. This adapter found invalid parameters in [Execution Parameters], and so on.	Please check the execution log from "My Log" of DataSpider Studio.

Notes

The saved definition information is automatically loaded when [CONFIG ID] is selected.

When you change the output items / selection items of the SAP query on the SAP system, or change the corresponding SAP query or table setting information in the configuration tool, it is necessary to manually reflect the change contents Yes.

To reflect the changes to the adapter, select the other [CONFIG ID] once, then select the corresponding [CONFIG ID] again.
In that case, mapped links are retained only for mapped elements on Mapper, with the same [Item Name].

Also, if you change [CONFIG ID], the setting value of [variable parameter] will be cleared, so you need to set it again.