EmailTrigger

Need help? Ask Kademi

An automation rule which fires whenever a named event occurs in an organisation, and performs one or more configured actions. A trigger listens on a single event id and can be narrowed by up to five condition values, which are matched against the corresponding values carried by the event. A condition left null is not compared, so it matches any value on the event, including a null one. An optional condition script, in either the XML rule format or as an MVEL expression, is evaluated as a final check and the trigger only fires if it returns true. Sending an email is only one of the things a trigger can do, and each action has its own enabled flag: it can add the profile to a group or remove them from one, grant a reward, activate an alert, award CPD points, send an SMS, insert a value into a data series, run server side JavaScript, or create a TriggerTimer which re-fires the trigger after a delay. Email is the only action which is on by default, ie when its flag is null.

Group: Database Entities

Extends: BaseEmailJob

Implements: Serializable, Auditable

Properties

Property	Returns	Description
activateAlertEnabled	`Boolean`	Whether firing activates the configured alert. Null means disabled.
active	`boolean`	Whether email items belonging to this trigger may be sent, which is true only while the trigger is enabled and not soft deleted.
addToGroupEnabled	`Boolean`	Whether firing adds the profile to the configured group. Null means disabled.
alert	Alert	The alert activated when the trigger fires, if the alert action is enabled. Lazily loaded.
auditOrg	`Organisation`	Organisation the audit trail for this trigger is recorded against, which is the organisation that owns it.
awardCpdEnabled	`Boolean`	Whether firing awards CPD points against a certificate. Null means disabled.
awardCpdForCert	Certificate	The certificate the CPD points are recorded against. If left null the platform tries to find a certificate associated with the module instead. Lazily loaded.
awardCpdModulePath	`String`	Path of the learning module the CPD award relates to. If left blank the platform tries to derive it from the event, for example using the same module as a module progress event.
awardCpdNumPoints	`Double`	Number of CPD points awarded when the trigger fires, if the CPD action is enabled.
conditionScriptMvel	`String`	Extra condition expressed as an MVEL expression, up to 2000 characters. When present it is evaluated when the trigger matches and the actions run only if it returns true.
conditionScriptXml	`String`	Extra condition expressed in the XML rule format, up to 2000 characters. When present it is evaluated when the trigger matches and the actions run only if it returns true.
createTimerEnabled	`Boolean`	Whether firing creates a TriggerTimer, which re-fires this trigger once the configured delay has elapsed. Null means disabled.
dataSeriesAmountMvel	`String`	MVEL expression which calculates the value inserted into the data series when the data series action runs.
dataSeriesCustomFields	`String`	Custom field values to store on the inserted data series record, held as text of up to 3000 characters.
dataSeriesDateMvel	`String`	MVEL expression which calculates the date the data series record is filed under. Null means the record is dated by the platform rather than by the event.
dataSeriesEnabled	`Boolean`	Whether firing inserts a record into a sales data series. Null means disabled.
dataSeriesName	`String`	Name of the data series the record is inserted into when the data series action runs.
emailEnabled	`Boolean`	Whether the trigger sends its email when it fires. This is the one action which is on by default, so null means enabled; use isEnabledEmail for the resolved value.
enableAlert	`boolean`	Null safe reading of the alert action flag.
enabled	`boolean`	Whether the trigger is switched on. A disabled trigger is skipped when its event fires, and its pending timers are not processed.
enabledAddToGroup	`boolean`	Null safe reading of the add-to-group action flag.
enabledAwardCpd	`boolean`	Null safe reading of the CPD award action flag.
enabledCreateTimer	`boolean`	Null safe reading of the create-timer action flag.
enabledEmail	`boolean`	Null safe reading of the email action flag. Email is on by default, so an unset flag reads as true.
enabledInsertDataSeries	`boolean`	Null safe reading of the data series action flag.
enableGroupRemove	`boolean`	Null safe reading of the remove-from-group action flag.
enableJavascript	`boolean`	Null safe reading of the JavaScript action flag.
enableReward	`boolean`	Null safe reading of the reward action flag.
enableSms	`boolean`	Null safe reading of the SMS action flag.
eventId	`String`	Identifier of the event this trigger listens on, for example a module completion or a group registration. Required, and the main index used when looking up which triggers should fire for an event.
groupToJoin	`Group`	The group the profile joins when the trigger fires, if the add-to-group action is enabled. Lazily loaded.
includeUser	`boolean`	Whether the email should also go to the profile associated with the event which fired the trigger, in addition to the recipient groups and organisations configured on the job.
javascript	`String`	Server side JavaScript run when the trigger fires, up to 10000 characters. It runs in the context of the website named by the JavaScript website property.
javascriptEnabled	`Boolean`	Whether firing runs the trigger's server side JavaScript. Null means disabled.
jsWebsite	Website	Website whose apps and libraries provide the context the trigger's JavaScript runs in. Lazily loaded.
numRewards	`Integer`	Fixed number of reward units, such as points, to grant when the trigger fires. Ignored when a rewards MVEL expression is set, which calculates the amount instead.
numRewardsMVEL	`String`	MVEL expression, up to 2000 characters, which calculates how many reward units to grant, for cases where the amount depends on the event rather than being fixed.
removeFromGroup	`Group`	The group the profile is removed from when the trigger fires, if the remove-from-group action is enabled. Lazily loaded.
removeFromGroupEnabled	`Boolean`	Whether firing removes the profile from the configured group. Null means disabled.
reward	Reward	The reward granted when the trigger fires, if the reward action is enabled. Lazily loaded.
rewardEnabled	`Boolean`	Whether firing grants the configured reward. Null means disabled.
rewardPointsTag	`String`	Name of the points tag the granted points are filed under, so that awards from this trigger can be reported on and expired as a group.
rewardReason	`String`	Text recorded against the points or reward transaction explaining why it was granted, shown to the participant in their transaction history.
sendPreference	`String`	Which channel the trigger prefers when both email and SMS are configured. Sending to both delivers both; the SMS preference falls back to email when the profile has no usable phone number.
smsEnabled	`Boolean`	Whether firing sends an SMS as well as, or instead of, the email. Null means disabled.
smsMessage	`String`	Body of the SMS sent when the SMS action is enabled, up to 1000 characters.
smsProvider	`String`	Name of the SMS provider configuration used to send the message. Null falls back to the organisation's default provider.
timerExpression	`String`	Expression, up to 1000 characters, used to work out the timer fire date instead of the fixed unit and multiple.
timerMultiple	`Integer`	How many timer units the delay lasts, for example 3 with a unit of days means three days after the event.
timerTime	`String`	Time of day, as text, that a created TriggerTimer should fire at. When set, the hour and minute of the calculated fire time are overridden with this value, so a delay of two days can still land at 9am.
timerUnit	`TimeUnit`	Unit of the delay applied when a TriggerTimer is created: hours, days, weeks, months or annual. If it is null no delay can be calculated and the timer fires immediately.
triggerCondition1	`String`	First condition value the event must carry for this trigger to fire, matched against the event's own first trigger item. A null condition is not compared, so it matches any value. Blank values are normalised to null by checkNulls.
triggerCondition2	`String`	Second condition value the event must carry for this trigger to fire, matched against the event's own second trigger item. A null condition is not compared, so it matches any value. Blank values are normalised to null by checkNulls.
triggerCondition3	`String`	Third condition value the event must carry for this trigger to fire, matched against the event's own third trigger item. A null condition is not compared, so it matches any value. Blank values are normalised to null by checkNulls.
triggerCondition4	`String`	Fourth condition value the event must carry for this trigger to fire, matched against the event's own fourth trigger item. A null condition is not compared, so it matches any value. Blank values are normalised to null by checkNulls.
triggerCondition5	`String`	Fifth condition value the event must carry for this trigger to fire, matched against the event's own fifth trigger item. A null condition is not compared, so it matches any value. Blank values are normalised to null by checkNulls.

