Illustration of structure concepts

Creating a file structure

Click on Main menu > Administration, Data administration > Imports > Attributes, risks and hierarchies.

Creating a structure by importing a file enables you to create :

• Level labels, codes and descriptions
• Labels, codes and descriptions of level values

Level parameters and additional level features can be adjusted directly via the interface.

File rules and formalism

The file structure must be as follows:

• Data must appear on the first tab
• The first line defines the headings for imported or exported information on levels and level values. The labels of these columns must be defined in the labels administration. The default is : VN_Label, VN_Code, VN_Description
• The second line defines level labels, codes and descriptions.
• The following lines define the level value tree
• All parents must be listed for each structure value on each line.
• No blank lines

Limitations

The import mechanism does not allow structure codes or structure level codes to be updated.

In the example, we cannot create a structure value under "EUROPE" by import.

If the list of levels does not match the content of the structure : error message

Advice / Procedure

We recommend that you proceed as follows to create an import:

1. Creation in Project Monitor structure and properties
2. Creation in Project Monitor levels and their properties
3. Export structure in Excel® format
4. Complete the resulting file with the desired level values
5. Import modified file
6. If necessary, update level value details (code, logo, description)

Modifying a file structure

Modifying a structure by importing a file allows you to modify the labels and descriptions of level values.

Code uniqueness is the entry point:

• Reading an existing code: modification if the file contains a different label or description,
• Read a non-existent code: create a new level.

💡

Example:

The following lines contain the values for the various levels

• Reading B9: code known → structure will be modified to this structure value or lower.
• Compare fields and modify if delta
• Read E9: code known → structure will be modified to this structure value or lower.
• Reading K9: new code → this structure value will be added structure

curl -X GET -H X-PM-LOGIN // User login // H X-PM-PASSWORD:admin "admin
-H X-PM-PASSWORD:admin "http://localhost:8888/MonitorMakerWeb/api/auth/jwt/token" // server address //

Step 2: Launch hierarchy import

curl POST X-PM-LOGIN: // User's login ///
-H Authorization: // Authorization token //
-H Accept:application/json 
-F attachment=@D:/projectmonitor/temp/Hierarchies.xls // Path of file to be imported //
"http://localhost:8888/MonitorMakerWeb/api/import/IMPORT_HIERARCHIE" // Address of hierarchy import WebService //

All levels described in the file are imported, even if they have no associated structure value .

If the level already exists (search by code), then the rest of the information in the file is ignored (no label update).

Blocking errors :

• incorrect header format
• non-existent structure
• incorrect level line

Non-blocking error :

• error on a structure value description line (the entire line is not imported)

The parameter import is only available for parameter creation. This import has no action code. Consequently, it is not possible to modify or delete measurements using this import.

The imported file contains at least the 6 columns detailed in the table.

Click on Main menu > Administration, Data administration > Imports > Attributes, risks and hierarchies.

This import also works for indicators: the expected format is identical.

(*): These last 3 columns are repeated as many times as the parameter is attached.

Principle

User import is only available for user creation. This import has no action code. Consequently, it is not possible to modify or delete actions via this import.

The first 4 columns are mandatory. The columns must be ordered as shown in the table:

In the user import screen

1. Fill in fields common to all imported users.
2. Click on Import a csv xls ldif file top right
3. Select file.

The "users being imported" list fills up, and a tooltip details the errors.

4. Click on Register to trigger the import of users from the list.

Possible errors

• This login is already in use
• The login can only contain letters and numbers (including the following characters: '_', '-','.', '@').
• The e-mail must be in the form chaîne@serveur.extension
• Password is mandatory
• Contact Virage Group to acquire additional licenses

Principle

Attribute import is only available for attribute creation. This import has no action code. Consequently, it is not possible to modify or delete attributes via this import.

1. Click on Main menu > Administration, Data administration > Imports > Attributes, risks and hierarchies.
2. Click on the Add a file or drag & drop the file to load the file containing the attributes to be imported,
3. Click on the Import to start importing.

During import, attributes in error are not imported and an error message appears in the import report.

Possible errors

• One of the mandatory fields is missing
• Project code with unauthorized characters
• Group or form not created
• List not created for a list attribute
• For a calculated attribute , checkattribute format. Must be numeric.
• If formula with attributes other than accepted format
• break criterion checked on an attribute whose format does not allow it.
• Search criterion checked on an attribute whose format does not allow it.
• Quick search criterion checked on an attribute whose format does not allow it.

List of fields

2.1 Project creation principle

Projects can be created either by :

• Application interface (single-project case)
• An Excel file import (XLS, XLSX) (multi-project case)
• Web services (single or multi-project)

