SAP Function Call builder inputs - Portlet Factory v6.1.2

Portlet Factory, Version 6.1.2

SAP Function Call builder inputs

This topic describes the inputs for the SAP Function Call builder.

Table 1. SAP Function Call builder inputs
Input Name Description
Name Name for this builder call. The WebSphere Portlet Factory Designer displays this name in the builder call list.
Connection

Properties File Enter the name of the properties file to be used to establish SAP host server information.
Example: my_sap.properties
Note: 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. You 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.
Function Selection

Search Pattern Enter a string to be used as search criteria for a function. You can use an asterisk (*) as a wildcard at any location within the search string.
For example, entering DDIF_* returns all functions whose name starts with DDIF.
Search for Functions Press this button to start a search.
When the search is complete, the SAP Function input contains a list of functions matching the search pattern.
SAP Function Use this select box to choose a function to call.
When you select a function in the list, a description of the function is displayed below the list.
Description A read-only field that displays a brief description of the selected function.
Enable Schema Caching Use this check box to enable the caching of the schema for the specified SAP Function. When enabled, the builder's regeneration phase uses a cached version of the function's schema. If a different function is selected a new version of the schema will be cached.
Selecting this option provides two benefits:

Enhanced Performance

This helps during editing models containing this builder.

Enhanced Security

A cached schema avoids exposing model generation time credentials once an initial regen has been performed. To leverage this specify to use separate runtime credentials.

Note: If the schema for the data changes on the SAP server, disable this input, regenerate the model, and enable this input again.
Function Inputs

Function Inputs If you know the function you are calling accepts optional inputs, you can enter Input Names and Input Values in this table. These Function Inputs can be used instead of getting inputs from the user in an input form.
For example, if you want to supply a constant value to an input you can do it here. Or, if you are using this builder to call a function using data from a row in a table of results, you can use values from the SelectedRowData variable as inputs. (See the SAPObjectBrowser model for some examples of this.)
These inputs will be set in Imports before the function is called and the values you define here override previously established values in the Input variable
Advanced

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
Commit Transaction Enable this to commit transactions to the SAP database as a result of this function call.
Use tables as function inputs Enable to use a table as an input to a function call.

Parent topic: SAP Function Call builder

Library | Support |

Input Name	Description
Name	Name for this builder call. The WebSphere Portlet Factory Designer displays this name in the builder call list.
Connection
Properties File	Enter the name of the properties file to be used to establish SAP host server information. Example: my_sap.properties Note: 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. You 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.
Function Selection
Search Pattern	Enter a string to be used as search criteria for a function. You can use an asterisk () as a wildcard at any location within the search string. For example, entering DDIF_ returns all functions whose name starts with DDIF.
Search for Functions	Press this button to start a search. When the search is complete, the SAP Function input contains a list of functions matching the search pattern.
SAP Function	Use this select box to choose a function to call. When you select a function in the list, a description of the function is displayed below the list.
Description	A read-only field that displays a brief description of the selected function.
Enable Schema Caching	Use this check box to enable the caching of the schema for the specified SAP Function. When enabled, the builder's regeneration phase uses a cached version of the function's schema. If a different function is selected a new version of the schema will be cached. Selecting this option provides two benefits: Enhanced Performance This helps during editing models containing this builder. Enhanced Security A cached schema avoids exposing model generation time credentials once an initial regen has been performed. To leverage this specify to use separate runtime credentials. Note: If the schema for the data changes on the SAP server, disable this input, regenerate the model, and enable this input again.
Function Inputs
Function Inputs	If you know the function you are calling accepts optional inputs, you can enter Input Names and Input Values in this table. These Function Inputs can be used instead of getting inputs from the user in an input form. For example, if you want to supply a constant value to an input you can do it here. Or, if you are using this builder to call a function using data from a row in a table of results, you can use values from the SelectedRowData variable as inputs. (See the SAPObjectBrowser model for some examples of this.) These inputs will be set in Imports before the function is called and the values you define here override previously established values in the Input variable
Advanced
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
Commit Transaction	Enable this to commit transactions to the SAP database as a result of this function call.
Use tables as function inputs	Enable to use a table as an input to a function call.