Stereotype Attributes
SAP Alias
Multiexcerpt |
---|
MultiExcerptName | sap_alias_attributes |
---|
|
Attribute | Description | Mandatory / Optional | Allowed Values |
---|
Name
| Specify a name for the alias. | mandatory | any string | Standard
|
---|
user | Supply user and password. | mandatory | pattern "<user>/<password>" | options | A blank separated list of name value pairs: name1="value1" name2="value2", and so forth. The possible name value pairs can be found further below. | optional |
| host | Supply the gateway host name (optional). | mandatory | a valid SAP host | localhost (default) | language | Supply the SAP logon language. | optional | 1-byte SAP language like E for English, D for German | 2-byte ISO language like EN for English, DE for German | client | Supply the SAP logon client. | mandatory | a valid SAP client | routerString | The router string is an additional routing information used by SAP RFC backend clients. SAP RFC clients prepend the DNS hostname with this string to get an application server name that is resolvable by the RFC library. | optional |
| systemNumber | Supply the system number of the SAP system. | optional | default = "00" | sapTrace
| The effect of this flag being true is two fold: The SAP RFC libraries will write trace file information (.trc) into the directory the service has been deployed to. By using the SAP transaction *SMGW (SAP gateway monitor), you can monitor the dataflow from and to the gateway the server is registered on.
The SAP trace level has to be defined in attribute connectionString. See Client Connection Options for a list of the allowed trace level values. | optional | true | Switch SAP trace on. | false | Switch SAP trace off. | protocol | Supply the connection protocol | mandatory | rfc | to use the RFC protocol | trfc | to use the tRFC protocol | poolSize | Multiexcerpt |
---|
MultiExcerptName | pool_size |
---|
| Supply the maximum number of parallel connections to the SAP system. The pool size can be defined per connection string. If you have multiple aliases with the same connection string, the highest value will be used. The same applies, if you set the values in the SAP adapter settings in the Administration. If all connections from the SAP connection pool are in use, warnings will be logged to the transaction log each second a service is waiting for connection. 2015-12-08 16:47:24 +0100 0000000182469dcd0001612899fea700e3d869aa 3 SAPConnectionPool 0 OK SAPRFC IO_ENTER PoolExhausted
2015-12-08 16:47:25 +0100 0000000182469dcd0001612899fea700e3d869aa 3 SAPConnectionPool 1000 OK SAPRFC IO_EXIT PoolExhausted
In this case, increase the pool size to solve the problem. |
| optional | default = 10 | |
SAP Adapters
Applicable for the follwong SAP adapters: SAP RFC, SAP TRFC, SAP TRFC Confirm Transaction, SAP TRFC Create Transaction.
Attribute | Description | Allowed Values / Examples |
---|
alias | Specify the SAP alias the adapter should use to establish the connection. | any valid SAP alias |
SAP Module Interface
This stereotype has no attributes.
SAP RPC Operation
Multiexcerpt |
---|
MultiExcerptName | SAPRPCOperation |
---|
shouldDisplayInlineCommentsInIncludes | false |
---|
|
Attribute | Description | Mandatory / Optional | Allowed Values / Example |
---|
rpcResponseName | Use to overwrite the RPC response message name in the WSDL. | | any valid string default: <soap port type name>_<operation name>_Response Code Block |
---|
<wsdl:message name="myReponseName">
<wsdl:part name="output" type="stns1:OutputClass"/> |
| soapInputNamespace | Use to overwrite the SOAP input namespace in the WSDL. | | any valid namespace string default: urn:<containment tree path>.<port name> Code Block |
---|
<wsdl:input>
<soap:body [...] namespace="myInputNamespace"/> |
| soapOutputNamespace | Use to overwrite the SOAP output namespace in the WSDL. | | any valid namespace string default: urn:<containment tree path>.<port name> Code Block |
---|
<wsdl:output>
<soap:body [...] namespace="myOutputNamespace"/> |
| |
SAP IDoc (Class)
The stereotype SAP IDoc is used on a class to mark it as SAP IDoc class. This stereotype has no attributes.
SAP IDoc Attribute (Class & Property)
Multiexcerpt |
---|
MultiExcerptName | SAP_iDocAttribute |
---|
shouldDisplayInlineCommentsInIncludes | false |
---|
|
Attribute | Description | Mandatory / Optional | Allowed Values |
---|
decimals | Specify the number of decimals for native type DEC . | mandatory for native type DEC | an integer value | offset
| Specify the offset of the attribute data within the serialized IDoc segment. | mandatory | any integer value | externalLength | Specify the parameter length as given in the ABAP dictionary (except for FLT, INT, DATS, TIMS). | mandatory | an integer value | nativeType
| Specify the native ABAP type. For allowed types and valid internal/native type combinations see Native SAP - ABAP - xUML Base Type Mappings. | mandatory | a valid ABAP native type as listed on Native SAP - ABAP - xUML Base Type Mappings |
|
SAP Parameters (Class)
Anchor |
---|
| sap_parameters |
---|
| sap_parameters |
---|
|
The stereotype SAP Parameters is used on a class to mark it as SAP parameter class. This stereotype has no attributes.
SAP Structure (Class)
Anchor |
---|
| sap_structure |
---|
| sap_structure |
---|
|
The stereotype SAP Structure is used on a class to mark it as SAP structure class. This stereotype has no attributes.
SAP Tables (Class)
The stereotype SAP Tables is used on a class to mark it as SAP tables class. This stereotype has no attributes.
SAP Adapter Operations
SAPTRFCCreateTransaction Operation
SAPTRFCCreateTransaction ( connectionString : String, transactionID : String )
Name | Type | Direction | Description |
---|
connectionString | String | in | Supplies the connection string (optional). |
transactionID | String | out | Returns the transaction ID of the newly created transaction. The transaction ID is logged as correlation ID to the transaction log (see Administration Guide > Contents of the Transaction Log).
|
SAPTRFCConfirmTransaction Operation
SAPTRFCConfirmTransaction ( connectionString : String, transactionID : String )
Name | Type | Direction | Description |
---|
connectionString | String | in | Supplies the connection string (optional). |
transactionID | String | in | Supplies the transaction ID of the transaction to be confirmed. The transaction ID is logged as correlation ID to the transaction log (seeAdministration Guide > Contents of the Transaction Log). |
SAPIDocComposer Operation
SAPIDocComposer ( anyObjectFlow : Any, idocString : String )
Name | Type | Direction | Description |
---|
anyObjectFlow | Any | in | Multiexcerpt |
---|
MultiExcerptName | anyObjectFlow |
---|
| Parsed IDoc object(s) The class specifying the type of this parameter must have stereotype SAPIDoc. |
|
idocString | String | out | Multiexcerpt |
---|
MultiExcerptName | idocString |
---|
| String containing IDoc data (e.g. the content of an IDoc file). |
|
SAPIDocRecordComposer Operation
SAPIDocRecordComposer ( anyObjectFlow : Any, EDI_DC40 : EDI_DC40[], EDI_DD40 : EDI_DD40[] )
Name | Type | Direction | Description |
---|
anyObjectFlow | Any | in | Multiexcerpt include |
---|
MultiExcerptName | anyObjectFlow |
---|
PageWithExcerpt | SAP |
---|
|
|
EDI_DC40 | Array of EDI_DC40 | out | Array of IDoc structured control records. |
EDI_DD40 | Array of EDI_DD40 | out | Array of IDoc structured data records. |
SAPXMLIDocComposer Operation
SAPXMLIDocComposer ( anyObjectFlow : Any, idocBlob : Blob )
Name | Type | Direction | Description |
---|
anyObjectFlow | Any | in | Multiexcerpt |
---|
MultiExcerptName | anyObjectFlowXML |
---|
| Parsed IDoc object(s) The class specifying the type of this parameter must have stereotype SAPIDoc and XML. Info |
---|
The input object must be named exactly after the root element of the IDoc, e.g. TXTRAW01. If not, the model will throw an exception at runtime. |
|
|
idocBlob
| Blob | out | Multiexcerpt |
---|
| Blob containing IDoc data (e.g. the content of an IDoc file). |
|
SAPIDocParser Operation
SAPIDocParser ( anyObjectFlow : Any, idocBlob : Blob )
Name | Type | Direction | Description |
---|
idocString | String | in | Multiexcerpt include |
---|
MultiExcerptName | idocString |
---|
PageWithExcerpt | SAP |
---|
|
|
anyObjectFlow | Any | out | Multiexcerpt include |
---|
MultiExcerptName | anyObjectFlow |
---|
PageWithExcerpt | SAP |
---|
|
|
SAPIDocRecordParser Operation
SAPIDocRecordParser ( EDI_DC40 : EDI_DC40[], EDI_DD40 : EDI_DD40[], anyObjectFlow : Any )
Name | Type | Direction | Description |
---|
EDI_DC40 | Array of EDI_DC40 | in | Array of IDoc control record strings |
EDI_DD40 | Array of EDI_DD40 | in | Array of IDoc data records strings |
anyObjectFlow | Any | out | Multiexcerpt include |
---|
MultiExcerptName | anyObjectFlow |
---|
PageWithExcerpt | SAP |
---|
|
|
SAPXMLIDocParser Operation
SAPXMLIDocParser ( idocBlob : Blob, anyObjectFlow : Any )
Name | Type | Direction | Description |
---|
idocBlob
| Blob | in | Multiexcerpt include |
---|
MultiExcerptName | idocBlob |
---|
PageWithExcerpt | SAP |
---|
|
|
anyObjectFlow | Any | out | Multiexcerpt include |
---|
MultiExcerptName | anyObjectFlowXML |
---|
PageWithExcerpt | SAP |
---|
|
|
SAP Adapter Parameter Types
EDI_DC40
Tip |
---|
For a detailed description on the structure of ECI_DC40 and EDI_DD40 see SAP documentation. |
EDI_DD40
Tip |
---|
For a detailed description on the structure of ECI_DC40 and EDI_DD40 see SAP documentation. |
Parameters
SAP RFC Adapter
Multiexcerpt |
---|
MultiExcerptName | parameters_saprfcadapter |
---|
|
Name | Type | Direction | Description |
---|
connectionString | String | in | Supplies the connection string (optional). | import | Any | in | The class specifying the type of this parameter must have stereotype SAP Parameters. The attributes and associations of this class correspond to the parameters given by the import section of the ABAP function declaration. | export | Any | out | The class specifying the type of this parameter must have stereotype SAP Parameters. The attributes and associations of this class correspond to the parameters given by the export section of the ABAP function declaration (see the export parameters in SAP). | changing | Any | in/out | The class specifying the type of this parameter must have stereotype SAP Parameters. The attributes and associations of this class correspond to the parameters given by the changing section of the ABAP function declaration | tables | Any | in/out | The class specifying the type of this parameter must have stereotype SAP Tables. The attributes and associations of this class correspond to the parameters given the tables section of the ABAP function declaration. | |
Client Connection Options
Via the SAP alias and the configuration descriptor you can get the protocol and the connection string. This string looks like:
name1="value1" name2="value2" ...;
Example: client="100" lang="D" ashost="10.160.99.122" sysnr="00" trace="1"
Note |
---|
The connection string must be provided in the following format: <optionName>="<optionValue>"<space><optionName>="<optionValue>"... If you do not conform with this pattern, this can lead to options not being recognized. Those errors won't be reported, but affect SAP behavior (e.g. you'll get a SAP connection error with CALL_FUNCTION_SIGNON_INCOMPL ). Pay attention that the names are not case-sensitive but the values are. Depending on the RFC server, some of these names are fix and some of them are optional. |
List of Available Options
Name | Description | Values | Default |
---|
ABAP_DEBUG | RFC with ABAP debugger | 0 | without Debugger | 0 |
1 | with Debugger |
ASHOST | Host name of a specific application server (R/3, No Load Balancing) |
|
|
|
CFIT | Conversion Fault Indicator Token. This flag determines substitute symbol for received Unicode characters, which could not be converted by the RFC library. |
|
| non Unicode systems 0x23, Unicode systems 0xfffd, or defined by environment variable RFC_REPL_CHAR |
CODEPAGE | The given codepage is to be used for this connection (Default is either 1100 or set by RfcSetSystemCodepage or is set by SAP_CODEPAGE environment variable). Could be rather useful if the sapgui should be started with codepage differs from 1100. |
|
|
|
COMM_CP | When communication has to be established between an Unicode Library and a Non Unicode system, all char like data will be converted into codepage which matched to logon language before send them. This codepage is called communication codepage. The effect of this method is that the Non Unicode System is sure to talk an system with communication codepage and not with an Unicode system. Usually the RFC Library determines automatically the communication codepage. Using this option it is possible for the programmer to set the communication codepage directly. This option is only active in the Unicode version of the RFC library. |
|
|
|
DEST | Destination in saprfc.ini if working with saprfc.ini. If the RFC server is an R/2 system this destination must also be defined in the 'sideinfo' for the SAP gateway. |
|
|
|
GROUP | Name of the group of application servers (if using Load Balancing) |
|
|
|
GRT_DATA | SAProuter connect data for SAPGUI when using RFC with SAPGUI. /H/...... : the whole router string for SAPGUI. /P/password: If the password for the SAPGUI connection is not the same as the one for the RFC connection. |
|
|
|
GWHOST | Host name of the SAP gateway (if server is R/2 or External) |
|
|
|
GWSERV | Service of the SAP gateway (if server is R/2 or External) |
|
|
|
ICCE | Ignore Character Conversion Errors. This flag determines the runtime behavior of the RFC library concerning character conversion. If this flag is 1, the concerned API will not exit with error, but replace the character which could not be converted with CFIT defined token. | 0 | not ignore | 0 or defined by environment variable RFC_IGNORE_CONV_ERROR |
1 | ignore |
IDLE_TIMEOUT | Inform the Web Application Server to close the connection after idle time in seconds. |
|
|
|
LCHECK | Logon check at OPEN time | 0 | without check | 1 |
1 | with check |
MSHOST | Host name of the Message Server (if using Load Balancing) |
|
|
|
MSSERV | Service of the Message Server (if using Load Balancing) |
|
|
|
NEWPASS | Changes the password during logon Note |
---|
On SAP system kernel older than 46C the password is sent in clear text on the network! |
|
|
|
|
PCS | Partner's Char Size. The RFC-library determines automatically the partner's char size at open time (using logon check) or at first call time (without logon check). This flag tells directly the Unicode RFC library to open a connection to a system with size of char given by this value. - If the partner is not an Unicode system but the value of the PCS flag is 2 an error will occur (runtime exception in the remote system).
- If the partner is a Unicode system but the value of the PCS flag is 1 the connection kind will be switched automatically. This field works only with Unicode library.
| 1 | Non Unicode | 1 |
2 | Unicode |
R3NAME | Name of the SAP system (if using Load Balancing) |
|
|
|
SAPLOGON_ID | String defined for SAPLOGON on 32-bit Windows |
|
|
|
SNC_LIB | Path and name of the SNC-library |
|
|
|
SNC_MODE | Working with SNC | 0 | without SNC | 0 (see RFC_SNC_MODE) |
1 | with SNC |
SNC_MYNAME | Own SNC name if you don't want to use the default SNC name |
|
|
|
SNC_PARTNERNAME | SNC name of the SNC partner (RFC server) or SNC name of the message server (Load Balancing) |
|
|
|
SNC_QOP | SNC Quality of service |
|
| 8 (RFC_SNC_QOP_DEFAULT, see RFC_SNC_QOP) |
SYSNR | SAP system number (R/3, No Load Balancing) |
|
|
|
TOUPPER | conversion of user and password to upper case for sending to Web Application Server | 0 | do not convert password to upper | 1, i.e. convert to upper case |
1 | convert password to upper |
TPHOST | Host name of the external RFC server program |
|
|
|
TPNAME | Path and name of the external RFC server program or Program ID of an registered RFC server program. Anchor |
---|
| trace_client_connection_options |
---|
| trace_client_connection_options |
---|
|
|
|
|
|
TRACE | RFC trace level | 0 | Errors only | 1 |
1 | Error messages and warnings |
2 | Error messages and a short trace |
3 | Error messages and a complete trace |
TYPE | RFC server type, 2/3/E: R/2 or R/3 or External System |
|
| 3 |
USE_SAPGUI | RFC with SAPGUI. If the sapgui is to be started with codepage differs from 1100, please use option CODEPAGE to define the codepage you need. | 0 | without SAPGUI | 0 |
1 | with SAPGUI |
2 | invisible SAPGUI |
WAN_CONN | RFC via Wide Area Network. - If LAN is used, all tables bigger than 8000 Bytes will be compressed before sent.
- If WAN is used, all tables bigger than 250 Bytes (or value defined by environment variable RFC_WAN_THRESHOLD) will be compressed before sent. The table size will be calculated as follows: table_length * number_of_rows.
| 0 | LAN | 0 |
1 | WLAN |
Alternative Login Possibilities
Name | Description |
---|
ALIAS_USER | An alias user name, could used instead of user or even together with USER. If both USER and ALIAS_USER are used, than they have to be match. |
EXTIDDATA | Contains valid external user's ID of an external authentification system. User name is optional. External ID is to be defined in the backend (SAP-System). |
EXTIDTYPE | Defines the kind of external identity. Valid only with EXTIDDATA. Follow values are not allowed: ID, NT; DN, CA, X, HX. Additionally, RFC Library provides the feature to retrieve MYSAPSSO2 certificate from the backend after successful logon. |
GETSSO2 | Request to create a cookie version 2 using given password and user name. If the value is 1, the cookie will be generated from user and password values given by USER=user and PASSWORD=password in the same connect_param string. Instead, user and password X.509 certificate could be used. If the RfcOpenEx call ended successfully, the generated SAP cookie version 2 can be retrieved via RfcGetTicket API. |
MYSAPSSO | SAP Cookie Version 1. Will be used instead of user and password for logon to backend |
MYSAPSSO2 | SAP Cookie Version 2. Will be used instead of password for logon to backend. In this case, user name is optional. |
X509CERT | An X.509 certificate will be used instead of password to logon to SAP System. In this case, user name is optional. |