IDocReader Component
Properties Methods Events Configuration Settings Errors
The IDocReader component is used to parse IDoc documents.
Syntax
TibiIDocReader
Remarks
The IDocReader component 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 component using one of the following methods:
- Call the Parse parse method
During parsing, the component 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 component 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 component with short descriptions. Click on the links for further details.
Connected | Indicates whether or not the component is connected to the SAP system. |
IDocControlRecordARCKEY | Key for the external message archive. |
IDocControlRecordCIMTYP | Custom extension that is defined by user. |
IDocControlRecordCREDAT | The creation date of the IDoc. |
IDocControlRecordCRETIM | The creation time of the IDoc. |
IDocControlRecordDIRECT | The direction of the IDoc, indicates if the IDoc is inbound or outbound. |
IDocControlRecordDOCNUM | The unique number assigned to the IDoc. |
IDocControlRecordDOCREL | The SAP release number for IDoc. |
IDocControlRecordEXPRSS | Override during inbound processing. |
IDocControlRecordIDOCTYP | The name of the basic type of the IDoc. |
IDocControlRecordMANDT | The client number. |
IDocControlRecordMESCOD | The message code. |
IDocControlRecordMESFCT | The message Function. |
IDocControlRecordMESTYP | The message type. |
IDocControlRecordOUTMOD | The output mode. |
IDocControlRecordRCVLAD | The logical address of recipient. |
IDocControlRecordRCVPFC | The partner function of recipient. |
IDocControlRecordRCVPOR | The receiver port. |
IDocControlRecordRCVPRN | The partner Number of Receiver. |
IDocControlRecordRCVPRT | The partner Type of Receiver. |
IDocControlRecordRCVSAD | The recipient's address. |
IDocControlRecordREFGRP | The message group (EDI Message Group). |
IDocControlRecordREFINT | The transmission file (EDI Interchange). |
IDocControlRecordREFMES | The message (EDI Message). |
IDocControlRecordSERIAL | EDI serialization property. |
IDocControlRecordSNDLAD | The logical address of sender. |
IDocControlRecordSNDPFC | The partner function of the sender. |
IDocControlRecordSNDPOR | The sender's port. |
IDocControlRecordSNDPRN | The partner number of the sender. |
IDocControlRecordSNDPRT | The partner type of the sender. |
IDocControlRecordSNDSAD | The sender's address. |
IDocControlRecordSTATUS | The status of the IDoc. |
IDocControlRecordSTD | A flag indicating the EDI standard. |
IDocControlRecordSTDMES | The EDI message type. |
IDocControlRecordSTDVRS | The EDI standard, version and release. |
IDocControlRecordTABNAM | The name of the table structure. |
IDocControlRecordTEST | Test flag. |
ErrorOffset | Current offset of the document being parsed. |
ExtraData | Extra data that has not been parsed by the component. |
IDocStatusRecordCreationDate | Date when the status record was created. |
IDocStatusRecordCreationTime | Time when the status record was created. |
IDocStatusRecordDescription | Description of the status record. |
IDocStatusRecordStatusCode | The status code of the IDoc status record. |
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. |
SapAttributeApplicationName | The name of the calling program. |
SapAttributeClient | The client authenticating to the SAP system. |
SapAttributeDestination | Destination that you are currently connected to. |
SapAttributeKernelVersion | The release version of the kernel. |
SapAttributeLanguage | One character code indicating the language of the system. |
SapAttributeLanguageCode | Two-character ISO 639-1 code indicating the language of the system. |
SapAttributeOwnCodePage | The code page of your system. |
SapAttributeOwnHost | The name of the host you're connected to. |
SapAttributeOwnType | The type of your own system. |
SapAttributeOwnVersion | The release version of your system. |
SapAttributePartnerCharSize | The length of a character on the partner's system. |
SapAttributePartnerCodePage | The code page of your partner's system. |
SapAttributePartnerHost | Partner host name. |
SapAttributePartnerType | The type of the partner's system. |
SapAttributePartnerVersion | The release version of the partner's system. |
SapAttributePasswordState | The state of the password. |
SapAttributeReserved | This property may contain an additional 160 bytes of data which is reserved for future new attributes returned by the R/3 server. |
SapAttributeRole | Indicates whether you're connected as a client or server application. |
SapAttributeSystemName | The name or id of the R/3 system you're currently connected to. |
SapAttributeSystemNumber | The system number of the R/3 server you're connected to. |
SapAttributeTraceOn | Indicates whether debug tracing is active or not. |
SapAttributeUser | The login credential which was used to connect to the R/3 server. |
SapConnectionClient | The client authenticating to the SAP system. |
SapConnectionType | Specifies how the connection is made to the SAP server. |
SapConnectionDestination | Reference to an existing destination that is specified in a local saprfc. |
SapConnectionGatewayHost | The gateway host you wish to connect to. |
SapConnectionGatewayService | The gateway service you wish to connect to. |
SapConnectionHost | Host name of the target system. |
SapConnectionLanguage | The language value to be used when connecting SAP system. |
SapConnectionPassword | The password used to authenticate to the SAP system. |
SapConnectionSoapURL | The URL of the SOAP service on the SAP system. |
SapConnectionSystemNumber | The number by which the target system is defined. |
SapConnectionUser | The user that is authenticating 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. |
IDocSegmentFieldCount | The number of records in the IDocSegmentField arrays. |
IDocSegmentFieldDataType | The data type of the IDoc segment property. |
IDocSegmentFieldDescription | The description of IDoc segment property. |
IDocSegmentFieldLength | The output length of the data in the IDoc segment property. |
IDocSegmentFieldName | The name of IDoc segment property. |
IDocSegmentFieldOffset | The data offset of the IDoc segment property. |
IDocSegmentFieldValue | The value of the IDoc segment property. |
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. |
SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
SSLCertEncoded | The certificate (PEM/base64 encoded). |
SSLCertStore | The name of the certificate store for the client certificate. |
SSLCertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
SSLCertStoreType | The type of certificate store for this certificate. |
SSLCertSubject | The subject of the certificate used for client authentication. |
SSLServerCertEncoded | The certificate (PEM/base64 encoded). |
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. |
FieldCount | The number of records in the Field arrays. |
FieldDataType | The data type of the IDoc segment property. |
FieldDescription | The description of IDoc segment property. |
FieldLength | The output length of the data in the IDoc segment property. |
FieldName | The name of IDoc segment property. |
FieldOffset | The data offset of the IDoc segment property. |
FieldValue | The value of the IDoc segment property. |
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 component 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. |
Event List
The following is the full list of the events fired by the component 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 component 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. |