On This Page:

Related Pages:

Update User Job Derestriction SOAP API

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.

Global Configuration

In ServiceScheduling, the global restricted jobs configuration options are configured via the following parameters in the sp083_system_parameters table.

Changes to the restricted jobs configuration options in the sp083_system_parameters table must be made through direct SQL commands on the ServiceScheduling database.

Column Name	Description	Notes	Mandatory/Optional	Valid Values	Initial Value
`rj_enabled`	When "YES", restricted jobs functionality is enabled in ServiceScheduling.		Mandatory	YES/NO	NO
`gantt_rj_mask_techSkills`	When "YES", the technician skills will be hidden in ServiceGANTT if the ServiceGANTT user has any restricted jobs in the Gantt horizon.	These fields all require the `rj_enabled` field to be "YES" to have any effect - otherwise, if restricted jobs functionality is not globally enabled, then these field settings have no effect.	Mandatory	YES/NO	NO
`gantt_ssr_restrictedJobs`	When "YES", then restricted jobs will be shown in the Same Site Report.		Mandatory	YES/NO	YES
`rj_show_CustomerName`	When "NO", the Customer Name field will not be shown for a job that is considered a restricted job for a ServiceGANTT user.		Mandatory	YES/NO	NO
`rj_show_ContactName`	When "NO", the Contact Name field will not be shown for a job that is considered a restricted job for a ServiceGANTT user.		Mandatory	YES/NO	NO
`rj_show_Address1`	When "NO", the Address 1 field will not be shown for a job that is considered a restricted job for a ServiceGANTT user.		Mandatory	YES/NO	NO
`rj_show_Address2`	When "NO", the Address 2 field will not be shown for a job that is considered a restricted job for a ServiceGANTT user.		Mandatory	YES/NO	NO
`rj_show_Address3`	When "NO", the Address 3 field will not be shown for a job that is considered a restricted job for a ServiceGANTT user.		Mandatory	YES/NO	NO
`rj_show_Address4`	When "NO", the Address 4 field will not be shown for a job that is considered a restricted job for a ServiceGANTT user.		Mandatory	YES/NO	NO
`rj_show_Phone`	When "NO", the Phone field will not be shown for a job that is considered a restricted job for a ServiceGANTT user.		Mandatory	YES/NO	NO
`rj_show_Phone2`	When "NO", the Phone 2 field will not be shown for a job that is considered a restricted job for a ServiceGANTT user.		Mandatory	YES/NO	NO
`rj_show_Skills`	When "NO", the Skills field will not be shown for a job that is considered a restricted job for a ServiceGANTT user.		Mandatory	YES/NO	NO
`rj_show_Notes`	When "NO", the Notes field will not be shown for a job that is considered a restricted job for a ServiceGANTT user.		Mandatory	YES/NO	NO

Restriction Types

ServiceManager's global Job Restriction Types menu option provides a user interface to manage the set of defined restriction types. (The option to do so is only accessible when restricted jobs functionality is enabled via sp083_system_parameters.rj_enabled).

Job Restrictions

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 specifies a restriction type to be set for the job.

Provided that restricted jobs functionality is enabled via sp083_system_parameters.rj_enabled, then the restrictions as defined via the various sp083_system_parameters above will be applied for the job, unless the user viewing/editing the job has been granted permission to view/edit restricted jobs of that job's restriction type.

User Derestrictions

Users can be granted permission to view/edit restricted jobs of one or more restriction types. Users derestriction type permissions can be managed via:

The Update User Job Derestriction SOAP API; and/or
ServiceManager's Update ServiceOptimizer User page from the Users menu. (The option to do so is only accessible when restricted jobs functionality is enabled via sp083_system_parameters.rj_enabled).

Limitations

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

Browser not supported