Inherited from BaseEmailJob

Properties

Property	Returns	Description
assetQueryId	`String`	Identifier of a query asset which selects the content the email is built from. When set, the first asset the query returns supplies the subject, from and reply-to values named by the asset field properties.
attachments	`List<EmailJobAttachment>`	Files attached to every email this job sends. Each attachment refers to blob store content by hash rather than holding the bytes. Null on a job which has never had an attachment added.
category	BaseEmailCategory	Category the job is filed under, used to group related jobs within an organisation. Optional.
deleted	`Boolean`	Soft deletion flag. A job with items or timers against it is flagged deleted and renamed rather than removed, so its history survives. Null means not deleted.
filterScriptMvel	`String`	Recipient filter expressed as an MVEL expression, up to 1000 characters. Recipients the expression does not evaluate to true for are dropped before sending.
filterScriptXml	`String`	Recipient filter expressed as the XML rule format, up to 1000 characters. Recipients the rule does not evaluate to true for are dropped before sending.
fromAddress	`String`	Address the emails are sent from. If blank the sender falls back to the organisation's admin domain, or to a noreply address on the primary domain.
fromAssetField	`String`	Name of the field on the asset selected by the asset query which supplies the from address, overriding the job's own from address when it resolves to a value.
groupRecipients	`List<GroupRecipient>`	The groups this job sends to. Each entry can be an exclusion instead, in which case members of that group are removed from the recipient set rather than added to it. Lazily loaded, and null on a job which has never had a group recipient added.
html	`String`	The email body, held as an MVEL template of up to 500000 characters and evaluated once per recipient.
id	`long`	Database identifier for this job. The subclasses share a single joined inheritance table, so the id is unique across scheduled emails, group emails and triggers alike.
loginTokens	`Boolean`	Whether links in the email should carry an auto-login token for the recipient, so that following one signs them in. Null is treated as false.
name	`String`	Unique, path-safe identifier for the job within its organisation, used as the lookup key and in admin URLs. Required. Soft deleting a job renames it with a '-Deleted-' suffix and a timestamp so the original name becomes available again.
notes	`String`	Free text notes about the job, up to 20000 characters. Copying a job with mimic prepends a 'Copied from' line naming the job it was copied from.
numEmails	`Integer`	Number of emails this job has queued for sending, recorded when the batch is generated so progress can be reported against it. Null before a batch has been generated.
organisationRecipients	`List<OrganisationRecipient>`	The organisations this job sends to, with the same include or exclude semantics as the group recipients. Lazily loaded, and null on a job which has never had an organisation recipient added.
recipientSelectors	`String`	Serialised recipient selection, up to 10000 characters, which is the newer replacement for the group and organisation recipient collections.
replyToAddress	`String`	Address replies are directed to. If blank the from address is used instead.
replyToAssetField	`String`	Name of the field on the asset selected by the asset query which supplies the reply-to address, overriding the job's own reply-to address when it resolves to a value.
subject	`String`	Subject line for the emails this job sends, up to 1024 characters, evaluated as an MVEL template per recipient. If it is blank the sender falls back to a generated subject built from the job title.
subjectAssetField	`String`	Name of the field on the asset selected by the asset query which supplies the subject line. Only consulted when an asset query id is set; the job subject is used if the field is empty.
themeSite	Website	Website whose live branch supplies the surrounding email template. When set, the generated body is wrapped in that site's email theme; when null the MVEL result is sent as-is.
timeToSend	`Date`	The time the job is intended to be sent at. Null on jobs which are not scheduled for a particular time.
title	`String`	Free text display label for the job, shown in the admin UI and used in the fallback subject line. Unlike the name it carries no uniqueness or path-safety guarantee and may be null.
type	`String`	Free text classification set by the caller and carried across when a job is copied. Not the Hibernate inheritance discriminator, which is a separate column the application does not expose.

