orderFormModel

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

Order form model class

XML

Attributes

name	type	description
atLeastOneFile	boolean	At Least One File If this option is set, a Job will require at least one file to be uploaded before the job can be submitted. The 'Finish' button to submit the job will only be shown to the user once there is at least one file added to the Job. Don't use this option if you wish to receive jobs without any files.
daysBeforeUploadExpires	int	Days before upload expires: This field will set the number of days before a package expires. This field is only used when RecipientEmail field and expireupload field are part of the order form. Scenarios: Admin leaves Days before upload expires field blank and has expireupload field on the order form: This will give full control to the user to specify the days before the Job expires. The user can enter any date in the future Admin specifies Days before upload expires but hides expireupload field on the order form: Jobs will expire after the number of days specified by the admin Admin specifies Days before upload expires and shows expireupload field on the order form: User will be allowed to specify a date which the Job expires provided it does not exceed the number of days specified by the admin from job submission. Admin leaves Days before upload expires field blank and doesn't add expireupload field to the order form: Job will never expire
formName	string	Unique form name.
formNameAlias	string	Display Name This is the actual text that will appear to the end user. The text will appear if the user can access more than one order form and when they click on "New Job" from the main menu. The text will appear in the drop down immediately below the "New Job" button. Default Form ID will be used if this text is not set.
isTemplate	boolean	Flag to indicate if this is a template.
itemsPerPage	int	Items Per Page This setting is for file form and edit file properties page. This will allow the specified number of files to be shown per page before confirming the Job. If no number is specified or if a number entered is 0, all the uploaded files are shown on one page with no previous or next links.
minimumCost	double	Minimum cost to use.
privateGroupOnly	boolean	Private Order Form (Group Only) - Enterprise Only By default all users that are NOT members of any group will see all the order forms defined in the system. Use this setting if you wish to make certain forms private and only visible to group members.
showPrice	boolean	Calculate Price If set, this option will cause the price of the order to be calculated using the price fields set in Job Field specifications, and displayed on the Job Order form, the Confirm Job page and the More User Info page.
showThumbnails	boolean	Show Thumbnails Display's thumbnails in certain workflows on the Job confirmation page next to each item. Preview thumbnails only appear on images uploaded using the Java Applet option.
thumbnailHeight	string	Thumbnail Height Set the fixed height of the thumbnails. If this is set to blank, then a size relative to the width will be used. Please note: If both height and width are blank, no resizing will be done to the images. This is not recommended.
thumbnailWidth	string	Thumbnail Width Set the fixed width of the thumbnails. If this is set to blank, then a size relative to the height will be used. Please note: If both height and width are blank, no resizing will be done to the images. This is not recommended.
tierPricing	boolean	Tier Pricing This option applies when a discount levels are used to set prices. In tier pricing, the discounted pricing is only applied to quantities above the discounted level, whereas in normal mode, all items have the discounted price. For example, with one discount level of 10 items, and prices of $1, and $.80, ,in normal mode, the cost will be $8.80: 11 x 0.80c - 0.80 being the discounted price for quantity 11, however when Tier Pricing is in effect, the cost will be $10.80: $10 x $1 plus 0.80.
href	string	Hyperlink reference to the resource

Elements

name (type)	min/max occurs	description
fileFields (fileFieldsModel)	0/1	List of file fields. These fields will be present for every file selected.
jobFields (jobFieldsModel)	0/unbounded	List of job fields.

JSON

property	type	description
atLeastOneFile	boolean	At Least One File If this option is set, a Job will require at least one file to be uploaded before the job can be submitted. The 'Finish' button to submit the job will only be shown to the user once there is at least one file added to the Job. Don't use this option if you wish to receive jobs without any files.
daysBeforeUploadExpires	int	Days before upload expires: This field will set the number of days before a package expires. This field is only used when RecipientEmail field and expireupload field are part of the order form. Scenarios: Admin leaves Days before upload expires field blank and has expireupload field on the order form: This will give full control to the user to specify the days before the Job expires. The user can enter any date in the future Admin specifies Days before upload expires but hides expireupload field on the order form: Jobs will expire after the number of days specified by the admin Admin specifies Days before upload expires and shows expireupload field on the order form: User will be allowed to specify a date which the Job expires provided it does not exceed the number of days specified by the admin from job submission. Admin leaves Days before upload expires field blank and doesn't add expireupload field to the order form: Job will never expire
formName	string	Unique form name.
formNameAlias	string	Display Name This is the actual text that will appear to the end user. The text will appear if the user can access more than one order form and when they click on "New Job" from the main menu. The text will appear in the drop down immediately below the "New Job" button. Default Form ID will be used if this text is not set.
isTemplate	boolean	Flag to indicate if this is a template.
itemsPerPage	int	Items Per Page This setting is for file form and edit file properties page. This will allow the specified number of files to be shown per page before confirming the Job. If no number is specified or if a number entered is 0, all the uploaded files are shown on one page with no previous or next links.
minimumCost	double	Minimum cost to use.
privateGroupOnly	boolean	Private Order Form (Group Only) - Enterprise Only By default all users that are NOT members of any group will see all the order forms defined in the system. Use this setting if you wish to make certain forms private and only visible to group members.
showPrice	boolean	Calculate Price If set, this option will cause the price of the order to be calculated using the price fields set in Job Field specifications, and displayed on the Job Order form, the Confirm Job page and the More User Info page.
showThumbnails	boolean	Show Thumbnails Display's thumbnails in certain workflows on the Job confirmation page next to each item. Preview thumbnails only appear on images uploaded using the Java Applet option.
thumbnailHeight	string	Thumbnail Height Set the fixed height of the thumbnails. If this is set to blank, then a size relative to the width will be used. Please note: If both height and width are blank, no resizing will be done to the images. This is not recommended.
thumbnailWidth	string	Thumbnail Width Set the fixed width of the thumbnails. If this is set to blank, then a size relative to the height will be used. Please note: If both height and width are blank, no resizing will be done to the images. This is not recommended.
tierPricing	boolean	Tier Pricing This option applies when a discount levels are used to set prices. In tier pricing, the discounted pricing is only applied to quantities above the discounted level, whereas in normal mode, all items have the discounted price. For example, with one discount level of 10 items, and prices of $1, and $.80, ,in normal mode, the cost will be $8.80: 11 x 0.80c - 0.80 being the discounted price for quantity 11, however when Tier Pricing is in effect, the cost will be $10.80: $10 x $1 plus 0.80.
href	string	Hyperlink reference to the resource
fileFields	fileFields (fileFieldsModel)	List of file fields. These fields will be present for every file selected.
jobFields	array of jobFields (jobFieldsModel)	List of job fields.