Skip to main content

FieldLogs

Generating Steps From a Reference Manual

You can add content from a Reference Manual to an already existing Template which is editable.

  1. From the main menu, go to Templates > Your Templates.

    your-templates-navigation.png
  2. Select a private Template or a Template under edition.

    private-template.png
  3. From the property pane, navigate to the tab Reference manuals.

    GenTemplateFromRefManual2.png
  4. Select a Reference Manual.

    Select_Reference_Manual.png

    Important

    The Reference Manual can be selected using the text filter. The list of Reference Manuals containing the typed text as part of the name is filtered.

    manual_filter.png

    The collapsed structure of the Reference Manual appears.

  5. Expand the structure of the Reference Manual.

    GenTemplateFromRefManualExpandedManual.png

    You can search for the required element or sub-element of the Reference Manual using the following options:

    • Search by code: Allows you to search the Reference Manual content using the Public key of the elements.

      SearchbyCode.png
    • Search by text: Allows you to search the Reference Manual content using keywords.

      SearchbyText.png

      The search highlights the relevant content of the Reference Manual.

  6. Select an element or sub-element such as Page Block, Task, Subtask, Job Set-up, Procedure, or Closing.

    In the example below, Job Set-up, Procedure, and Closing are the sub-elements.

    OneStepSelected.png

    You can select multiple elements or sub-elements using shift + click.

    MultipleElementsSelected.png
  7. Right click the selected element(s).

    RightClick.png

    The available options appear.

    AvailableOptions.png
  8. Click Generate Steps.

    ClickGenerateSteps.png
  9. Select where you want to insert the Steps.

    Select_Insertion_Step.png
  10. [Optional] Select a granularity level.

    Select_Granularity_Level_Generate_Steps.png

    Important

    The Default value generated by the system is the recommended value for the granularity level.

    Note

    The granularity level defines the maximum number of sub-levels that the system will generate.

    If the Reference Manual contains more Step levels than the defined granularity level, the content of the child Steps belonging to the inner levels merge with the parent Step at the same level as the granularity level set.

    For example, if you select a granularity level of 3 and the Reference Manual contains 5 levels of Steps, the child Steps of level 4 and 5 are merged with the parent Step at level 3.

    Refmanual5steps.png
    stepsgenGL3.png

    The Granularity level of the Steps generation is available only for the Steps generated from Manuals of format SGML.

  11. [Optional] Expand the Options section and check the Exact links to the referenced content option.

    ExactLinks.png

    When the option is checked, the links in the Step redirect you to the content in the original version of the Reference Manual.

    When the option is not checked, the links in the Step redirect you to the content in the latest version of the Reference Manual.

  12. Click Generate.

    Click_Generate_Steps.png

    The Steps are added to the Template.

    Result_Steps_Generated.png

    If multiple elements and sub-elements of the Reference Manual were selected to generate Steps, each element and sub-element is added as a different Step. The Steps are added to the Template in the order in which they were selected.

    MultipleStepsOrderDialog.png
    StepOrderInTemplate.png

    If an element and its sub-element are selected, the sub-element is added twice. It is added as both a child Step under the element Step and as an individual Step.

    TaskStep_SubtaskStep.png

    In the above example, the element Task 05-21-01-200-001 and its sub-element 1. General are selected. When Steps are generated, they are added as separate Steps. The sub-element is added twice in the Template.

    The Template Step 1 corresponds to Task 05-21-01-200-001. The Steps for 1. General are repeated twice in the Template - once as 1.1, a child Step and again as 2, an individual Step.