Methods

asScheduledEmail() · asGroupEmail() · getId() · getName() · getTitle() · getNotes() · getSubject() · getFromAddress() · getReplyToAddress() · getGroupRecipients() · getOrganisationRecipients() · getThemeSite() · getHtml() · getFilterScriptXml() · getFilterScriptMvel() · getAssetQueryId() · getSubjectAssetField() · getFromAssetField() · getReplyToAssetField() · addGroupRecipient(Group g, boolean exclusion) · getType() · getAttachments() · getLoginTokens() · getDeleted() · getNumEmails() · getTimeToSend() · getRecipientSelectors() · deleted() · getCategory() · numEmails()

`asScheduledEmail()`

Returns: ScheduledEmail

Narrows this job to a ScheduledEmail, the recurring job type driven by a frequency and a start date.

`asGroupEmail()`

Returns: GroupEmailJob

Narrows this job to a GroupEmailJob, the one-off broadcast sent to a set of groups or organisations.

`getId()`

Returns: long

Database identifier for this job. The subclasses share a single joined inheritance table, so the id is unique across scheduled emails, group emails and triggers alike.

`getName()`

Returns: String

Unique, path-safe identifier for the job within its organisation, used as the lookup key and in admin URLs. Required. Soft deleting a job renames it with a '-Deleted-' suffix and a timestamp so the original name becomes available again.

