IDoc Renderer

The IDoc Renderer activity receives the IDoc in XML format and provides the output in raw IDoc format. The raw IDoc format is the same as the IDoc sent to the SAP system but no IDoc is posted to the SAP system.

To bypass the SAP Connection validation at runtime for IDoc Renderer activity, you can add the following Java properties in the VM Arguments of TIBCO ActiveMatrix BusinessWorks™ Studio:

• com.tibco.bw.palette.sap.IDocRenderer.disableSAPConnectionValidation = true

• com.tibco.bw.palette.sap.IDocRenderer.isUnicode = false

The com.tibco.bw.palette.sap.IDocRenderer.disableSAPConnectionValidation property specifies the use of SAP connection at runtime to get the Unicode field. If the value is true, then the IDOC Renderer activity uses the com.tibco.bw.palette.sap.IDocRenderer.isUnicode property instead of the SAP connection to get the value of the Unicode field. Set the com.tibco.bw.palette.sap.IDocRenderer.disableSAPConnectionValidation property to true to avoid using the SAPConnection at runtime.

You can use the com.tibco.bw.palette.sap.IDocRenderer.isUnicode property to specify the value for the Unicode field.

 

General Tab

On the General tab, establish connections to the SAP system and download the schema of the IDoc to be used to prepare raw IDoc.

The following table lists the configurations on the General tab of the IDoc Renderer activity:

Field	Visual diff	Module Property?	Description
Name	Yes	No	Specify the name to be displayed as the label for the activity in the process.
SAP Connection	Yes	Yes	Click to select a SAP Connection shared resource. The SAP Connection shared resource establishes connections between the plug-in and the SAP system. If no matching SAP Connection shared resources are found, click the Create Shared Resource to create one. For more information, see Creating and Configuring an SAP Connection. Note: The SAP Connection is used only for design time.
IDoc Name	Yes	No	Click the Fetch IDoc button to download the schema of the IDoc to be posted. In the Search IDoc dialog, complete the following tasks: Specify the IDoc filter to filter out the required IDoc types with the IDoc type name. The IDoc filter supports the wildcard search. The default value of the IDoc Filter field is .*, and the value of this field is case sensitive. Select an IDoc schema type. Basic Type: Select Basic Type if you want to download the IDoc schema of the basic type. Only the basic IDoc types matching the IDoc filter can be filtered out. Extended Type: Select Extended Type if you want to download the IDoc schema of the extended type. The extended IDoc type name includes the name of the basic IDoc type, from which it is extended. Therefore, the extended IDoc types can be filtered out by using the corresponding basic IDoc type name. Click the Fetch IDoc button. Select the IDoc type that you want to download and click OK. Ensure that the selected IDoc type and the associated segments have been released in the SAP system. You need to clear the Download IDoc specific to SAP release checkbox to filter those IDocs that have been released but do not have a release number assigned. After the IDoc schema is downloaded, an XSD file is created. The XSD file cannot be visible in the project, but it can be picked from the activity if required. Note:   After an IDoc schema is downloaded to the plug-in, if new segment definitions are added to the IDoc schema because of the upgrade of the SAP system, you have to refresh the IDoc schema in the plug-in. If the IDoc schema requires to be refreshed from the SAP system, then ensure that the Download IDoc specific to SAP release checkbox is configured accordingly. The Download IDoc specific to SAP checkbox is by default always selected when the user clicks the Fetch IDoc button. By default, the SAP release associated to the SAP Connecction shared resource is shown.

Description Tab

On the Description tab, enter a short description for the IDoc Renderer activity.

Advanced Tab

On the Advanced tab, specify the input mode that use tRFc or qRFC. No queue names are taken.

The following table lists the configurations on the Advanced tab of the Post IDoc to SAP activity:

Field	Visual diff	Module Property?	Description
IDoc Input Mode	Yes	No	The plug-in supports the following protocols: tRFC: Select tRFC if the message delivery in sequence is not required. qRFC: Select qRFC if the message delivery in sequence is required. If you select qRFC from the IDoc Input Mode list, the queueName attribute in the message sent to the destination specified in the Confirm IDoc Destination field contains the value of the SAP Queue Name field. The default protocol is tRFC. Note: While using the raw IDoc output with a subsequent PostIDoc activity the IDoc Input Mode field across these activities should match.

Input Tab

On the Input tab, specify the IDoc data for the selected IDoc.

The following table lists the input elements on the Input tab of the IDoc Renderer activity:

Input Item	Data Type	Description
IDocRendererInput	Complex	Enters the data to prepare the IDoc data into raw format.

For information on how to create IDoc in XML format, see Mapping Data for SAP Palette Activities

Output Tab

On the Output tab, find the information of the posted IDoc.

The following table lists the output elements on the Output tab of the IDoc Renderer activity:

Output Item	Data Type	Description
data	String	Displays the raw IDoc data that was prepared by the input IDoc XML data.

Fault Tab

On the Fault tab, you can find the error codes and error messages of the IDoc Renderer activity.

For more information, see Error Codes.

The Fault tab has the following exceptions:

• SAPPluginException

The SAPPluginException throws an exception and causes the activity to stop.

Error Schema Element	Data Type	Description
msg	String	Displays the error message.
msgCode?	String	Displays the error code.