---
title: "Change Descriptions"
slug: "changedescriptions"
updated: 2023-09-07T02:16:24Z
published: 2023-09-07T02:16:24Z
---

> ## Documentation Index
> Fetch the complete documentation index at: https://help.12dsynergy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Change Descriptions

Admin Content

A change description is a message that the user must specify whenever any of the following actions are performed in the 12d Synergy applications.

- Any change to a file, like renaming, purging, updating, etc.
- Checking in a file
- Moving a file
- Changing a task
- Checking in a 12d Model project
- Changing a folder

These change descriptions enable you to view and understand the history of the files in the subject. By default, entering the change descriptions is mandatory. Instead of specifying a change description manually every time an action is performed, 12d Synergy gives you the option to configure some predefined change descriptions using the procedure mentioned below.

### 1.1. How to Change the Description Mode

Whenever a change is made to a file or a folder, 12d Synergy asks for a description of the change. This description helps when you perform an audit on the data. By default, the description is mandatory, but this can be configured using the **Description Mode** option.

1. In the **12d Synergy Administration** application, select the **System Rules**tab **> Change Descriptions** tab.
2. Select the required mode for the display of change descriptions across the 12d Synergy applications from the **Description mode** list.  
![](https://cdn.document360.io/36833d89-59e3-46a5-b491-e9aa1b524a85/Images/Documentation/v5changedescriptions.doc-image-373y69xo.png)  
  
The selected **Description mode**is applied to all the above-listed changes that are performed on entities in the **12d Synergy Client**application.

### 1.2. How to Configure Predefined Change Descriptions

1. In the **12d Synergy Administration** application, select the **System Rules**tab **> Change Descriptions** tab.  
![](https://cdn.document360.io/36833d89-59e3-46a5-b491-e9aa1b524a85/Images/Documentation/v5changedescriptions.doc-image-t5s4vrhr.png)
2. Select the **Use wizard**check box to see all the predefined change descriptions that you can apply to a change action in one dialog box as shown below.  
![](https://cdn.document360.io/36833d89-59e3-46a5-b491-e9aa1b524a85/Images/Documentation/v5changedescriptions.doc-image-c3541zg4.png)  
  
If you do not select the **Use Wizard** check box, the change description window is displayed like the following. You will either have to enter a change description in the box below the **Please describe this change** statement or select an appropriate option from the **Use** list below.  
![](https://cdn.document360.io/36833d89-59e3-46a5-b491-e9aa1b524a85/Images/Documentation/v5changedescriptions.doc-image-hf2plfu1.png)

- For the wizard setting to take effect, you must restart the 12d Synergy Client application after selecting/clearing the **Use wizard** check box.
- You can type **@** and select a name from the list of contacts to notify the contact about the file change via email. For example, @Cornelious Chase.
- You can also type **@**with the project role to notify the person working in the capacity of the specified role of the change. For example, @Drafter.

### 1.3. How to Create a Predefined Change Description

1. In the **12d Synergy Administration** application, select the **System Rules**tab **> Change Descriptions** tab.
2. Select the action for which you want to create a new predefined change description from the **Change type** list.  
The predefined change descriptions for the selected action are displayed in the panel below.
3. Click the ![](https://cdn.document360.io/36833d89-59e3-46a5-b491-e9aa1b524a85/Images/Documentation/v5changedescriptions.doc-image-jiikugsi.png) button.  
The **Add/Edit a Predefined Change Description** window is displayed.  
![](https://cdn.document360.io/36833d89-59e3-46a5-b491-e9aa1b524a85/Images/Documentation/v5changedescriptions.doc-image-02tlz66y.png)
4. Enter the name for the predefined change description in the **Name** box.
5. Enter a very brief description for the predefined change description in the **Description** box.
6. If you want to prompt the user for additional information that should make up the description, create a predefined description with values in square brackets.  
For example, you may have a predefined description entitled Milestone Backup, but you want to capture information on why it is a milestone.  
  
If you create a predefined description with values in square brackets, the user will be required to enter more information at change time.  
For example:  
**Milestone backup**  
**[Reason for being a Milestone backup]**  
The following window is displayed, requiring the user to fill out the **Reason for being a Milestone backup** field.  
![](https://cdn.document360.io/36833d89-59e3-46a5-b491-e9aa1b524a85/Images/Documentation/v5changedescriptions.doc-image-6g4bdrbs.png)
7. Click the **Save** button.  
The predefined change description is created for the selected action and is displayed in the panel below the **Change type** list.

### 1.4. How to Edit a Predefined Change Description

1. In the **12d Synergy Administration** application, select the **System Rules**tab **> Change Descriptions** tab.
2. Select the action for which you want to create a new change predefined description from the **Change type** list.  
The predefined change descriptions for the selected action are displayed in the panel below.
3. Select the predefined change description that you want to edit and click the ![](https://cdn.document360.io/36833d89-59e3-46a5-b491-e9aa1b524a85/Images/Documentation/v5changedescriptions.doc-image-3k2ladsz.png) button.  
The **Add/Edit a Predefined Change Description** window is displayed.  

You can change the order of display of the predefined change descriptions for a change type, by selecting the one to be moved in order and click the up ![](https://cdn.document360.io/36833d89-59e3-46a5-b491-e9aa1b524a85/Images/Documentation/v5changedescriptions.doc-image-1h6z5h78.png)and down ![](https://cdn.document360.io/36833d89-59e3-46a5-b491-e9aa1b524a85/Images/Documentation/v5changedescriptions.doc-image-p9zvja9o.png)arrow buttons.
4. Make the necessary edits and click the **Save** button.

### 1.5. How to Delete a Predefined Change Description

1. In the **12d Synergy Administration** application, select the **System Rules**tab **> Change Descriptions** tab.
2. Select the action for which you want to create a new predefined change description from the **Change type** list.  
The existing predefined change descriptions for the selected action are displayed in the panel below.
3. Select the predefined change description that you want to edit and click the ![](https://cdn.document360.io/36833d89-59e3-46a5-b491-e9aa1b524a85/Images/Documentation/v5changedescriptions.doc-image-0nys2j0x.png) button.  
The selected predefined change description is deleted.
