...
| Table of Contents |
|---|
Schedule Metadata
K2AServiceLibraryMeta is an endpoint that shows metadata for the other endpoints. For example, this displays the Appointment endpoint. The K2AServiceLibraryMeta endpoint URL can be found in Schedule > installLog.txt in the line Test service with URL: http://yourserver:port/KEY2ACTServiceLibrary/api/K2AServiceLibraryMeta Copy the URL and paste it into your web browser. Firefox will display the JSON file appropriately. Chrome has extensions that can be added to format the JSON display.
| Note |
|---|
If the value you are seeking is not currently present in the metadata, the value would have to be added by the development team as it requires a data model change. This is not a file that can be customized outside of development. |
Grid Configuration
There are many grids in Schedule. A few examples of the primary grids are:
- Unscheduled/Unassigned Appointments
- Service Calls
- Equipment
- Location Contacts
- Maintenance Contracts
- Jobs
...
You can pick from these column values to tailor Schedule for your users.
Adding a Column to a Grid
...
Open the columns.json file located in web client install location \Schedule\Scripts\K2A\. Inside each of the grid folders (AppointmentHistoryGrid, AttachmentGrid, ResourceGrid, UnscheduledGrid), you will find the columns.json file. Open this file with a text editor.
| Note |
|---|
| Only the grid folders that contain the columns.json file are customizable. If there isn't a columns.json file then the grid will only have the columns displayed. |
Locate the position where you want the column to display. For example, as the last column.
| Note |
|---|
| Required columns and/or their required location are noted in the file. |
...
- "label": The information within the quotation marks displays as the column header.
- "id": Enter the field name exactly as it appears in the endPoint in K2AServiceLibraryMeta.
...
For example, to add the Service Call Creation Date to the Unscheduled Grid on the Schedule Board, add the following in the UnscheduledGrid\columns.json file:
{ "label": "SC Created","width": "150","type": "dhxcalendar","align": "left","sort": "date","id": "callCreationDate"}
Grid Column Formatting
This section describes the columns.json file.
...
Actual label that will be displayed on the header of the column.
...
The width in pixels of the column. To make a column hidden set the size to 0.
...
Defines the type of field the column contains.
- "rotxt": Read only text field.
- "ron": Read only numeric field
- "dhxCalendar": Date field
...
Defines the alignment for the column, including the header.
- "left": Left aligned.
- "center": Center aligned.
- "right": Right aligned.
...
Defines the type of sorting for the column.
- "str": Text sorting.
- "date": Date sorting.
- "int": Number sorting
- "na": No sorting
Column Filtering
This section describes how filtering works in the filter boxes on the grid.
- Text Filter: A column type of "rotxt" will use a text filter. Retrieves values which contain mask defined through text field.
- Numeric Filter: A column type of "ron" will use a text filter that allows using comparison operators in it. Retrieves values which contain mask defined through text field.
The possible comparison operators are:
...
See http://yourserver:port/KEY2ACTServiceLibrary/api/K2AServiceLibraryMeta. Copy the URL and paste it into your web browser. Firefox will display the JSON file appropriately. Chrome has extensions that can be added to format the JSON display.
...
| Column | ||
|---|---|---|
| ||
Appointment |
| Column | ||
|---|---|---|
| ||
LocationContract |
| Column | ||
|---|---|---|
| ||
ServiceArea |
User-Defined Field Configuration
In Schedule setup, you have the capability to mark the fields to display in specific windows. If your company has utilized any of the user-defined fields (UDF) in Service Management that are not listed, you can add those fields to display as options in the Settings window, and then mark the checkbox to show the field(s). Conversely, if you do not want UDF fields to display in the Settings window, you can update this information.
The UDF files are found in C:\Program Files (x86)\Signature\ServiceLibrary\UDF. (This is the default ServiceLibrary installation location.)
The files are:
- AppointmentUDF.json : Can be displayed on Service, Job, and/or Resource appointment window.
- CustomerUDF.json : Can be displayed on a Customer window.
- LocationUDF.json : Can be display on a Location window.
- WorkOrderUDF.json : Can be display on a Service Call window.
Example: for Location you could add User_Defined_9a as follows. Append the following to the LocationUDF.json file:
{ "Column": "Service_User_Define_9", "Length": 0,
"Label": "This is my label to display",
"Type": "Date",
"IsUsed": true,
"wsiParameterName": ""
}
| Note |
|---|
If IsUsed is not set to true, the field will not show up in settings for you to add to the displayed fields. |
Setting up a Field to Display in Schedule Service Call & Appointment Form Fields Settings
For Service Appointments, Job Appointments and Technician Activities:
- To display an appointment UDF field, open the AppointmentUDF.json file in a program that allows you to edit the file (example: Notepad). Edit the following fields within a set of braces { }.
- "Label": User defined label that displays for the property.
- "IsUsed": To display the field, change the IsUsed value to true .
- Save the AppointmentUDF.json file.
For the Service Call form:
Once values are added into the WorkOrderUDF.json file, they become immediately available to add to the forms from the Schedule Settings window.
- To display a service call UDF field, open the WorkOrderUDF.json file in a program that allows you to edit the file (example: Notepad++). Edit the following fields within a set of braces { }.
- "Label": User defined label that displays for the property.
- "IsUsed": To display the field, change the IsUsed value to true .
- Save the WorkOrderUDF.json file.
Adding the User-Defined Field to the Schedule Appointment Window
- Open Schedule, go to Settings > Service Call & Appointment Form Fields.
- Select the appropriate tab(s) and mark the checkbox next to the field(s) that you added to update the windows.
- Select Save.
Appointment Label and Tooltip Configuration
Appointment panel labels and tooltip labels are defined similarly using JSON files. These files are in: C:\Program Files (x86)\Signature\Schedule\Scripts\K2A\SchedulerControl.
The files are:
- eventContent.json: Appointment panel labels
- tooltipContent.json: Appointment tooltip labels
Below is an example of the file structure. Each section within the curly brackets { } represents an appointment property that you will see on the schedule board. The order that your fields appear in the configuration file is the order that they will show in on the schedule board.
- "id": Appointment property and must be one of these valid case-sensitive values: Appointment Property List. See Example: Appointment Property List.
- "label": User-defined label that displays for the property. See Example: Additional User-Defined Fields.
- "apptType": Appointment type to display the label for. The available appointment types are: "WorkOrder", "Job", and "Technician".
Adding Appointment Description to Mouse-Over Tooltip
C:\Program Files (x86)\Signature\Schedule\Scripts\K2A\SchedulerControl
{ "id": "description",
"label": "App Desc: ",
"apptType": [ "ServiceCall", "Job" ]
}
Adding Cost Code Alias to the Tooltip or Job Appointment Bar
Add this to the tooltipContent.json and eventContent.json:
{
"id": "costCodeAlias",
"label": "Cost Code: ",
"apptType": "Job"
},
Adding Service Call Description with a Label
(Not sure job needs to be in the apptType list though as job appointments don’t have service call descriptions.)
{ "id": "workOrderDescription",
"label": "Service Desc: ",
"apptType": [ "ServiceCall", "Job" ]
},
Adding Service Call Description Without a Label
{ "id": "workOrderDescription", "label": "",
"apptType": [ "ServiceCall", "Job" ]
},
Altering the Resource Data Shown in the Timeline View
This example shows you how to set the Resource box to display only the Tech ID and Primary Skill Level in the Schedule Grid when using the Timeline View. See Example: Modified schedulerControl.js.
...
Go to the folder where the schedulerControl.js file is installed. For a base installation, using the installation defaults, it would be here: C:\Program Files (x86)\Signature\Schedule\Scripts\K2A\SchedulerControl.
...
| Child pages (Children Display) |
|---|