Group Scheme Settings - Information

The Info section of the group scheme settings holds the general set up of a group scheme: what goes on its work orders, the values new work orders start with, which location they go to, how notifications behave, and how the work orders are paid for.

Most of these settings are used when a work order is created. Changing one affects new work orders only, unless stated otherwise.

General

  • Name - the name of the group scheme, shown wherever the group scheme appears.
  • Colour - pick a colour from the palette and the group scheme's name is shown as a pill in that colour wherever it appears (work order list, overview, group scheme dropdowns, on the work order). Choose No colour to remove it; the name is then shown in a plain grey pill. Pages you already have open pick up the change the next time they are loaded. See Colours for the colours available.
  • Active - choose No to retire a group scheme. See below.
  • API Id - the identifier for this group scheme in the CWS API. It cannot be changed. Click the copy icon (or the value) to copy it for anyone integrating with the API for this group scheme.

Making a group scheme inactive

When Active is set to No:

  • new work orders can no longer be created for the group scheme
  • it is removed from the group scheme dropdowns and from the retailer portal
  • its work order imports and API exports stop running

Existing work orders are kept.

Reactivating. Making a group scheme inactive switches off its work order imports and API connections. They are not switched back on when the group scheme is made active again, and must be re-enabled one by one.

Work Order Settings

  • Work Order Type - chosen when creating a new group scheme. Normal is for service and repair work; Install makes it an install group scheme, whose work orders have no product and so skip the product-related settings described in these articles. The type cannot be changed once the group scheme has been created, so existing group schemes show it read-only.
  • Inventory or Parts - which sections are available on the group scheme's work orders:
    • Both Available - work orders have both a Parts section and an Inventory section.
    • Parts Only - work orders have no Inventory section.
    • Inventory Only - work orders have no Parts section.
  • Allow Create - whether work orders for the group scheme can be created by hand. Off, the group scheme is not offered under New Work Order, and its new work order form cannot be saved. Work orders still arrive through work order imports, the API, the retailer portal and product returns. On by default.
  • Model Input Mode - how the product is entered on the New Work Order form:
    • Quick Search - a single search box. Start typing the model and the product type and brand are filled in from the model chosen.
    • Select Fields - separate Product Type, Brand and Model dropdowns.
  • Model Add Allowed - choose No to remove the button for adding a new model, both while creating a work order and on an existing work order's product, so users can only choose from the existing models. With Yes, the button shows only to users whose group has the Product Models > Write permission (see Permissions).
  • Customer Mode - who the customer is on a new work order. The delivery details are entered separately in every mode:
    • Create New - a new customer is entered for each work order.
    • Select Existing - the customer is picked from the customers attached to the group scheme (Associations > Customers).
    • Single - every work order gets the Customer set under New Work Order Values; the form shows no customer field. Work orders arriving through the retailer portal, work order imports and the API that carry no customer details also get this customer; ones that do carry details still create their own customer.
  • KPI Step - the number of days in each band of the group scheme's closed work order age reports. With a step of 7 the bands are 0-7 days, 8-14, 15-21, 22-28 and over 28. The default is 7.
  • Inventory End Status - the status a work order moves to when it has been waiting in an inventory status and its inventory order is finished. If none is chosen the work order goes back to the status it was in before.

SLA

SLA Age is the number of days a work order spends between a chosen starting sub-status and a chosen end point. The fieldset appears once the group scheme has been saved.

  • SLA Age From - the sub-status that starts the SLA Age count. Off means the scheme has no SLA Age.
  • SLA Age To - the sub-status that ends the count. Any closed status means the count ends when the work order closes.
  • SLA Age Counts - Calendar days, or Business days (Monday to Friday). Dates are taken in the account's timezone. The day the work order enters the From sub-status is not counted, the end day is. Open work orders count up to today; closed ones stop at the closing day. The value is blank when the work order never entered the From sub-status.

The work order list offers "SLA Age (Days)" and "SLA Age From" columns, which also appear in list exports.

New Work Order Values

The values a new work order starts with.

  • Status - the status a new work order starts in. Default uses your account's default status. A status set against a model (Associations > Product Models) takes priority. See Work Order Status.
  • Fault Symptom and Fault Action - the fault symptom and action given to work orders created through the retailer portal, work order imports and product returns. They are not used by the New Work Order form.
  • Location - the location used when Location Mode (under Automatic Allocation) is Default Location, and when no other location qualifies. If left empty, your account's default location is used. The location is added to the group scheme's locations automatically.
  • Customer - the customer every new work order gets when Customer Mode (under Work Order Settings) is Single; it is greyed out in the other modes. Any customer on the account can be chosen; it is added to the group scheme's customers automatically.
  • Retailer / Branch - the retailer branch given to a new work order that is created without one. The branch's retailer must be attached to the group scheme.
  • Deliver To - whose address the Delivery Info on a new work order starts as: the Customer's or the retailer Branch's. It can be changed on each work order.
  • Instructions - instructions added to a new work order when none are entered. Instructions set against a model take priority.

