Sub Diagram

 

Accessing Sub Diagrams

Users can decompose complex diagrams into Sub Diagrams for better clarity and management. A Sub Diagram tab lists all sub diagrams originating from the main diagram. 

1. A Sub Diagram tab will appear in the interface after a diagram is generated.

2. You cannot proceed to Sub Diagrams until the associated Work Item (WI) is published.

 

3. To publish the WI, follow the publishing workflow in Diagram.

 

4. Once the WI is published, access and interact with the Sub Diagrams as needed. Click on your required Sub-diagram. 

 

5. The selected Sub Diagram has been generated .

 

 

Publishing Sub Diagrams

Users can publish Sub Diagrams to Existing Work Items and New Work Items. Let's discuss each of the two ways. 

 

To an Existing Work Item

1. Click on the "Publish" button.  

 

2. Select the Existing Work Item option. Users must publish work items at each level of the diagram hierarchy before generating further sub-diagrams. 

 

3. The following pop up window will open. Select the Link Type from the dropdown (By default, Child will be selected as the Link type)

 

4. Select the work item from the list. 

Note: All Work Items (WIs) will be shown in the list except those that already contain a diagram.

 

5. Select the Work item field for the sub-diagram. 

 

6. Choose whether you want to include Diagram Explanation. 

Note: In cases where a diagram explanation has not been pre-generated, the checkbox will be displayed as unchecked by default. If the user chooses to check this box, the system will initiate the generation of the explanation in real-time. Conversely, if the checkbox is already checked upon first interaction, it indicates that the explanation has been pre-generated and is readily available.

 

 

 

7. Determine whether to select the "Include Diagram Markdown" option (the option is selected by default).

 

8. Decide whether to replace the information in the selected field.

 

9. Click on the "Publish" button.

 

10. The sub-diagram has been published to an existing work item.

 

Note: When a sub-diagram is successfully published, a green checkbox will appear with its name, serving as an indicator of its published status. For sub-diagrams that are not yet published, a blue plus sign (+) will be displayed adjacent to their names within the sub-diagram panel, signifying their unpublished status and availability for further action.

 

To a New work Item 

1. To publish a Sub Diagram to a new work item, click on the Publish button. 

 

2. Select the New Work Item option to open the "Publish to new work item" popup window.

 

3. Select the Link Type. By default "Related" will be selected as the link type. 

 

4. By default, the title of a new work item is automatically set to the name of the diagram. However, users have the flexibility to modify the title as needed to better align with their specific requirements.

 

5. Select the Work item type. 

 

6. Select the Work item Field. 

 

7. Select whether you wish to include the Explanation and Diagram Markdown in the new work item.

Mandatory Fields Scenario

• Mandatory fields for a work item appear within a light gray box labeled Mandatory Fields.

Note: Mandatory fields only appear when the user configures specific fields as mandatory. If no mandatory fields are configured, the mandatory fields option does not display. When mandatory fields are configured and the user does not provide values for them, the 'Publish' button remains disabled until the user enters the mandatory information. If no mandatory fields are configured by the user, the button remains enabled by default.

• Mandatory fields for a work item appear within a light gray box labeled Mandatory Fields.

 

• A red icon marks required fields, clearly showing that they must be filled in.

 

• Add the required field info in the fields mentioned in the ‘Mandatory Field' box.

• Once you enter information in the field, the red label beside it is removed.

 

• The Publish button becomes enabled only after you complete all required fields for the work item type selected in the Create Work Item window.

 

8. Click on the Publish button. 

 

9. The Sub Diagram has been successfully published to a New Work item. 

 

Note: A notification message is triggered above the Sub Diagram list when there is a change or update in the diagram. This can happen in the following scenarios:

• If any changes are made to the diagram using the Diagram Markdown or the Update Diagram prompt.
• The message will notify users that the diagram has been updated and suggests regenerating Sub Diagrams. 

 

Saving a Sub Diagram

1. To save a sub diagram, the first step is to click on the Save As button. 

 

2. Choose the desired format for saving the sub diagram:

• Word File (.docx): Includes the Diagram, Explanation, and Diagram Markdown.
• PDF File (.pdf): Includes the Diagram, Explanation, and Diagram Markdown.
• Image File (.png/.jpeg): Saves the Diagram as a standalone image.

 

3. The Sub Diagram has been downloaded successfully.

 

 

Accessing Sub Diagrams in a Previous Version of a Diagram

• If you want to view the sub-diagrams for a previous version, please restore it to the latest version and then regenerate the sub-diagrams.

Note: When you switch to a previous version of the diagram, the Sub Diagrams panel will be frozen and the user will see a message indicating the user to restore the version in order to view the sub diagrams.