Diary Planner Settings

Diary Planner has three levels of configuration: global, application and appointment.

While there are certain settings which must be set at the appointment level, anything not set there will fall back to the application level. Anything not set at the application level will fall back to the global settings.

Appointment Configuration

function(params, credentials) {
    //This is the id of the slot type article in this environment for this type of appointment
    let appointmentTypeArticleId = 2098;
    //Add any additional values that you want made available to CTM templates
    let additionalCTMValues = {};
    //Add any additional settings that you want made available to the appointment forms
    let additionalSettings = {};
    let taskAssignment = {};
    let response = {
        slotTypeId: appointmentTypeArticleId,
        additionalCTMValues: additionalCTMValues,
        additionalSettings: additionalSettings,
        taskAssignment: taskAssignment,
        showOnDashboard: true
    };
    return response;
}

Global and Application Configuration

While these settings can be overridden at the appointment level, it doesn't generally make sense to.

Link Settings

The following settings must be correct for your platform, they are used by the booking forms to look up available appointments. They are also used to generate links that can be used in messages and emails. 

let linkSettings = {
    admin: {
        subsite: "staff"
    },
    csu: {
        subsite: "staff"
    },
    citizen: {
        language: {
            EN: {
                subsite: "citizen"
            }
        }
    }
};

User Task Settings

These setting control the forms and user groups used to manage and process the appointment.

The default settings can be overridden on a per user role basis by defining a role object and adding the names of the forms you'd lie to override.

let taskAssignment = {
    default: {
        managementForm: "SBDEFAULTMANAGEAPPOINTMENT",
        processingForm: "SBDEFAULTPROCESSAPPOINTMENT",
        confirmationForm: "SBDEFAULTCONFIRMATIONFORM"
    },
    csu: {
        assignmentGroup: "CSA_GENERAL"
    },
    admin: {
        managementForm: "SBCUSTOMFORM",
        assignmentGroup: "SLOTBOOKINGADMIN"
    }
};

User Roles

These settings control the user roles available in the rest of the settings and the user groups that are associated with a role. When creating a new application, we  recommend that you create a specific user group for administrators and update the admin user role to use that group.

Role Settings

The following settings are used to define a user role.

Example

let userRoles = {
    "anonymousUserRole": "anonymous",
    "anonymousUserId": 1,
    "roles": [{
        "code": "admin",
        "siteUserGroups": ["SLOTBOOKINGADMIN"],
        "name": "Admin",
        "isAdmin": true,
        "isCSU": true,
        "canSelectAppointments": true
    }, {
        "code": "csu",
        "siteUserGroups": ["CSA_GENERAL"],
        "name": "CSU",
        "isAdmin": false,
        "isCSU": true,
        "canSelectAppointments": false
    }, {
        "code": "citizen",
        "siteUserGroups": ["CITIZENS"],
        "name": "Citizen",
        "isAdmin": false,
        "isCSU": false,
        "canSelectAppointments": false
    }]
};

Action Settings

The following settings control when, where and by whom actions can be performed. They are held in the variable actionSettings. The following top-level settings are used:

Status Codes

The following are the default status codes for an appointment. They correspond to the steps in the appointment processing model. These can be extended if required for a new application:

Action Availability Settings

These settings control when and by whom actions can be performed, the settings are stored against each status.

For each of the above the following settings are available

Action Processing Settings

These settings control what happens when an action is performed, the behaviour for Cancel, Amend and Reschedule cannot be controlled via configuration. Those actions are performed by the Slot Booking process and cannot be altered.

Available settings for an action

Additional Comms Template Manager Settings

This object lets you pass additional variables to the comms template manager to use in your email and message templates.

let additionalCTMValues = {
    diaryPlanner: "DiaryPlanner"
};