EI_Config – Other configuration settings

 

 

 

The worksheet EI_Config contains other configuration setting described in the table below:

Row/ ID

Configuration setting

Description

License

13/14/15/16/17

License key to a SAP system 1/2/3/4/5

Obsolete. Not used from version 2.50 and above.

18

License key to a computer

Obsolete. Not used from version 2.50 and above.

General settings

EI_C_NAME

EasyInputName

The name displayed in all EasyInput worksheets in the fifth row.  Usually the name is connected somehow to the script/ scripts name.

EI_C_DS_ID

DataSheet

The reference to the data sheet. The data sheet must exist and have the required structure. 

EI_C_DS_START

DataStartRow

The first row, from which data starts on the data sheet. The default value is 10, but can be given a larger value (>=10) . 

EI_C_DS_END

DataEndRow

Optional. Usually left empty (then the last row will be searched automatically). Separate transactions can be separated by up to 4 empty rows.

EI_C_PREV_DOUBLE

PreventDoublePosting

Optional. Can be left empty or have X value.  When set to X, then it is impossible to run actual mode for all records (the user still cen use actual run for new records and for errors).

EI_S_STOP_ON_ERROR

StopOnFirstErrorResult

Optional. Can be left empty or have X value.  When set to X, then after the first Error result, the scripts is stopped and further data will not be processed.

EI_C_BACKUP_BEFORE

MakeDataBackupBefore

Opitional. Can be left ampty, filled with O or A values. When filled with O/A values than data sheet will be copied after EasyInput run. For A (all) it will be done allways. For O (only for actual) it will be done only for actual runs. 

EI_C_BACKUP_AFTER

MakeDataBackupAfter

Opitional. Can be left ampty, filled with O or A values. When filled with O/A values than data sheet will be copied after EasyInput run. For A (all) it will be done allways. For O (only for actual) it will be done only for actual runs. 

EI_C_DEBUG_DET_MESG

DebugMode DetailedMessages

Optional: Can be left empty or filled with X value. When set to X, messages contain more echnical information. Used mostly, when debugging scripts. Should normally be left empty.

EI_C_SKIP_IND

SkipFieldIndicator

Sign, that designates data not to be transfered. Can be left empty or have value that rarely shows in the script ,e.g. „/”. When configuration setting “Delta” is set, than if the data contains the value defined by SkipFieldIndicator, than the corresponding script line is not transferred to SAP.

EI_C_SKIP_DELTA

Delta – do not pass SkipField values

Optional. Default value = X. When set to X, the data fields containing SkipFieldIndicator will be omitted in the script.  When empty, EasyInput will not check data fields values and transfer them all to the script (apart form completely empty rows). 

EI_C_WAIT_TIME

WaitTime AfterTransaction

When one script contains several transactions, that should be called one after another, and when the transactions data is relates, the user may force EasyInput to wait after each transaction for the system have time to post it correctly, before the start of the next transaction. The delay is stated in milliseconds. Setting anything greather than 0 will have negative influence on EasyInput performance. 

EI_C_SUBLEVEL_REQUIRED

SublevelRequired

Sets the default for the sublevel data. If set to X, than the system assumes, that the sublevel data (e.g. line items) are required. If not set, than sublevel data is treated as optional (may or may not be present in the data sheet). The default setting on the configuration worksheet can be overriden by the order ending:

_O – optional

_R – required

EI_C_SAP_GUI_USE

UseSAPGUI

Forces use of SAP GUI to process script data. Some moder transactions will not work without this setting.

EI_C_LOOP_BACK

LoopBackwards

If set, the sublevel data is processed from the last data row to the beginning. This is usefull, when transactions are recorded that way, that the data is always added in the first row, and allows the posted data to keep the order given in data sheet.

EI_C_AUTO_LEVEL_ORDER

Automatic

LevelOrder

InDataSheet

If set the system tries to establis level/order on data sheet automatically based on the data entered by user. This can only work If the script does not contains overlapping data (various level/order assigned to one data column). For most of the scripts this requirement will be fulfilled.

