Route Service Contract Schedules

Form ID: (FS305600)

You can use this form to enter a new schedule for a particular route service contract, or to view and modify an existing schedule.

Note:

To open this form and add a new schedule, on the Route Service Contracts (FS300800) form, you click Add Schedule on the table toolbar. To open this form to modify a schedule, you click the schedule number in the Schedule ID on the Schedules tab of the Route Service Contracts (FS300800) form.

Form Toolbar

The form toolbar includes standard and form-specific buttons and commands. For the list of standard buttons, see Form Toolbar and More Menu. The form-specific commands are listed in the following table.


Button	Description
Generate Route Appointments	Opens the Generate Route Appointments (FS500200) form, where you can generate the routes with appointments according to this schedule. This button becomes available when you save the schedule.

Summary Area

In this area, you can define a new schedule and its settings, or select an existing schedule and view its settings.


Element	Description
Service Contract ID	The identifier of the route service contract to which the schedule is related.
Schedule ID	The identifier of the contract schedule. The system generates this ID by using the numbering sequence specified in the Service Contract Schedule Numbering Sequence on the Route Management Preferences (FS100400) form.
Active	A check box that indicates (if selected) that the schedule is active in the system, and appointments can be generated.
Customer	The unique identifier of the customer that has ordered the services of this schedule. The system fills this in based on customer specified for the related contract on the Route Service Contracts (FS300800) form.
Location	The unique identifier of the customer location for which you want to create the schedule. The system fills this box in based on customer location specified for the related contract on the Route Service Contracts (FS300800) form.
Customer Contract Nbr.	Read-only. The numeric identifier of the service contract for this customer.
Project	The project to which this service contract schedule is related. Read-only. The system fills in this box with the value specified in the Project box of the Route Service Contracts (FS300800) form for the related service contract. This box appears on the form only if the Projects feature is enabled on the Enable/Disable Features (CS100000) form.
Default Project Task	The project task to be used by default for items associated with the contract schedule. By default, the system fills in this box with the value specified in the Default Project Task box of the Route Service Contracts (FS300800) form for the related service contract, but you can override this value. This box appears on the form only if the identifier of a project is selected in the Project box.
Service Order Type	The type of service orders with the Route behavior involved in the contract.
Start Date	The date from which the schedule is generated according to the service contract. The system fills this in based on start date specified for the related contract on the Route Service Contracts (FS300800) form.
Expiration Date	Read-only. The end date of the range when the schedule is generated. This value is specified if the Enable Expiration Date check box is selected and the date is specified in the Expiration Date box on the Route Service Contracts (FS300800) form.
Next Execution Date	Read-only. The date when the appointments for the schedule should be executed next.
Last Generated	Read-only. The date for which the last route execution was generated.

Table 1. Additional Settings SectionIn this section, you specify the vendor that performs services and the week codes for the schedule, if these settings are applicable for the schedule.
Element	Description
Week Codes e.g.: 1, 2B, 1ACS	The week code for the route. The following setting will be used only to validate the recurrence of the route versus the week code.
Vendor	The vendor that handles services. The list of vendors available for selection may be limited based on the role or roles assigned to the user account to which you are signed in if the Customer and Vendor Visibility Restriction feature is enabled on the Enable/Disable Features (CS100000) form. In this case, the Restrict Visibility To box appears on the Financial tab of the Vendors (AP303000) form. With the feature enabled, a vendor is available for selection if one of the following is true: The Restrict Visibility To box is empty for the vendor—that is, the vendor’s visibility is not restricted. A branch, company, or a company group is specified in the Restrict Visibility To box for the vendor, and your user account has the role specified in the Access Role box of the Configuration Settings section of one of the following: the Branch Details tab of the Branches (CS102000) form for the selected branch, or the Company Details tab of the Companies (CS101500) form for the selected company or a company within the company group.

Details Tab

On this tab, you can enter any services, non-stock items, and stock items involved in the route service contract schedule. When you add a row and select the line type and inventory ID, the system fills in the Transaction Description column with the description of the item.

