Skip to main content

Contract Administration - Setup

Configuration

The Configuration screen contains two tabs: Settings and Lookup Tables.

Settings

The Settings tab contains a single setting which allows you to specify which business types will be used in the Contract Administration module. This is only relevant if your organisation includes multiple companies, some of which are construction and some of which are home building, and you wish to exclude one category from Contract Administration. Use the drop-down list to select either or both business types, then click to save your changes.

A screenshot of a computer

Description automatically generated

Lookup Tables

The Lookup Tables tab contains a grid listing each of the fields which can be configured in Issue Setup. For each field, there are two settings you can toggle within the grid.

In the Status column, click to set each field to either Company or Global. If a field is set to Company, you will be able to configure company-specific settings for that field in Issue Setup, for each company within your organisation. If a field is set to Global, then you will only be able to configure one set of settings for that field in Issue Setup, which will be applied to every company and contract within your organisation.

In the Allow Templates Level Override column, tick or untick the box to allow or disallow contract templates to override the settings configured in Issue Setup for each field. If you tick the box for a field, the template level settings for that field from a contract template will override the global settings from Issue Setup for issues linked to contracts using that template. If you untick the box for a field, that field will not be available for configuration at the template or contract level; the global settings from Issue Setup will be applied to all contracts.

A black and white line

Description automatically generated


Issue Setup

Cost Impact

Creating a Cost Impact

Open the Cost Impact tab and click the + Add Cost Impact button. This opens the New Cost Impact window.

A screenshot of a computer

Description automatically generated

Complete the fields as follows:

Company

Select the company which will use this cost impact in issue creation. If Cost Impact is set to Global in configuration, this field will be hidden.

Code

Enter a code for the cost impact. This is for internal use only.

Description

Enter a description of the cost impact. This is the text that will appear in the lookup list.

Order

Enter a number to dictate where this cost impact will appear in the lookup list. Order number 1 means it will be at the top of the list, order number 2 means it will be the second option down and so on.

Access to Cost

If you tick this box, a field will appear for the user to enter the cost of resolving the issue when they select this cost impact.

Active

Tick this box to make this an active cost impact. If you do not tick this box, users will not be able to select this cost impact when managing issues.

All Templates

Select whether you want this cost impact to initially be marked as In Use or Not in Use when it is pushed to the relevant contract templates. If it is marked as Not in Use by a contract template, and the contract template level override is activated for cost impact, users will not be able to select this cost impact when managing issues linked to contracts using that template. Note that if the cost impact is not active, it is locked to Not in Use.

All Contracts

Select whether you want this cost impact to initially be marked as In Use or Not in Use when it is pushed to the relevant contracts. If it is marked as Not in Use for a contract, and the contract level override is activated for cost impact, users will not be able to select this cost impact when managing issues linked to that contract. Note that if the cost impact is not active, it is locked to Not in Use.

Click to save the cost impact.

Editing a Cost Impact

Inline editing is enabled within the grid for every field except Company.

Deleting a Cost Impact

To delete a cost impact, click the trash can icon in the Actions column. You will receive a confirmation popup asking if you are sure.

A white background with black text

Description automatically generated
  1. Click to confirm.

Schedule Impact

Creating a Schedule Impact

Open the Schedule Impact tab and click the + Add Schedule Impact button. This opens the New Schedule Impact window.

A screenshot of a schedule impact

Description automatically generated

Complete the fields as follows:

Company

Select the company which will use this schedule impact in issue creation. If Schedule Impact is set to Global in configuration, this field will be hidden.

Code

Enter a code for the schedule impact. This is for internal use only.

Description

Enter a description of the schedule impact. This is the text that will appear in the lookup list.

Order

Enter a number to dictate where this schedule impact will appear in the lookup list. Order number 1 means it will be at the top of the list, order number 2 means it will be the second option down and so on.

Access to Days

If you tick this box, a field will appear for the user to enter the number of days the schedule will be held back by when they select this schedule impact.

Active

Tick this box to make this an active schedule impact. If you do not tick this box, users will not be able to select this schedule impact when managing issues.

All Templates

Select whether you want this schedule impact to initially be marked as In Use or Not in Use when it is pushed to the relevant contract templates. If it is marked as Not in Use by a contract template, and the contract template override is activated for schedule impact, users will not be able to select this schedule impact when managing issues linked to contracts using that template. Note that if the schedule impact is not active, it is locked to Not in Use.

All Contracts

Select whether you want this schedule impact to initially be marked as In Use or Not in Use when it is pushed to the relevant contracts. If it is marked as Not in Use for a contract, and the contract level override is activated for schedule impact, users will not be able to select this schedule impact when managing issues linked to that contract. Note that if the schedule impact is not active, it is locked to Not in Use.

  1. Click to save the cost impact.