In the case of creation by interface, we create project by project. Operating modes can be :

• Creation from a blank structure
• Duplicating an existing project
• Creation from a project template: enter the code of the project template technicalattribute
• MS Project import

If created using Excel® (.xls format), from 1 to N projects can be created in a single import.

Method

There are 2 possibilities for importing projects into Project Monitor :

• Manual: using the controls as a background task
• By webservice in a scheduled task : using curl

The use of either method depends essentially on the objective sought and its frequency:

• One-off creation/modification to Manual
• Weekly or daily changes to cURL / View

Manual import is performed in Administration > Data administration > Imports > Projects.

To track progress :Administration >Advanced settings > Technical configuration > Background commands a background task order

Constraints

Column	Description	Rule
Project* code	Project identification code Text column type	- Mandatory value - A code is unique. - It must contain only numbers, letters or "- " " " _ " " / ".
Project* label	Project label displayed	- Mandatory value - A label is unique - The label cannot be modified.
project manager	Identifying the project manager	- Mandatory value for creation - Optional for modification - Enter user login - A project manager must be a user account - Modifiable if different value
status	project status	- Mandatory value for creation - Optional for modification - Enter the exact value of the status (code or label) - Value must exist in Project Monitor at time of import - Modifiable if different
Start date	Project start date	- Mandatory value for creation - Optional for modification - No change if empty / Modifiable if different value - Cannot be later than end date - Format must be dd/mm/yyyy
End date	Project end date	- Mandatory value for creation - Optional for modification - No change if empty / Modifiable if different value - Cannot be earlier than start date - Format must be dd/mm/yyyy
Description	Project description	- Optional - No change if empty / Modifiable if different value - Modifiable if different value (all previous columns must be added if description is to be modified) - Free text field without formatting
Father project code	Parent project identification code Text column type	- Mandatory value for creation if child project - Project code corresponding to a project already created - Modifiable if different value (all previous columns must be added if description is to be modified)

With progressive scheduling

A column should be added in the last position to enter a smoothing start date for the remaining work.

Special rules :

• One line per structure link per project. There may therefore be several lines for a single project.
• structure link values from a line to a project is done either by code or label.
• When importing a project that already exists in the database, all connections are reset. This means that any values modified in the application are erased in favor of those in the import file.

Column	Description	Rule
Project* code or name	Project identification code or project name	- Mandatory - It is preferable to work on the project code
structure	Indicates that the project is attached to a given structure .	- Mandatory - Enter either the structure value or the structure code
Level	Used to indicate the project's lowest structure link level for a given structure . The structure link level is not necessarily the lowest structure level. E.g.: an A project can be linked to the Country level, and a B project to the City level of a geographic structure .	- Mandatory - Enter either the value or the code - The level must be declared as a structure link level in the application.
structure value	Indicates the value to which the project is attached.	- Mandatory - Enter either the value or the code - The structure value must exist in Project Monitor at time of import

Special rules :

• One line per user and per project. There can therefore be several lines for a single project.
• structure link values from a line to a project is done either by code or label.
• When importing a project that already exists in the database, all assignments are reset. This means that users who have been modified in the application are erased in favor of those mentioned in the import file.

SPECIAL CASE OF "DIFF" MODE

If you wish to use the file for updates, you can apply different rules by adding the suffix "DIFF" to the "EQU" tab (e.g. EQU_import_DIFF).

In DIFF mode :

• All users are not reset by default.
• If a line specifies only the role code, all user attachments are deleted (useful for resetting to zero if necessary).
• If a line specifies the role code and the user code, it is added to the existing ones.

Special rules :

• One line per attribute and per project. There can therefore be several lines for a single project.
• structure link values from a line to a project is done either by code or label.
• It is not possible to import a technical attribute .

Special rules :

• This tab shows all project phases and milestones.
• One line per planning object and per project. There can therefore be several lines for a single project.
• structure link values from a line to a project is done either by code or label.
• The presence of the planning tab activates the project planning module.
• When a phase is created, its duration must be greater than or equal to 1 day.

*Les valeurs attendues pour le < code type dépendance > sont :

• "FD" corresponds to the "End-Start" type
• "DD" corresponding to the "Start-Start" type
• "FF" corresponds to the "Fin-Fin" type
• "DF" corresponds to the "Start-End" type
• The value of this code is only required if a project code is also entered.
• If no value is entered, the default value is "FD".
• Here are a few examples:

• Here are some incorrect examples:

N.B.: Project Monitor does not check dependency links during import

Special rules :