Automatic Allocation

How the location that will carry out a new work order is chosen.

Location Mode

Mode How the location is chosen
Select (Any) The person creating the work order picks any of the group scheme's locations
Select (Closest) The closest locations are listed, nearest first, with the nearest already selected. The person creating the work order can pick another
Auto (Closest) The closest location is chosen automatically. No location is asked for
Default Location Every work order goes to the Location set under New Work Order Values

In the two Closest modes, a location qualifies when it is active, attached to the group scheme (Associations > Authorised Locations), services the product type on the work order, and is within its maximum distance, if it has one. Distance is measured by road. If no location qualifies, the Location under New Work Order Values is used.

Work orders created through the retailer portal and work order imports are always allocated to the closest qualifying location, unless the mode is Default Location.

Distance and rank

  • Max Auto KM - the furthest a location can be, in km, and still qualify. Leave at 0 for no limit: the closest location is chosen however far away it is. A different distance can be set for an individual location in the Max Distance (km) column under Associations > Authorised Locations; that overrides the group scheme's figure for that location, and 0 there means no limit too.

  • Rank Limit (KM) - lets a location's rank count as well as its distance. Each location has a rank of Normal, Silver or Gold, set on the location itself. When a better ranked location is further from the customer than a lower ranked one by less than this many km, the better ranked location is put first: Gold ahead of Silver and Normal, Silver ahead of Normal. Leave at 0 to go by distance alone.

    For example, with a limit of 30 km, a Gold location 20 km away is chosen ahead of a Normal location 5 km away. With a limit of 10 km the Normal location is chosen, as the Gold one is 15 km further.

Notifications

Email Notifications

  • Customer - Disabled stops notification emails to customers for this group scheme's work orders, including the welcome email. System Default leaves them on.
  • User - Disabled stops notification emails to users who are subscribed to events for this group scheme's work orders. System Default leaves them on. See Subscribing Users to Events.
  • Welcome Template - the notification template for the email sent when a work order is created. If none is chosen the standard new work order email is sent. See Notification Templates.
  • User Attachment - a print template to attach, as a PDF, to the notification emails sent to users. It is not attached to emails sent to customers.
  • Reply To - where a reply to a notification email goes: the work order's Location, the Group Scheme (the first email address of its main contact) or the Account. See Email Notification Addresses.

Customer and User do not affect the status change emails set up under Associations > Status Change Emails. Those are always sent.

SMS Notifications

  • Customer - System Default follows the customer setting under Administration > System > SMS. Disabled turns SMS notifications to customers off for this group scheme.
  • User - the same, for SMS notifications to users.
  • Welcome Template - the SMS template used for the message sent when a work order is created, to both the customer and any subscribed users. If none is chosen the account's template for that event is used, or the standard new work order message. See Notification Templates.

SMS can only be turned off here. If SMS notifications are off in the system settings they stay off for every group scheme. See SMS Setup.

Billing

How the group scheme's work orders are paid for.

Payment Mode

How the group scheme's work orders are paid for. The mode is recorded on each work order when it is created, so changing it does not change existing work orders.

Mode What happens
Central Billing Work orders are invoiced to the group scheme. Payments cannot be recorded on the work order. See Billing
Force Pre Pay The work order must be paid in full before it is created. The person creating it confirms payment has been received and enters the docket or receipt number
Customer Credit Card The customer's credit card details are collected when the work order is created and a card payment for the total is recorded
Location The location bills the customer and records payments on the work order itself. The work order is not invoiced to the group scheme
Central Billing + Pre Payments Payments can be recorded on the work order, and whatever is still owing is invoiced to the group scheme

Inventory and SMS

  • Inventory Paid By - who pays for inventory used on a work order:
    • Group Scheme - nothing is deducted from the location.
    • Location - the trade price of the inventory, plus tax, is deducted from the location's payment for the work order.
  • Inventory Zero Charge - choose Yes for inventory items added to a work order to be recorded at 0.00, so they are not charged for. With No the normal prices apply.
  • SMS Rate - the amount charged to the group scheme for each SMS sent on its work orders. The SMS sent each month are totalled and added to the group scheme's invoice as SMS Charges. Leave empty to make no charge.