XML structure

Format

The format determines the structure of the XML file, and limitations and rules when configuring the XML file.

• M3 standard document

  Use the M3 standard document when the XML file is transmitted to an external output management application for formatting and distribution. The content of the XML includes, in addition to lines, the header, text, address, and summary sections. Usually, the layout is designed with portrait orientation. To ensure that the external application is always working, there are restrictions when it comes to what can be changed when using this format. It can only be used for printer files of type Document.

  When Format '1-M3 standard document', other fields, such as Root element, Schemas, and Element name, are disabled or not used.

• M3 standard report

  Use the M3 standard report when the XML file is transmitted to an external output management application for formatting and distribution. The main content of the XML consists of lines but can also include a minor header and summary. The layout is usually designed with landscape orientation. To ensure that the external application is always working, there are restrictions when it comes to what can be changed when using this format. This format can only be used for printer files of the type Report. M3 standard report only uses these different sections, that are, Report, Header, Report Header, Group, Main, and Detail.

  When the Format '2-M3 standard report', other fields, such as Root element, Schemas, and Element name, are disabled or not used.

• Open

  Open is intended to be used when the XML file is used for integration to other systems. The receiving system may then require a specific format. There are no restrictions as to what can be changed. This is usually used in the Financial Reporting functionality.

  When Format '3-Open' is selected, other fields, such as Root element, Schemas, and Element name, are enabled.

  • Root element: This field indicates the root element of an XML document. This must contain one root element that is the parent of a" other elements. The root element is the first and last tag in the XML document.

  • Default namespace – XML Namespace provides a method to avoid element name conflicts. In XML, the element names are defined by the developer. This often leads to conflicts when attempting to combine XML documents from different XML applications. The namespace is defined by an xmlns attribute in the start tag of an element. The namespace declaration has this syntax: xmlns:prefix="URI".

    Defining a default namespace for an element saves us from using prefixes in all the child elements. Defining a default namespace has this syntax: xmlns="namespaceURI"

    The default namespace field must have a value for the other field, such as Namespace 1 and Prefix for Namespace 1 shown in the XML structure during printing.

  • Prefix for namespace 1: this field indicates the prefix for namespace 1.
  • Schema Namespace: This field indicates schema namespace. The use of namespaces and prefixes is recommended to remove any ambiguity for element and attribute declarations because several vocabularies are used to describe different elements and attributes in XML documents, the use of namespaces and prefixes is recommended to remove any ambiguity for element and attribute declarations. Distinguishing between element and attribute names for each namespace is essential when using schemas from more than one namespace.
  • Schema: This field indicates the XML schema. The XML schema describes the structure of XML documents. The purpose of an XML schema is to define the legal building blocks of an XML document.
  • Element name: This field indicates the element name that defines the name of the tag. If the element name is an item, the tag is <item>.

Split XML file

Select the check box if the result from an output job should split into several smaller XML files. You can do a split per document. For example, one XML file per invoice or per purchase order). If you selected Interface 3-'IDM Output management' and Interface 6-'IDM Output Management, double interfaces' in 'Output Service. Open' (MNS216), the check box must be selected.

CSV File Control

• Table name

  This field is matched with a table name in the Excel template to locate where to insert the CSV data.

• Sheet name

  This field is matched with a sheet name in the Excel template to determine where to insert the CSV data. 'Sheet name' becomes a required field after a table name is specified. For single CSV, the sheet name also becomes required if 'Column Format' is equal to 1 or 2 on 'XML Structure Section. Open Element' (CMS009/E).

  Note: If both the table name and sheet name fields are blank, any template uploaded is ignored since the template does not have any matches for where to insert the CSV data. This results in an Excel output without any formatting. This field is matched with a sheet name in the Excel template to locate where to insert the CSV data. Sheet name becomes a required field once a table name is specified.

• Heading section

  You can use this field to indicate the sections in 'XML Structure. Open Section' (CMS007) to be printed on the topmost row of the CSV file. The topmost row or rows contains only the text element labels indicated in 'XML Structure Section. Open Element' (CMS009).

  Note: Only sections with status 30 and 80 can be selected as a heading section.

• Multiple headers

  Select this check box to display the additional label on the row above the field labels. Clearing the option causes the CSV outout to not display the additional message in 'XML Structure Section. Open Element' (CMS009).

• Multiple rows

  Select this check box to split the section according to each row grouping element in 'XML Structure Section. Open Element' (CMS009). Clearing the option causes the CSV export to bypass row grouping elements and display all fields in a single row.

  Note: Multiple headers and rows feature is only applicable for reports.

