Using associated documents

 

Introduction

This page provides an overview of associated documents and how to use them in CARS.

Please note that associated documents are currently only available for MCHW documents.

Back to top

What are associated documents?

An “associated document” is the term used for content produced outside of CARS but is to be published alongside the controlled document authored within CARS.

For example, if there is a proforma to be completed on site as part of construction, this can be created outside of CARS (i.e., as a form, spreadsheet, or any file type as required) and then referenced within the CARS document.

Back to top

Recording associated documents

A record of any associated documents to be included in publication is captured on the document information page within CARS. This helps to ensure that all required documents are included when the controlled document is published.

Back to top

Associated document reference numbers

A reference number for each associated document is automatically generated within CARS. The generated reference follows a simple structure:

[MCHW SHW code]/[3-letter code for document type]/###

i.e., a single constructor proforma for CC 201 would have the code: CC 201/PRO/001.

If a associated document is removed from the listing in CARS, the references will automatically re-calculate. References are not persisted between different published versions.

Back to top

Adding a new associated document in CARS

To add a new associated document in CARS, follow these steps:

  1. Navigate to your document in CARS
  2. On the “Document information” page, scroll down until the “Associated documents” section is visible.
  1. Click “+ Add an associated document”, see below.
  1. Select the “Associated document type” from the drop-down list provided.
  2. Confirm whether the associated documents has any national variations; i.e., whether there are different versions to be published for England, Northern Ireland, Scotland, and Wales.
  3. Enter a title for the associated document. The title is restricted to a maximum of 100 characters.
  4. The “Cancel” button can be used to abort the addition at any time. Pressing “Esc”[ape], or clicking outside of the modal will also cancel the action.
  5. Click “Add this associated document” to save the record.
  6. The reference number is automatically generated and will updated if changes are made to the document code.
Back to top

Editing an associated document

To edit an associated document in CARS, follow these steps:

  1. Navigate to the CARS “Document information” page for your document.
  2. Scroll down to the “Associated documents” section.
  1. Click on the edit (pencil) icon next to the associated document to be edited.
  1. The “Associated document type” cannot be changed once set.
  2. Update the “Has national variations” setting and “Title” as required.
  3. The “Cancel” button can be used to abort the edit at any time. Pressing “Esc”[ape], or clicking outside of the modal will also cancel the action.
  4. Click “Save change to this associated document” to save the changes.
Back to top

Removing an associated document

To remove an associated document in CARS, follow these steps:

  1. Navigate to the CARS “Document information” page for your document.
  2. Scroll down to the “Associated documents” section.
  1. Click on the remove (bin) icon next to the associated document to be removed.
  1. A confirmation model, as shown above, will be displayed.
  2. The “Cancel” button can be used to abort the removal at any time. Pressing “Esc”[ape], or clicking outside of the modal will also cancel the action.
  3. Click “Remove associated document” to remove the associated document.
Back to top