Formatting Generate Documentation Work Instructions

You can generate formatted work instructions that you can review within the Work Instructions app using CATRules.

Before you begin:

Your administrator has used CATRules to specify the type of work instructions extracted that you can get. That is, HTML or XML, whether XML output further processes, and whether the documents are attached to the operation. See Authoring a Catalog. This task describes what to do when your administrator has chosen HTML formatting for your output.

If you attached views to work instructions, you can update all the views simultaneously by changing the current system to the parent of all the work instructions. Then click Update Views .

Note: If there are Operations inside a Workplan / System that is in Released maturity state, and if Views are applied for those Operations, then any subsequent save done in that session fails. Use the Save with Options
See Also
About Formatting Generate Documentation
Business Rules
Saving after a Work Plan Publication with a Released Operation
  1. If required, click Change Current System to select the parent system that includes all the operations whose work instructions you want to review.
    Note: You have the capability to generate documentation based on Operation Sequence, either based on Time, or Tree order.

    In Generate Documentation, the Operation sequence in XML/HTML is determined by product flow and creation time.

    • Operations are displayed sorted by start time.
    • When multiple operations have the same start time, they are displayed sorted by creation order.


    Operation sequence in a Generated Document.

    When there are many operations, it becomes difficult to spot the required operation.

    Display sequence based on the Tree Order, generates a document that has operations displayed based on the Tree Order.

    Display sequence based on Time, the Operation Sequence in the Generated Documentation is aligned with the sequence in the Operation Filmstrip.

  2. Click Generate Documentation for All Operations
    The Format & Attributes dialog box appears.

    See Supporting Generate Documentation for Alternate/Substitute.

    The dialog box lists the formatting translator (XSLT) files; the dialog box next to each type of file enables you to select a customized translator from your catalog, if you prefer.

    Note: If your administrator enabled you to choose whether to have HTML or custom formatted files, a Generate Documentation dialog box asks which you prefer.

  3. For the formatting translator files, you can either:
    • Click OK (that is, accept the default formatting files).
    • Click the dialog box next to one (or each) default file. The Catalog Browser appears; use it to select the formatting file you want to use, and click OK on the Catalog Browser. The list in the Format and Attributes Specification shows the XSLT files that you select your catalog.
    Once you have accepted the default or selected formatting files, select the appropriate process, product, and resource (PPR) attribute (XML) file you want.
  4. You can either:
    • Click OK (that is, accept the Work Instructions-provided PPR attributes file).
    • Click the dialog box next to the PPR attributes file. The Catalog Browser appears; use it to select the XML you want to use, and click OK on the Catalog Browser.
  5. Click OK in the Format and Attributes Specification dialog box.
    If your administrator has set up the business logic to attach the work instructions to the system, the formatted instructions are attached. When you first publish work instructions, a compressed panel appears in the upper right corner.

  6. Move and resize the browser.

    You can also use scroll bars to see information.

    A formatted list of the system operations, with the content in its PPR context, appears in the browser. Operations with work instructions have hyperlinks.

  7. Click an operation with work instructions.
    The instructions assigned to the operation appear in the browser.
  8. Right-click anywhere on the work instruction and select Back.

Note: To preview the instructions for only one operation, right-click the operation in the Operations Sequencer frame, and click Generate Documentation for Operation. As with Generate Documentation for All Operations, if your administrator creates the logic for HTML formatting, the Format and Attributes Specification dialog box appears. Once you select or confirm the formatting and attribute files, you see a preview of the work instructions for the operations.