Enable comments when submitting changes

An administrator can turn ON or OFF an optional feature to prompt a user to add a comment when using the Save and Submit option in Oxygen.

By default, the SaveSubmitComments feature is OFF (false).

When a user edits a component in the Oxygen editor and selects Save and Submit:

  • If the SaveSubmitComments feature is ON (true), the user is prompted to enter a comment.

    The comment is optional and can be left blank.

    • If no comment is entered and the user selects Save or Cancel, only the changes to the component are saved and the Oxygen editor closes.
    • If a comment is entered and the user selects Save, both the changes to the component and the comment are saved. The comment can be seen in a Comments column in the following places: Components browser (hidden by default), Component's History record, Changesets tab.

    If you can Edit References In Place, and you make changes only to an expanded reference, then your comment will appear only in that edited component's History record.

  • If the SaveSubmitComments feature is OFF (false), the user does NOT see the prompt to enter a comment. The changes to the component are saved and the Oxygen editor is closed.

To enable comments when submitting changes:

  1. From the Administration menu, select Advanced Settings, and then Features management.
  2. On the Features Management tab:
    1. After SaveSubmitComments, note the state. If the feature is enabled, it says true.
    2. After SaveSubmitComments, click Update.
  3. The feature is highlighted in blue. To change the state:

    • To enable the feature, type true.
    • To disable the feature, type false.
  4. Click Update.

    Results:

    To see the changes, users must sign out and back in.

    When a user is working in Oxygen, after selecting Save and Submit, the user is prompted to enter a comment:

    The comment is optional and can be left blank.

    You see comments in the Component Details screen, on the History tab.