Add or edit an item

The ticket definition contains a number of default ticket items. You can also create and configure custom items. For each custom item, you must define the item type. The new items are added to the ticket definition. The workspaces [Product items] and [Order items] show all available items.

The ticket items used in a product can be configured exclusively for that product in the workspace [Products]. The ticket items used in a view can be configured exclusively for that view.

You cannot change the item name or item type after you create the item.

1. Select the workspace where you want to create the new item: [Product items] or [Order items].

2. Click [Add].

3. Define the item name. You can use the characters: 'a. - z.', 'A. - Z.', '0. - 9.', '_' . Spaces are not allowed. The name must be unique.

   The item name must not exceed 128 characters. The accounting information cannot be collected if the job ticket definition contains an item with a name longer than 128 characters.

4. Define the item type.

5. Define the [Captions]. The caption is the displayed name of the item.

   You can use the characters: 'a. - z.', 'A. - Z.', '0. - 9.', '_' . Spaces are allowed for the caption.

   The default language for the item is displayed in the top of section [Captions]. You can define a caption for each language. See procedure Manage the languages if you want to add or remove a language for an item.

6. Define the tooltip for the item.

   You can define the tooltip in the text field on the right. The text field for the tooltip is coloured yellow. You can define a tooltip for each language.

7. Define the [Configuration].

   In this dialogue, you define the values for the item. The values for the item are available in the ticket definition.

   NOTE

   It is recommended that you assign a neutral default value to the item: None, No, 0, False, [empty string].

   Table 1.

   Item type	Description
   [Number]	[Number] items are items that allow the user to enter a numeric value. [Number of decimals:] When the user types more decimals than defined, the number is rounded according to the defined number of decimals.
   [Yes/No]	[Yes/No] items are items that allow the user to enable or disable an item. You can define the default value for the item. A checkmark in the checkbox means that the default value is 'Yes'. An empty checkbox means that the default value is 'No'. You can define custom captions for the 'Yes' and 'No' values. For example, 'True' and 'False'. For each caption, you can define the tooltip in the text field on the right. The text field for the tooltip is coloured yellow. ['Undefined' caption:] Option [Default value] is overruled when you define a caption for this option. The user must always select a value for this item. No default value is offered to the user.
   [Text]	[Text] items are items that allow the user to type text. Text items can be single-line or multiple lines. An item like [Remarks] is typically a multiple lines item. You can type a text that is displayed as the default string in the job ticket. If the user is allowed to edit the text item, the user can change the default string. You can specify the maximum number of characters that the user can enter. You can define a mask for the text. The mask is compared to the entered text. When the pattern matches, the text is valid. The mask must be a regex (regular expression). NOTE To inform the user about the mask, you can put information about the mask in the tooltip of the item.
   [Date]	[Date] items are items that allow the user to enter a date. The option [The default date is today plus offset:] allows you to define when an action must be performed. The action is related to the job. When you enter '0' today's date is displayed when the item is used. When you enter another number, that number is added to today's date. The resulting date is displayed, but the user can change the date. The syntax of notation [1.00:00:00] means [days.hours:minutes:seconds]. The maximum values for the first and the last valid date relative to the default date are 4700 days. For example, for item [Delivery date] the following values are defined: [The default date is today plus offset:] 4 [First valid date relative to the default date:] -4 [Last valid date relative to the default date:] 4 [Allowed days:] Monday to Friday The job is submitted on Thursday, June 15. The default delivery date becomes Monday, June 19. The job is allowed to be delivered at the earliest on Thursday, June 15. And at the latest on Friday, June 23. NOTE All seven days of the week are used to calculate the first and last valid date relative to the default date. Option [Allowed days:] is not used in the calculation. You can select which days of the week are allowed for the new item of type [Date].
   [Choice]	[Choice] items are items that allow the user to select an option from a drop-down list. Click the '+' icon to add a new option to the choice item. Define the option name. You can use the characters: 'a. - z.', 'A. - Z.', '0. - 9.', '_' . Spaces are not allowed. The name must be unique. Define the option caption. The option caption is the displayed name of the option. The default language for the option is displayed in the top. You can use the characters: 'a. - z.', 'A. - Z.', '0. - 9.', '_' . Spaces are allowed for the caption. You can define a caption for each language. You can define the tooltip in the text field on the right. The text field for the tooltip is coloured yellow. Click [Browse] to add a custom image to an option of a choice item. If the image path is empty, the custom image of the option is removed. Click the pencil icon to edit an option. The icon appears when you hover the mouse pointer over an option. You cannot change the option name of an existing option. Use the 'Up' and 'Down' buttons to change the order of choice items. Select the default option for the choice item from the drop-down list. NOTE All visual ticket items are choice items. You cannot add or remove choices for most of the visual ticket items. Only for NewCoverMedia and Media you can change the available choice items. Select edit or import the media catalogue (Import the media catalogue).
   [Lookup] item using an ODBC driver	Ticket items of type "Lookup" using an ODBC driver use a query to read information from a data source. You can add that information to an order. Create and configure an ODBC driver, see Accessing a data source using a lookup item and an ODBC driver. Select [ODBC driver]. Type the name of the ODBC driver. This is the exact name that you defined in "Data Source Name", or "Name" for a SQL data source, for the ODBC driver. For a SQL data source or a MS Access data source: Type the "User name" and the "Password" of the user account with access rights to the database. NOTE The "User name" and "Password" of the lookup item overwrite the "Login ID" and "Password" of the ODBC driver, see step 6 of procedure "ODBC driver for a SQL data source". For example, if you leave the "User name" and "Password" empty, the user account tries to login with empty credentials. For a TXT or CSV data source, or an Excel data source: Leave the "User name" and the "Password" empty. Create a SQL query to retrieve information from the data source. A valid query must take into account if the selected database is case sensitive for correct data retrieval. You can type $ in the query to display a list of profile items. You can use these profile items in the query. For example, the query is: SELECT F3 FROM ODBC_data_source.txt This query returns all values of column “F3” of data source “ODBC_data_source.txt” to the lookup item “ODBC lookup”. Examples of queries: SQL Driver: SELECT Column FROM Database.Table Microsoft Access Driver: SELECT Column FROM Table Microsoft Excel Driver: SELECT Account FROM [Sheet1$] WHERE User LIKE '$LastName$’ Microsoft Txt Driver: SELECT F2 FROM test.txt Type a value for "Other". The lookup item returns the value of "Other" when the query returns no value. Save the changes. Select "Products" and add the lookup item to one of more products. Publish the changes. NOTE The first 999 values returned by the query are available in the drop-down list.
   [Lookup] item for an LDAP server	Ticket items of type "Lookup" for an LDAP server retrieve data of a user from an LDAP server. You can add that information to an order. You can find an example of a lookup item for an LDAP server below this table. Select [LDAP server]. Select an LDAP server from the drop-down list. The drop-down list contains all LDAP servers used to retrieve user data, see [Configuration] - [System] - [Connectivity] - [LDAP server] - [Authentication & user data]. Type the LDAP attribute from which you want to retrieve the data. You can define one LDAP attribute per lookup item. Define a separator. The LDAP attributes can contain multiple values. Therefore, you have to define a separator to read each separate value correctly. One of the configuration items for an LDAP server is a separator. Both the lookup item and the LDAP server must use the same separator. Else, the lookup item cannot return multiple values of an LDAP attribute correctly. To check which separator is used by the LDAP server, do: Click [Configuration] - [System] - [Connectivity] - [LDAP server] - [LDAP servers]. Check setting [Separator for multi-valued attributes:]. [Selection criteria] The selection criteria define for which user the data from the LDAP attribute will be retrieved. The selection criteria cannot be empty. You have to search for at least one user. The criteria can contain multiple placeholders and constant values. These must be separated by commas. You can type $ in the query to display a list of profile items. You can use these profile items in the query. When you use the lookup item: Firstly, the placeholders are replaced with their actual value. For example, $UserId$ is replaced with the user name of the logged in user. Now, a list of comma separated users is obtained. The users are evaluated in the specified order. The lookup item retrieves the data from the LDAP attribute for the first valid user in the comma separated list. When no valid user is found, the criteria return the default value of the lookup item, see the next step. Type a value for "Other". The lookup item returns the value of "Other" when the criteria return no value. Save the changes. Select "Products" and add the lookup item to one of more products. Publish the changes.

8. Enable option [Log item] if the item must be visible in the log file.

9. Click [Save].

10. Click the [Publish] icon in the tab of workspace [Product & order editor] or [Web shop editor].

    Publishing the changes to the PRISMAdirect server could take some time. The status bar indicates the progress.

Example of a lookup item for an LDAP server

The LDAP server contains the following users: u1, u2, u3, u4, u5. These users have access to the following cost centres:

• u1: c1, c2, c3

• u2: c4

• u3: c2, c4

• u4: c1, c3

• u5: <none>

The cost centres are stored in the [LDAP attribute] "CostCentres".

[Selection criteria]: $OnBehalfUserId$, $UserId$, u2

1. You are logged in as "u1" and you submit a job on behalf of "u3". The lookup item returns: c2, c4.

2. You are logged in as "u1" and you submit a job on behalf of "u5". The value for the CostCenters attribute is empty for "u5", so the selection criteria then evaluate the next value. The next value is the logged in user "u1". The lookup item returns: c1, c2, c3.

3. You are not logged in as an LDAP user and you submit a job on behalf of "u5". The value for the CostCenters attribute is empty for both users, so the selection criteria then evaluate the next value. The next value is user "u2". The lookup item returns: c4.

4. When the selection criteria cannot find a valid user, the selection criteria return the default value of the lookup item as defined in "Other".