Extract Template

The Extract Template zone displays the details of an extract template. It contains the following sections:

• Main - Displays the basic information about the extract template. It contains the following fields:

  Field Name	Field Description
  Extract Template	Displays the name of the extract template. Note: This is a read-only field.
  Description	Displays the description of the extract template. Note: This is a read-only field.
  File Header Required	Indicates whether header information is defined or not in the file for the extract template.
  File Footer Required	Indicates whether footer information is defined or not in the file for the extract template.
  Audit Log Required	Indicates whether transition of various statuses is logged in the ORMB system once each file request is processed.
  Error Log Required	Indicates whether an error is logged in the ORMB system once each file request is processed.
  File Archive Required	Indicates whether the file is relocated to another location once the processing takes place on the SFTP server.
  File Encryption Required	Indicates whether to first decrypt and then extract the file on the SFTP server.
  Status	Indicates the status of the extract template. The valid values are: Active Inactive Note: This is a read-only field.
  Date/Time Format	Displays the format in which you want to define the date and time on extracting the information. Note: This is a read-only field.
  Detailed Description	Displays additional information about the extract template. Note: This is a read-only field.

• Extract File Format - Displays information about the file formats supported by the extract template for extracting information from the system. It contains the following columns:

  Column Name	Column Description
  File Format	Indicates the format in which you want to extract the information. The valid values are: Comma Separated Values Extensible Markup Language Fixed Position JavaScript Object Notation Pipe Separated Values Tilde Separated Values
  File Extension	Displays the file extension selected corresponding to the selected file format.
  Root Tag	Displays the name of the root tag in which the extracted information has to be enclosed. Note: This field is enabled when the Extensible Markup Language or JavaScript Object Notation option is selected from the File Format list.
  Enclosed Quotes Required	Indicates whether you want to enclose the extracted information in double quotes. Note: This checkbox appears when the Comma Separated Values, Pipe Separated Values or Tilde Separated Values option is selected from the File Format list.
  Column Header Required	Indicates whether you want the column headers in the extracted file or not. Note: This checkbox appears when the Comma Separated Values, Pipe Separated Values or Tilde Separated Values option is selected from the File Format list.
  Do Not Extract	Indicates whether you want to exclude the corresponding file format from the extracted information.
  Same as Source XML	Indicates whether the Target Field XPath is same as the Source Field XPath while mapping the fields. Note: This checkbox appears when theExtensible Markup Language or JavaScript Object Notation option is selected from the File Format list.

• Services - Displays the business services using which you want to extract information from the system. It contains the following columns:

  Column Name	Column Description
  Sequence Number	Displays the sequence number of the service.
  Service Type	Indicates the service type you want to extract the information. The valid values are: Business Service Business Object
  Schema Name	Displays the name of the service required to extract the information.
  Dependent Service Name	Displays the name of the service which gives the details of the service hierarchy required for the information extract.
  Post Processing Algorithm	Displays the name of the algorithm which is executed after the service is processed.

• Extract Settings - Displays the details about the record count of list element and fields mapped in the template. This section contains the following sub-sections:

  • List Element Extract Details - Displays the maximum list record count in a single data line in the extract information:

    Column Name	Column Description
    List Element Xpath	Displays the XPath of the list element for which the sequence / positions are reserved based on the given record count.
    Maximum Records	Displays the number of records for a list element.

    Note: This section appears when the Comma Separated Values, Pipe Separated Values, Fixed Position or Tilde Separated Values option is selected from the File Format list.

  • Field Mapping - Displays the details of the fields mapped in the extract template which are used to extract the information. It contains the following columns:

    Column Name	Column Description
    Sequence	Displays the sequence of the field.
    Field Name	Displays the name of the field to be displayed in the extracted information file. Note: If the Extensible Markup Language option is selected from the File Format list then the node names gets displayed.
    Source Field Path	Displays the XPath of the source field from where the information is to be extracted.
    Target Field Path	Displays the Xpath of the target field into which the extracted information is to be saved. Note: This column is appears when the Extensible Markup Language or JavaScript Object Notation option is selected from the File Format list.
    Start Position	Indicates the starting position of a particular field in the extracted file. Note: This column appears when the Fixed Position option is selected from the File Format list.
    End Position	Indicates the ending position of a particular field in the extracted file. Note: This column appears when the Fixed Position option is selected from the File Format list.
    Do Not Extract	Indicates whether you want to exclude corresponding field mapping from the extracted information.
    Edit Input	Indicates whether you want to define the default value for the corresponding field. Note: If this checkbox is selected then the Default Value field is enabled.
    Default Value	Indicates the default value defined for the corresponding field in the extract template. Note: This field is enabled when the Edit Input checkbox is selected.
    Date Time Format	Specifies the format in which you want to define the date and time on extracting the information.

By default, the Extract Template zone does not appear in the Extract Template screen. It appears when you click the Broadcast () icon corresponding to a extract template in the Extract Template List zone.

Related Topics