`getTitle()`

Returns: String

Free text display label for the job, shown in the admin UI and used in the fallback subject line. Unlike the name it carries no uniqueness or path-safety guarantee and may be null.

`getNotes()`

Returns: String

Free text notes about the job, up to 20000 characters. Copying a job with mimic prepends a 'Copied from' line naming the job it was copied from.

`getSubject()`

Returns: String

Subject line for the emails this job sends, up to 1024 characters, evaluated as an MVEL template per recipient. If it is blank the sender falls back to a generated subject built from the job title.

`getFromAddress()`

Returns: String

Address the emails are sent from. If blank the sender falls back to the organisation's admin domain, or to a noreply address on the primary domain.

`getReplyToAddress()`

Returns: String

Address replies are directed to. If blank the from address is used instead.

`getGroupRecipients()`

Returns: List<GroupRecipient>

The groups this job sends to. Each entry can be an exclusion instead, in which case members of that group are removed from the recipient set rather than added to it. Lazily loaded, and null on a job which has never had a group recipient added.

`getOrganisationRecipients()`

Returns: List<OrganisationRecipient>

The organisations this job sends to, with the same include or exclude semantics as the group recipients. Lazily loaded, and null on a job which has never had an organisation recipient added.

`getThemeSite()`

Returns: Website

Website whose live branch supplies the surrounding email template. When set, the generated body is wrapped in that site's email theme; when null the MVEL result is sent as-is.

`getHtml()`

Returns: String

The email body, held as an MVEL template of up to 500000 characters and evaluated once per recipient.

`getFilterScriptXml()`

Returns: String

Recipient filter expressed as the XML rule format, up to 1000 characters. Recipients the rule does not evaluate to true for are dropped before sending.

`getFilterScriptMvel()`

Returns: String

Recipient filter expressed as an MVEL expression, up to 1000 characters. Recipients the expression does not evaluate to true for are dropped before sending.

`getAssetQueryId()`

Returns: String

Identifier of a query asset which selects the content the email is built from. When set, the first asset the query returns supplies the subject, from and reply-to values named by the asset field properties.

`getSubjectAssetField()`

Returns: String

Name of the field on the asset selected by the asset query which supplies the subject line. Only consulted when an asset query id is set; the job subject is used if the field is empty.

`getFromAssetField()`

Returns: String

Name of the field on the asset selected by the asset query which supplies the from address, overriding the job's own from address when it resolves to a value.

`getReplyToAssetField()`

Returns: String

Name of the field on the asset selected by the asset query which supplies the reply-to address, overriding the job's own reply-to address when it resolves to a value.

