Operations

An action may have one or more Operations. An Operation is like an Edit Check action in Medidata Rave. For example, to add or remove labels from objects. Each type of Operation has a set of related parameters such as the name of the label to add or remove.

Operation

Parameters

Description

Add Label

Label Name

Adds this Label to the Object if it doesn't already have that Label associated with it.

Remove Label

Label Name

Remove this Label from the Object if has that Label associated with it.

Add Comment

Comment Text

Add this comment to the Object. Note that comments may only be added to draft objects such as Forms, Test Cases, Folders and custom objects defined for drafts. This operation is ignored for Projects and Drafts which cannot have comments associated with them.

Clear Property

Property Name

Clears this custom property value for the Object if the value is not already blank.

Cannot be used for actions on Tickets.

Set Property Value

Property Name, and either a Fixed value or an Expression

Sets this custom property to a value for the Object.

A Fixed value is entered using the input appropriate to the custom property's data type — a date picker for a Date property, a list of choices for a Choice property, and so on — so the value is always one the property accepts.

An Expression is a small formula worked out when the Action runs, so the value can depend on the current date, the user running the Action, or another of the Object's own properties. For example, a due date ten days from today is today() + days(10). The expression language is described under Set Property Value expressions; use the Test button in the editor to see what an expression produces before you save.

Setting a value is most useful with a custom property that is reserved for actions, meaning that users cannot edit the value directly. A "Mark as Tested" Action can then record who tested the object and when, and users can only change those values by running the Action.

A Fixed value can be given for any type that has an input, which is every type except Reference and User; an HTML property gets a rich-text editor. An expression can set any custom property except a Reference or a Set.

A User property can only be set by an expression, and only to a person the expression already knows: user, the person running the Action, or another User property on the same object. It cannot be set to a person you pick when you write the Action, and it cannot be set to a number. A wrong number in a Choice property looks wrong, but a wrong user id quietly names a real colleague, and the value is then read as a record of who owns the object.

An HTML value - Fixed or from an expression - is checked when you save it, and again wherever it is shown. Only basic formatting is kept, so anything else in the value is removed before it reaches the page.

Cannot be used for actions on Tickets.

Send Email

Subject of email, List of Project Roles to be informed and/or email addresses, Body of email

When an action is run on a group of objects (including a group containing only 1 object) an email is generated informing users of which objects have been affected. If the target of the action is a draft or draft object such as a Form then the users in the containing project with the roles identified in the "to" parameter will receive the email along with any email addresses listed in the "to" parameter (see note about email addresses).

If the action is run on one or more Projects then the users within the projects with the identified roles will receive the email along with any direct email addresses listed.

Add Ticket

Title of Ticket, Body text of ticket

When an action is run on a group of objects (including a group containing only 1 object) a ticket window is opened once the action has run and the user can choose to save the ticket, modify and save or cancel the creation of the ticket.

If the target of the action is a draft or draft object then the ticket is created with the affected objects added as related objects for the ticket.

Tickets cannot be created for Drafts, Projects or Tickets, only for draft objects.

Tickets will not be created if the action is an auto-action and no window will be shown to create the ticket if the user executing the action does not have permission to add tickets in the project.

Add Role Assignment

Role Name

Assigns the selected objects to all users who have the specified Project Role in the current Project.

This operation can only be used for actions on draft-level objects such as Forms, Folders, Edit Checks, and custom objects. It cannot be used for actions on Drafts or Projects.

Remove Role Assignment

Role Name

Removes the selected objects from the assignments of all users who have the specified Project Role in the current Project.

This operation can only be used for actions on draft-level objects such as Forms, Folders, Edit Checks, and custom objects. It cannot be used for actions on Drafts or Projects.

Remove All Assignments

None

Removes all user assignments from the selected objects. After this operation, the objects will not be assigned to any users or roles.

This operation can only be used for actions on draft-level objects such as Forms, Folders, Edit Checks, and custom objects. It cannot be used for actions on Drafts or Projects.

This operation is typically used in combination with Add Role Assignment or Assign Current User to completely reassign objects. When combining operations, Remove All Assignments must come before any assignment operations.

Assign Current User

None

Assigns the selected objects to the user who triggered the action. The user will have the objects added to their assignments.

This operation can only be used for actions on draft-level objects such as Forms, Folders, Edit Checks, and custom objects. It cannot be used for actions on Drafts or Projects.

Important

When creating a Send Email action, any email addresses in the "to" list of recipients are checked against the domains listed for the organization and the email address will not be accepted if the organization does not control the domain of the email address.

Operations and custom properties

The Set Property Value and Clear Property operations refer to a custom property by name. TrialGrid keeps Actions and custom properties consistent with each other:

  • An Action can have several operations that change the same property. They run in the order they are listed, and the last one to run decides the final value — a Set followed by a Clear leaves the property empty, a Clear followed by a Set leaves it with the set value. Each change is recorded separately in the object's activity.

  • Deleting a custom property removes any Set Property Value and Clear Property operations that refer to it, from every Action in the URL. The Actions themselves, and their other operations, are not affected. The message shown when the property is deleted tells you how many operations were removed.

  • Changing the data type of a custom property is not permitted while an Action would be left setting a value that is not valid for the new type. For example, a DateTime property whose value is set by the expression now() cannot be changed to a Date, because now() produces a date and time; and a property set by a Fixed value cannot be changed to a type that would reject that value. The error message names the Actions concerned; change or remove the operations first, then change the data type.