Stereotype Attributes
SAPAliasSAP Alias
| Multiexcerpt |
|---|
| MultiExcerptName | sap_taggedalias_valuesattributes |
|---|
|
| Attribute | Description | Mandatory / Optional | Allowed Values | protocol | Supply the
|---|
Name
| Specify a name for the alias. | connection protocol | mandatory | rfc | to use the RFC protocol | | trfc | to use the tRFC protocol | | host | Supply the gateway host name (optional). | mandatory | a valid SAP host | | localhost (default) | | 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) | client | Supply the SAP logon client. | mandatory | a valid SAP client | | user | Supply user and password. | mandatory | pattern "<user>/<password>" | | 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 | systemNumber | Supply the system number of the SAP system. | optional | default = "00" | | 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 | poolSize | | Multiexcerpt |
|---|
| | MultiExcerptName | pool_size |
|---|
| Supply the maximum system 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 | | 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 | 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. | 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 | |
SAPModuleInterface
This stereotype has no attributes.
SAPRPCOperation
...
| MultiExcerptName | SAPRPCOperation |
|---|
| shouldDisplayInlineCommentsInIncludes | false |
|---|
...
...
any valid string
default: <soap port type name>_<operation name>_Response
| Code Block |
|---|
<wsdl:message name="myReponseName">
<wsdl:part name="output" type="stns1:OutputClass"/> |
...
...
any valid namespace string
default: urn:<containment tree path>.<port name>
| Code Block |
|---|
<wsdl:input>
<soap:body [...] namespace="myInputNamespace"/> |
...
...
any valid namespace stringdefault: urn:<containment tree path>.<port name>| Code Block |
|---|
<wsdl:output>
<soap:body [...] namespace="myOutputNamespace"/> |
SAPParameters
This stereotype has no attributes.
SAPStructure
This stereotype has no attributes.
SAPIDocAttribute
...
| MultiExcerptName | SAPRPCOperation |
|---|
| shouldDisplayInlineCommentsInIncludes | false |
|---|
...
| 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 stringdefault: 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
Parameters
SAPRFCAdapter
| 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 SAPParameters 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 SAPParameters 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 SAPParameters 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 the SAPTablesstereotype SAP Tables.
The attributes and associations of this class correspond to the parameters given the tables section of the ABAP function declaration. | |
...