Edit Tab

This section provides guidelines about the groups of Edit tab. The Edit tab in Process Runner contains the options related to control parameters, settings, Excel controls, and others.

This section contains the following topics:

• Run Actions
• Lock File
• Excel Controls
• Custom Script and Delays Options
• Clear Temp and Backup File(s)

Only for a Transaction Process file, you can use the options in the Run Options section to include the Error Processing Run or Test Run options that can be used by a run-only user. Also, only for FB01 and FBV1 transactions, you can also use the Data Validation options.

Run Actions

This topic describes how to use the options in the Edit > Run Actions section to run the file. Some of the run options are available only for some of the technologies.

For information about the different run options, see Run Actions.

Lock File

This topic describes how to use the options in the Lock Settings window to prevent users from making changes to a specific Process file.

Refer to the video to understand how Process Runner implements File Locking and Password Protection.

To configure the lock settings,

1. In Process Runner, open the Process file that you want to update.
2. Go to the Edit tab and select Lock File. The Lock Settings window appears.

   

3. In the Lock Basic Operations section, perform the following steps:
   • To ensure that a specific run type cannot be run, in User cannot perform following function, select Run, Test Run, Debug Run, Error Processing Run, Data Governance, and Data Validation depending on your requirements. The Data Validation option is displayed only for Transaction Process files.

     An error message appears when this file is run and if the Run option is disabled.

   • To ensure that the password is entered when saving and opening the file, select User cannot Save the file without valid password and User cannot Open the file without valid password; these options are valid only if password-protection is enabled for the Process file as described in step 5.
   • To disable the Excel section on the Home or Edit tabs when you open the Process file, select User cannot change Excel settings on home tab.
   • To ensure that the Mapper is not displayed in the Mapper tab on the Home or Edit tabs when you open the Process file, select User cannot change Mapper.
   • To ensure that schedules cannot be added, edited, or deleted, select User cannot change scheduler settings.
4. In the Lock Advanced Operations section, select the following options:
   • User cannot change Control Parameters: Indicates that the options in the Control Parameter tab in the Logon and Control Parameters window on the Home tab are disabled.
   • User cannot change Logon & Performance settings: Indicates that the options in the Logon and Performance tab in the Logon and Control Parameters window on the Home tab are disabled.
   • User cannot change Excel Controls settings: Indicates that the options in the Excel Controls tab on the Edit tab are disabled.
   • User cannot change Custom Script and Delays settings: Indicates that the options in the Custom Script And Delays Options tab on the Edit tab are disabled.
   • User cannot change Process Connection settings: Indicates that the options in the Process Connection section under Home or Edit tabs are disabled.
5. To configure a password that must be entered when opening or saving the Process file, perform the following steps in the Add password protection section:
   1. Enter the password, confirm the password, and enter a password hint.
   2. To enter the contact details of the person who can be contacted when the password validation fails, enter the information in the Display this contact information when password validation fails box.

   Note: When you enter a password but do not select either User cannot Save the file without valid password or User cannot Open the file without valid password, Process Runner asks for a password if you have selected Lock File.

6. Select OK.The details are updated.

Excel Controls

This topic describes how to use the options in the Excel Controls section on the Edit tab.

To configure the options in the Excel Controls section,

1. In Process Runner, open the Process file that you want to update.
2. Go to the Edit > Excel Controls and perform the following steps:
3. To run only the filtered rows and not process the rows hidden by the current filter, select Run only filtered row.
4. To display Excel during the run, select Show Excel on Run.
5. The current version of Process Runner does not support iBook functionality, and the Export iBook option is enabled only when a Process file with internal iBook is used. You can use the Export iBook option to remove iBook, compress the Process file, and export iBook data to Excel file manually. Only if you are using a Process file that was designed using 5.20.11 or a lower version, the iBook data is exported as an Excel file to the Process Runner working folder that is configured under Tools > Application> Options > Path, and then is mapped to the Process file automatically.

   

