The pages listed below describe the ServiceOptimizer public SOAP APIs that relate to the management of Job Restrictions.

Job Restrictions

Overview

Job restrictions allow jobs in ServiceScheduling to be marked as being restricted, which prevents users in ServiceGANTT without authorization from viewing or editing certain job fields.

Which job fields are restricted are defined globally. Job fields which can be be restricted are:

Technician skills;
Customer name;
Contact name;
Address 1;
Address 2;
Address 3;
Address 4;
Phone;
Phone 2;
Skills; and
Notes.

In addition to restricting these fields, it is also possible to restrict the display of restricted jobs in the Same Site Report.

When job restrictions are enabled, the sp073_restriction_types table can be used to define one of more restriction types, which can then be applied to jobs.

See the ServiceOptimizer Admin Guide section on Admin ServiceOptimizer System Configuration Business Functionality Configuring Restricted Jobs for details on how to enable and configure job restrictions, and configure restriction types.

Setting Job Restrictions

To set jobs as being restricted, the Book Appointment SOAP API, Book Dependency Group Jobs SOAP API, Book Non-Appointment Job SOAP API and Book Split Dependency Group Jobs SOAP API all support an optional restrictionRef parameter, which allows the restriction type to be set.

User Job Restrictions

When a job has a restriction type set, then the job is considered to be restricted, and the relevant, globally defined restrictions will be applied in ServiceGANTT, preventing all users from viewing or editing the restricted fields (and seeing the jobs in the Same Site Report, if enabled) - unless the user has been granted permission to see the details of restricted jobs with the matching restriction type.

The Update User Job Restriction SOAP API provides the mechanism to add one or more restriction types to users, thus granting them permission to see the details of jobs of the matching restriction type(s). The same API also allows the removal of restriction types from users, so that the permission to see the details of jobs with the matching restriction types can also be removed, when required.

Limitations

There are a number of limitations to the functionality of Restricted Jobs. See the ServiceOptimizer Admin Guide for details on Restricted Jobs Limitations.

Integration ServiceOptimizer Update User Job Derestriction SOAP API

Browser not supported