EI_C_MESSAGE_TYPES_PRESENTED

MessageTypesPresented

Allows filtering the message types presented with the filtering string. String examples:

* - all messages

E – only error messages (type E)

ES – error and informational messages (E and S)

EWISA – error messages of types EWISA

EI_C_MESSAGE_VALUE_READ_STRING

ReadValueFromMessage (ID-Nr-Param-Column

[-Start-Length])

Allows copying one of the four message paramters of a chosen message (V1, V2, V3 or V4) to the selected data sheet column. This option is sometimes used to read back the document number given in a message. Example of a correct parameter:

F5-312-V1-AH or F5-312-V1-AH-1-10 (first 10 characters)

Importnt: From version 3.03 B1008 on it is possible to use the VX identifier instead of V1, V2, V3, V4. When VX is used all four message parameters are copied to selected data column separated by “|” character. E.g: F5-312-VX-AH

EI_C_MESSAGE_VALUE_CELL_CLEAR

ClearMessageCellsAtStart

By default active - “X”. This parameter switches on clearing the data worksheet cell to which part of the message will be copied  (see EI_C_MESSAGE_VALUE_READ_STRING). The clearing operation is performed before first transaction of the script for the given transaction data row. Normally the parameter should stay switched on, unless one wants to execute separate scripts on the same data and message that have been read in the first script should be used in the second one.

EI_C_TEST_MODE_PRESENT

TestModePresent

If set to “X” than the test run is excluded from the dropdown list in the menu combo box. Useful when only actual run is to be performed (some function modules always commit changes and test mode cannot be easily implemented)

EI_C_FM_RET_FIRST_ROW

FirstReturnLineInTheSameRow

Decides that if table is returned from function module, than the first row will be put into the last row of calling parameter (used when only one row expected)

EI_C_RET_MERGE_LEVELS

MergeReturnTablesForReporting

Decides whether, for mass data reading, merging of higher level return rows with lower level data (e.g. headers data added to line items). Used sometimes in OData scripts for easier reporting. Usually used together with EI_C_FM_RET_FIRST_ROW parameter (then only line items enriched with header data are visible).

EI_C_FM_RET_HEIGHT

ReturnedRowHeight

Decides of the hight of rows for table type returned data. If set to 0 then the height is taken from the row above the inserted row. Used in FM and OD scripts that can return tables.

EI_C_RESULT_CHECK_STRING

ResultCheckingString

The result of the script call is set as follows:

-         If the called function module raises an exception, than the result is set to error

-         If the called function module/ transaction does not raise an error and return messages then these messages are analyzed according to ResultCheckingString.

The most popular setting is:

E-E, where, the first E depicts that by default there will be success unless an error is found out. The second E depicts the fact that if there is a message of type E, than it is treated as an error.

The full syntax of ResultCheckingString is:
E or S-Type[-Id][-Nr][| E or S-Type[-Id][-Nr]], where message ID and message Nr are optional.

Examples:

E-E (error when message type E detected)

S-S-01-102 (success when message type S from class 01 and with number 102 detected)

E-E|S-S (for test run result based on error detection and for actual run result based on success)

EI_C_MESS_DEL_BUTTON

MessagesDeleteButton

Allows switching on additional EI ribbon button, when on data worksheet. This button serves clearing last EI run results.

Example values:

X

A27 or AA10:AQ1000  (additional area to be cleared)

EI_C_DATA_DEL_BUTTON

DataAreaDeleteButton

Allows switching on additional EI ribbon button, when on data worksheet. This button serves clearing all data entered on the data worksheet.

Both messages and data are cleared when the button is pressed. 

Example values:

X

21:1000 or AA10:AQ1000  (other area to be cleared than default one)

EI_C_SHOW_PROGRESS

ShowProgressWindow

Allows displaying the progress window. Possible values:

Empty – no progres window

X – progress window always

S – progress window above 200 data lines

Number e.g. 300 – progress window above given number of data lines

EI_C_DATASHEET_AUTO_SWITCH

AutoSwitchToDataSheet

