Registry Notification Command is a command line utility to register a Notification. It is primarily intended to be manually run to perform testing of Notification infrastructure, but can also be used in scripts to register Notifications in a production environment.

Usage

Notification Command is run via cake shell, ie 

$ cd $REGISTRY/app
$ ./bin/cake notification ...
  1. notification [-qvM] -c <coId> -a <actorIdentifier> -A <action> -C <comment> [-g <subjectGroupIdentifier>] [-G <recipientGroupIdentifier>] -m <messageTemplateId> [-r <recipientIdentifier>] [-s <subjectIdentifier>] [-S <source>] -t <typeLabel>

where

  • M: If true, the Notification must be resolved (not acknowledged)
  • action: The Notification Action Code (typically a four character code)
  • actorIdentifier: The Actor Person's Identifier (see Identifier Mapping, below)
  • coId: The CO ID in which to register the Notification
  • comment: The Notification Comment
  • messageTemplateId: The Message Template used for the content of the Notification
  • recipientGroupIdentifier: The Recipient Group's Identifier (see Identifier Mapping, below; used to send to a Group of People)
  • recipientIdentifier: The Recipient Person's Identifier (see Identifier Mapping, below; used to send to an individual Person)
  • source: The Notification source, typically in the form of a URL of the action that generated the Notification
  • subjectGroupIdentifier: The Subject Group Identifier (see Identifier Mapping, below1)
  • subjectIdentifier: The Subject Person's Identifier (see Identifier Mapping, below)
  • typeLabel: The type used for Identifier mapping (see Identifier Mapping, below)

One of recipientIdentifier or recipientGroupIdentifier is required.

Identifier Mapping

For all Person and Group Identifiers, the specified parameter is an Identifier of the type specified by typeLabel associated with the Person or Group.

See Also

Changes From Earlier Versions

As of Registry v5.2.0

  • subjectGroupIdentifier and recipientGroupIdentifier are supported.
  • No labels