Versions Compared

Version Old Version 1 New Version 2
Changes made by

Documentation Reviewer

Documentation Reviewer

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Schedule Configuration
Contents
Schedule Meta Data
Grid configuration
Adding a column to a grid
Grid column formatting
Column Filtering
List of endPoints (example)
User-defined field configuration
Setting up a field to display in Schedule Service Call & Appointment Form Fields Settings
Adding the user-defined field to the Schedule appointment window
Appointment label and tooltip configuration
Appointment property list
Additional user-defined fields
Anchor_Adding_Columns_to_Adding_Columns_to Anchor_Adding_a_column_Adding_a_column

...

Contents

Table of Contents


Schedule Meta Data

K2AServiceLibraryMeta is an endpoint that shows meta data 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 meta data, 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:

...


Each of these grids has a columns.json file that indicates the fields of data that can be displayed and the order, as well as the label for the field. There are some restrictions in some grids, where the first few fields are required to be present and in a certain location. Those restrictions are noted in the json files.
You can pick from these column values to tailor Schedule for your users.

...

Adding a column to a grid

  1. Open K2AServiceLibraryMeta in your browser. Locate the endpoint and objectProperties. Within each endpoint, objectProperties have been added that lists the properties associated with the endpoint with a method of GET by the object name, which are used in our JSON files. This does not list the unvalidated user-defined fields (UDF).
  2. Open the columns.json file located in web client install location \Schedule\WebsiteFiles\Scripts\K2A\. Inside each of the grid folders, 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 is no columns.json file then the grid will only have the columns displayed.
  3. 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.
  4. Copy the information from the current last column, including the curly brackets { }, and paste this directly below.
  5. Add a comma ',' to the closing curly bracket } of the former last column.
  6. Edit the following:
    1. "label": The information within the quotation marks displays as the column header.
    2. "id": Enter the field name exactly as it appears in the endpoint in K2AServiceLibraryMeta.
  7. Save the columns.json file.
  8. Launch Schedule and view the column that was just added. If the column doesn't display, you may need to reset the grid. Resetting the grid will reset the existing columns to their original location in the grid. To reset a grid, choose Menu and then choose About, choose the grid name from the Reset Grid drop-down and then choose Reset. Anchor_Example_Example Anchor_K2AServiceLibraryMeta_Endpoint_K2AServiceLibraryMeta_Endpoint Anchor_List_of_endPoints_List_of_endPoints

...

...

Grid column formatting

(This section describes the columns.json file)

Label

...

Actual label that will be displayed on the header of the column.

Width

...

The width in pixels of the column. To make a column hidden set the size to 0.

Types

...

  • "rotxt" is a read only text field
  • "ron" is a read only numeric field
  • "dhxCalendar" is for date field
Align

...

  • "left" is left aligned
  • "center" is center aligned
  • "right" is right aligned
Sort

...

  • "str" is for text sorting
  • "date" is for date sorting
  • "int" is for number sorting
  • "na" is for no sorting


Anchor
_Toc530045251
_Toc530045251
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:

=

Equal to

>

Greater than

<

Less than

?

Less or equal to

>=

Greater or equal to

n1..n2A range of values
  • '=' - equal to;
  • '>' - greater than;
  • '<' - less than;
  • '?' - less or equal to;
  • '>=' - greater or equal to;
  • 'n1..n2' - a range of values.

...

Anchor
_Toc530045252
_Toc530045252
List of endPoints (example)