6. To enable Process Runner how to interpret the values stored in the Excel, select one of the following from the Read Excel cell values dropdown list:
   • As Displayed:Process Runner reads the value that is as displayed in the Excel. The value might be rounded off.
   • As Internally Stored:Process Runner reads the original value that is stored internally. The original value is read through.
7. To write the header information to Excel at the end of each run, which is useful when the you must retrieve fields from SAP to Excel, select Field, Description, or Both to indicate the header type and select the execution type as follows:
   • Input field Only: Indicates that the header type must be applied for Excel to SAP run.
   • Output Field Only: Indicates that the header type must be applied for SAP to Excel run.
   • Both: Indicates that the header type must be applied for both Excel to SAP run and SAP to Excel runs.
8. To edit additional settings, click the pop-up icon. For information about how to edit the options in the Basic tab, select Basic Excel Controls. For information about how to edit the options in the Expert tab, select Expert Excel Controls.

Basic Excel Controls

This topic describes the how to configure the basic Excel controls.

To configure the options in Basic tab,

1. In Process Runner, open the Process file that you want to update.
2. Go to the Edit tab and select the pop-up icon. The Basic tab of the Excel Controls window appears.
3. In Read/Write Option section, select the following options:
   • To enable Process Runner to read the value that is as displayed in the Excel file, select Execute only filtered rows.
   • To define the filter parameters, select Filter Excel Rows where Column and enter the values for the additional fields.
   • To enable Process Runner how to interpret the values stored in the Excel, select one of the following from the Read Excel cell values dropdown list:
     • As Displayed:Process Runner reads the value that is as displayed in the Excel. The value might be rounded off.
     • As Internally Stored:Process Runner reads the original value that is stored internally. The original value is read through.
   • To set the limit for Process Runner to check or search, after which Process Runner automatically abort the filter process, enter a value in Blank row threshold for stopping.
   • To write the header information to Excel at the end of each run, which is useful when the you must retrieve fields from SAP to Excel, select Field, Description, or Both to indicate the header type and select the execution type as follows:
     • Input field Only: Indicates that the header type must be applied for Excel to SAP run.
     • Output Field Only: Indicates that the header type must be applied for SAP to Excel run.
     • Both: Indicates that the header type must be applied for both Excel to SAP run and SAP to Excel runs.
4. In the Other Option section, select the following options:
   • To define when to save the Excel file, select an option from the Save Excel dropdown list, enter the value for the additional field, and optionally select Also apply when file is used in Excel Add-In.
   • To display Excel during the run, select Show Excel on Run.
   • (Only for Data Extractor) To use the character set, select from the Character Set dropdown list.
5. Select OK. The changes are saved.

Expert Excel Controls

This topic describes the how to configure the expert Excel controls.

Note: To leave a single data field unchanged, you can use Suppress field on Zero, Suppress field on Blank, or Suppress field on Blank or Zero. Instead of the entire row if we want to suppress only selected fields, we can use dynamic skip type Suppress Field on Blank or Zero or Space(s). For information about how to keep a particular data field unchanged, see F-Suppress Field on Blank or Zero. To suppress multiple fields or when you do not want to send the values for those fields during the Process file run, you can use the feature Disable mapped fields if mapped value in Excel as explained in this procedure.

To configure the options in the Expert tab,

1. In Process Runner, open the Process file that you want to update.
2. Go to the Edit tab and select the pop-up icon. The Basic tab of the Excel Controls window appears.
3. Select Expert and select the following options:
   • To suppress the fields where a particular symbol, such as back slash (/) is encountered in the Excel data during the run, select Disable mapped field if mapped value in excel cell is and enter the symbol in the box. This option is applicable to all the fields where (/) is present in the Excel data.
   • To suppresses if the fields are blank during the run, select Disable mapped field if mapped value in excel cell is blank.
   • To clear all the data from external Excel file before running any Process file, select Clear data from Excel Sheet before each Run and select to either delete all the data from Excel or delete only SAP to Excel Columns; enter the value for the columns.
   • (Only for Transaction) To enable Process Runner to consider the Excel cell values, select Vertical Transaction Repeater (VTR).
   • (Only for Transaction) To determine how the downloaded file must be treated, select an option in the Downloaded File post processing dropdown list.
   • (Only for BAPI/RFM) To determine the cell delimiter, select the option from In Cell-Delimiter dropdown list.
