fieldModel

Namespace: http://filecatalyst.com/model
XML Schema: model.xsd

Field model class

XML

Attributes

name type description
description string Help Text - additional text shown to the end user next to the input field. This text may contain HTML
displayFormat string Display Format - additional formatting information to the generated HTML field for example: 'ROWS=25 COLS=80' to a textarea field. This field can also be used to set custom CSS definitions.
This field can also be used to control the functionality of certain fields:
  • For date field the display format may also contain 'allowpastdate' keyword which will allow the user to select dates in the past.
header string The user friendly label displayed on the Job entry form.
helpButtonText string Help Button Text - when this field is set the following icon will be shown to the user: help button any text entered here will be shown when a user hovers over the question icon.
name string Field Name - used to identify this field in the system. This value is never visible by the user and must not contain any non-alpha numeric characters.
taxAmount double Tax amount.
operand fieldOperandActionType Type specific. Operand to use for certain field types. See fieldOperandActionType.
showOnJobSummary boolean Flag indicating if this fields should be shown on the Job Summary.
showOnReport boolean Flag indicating if this fields should be shown on the report.
fieldType fieldType

Each field can be one of these types:

  • text
  • number (number only)
  • quantity (must be a number it also has special meaning for price calculations. There can only be one quantity field per form)
  • textarea (multi-line text field)
  • date (enables date-picker button and enforces correct date format) The selected date MUST be in the future unless keyword 'allowpastdate' is present in the "Display Format" section. The format for the date and other properties related to the date picker can be configured via the language file.
  • select (list of possible options provided)
  • email address
  • recipient (list of possible recipients for the uploaded files). If a recipient field is added to an order form, the system administrator is not notified of a new Job, only the selected recipient.
  • tax (used in systems where pricing is automatically calculated)
  • ftpserver - this field is used to customize the list of FTP/FC servers a user can upload to. This will override the value of preferred server under the user's profile
  • expireupload - this field is used to specify when an upload expires. Field is only used when RecipeintEmail is on the order form.
  • password (used to set a password to download the files) the password is not sent in the email notification to the recipient, it has to be communicated via a different mean like telephone or another email message
  • pin (used to set a pin to download the files. The pin is generated automatically by the system and is sent in the email to the recipient.)
  • emailAuth (Used for secure downloads. If this field is in use, the recipient will receive a secure ID after visiting the first link they get and this ID will be valid for only 15mins.)
  • download_method (This is a drop down which allows the user to specify a method for which the recipients will be able to download the file(s). When this field is added to the Field list, two fields(xSecurePin and xSecurePassword) will be automatically added, and when the field is removed, these fields will be removed also.)
  • notification (This is another drop down which will allow users to specify whether or not they would like to be notified when one or all the recipients have downloaded the file(s) and status changes.)
See fieldType.
href string Hyperlink reference to the resource

Elements

name (type) min/max
occurs		 description
items (itemsModel) 0/1 Items associated with this field type.
discountLevels (discountLevelsModel) 0/1 Discount levels.

JSON

property type description
description string Help Text - additional text shown to the end user next to the input field. This text may contain HTML
displayFormat string Display Format - additional formatting information to the generated HTML field for example: 'ROWS=25 COLS=80' to a textarea field. This field can also be used to set custom CSS definitions.
This field can also be used to control the functionality of certain fields:
  • For date field the display format may also contain 'allowpastdate' keyword which will allow the user to select dates in the past.
header string The user friendly label displayed on the Job entry form.
helpButtonText string Help Button Text - when this field is set the following icon will be shown to the user: help button any text entered here will be shown when a user hovers over the question icon.
name string Field Name - used to identify this field in the system. This value is never visible by the user and must not contain any non-alpha numeric characters.
taxAmount double Tax amount.
operand fieldOperandActionType Type specific. Operand to use for certain field types. See fieldOperandActionType.
showOnJobSummary boolean Flag indicating if this fields should be shown on the Job Summary.
showOnReport boolean Flag indicating if this fields should be shown on the report.
fieldType fieldType

Each field can be one of these types:

  • text
  • number (number only)
  • quantity (must be a number it also has special meaning for price calculations. There can only be one quantity field per form)
  • textarea (multi-line text field)
  • date (enables date-picker button and enforces correct date format) The selected date MUST be in the future unless keyword 'allowpastdate' is present in the "Display Format" section. The format for the date and other properties related to the date picker can be configured via the language file.
  • select (list of possible options provided)
  • email address
  • recipient (list of possible recipients for the uploaded files). If a recipient field is added to an order form, the system administrator is not notified of a new Job, only the selected recipient.
  • tax (used in systems where pricing is automatically calculated)
  • ftpserver - this field is used to customize the list of FTP/FC servers a user can upload to. This will override the value of preferred server under the user's profile
  • expireupload - this field is used to specify when an upload expires. Field is only used when RecipeintEmail is on the order form.
  • password (used to set a password to download the files) the password is not sent in the email notification to the recipient, it has to be communicated via a different mean like telephone or another email message
  • pin (used to set a pin to download the files. The pin is generated automatically by the system and is sent in the email to the recipient.)
  • emailAuth (Used for secure downloads. If this field is in use, the recipient will receive a secure ID after visiting the first link they get and this ID will be valid for only 15mins.)
  • download_method (This is a drop down which allows the user to specify a method for which the recipients will be able to download the file(s). When this field is added to the Field list, two fields(xSecurePin and xSecurePassword) will be automatically added, and when the field is removed, these fields will be removed also.)
  • notification (This is another drop down which will allow users to specify whether or not they would like to be notified when one or all the recipients have downloaded the file(s) and status changes.)
See fieldType.
href string Hyperlink reference to the resource
items items (itemsModel) Items associated with this field type.
discountLevels discountLevels (discountLevelsModel) Discount levels.