(See http://yourserver:port/KEY2ACTServiceLibrary/api/K2AServiceLibraryMeta ) Appointment
AppointmentHistory
AppointmentStatus
Attachment
Company
Customer
CustomerSearch
Division
Equipment
ERPUser
Job
JobCostCode
K2AServiceLibraryMeta
K2ASettings
LaborGroup
LocationContact
LocationContract
Location
Note
PricingMatrix
ResourceActivity
ResourceBranch
Resource
ResourceExtension
ResourceInventorySite
ResourceReport
ResourceServiceArea
ResourceShift
ResourceSkillSet
ResourceTeam
Role
RolePermission
Salesperson
ServiceArea
ServiceOptions
SkillLevel
Subcontractor
Tasks
TimeStamp
TimeZone
User
UserRoles
ValidatedUserDefined
WorkOrder
WorkOrderProblem
WorkOrderReport
WorkOrderResolution
WorkOrderType

Anchor
_.JSON_Files_for
_.JSON_Files_for
Anchor
_Adding_User-Defined_Fields
_Adding_User-Defined_Fields

...


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.

Anchor
_Setting_up_a
_Setting_up_a
Anchor
_Toc530045254
_Toc530045254
Setting up a field to display in Schedule Service Call & Appointment Form Fields Settings

...

  • "Label" – User defined label that displays for the property.
  • "IsUsed" - To display the field, change the IsUsed value to true .
  1. Save the AppointmentUDF.json file.


For the Service Call form, use the WorkOrderUDF.json
Once values are added into this json file, they become immediately available to add to the forms from the Schedule Settings window. Follow the instructions below.

Anchor
_Adding_the_user-defined
_Adding_the_user-defined
Anchor
_Toc530045255
_Toc530045255
Adding the user-defined field to the Schedule appointment window

...

  • "id" - Appointment property and must be one of these valid case-sensitive values.
  • "label" - User-defined label that displays for the property.
  • "apptType" - Appointment type to display the label for. The available appoint types are: "WorkOrder", "Job", and "Technician".
Wiki Markup
!worddav9c79a433b55cba3c85dec89bdaedf571.png|height=344,width=301! 
\\
\\
Adding appt description to mouse-over  tooltip:     (x86)\Signature\Schedule\{*}WebsiteFiles{*}\Scripts\K2A\SchedulerControl
\\
\{
    "id": "description",
    "label": "App Disc: ",
    "apptType": \[ "ServiceCall", "Job" \]
  \}
\\
To add Cost Code Alias to the tool-tip or job appointment bar… add this to the tooltipContent.json and eventContent.json:
\{
"id": "costCodeAlias",
"label": "Cost Code: ",
"apptType": "Job"
\},
 \\
Adding service call description – both with and without a label
  \{
    "id": "workOrderDescription",
    "label": "Service Desc: ",
    "apptType": \[ "ServiceCall", "Job" \]
  \},   
                                 (not sure job needs to be in the apptType list though…because job appts don't have svc call descriptions)
\\
!worddav62572427ad67eb9a51a9adfe0d816c81.png|height=242,width=354!
\\
\\
Without Label:
  \{
    "id": "workOrderDescription",
    "label": "",
    "apptType": \[ "ServiceCall", "Job" \]
  \},
\\
\\
\\

Anchor
_Appointment_Property_List
_Appointment_Property_List
Anchor
_Toc530045257
_Toc530045257
Appointment property list

start_date
end_date
number
estimateHours
resourceName
customerName
locationName
costCode
costCodeAlias
actualHours
technicianStatus
appointmentStatus
appointmentPriority
group
skillLevel
completionDate
modifiedDate
modifiedUser
division
affiliate
region
branch
serviceArea
workOrderType
workOrderProblem
workOrderPriority

Anchor
_Toc530045258
_Toc530045258
Additional user-defined fields

In addition to the above fields any user defined fields in the SV00301 table are available to include such as:
Service_User_Define_1
Service_User_Define_2
Service_User_Define_3

To Alter the data shown in the Resource box, in the Schedule Grid when using the Timeline View

...


resourceColumnData: function (resource, label) {return "<div id='headerLabel-" + resource.key + "' data-resourceID='" + resource.key + "' class='resourceHeaderDetail' style='height: 100% !important;' ondblclick='COMMON.showResourceDetail(" + resource.key + ")'>\ <div class='resourceDataDetail'>" + label + "</div><div class='resourceDataDetail'>" + resource.resource + "</div><div class='resourceDataDetail'>" + resource.skillLevel + "</div><div class='resourceDataDetail'>" + resource.team + "</div></div>";

  1. Replace this area of the script with this text:  <div class='resourceDataDetail'>" + resource.resource + "</div><div class='resourceDataDetail'>" + resource.skillLevel + "</div></div>";
  2. Save changes to the file.
  3. Launch Schedule.
  4. CTRL-F5 to update the configuration files.

...