IDocEncode
The service converts an IDoc list to an XML string in a format specified by the SAP IDoc-XML specification.
- Input parameters
-
- $encoding
- Optional. Specifies the encoding that is used in the output document's XML header, for example, iso-8859-1
- iDocList- OR -
- Contains the IDocs as object of the type com.sap.conn.idoc.IDocDocumentList.
- IDOC_CONTROL IDOC_DATA- OR -IDOC_CONTROL_REC_40IDOC_DATA_REC_40
- Both keys are document lists (Tables) containing the control and data tables for the IDoc. The
SDATA field is a document object containing the keys and values from the
segment table. The name of the segment table is specified by the SEGNAM
field. Note: This service handles both IDoc versions 2 and 3. The difference between the two is that, for IDocs version 2, the service looks for IDOC_CONTROL and IDOC_DATA in the pipeline. For IDocs version 3, it looks for IDOC_CONTROL_REC_40 and IDOC_DATA_REC_40.
Note: You can specify the iDocList or IDoc tables that contain IDOC_CONTROL and IDOC_DATA or IDOC_CONTROL_REC_40 and IDOC_DATA_REC_40 in the input parameters.
- Return values
-
- xmlData
- String. IDoc in XML. The XML format is consistent with the SAP-XML specification.
Example
This service is most often used when you want to receive an IDoc from an SAP system and convert
it to XML.
- Invoke IDocEncode. It takes the pipeline that contains the IDoc as input and converts it to an XML string. The XML string is accessible in the pipeline through the xmlData key.