Product attribute reference
The product attributes are defined in a JSON configuration file. For more information about JSON, see:
Each product configuration file consists of the following components:
- image—The image file that is displayed in the Product Selection area in the User web interfaceThe User web interface provide a range of services for users, including a summary of usage and balance history, a list of the shared accounts that the user can use for printing, the current costs for printing usage, ability to add balance by using a TopUp/Pre-Paid Card or an external payment system (when using the payment gateway module), transfer funds to other users, view a history of balance transactions, view a list of the user's recent printing, and view print jobs pending release (when using a Release Station)..
- productVisibility—Indicates whether or not the product is displayed in the Customer interface.
- orderAttachments—(optional) Indicates whether or not the customer is allowed to provide the original document as a physical (rather than electronic) document, and/or attach an electronic document.
-
attributes—the fields that are displayed on the New Order form, for example, “Binding” or “Paper stock” (see 1 in the image below). You can use any combination of the predefined attributes. Attributes that provide a drop-down list can have:
-
options—the options that are available in a field with a drop-down list. For example, the Binding field might have a drop-down list of options including “Comb Binding”, “Spiral Binding”, or “Stapling” (see 2 in the image below). You can define any number of options for an attribute. The first option under an attribute is the default option. If you define only one option, the option is auto-selected and locked when the order is created. Fields with only one option are indicated on the Order screen by a padlock icon.
Binding options can also contain subAttributes, which are any additional fields that are displayed on the New Order form after a user has selected a particular binding option. For example, if a user selects Comb Binding, they might also need to select the binding edge and the color of the binding (see 3 in the image below). You can define any number of subAttributes for a binding option. subAttributes can also have options, that is, a drop-down list in the New Order form. For example, the Binding edge subAttribute might have the option to bind the long edge or the short edge of the document (see 4 in the image below).
-
- The order in which the attributes are defined in the configuration file does NOT determine the order the fields are displayed on the New Order form. The order of fields on the page is predefined and cannot be changed.
- If an attribute has only one option, then the option is auto-selected and cannot be changed in the Order form.
- If the attribute has multiple options, the first option is the default.
- If you define only one option, the option is auto-selected and cannot be changed when the order is created.
- If you configure an attribute in this file, the associated field must be completed when an order is placed (you cannot create optional fields).
image
The image file that is displayed in the Product Selection area in the User web interface.
Job Ticketing comes with a collection of stock images that are used in the example products. Stock images are located in:
<install path>/job-ticketing/config/stock-images
You can use either stock images, or your own custom images. Custom images must be located in the following path:
<install path>/job-ticketing/config/custom-images
Images must be less than 250kb and in one of the following image formats:
- jpg (jpeg)
- png
- svg
- gif
User web interface
Configuration file
productVisibility
Determines whether or not the product is displayed in the Customer interface. Valid values are:
- draft—The product is not available in the Customer interface. Operators can see the product (with a “Draft” stamp) in the Customer view, however, customers cannot see the product.
- published—The product is available in the Customer interface.
User web interface
Configuration file
orderAttachments
Indicates whether or not the customer is allowed to:
- provide the original document as a physical (rather than electronic) document
- attach an electronic document to the order
New Order form
Configuration file
|
Object |
Description |
|---|---|
| fileUploadEnabled |
Indicates whether or not the customer can attach one or more electronic documents to the order. Valid values:
|
|
physicalCopyEnabled |
Indicates whether or not the customer can provide the original document as a physical (rather than electronic) document. Valid values:
If set to true, an additional option to specify that a Physical document has been supplied is available under the Files area on the New Order form in the Operator interface. This option is NOT displayed in the Customer interface. |
attributes
Attributes define the fields that are displayed on the New Order form that specify the print job settings, for example, “Binding”. You can use any combination of the attributes. The order in which they are defined does not affect the order in which they are displayed on the New Order form.
copies
Determines whether or not the Copies field is displayed in the Details area on the New Order screen.
New Order form
Configuration file
|
Object |
Description |
|---|---|
|
visible |
Indicates whether or not the option to specify the number of copies is available. Valid values:
|
printColor
Determines whether or not the Print color field is displayed in the Details area on the New Order screen.
New Order form
Configuration file
|
Object |
Description |
|---|---|
|
visible |
Indicates whether or not the option to select grayscale or color is available. Valid values:
|
singleOrDoubleSided
Determines whether or not the Single sided or double sided field is displayed in the Details area on the New Order screen.
New Order form
Configuration file
|
Object |
Description |
|---|---|
|
visible |
Indicates whether or not the option to print single or double-sided is available. Valid values:
|
due
Determines whether or not the Due date field is displayed on the New Order screen, and if it is, which days are available for selection.
New Order form
Configuration file
|
Object |
Description |
|---|---|
|
visible |
Indicates whether or not the Due date field is displayed on the New Order screen. Valid values:
|
| leadTimeDays |
The number of days lead time that the room needs before an order can be filled. For example, if you need a minimum of 1 day for laminating, you would enter 1 as the leadTimeDays value. This means a customer would not be able to select today as the Due Date. Valid values: Numerical value (default is 0). |
| workingDays |
The days of the week that can be requested as a due date. Valid values: Mon, Tue, Wed, Thu, Fri, Sat, Sun NOTE
These values are NOT case sensitive. For example, if your room is not open on weekends, you would specify:
"workingDays": ["Mon","Tue","Wed","Thu","Fri"]
If your room was open 7 days a week, you would specify:
"workingDays": ["Mon","Tue","Wed","Thu","Fri",
"Sat","Sun"]
|
paperStock
Determines the options available in the Paper stock field in the Details area on the New Order screen.
New Order form
Configuration file
For each paper option, define the following:
|
Option details |
Description |
|---|---|
|
size |
The paper size. For example, A4 or A3. Valid format: Text string. |
|
color |
The paper color. For example, white, red, or black. Valid format: Text string. |
|
type |
(optional) The paper type. Use this option to allow selection of the paper stock, such as the weight (for example, 100gsm or 1500gsm), or the finish (for example, matte or gloss). Valid format: Text string. |
| cost |
The estimated cost per sheet of paper. Valid format: Decimal |
custom fields
Displays custom fields in their own area on the New Order screen. You can create either text entry fields or drop-down lists. For example, you might offer a thesis product that has the thesis title and student name in gold lettering.
You can have only one custom fields section on the New Order form.
New Order form
Configuration file
For the custom area, define the following:
|
Option details |
Description |
||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
name |
The name of the custom area as it is displayed on the New Order form. Valid format: Text string. |
||||||||||||||||||||||||||||||||
| fields |
The fields that will be available in the custom area. For each field, define the following:
|
||||||||||||||||||||||||||||||||
operator only custom fields
Displays custom fields that are visible only in the Operator interface, in their own area on the New Order screen. You can create either text entry fields or drop-down lists. For example, you might want to record the operator's name or the printer being used for each order.
You can have only one operator only custom fields section on the New Order form.
New Order form
Configuration file
For the operator only custom area, define the following:
|
Option details |
Description |
||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
name |
The name of the operator only custom area as it is displayed on the New Order form. Valid format: Text string. |
||||||||||||||||||||||||||||||||
| fields |
The fields that will be available in the operator only custom area. For each field, define the following:
|
||||||||||||||||||||||||||||||||
collating
Determines the options available in the Collating drop-down list in the Finishing area on the New Order screen. This field allows customers to select the type collation they need, for example, you might want to offer a collation option that creates individual packs containing one copy of multiple documents.
New Order form
Configuration file
For each collating option, define the following:
|
Option details |
Description |
|---|---|
|
name |
The name of the collation option as it is displayed on the new order form. Valid format: Text string. |
|
image |
(optional) The image of the collation option to be displayed on the drop-down menu next to the option. NOTE
You must provide an image for all or none of the options. The image file must be located in the following path: <install path>/job-ticketing/config/custom-images Images must be less than 250kb and in one of the following image formats:
Valid format: Text string. |
|
description |
(optional) The description of the collation option as it is displayed on the new order form. Valid format: Text string. |
| cost |
The estimated cost for the collating option. Valid format: Decimal |
frontCover
Determines the options available in the Front cover drop-down list in the Finishing area on the New Order screen. This field allows customers to select the type of material for the front cover of their bound documents, for example, acetate, Leathercarft, or cardboard.
New Order form
Configuration file
For each front cover option, define the following:
|
Option details |
Description |
|---|---|
|
name |
The name of the front cover material as it is displayed on the new order form. Valid format: Text string. |
|
image |
(optional) The image of the front cover material to be displayed on the drop-down menu next to the option. NOTE
You must provide an image for all or none of the options. The image file must be located in the following path: <install path>/job-ticketing/config/custom-images Images must be less than 250kb and in one of the following image formats:
Valid format: Text string. |
|
description |
(optional) The description of the front cover option as it is displayed on the new order form. Valid format: Text string. |
| cost |
The estimated cost for the front cover option. Valid format: Decimal |
|
printable |
Whether or not the Print on cover field is available on the new order form. This option allows a customer to print the first page of the document on the front cover or leave the front cover blank. Valid values:
|
backCover
Determines the options available in the Back cover drop-down list in the Finishing area on the New Order screen. This field allows customers to select the type of material for the back cover of their bound documents, for example, acetate, Leathercarft, or cardboard.
New Order form
Configuration file
For each back cover option, define the following:
|
Option details |
Description |
|---|---|
|
name |
The name of the back cover material as it is displayed on the new order form. Valid format: Text string. |
|
image |
(optional) The image of the back cover material to be displayed on the drop-down menu next to the option. NOTE
You must provide an image for all or none of the options. The image file must be located in the following path: <install path>/job-ticketing/config/custom-images Images must be less than 250kb and in one of the following image formats:
Valid format: Text string. |
|
description |
(optional) The description of the back cover material as it is displayed on the new order form. Valid format: Text string. |
| cost |
The estimated cost for the back cover option. Valid format: Decimal |
cutting
Determines the options available in the Cutting drop-down list in the Finishing area on the New Order screen. This field allows customers to select the type of cutting they need, for example, cut the document in half horizontally.
New Order form
Configuration file
For each cutting option, define the following:
|
Option details |
Description |
|---|---|
|
name |
The name of the cutting option as it is displayed on the new order form. Valid format: Text string. |
|
image |
(optional) The image of the cutting option to be displayed on the drop-down menu next to the option. NOTE
You must provide an image for all or none of the options. The image file must be located in the following path: <install path>/job-ticketing/config/custom-images Images must be less than 250kb and in one of the following image formats:
Valid format: Text string. |
|
description |
(optional) The description of the cutting option as it is displayed on the new order form. Valid format: Text string. |
| cost |
The estimated cost for the cutting option. Valid format: Decimal |
binding
Determines the options available in the Binding drop-down list in the Finishing area on the New Order screen. This field allows customers to select the type of binding for their documents, for example, comb binding, spiral binding, or stapling.
New Order form
Configuration file
For each binding option, define the following:
|
Options details |
Description |
||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
name |
The name of the binding option as it is displayed in the drop-down list (for example, Comb binding). Valid format: Text string. |
||||||||||||||||||||||||||||||||
|
description |
(optional) A description of the binding type. This description is displayed below the binding option name in the drop-down menu. Valid format: Text string. |
||||||||||||||||||||||||||||||||
|
image |
(optional) The image that is displayed next to the option in the Binding drop-down list. NOTE
You must provide an image for all or none of the options. The image file must be located in the following path: <install path>/job-ticketing/config/custom-images Images must be less than 250kb and in one of the following image formats:
|
||||||||||||||||||||||||||||||||
| cost |
The estimated cost for the binding option. Valid format: Decimal |
||||||||||||||||||||||||||||||||
|
subAttributes |
subAttributes define any additional fields that are displayed when a binding option is selected on the New Order form. For example, if a customer selects stapling, they might also be required to select the position of the stapling (left of document or top left corner). If the option does not require any additional fields, you do not need subAttrbutes. For each additional field, define the following:
|
||||||||||||||||||||||||||||||||
holePunching
Determines the options available in the Hole Punching drop-down list in the Finishing area on the New Order screen. This field allows customers to select the type of hole punching they need, for example, two hole punch or three hole punch.
New Order form
Configuration file
For each hole punching option, define the following:
|
Option details |
Description |
|---|---|
|
name |
The name of the hole punching option as it is displayed on the new order form. Valid format: Text string. |
|
image |
(optional) The image of the hole punching option to be displayed on the drop-down menu next to the option. NOTE
You must provide an image for all or none of the options. The image file must be located in the following path: <install path>/job-ticketing/config/custom-images Images must be less than 250kb and in one of the following image formats:
Valid format: Text string. |
|
description |
(optional) The description of the hole punching option as it is displayed on the new order form. Valid format: Text string. |
| cost |
The estimated cost for the hole punching option. Valid format: Decimal |
folding
Determines the options available in the Folding drop-down list in the Finishing area on the New Order screen. This field allows customers to select the type of folding they need, for example, Bifold or Trifold.
New Order form
Configuration file
For each folding option, define the following:
|
Option details |
Description |
|---|---|
|
name |
The name of the folding option as it is displayed on the new order form. Valid format: Text string. |
|
image |
(optional) The image of the folding option to be displayed on the drop-down menu next to the option. NOTE
You must provide an image for all or none of the options. The image file must be located in the following path: <install path>/job-ticketing/config/custom-images Images must be less than 250kb and in one of the following image formats:
Valid format: Text string. |
|
description |
(optional) The description of the folding option as it is displayed on the new order form. Valid format: Text string. |
| cost |
The estimated cost for the folding option. Valid format: Decimal |
laminating
Determines the options available in the Laminating drop-down list in the Finishing area on the New Order screen. This field allows customers to select the type of laminating they need, for example, Gloss with no border or Gloss with 1/4" border.
New Order form
Configuration file
For each laminating option, define the following:
|
Option details |
Description |
|---|---|
|
name |
The name of the laminating option as it is displayed on the new order form. Valid format: Text string. |
|
image |
(optional) The image of the laminating option to be displayed on the drop-down menu next to the option. NOTE
You must provide an image for all or none of the options. The image file must be located in the following path: <install path>/job-ticketing/config/custom-images Images must be less than 250kb and in one of the following image formats:
Valid format: Text string. |
|
description |
(optional) The description of the laminating option as it is displayed on the new order form. Valid format: Text string. |
| cost |
The estimated cost for the lamination option. Valid format: Decimal |
packaging
Determines the options available in the Packaging drop-down list in the Finishing area on the New Order screen. This field allows customers to select the type of packaging they need, for example, shrink wrap each item or shrink wrap a set of items.
New Order form
Configuration file
For each packaging option, define the following:
|
Option details |
Description |
|---|---|
|
name |
The name of the packaging option as it is displayed on the new order form. Valid format: Text string. |
|
image |
(optional) The image of the packaging option to be displayed on the drop-down menu next to the option. NOTE
You must provide an image for all or none of the options. The image file must be located in the following path: <install path>/job-ticketing/config/custom-images Images must be less than 250kb and in one of the following image formats:
Valid format: Text string. |
| cost |
The estimated cost for the packaging option. Valid format: Decimal |
| showItemsPerSet |
Whether or not the customer can specify the number of items to be included in each set. Valid values:
|
material
Determines the options available in the Material field on the New Order screen. This field allows customers to select the type of material and the color for their 3D print job.
New Order form
Configuration file
For each material option, define the following:
|
Option details |
Description |
|
|---|---|---|
|
name |
The name of the material as it is displayed in the Material field in the User web interface. Valid format: Text string. |
|
|
color |
(optional) The colors that a customer can select for the 3D print job. |
|
|
|
name |
The name of the color as it is displayed in the Color field in the User web interface. Valid format: Text string. |
|
|
value |
(optional) The hexadecimal value for the color that is displayed on the New Order screen when the customer selects a color. Valid format: Hexadecimal value (for example, #00ff00). |
|
cost |
The estimated cost for the material option. Valid format: Decimal |
|
proofRequired
Determines the options available in the Do you need a proof? drop-down list on the New Order screen. This field allows customers to select whether or not they want to see and approve a proof of the print job before the job is processed.
New Order form
Configuration file
For each proofing option, define the following:
|
Option details |
Description |
|---|---|
|
name |
The text that is displayed in the Do you need a proof? drop-down list. Valid format: Text string. Default options are:
|
|
description |
(optional) The text that is displayed below the Do you need a proof? field that describes the selected option. Valid format: Text string. |
Delivery options is a global setting and is configured in a different file. For more information, see Configure delivery options.