`addGroupRecipient(Group g, boolean exclusion)`

Returns: GroupRecipient

Adds a group to this job's recipient list, creating the recipient collection if the job did not have one. The new link is attached to the in-memory job only; it is not saved, so the caller must persist it.

Parameter	Description
`g`	the group to send to, or to exclude
`exclusion`	true to exclude the group's members rather than include them

`getType()`

Returns: String

Free text classification set by the caller and carried across when a job is copied. Not the Hibernate inheritance discriminator, which is a separate column the application does not expose.

`getAttachments()`

Returns: List<EmailJobAttachment>

Files attached to every email this job sends. Each attachment refers to blob store content by hash rather than holding the bytes. Null on a job which has never had an attachment added.

`getLoginTokens()`

Returns: Boolean

Whether links in the email should carry an auto-login token for the recipient, so that following one signs them in. Null is treated as false.

`getDeleted()`

Returns: Boolean

Soft deletion flag. A job with items or timers against it is flagged deleted and renamed rather than removed, so its history survives. Null means not deleted.

`getNumEmails()`

Returns: Integer

Number of emails this job has queued for sending, recorded when the batch is generated so progress can be reported against it. Null before a batch has been generated.

`getTimeToSend()`

Returns: Date

The time the job is intended to be sent at. Null on jobs which are not scheduled for a particular time.

`getRecipientSelectors()`

Returns: String

Serialised recipient selection, up to 10000 characters, which is the newer replacement for the group and organisation recipient collections.

`deleted()`

Returns: boolean

Null safe reading of the soft deletion flag.

`getCategory()`

Returns: BaseEmailCategory

Category the job is filed under, used to group related jobs within an organisation. Optional.

`numEmails()`

Returns: Long

The queued email count as a long, for callers which need a widened value.

Methods

asEmailTrigger() · getEmailEnabled() · getRemoveFromGroup() · getRemoveFromGroupEnabled() · getAddToGroupEnabled() · getGroupToJoin() · getCreateTimerEnabled() · getTimerUnit() · getTimerMultiple() · getEventId() · getConditionScriptXml() · getConditionScriptMvel() · getTriggerCondition1() · isEnabled() · isIncludeUser() · getTriggerCondition2() · getTriggerCondition3() · getTriggerCondition4() · getTriggerCondition5() · getReward() · getNumRewards() · getNumRewardsMVEL() · getRewardEnabled() · getAlert() · getActivateAlertEnabled() · getRewardReason() · getRewardPointsTag() · getAwardCpdNumPoints() · getAwardCpdEnabled() · getAwardCpdForCert() · getAwardCpdModulePath() · getSmsEnabled() · getSmsMessage() · getSmsProvider() · getDataSeriesAmountMvel() · getDataSeriesDateMvel() · getDataSeriesEnabled() · getDataSeriesName() · getDataSeriesCustomFields() · getSendPreference() · getTimerTime() · getTimerExpression() · isJavascriptEnabled() · getJavascript() · getJsWebsite() · checkNulls() · isActive() · isEnabledInsertDataSeries() · isEnabledAwardCpd() · isEnabledAddToGroup() · isEnabledEmail() · isEnabledCreateTimer() · isEnableGroupRemove() · isEnableReward() · isEnableAlert() · isEnableSms() · isEnableJavascript() · getAuditOrg()

`asEmailTrigger()`

Returns: EmailTrigger

Narrows this job to an EmailTrigger, which for a trigger is always itself.

`getEmailEnabled()`

Returns: Boolean

Whether the trigger sends its email when it fires. This is the one action which is on by default, so null means enabled; use isEnabledEmail for the resolved value.

`getRemoveFromGroup()`

Returns: Group

The group the profile is removed from when the trigger fires, if the remove-from-group action is enabled. Lazily loaded.

`getRemoveFromGroupEnabled()`

Returns: Boolean

Whether firing removes the profile from the configured group. Null means disabled.

`getAddToGroupEnabled()`

Returns: Boolean

