IDocReader Bean
Properties Methods Events Configuration Settings Errors
The IDocReader component is used to parse IDoc documents.
Syntax
InERP.Idocreader
Remarks
The IDocReader bean allows you to easily parse an IDoc from a file, a stream, or from memory. You can parse documents that are formatted in either plain text or XML. To do so, you need to follow the steps below:
- Import schema, this can be done one of two ways:
- Use the ImportSchemaFromSAP method to retrieve the schema directly from SAP
- Use the ImportXMLSchema method to retrieve the XML schema directly from disk
- Load the IDoc Data into the bean using one of the following methods:
- Specify the file to read in the InputFile property
- Provide the data directly from memory using the InputData property
- Set the input stream using the SetInputStream method
- Call the Parse parse method
During parsing, the bean performs basic validation of the incoming document. If validation fails, a warning is generated, and the Error event will fire, populating the ErrorOffset property with the offset in the document where the error occurred.
In order to navigate the document, you will need to use the XPath
property, like so:
/segmentA[1]/childSegmentC[2]/grandChildSegmentA[1]
This example path means that the bean will select the first grandChildSegmentA in the second childSegmentC in the first segmentA.
Property List
The following is the full list of the properties of the bean with short descriptions. Click on the links for further details.
Connected | Indicates whether or not the component is connected to the SAP system. |
ControlRecordData | Control record data of the IDoc. |
ErrorOffset | Current offset of the document being parsed. |
ExtraData | Extra data that has not been parsed by the component. |
IDocStatus | The status of an IDoc. |
ImportFormat | The format of the import data. |
InputData | The IDoc data to be read. |
InputFile | The file to be read. |
MaxSegments | The maximum number of occurrences for this segment. |
MinSegments | The minimum number of occurrences for this segment. |
SapAttributes | Describes the SAP R/3 system you're connected to. |
SapConnection | These properties are used to connect to the SAP system. |
SegmentCount | The number of segments available. |
SegmentDataLength | The data length of the current segment. |
SegmentDescription | The description of the current segment. |
SegmentFields | A list of fields in the current segment. |
SegmentHierarchyLevel | Hierarchy level of the current segment. |
SegmentIndex | The index of the current segment. |
SegmentName | Current segment name. |
SegmentParentName | The name of the parent of the current segment. |
SegmentSequenceNumber | Sequence number of the current segment. |
SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | The certificate to be used during SSL negotiation. |
SSLServerCert | The server certificate for the last established connection. |
Timeout | Length of time in seconds the component waits for a response from the SAP system. |
TransferMode | Mode for sending the IDoc data to SAP System. |
XChildren | Number of child segments of the current segment. |
XFields | Collection of fields in the current IDoc segment. |
XPath | Provides a way to point to a specific segment in the document. |
XSegment | The name of the current segment. |
Method List
The following is the full list of the methods of the bean with short descriptions. Click on the links for further details.
abortConnection | Used to terminate a connection to the SAP system. |
closeConnection | Closes a connection to the SAP system. |
config | Sets or retrieves a configuration setting . |
doEvents | Processes events from the internal message queue. |
exportXMLSchema | Exports an IDoc XML schema file. |
flush | Flushes the parser and checks its end state. |
getAttributes | Retrieves attributes about the SAP system you're currently connected to. |
getCurrentIDocStatus | Get status record of the current IDoc. |
importSchemaFromSAP | Loads the schema for an IDoc type. |
importXMLSchema | Imports an XML schema file describing an IDoc type. |
input | Provides input to the reader. |
interrupt | Interrupt the current method. |
openConnection | Opens a connection to the SAP system. |
parse | Parse the IDoc data. |
reset | Resets the parser. |
send | Send the generated IDoc to the SAP System. |
setInputStream | An input stream to read the IDoc data. |
Event List
The following is the full list of the events fired by the bean with short descriptions. Click on the links for further details.
ControlRecord | Fires when the control record data is read. |
EndSegment | Fires when the data record segment has been read. |
Error | Information about errors during data delivery. |
SegmentField | Fires when a field of the segment is read. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows the progress of the secure connection. |
StartSegment | Fires when a new data record segment is being read. |
Status | Detailed status messages for debugging purposes. |
Configuration Settings
The following is a list of configuration settings for the bean with short descriptions. Click on the links for further details.
LogPerformanceData | Logs the performance information when a function is called. |
LogRawData | Logs the raw data being sent and received. |
ParseTables | Indicates whether to parse tables into rows and columns. |
ResponseParamText[i] | The value of the PARAMTEXT for the specified reponse parameter. |
RequestParamText[i] | The value of the PARAMTEXT for the specified request parameter. |
Group | The logon group. |
MessageServer | Service name of load balancer service. |
SncLibPath | The external security product's library. |
SncMode | The SNC activation indicator. |
SncName | The Initiator's SNC name. |
SncPartnerName | The communication partner's SNC name. |
SncQop | The quality of protection level. |
SystemID | The system ID of the SAP system. |
LocalHost | The IP address of the local interface. |
ProxyAutoDetect | Whether or not to automatically detect and use proxy system settings, if available. |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
FirewallType | Determines the type of firewall to connect through. |
CodePage | The system code page used for Unicode to Multibyte translations. |