Note:

For it to be possible for you to specify the stock items involved in the schedule, the appropriate posting settings must be specified for the service order type associated with the schedule. That is, on the Preferences tab (Billing Settings section) of the Service Order Types (FS202300) form, in the Generated Billing Documents box, the Sales Orders, SO Invoices, or None option should be selected.

On this tab, you can move an item by dragging its line to the required place.

The table toolbar includes only standard buttons. For the list of standard buttons, see Table Toolbar.


Column	Description
Line Type	The type of the line involved in the service contract. Depending on the type you select, other columns on this tab may or may not be available. The line type is one of the following options: Service (default): The line is a service—that is, a non-stock item with the Service type defined on the Non-Stock Items (IN202000) form. Non-Stock Item: The line is a non-stock item with a type of Non-Stock Item, Labor, Charge, or Expense defined on the Non-Stock Items (IN202000) form. Inventory Item: The line is a stock item of any type defined on the Stock Items (IN202500) form. Comment: The line is a comment. You can use this type to indicate to the staff member a remark about the service. You type the comment in the Description column. Instruction: The line is an instruction. You can use this type to indicate to the staff member an instruction about the service. You type the instruction in the Description column. Service Template: The line is a service template. You can use this type to assign to the service order a set of services associated with the template. You can create a service template on the Service Templates (FS204900) form.
Inventory ID	The identifier of the item if the line type is Service, Non-Stock Item, or Inventory Item.
Billing Rule	The billing rule applied to the line, which is filled in by the system when you select an item. The billing rule is one of the following: Time: The item of the Service type is billed based on time, with the specific time used depending on the option button selected under Run Billing For on the Billing Cycles (FS206000) form for the billing cycle assigned to the customer: Appointments (that is, the billing cycle is defined to generate billing documents from appointments): The time that was spent delivering the service. Service Orders (that is, the billing cycle is defined to generate billing documents from service orders): The time that was estimated to be spent on delivering the service. In both of these cases, the price of the service is defined for each unit of time. Flat Rate: The item is billed at a fixed price, regardless of the time that was spent delivering the item. For an item of the Non-Stock or Inventory Item type, this option is selected by default and cannot be changed. None: The item of the Service type is free of charge. (That is, no price is specified for the service.) This column is available for editing if Service or Service Template is selected in the Line Type column.
Service Template ID	The identifier of the service template.
Estimated Duration	The total estimated time that the item is expected to last.
Estimated Quantity	The quantity of the item in this line. This column is available for editing if Service, Non-Stock Item, or Inventory Item is selected in the Line Type column.
UOM	The unit of measure used for the item selected in the Inventory ID column. When you select an item in the Inventory ID column on the current tab, the system populates this column with the UOM specified in the Sales Unit box of the General tab of the Non-Stock Items (IN202000) or Stock Items (IN202500) form. If you specify a service template in the Service Template ID column of this row, this column remains empty.
Transaction Description	A description of the line. If the line type is Service, Non-Stock Item, Inventory Item, or Service Template, the system automatically fills in this column with the description of the selected service, non-stock item, or service template, respectively. If Comment or Instruction is selected in the Line Type column, you enter the comment or instruction in this column.
Project Task	The project task to which this line item is related. By default, the system fills in this column with the value specified in the Default Project Task box in the Summary area of the form. You can override this value if necessary. This column appears on the form only if the Projects feature is enabled on the Enable/Disable Features (CS100000) form. This column is available only if the identifier of a project is selected in the Project box in the Summary area of the form.
Cost Code	The cost code with which this item is associated. This column appears on the form only if the Cost Codes feature is enabled on the Enable/Disable Features form. This column is available only if the identifier of a project is selected in the Project box in the Summary area of the form.
Equipment ID	The identifier of the target equipment for which the item is provided. Note: This column is hidden by default. You can display this column in the table by using the Column Configuration dialog box. For details, see Table Layout: Process Activity.
Line Nbr.	The line number of the item. Note: This column is hidden by default. You can display this column in the table by using the Column Configuration dialog box. For details, see Table Layout: Process Activity.