Editing a Schedule Impact

Inline editing is enabled within the grid for every field except Company.

Deleting a Schedule Impact

To delete a schedule impact, click the trash can icon in the Actions column. You will receive a confirmation popup asking if you are sure.

A white background with black text

Description automatically generated

Click to confirm.

Cause

Creating a Cause

Open the Cause tab and click the + Add Cause button. This opens the New Cause window.

A screenshot of a computer

Description automatically generated

Complete the fields as follows:

Company

Select the company which will use this cause in issue creation. If Cause is set to Global in configuration, this field will be hidden.

Code

Enter a code for the cause. This is for internal use only.

Description

Enter a description of the cause. This is the text that will appear in the lookup list.

Order

Enter a number to dictate where this cause will appear in the lookup list. Order number 1 means it will be at the top of the list, order number 2 means it will be the second option down and so on.

Active

Tick this box to make this an active cause. If you do not tick this box, users will not be able to select this cause when managing issues.

All Templates

Select whether you want this cause to initially be marked as In Use or Not in Use when it is pushed to the relevant contract templates. If it is marked as Not in Use by a contract template, and the contract template override is activated for cause, users will not be able to select this cause when managing issues linked to contracts using that template. Note that if the cause is not active, it is locked to Not in Use.

All Contracts

Select whether you want this cause to initially be marked as In Use or Not in Use when it is pushed to the relevant contracts. If it is marked as Not in Use for a contract, and the contract level override is activated for cause, users will not be able to select this cause when managing issues linked to that contract. Note that if the cause is not active, it is locked to Not in Use.

  1. Click to save the cause.

Editing a Cause

Inline editing is enabled within the grid for every field except Company.

Deleting a Cause

To delete a cause, click the trash can icon in the Actions column. You will receive a confirmation popup asking if you are sure.

A white background with black text

Description automatically generated

Click to confirm.

Priority

Creating a Priority

Open the Priority tab and click the + Add Priority button. This opens the New Priority window.

A screenshot of a computer

Description automatically generated

Complete the fields as follows:

Company

Select the company which will use this priority in issue creation. If Priority is set to Global in configuration, this field will be hidden.

Code

Enter a code for the priority. This is for internal use only.

Description

Enter a description of the priority. This is the text that will appear in the lookup list.

Colour Code

Select a colour code for the priority. Issues of this priority will be marked by a line of this colour on the issues list on mobile, to allow mobile users to quickly discern between high and low priority issues.

Order

Enter a number to dictate where this priority will appear in the lookup list. Order number 1 means it will be at the top of the list, order number 2 means it will be the second option down and so on.

Active

Tick this box to make this an active priority. If you do not tick this box, users will not be able to select this priority when managing issues.

All Templates

Select whether you want this priority to initially be marked as In Use or Not in Use when it is pushed to the relevant contract templates. If it is marked as Not in Use by a contract template, and the contract template override is activated for priority, users will not be able to select this priority when managing issues linked to contracts using that template. Note that if the priority is not active, it is locked to Not in Use.

All Contracts

Select whether you want this priority to initially be marked as In Use or Not in Use when it is pushed to the relevant contracts. If it is marked as Not in Use for a contract, and the contract level override is activated for priority, users will not be able to select this priority when managing issues linked to that contract. Note that if the priority is not active, it is locked to Not in Use.

  1. Click to save the priority.

Editing a Priority

Inline editing is enabled within the grid for every field except Company.

Deleting a Priority

To delete a priority, click the trash can icon in the Actions column. You will receive a confirmation popup asking if you are sure.

A screenshot of a white background

Description automatically generated
  1. Click to confirm.

Type

Creating a Type

Open the Type tab and click the + Add Type button. This opens the New Type window.

A screenshot of a computer

Description automatically generated

Complete the fields as follows:

Company

Select the company which will use this type in issue creation. If Type is set to Global in configuration, this field will be hidden.

Code

Enter a code for the type. This is for internal use only.

Description

Enter a description of the type. This is the text that will appear in the lookup list.

Issue Category

Select which issue category this type falls under. This is a pre-set list consisting of Snag List, Non-Conformities, Dayworks and Construction.

Order

Enter a number to dictate where this type will appear in the lookup list. Order number 1 means it will be at the top of the list, order number 2 means it will be the second option down and so on.

Active

Tick this box to make this an active type. If you do not tick this box, users will not be able to select this type when managing issues.

All Templates