Allows automatic switching to another data sheet if two or more scripts are defined, that use different data worksheets. Possible values are:

Empty – no switching

X – switching, when script changed

H – switching plus old data worksheet hiding when script changed

EI_C_JOIN_DATA_SHEETS

JoinDataFromSeparateSheets

Switches on acces to additional functionality of joining together data from separate worksheets and copying the result to the script data worksheet. Usefull when e.g. header lines and line items are given on separate worksheets. More about this functionality can be found here.

EI_C_DO_NOT_ASK_4_ACTUAL

DoNotAskAboutActualRunStart

Switches off the popup message to ask whether the user really wants to start EI in actual mode. When set (“X” value), acs the same way as hiding the data worksheet (for hidden data worksheet also no additional question for actual mode is generated). 

EI_C_HIDE_RIBBON

HideEasyInputRibbonMenu

Switches off the EasyInput Ribbon menu. Can be set (“X” value) when VBA macros are used to start EasyInput functions.

To switch the menu ribbon back on, if needed, one has to unhide EI_Config worksheet and change this settings back.

EI_C_HIDE_RUN_TYPE

HideRunTypeSelection

Hides the EasyInput menu part – combo box “Run type”. Usefull for scripts with only one run type e.g. for scripts reading data.

EI_C_CONFIG_PASS

ConfigurationPassword

Allows locking configuration (when hidden, that entering password will be required to show configuratiion from the menu). Warning! There is always the possibility to unnhide the EI_Config worksheet manually and check the password there.

TR settings (transactional script settings)

EI_C_TR_SFM

StandardRunFunctionModule

Decides whether the standard SAP module is used, or the module provided by SNP Poland (BCC). If the transport request furnished with the full version of the program is not implementerd in the SAP system only the SAP function module can be used.

EI_C_TR_EFM

ExtendedRunFunctionModule

Decides whether the standard SAP module is used, or the module provided by SNP Poland (BCC). If the transport request furnished with the full version of the program is not implementerd in the SAP system only the SAP function module can be used. Warning! Extended SAP module requres E-CATT swich active on the client level and additional user authorizations.

EI_C_TR_DEBUG

DebugModeScriptTesting

Opitional. Can be left empty, filled with A or E values. Used when debugging scripts. When A/E is set only the first data pack (usually one transaction) is performed with the option to show SAP GUI screen (A= all screens, E= only screens with errors). Additionally the script generated for the first data package is saved as a text file EI_Debug_*.txt. Such a file can be imported in SHDB transaction an tested in SAP GUI. The text file is saved to My Documents folder. When this option is switched on (E/A) then the status (Error/OK) of manually analyzed transaction is not set by the system in the data sheet.  This option should be used carefully, when script debugging and only in SAP test systems.

EI_C_TR_MODE

Mode

Distinguishes between EasyInput operation modes:

B-Standard – batch input set to X, only write

C-Extended – batch input cleared, write and read allowed

 

When only  writing data to SAP the standard mode can be used. Important! The extended mode can be used only in the full version of the product and requires the SAP system administrator to upload transports requests provided with the full version installation files.

Important! The scripts for the standard (batch input = ‘X’ and extended batch input = ‘ ‘ modes can be different for some transactions). One should take it into consideration when recording script with SHDB transaction.

FM settings (BAPI/ functional script settings)

EI_C_FM_CFM

GenericConversion FunctionModule

Decides whether the standard SAP module is used for the not handled internally conversions, or the module provided by SNP Poland (BCC). If the transport request furnished with the full version of the program is not implementerd in the SAP system, only the SAP function module can be used.

EI_C_FM_RET_TRIM

TrimReturnedStrings

Decides, that the strings returned will not have leading/trailing spaces.

EI_C_FM_DEBUG

DebugModeScriptTesting

Opitional. Can be left empty or filled with X value. Used when debugging scripts. When X is set only the first data pack (usually one transaction) is performed with the option to show data passed to FM on EI_Debug worksheet. When this option is switched on (X) then the status (Error/OK) of analyzed transaction is not set by the system in the data sheet.  This option should be used carefully, when script debugging and only in SAP test systems.

