SAP Batch Input Builder

SAP Batch Input Builder

In this topic ...

Specifying Inputs
Specifying Credentials
Related Topics ...

Overview: Creating Pages and Forms

Use the SAP Batch Input Builder to execute an exported SAP batch input. Using features in the Builder we can parameterize values of the batch process. Additionally, values of the batch can be designated User Inputs.
This Builder parses a recorded SAP batch transaction that has been exported to a file. The Builder displays the transaction steps in a table and we can specify inputs for the Value field for each transaction step within the table. The Builder creates a Java method that can be called to execute the batch operation using SAP s RFC_CALL_TRANSACTION. The Builder also creates a variable that contains the return value from the batch transaction call.
Values of the batch can be designated as User Inputs. When this is done the Builder creates a schema-typed variable that we can use to create an input page to provide inputs for the batch before execution. In this case, a schema-typed variable is created for the specified inputs (the values supplied in the table are ignored).

Specifying Inputs

The Text Builder takes the inputs described in the table below. For help on inputs common to many or all Builders such as those in the Properties and HTML Attributes input groups, see "Using the Builder Call Editor."

Input Name Description
Name Enter a name for this Builder call. The Designer displays this name in the Builder Call List.
Properties File Enter the name of the properties file to be used to establish SAP host server information.
Example: my_sap.properties
This file must be located in the WEB-INF/config/sap_config directory
Test Connection Button Press this button to test the connection to the SAP host server. If the connection is successful, a connection confirmation dialog is displayed
Runtime Credentials Select the type of credentials to use to access the SAP system. We can choose:

Use same credentials properties for all users To use the user name and password credentials specified in the .properties file regardless of which users is running the SAP portlet.
Specify execution credentials To specify a user name and password that will be used by this Builder to access the SAP host server.

Execution User Name This input is available when "Specify Execution Credentials" is selected as the Runtime Credentials input.
Specify an indirect reference to the location used to store the SAP user name. This location might be a variable or method result.
Execution Password This input is available when "Specify Execution Credentials" is selected as the Runtime Credentials input.
Specify an indirect reference to the location used to store the password.
Batch File Specify the name of a recorded SAP batch input that has been exported to a file.
Fetch Contents Button Press this button to re-parse the original batch input file.
You might need to do this if you want to undo any changes to the batch input and reload the original. When this button is pressed, the Batch Table input is initialized with the original batch data
Transaction This display-only field shows the name of the SAP transaction that the batch input file represents.
Batch Table This table shows the relevant steps in the current batch input file.
Display-only columns include:

Program - Name of the ABAP program that the screen belongs to
Dynpro - Four digit screen id within the program
Dynpro_start - Indicates this step is the start of a screen in the batch sequence
Name - Name of the current screen field

Refer to SAP Batch Input processing documentation for additional information about these display fields.(
Columns we can supply inputs for include:

Value - Use this column to specify a constant or indirect value instead of the original value from the recorded batch input.
User Input - This column can be set to either blank or "yes". When set to "yes", the Value field is ignored, and the "Input Name" appears in a schema-type variable. At execution time, the value in this variable will be used for that step of the batch. This variable is useful for creating an input form by using the Data Page Builder.
Input Name - This input is effective when "User Input" above is set to "Yes." Enter here a valid XML element name to be used as the name for the value in the Schema-typed input variable.

Connection Properties Use this input to override any connection properties established in the connection properties file. You might want to do this if you want to profile a value such as the host server name.
Select a property in the Property Name box and provide an input for that property in the Property Value box

Specifying Credentials

You have several options when choosing the credentials used to access the SAP system at portlet execution time. We can use the same credentials for all portlet users if you want all users to use the same user name and password. In many cases, it is desirable to have different credentials for each user. Implementing this feature varies greatly between different brands of portal server, therefore, it is best to refer to the specific portal server's documentation to learn how to implement user-specific credentials.

Objects this Builder Creates

The SAP Batch Input Builder creates the following objects and places them within the WebApp:
Linked Java Objects

[Buildername]Batch - This LJO contains an invoke() method that is the method called to perform a batch execution.

Schemas

[Buildername]_InputSchema - Schema created when any fields are marked as "User Input."
[Buildername]_Schema - Schema which represents the imports, exports, and tables of the BAPI_TRANSACTION_COMMIT all, and can be useful for referencing the returned result structure (same as if SAP Function Call Builder was used to call BAPI_TRANSACTION_COMMIT).

Variables

[Buildername]_Input - Schema-typed variable used as input for batch transaction when fields are specified as "User Input". Uses "[Builder name]_InputSchema"
[Buildername]_Exports - Schema-typed variable that contains the results of the BAPI_TRANSACTION_COMMIT
[Buildername]_Schema - XSD schema representing the data returned by the function. There are child schema elements defined for Imports, Exports, and Tables.

Input Name	Description
Name	Enter a name for this Builder call. The Designer displays this name in the Builder Call List.
Properties File	Enter the name of the properties file to be used to establish SAP host server information. Example: my_sap.properties This file must be located in the WEB-INF/config/sap_config directory
Test Connection Button	Press this button to test the connection to the SAP host server. If the connection is successful, a connection confirmation dialog is displayed
Runtime Credentials	Select the type of credentials to use to access the SAP system. We can choose: Use same credentials properties for all users To use the user name and password credentials specified in the .properties file regardless of which users is running the SAP portlet. Specify execution credentials To specify a user name and password that will be used by this Builder to access the SAP host server.
Execution User Name	This input is available when "Specify Execution Credentials" is selected as the Runtime Credentials input. Specify an indirect reference to the location used to store the SAP user name. This location might be a variable or method result.
Execution Password	This input is available when "Specify Execution Credentials" is selected as the Runtime Credentials input. Specify an indirect reference to the location used to store the password.
Batch File	Specify the name of a recorded SAP batch input that has been exported to a file.
Fetch Contents Button	Press this button to re-parse the original batch input file. You might need to do this if you want to undo any changes to the batch input and reload the original. When this button is pressed, the Batch Table input is initialized with the original batch data
Transaction	This display-only field shows the name of the SAP transaction that the batch input file represents.
Batch Table	This table shows the relevant steps in the current batch input file. Display-only columns include: Program - Name of the ABAP program that the screen belongs to Dynpro - Four digit screen id within the program Dynpro_start - Indicates this step is the start of a screen in the batch sequence Name - Name of the current screen field Refer to SAP Batch Input processing documentation for additional information about these display fields.( Columns we can supply inputs for include: Value - Use this column to specify a constant or indirect value instead of the original value from the recorded batch input. User Input - This column can be set to either blank or "yes". When set to "yes", the Value field is ignored, and the "Input Name" appears in a schema-type variable. At execution time, the value in this variable will be used for that step of the batch. This variable is useful for creating an input form by using the Data Page Builder. Input Name - This input is effective when "User Input" above is set to "Yes." Enter here a valid XML element name to be used as the name for the value in the Schema-typed input variable.
Connection Properties	Use this input to override any connection properties established in the connection properties file. You might want to do this if you want to profile a value such as the host server name. Select a property in the Property Name box and provide an input for that property in the Property Value box