4. Select OK. The changes are saved.

Custom Script and Delays Options

This section contains information about how to configure Process Runner to run before or after the run of other programs or scripts.

Process Runnerallows you to extend its capabilities with external processes using the pre and post-run functionality. The externally called processes can also receive parameters from Process Runner that can be utilized to run its own logic. The called processes can also communicate with Process Runner at the end to provide end-to-end integration.

You can also store scripts written in VBScript or JavaScript internally with the Process file using the iScript option.

Some of the examples where you can use pre-run or post-run external processes are as follows:

• Send automatic email or SMS text message at the end of the each run with status of the run and error count.
• Look at a mount application server, Unix mount point and move the file(s) to appropriate location before or after each run.
• Run a macro to calculate, summarize or perform formatting of external data before each run.
• Downloaded data or report to proprietary software or call third-party importer routine.
• Trigger another application before or after the run.

Using pre-run and post-run with dynamic skips and dynamic formulas, you can create cross-platform and flexible automation solutions.

The section contains the following topics:

• Pre/Post Script
• Custom Process
• Start and Delays
• Control Process Runner from External Process with Return Code

Pre/Post Script

This topic describes how to configure the Pre Script or Post Script options to run an internal script or external file before running the Process file. You can configure both the pre-run and post-run settings at the same time. The external file can be a standard executable file, batch file, a VBScript, JavaScript, or Visual Basic file.

To configure pre-run or post-run script options,

1. Open the Process file for which you want to include the pre-run or post-run script, select Edit tab, and then one of the following options:
   • Pre Script: Indicates that the script is run before the Process file run.
   • Post Script: Indicates that the script is run after the Process file run.