Whether firing adds the profile to the configured group. Null means disabled.

`getGroupToJoin()`

Returns: Group

The group the profile joins when the trigger fires, if the add-to-group action is enabled. Lazily loaded.

`getCreateTimerEnabled()`

Returns: Boolean

Whether firing creates a TriggerTimer, which re-fires this trigger once the configured delay has elapsed. Null means disabled.

`getTimerUnit()`

Returns: TimeUnit

Unit of the delay applied when a TriggerTimer is created: hours, days, weeks, months or annual. If it is null no delay can be calculated and the timer fires immediately.

`getTimerMultiple()`

Returns: Integer

How many timer units the delay lasts, for example 3 with a unit of days means three days after the event.

`getEventId()`

Returns: String

Identifier of the event this trigger listens on, for example a module completion or a group registration. Required, and the main index used when looking up which triggers should fire for an event.

`getConditionScriptXml()`

Returns: String

Extra condition expressed in the XML rule format, up to 2000 characters. When present it is evaluated when the trigger matches and the actions run only if it returns true.

`getConditionScriptMvel()`

Returns: String

Extra condition expressed as an MVEL expression, up to 2000 characters. When present it is evaluated when the trigger matches and the actions run only if it returns true.

`getTriggerCondition1()`

Returns: String

First condition value the event must carry for this trigger to fire, matched against the event's own first trigger item. A null condition is not compared, so it matches any value. Blank values are normalised to null by checkNulls.

`isEnabled()`

Returns: boolean

Whether the trigger is switched on. A disabled trigger is skipped when its event fires, and its pending timers are not processed.

`isIncludeUser()`

Returns: boolean

Whether the email should also go to the profile associated with the event which fired the trigger, in addition to the recipient groups and organisations configured on the job.

`getTriggerCondition2()`

Returns: String

Second condition value the event must carry for this trigger to fire, matched against the event's own second trigger item. A null condition is not compared, so it matches any value. Blank values are normalised to null by checkNulls.

`getTriggerCondition3()`

Returns: String

Third condition value the event must carry for this trigger to fire, matched against the event's own third trigger item. A null condition is not compared, so it matches any value. Blank values are normalised to null by checkNulls.

`getTriggerCondition4()`

Returns: String

Fourth condition value the event must carry for this trigger to fire, matched against the event's own fourth trigger item. A null condition is not compared, so it matches any value. Blank values are normalised to null by checkNulls.

`getTriggerCondition5()`

Returns: String

Fifth condition value the event must carry for this trigger to fire, matched against the event's own fifth trigger item. A null condition is not compared, so it matches any value. Blank values are normalised to null by checkNulls.

`getReward()`

Returns: Reward

The reward granted when the trigger fires, if the reward action is enabled. Lazily loaded.

`getNumRewards()`

Returns: Integer

Fixed number of reward units, such as points, to grant when the trigger fires. Ignored when a rewards MVEL expression is set, which calculates the amount instead.

`getNumRewardsMVEL()`

Returns: String

MVEL expression, up to 2000 characters, which calculates how many reward units to grant, for cases where the amount depends on the event rather than being fixed.

`getRewardEnabled()`

Returns: Boolean

Whether firing grants the configured reward. Null means disabled.

`getAlert()`

Returns: Alert

The alert activated when the trigger fires, if the alert action is enabled. Lazily loaded.

`getActivateAlertEnabled()`

Returns: Boolean

Whether firing activates the configured alert. Null means disabled.

`getRewardReason()`

Returns: String

Text recorded against the points or reward transaction explaining why it was granted, shown to the participant in their transaction history.

`getRewardPointsTag()`

Returns: String

Name of the points tag the granted points are filed under, so that awards from this trigger can be reported on and expired as a group.

`getAwardCpdNumPoints()`

Returns: Double

Number of CPD points awarded when the trigger fires, if the CPD action is enabled.

`getAwardCpdEnabled()`

Returns: Boolean

