Applies to: Australia and UK Uniclass-based (preliminary and work section) specifications only. Please see a separate article for UK - CAWS-based specifications.


This article shows the types of changes that can happen to a clause. It sets out what will happen to your clause when you click the action buttons. Please note that in some cases, you must make further edits to the clause after clicking 'Update clause'.


This article assumes an understanding of 'Update'. This is explained in Using the Update tab.


We recommend referring to the technical update notes that accompany every content set update when you are using ‘Update’. The notes highlight the key areas where changes have been made. 

Technical update notes are posted to the 'Technical content releases' page for every content set change. For convenience, the can be accessed from the 'Help' menu within the platform.


Related articles:

Update notifications - an overview

Using the Update tab

Technical content releases


The 'Updates to' panel

The 'Updates to' panel shows the proposed changes the platform will make to your clause. Icons, tooltips and text styling call out the clause and guidance changes.


A screenshot of the 'Updates to' panels in the update preview window.

A screenshot of the 'Updates to' panels in the update preview window.


Types of change

The table below shows each change scenario in detail. Please note that in some cases, you must make further edits to the clause after clicking 'Update clause'.


Top tip: In most cases applying an update to a clause will require the clause to be edited further. So, before clicking the update buttons, click on the 'View in editor'. This will open that clause in a new browser tab. Then click the 'Update clause' buttons to apply the update. When you are ready to edit the clause, the clause will be waiting for you in the new browser tab.



Type of changeHow the change is displayed
'The suggestions have been revised. The change may be to a document link.'

'Updates to' shows:
  • An orange border around the row suggestions menu.
  • A tooltip that says, 'The suggestions have been revised. The change may be to a document link'.
  • The 'Guidance' panel will indicate the text that has been added and removed. This includes changes to reference standard display text or hyperlink URLs.

 

Action buttons are:

  • 'Cancel' – closes the 'Update' preview and returns you to the 'Updates' grid. No changes are made to the clause.
  • 'Ignore' – will not apply the new suggestions to the clause template for you to select. It will close the 'Update' preview and remove the notification from the 'Updates' grid.
  • 'Update clause' – will update the suggestions menu values. The platform will not change the value of the row.


Important! To apply the revised suggestions to your clause, you must edit the clause after clicking 'Update clause'.  

'The default value has been revised.'

'Updates to' shows:
  • An orange icon to the left of the row title.
  • A tooltip that says, 'The default value has been revised.
  • The 'Guidance' panel will indicate the text that has been added and removed. This includes changes to reference standard display text or hyperlink URLs.


Action buttons are:

  • 'Cancel' – closes the 'Update' preview and returns you to the 'Updates' grid. No changes are made to the clause.
  • 'Ignore' – will not apply the new suggestions to the clause template for you to select. It will close the 'Update' preview and remove the notification from the 'Updates' grid.
  • 'Update clause' – The platform will apply the revised default value to your clause.
'The default value has been revised. Your edits have been left unchanged.'

'Updates to' shows:
  • An orange icon to the left of the row title.
  • A tooltip that says, 'The default value has been revised.
  • The 'Guidance' panel will indicate the text that has been added and removed. This includes changes to reference standard display text or hyperlink URLs.


Action buttons are:

  • 'Cancel' – closes the 'Update' preview and returns you to the 'Updates' grid. No changes are made to the clause.
  • 'Ignore' – will not apply the new suggestions to the clause template for you to select. It will close the 'Update' preview and remove the notification from the 'Updates' grid.
  • 'Update clause' – will update the default suggestions menu values in the clause template but it will not change the value in your clause. You will need to do this yourself.

Important! You must edit the clause after clicking 'Update clause' to apply the revised suggestions to your clause.

'The clause has been deleted.'

'Updates to' shows:
  • The middle 'updates to' panel is displayed in red text and struck-through.
  • The guidance in the right-hand panel is replaced with a message displaying 'No guidance available'.


Action buttons are:

  • 'Cancel' – closes the 'Update' preview and returns you to the 'Updates' grid. No changes are made to the clause.
  • 'Keep' – retains the clause in the specification. The guidance will remain visible. There will be no future update notifications as the clause has been removed.
  • 'Delete' – will delete the clause from the specification. It may introduce a broken link.
    Please see What are broken links and how to fix them.