• Display UTC offset

  Select this check box to display the UTC information in the XML structure. If cleared, UTC information is not available in the XML structure. Multiple headers and rows is a feature that is only applicable for reports.

Archive information

Panels F and G in (CMS006) contain information regarding document archive. The information is designed to match the information required in IDM but is used for other archiving application. A media of type *ARCHIVE must be included in the output media selection for the archive information to be included in the XML file.

• Document type

  Shows the Document type ID within IDM. The ID in M3 BE must exactly match the ID in IDM. You must specify a value or reference to an XML object.

• File name

  Shows the file name to be used within IDM. You must specify a value or reference to an XML object.

• Access control list

  Shows the Access control list within IDM. The ID in M3 BE must exactly match the ID in IDM. You must specify a value or reference to an XML object.

• Archive

  If the 'Archive control' selected is 0-'Use setting in CMS006' in 'List and Printer programs. Configure' (CMS005), this field is used to indicate if copies of the printer file must be archived. Select 0-'No' to disable the archive settings in (CMS006) and use 'Output Media Selection. Open' (MNS205) or 'Doc Media Control Object. Connect Media' (CRS949) media for document and report type printer files. Select 1-'Only original' to archive only the original document. Select 2-'Only copies' to archive only the copies of document. Select 3-'Both original and copies' to archive both the original and copies of document. Select 4-'Yes' to archive report type printer files.

  You can select one of these options:

  • 1-'Only original': Archives only the original document.
  • 2-'Only copies': Archives only the copies of document.
  • 3-'Both original and copies': Archives both the original and copies of document.

  If the 'Update version'option is enabled for Archive Control 1, 2, or 3, the version of a stored document in IDM is updated if it matches the archiving attributes and document type of the new document. This functionality is exclusive to IDM.

• File type

  If the 'Archive' selected is 1, 2, 3, or 4 in (CMS006), this field is used to indicate the file type to be archived. If IDM Output Management is used for Interface XML, the only valid alternatives are PDF, Word, or Word and PDF. Selecting any of the other alternative results in the file type PDF. If IDM Output Management is used for Interface CSV, all alternatives are ignored, and the file type is always Excel.

  When archiving documents in IDM, the valid file types are 1-'PDF', 2-'Excel', and 6-'Word'. The 'Update version' option is not valid for file type 7-'Word and PDF'.

• Attribute ID

  Shows the Attribute ID within IDM. Valid Attribute ID is dependent on document type ID. The ID in M3 Business Engine must exactly match the ID in IDM.

  For the 'Update version' , the attribute ID in M3 must match the attribute ID in IDM. Only the latest document with the same attributes are updated with the a new version in IDM.

• Attribute value

  Shows how to set the value for an attribute ID.

  'Update version' is not allowed for multi-value attributes. The versions are only updated if a match is made for single-value attributes.

• Document type

  The Document Type used when archiving the document in IDM must have the property 'Use Unique ID' enabled in IDM for the update version functionality to work.

User-defined fields

Use panel H in (CMS006) to cover the hard-coded values, predefined, and user-defined constants that are specified. These is used as parameters in the 'Subject' and 'Email Text' fields in 'Output Media Selection. Open' (MNS205) and 'Doc Media Control Object. Connect Media' (CRS949).

The values are extracted from the output XML file then stored in user-defined and predefined constants.

This table shows the available user-defined constants:

• Specific value

  Indicates the hard-coded or constant values.

• XML Section

  Use this field to specify the XML section available in a specific printer file. Those section can be found in 'XML Structure. Open Section' (CMS007).

• Element Sequence Number

  Use this field to specify the elements available in a specific XML section. Those elements can be found in 'XML Structure Section. Open Element' (CMS009).

Related document types for Infor Document Management

On Panel H (CMS006), the related document fields enable the user to select up to five document types from 'Document Type. Open' (MNS060). These document types are matched with a corresponding file that has been uploaded to Infor Document Management, which are then included in the output. Related documents are retrieved according to the document type and attributes selected in (MNS060).

The selected media option is used to determine when an attachment should be included. If option 2='Print' is selected for example, this option only includes an attachment if the output selected is for printing, not for sending through email.

Merge check box

The merge option is used to decide if the attachments should be merged into one single PDF. Merging option is only valid for file type: 1='PDF' in (MNS205). Other file types in (MNS205) results in related documents to be attached separately, as if the option was not selected.