Skip to main content

FieldLogs

Regenerating the Template Content

The purpose of Regeneration is to update the Template with content from the new Revision of a Manual.

In some cases, users generate content directly from a Manual and add attributes without changing the Step Title.

When they receive new Revisions through the Screening process, they update the Steps with the modified content from the new Revision.

During Regeneration, a user can revert the custom changes made to the Template.

Note

When you Submit a modified Template from Screening, it is present under the OEM Revised Templates under Edition category as shown.

MicrosoftTeams-image__2_.png

You can Regenerate the Template when it is under Edition.

Consider a Template generated from a Reference Manual.Generating a Template from a Reference Manual

Custom changes may be made to the Template. When a new version of the Reference Manual is available, the Template will be Regenerated.

In the Template edition stage, three Regeneration options are available.

dropdown_options.png

There are three different Regeneration options listed below:

  1. Regenerate all Steps.

  2. (BETA) Regenerate with Template.

  3. (BETA) Regenerate Template with Attributes.

The Regenerate all Steps option does not retain any custom Attributes.

All the steps are Regenerated.

The user can retain any custom changes by choosing (BETA) Regenerate Template or (BETA) Regenerate Template with Attributes as shown below.

2023-11-22_13-27-23.png

The options are described in detail below:

Regenerate all Steps discards all custom modifications. All the Steps are Regenerated from the Reference Manual.

In the below example, the Template has the following custom changes.

  • A Functional Type DOC has been added to Step 1 which was generated from the Reference Manual.

  • A custom Step has been added (Step 2).

2023-11-21_14-21-48.png

While the Template is under Edition, the option Regenerate all Steps is selected.

Regenerate_all_Steps.png

A confirmation message appears warning the user that all the modifications will be reverted.

Confirmation_message.png

When the user confirms by clicking Regenerate all Steps, the Template is Regenerated.

Regenerate_all_steps_button.png

If Facets are present in the Template, the user can choose to add them.

Facets_detected.png

If PTC details are present in the Template, the user can choose to add them.

PTC_detected.png

All the custom changes made to the Template have been reverted.

The Regenerated Template contains all the Steps Regenerated from the new version of the Manual.

result_of_Reg_all_steps.png

(BETA) Regenerate Template is used to Regenerate the whole Template from the Reference Manual while keeping some custom changes.

While the Template is under Edition, the option (BETA) Regenerate Template is selected.

_BETA__Regenerate_with_template.png

A confirmation message appears warning the user that this Template will be Regenerated from the Documentation References.

confirmation_message_of_regenerate_with_template.png

The Manuals you choose while generating the Steps are displayed.

manual_selected.png

[Optional] By selecting Keep Custom Text in Steps, the changes made to the Step Title remain the same after Regeneration.

Regenerate_template_with_keep_custom_attributes.png

When the user confirms by clicking (BETA) Regenerate Template, the Template is Regenerated.

_BETA__Regnerate_template.png

The Regeneration Results are displayed with the reconstructed Steps kept during Regeneration.

Click OK.

regeneration_click_ok.png

The Template is Regenerated by keeping custom changes.

result_of_Reg_template.png

(BETA) Regenerate Template with Attributes is used to Regenerate the whole Template from the Reference manual while keeping some custom changes and Step Attributes.

Based on the extent of custom changes made to a Step, the Regeneration of Steps differs.

The following table compares the Regeneration of different Steps.

2023-11-22_13-30-21.png

While the Template is under Edition, the option (BETA) Regenerate Template with Attributes is selected.

_BETA__Regenerate_Template_with_attributes.png

A confirmation message appears warning the user that this Template will be Regenerated from the Documentation References.

confirmation_message_of_regenerate_template_with_attribute.png

The Manuals you choose while generating the Steps are displayed.

manual_with_attributes.png

[Optional] By selecting Keep Custom Text in Steps, the changes made to the Step Title remain the same after Regeneration.

custom_steps_.png

Select the required Attributes that you want to keep.

Attributes_dropdown.png

When the user confirms by clicking (BETA) Regenerate Template with Attributes, the Template is Regenerated.

BETA_REGENEATE_TEMPLATE_ATTRIBUTE.png

The Regeneration Results are displayed with the reconstructed Steps kept during Regeneration.

Click OK.

Regeneration_result_ok.png

The Template is Regenerated by keeping some custom changes and Step Attributes.

result_of_Reg_with_attributes.png