2. Select Pre Script or Post Script. The Pre-Run/Post-Run Process Settings window appears. Perform the following steps:
   1. On the Pre-Run iScript tab, select Pre-Run Process or on the Post-Run iScript tab, select Post-Run Process and select one of the following options from the dropdown list:
      • Internal Script: Allows you to enter a script written in VBScript, JavaScript, or VB.Net in the Internal Script editor box. Optionally, select Insert Sample Code to use one of the sample scripts provided.

        Note: For VB.Net, you can also select from the predefined libraries depending on your requirement. For example, select Innowera Easy Workflow Library to download an EShare file or start a workflow using the Download EShare File or Start Workflow functions. This library is not supported when EShare is configured using the EShare Service URL.

      • External File: Allows you to select an external .exe, .bat, .vbs, or .js file that is on your computer. Optionally, right-click in the parameters text box to view the list of predefined parameters that you can use in the selected external file and ensure that you separate each parameter with a comma.

        Variable name	Description
        #CURPRTYPE#	Displays the type of the current Process file. TX for Transaction BA for BAPI/RFM GS for GUI Scripting DE for Data Extractor
        #CURPROC#	Displays the name of the process, table, or BAPI used in the current Process file. Example: MM02, MARC, BAPI_CREATE_CONTRACT
        #CURPRFILE#	Displays the full path of the current Process file. Example:C:\Innowera\MRRC.ite
        #CURXLFILE#	Displays the full path of the current Excel file. Example:C:\Innowera\test.xls
        #CURXLSHEET#	Displays the name of the current worksheet.
        #CURSAPSYS#	Displays the name of the SAP system used to run the current Process file. Example:PR1, DEV, QAS
        #SAPUSR#	Displays the SAP user name used to log onto the SAP system. Example: JSMITH
        #SAPLAN#	Displays the language of the interface of the SAP system. Example: EN, FR, DE
        #SAPCLIENT#	Displays the client number used to log onto the SAP system. Example: 101, 800
        #SAPSYSTEMNO#	Displays the system number used of the SAP system. Example: 00, 01
        #NOOFREC#	Displays the number of records extracted from SAP. This option is available only for Data Extractor.
        #NOOFCALL#	Number of finished calls after a process completed. This option is available only for Transaction.
        #RUNTYPE#	Displays the run type. 1 for Run 2 for Test Run 3 for Error Processing Run 4 for Debug Run
        #ERRORCOUNT#	Displays the number of errors. This option is available only for Transaction.
        #ERRORSTAT#	Displays the status of the current task; 1 if an error occurs and 0 if the task is run successfully.
        #ERRORMSG#	Displays the error message if the #ERRORSTAT# returns 1. Example: Specify account number. SAP Front end Server: The method got an invalid argument.
        #XLDATASTARTROW#	Displays the Excel row number from where the run starts.
        #XLDATAENDROW#	Displays the Excel row number where the run ends.
        #XLDATASTATCOL#	Displays the statistics column.
        #XLDATALOGCOL#	Displays the log column.
        #ISMASTERPROCESS#	Displays whether the Process file is master file; 1 if it is the master process and 0 if it is not.
        #MASTERXLFILE#	Displays the name of the Excel file used in the master Process file.
        #MASTERXLSHEET#	Displays the name of the worksheet used in the master Process file.
        #MASTERXLDATASTARTROW#	Displays the Excel row number in the master Process file from where the run starts.
        #MASTERXLDATAENDROW#	Displays the Excel row number in the master Process file where the run ends.

   2. In the Process Settings section, select the following options that determine what must be done when an external file is busy or closed:
   • Wait options:
   • 1-No Wait: Indicates that the Process file does not wait for external file if the file is busy or closed.
   • 2-Wait until terminated: Indicates that the Process will waits until the external file gets terminated.
   • 3-Wait until second: Indicates that the Process file waits for specified seconds.
   • Stop on error: Indicates that the Process file stops if the external file or internal script throws an error.
   • Run with normal Run: Indicates that the external file or internal script runs only when you perform a normal run. This option is displayed only for Transaction, BAPI/RFM, and GUI Scripting Process files.
   • Run with Test Run: Indicates that the external file or internal script runs only when you perform a test run. This option is displayed only for Transaction Process file.
   • Run with Debug: Indicates that the external file or internal script runs only when you perform a debug run. This option is displayed only for Transaction and GUI Scripting Process files.
   • Run with Error Processing: Indicates that the external file or internal script runs only when you perform an error processing run. This option is valid displayed for Transaction and BAPI/RFM Process files.
   3. Select OK. The updates are saved.
3. To add a third-party library file that can be used in the custom VB.NET script in the Pre-Run iScript, Post-Run iScript, and Custom Process script editor, select Custom Library > Add. The Add Custom Library window appears. Perform the following steps
   1. Select Add. The Add Custom Library window appears.
   2. In the Library file box, browse to the location on your computer where the library file exists. Process Runner supports only 32-bit library file.
   3. By default, the name of the file selected in the Library file box appears in Library name box. Optionally, you can edit the name.
   4. In the Runtime path for library section, select one of the following options:
      • Reference Path: Indicates the path on your computer where the library file exists, which will be used to run the custom script.
      • Environment Variable: Indicates the variable name that you select from the dropdown list . The variable name is associated with the path in which the library file is placed. Select this option to share the Process file with other users, typically run-only users. To use this Process file, the run-only user must create an environment variable in the System Properties > Advanced tab > Environment Variables with the same name displayed here, and configure the path where the custom library file exists, after adding the library file.
   5. Select Pre-Run iScript, Post-Run iScript, and Custom Process depending on where you want to use the library file.
   6. Select OK. The library file with the configured details appears in the custom library grid.

Custom Process

This topic describes how to configure the Custom Process options to run a script written in VBScript, JavaScript or VB.Net without the involvement of SAP. Typically, when pre-run or post-run scripts are run before or after the Process File run, an SAP connection is established. However, a custom process can be used to verify these scripts and run other external processes.

To create custom process,

1. Open the Process file for which you want to include the custom process script, select Edit > Custom Process. The Custom Process Script Editor window appears. Perform the following steps:
   1. Select the Custom Process checkbox and select the language of the script from the dropdown list.
   2. To place a separate button on the tab to run the custom process, select Run as separate process. Enter the name of the button in the Custom Process button caption box and the tooltip for that button in the Custom Process button tooltip box.
   3. Enter the script in the Internal Script box.
   4. Select OK. The custom script is updated and the button for the custom run appears.

      

