Create and manage plan documentation sections
Use the documentation section to document the recovery capabilities of the plan.
Before you begin
About this task
Procedure
- Navigate to Business Continuity > Business Continuity Workspace.
-
Click the lists icon (
).
- Click In Draft state in the Planning list.
- Click the link to the plan record in the Name column.
-
Click the Documentation related list of the plan.
You can view each section of the documentation in a separate text box. The documentation sections that are part of the plan template, which you used to create the plan, default to this plan. You can create new sections to the documentation and edit existing sections as well.
-
To edit a documentation section, click the edit icon (
).
Use this icon to edit the title as well as the text in the description of the documentation section. - To edit the text in a section, click the Edit button in the text box.
-
To undo all your updates and revert to the original text of the documentation section, click Reset to template and click Reset to confirm your action.
Note:Reset to template button is enabled only when the document section is in Pending state and not in Complete state.
When you reset, both the title and description along with the text in the documentation section are reset to the title, description, and documentation content in the plan template.
-
To delete a documentation section, click the delete icon (
).
This action deletes the documentation section. -
To create a section in the documentation tab, click New
section.
- In the New section pop-up, enter a title and a description for the section.
- Click Create.
- Click the Edit button to enter the contents in the text box for the section.
- To save the updates and continue to edit the content, click Save.
-
To save and exit the edit mode, click Complete.
After you click Complete, both the
and
icons are disabled. To enable the icons, click the Edit button in the documentation section text box.
-
To view the subsequent section and scroll through all the sections, collapse
the section after you complete editing.
- Change section order at the plan level
- You can change the order in which the sections appear in the Documentation related list to help the user review the sections in a logical sequence. However, you must set the order preference for the sections by entering an integer value in the Order field of the Plan Documentation form for each documentation section in the plan. This customization overrides the order preference set at the plan template level.
- Change section order at the plan template level
- You can define the order of document sections in the Plan template
as well. This order is applied to all the plans that use the
template. However, only a BCM administrator can change the order of
the sections in the Plan Template form, when the template is
created.
- To rearrange the section order, navigate to Business Continuity > Plan Configuration > Plan Templates
- Click the plan template in the Name link.
- Click unlock document sections icon (
)
- Click the add/remove multiple icon (
) and move the items in a preferred order in the Document Sections field.
Figure 1. Document sections - Click Update.
As a program manager, planner, viewer, or BCM administrator, you can only view the rearranged order of the sections in the workspace when your plan uses that template.
Figure 2. Order of the sections in a document