notification.coms

Communications notification.

type

object

properties

  • accessedValues

The notification retrieves this list of values, which can subsequently be utilized within the message template.

Default value is [[]]

type

array

default

items

type

string

  • isTemplateGeneratedByOspComposer

Name of the playbook that generated this file. If present, the file is managed by the Composer and may be overwritten on regeneration. Used for selective clean. Do not edit or set manually.

type

string

  • moduleId

The id of the linked communications module

type

string

  • template

The template to use to generate the message

TemplateConfiguration

  • templateId

The id of the template to use for this file

type

string

  • templateVariables

The variables and their values to be replaced from the template

type

object

additionalProperties

  • variablesFiles

The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.

type

array

items

type

string

additionalProperties

False

TemplateConfiguration

type

object

properties

  • locale

The locale to use when generating the messages.

Default value is [“FRENCH”]

type

string

enum

FRENCH, GERMAN, ITALIAN, ENGLISH, JAPANESE, KOREAN, CHINESE, SIMPLIFIED_CHINESE, TRADITIONAL_CHINESE, FRANCE, GERMANY, JAPAN, KOREA, UK, US, CANADA, CANADA_FRENCH

default

FRENCH

  • longMessageTemplateId

Define the template ID to use to generate the body of the email.

type

string

  • objectTemplateId

Define the template ID to use to generate the object of the email.

type

string

  • requestTimeout

he module ‘osp-report’ is responsible for generating notifications. In case this module is not available, a timeout feature is implemented to avoid endless waiting

Default value is [{“unit”:”SECONDS”,”value”:5}]

default

unit

SECONDS

value

5

DurationConfigurationEntity

  • retryDelay

The delay between retry to generate the notification with ‘osp-report’ module (after a failure).

Default value is [{“unit”:”SECONDS”,”value”:5}]

default

unit

SECONDS

value

5

DurationConfigurationEntity

  • shortMessageTemplateId

Define the template ID to use to generate the content of the sms.

type

string

additionalProperties

False

DurationConfigurationEntity

type

object

properties

  • unit

The unit of time expressed

type

string

enum

NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS

  • value

The amount of time expressed with the unit

type

integer

additionalProperties

False