View Modules

The 4P platform hosts a collection of computation modules to process data. These modules can then be chained in a macro.

Note

Users with no PHIS account do not have access to the list of modules.

List of Modules

To open the list of available modules in 4P, click the Modules item in the main menu of the application.

Modules are organised in a table, ordered by Name. The table displays the following information about each module:

• Name: its general name

• Vector: the vector(s) which the module is compatible with

• Inputs: the list of input parameters (red parameter means it is mandatory, gray optional)

• Outputs: the list of output data generated by the module

• Status: the module status, whether it is published, archived or in a draft version

• Integration: the module integration state, whether it is integrated, in error or running

Note

Published modules are visible by every users of the platform, whereas draft modules only by their authors. Archived modules are visible only by super-administrators.

Hint

Each column of the table can be filtered so as to reduce the number of displayed modules.

Details of a Module

Click a row in the list of modules to open its details page showing additional information.

In addition to displaying the same information as in the list of modules, the details page presents the following elements:

• Species: The list of species that are compatible with this module

• Author: The name and email of the user who created the module

• Technical guide: A link toward technical documentation about the current module

• Integration status: The status of the module integration process (Integrated, Not integrated, Running or Failed)

• Macros using this module: The list of macros using the current module in their workflows

• Previous version: If the module is a duplicated version of another one

The Inputs box displays the list of input parameters of the module command line. For each parameter the table shows the prefix preceeding the value in the command line, the label, type and default value.

The Outputs box displays the list of output data generated by the module. For each output the table shows the label, the type, the conditional parameter and value.

Hint

The conditional parameter is one of the input parameters of type boolean. The output is generated only when that parameter is true.

Actions on a module

A series of actions are available on each module.

• It is possible to Modify a module when it is in draft mode (i.e. not published), and when the integration process is over.

• We can Duplicate a module which creates a draft and editable copy of it. This option is used when a module version becomes obsolete.

• Only draft modules can be Deleted.

In addition, it is possible to restart the integration process using the Restart integration button next the the integration status. This option is available when the module is in draft mode only.

Publish a module

Only users with super-administrator privileges can publish a module. Once published, it is visible and usable by all users of 4P and can not be deleted nor modified. Super-administrators have access to the following advanced actions:

• Publish: Publish an element by making it final and visible by all users of the platform

• Archive: Archive an element by hiding it from all users of the platform

• Unpublish: Unpublish an element by making it back to a draft state

• Unarchive: Unarchive an element by making it back to a published state

Hint

Modules, Data types and Macros offer the same publication control by super-administrators