Adding Scheduler Fields
Scheduler fields allow users to see the appointments in which they are scheduled, regardless of the parent application. You can add scheduler fields in applications or questionnaires. Scheduler fields cannot be added as a filter in or as a rule for a data-driven event.
Use the triangular reference in searches, calculations, and inherited record permissions.
Note: After you create a scheduler field, you cannot edit the Display Control or Configuration options. You must delete the scheduler field, which removes the triangular relationships. After creating the scheduler field, you must add it to the application layout.
On this page
Task 1: Create the field
- From your application, go to Designer tab > Layout tab > Objects panel > click
.
- Select the field type and enter a name.
- If possible, keep names under 20 characters. For example, use Description instead of Description of the Asset.
- Capitalize the first letter of each word in the field name. For example, use Predicted Impact instead of Predicted impact.
- Avoid redundant wording in field names. For example, using the word Asset is unnecessary in the following series of fields: Asset Name, Asset Type and Asset Value.
- Use noun-based field names whenever possible. Avoid verb-based field names, for example, Set Asset Name.
- Do not use the names: Version, Level ID, or Content ID for fields that you add to an application or questionnaire. Field do not display properly with these names.
- Select a display control option and click Create Field.
- If you selected Schedule grid, select the applicable available reference. The available reference designates the application to which a relationship is created when the appointment is viewed in the schedule view. This designation creates a triangular relationship among this application.
- If applicable, select the associated level of the available reference.
- Click OK.
- In the General Information section, enter a description.
Field name guidelines:
Option |
Description |
---|---|
Schedule grid |
Displays appointments in a Gantt-like chart with the resource along the left side and the appointments in segmented columns based on start and end dates. In this view, you can see all assigned resources for each parent record. To assign resources to any parent application, you must configure a scheduler field with the schedule view and add it to the layout of that application. Any module with the scheduler field is considered a parent application. |
Resource grid |
Displays appointments in a list grouped by parent applications for all resources or the appointments for a particular resource when viewed by that user. In this view, your users can see all appointments assigned to them through this view regardless of the application to which they are assigned. Users can also see any appointments that are not assigned to a resource. |
For example, if you are creating the Scheduler field in the Engagements application with the schedule view, it becomes the parent application. You can then specify Contacts as its resource, which creates a triangular relationship between the Engagements and Contacts applications and the Appointment application.
If you select the Resource Grid as the Display Control, this designation automatically establishes a relationship between the current module and the Appointment application.
Note: When you save the field, the system strips any HTML tags <?xm>l, <form>, <textarea>, <option>, <select>, <meta>, and <body> that you may have inserted in the description because they may constitute vulnerabilities in the system. The following example shows how you can correct the cascading style sheet (CSS) syntax for the <body> tag so that it will function correctly:
<html>
<head>
<style type="text/css">.c0 { font-family: 'Arial' } .c1 { margin: 0px; background-color: #ffe4e1 } </style>
</head>
<body class="c0">
<p class="c1">This is a text field.</p>
</body>
</html>
Note: Do not use absolute positioning in HTML content.
Task 2: Configure options
In the Options section, select all of the following options that apply to this field.
Option |
Description |
---|---|
Make this a searchable field |
Makes this field available for display in all search results. |
Display this field in global search results |
Makes this field available for display in global search results. This option is only available if this field is set as searchable. |
Task 3: Set the record lookup configuration
Note: If you selected Resource grid as the display control, the record lookup configuration is unavailable. Go to Task 5 to configure the help text.
If you selected Schedule grid as the display control, define the selection and sorting criteria for displaying records from the related application from which you want users to select from Record Lookup.
Options |
Description |
---|---|
Display Fields |
Specifies the fields of data from the relationship application that the Record Lookup page displays for users when they select related records in the Scheduler field. Click Use the If the related application is a leveled application, and you selected fields from 2 or more levels to be displayed in the Scheduler field, you can only arrange those fields on a level-by-level basis. You cannot intermix fields from separate data levels. |
Filters (Optional) |
Determines the filtering criteria for selecting records for display on the Record Lookup page. To set filters for the records to be displayed in the field, select the values for the following fields:
You can also create a dynamic filter for filtering record lookup. |
Sorting (Optional) |
Specifies the fields by which the Record Lookup page sorts referenced records. Select values for the following sorting criteria:
|
Task 4: Schedule the display configuration
Note: If you selected Resource grid as the display control, the display configuration is unavailable. Go to Task 5 to configure the help text.
If you selected Schedule grid as the display control, in the Schedule Display Configuration, select the resource fields that you want to display.
Option |
Description |
---|---|
Display Fields |
Defines the columns of data that display in the Resource column of the schedule view. To select fields for display, in the Display Fields list, click Use the |
Task 5: Configure help text
Field-level help provides additional guidelines and instructions to ensure users enter appropriate information in the field. This Help text displays for users when they add, edit, and view records in the application where the field resides.
Consider the following general guidelines when writing field-level Help:
- Use short, concise instructions that direct the user to take a specific action. For example, "Enter your name" is preferable to "This field is used to enter your name."
- Use complete sentences whenever possible.
- Avoid jargon (unless terms are critical and are familiar to your users).
- Consider the technical aptitude of your audience, and author your help text at a corresponding level.
- Use “you” and “your” as if you are speaking directly to the user.
- Consider posing Help text in the form of a question, for example, "What is your level of interest?"
In the Help text section, do the following:
- Select a display option for both edit and view modes.
- If you are using help text, enter the text.
Option |
Description |
---|---|
None |
Help text does not display. |
Tooltip Icon |
Help icon displays beside the field in edit and view modes. Click this icon to display the field Help. The application dynamically sizes of the Help box based on the number of characters in the text.
|
Below |
Help displays below the field in edit and view modes.
|
Task 6: Configure field access
Access rights determine whether all users or only select users or groups have access to the field.
In the Access section, do the following:
- Select Public or Private.
- If you selected Private, maximize the pane and click
to select the users and groups to whom you want to grant access.
Note: Key fields must be public.