Select whether you want this type to initially be marked as In Use or Not in Use when it is pushed to the relevant contract templates. If it is marked as Not in Use by a contract template, and the contract template override is activated for type, users will not be able to select this type when managing issues linked to contracts using that template. Note that if the type is not active, it is locked to Not in Use.

All Contracts

Select whether you want this type to initially be marked as In Use or Not in Use when it is pushed to the relevant contracts. If it is marked as Not in Use for a contract, and the contract level override is activated for type, users will not be able to select this type when managing issues linked to that contract. Note that if the type is not active, it is locked to Not in Use.

Mandatory

The Mandatory section of the window contains a list of fields which are available when creating or editing an issue. Tick the box next to a field label to make it a mandatory field for issues of this type. Mandatory fields must be completed when creating or editing an issue, otherwise the user will be unable to save.

  1. Click to save the type.

Editing a Type

Inline editing is enabled within the grid for every field except Company. To edit mandatory field status for a type, click the Details link in the Details column to open the Mandatory window.

Deleting a Type

To delete a type, click the trash can icon in the Actions column. You will receive a confirmation popup asking if you are sure.

A white background with black text

Description automatically generated
  1. Click to confirm.

Issue Templates

Creating an Issue Template

Open the Issue Templates tab and click the + Issue Template button. This opens the Create Issue Template window.

Complete the Template Info fields as follows:

Template Name

Enter a name for the template. This is how the template will be labelled in the Template drop-down list when a user is creating an issue.

Description

Enter a description of the template.

Business Type

Select which business type this template is relevant to.

Complete the General Info and Impacts fields. For a description of each field, see the Creating an Issue section in Issue Workbench.

Click to save the template.

Editing an Issue Template

Right-click the template you wish to edit, or left-click the template and click the menu icon , then click Edit. This opens the Edit Issue Template window for that template.

Edit the fields as necessary.

Click to save your changes.

Deleting an Issue Template

To delete an issue template, click the trash can icon in the Actions column. You will receive a confirmation popup asking if you are sure.

Click to confirm.


Contract Templates

There are three levels of issue setup: the global level (configured in Issue Setup), the template level (configured here in Contract Templates) and the contract level (configured in App Settings in the Contract Home module).

On the Contract Templates screen, you can create templates for issue setup at the contract level for a specific company. Once a contract template has been created for a company and marked as In Use, every contract linked to that company will be able to use that template. A contract must be assigned a contract template before users can create issues linked to that contract.

The options available to configure at the template level are dependent on which features are approved for template level override in Configuration.

Creating a Contract Template

Click the + Add Template button. This opens the New Contract Template window.

A screenshot of a computer

Description automatically generated

Complete the fields as follows:

Company

Select the company which will use this template.

Template Name

Enter a name for the template.

Business Type

Select the business type of the selected company. The options available are dependent on which business types are enabled in Configuration.

In Use

Tick this box to mark this template as In Use. If you do not tick this box, the template will not be available for selection when assigning a template to contracts from the selected company.

Click to save the template.

To configure the issue setup for the template, find the template in the Contract Templates grid, then click the Details link in the Details column.

A screenshot of a computer

Description automatically generated

The Configuration tab contains a list of fields which can be configured at the template level– fields which are not approved for template level override in Configuration are hidden from this screen.

In the Allow Contracts Level Override column, tick or untick the box to allow or disallow individual contracts using this template to override the settings configured in this template for each field. If you tick the box for a field, the contract level settings for that field from App Settings will override the template level settings from this template, for issues linked to that contract. If you untick the box for a field, that field will not be available for configuration at the contract level; the settings from this template will be applied to all contracts using the template.

The Issue Setup tab contains sub-tabs for each of the fields which can be configured at the template level – fields which are not approved for template level override in Configuration are hidden from this screen.

A screenshot of a computer

Description automatically generated

For details on creating, editing and deleting entries for each of the configurable fields, see Issue Setup. There is one additional option available at the template level: In Use. In order for an entry to be available to select when creating an issue linked to a contract using this template, it must be marked as both Active and In Use. You can untick the In Use box to hide an entry from contracts using this template.

Editing a Contract Template

Inline editing is enabled for the Template Name, Business Type and In Use fields in the Contract Templates grid.

To edit the configuration and issue setup for a template, click the Details link in the Details column. Note that all fields are locked for editing in issue setup, other than the In Use field.

Deleting a Contract Template

Contract templates can only be deleted if they are not being used by any contracts. Attempting to delete a template which is in use will return an error message listing the contracts currently using it.

To delete a contract template, click the trash can icon in the Actions column. You will receive a confirmation popup asking if you are sure.

A white background with black text

Description automatically generated

Click to confirm.

Did this answer your question?