Whether firing awards CPD points against a certificate. Null means disabled.

`getAwardCpdForCert()`

Returns: Certificate

The certificate the CPD points are recorded against. If left null the platform tries to find a certificate associated with the module instead. Lazily loaded.

`getAwardCpdModulePath()`

Returns: String

Path of the learning module the CPD award relates to. If left blank the platform tries to derive it from the event, for example using the same module as a module progress event.

`getSmsEnabled()`

Returns: Boolean

Whether firing sends an SMS as well as, or instead of, the email. Null means disabled.

`getSmsMessage()`

Returns: String

Body of the SMS sent when the SMS action is enabled, up to 1000 characters.

`getSmsProvider()`

Returns: String

Name of the SMS provider configuration used to send the message. Null falls back to the organisation's default provider.

`getDataSeriesAmountMvel()`

Returns: String

MVEL expression which calculates the value inserted into the data series when the data series action runs.

`getDataSeriesDateMvel()`

Returns: String

MVEL expression which calculates the date the data series record is filed under. Null means the record is dated by the platform rather than by the event.

`getDataSeriesEnabled()`

Returns: Boolean

Whether firing inserts a record into a sales data series. Null means disabled.

`getDataSeriesName()`

Returns: String

Name of the data series the record is inserted into when the data series action runs.

`getDataSeriesCustomFields()`

Returns: String

Custom field values to store on the inserted data series record, held as text of up to 3000 characters.

`getSendPreference()`

Returns: String

Which channel the trigger prefers when both email and SMS are configured. Sending to both delivers both; the SMS preference falls back to email when the profile has no usable phone number.

`getTimerTime()`

Returns: String

Time of day, as text, that a created TriggerTimer should fire at. When set, the hour and minute of the calculated fire time are overridden with this value, so a delay of two days can still land at 9am.

`getTimerExpression()`

Returns: String

Expression, up to 1000 characters, used to work out the timer fire date instead of the fixed unit and multiple.

`isJavascriptEnabled()`

Returns: Boolean

Whether firing runs the trigger's server side JavaScript. Null means disabled.

`getJavascript()`

Returns: String

Server side JavaScript run when the trigger fires, up to 10000 characters. It runs in the context of the website named by the JavaScript website property.

`getJsWebsite()`

Returns: Website

Website whose apps and libraries provide the context the trigger's JavaScript runs in. Lazily loaded.

`checkNulls()`

Returns: void

Normalises the five trigger conditions so that a blank value becomes null, which is what the matching logic treats as 'match anything'. Call this after populating a trigger from a form, where empty inputs arrive as empty strings rather than nulls. Changes the in-memory object only.

`isActive()`

Returns: boolean

Whether email items belonging to this trigger may be sent, which is true only while the trigger is enabled and not soft deleted.

`isEnabledInsertDataSeries()`

Returns: boolean

Null safe reading of the data series action flag.

`isEnabledAwardCpd()`

Returns: boolean

Null safe reading of the CPD award action flag.

`isEnabledAddToGroup()`

Returns: boolean

Null safe reading of the add-to-group action flag.

`isEnabledEmail()`

Returns: boolean

Null safe reading of the email action flag. Email is on by default, so an unset flag reads as true.

`isEnabledCreateTimer()`

Returns: boolean

Null safe reading of the create-timer action flag.

`isEnableGroupRemove()`

Returns: boolean

Null safe reading of the remove-from-group action flag.

`isEnableReward()`

Returns: boolean

Null safe reading of the reward action flag.

`isEnableAlert()`

Returns: boolean

Null safe reading of the alert action flag.

`isEnableSms()`

Returns: boolean

Null safe reading of the SMS action flag.

`isEnableJavascript()`

Returns: boolean

Null safe reading of the JavaScript action flag.

`getAuditOrg()`

Returns: Organisation

Organisation the audit trail for this trigger is recorded against, which is the organisation that owns it.

To get full access to the Kademi Hub existing customers can login here, or new customers can register here.