Logging_Service Process Definition
The SAP Readiness Validator used a shared logging service process definition, named Logging_Service, to handle the writing of functional and technical API success and failure messages to the TIBCO BusinessWorks process engine log.
Logical Flow
The Logging_Service process definition consists of Start and End nodes, and a Write To Log activity. A schema defines required and optional input parameters for the process. The process definition is illustrated below.
Components
The following chart describes the TIBCO BusinessWorks activities that comprise the Logging_Service process definition.
Activity Name | Input | Output | Dependencies |
|---|---|---|---|
Start | APIReturnLog schema instance, with required fields populated | None | None |
Log | APIReturnLog schema instance, with required fields populated | Line appended to BusinessWorks process engine log indicating API technical or functional success or failure | None |
End | None | None | None |
Logging_Service Process Definition Components
Input Schema
The input schema for the Logging_Service process is called APIReturnLog. The following chart describes the required and optional input parameters of this schema.
Node Name | Cardinality | Type | Value Restrictions | Comment |
|---|---|---|---|---|
LeadingText | Required | String | Recommended format: "[Action] [Object] Step n: [API Name]" For example: "Create Part Step 1: BAPI_MATERIAL_SAVEREPLIC A" | |
FunctionalorTechnical | Required | String | "F" or "T" | Indicates whether logging functional ("F") or technical ("T") API invocation results |
Success | Required | String | "true" or "false" | "true" indicates the API was invoked successfully; "false" indicates a failure |
TYPE | Optional | String | Mapped directly from the API Return structure for API functional success and failure messages. Standard SAP message types include: • S (Success) • I (Information) • W (Warning) • E (Error) • A (Abend) | |
ID | Optional | String | Mapped directly from the API Return structure for API functional success and failure messages. SAP message IDs are also known as message classes. | |
NUMBER | Optional | String | Mapped directly from the API Return structure for API functional success and failure messages; typically, this is a three-digit number. | |
MESSAGE | Optional | String | Mapped directly from the API Return structure for API functional success and failure messages; this is the SAP API return message text. | |
StackTrace | Optional | String | Mapped directly from the TIBCO BusinessWorks error transition for API technical failure messages. |
Logging_Service Input Schema, APIReturnLog