Contents

Contract Rename

Purpose

This article will help you understand how to best configure the Contract and Contract Prefixing values within DRS.

Contract rename allows you to prefix certain aspects of the system depending on the contract used. This will allow you to differentiate between different orders, properties and SORs based on the contract they are associated to.

DRS > Configuration > Contract Rename

There is a requirement for ALL contracts used within DRS to be added to this section regardless of whether you use the prefixing or not or else the Order will fail to create. Please also ensure you have also added them to the Customer / Order Business Data.

Configuring Contract Rename

Clicking the Add or Selecting an existing Contract and clicking the Edit button will allow you to specify the contract and prefix of a contract.

In both cases, you will be presented with the following screen.

As part of your DRS configuration, you will need to maintain an entry for each CONTRACT value within the Business Data fields within this screen.


What is Contract Prefixing?

Prefixing is commonly used to allow a single set of data to be configured within DRS to create multiple different scheduling solutions.

A common usage of prefixing is to apply SOR Prefixing. SOR Prefixing will allow you to maintain a single list of SOR's in your Works Management or Housing system, but based on the Contract provided, allow DRS to apply a different scheduling solution, perhaps defining a different Skill, or have the work delivered by Worker resources with a specific Team Ability value.

Prefixing is an internal function to DRS. Any prefixing applied within DRS to provide a more granular scheduling solution will be removed for any outbound API notifications to integrating solutions.

Prefixing Options

For each individual contract, you will be able to specify some Prefixing options. Leaving any (or all) fields blank, will result in DRS ignoring this possible prefixing option.

The three areas you can apply prefixing options to are:

  • Orders
  • Properties
  • SORs

Prefixing is applied to these objects on the creation of the object, whether that be when the Order, Property or Job is provided through the API to DRS, or, when creating a new Object in DRS such as a Follow On or new Property.

Column Name

Description

Contract

This is the Contract value that has been added to either the Customer or Order Business Data.

Prefix

If Prefix Type is set to Simple = This will add this prefix value to all the orders, customers and SOR’s. 

If Prefix Type is set to Complex = Enter “None” as the prefix value and specify in the In/Out fields what prefixing you want (If any). This is the most common setting.

Order In

When the OrderCreate request comes in from the housing management system, if prefixed with this value it will remove the value.

Order Internal

This value will be applied to the Order to be visible in DRS.

Order Out

This will add a prefix outbound on the Booking Confirmation.

Customer In

When the OrderCreate request comes in from the housing management system, if prefixed with this value it will remove the value.

Customer Internal

This value will be prefixed to the customer ID when identifying the Customer ID/UPRN in DRS.

Customer Out

This will add a prefix outbound on the Booking Confirmation.

Customer Out PDA

This will add a prefix outbound on the getSchedule response to the mobile system

SOR In

This value will be stripped from the SOR when identifying it in the SOR templates.

SOR Internal

This value will be prefixed to the SOR when using it in DRS.  This value must exist then in the SOR Templates.

SOR Out

This will add a prefix outbound on the Booking Confirmation.

Agency

This is the Agency that it will match to, configured in DRS.

Prefix Type

Simple = This is if you want a global prefix to be applied as specified in the Prefix option.

Complex = This is if you want different prefixes to be applied (In/Out/Internal) as specified in the other values. This is the most common as is also used if you do not want any prefixing as the other boxes can be left blank.

Was this article useful?

Contract Business Data

Customize

Contact