Recurrence Tab

On this tab, you can define the recurrence settings of the schedule.

Table 2. Frequency Settings Section
Element	Description
Frequency Settings	The frequency at which the schedule should occur. Select one of the following option buttons: Daily: The schedule type recurs daily or every x days. Weekly: The schedule type recurs weekly or every x weeks. Monthly: The schedule type recurs monthly or every x months. Yearly: The schedule type recurs yearly or every x years. Select the frequency type, and enter the settings specific to the type in the corresponding section on this tab (described below).

Table 3. Season Settings SectionThis section is available only if the Enable Seasons in Schedule Contracts check box is selected on the Route Management Preferences (FS100400) form.
Element	Description
	For the Daily, Weekly, and Monthly frequency types, you use the check boxes to select the month or months when the schedule recurs: January, February, March, April, May, June, July, August, September, October, November, and December.

Table 4. Daily SectionThis section is available if the frequency setting is set to Daily. In this section, you define the recurrence settings of a daily schedule.
Element	Description
Every x Days	An integer that specifies the time interval in days when the schedule recurs. For example, 1 means every day and 2 means every other day, starting on the Start Date.

Table 5. Weekly SectionThis section is available if the frequency setting is set to Weekly. In this section, you define the recurrence settings of a weekly schedule.
Element	Description
Every x Weeks	An integer that specifies the time interval in weeks when the schedule recurs. For this frequency type, enter an integer and use the following check boxes to select the day of the week when the schedule recurs: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday.

Table 6. Monthly SectionThis section is available if the frequency setting is set to Monthly. In this section, you define the first recurrence settings of the monthly schedule.
Element	Description
Every x Months	An integer that specifies the time interval in months when the schedule recurs. For this frequency type, you should enter an integer and select one of the option buttons below this box.
Schedule On	The day when the schedule recurs. Select one of the following option buttons: Fixed Day of Month: Indicates (if selected) that the schedule recurs monthly on the day of the month specified in the related box. Fixed Day of Week: Indicates (if selected) that the schedule recurs monthly on the particular weekday of the month specified in the related box.

Table 7. Second Recurrence Monthly Settings SectionThis section is available if the frequency setting is set to Monthly. In this section, you define the second recurrence settings of the monthly schedule.
Element	Description
Monthly 2 Selected	A check box that indicates (if selected) that the second settings are applied to the monthly schedule.
Schedule On	The day when the schedule recurs. Select one of the following option buttons: Fixed Day of Month: Indicates (if selected) that the schedule recurs monthly on the day of the month specified in the related box. Fixed Day of Week: Indicates (if selected) that the schedule recurs monthly on the particular day of the week (in the month) specified in the related box.

Table 8. Third Recurrence Monthly Settings SectionThis section is available if the frequency setting is set to Monthly. In this section, you define the third recurrence settings of the monthly schedule.
Element	Description
Monthly 3 Selected	A check box that indicates (if selected) that the third settings are applied to the monthly schedule.
Schedule On	The day when the schedule recurs. Select one of the following option buttons: Fixed Day of Month: Indicates (if selected) that the schedule recurs monthly on the day of the month specified in the related box. Fixed Day of Week: Indicates (if selected) that the schedule recurs monthly on the particular day of the week (in the month) specified in the related box.

Table 9. Fourth Recurrence Monthly Settings SectionThis section is available if the frequency setting is set to Monthly. In this section, you define the fourth recurrence settings of the monthly schedule.
Element	Description
Monthly 4 Selected	A check box that indicates (if selected) that the fourth settings are applied to the monthly schedule.
Schedule On	The day when the schedule recurs. Select one of the following option buttons: Fixed Day of Month: Indicates (if selected) that the schedule recurs monthly on the day of the month specified in the related box. Fixed Day of Week: Indicates (if selected) that the schedule recurs monthly on the particular day of the week (in the month) specified in the related box.

