Difference between revisions of "OS4X Enterprise Webaccess custom input fields"

From OS4X
Jump to navigation Jump to search
(Created page with "= Purpose = With custom input fields, OS4X administrators can define if additional input fields may be contained in OS4X jobs. Up to six fields are available at the moment, if...")
 
Line 1: Line 1:
 
= Purpose =
 
= Purpose =
 
With custom input fields, OS4X administrators can define if additional input fields may be contained in OS4X jobs. Up to six fields are available at the moment, if this isn't sufficient please inform [mailto:support@os4x.com support@os4x.com].
 
With custom input fields, OS4X administrators can define if additional input fields may be contained in OS4X jobs. Up to six fields are available at the moment, if this isn't sufficient please inform [mailto:support@os4x.com support@os4x.com].
 +
 +
Own input fields have some properties, which are defined in the administrative web interface in "Configuration" -> "OS4X Enterprise" -> "Webaccess", section "Own labels in jobs".
 +
 +
= Configuration =
 +
In order to enable "own labels" in OS4X Enterprise jobs via OS4X Webaccess, you have to enable the checkbox "Use own input fields in jobs?". Each node (say: each own label) has several configuration possibilities:
 +
*Enable node: you can en- or disable single nodes on demand.
 +
*Node name: this is the name of the XML node below the XPath "/OS4X_job/job_information". You must not define XML node names of the already existing XML node names. Forbidden values are:
 +
**job_direction
 +
**job_number
 +
**job_comment
 +
*Mandatory: If the field is mandatory, it must be filled with content. This implies (depending on the later configured job type configuration):
 +
**Send jobs: the field must be filled out in order to initiate a send job.
 +
**Receive jobs: The field must me filled out in order to download the job and/or mark the job as fetched.
 +
**Job type:
 +
**Outgoing: only send jobs have this field.
 +
**Incoming: only receive jobs have this field.
 +
**Both: both incoming and outgoing jobs have this field available.
 +
*Visible in job list: if the field should be visible as a separate column in the job list, enable this feature.
 +
*Language configuration: for every defined language, you may define a text value for the internationalized web interface. You can click in the cell of the table to edit the value. By leaving the cell, the value is saved.
 +
**Language: the corresponding language.
 +
**Node description: the text value which is displayed in the selected language in OS4X Webaccess.
 +
**Is fallback: If a language has no value, the selected fallback value will be displayed.

Revision as of 08:59, 26 May 2021

Purpose

With custom input fields, OS4X administrators can define if additional input fields may be contained in OS4X jobs. Up to six fields are available at the moment, if this isn't sufficient please inform support@os4x.com.

Own input fields have some properties, which are defined in the administrative web interface in "Configuration" -> "OS4X Enterprise" -> "Webaccess", section "Own labels in jobs".

Configuration

In order to enable "own labels" in OS4X Enterprise jobs via OS4X Webaccess, you have to enable the checkbox "Use own input fields in jobs?". Each node (say: each own label) has several configuration possibilities:

  • Enable node: you can en- or disable single nodes on demand.
  • Node name: this is the name of the XML node below the XPath "/OS4X_job/job_information". You must not define XML node names of the already existing XML node names. Forbidden values are:
    • job_direction
    • job_number
    • job_comment
  • Mandatory: If the field is mandatory, it must be filled with content. This implies (depending on the later configured job type configuration):
    • Send jobs: the field must be filled out in order to initiate a send job.
    • Receive jobs: The field must me filled out in order to download the job and/or mark the job as fetched.
    • Job type:
    • Outgoing: only send jobs have this field.
    • Incoming: only receive jobs have this field.
    • Both: both incoming and outgoing jobs have this field available.
  • Visible in job list: if the field should be visible as a separate column in the job list, enable this feature.
  • Language configuration: for every defined language, you may define a text value for the internationalized web interface. You can click in the cell of the table to edit the value. By leaving the cell, the value is saved.
    • Language: the corresponding language.
    • Node description: the text value which is displayed in the selected language in OS4X Webaccess.
    • Is fallback: If a language has no value, the selected fallback value will be displayed.
Retrieved from "https://wiki.os4x.com/index.php?title=OS4X_Enterprise_Webaccess_custom_input_fields&oldid=3582"