EI_C_FM_COMMIT

BAPI commit after actual function call

Decides whether after each actual function module call the commit with the BAPI_TRANSACTION_COMMIT should be executed (needed for newer BAPI methodes)

GS settings (SAP GUI Script)

EI_C_GS_TRY_ATTACH

TryAttachingToOpenSAPGUI

When used, the SAP GUI scripts at first tries to attach to an open SAP GUI session. If this is not possible then, the scripts open its own special session. Important one can force the standard SAP GUI use instead of special script session by setting the parameter: EI_C_SAP_GUI_USE.

EI_C_GS_DEBUG

DebugModeScriptTesting

Used when debugging scripts. When A or E is set only the first data pack (usually one transaction) is performed with the option to show data passed to script on EI_Debug worksheet. When this option is switched on (A or E) then the status (Error/OK) of analyzed transaction is not set by the system in the data sheet.  This option should be used carefully, when script debugging and only in SAP test systems.

When used together with EI_C_DEBUG_DET_MESG DebugMode DetailedMessages, then additional worksheet (EI_Debug) with debugging information is created and more detailed messages are available.

EI_C_GS_TESTTOOLMODE

TestToolModeOn

Switches the test tool mode used by SAP GUI scripting. When in test tool mode, SAP GUI scripting is more reliable. Both recording and playing should be done with test tool mode switched on. When in test tool mode:

•While success (S), warning (W) and error (E) messages are always displayed

in the statusbar, information (I) and abort (A) messages are displayed as pop-up

windows unless testToolMode is set.

•The update mode of the application server is changed to immediate mode for

the connection.

•System messages are ignored so that they do not interrupt the recording or

playback of scripts.

EI_C_GS_END_TRANS

AutoCloseTransaction

Switches on automatic close of SAP transaction (/n) at the end of each EasyInput transaction. Usually good, so the next transaction start from the same point. In some cases, when the user wants to force second easyinput transaction to use gui state of the first transaction (e.g. for performance reasons) this can be switched off. 

OD settings (OData Script)

EI_C_OD_MATCHING_LEVEL

ResultMatchingLevel (0 = strict matching)

Can be filled with natural values equal or larger than 0. If set to 0, then exact matching of result values with result definition is performed (e.g. if in export section returned field is defined as d-result-material-text, then only exat mach willl be treated as the correct result value. If return result may differ depending on data quantity/ url parameter one can set ResultMatchingLevel e.g. to 3. Then seraching is done for instead for exact value (d-result-material-text)  for partly matching value *resut-material-text (independent on the beginning).

Note, that the user can also define export parameter explicitly with asterisk at the beginning (e.g. *error-message), so that only the ending must mutch for this export parameter.  Then for this parameter the ResultMatchingLevel parameter is not taken into account.

EI_C_OD_AUTO_PROTOCOL

DefaultProtocol

 

May be set with three values:

&cprotocol&

http

https

Important! If set to  &cprotocol&, then EasyInput first check in SAP if https protocol can be used, and if yes, than uses https protocol. If https cannot be used then http is used.

One can use http value to force http service calls.

EI_C_OD_AUTO_HOST

DefaultHost

May be set to host address (e.g. www.odata.org) or to &chost& tag.

If &chost& is used, then Gateway host will be taken from the SAP system automatically.

EI_C_OD_AUTO_PORT

DefaultPort

May be set to host port (e.g. 443) or to &cport& tag.

If &cport& is used, then Gateway port will be taken from the SAP system automatically.

EI_C_OD_DEBUG

DebugModeScriptTesting

 

Opitional. Can be left empty or filled with X value. Used when debugging scripts. When X is set only the first data pack (usually one transaction) is performed with the option to show data passed to/from OData on EI_Debug worksheet. When this option is switched on (X) then the status (Error/OK) of analyzed transaction is not set by the system in the data sheet. This option should be used carefully, when script debugging and only in SAP test systems.

 

See also EasyInput global settings topic.