Eyeball Configuration

Overview

The predefined configuration in the eyeball-config-backup and eyeball-config-pod YAML files define the fields that will appear in the Eyeball screen in the portal and how. It defines the fields and related details like, whether the field is mandatory or not, will it be visible in the Eyeball screen, will it be enabled for editing, what will be the field display order, what will be the field type etc.

Sample YAML file

eyeball-config-backup.yaml

kind: document
metadata:
  name: deduction/v1/documents/eyeball/backup
  description: 
spec:
  fields:

    - name: "document_provider"
      description: "Document Provider"
      mandatory: true
      visible: true
      enable: true
      displayOrder: 1
      defaultControlType: "TextBox"

    - name: "TotalDeduction"
      description: "Total Deduction"
      visible: true
      enable: true
      displayOrder: 2
      defaultControlType: "NumericTextBox"

    - name: "lines"
      description: "Lines"
      defaultControlType: "Array"
      enable: true
      visible: true
      displayOrder: 3
      fields:
        - name: "description"
          description: "Description"
          defaultControlType: "TextBox"
          enable: true
          visible: true

        - name: "deducted_amount"
          description: "Deducted Amount"
          defaultControlType: "NumericTextBox"
          enable: true
          visible: true

        - name: "Invoiced_qty"
          description: "Invoiced Qty"
          defaultControlType: "NumericTextBox"
          enable: true
          visible: true

        - name: "received_qty"
          description: "Received Qty"
          defaultControlType: "NumericTextBox"
          enable: true
          visible: true

        - name: "deducted_qty"
          description: "Deducted Qty"
          defaultControlType: "NumericTextBox"
          enable: true
          visible: true

        - name: "deducted_price_per_qty"
          description: "Deducted Price Per Qty"
          defaultControlType: "NumericTextBox"
          enable: true
          visible: true

        - name: "deduction_reason"
          description: "Deduction Reason"
          defaultControlType: "TextBox"
          enable: true
          visible: true

        - name: "invoice_number"
          description: "Invoice Number"
          defaultControlType: "TextBox"
          enable: true
          visible: true

        - name: "purchaseOrderNumber"
          description: "Purchase Order Number"
          defaultControlType: "TextBox"
          enable: true
          visible: true

        - name: "deduction_date"
          description: "Deduction Date"
          defaultControlType: "TextBox"
          enable: true
          visible: true

        - name: "Debit"
          description: "Debit"
          defaultControlType: "TextBox"
          enable: true
          visible: true

        - name: "item_identifiers"
          description: "Item Identifiers"
          defaultControlType: "Array"
          enable: true
          visible: true
          fields:
            - name: "id"
              description: "Id"
              defaultControlType: "TextBox"
              enable: true
              visible: true

            - name: "type"
              description: "Type"
              defaultControlType: "TextBox"
              enable: true
              visible: true

eyeball-config-pod.yaml

kind: document
metadata:
  name: deduction/v1/documents/eyeball/pod
  description: 
spec:
  fields:

    - name: "document_provider"
      description: "Document Provider"
      enabled: false
      defaultControlType: "TextBox"

    - name: "customer_sign"
      description: "Customer Sign"
      visible: true      
      defaultControlType: "Checkbox"

    - name: "customer_sign_text"
      description: "Customer Sign Text"
      visible: true
      defaultControlType: "TextBox"

    - name: "carrier_sign"
      description: "Carrier Sign"
      visible: true
      defaultControlType: "Checkbox"

    - name: "carrier_sign_text"
      description: "Carrier Sign Text"
      visible: true
      enable: true
      defaultControlType: "TextBox"

    - name: "subject_to_count"
      description: "Subject To Count"
      visible: true
      defaultControlType: "Checkbox"

    - name: "bol"
      description: "BOL"
      visible: true
      defaultControlType: "TextBox"

    - name: "freight_charge_terms"
      description: "Freight Charge Terms"
      visible: true
      defaultControlType: "TextBox"

    - name: "total_packages_quantity"
      description: "Total Packages Quantity"
      visible: true
      defaultControlType: "NumericTextBox"

    - name: "total_lbs_quantity"
      description: "Total LBS Quantity"
      visible: true
      defaultControlType: "NumericTextBox"

    - name: "lines"
      description: "Lines"
      defaultControlType: "Array"
      fields:
        - name: "invoice_number"
          description: "Invoice Number"
          defaultControlType: "TextBox"
          
        - name: "description"
          description: "Description"
          defaultControlType: "TextBox"
          
        - name: "order_number"
          description: "Order Number"
          defaultControlType: "TextBox"
          
        - name: "packages_quantity"
          description: "Package Quantity"
          defaultControlType: "NumericTextBox"
          
        - name: "lbs_quantity"
          description: "LBS Quantity"
          defaultControlType: "NumericTextBox"
          
    - name: "notations"
      description: "Notations"
      defaultControlType: "Array"
      fields:
        - name: "notation_type"
          description: "Notation Type"
          defaultControlType: "TextBox"
          
        - name: "quantity"
          description: "Quantity"
          defaultControlType: "NumericTextBox"
          
        - name: "quantity_type"
          description: "Quantity Type"
          defaultControlType: "TextBox"
          
        - name: "item_identifier"
          description: "Item Identifier"
          defaultControlType: "TextBox"

        - name: "item_identifier_type"
          description: "Item Identifier Type"
          defaultControlType: "TextBox"
          
        - name: "handwritten_source"
          description: "Handwritten Source"
          defaultControlType: "TextBox"
          
    - name: "handwritten"
      description: "Handwritten"
      defaultControlType: "Array"
      fields:
        - name: "handwritten"
          description: "Handwritten"
          defaultControlType: "TextBox"
          
        - name: "handwritten_with_context"
          description: "Handwritten With Context"
          defaultControlType: "TextBox"

Parameter	Description
Name	Determines the name of the field in JSON.
Description	Adds a brief description of the field.
Visible	Determines if the field is displayed in the UI.
Mandatory	Determines whether the field value is mandatory.
Enable	Determines whether the field can be edited.
DisplayOrder	Determines the order in the UI where the field is displayed.
DefaultControlType	Determines the type of the field. Array: For grid type fields like line items. TextBox: For plain text fields. NumericTextBox: For text fields with only numeric data. Checkbox: For multi selection type fields.

IMPORTANT
Ensure that the column order in the line items table is identical in both extraction YAML files and eyeball YAML files.

Overview

Sample YAML file

eyeball-config-backup.yaml

eyeball-config-pod.yaml

Related Articles