Table 10. Yearly Section This section is available if the frequency setting is set to Annual. In this section, you define the recurrence settings of a yearly schedule.
Element	Description
Every x Years	An integer that specifies the time interval in years when the schedule recurs. For this frequency type, you enter an integer and use the check boxes to select the month or months when the schedule recurs: January, February, March, April, May, June, July, August, September, October, November, and December.
Schedule On	The day when the schedule recurs. Select one of the following option buttons: Fixed Day of Month: Indicates (if selected) that the schedule recurs monthly on the day of the month specified in the related box. Fixed Day of Week: Indicates (if selected) that the schedule recurs monthly on the particular day of the week (in the month) specified in the related box.

Attributes Tab

On this tab, you can view the list of attributes for the route service contract schedule, specify the values of the attributes, and change these values, if necessary. When you select the service order type on the current form, this tab is populated with the list of attributes (and any default values) that have been defined for the selected service order type on the Attributes tab of the Service Order Types (FS202300) form.

The listed attributes and their values will be copied to the Attributes tab of the Appointments (FS300200) form for the appointments generated according to the schedule.

The table toolbar includes only standard buttons. For the list of standard buttons, see Table Toolbar.


Column	Description
Attribute	The description of the attribute.
Required	A read-only check box that indicates (if selected) that a value must be specified for the attribute. This setting is copied from the Attributes tab of the Service Order Types form for the selected service order type.
Value	The value of the attribute. If the system has inserted a default value for the attribute, you can overwrite it, if necessary. The default value is defined on the Attributes tab of the Service Order Types form for the selected service order type.

Route Tab

On this tab, you can select a route and define the order of the route appointment within the route sequence.

Table 11. Route Settings Section
Element	Description
Route ID	The identifier of the route.
Order	The number that identifies the order of the route appointment in the route sequence.

Week Codes Tab

The Days by Week Codes tab indicates the upcoming days the schedule will be performed, based on the configured week code and execution days. For the routes to be displayed, make sure that the calendar week code is generated in the selected period of time on the Calendar Week Codes (FS205900) form.

Note:

The week codes are currently used for validation purposes. The recurrence of the route will be taken from the Recurrence tab.

You use the selection area to filter the days that are displayed in the table.

Table 12. Selection Area You use the selection area to filter the displayed days in the table.
Element	Description
From	The start date for which the data is displayed.
To	The end date for which the data is displayed.

Table 13. Table
The table toolbar includes only standard buttons. For the list of standard buttons, see Table Toolbar.
Column	Description
Date	The date when the route is performed.
Week Code	The week code corresponding to the date.
Day of Week	The day of week when the route is performed.
Week of Year	The week of the year when the route is performed.
Start Date of Week	The Monday date of the week when the route is performed.

Forecast Tab

On this tab, you can view the dates when the routes and appointments will be generated according to the schedule if you invoke the generation process on the Generate Route Appointments (FS500200) form.

Table 14. Selection Area You use the selection area to filter the displayed days in the table.
Element	Description
From	The start date for which the data is displayed.
To	The end date for which the data is displayed.

Table 15. Table
The table toolbar includes only standard buttons. For the list of standard buttons, see Table Toolbar.
Column	Description
Date	The date when the route is performed.
Day of Week	The day of week when the route is performed.
Week of Year	The week of the year when the route is performed.
Start Date of Week	The Monday date of the week when the route is performed.

Delivery Notes Tab

This tab contains an area where you can add delivery notes for the staff member performing the route appointment.

The area consists of the following:

The formatting toolbar, with buttons to let you edit text, change its typographical treatment, and format it. Buttons also let you add files and insert images.
The Message text box, where you can enter a detailed description or comment on the document. You can type the description here and edit it using the buttons on the formatting toolbar.

Internal Notes Tab

This tab contains an area where you can add notes for the internal use.

The area consists of the following:

The formatting toolbar, with buttons to let you edit text, change its typographical treatment, and format it. Buttons also let you add files and insert images.
The Message text box, where you can enter a detailed description or comment on the document. You can type the description here and edit it using the buttons on the formatting toolbar.