IDocWriter Component
Properties Methods Events Configuration Settings Errors
The IDocReader component is used to write IDoc documents.
Syntax
TibiIDocWriter
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:
- 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.
- Specify where to write the document by setting the OutputFile property. If not set, the data will be written to the OutputData property.
- Start a new document by calling StartIDoc.
- 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.
- Create a new record data segment by calling StartSegment.
- 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.
- Once you are done with the segment, call EndSegment.
- Repeat steps 5-7 until you are finished writing the document.
- 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.
Append | Indicates whether or not the component should append to a file when writing IDoc data. |
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. |
ExportFormat | The format of the export data. |
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. |
MaxSegments | The maximum number of occurrences for this segment. |
MinSegments | The minimum number of occurrences for this segment. |
OutputData | The IDoc data to be written. |
OutputFile | Specifies the name of the IDoc file to write to. |
Overwrite | Indicates whether or not the component should overwrite files when writing IDoc data. |
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). |
Suffix | What to append after each segment delimiter. |
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. |
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. |
EndIDoc | Finish creating an IDoc. |
EndSegment | Ends writing the current segment. |
GetAttributes | Retrieves attributes about the SAP system you're currently connected to. |
GetCurrentIDocStatus | Get status record of the current IDoc. |
ImportSchemaFromSAP | Imports the schema for an IDoc type. |
ImportXMLSchema | Imports an XML schema file describing an IDoc type. |
Interrupt | Interrupt the current method. |
OpenConnection | Opens a connection to the SAP system. |
Reset | Resets the parser. |
Send | Send the generated IDoc to the SAP System. |
StartIDoc | Start to create an IDoc. |
StartSegment | Creates a new IDoc data segment on the current IDoc document. |
WriteControlRecord | Writ IDoc control record data to the file or stream. |
WriteFieldValue | Write 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.
Error | Information about errors during data delivery. |
Output | Fires whenever a segment is complete. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows the progress of the secure connection. |
Status | Detailed status messages for debugging purposes. |
Warning | Fires 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.
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. |