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

IDocWriter Component

Properties   Methods   Events   Configuration Settings   Errors  

The IDocReader component is used to write IDoc documents.

Syntax

nsoftware.InERP.Idocwriter

Remarks

The IDocWriter component allows you to create a document from scratch. The component allows you to create an IDoc document one segment at a time. Here's how a document would normally be created:

  1. First, load a schema file into the component. You can use ImportSchemaFromSAP to retrieve the schema from SAP or ImportXMLSchema if you have the XML schema saved locally.
  2. Specify where to write the document by setting the OutputFile property or calling the SetOutputStream method. If neither is set, the data will be written to the OutputData property.
  3. Start a new document by calling StartIDoc.
  4. Write the Control Record Data before writing any segments, call WriteControlRecord. Note that you will need to set the fields in the ControlRecordData property before calling this method.
  5. Create a new record data segment by calling StartSegment.
  6. Write all the data for the segment by creating new fields using the WriteFieldValue method. Note that each segment can contain one to many fields.
  7. Once you are done with the segment, call EndSegment.
  8. Repeat steps 5-7 until you are finished writing the document.
  9. Once you are done with the document, call EndIDoc.

Example IDocWriter Code:

idocwriter1.StartIDoc()
idocwriter1.WriteControlRecord()
idocwriter1.StartSegment("Segment1")
idocwriter1.WriteFieldValue("Field1", "Value1")
idocwriter1.WriteFieldValue("Field2", "Value2")
...
idocwriter1.EndSegment()
idocwriter1.StartSegment("Segment2")
idocwriter1.WriteFieldValue("Field1", "Value1")
...
idocwriter1.EndSegment()
...
idocwriter1.EndIDoc()

Property List


The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

AppendIndicates whether or not the component should append to a file when writing IDoc data.
ConnectedIndicates whether or not the component is connected to the SAP system.
ControlRecordDataControl record data of the IDoc.
ExportFormatThe format of the export data.
IDocStatusThe status of an IDoc.
MaxSegmentsThe maximum number of occurrences for this segment.
MinSegmentsThe minimum number of occurrences for this segment.
OutputDataThe IDoc data to be written.
OutputFileSpecifies the name of the IDoc file to write to.
OverwriteIndicates whether or not the component should overwrite files when writing IDoc data.
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.
SuffixWhat to append after each segment delimiter.
TimeoutLength of time in seconds the component waits for a response from the SAP system.
TransferModeMode for sending the IDoc data to SAP System.

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.
EndIDocFinish creating an IDoc.
EndSegmentEnds writing the current segment.
GetAttributesRetrieves attributes about the SAP system you're currently connected to.
GetCurrentIDocStatusGet status record of the current IDoc.
ImportSchemaFromSAPImports the schema for an IDoc type.
ImportXMLSchemaImports an XML schema file describing an IDoc type.
InterruptInterrupt the current method.
OpenConnectionOpens a connection to the SAP system.
ResetResets the parser.
SendSend the generated IDoc to the SAP System.
StartIDocStart to create an IDoc.
StartSegmentCreates a new IDoc data segment on the current IDoc document.
WriteControlRecordWrit IDoc control record data to the file or stream.
WriteFieldValueWrite current segment field value.

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.

ErrorInformation about errors during data delivery.
OutputFires whenever a segment is complete.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StatusDetailed status messages for debugging purposes.
WarningFires whenever a validation warning is encountered.

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