Clauses are occasionally deleted from the content set because several clauses are being consolidated or the clause is being moved.

We recommend referring to the technical update notes accompanying every content set update when using ‘Update’. Please see 'Technical content releases'.
Please click to expand image.
'A new row {row title} has been added.'

'Updates to' shows:
  • A green '+' icon and underline for the row.
  • The 'Guidance' panel will show any newly added guidance with a green background.


Actions buttons are:

  • 'Cancel' – closes the 'Update' preview and returns you to the 'Updates' grid. No changes are made to the clause.
  • 'Ignore' – will not apply the new row to the clause. It will close the 'Update' preview and remove the notification from the 'Updates' grid.
  • 'Update clause' – will add the new row to the clause.


Important! The new row may require a value to be added. To do this, you must edit the clause after clicking 'Update clause'.

'The row, {row title}, has been deleted.'

'Updates to' shows:
  • A red cross icon with a cross and row title in red struck through text formatting.
  • A tooltip that says, 'The row, Third-party certification, has been deleted.'


Actions buttons are:

  • 'Cancel' – closes the 'Update' preview and returns you to the 'Updates' grid. No changes are made to the clause.
  • 'Ignore' – will not apply the changes to your clause. It will close the 'Update' preview and remove the notification from the 'Updates' grid.
  • 'Update clause' – will remove the row from your clause.
'The row, {row title}, has been deleted. It will be converted to a user row to save your edits.'

If you have edited the row being deleted by the clause update, The platform will retain it in your spec.

'Updates to' shows:
  • A red icon with an exclamation.
  • A tooltip that says, 'The row, Third-party certification, has been deleted. It will be converted to a user row to save your edits.'


Actions buttons are:

  • 'Cancel' – closes the 'Update' preview and returns you to the 'Updates' grid. No changes are made to the clause.
  • 'Ignore' – will not apply the changes to your clause. It will close the 'Update' preview and remove the notification from the 'Updates' grid.
  • 'Update clause' – will keep the row remove the row from your clause.


Important! The row intended to be deleted will remain in your clause. To delete it, you must edit the clause after clicking 'Update clause'.

'The row, {row title}, has moved up/down/in/out.'

'Updates to' shows:
  • An orange arrow icon.
  • A tooltip that says, 'The row, Performance characteristics, has moved up/down/in/out'.


Actions buttons:

  • 'Cancel' – closes the 'Update' preview and returns you to the 'Updates' grid. No changes are made to the clause.
  • 'Ignore' – will not apply the changes to your clause. It will close the 'Update' preview and remove the notification from the 'Updates' grid.
  • 'Update clause' – will restructure your clause as the 'Updates to' panel indicates.
'The row title, {row title}, has been revised'

'Updates to' shows:
  • An orange arrow icon.
  • A tooltip that says, 'The row title, PVB type, has been revised'.


Actions buttons:

  • 'Cancel' – closes the 'Update' preview and returns you to the 'Updates' grid. No changes are made to the clause.
  • 'Ignore' – will not apply the changes to your clause. It will close the 'Update' preview and remove the notification from the 'Updates' grid.
  • 'Update clause' – will retitle the roe of your clause.
'The Guidance for this clause has been revised'.

'Updates to' shows:
  • A yellow pencil icon next to the 'Guidance' title.
  • The latest guidance is always displayed in the right-hand panel.
  • When there is only guidance changes that do not change the rows of the template no icons or tooltips are displayed in the middle panel.
    • Guidance-only changes will not change the written specification but will update the information presented against the specification in the guidance panel.
  • The platform compares the latest guidance with the previous guidance and displays the differences. 
  • Newly added guidance is presented with a green background and underline.
  • Removed guidance is presented with a red background and strikethrough.
  • Guidance differences also highlight changes in hyperlinks display text and underlying URLs.
  • When there are no icons in the middle panel, the change is a guidance change only. We recommend clicking the update button for guidance only changes.


Actions buttons:

  • 'Cancel' – closes the 'Update' preview and returns you to the 'Updates' grid. No changes are made to the clause.
  • 'Ignore' – will not apply the changes to your clause. When you look at the clause in the editor, it will show the old guidance. It will close the 'Update' preview and remove the notification from the 'Updates' grid. 
  • 'Update clause' – will update the guidance displayed against your clause.