• N lines per indicator and per project. Eachindicator line shows the completed indicator for a given period . There may be several lines for a single project.
• If no phase is specified, theindicator is assigned to the project phase (this applies in particular to indicators with no phase).
• The presence of the indicator tab activates this module in the project.
• If we import the "ACT-" / "IND-" and "PLAN" tabs (in this precise order) then the values in the "reference" andtarget finaltarget columns of "IND-" will be overwritten by the values in the "reference" andtarget finaltarget columns of "PLAN". For the purposes of this import, therefore, the "reference" andtarget finaltarget columns of "IND-" need not be filled in.
• If we import the "ACT-" / "PLAN" and "IND-" tabs (in this precise order) then the values in the "reference" andtarget finaltarget columns of "PLAN" will be overwritten by the values in the "reference" andtarget finaltarget columns of "IND-". For the purposes of this import, therefore, the "reference" andtarget finaltarget columns of "PLAN" need not be filled in.

Special rules :

• N lines per indicator and per project. Eachindicator line shows the completed indicator for a given period . There may be several lines for a single project.
• If no phase is specified, theindicator is assigned to the project phase (this applies in particular to indicators with no phase).

Special rules :

• n lines per budget and per project. Each budget line shows the completed budget for a given period . There may be several lines for a single project.
• If no phase is specified, the budget is allocated to the project phase (this applies in particular to budgets with no phase).
• The presence of the budget tab activates this module on the project.

Special rules :

• In this tab, all project tasks are listed
• One line per task and per project. There can therefore be several lines for a single project.
• structure link values from a line to a project is done either by code or label
• Presence of task tab activates project planning module

The budget import is only available for creating budget measures. This import does not have an action code. Consequently, it is not possible to modify or delete measures using this import.

(*): These last 3 columns are repeated as many times as the budget is attached.

Invoice import works on projects with the revenue module enabled. If the revenue module is not activated on the project being imported, an error is displayed.

Creation or modification based on the existence of the invoice according to its code.

Quotation import works on projects where the revenue module is activated. If the revenue module is not activated on the project being imported, an error is displayed.

Creation or modification based on the existence of the quote according to its code.

Import does not work with CancelAndReplace on envelopes: DELETE is required to delete envelopes.

With regard to envelope budgets, if budgets are not specified in the import, these budgets are deleted from theenvelope concerned after import: the deletion order only concerns the envelope object.

The cancelAndReplace command concerns the envelope object: there is noenvelope destruction without an import request. On the other hand, any data contained in theenvelope not specified by the import will be ejected: the cancelAndReplace command therefore affects the contents of theenvelope , but not the list of envelopes.

If the financial document does not exist :

• It is created automatically.
• Assignment to project or phase is automatic on import
• When importing a distributed financial document ,
• The distribution displayed in the financial document is always "manual", even if the distribution mode is different in thebudget category .

If the financial document does not concern a project :

• If there is no project code in the import, then financial documents are created without a project and appear in thebudget theme without a project (Budget management > Financial documents > Filter = No project).
• If the financial document has the wrong project code, it is not created.

If a parameter has not been assigned within the project and is present in the import file, assignment is performed automatically. If representation values (e.g. target) are not specified in the import file, the default value is "0" (zero).

The import does not work in cancelAndReplace : the DELETE command must be given to delete budget allocations to phases.

The imported file contains at least the 18 columns detailed on the next page.

If during import the line does not have the same distribution as that specified by the import, an error is output and the line is ignored by the import.

A budget request import can update requests already created on your platform.

Cases of error :

• SI: the budget plan has no assigned budget parameter and we enter budget code A in the import file.
• THEN the following error message is displayed: The amounts are included in budget code A in the project request.
• IF: the budget plan has an assigned budget parameter A and we enter budget code B in the import file.
• THEN the following error message is displayed: The budget plan does not contain the budget code: B - ERROR
• IF: the budget plan has an assigned budget parameter A and we enter budget code B in the import file, and budget parameter B is not assigned to the project.
• THEN the following error message is displayed: No budget allocated to the project. Resource code read: B, phase : _PROJET_ - ERROR

Resource import is only available for resource creation. This import has no action code. Consequently, it is not possible to modify or delete actions via this import.

(*): These last 3 columns are repeated as many times as the resource is attached.

The activity input import works on projects with the resource module enabled. If the resource module is not activated on the project being imported, an error is displayed. Resources must also be present in the project. The project must also have been started.

Finally, for the import to work, you need :

• Go to the resource parameter structure parameter structures
• Check that the is daily timesheet

The import of remaining work works on projects with the resource module enabled. If the resource module is not activated on the project being imported, an error is displayed. Resources must also be present in the project. The project must also have been started.