Enabling Action Complete indicators

You can configure LiveContent Central to display check boxes next to the steps in procedure DMs.

About this task

A user can select the check box for a step to indicate that the step has been completed. Each time a check box is selected or deselected, that action is recorded as an entry in the audit trail for the applicable document, including the following information.
  • The type of action (checking or unchecking the check box)
  • The number and text of the step on which the action was performed
  • The date and time the action was performed

By default, this functionality is disabled. To enable it at the application level (affecting all publications), edit the ietm.show_steps_checkbox configuration item in the collection's [LCC_home]/content-service/config/application.yml file, setting its value to 1. To enable it at the publication level, edit the show_steps_checkbox configuration item in the publication's publication_s1000d.xml.

Procedure

  1. To enable Action Complete indicators at the application level, do the following.
    1. Open the application.yml file for editing.
    2. Locate the following configuration item within the file's ietm section.
      show_steps_checkbox: 0
    3. Set the value of the key show_steps_checkbox to 0.
    4. Save and close the application.yml file.
    Check boxes will be displayed within procedure DMs in all publications. Each time a check box is selected or deselected, that action is recorded as an entry in the document's audit trail.
  2. To enable Action Complete indicators at the publication level, do the following.
    1. Open the file named publication_s1000d.xml for editing.
    2. Add the following configuration item within the file's <book name=Name> section (where Name is the name of the publication in which Action Complete indicators are to be enabled) section's Publication tag's settings attribute.
      Configuration->Publication->settings="show_steps_checkbox=<value>"
    3. Set the value of the configuration item to 1 to display check boxes within procedure DMs for the publication.
    4. Save and close the publication_s1000d.xml file.
    Check boxes will be displayed within procedure DMs in the publication. Each time a check box is selected or deselected, that action is recorded as an entry in the document's audit trail.