Creating a new research project

Creating a new research project#

New research project is created by sending a project:start message to Tutkimusmoniviestin. Tutkimusmoniviestin responds with either project-completed or project-error message. Only one project can be created per Vasara process. For every project:start message, there should always be either project-completed message, project-error message with invalidFormat error code, or project-cancelled message. Otherwise the project creation doesn’t stop properly.

../../_images/project-flow.svg

Create new research project#

Message sent from Vasara to Tutkimusmoniviestin to create a new research project.

properties

  • messageName

Vasara:OSC:MVRE:project:start

  • inputParameters

properties

  • title

Project title

type

string

  • description

Project description.

type

string

  • expires

Project expiration date in Camunda format.

type

string

examples

2020-12-31T23:59:59.000+0000

  • users

JSON list of users to add.

type

array

items

user_

user#

properties

  • username

JYU email in short format

type

string

examples

erkesimerk@jyu.fi

  • expires

User expiration date in the project in Camunda format

type

string

examples

2028-12-31T23:59:59.000+0000

  • isOwner

Is the user a owner in the project.

type

boolean

All users with isOwner set to true can add, edit and remove project users. They can also add and remove users from owners.

Project created successfully#

Message sent from Tutkimusmoniviestin to Vasara if the project is created successfully.

properties

  • messageName

MVRE:OSC:Vasara:project-completed

Project creation failed#

Message sent from Tutkimusmoniviestin to Vasara if the project creation fails.

properties

  • messageName

MVRE:OSC:Vasara:project-error

  • outputParameters

properties

  • errorCode

Code defining the error type

type

string

enum

invalidFormat, invalidTitle, groupExists, projectExists

  • errorMessage

Message describing the error

type

string

Error code can be invalidFormat, invalidTitle, projectExists or groupExists. In case of invalidFormat error, there is problems in input parameter formatting. To retry, new project:start message should be sent with valid inputs. In all other cases, project-title message should be sent with a new title. Alternatively, in case of invalidTitle, projectExists or groupExists, project creation cand be cancelled by sending project-cancelled message.

Update invalid project title#

Message sent from Vasara to Tutkimusmoniviestin to update invalid project title.

properties

  • messageName

Vasara:OSC:MVRE:project-title-updated

  • inputParameters

properties

  • title

New project title

type

string

After receiving project-error message with invalidTitle, groupExists or projectExists error code, project-title message is used to try again with a new title. Sending project-title message results either in project-completed or a new project-error message.

Cancel project creation#

Message sent from Vasara to Tutkimusmoniviestin to cancel the project creation.

properties

  • messageName

Vasara:OSC:MVRE:project-cancelled

After receiving project-error message with invalidTitle, groupExists or projectExists error code, project-cancelled message can be used to cancel the project creation.

Sisällys