Question 1

Task mail integration

Accepted Answer

Articles on: API

You enable a project email address to receive emails and create tasks from them.

When using this email, you can either respond to a task (a comment is added) or create a new task.

You company needs to have enabled the Task mail plugin

Enable plugin

The plugin is enabled in the project settings, and you must be an admin to do this.

Go to the project settings
Click on the "Advanced" tab
Click on the "Enbale Task mail"

Project email

The email will have the following format:

project+@api.cxplanner.com

Creating a new task

There are two ways to create a new task. The first is simple, and the second is more complex.

Simple

Write an email and just ensure, that the email-content is the task name. When our API reaches the first new line, it will stop parsing the mail.

Send to: project+@api.cxplanner.com Subject: My new task Body: This lines is included And this line But this line is not included due to newline before

Complex

The complex way gives you more control over the task. You can add a longer name with line breaks, and you can set the status and assign people.

The example below will:

Create a task
Set the status to "Active" (if that status exists)
Assign the task to Thomas T (if that person exists and is a member of the project).

``` Send to: project+@api.c

Question 2

Access API area

Accepted Answer

Articles on: API

You can integrate CxPlanner with various tools and software solutions.

This article describes how to find your API keys.

||| Do not share you API keys with anyone. They can be used to access your data.

|| You company needs to have enabled the API static key plugin

How to get the API key

You can only access the API area, if you company-role is "Administrator".

Click on you avatar in the top right corner
Click on "API Keys"

Rate limit

The API is limit to 30 calls (POST/GET) per minute. More than that will result in a connection error.

Updated on: 09/01/2023

Question 3

Add a new project

Accepted Answer

If you have access to it, you can add new projects to your company-platform. Navgiate to Projects in the sidebar.

Add project

The example below can differ from your project, as you can customize the project to your needs and with your own plugins.

Add new project

Clone a template

The little cog-icon in the top right corner of the white box gives you access to clone a template. This is a quick way to create a new project with the same structure as an existing project.

Question 4

Zapier API key

Accepted Answer

Articles on: API

You can integrate CxPlanner with Zapier using an API key.

When integrating CxPlanner with Zapier, you need to provide an API key inside the Zapier integration.

The integration will allow you to create a Zap, that can trigger the creation of new tasks.

How to get the API key

Please follow the instructions in the API area and Create an API key articles.

Giving the API-user access

You have to manually decide which projects the API-user should have access to.

This is a security feature, to prevent the API-user from accessing data, that he/she should not have access to.

Follow the instructions in the Add API-user to project.

Add integration at Zapier

Go to Zapier
Click on "Make a Zap"
Find your initiator (the app that triggers the Zap)
Select CxPlanner as the action app
Provide the API key
Ready to go!

Updated on: 09/01/2023

Question 5

Project introduction

Accepted Answer

When you are working within CxPlanner, it will in most cases be on a project.

Our projects is built around a dynamic structure, which means that you can customize the project to your needs. You can create a specific Quality project, Commissioning project or a Project management project.

Project types

There are three different types of projects:

A normal project which is what you will use most of the time.
A project folder - this is a special module which is used to group projects.
A tender project - this is a special module which opens a limited set of features. It is used to create a tender.

If you are in doubt - always use a normal project

Access to a project

It is only users, who has been added to a project, who can access the project.

There are diffent project roles, which gives different access to the project. That is detailed in the Project roles article.

Project overview

Project overview with add new project buttons

Question 6

Add new task / observation

Accepted Answer

Task, Issue, Deficiency, Observation

To keep it simpel, we'll just call it a task. But a task can be any of these, e.g. a Punch list consists of tasks.

Tasks and Observations

CxPlanner is built around tasks. Tasks can be accessed in various views: table, kanban, schedules, and on floor plans - all showing tasks in different ways.

Which tasks you can see depends on your role in the project.

Create a new task

|| Whether you can create tasks depends on your role in the project, which is adjusted with "Project Role" and "User Groups" in the project settings.

New task button

Overview of a task

You can change the various detail options, floor plans, etc. in the project settings.

Overview of a new task

Frequently Read Articles

Browse All Categories