Skip to main content

FieldLogs

Using Module Libraries

A Module Library contains a list of reusable Modules. It enables a Template Author to insert standard Modules into a Template while designing it.

A Template Author can insert any of these Modules into a Template.

Below is an example of a Repair Module Library which consists of Wing, Engine and Gear Repair Modules.

Suppose a Template Author needs to use a Wing Repair Module as part of a different Template, this Module can simply be inserted.

Module_Library.png

A Module refers to a self-contained and independent unit that performs a specific Task or provides a set of related functionalities.

Module Variables refer to Variables that are defined within a specific Module.

Module Variables provide a convenient way to manage data within a Module.

Their scope is limited to that Module.

They can store temporary data or intermediate results during execution within the Module.

Note

Values of these variables can be changed while inserting the Module into a Template. The same Module can be inserted into different Templates using different values.

The Module Library can be edited in two ways:

1. Existing Modules can be edited.

2. New Modules can be added.

After the edition of the Module Library, it is published using a Lifecycle.

Module_Library_lifecycle.png

Note

The term Module Libraries is a customizable label in Fieldlogs. It might be referred to differently in an organization.

The equivalent term for Module Libraries in your organization is the term used instead of the highlighted menu item below in your interface.

2023-09-04_19-18-30.png
Creating Module Libraries

To create a Module Library:

  1. On the main menu, go to Templates > Module Libraries.

    main_menu.png

    The Module Libraries page opens.

    result_main_menu.png

  2. Click Create new Module Library.

    create_new_Module_Library.png

  3. Enter Module Library Name.

    Enter_Module_Library_name.png

  4. [Optional] Enter Module Library Description.

    Module_Library_descxription.png

  5. Click icon.png to add Module Library Category.

    Module_library_category.png

  6. Click the dropdown to view the list of category options.

    dropdown_icon.png

  7. Select a Category from Proposed Categories that already exist, from the list as shown below.

    Previously created Categories appear under Proposed Categories.

    Categories.png

    Add icon.png and/or delete delete_icon.png as many as Module Library Categories as shown below.

    add_and_delete.png

  8. Click the dropdown to open the list of options and select a Lifecycle for the Module Library from the list.

    lifecycle_selection.png

  9. Click Create.

    Create_ML.png

    The Module Library is created.

    result_module_library.png

    Users who are part of this Group can see this Group's information.

    ML_Group_visibility.png
Adding Modules to a Module Library

You can now add Modules to the Module Library.

To add Modules to a Module Library:

  1. Click Pick up edition.

    Pickup_edition.png

  2. Click Add Module.

    AddModule_ML.png

    The Add Module dialog is displayed.

    MLdialog.png

  3. Click Create.

    Addmodule_dialog.png

    The Module is created.

    Module_created.png

  4. Click Edit Module. This allows you to add Steps to the Module or edit other properties.

    edit_module.png

  5. Add the required Steps to the selected Module.

    steps_in_module.png

    The Steps have been added to the Module.

  6. [Optional] Click Add Documentation Key to add a Documentation Reference to a Module.

    add_documentation_key.png

    Fill in the required fields. The Documentation Reference has been added to the Module Library as shown below.

    Doc_Ref_ML.png

  7. Click Save.

    doc_key_added_ML.png
Creating Module Variables

Modules behave the same when inserted into any Template without Module Variables.

However, using Module Variables allows setting different values before insertion, which leads to different behaviour.

To create a Module Variable:

  1. On the main menu, go to Templates > Module Libraries.

    main_menu.png

    The Module Libraries page opens.

    result_main_menu.png

  2. Select the required Module Library.

    selecting_module_library.png

  3. Click Edit Module.

    edit_module_adding_variables.png

  4. Click list_of_tabs_icon.png to view the entire list of tabs.

    displaying_all_the_entire_tabs.png

  5. Click variable_icon.png Variable as shown below.

    clicking_variable.png

  6. Click Add Variable.

    Add_variable.png

    For more information on adding a Variable, click here.

    Note

    When you check the Edit value when inserted in a Template, you can edit the value of the variable at the time of insertion.

    Edit_value_when_inserted.png

Once the Module Variables are added to the Modules, the Module can now be Published.

Publishing the Module

A Module must be Published before it can be used.

To Publish a Module:

  1. Click View Module Library.

    view_module_library.png

  2. Click Publish new Module Library Version.

    Publish_new_version_Module_Library.png

    A dialog box appears.

  3. Click Publish new version.

    Publish_new_version_button.png

    A message confirming the successful publication of the Module Library is displayed.

    success_message.png

    The Module Library can now be used in any Template.

    Note

    When you add or edit a Module and then Publish a new version of it, the version number of the corresponding Module Library gets incremented.

    2023-10-18_21-40-51.png

  4. Click Release edition, allows other users to pick up this Module Library for edition.

    release_edition.png

    Note

    For more information on the Export/Import of Module Libraries from Json, click here.

Deleting a Module and/or Module Library

To delete a Module:

  1. To delete a Module, click Decommission as shown below.

    deleting_a_module.png

    A confirmation message is displayed.

  2. Click Decommission.

    Decommisiion_button.png

    The Module is deleted.

    module_deleted.png

To delete a Module Library:

  1. To delete a Module Library, click Decommission as shown below.

    deleting_a_module_library.png

    A confirmation message is displayed.

  2. Click Decommission.

    confimration_message_module_library.png

    The Module Library is deleted.

    Module_library_deleted.png

Note

Although the Module library is deleted from the list above, it will still be available to Templates currently using it.

final_result.png
In this section: