1. Preamble
1.1 Purpose of the document
This document describes how to use the Project Monitor on the Zapier workflow tool.
1.2 Editorial agreement / glossary
Term | Description |
PM | |
API | Application Programming Interface |
REST | Representational State Transfer |
HTTP | Hyper Text Transfer Protocol |
1.3 Architecture principles
The application Project Monitor uses web services. Detailed documentation on web services is available at :
Webservices memo
2. Zapier
2.1 Presentation
Zapier is an automation tool for interconnecting web services from different sources. This process is simplified by the use of Zaps, which enable dataexchange between 2 applications.
2.2 Creating an account
The first step is to create a Zapier account. To do this, go to the following address: https: //zapier.com/sign-up/
2.2.1 Licensing
There are several levels of Zapier license. Each license corresponds to a maximum number of tasks (cf. Mémo Zapier - 4.2.1 How to choose a license?) that can be executed per month, a number of Zaps, and a processing time.
For more information, visit https://zapier.com/pricing.
2.3 Interface presentation
Once connected, a menu is available on the left:
2.3.1 Dashboard
This is the home page, displaying the most frequently used applications on the profile.
2.3.2 Zaps
Accesses the list of Zaps defined on the profile.
Private folders
The part Private folders
allows you to create folders to organize your Zaps. This step is optional.
Shared folders
The part Shared folders
is a collaborative space for sharing Zaps.
Trash
Contains all Zaps that have been deleted.
Zaps list
On the right, the list of zaps. The logo on the left is that of the application triggering the Zap. The logo on the right is that of the application receiving the Zap.
The number in the middle is the number of Zap steps. The terminology used by Zapier is number of tasks
. It is important because Zapier licenses are conditional on the number of monthly tasks on the account (cf. Mémo Zapier - 4.2 Licenses).
On the right, the on/off button indicates whether the Zap is active or inactive. An inactive Zap will not be triggered.
Finally, a contextual menu lets you perform actions on a Zap.
- Edit: Allows you to administer Zap (cf.
Mémo Zapier - 4.1 Setting up a Zap).
- Rename: Renames the Zap.
- Share Zap: Allows you to share a link to the Zap (cf.
Mémo Zapier - Shared folders).
- Move to folder : Moves the Zap to a folder created in
Private folders
.Mémo Zapier - Private folders
- Task History: Open the Zaphistory (cf.
Mémo Zapier - 2.3.4 Task history).
- Copy: Creates a copy of the Zap.
- Trash: Deletes the Zap.
2.3.3 My Apps
Regroups all connections to applications defined in Zaps.
You can rename them, test the connection status and connect or disconnect them.
2.3.4 Task history
Regroups all Zaps executions and their states.
Usage tab
For each Zap, you can see its name, the last execution date, the number of Zapier tasks consumed and the number of errors raised by the Zap.
Open in Editor : Redirects to Zap administration (cf. Mémo Zapier - 4.1 Setting up a Zap).
View Task log : Redirects to Zap taskhistory (cf. Mémo Zapier - 2.3.4 Task history).
Task Log tab
Regroups the entire taskhistory for all Zaps defined on the profile.
For each Zap execution, we show its status (successful, failed, filtered), its name, the execution date and the number of associated Zapier tasks.
Click on a line to access the Zap execution details. For each Zap step, you'll find the execution status, the date and, depending on the step, the input and output data, the completion of conditions, etc.
3. Application
Project Monitor
3.1 Compatibility matrix
Project Monitor version | Zapier application version |
Up to 6.5.3.1 | Up to 1.0.2 |
From 6.5.3.2 onwards | From 1.1.1 |
3.2 Presentation
The application Project Monitor provides a number of actions (cf.
Mémo Zapier - 3.5 Actions) and events (triggers) (cf.
Mémo Zapier - 3.4 Triggers) to interconnect with other applications via Zapier.
3.3 Authentication
To be able to use the actions (cf. Mémo Zapier - 3.5 Actions) and triggers (cf.
Mémo Zapier - 3.4 Triggers) of the application, authentication is required. To do this, when selecting the application
Project Monitor in a Zap, you are presented with a login screen.
The login and password are those used to connect directly to the platform. Project Monitor.
The UP field must contain the code of the UP to which the user connects on the platform. Project Monitor. This field is optional, but is necessary if there are duplicate users on 2 UPs.
The URL field is the one entered in the browser to access the platform. Project Monitor. Only the part between
https://
and .p-monitor.com
.
This form allows you to retrieve the authentication token Project Monitor.
3.4 Triggers
A trigger is an event completed by an application that triggers the execution of a Zap. When a trigger is used, a webhook is automatically configured in Project Monitor.
3.4.1 List of triggers
Project Monitor
3.4.1.1 New Project
Event triggered when a project is created on the user's login up.
Data provided by the trigger :
Field | Description |
Id | Identifier |
Code | Project code |
Title | Project title |
Description | Project description |
LongTitle | Long project title |
ExternalReference | External project reference |
ExternalApplicationCode | External project application code |
StateTitle | Project status |
StateCode | Project status code |
ProjectManagerLogin | Login of the user assigned as project manager |
ProjectManagerName | First and last name of user assigned as project manager |
ModificationDate | Project modification date (timestamp: 1600781172177) |
BeginDate | Project start date (timestamp: 1600781172177) |
EndDate | Project end date (timestamp: 1600781172177) |
CreationDate | Project creation date (timestamp: 1600781172177) |
TemplateCode | template code used to create the project |
TemplateId | Id of the template used to create the project |
You'll also find logins for all team members assigned to the project, as well as project attachments and attributes.
3.4.1.2 Updated Project
Event triggered when a project is modified on the user's login up.
Data provided by the trigger :
Field | Description |
Id | Identifier |
Code | Project code |
Title | Project title |
Description | Project description |
LongTitle | Long project title |
ExternalReference | External project reference |
ExternalApplicationCode | External project application code |
StateTitle | Project status |
StateCode | Project status code |
ProjectManagerLogin | Login of the user assigned as project manager |
ProjectManagerName | First and last name of user assigned as project manager |
ModificationDate | Project modification date (timestamp: 1600781172177) |
BeginDate | Project start date (timestamp: 1600781172177) |
EndDate | Project end date (timestamp: 1600781172177) |
CreationDate | Project creation date (timestamp: 1600781172177) |
TemplateCode | template code used to create the project |
TemplateId | Id of the template used to create the project |
You'll also find logins for all team members assigned to the project, as well as project attachments and attributes.
3.4.1.3 Deleted Project
Event triggered when a project is deleted on the user's login up.
Data provided by the trigger :
Field | Description |
Id | Identifier |
Code | Project code |
Title | Project title |
ExternalReference | External project reference |
ExternalApplicationCode | External project application code |
3.4.1.4 New Task
Event triggered when a task is created on the user's login up.
Data provided by the trigger :
Field | Description |
Id | Identifier |
Title | task title |
Description | task description |
ExternalReference | External task reference |
ExternalApplicationCode | External task application code |
StateTitle | task status |
StateCode | task status code |
PriorityTitle | task priority |
PriorityCode | task priority code |
ProjectExternalReference | External reference for the task project |
ProjectId | Identifier |
ProjectTitle | task project title |
CreatorLogin | Login of the user who created the task |
AssignedLogin | Login of the user assigned to the task |
ModificationDate | task modification date (timestamp: 1600781172177) |
BeginDate | task start date (timestamp: 1600781172177) |
TargetBeginDate | Scheduled task start date (timestamp: 1600781172177) |
EndDate | task end date (timestamp: 1600781172177) |
DueDate | task deadline (timestamp: 1600781172177) |
task attributes are also included.
3.4.1.5 Updated Task
Event triggered when a task is modified on the user's login up.
Data provided by the trigger :
Field | Description |
Id | Identifier |
Title | task title |
Description | task description |
ExternalReference | External task reference |
ExternalApplicationCode | External task application code |
StateTitle | task status |
StateCode | task status code |
PriorityTitle | task priority |
PriorityCode | task priority code |
ProjectExternalReference | External reference for the task project |
ProjectId | Identifier |
ProjectTitle | task project title |
CreatorLogin | Login of the user who created the task |
AssignedLogin | Login of the user assigned to the task |
ModificationDate | task modification date (timestamp: 1600781172177) |
BeginDate | task start date (timestamp: 1600781172177) |
TargetBeginDate | Scheduled task start date (timestamp: 1600781172177) |
EndDate | task end date (timestamp: 1600781172177) |
DueDate | task deadline (timestamp: 1600781172177) |
3.4.1.6 Deleted Task
Event triggered when a task is deleted on the user's login up.
Data provided by the trigger :
Field | Description |
Id | Identifier |
Title | task title |
ExternalReference | External task reference |
ExternalApplicationCode | External task application code |
3.4.2 Using a trigger
3.4.2.1 Configuring a zap
The first step is to create a new zap with a trigger as its starting point. Project Monitor.
For example, in the Choose App & Event
we select the application Project Monitor and the trigger
New project
.
The next tab is the Choose account
to enter the application's connection information Project Monitor. It is possible to select an account already entered in the list.
My Apps
(cf. Mémo Zapier - 2.3.3 My Apps) or add an account directly (cf.
Mémo Zapier - 3.3 Authentication).
The next tab Customize Project
displays a field to be filled in with the name of the webhook to be created. It's advisable to use an explicit name, and to avoid duplicates between 2 Zaps.
The next tab Find Data
allows you to test the trigger configuration. To do this, click on the blue button Test trigger
. If the webhook has worked, Zapier will find a request (this is the object you've just created). If this step works, your trigger configuration is complete. You can now add any action you like to the trigger.
3.4.2.2 Webhook management
For more information on how webhooks work, there's a webhook memo on our community site.
Creating and deleting webhooks in Project Monitor is automated and depends on the state of the Zaps. Activating a Zap creates a webhook, and deactivating it deletes it (and all its configuration).
View webhooks in Project Monitor
In the administration of Project Monitorclick on the map
Webhooks
(in the category Config. Platform
).
The list of created webhooks is displayed. Click on a webhook to view it.
This screen shows the url automatically filled in from Zap. It is completed by the fields you wish to pass to Zapier.
Creation/modification trigger: OBJECT.ID only. Zapier will use the task or project ID to load the rest of the fields.
Delete trigger : As the object is deleted, it is not possible to load all its fields from its identifier. You can, for example, pass the information OBJECT.ID, OBJECT.LIBEL, OBJECT.REFERENCEEXTERNAL or OBJECT.CODEAPPLICATION. The last 2 fields can be very useful if you want to do bidirectional work. For example, a task initially created in Trello (and therefore created in Project Monitor), which you then wish to reinject into Trello according to the changes in
Project Monitor.
Here is an example of how to set up a deletion:
The full url is :
Note that you can filter the objects triggered by the Event
.
If the filters on this screen aren't enough, you can also add filters directly in Zapier. Just because a webhook notification is sent doesn't mean you have to use it.
3.4.2.3 Creating an object in
Project Monitor
To test the webhook you want to define, you need to create an object. You can delete it later; it's simply a test to validate the zap entry point.
3.5 Actions
An action is an event received by an application that can terminate the execution of a Zap.
3.5.1 Prerequisites
3.5.1.1 Project template management / Attachments
Version 1.1.1 of the Zapier application Project Monitor now lets you enter attachments directly in theaction configuration.
It is still possible to use templates to fill in attachments. For the same structure, the template, the zap, takes over.
In order to manage project attachments in Project MonitorIt may be necessary to create a project template . This template must be entered in the zap actions so that
Project Monitor can create the project with the right information.
View mandatory links
In the administration of Project Monitorclick on the map
Hierarchies
(in the category Reference systems
).
The list of platform repositories is displayed. The last column Mandatory project or action
indicates whether the structure link is mandatory for projects.
In the case of a mandatory structure link , you'll need to check that it's possible to use this structure link in templates.
Click on the structure link in question.
The structure link configuration screen appears. Click on the structure sheet
and checks that the structure link is Optional
or Mandatory
for Project templates
. If it isn't, modify it accordingly and save.
Create a template
Go to theme settings Project
.
Click on the map Project templates
.
A list of existing templates appears, click on the add button.
Fill in the required fields, at least :
- Label ( template name)
- Code (to be used in Zaps)
- Attachments
It is possible to create multiple templates for project creation via Zapier. All you need to do is configure the Zaps to use the relevant templates according to the data.
3.5.1.2 Supportedattribute type
In Project Monitortasks and projects can have attributes of various types. Here is the list of types supported (or not) by the application's actions
Project Monitor via Zapier.
attribute type | Support |
Chain | Yes |
Multi-line | Yes |
Boolean | Yes |
Digital | Yes |
Date | Yes |
List | Yes |
Image | No |
Document | No |
3.5.2 List of actions
Project Monitor
3.5.2.1 Create Project
Create a new project in Project Monitor.
Create Project
Create Project
Project creation uses the following fields:
Zapier | Description | Monitor project |
Title | Project title (required) | Wording |
Description | Project description | Description |
Project Code | Code | Code |
Start Date | Project start date (required) | Start date |
End Date | Project end date (required) | End date |
Project Manager Login | Identifier | project manager |
State Code | Project status | status |
Template Code | Code for template v to be applied to the new project. | current project template |
External Reference | Project identifier in external application. If left empty, the project can be modified and/or deleted via the code | Internal field |
Source Application | External application code (mandatory) | Internal field |
Custom Attributes | List of attributes associated with the project | form >> attribute |
Reference Links | List of project links | form >> CODE_HIERARCHY |
Create Project
General tabCreate Project
Templates tabThe project is created in Project Monitor with input information.
3.5.2.1.1 'Custom Attributes' field details
Each attribute must be on a single line. In the first field, enter theattribute code. In the second field, enter theattribute value. The value changes according to the type ofattribute :
- For a string type: Enter the string ;
- For a multiline type: Enter the character string ;
- For a Boolean type: Enter 'True' or 'False'.
- For a numeric type: Enter the number
- For the date type: Enter the timestamp
- For list type: Enter the code of the list value (the list must also have a code)
It is perfectly possible to use results extracted from previous triggers or zap actions.
3.5.2.1.2 Details of the 'Reference Links' field
Links must be transmitted in the same way as attributes. Each structure link must be on a single line. In the first field, enter the structure code. In the second field, enter the structure value code, or the level value codes separated by commas.
3.5.2.2 Update Project
Modify an existing project in Project Monitor.
Editing a project uses the following fields:
Zapier | Description | Monitor project |
Title | Project title (required) | Wording |
Description | Project description | Description |
Project Code | Code | Code |
Start Date | Project start date | Start date |
End Date | Project end date | End date |
Project Manager Login | Identifier | project manager |
State Code | Project status | status |
External Reference | Project identifier in external application. If left blank, the Project Code must be filled in. | Internal field |
Source Application | External application code (mandatory) | Internal field |
Custom Attributes | List of attributes associated with the project | form >> attribute |
Reference Link Mode | 0 = No change to project links
1 = Reference Links attachments added
2 = Replacement by attachments designated by Reference Links | |
Reference Links | List of project links | form >> CODE_HIERARCHY |
Update Project
Update Project
General tabThe project is well modified in Project Monitor with the input information. Empty fields are ignored.
3.5.2.3 Create Task
Creates a new task in Project Monitor.
task creation uses the following fields:
Zapier | Description | Monitor project |
Title | task title (required) | Subject |
Description | task description | Message |
Project Code | Code | Project |
State Code | task status | Status |
Priority Code | task priority | Priority |
Type Code | task type | Type |
User Assigned Login | Identifier | Members >> Assigned |
Sender login | Identifier | Members >> Issuer |
Due date | taskdeadline | Code and target dates >> For the |
External Reference | task identifier in the external application. If left empty, the task can be modified and/or deleted using the task identifier. | Internal field |
Source Application | External application code (mandatory) | Internal field |
Custom Attributes | List of attributes associated with the task | Attributes >> attribute |
Create Task
Create Task
The task is created in Project Monitor with input information.
3.5.2.4 Update Task
Modifies an existing task in Project Monitor.
Modifying a task uses the following fields:
Zapier | Description | Monitor project |
Title | task title (required) | Subject |
Description | task description | Message |
Project Code | Code | Project |
State Code | task status | Status |
Priority Code | task priority | Priority |
Type Code | task type | Type |
User Assigned Login | Identifier | Members >> Assigned |
Sender login | Identifier | Members >> Issuer |
Due date | taskdeadline | Code and target dates >> For the |
External Reference | task identifier in external application. If left empty, the Task id must be filled in. | Internal field |
Task id | Identifier | Internal identifier |
Source Application | External application code (mandatory) | Internal field |
Custom Attributes | List of attributes associated with the task | Attributes >> attribute |
Update Task
Update Task
The task is modified in Project Monitor with the input information. Empty fields are ignored.
4. Zaps
4.1 Setting up a Zap
4.1.1 Defining the start trigger
Login :
Customize trigger conditions, here we want to filter the activity (we only want a trigger for a project creation). For your information, there's also the Filter by Zapier
to filter data in a zap more efficiently, but this increases the number of monthly tasks.
Here you need to create a project to validate that the trigger works properly, then click on Test trigger :
4.1.2 Making associations between target and source systems
Let's take the example of a project or task creation in Trello that needs to be reflected in Project Monitorsome data exist in both Trello and
Project Monitorbut are not described in the same way. (Project status, project manager login, task priority). It is therefore necessary to associate these values to make the zap fully dynamic. To do this, add a new action and use
Formatter by Zapier
.
Formatter by Zapier
In the Transform field, select Lookup table
.
In lookup key, select the field you wish to test. In our example, the field is board closed
which indicates whether the project is open or closed.
This will allow us to associate, depending on the field value board closed
a value corresponding to the status a project Project Monitor.
For board closed = false
then the code will be status
For board closed = true
then the code will be status
.
- The data
status
come from theget_data
but you can type them directly into this field if you know the status codes.
Once associated, the value deduced can be used in the application's project creationaction Project Monitor :
4.1.3 Defining an action
A zap must end with an action, in this case theaction new project
in Project Monitor. The goal is for Trello data to be dynamically retrieved in
Project Monitor.
The data title
, description
and project code
are data taken directly from Trello. Simply click in a field and click on the data you wish to associate with it.
The data state code
is an associated datum as seen in Mémo Zapier - 4.1.2 Making associations between target and source systems it is deduced using Zapier formatter. To select it, click in the field.
The field Application source
is compulsory, it defines the application that produced the trigger (in this case, Trello).
It is also possible to enter attributes Project Monitor in the last field, the number of attributes is unlimited and all types are accepted except file typesDocument). The following syntax must be observed:
CODEATTRIBUTE=VALUEATTRIBUTE
. In the example, this is attribute list or _TEST_ATT_3
is a list value code.
4.2 Licensing
For details of prices and types of Zapier licenses go to https://zapier.com/app/billing/plans
4.2.1 Choosing a license
A number of factors need to be taken into account:
- The number of zaps you plan to use ;
- The applications you wish to use (premier, formatters) ;
- Update time (the free version takes about 15 min, compared with 2 min for the professional version, for example) ;
- The number of Zapier tasks you are planning.
A Zapier task is a zap step. Only the first step (the starting trigger) does not count in a task. For example, if you have 1 trigger, 2 formatters and an action, your zap is 3 tasks.
Let's imagine a project creation zap. You plan to create 1000 projects in a month, i.e. 1000 * 3 = 3000 tasks. You will therefore have used 3000 Zapier tasks, which means that a License of type professionnal
is required. Licenses are fairly flexible, with the possibility of upgrading for a month and then reverting to the previous state.
5. Data protection
Zapier has met the requirements of the EU General Data Protection Regulation (RGPD) since May 25, 2018. You can find all the information about Zapier's RGPD compliance at this address: https: //help.zapier.com/hc/en-us/articles/16737802843661-Is-Zapier-GDPR-compliant