Required Objects and Properties#

The annotations module is required. To enable object-comments, both the Comments and Employee modules are required. The required objects and properties for each module are listed below.

Comments Module#

Syntax

Description

Comment Object

In order to enable the extended comment functionality, a dedicated Comment object is required.

Author property

A comment object will maintain a reference to an Author, this needs to be facilitated by a Lookup or Multi-select Lookup property pointing to an Employee.

Content property

A comment requires a Content property to hold its contents. This must be a Multiline text property.

Guid property

A comment requires a special Guid maintained by CtrlPortals. This must be stored in a plain text property.

Parent Guid property

A comment requires a reference to its parent’s Guid (if any). This must be stored in a plain text property.

Parent Object property

A comment requires a property to refer to its parent object (if any). This must be stored in a lookup- or multi-select lookup property.

Mentions property

A comment requires a property so that it can contain a comment’s mentions of other Employees (the ones gathered with the @-syntax). This property must be a multi-select lookup that references the list of Employees (employee objects).

Comments Module Setup

Employee Module#

Syntax

Description

An Employee object

In order for comments to identify Authors, an Employee object is required.

User property

An employee object must refer to an exact user through a lookup property pointing to a user account.

Image property

An employee object can contain the base64 representation of an image in a Multiline Text property.

The comments module is optional, but if it is to be enabled, all of the above comment module’s objects and properties must be implemented.

Calendar Module#

See Calendar module for optional objects and properties required for enabling the calendar functionality.