AddCyclePeriodNote macro

The AddCyclePeriodNote macro is used to add a note related to the current cycle period. This macro is executed at cycle period level.

For executing the macro, the value in the Command field must be specified in this format:

AddCyclePeriodNote(Note Type, Priority, Summary, [Detail], [Post to Mingle], [Mingle Group])
Note: The optional parameters are specified in [ ].

This table lists the parameters that are used to execute the macro:

Parameter Name Description
Note Type The type of note to be created. This must be an Enabled note type with Log format.
Priority The priority of the note to be created. Possible values:
  • High
  • Medium
  • Low
Summary The summary text for the note to be created.
Detail The detailed description for the note to be created.
Note: If this value is not specified, the note is created without detailed text.
Post to Mingle Indicates whether the note is posted to mingle for the current user. Possible values:
  • True
  • False
Note: If this value is not specified, the note is not posted to mingle.
Mingle Group Indicates the mingle group to which the note is posted.
Note: 
  • This parameter is applicable when Post to Mingle is set to True.
  • If this value is not specified, the post is added to the user stream only.
  • If the specified mingle group cannot be resolved, the post is added to the user stream only.

This table lists the examples of the AddCyclePeriodNote macro:

Requirement Syntax
Add an Overview log note type with priority = Low with detail. AddCyclePeriodNote("Overview","Low","Approval status","Confirming the approval process with the team").
Add an Overview log note type with priority = Low and post to Ming.le group "planners". AddCyclePeriodNote("Overview","Low","Approval status", "Confirming the approval process with the team","true","planners").
Add an Overview log note type with priority = High and post to the executing user's Ming.le feed. AddCyclePeriodNote("Overview","High","Approval status", "Confirming the approval process with the team","true","").