2. To add a third-party library file that can be used in the custom VB.NET script in the Pre-Run iScript, Post-Run iScript, and Custom Process script editor, select Custom Library > Add. The Add Custom Library window appears. Perform the following steps: 
   1. In the Library file box, browse to the location on your computer where the library file exists. Process Runner supports only 32-bit library file.
   2. By default, the name of the file selected in the Library file box appears in Library name box. Optionally, you can edit the name.
   3. In the Runtime path for library section, select one of the following options:
      • Reference Path: Indicates the path on your computer where the library file exists, which will be used to run the custom script.
      • Environment Variable: Indicates the variable name that you select from the dropdown list. The variable name is associated with the path in which the library file is placed. Select this option to share the Process file with other users, typically run-only users. To use this Process file, the run-only user must create an environment variable in the System Properties > Advanced tab > Environment Variables with the same name displayed here, and configure the path where the custom library file exists, after adding the library file.
   4. Select Pre-Run iScript, Post-Run iScript, and Custom Process depending on where you want to use the library file.
   5. Select OK. The library file with the configured details appear in the custom library grid.

Start and Delays

This topic describes how to configure the options in the Custom Script and Delays Option window that affects the behavioral characteristics of the post, pre, and ongoing run.

Refer to the video to understand how Process Runner implements starts and delays.

To configure start and delay options,

1. Open the Process file for which you want to configure the start and delay options and select the pop-up icon in the Custom Scripts and Delays Option section. The Custom Scripts and Delays Option window appears.
2. In File Option, select the following options:
   • Run on open: Indicates that Process Runner runs this file as soon as it is opened.
   • Exit after run: Indicates that Process Runner exits automatically as soon as the run is concluded. This option is usually used in cases of periodic scheduled execution.
   • Stop further Processing on first error: Indicates that Process Runner stops further processing as soon as the first error is encountered.
3. In Delay Option, select the following options:
   • Delay before start: Indicates the time duration for which Process Runner waits before the run command is applied. You can use this option to implement the run of scheduled processes.
   • Delay between calls: Indicates the time duration for which Process Runner must wait between the run of each call or the time interval between two calls. If you select this option, Process Runner becomes slow.
   • Delay between lines: (Available only for GUI Scripting) Indicates the time interval that is applicable between the run of each line.
4. Optionally, select Suppress status bar and Excel messages at run time. Process Runner suppresses status bar and Excel messages at run-time.
5. Select OK. The changes are saved.

Control Process Runner from External Process with Return Code

This topic describes the behavior of Process Runner depending on the return code of an external process. External process can return 0 to indicate that there was no error and Process Runner should continue further. Or it can return 1 and indicate that there was an error and Process Runner should not continue further.

This behavior is valid only if you have configured Process Runner to wait for the external process. The following table explains the different scenarios.

The following is an example of a VBScript file with return error and its behavior with process settings.

This script takes command-line parameters and shows them one by one and terminates with error code 0 (no error).  If no parameter is provided, it displays a message and terminates with the error code 1.

The following is an example of a JavaScript file that repeats any statement within the while loop 100 times. It increments the loop variable after each iteration.

For catching the error generated from external application, Process Runner uses the environment variables called PRERRORLEVEL and PRERRORMSG. When the external process wants to return a value as exit status to Process Runner, you can use the environment variables and set its value to the desired exit code. The Pre-run or Post-run feature can catch this value and control further processing accordingly. Process Runner considers non-zero value of that variable as an error state and zero as a success. To get an error message back to Process Runner, you can use the PRERRORMSG environment variable.

Clear Temp and Backup File(s)

This topic describes how to clear the temporary and backup files that Process Runner maintains of each file.

To take a backup and clear the temp file, select Edit > Clear Temp and Backup File(s) in the Other section. By default, the backup files are at Documents\Innowera\Backup.