Report: Change Summary with Version History and Documents Replaced

Description

When submitting a new document or questionnaire, or a new version of an existing document/questionnaire, to review or approval, a document owner must include the reason for creating the new document/questionnaire or a summary of changes to the existing document/questionnaire. This report shows the change summaries written by document owners upon submitting those documents/questionnaires (new or new version) for review or approval.

Note: By default, the text "New Document" or "New Version" is added to the text box when a document owner submits a document/questionnaire for review or approval. PolicyTech does not require the document owner to change the default text, though your organization may require a more detailed explanation.

Available to users with the following roles or permissions:

Document Owner, Proxy Author, Report Manager, Administrator

How to Generate

  1. Click Reports.
  2. Click Document Reports, and then click Change Summary with Version History and Documents Replaced.
  1. Select documents or questionnaires to include in the report (see Selecting Documents for help), and then click OK.

All options available for this report are displayed on the left. Notice that the number of currently selected documents/questionnaires is displayed after the Documents option, which you can click anytime to change your document/questionnaire selection.

Note: If you change your document/questionnaire selection after clicking View Report, click View Report again to refresh the report contents.

  1. (Optional) Click Arrangement and do any of the following:
  1. Click Detail Options, and then select the information you want included in the report. See Detail Options below for details.
  1. (Optional) Click Output Format, and then click Standard or Microsoft Excel Raw.
  1. (Optional) To save the current document/questionnaire selections and option settings for future use, click , type a name and description, click Save and Close, and then click OK.

Note: To access a saved report, click Reports, and then click My Saved Reports.

  1. Click View Report.

If you chose the Standard output format, the report opens in the viewing pane to the right where you can view the report, search within it, send it to another PolicyTech user, print all or part of it, and save it to disk in several different formats (see Working with a Finished Legacy Report for details). If the report contains links, click a document or questionnaire link to open that document/questionnaire in PolicyTech or click a user name to open another report specific to that user.

If you selected Microsoft Excel Raw, follow the prompts to download and open the Excel file.

Detail Options

Include previous versions. Includes the change summaries for any previous versions of the selected document/questionnaire.

Include next versions. If a selected document/questionnaire is not the latest version, this option adds the change summaries for each later version.

With non-approved versions. Displayed only when Include next versions is selected. Select this option if you want to include the change summaries of versions currently in the review or approval status.

Note: Selecting Include next versions without selecting With non-approved versions applies only if you select documents/questionnaires in the archived status that were replaced by a newer version.

Include 'Edit in Current State' summaries. A document owner or administrator can make minor changes to an approved document without creating a new version and sending it through the approval process. When a user does this, PolicyTech requires the user to summarize changes and creates a minor version, appending a period and a minor version number to the major version number, such as 1.1 or 1.2. Selecting Include 'Edit in Current State' summaries adds minor version change summaries to the report.

Note: This option does not apply to questionnaires.

With system changes. Displayed only when Include 'Edit in Current State' summaries is selected. PolicyTech creates minor versions of a document each time it automatically updates something in the document, such as an inserted document property or a link to another PolicyTech document. Select this option if you want to include change summaries for system-generated minor versions.

Note: This option does not apply to questionnaires.

Include Owner/Approver Details. Adds the names and job titles (if included in the users' profiles) of the document owner and approver of each document version.

Include Replaced Document Details. Adds a list of documents, if any, each version replaced when it was published.

Note: This option does not apply to questionnaires.

Include Assigned Categories. For each included document/questionnaire, adds a list of its assigned categories.