IDocReader Class

Properties   Methods   Events   Configuration Settings   Errors  

The IDocReader component is used to parse IDoc documents.

Class Name

InERP_IDocReader

Procedural Interface

 inerp_idocreader_open();
 inerp_idocreader_close($res);
 inerp_idocreader_register_callback($res, $id, $function);
 inerp_idocreader_get_last_error($res);
 inerp_idocreader_get_last_error_code($res);
 inerp_idocreader_set($res, $id, $index, $value);
 inerp_idocreader_get($res, $id, $index);
 inerp_idocreader_do_abortconnection($res, $errormessage);
 inerp_idocreader_do_closeconnection($res);
 inerp_idocreader_do_config($res, $configurationstring);
 inerp_idocreader_do_doevents($res);
 inerp_idocreader_do_exportxmlschema($res, $filepath);
 inerp_idocreader_do_flush($res);
 inerp_idocreader_do_getattributes($res);
 inerp_idocreader_do_getcurrentidocstatus($res);
 inerp_idocreader_do_importschemafromsap($res, $idoctype, $enhancement);
 inerp_idocreader_do_importxmlschema($res, $filepath);
 inerp_idocreader_do_input($res, $text);
 inerp_idocreader_do_interrupt($res);
 inerp_idocreader_do_openconnection($res);
 inerp_idocreader_do_parse($res);
 inerp_idocreader_do_reset($res);
 inerp_idocreader_do_send($res);

Remarks

The IDocReader class 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:
   • Use the ImportSchemaFromSAP method to retrieve the schema directly from SAP
   • Use the ImportXMLSchema method to retrieve the XML schema directly from disk
2. Load the IDoc Data into the class 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
3. Call the Parse parse method

During parsing, the class 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 class will select the first grandChildSegmentA in the second childSegmentC in the first segmentA.