ERP Integrator V2 - Online Help
ERP Integrator V2
Questions / Feedback?

IDocReader Component

Properties   Methods   Events   Configuration Settings   Errors  

The IDocReader component is used to parse IDoc documents.

Syntax

nsoftware.InERP.Idocreader

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:

  1. Import schema, this can be done one of two ways:
  2. Load the IDoc Data into the component 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
  3. 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.

ConnectedIndicates whether or not the component is connected to the SAP system.
ControlRecordDataControl record data of the IDoc.
ErrorOffsetCurrent offset of the document being parsed.
ExtraDataExtra data that has not been parsed by the component.
IDocStatusThe status of an IDoc.
ImportFormatThe format of the import data.
InputDataThe IDoc data to be read.
InputFileThe file to be read.
MaxSegmentsThe maximum number of occurrences for this segment.
MinSegmentsThe minimum number of occurrences for this segment.
SapAttributesDescribes the SAP R/3 system you're connected to.
SapConnectionThese properties are used to connect to the SAP system.
SegmentCountThe number of segments available.
SegmentDataLengthThe data length of the current segment.
SegmentDescriptionThe description of the current segment.
SegmentFieldsA list of fields in the current segment.
SegmentHierarchyLevelHierarchy level of the current segment.
SegmentIndexThe index of the current segment.
SegmentNameCurrent segment name.
SegmentParentNameThe name of the parent of the current segment.
SegmentSequenceNumberSequence number of the current segment.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLServerCertThe server certificate for the last established connection.
TimeoutLength of time in seconds the component waits for a response from the SAP system.
TransferModeMode for sending the IDoc data to SAP System.
XChildrenNumber of child segments of the current segment.
XFieldsCollection of fields in the current IDoc segment.
XPathProvides a way to point to a specific segment in the document.
XSegmentThe 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.

AbortConnectionUsed to terminate a connection to the SAP system.
CloseConnectionCloses a connection to the SAP system.
ConfigSets or retrieves a configuration setting .
DoEventsProcesses events from the internal message queue.
ExportXMLSchemaExports an IDoc XML schema file.
FlushFlushes the parser and checks its end state.
GetAttributesRetrieves attributes about the SAP system you're currently connected to.
GetCurrentIDocStatusGet status record of the current IDoc.
ImportSchemaFromSAPLoads the schema for an IDoc type.
ImportXMLSchemaImports an XML schema file describing an IDoc type.
InputProvides input to the reader.
InterruptInterrupt the current method.
OpenConnectionOpens a connection to the SAP system.
ParseParse the IDoc data.
ResetResets the parser.
SendSend the generated IDoc to the SAP System.
SetInputStreamAn input stream to read the IDoc data.

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.

ControlRecordFires when the control record data is read.
EndSegmentFires when the data record segment has been read.
ErrorInformation about errors during data delivery.
SegmentFieldFires when a field of the segment is read.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StartSegmentFires when a new data record segment is being read.
StatusDetailed 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.

LogPerformanceDataLogs the performance information when a function is called.
LogRawDataLogs the raw data being sent and received.
ParseTablesIndicates 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.
GroupThe logon group.
MessageServerService name of load balancer service.
SncLibPathThe external security product's library.
SncModeThe SNC activation indicator.
SncNameThe Initiator's SNC name.
SncPartnerNameThe communication partner's SNC name.
SncQopThe quality of protection level.
SystemIDThe system ID of the SAP system.
LocalHostThe IP address of the local interface.
ProxyAutoDetectWhether or not to automatically detect and use proxy system settings, if available.
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallUserA user name if authentication is to be used connecting through a firewall.
FirewallTypeDetermines the type of firewall to connect through.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 2.0.6240.0