Misc

This section lists the elements you can use to configure miscellaneous parameters.

This page discusses:

CustomConfigList
CustomConfig
SchedulingConfig
CronCalendarConfig
DailyCalendarConfig
MonthlyCalendarConfig
WeeklyCalendarConfig
JobConfigGroup
DispatchJobConfig
TriggerConfigGroup
SimpleTriggerConfig
CronTriggerConfig
ValidatorConfig
ValidatorGroup
Validator
CustomValidator
AdminUIConfig
Role
Permission
DispatchMessage
KeyValue
IntValue

CustomConfigList

com.exalead.mercury.mami.master.v10.CustomConfigList
A list of custom configuration entries.

Attributes:


Name	Type	Default value	Description
`version`	`long`

Nested elements:


Name	Type	Description
`CustomConfig`	`com.exalead.mercury.mami.master.v10.CustomConfig*`

CustomConfig

com.exalead.mercury.mami.master.v10.CustomConfig
Data model A custom configuration entry. Contains the custom configuration entries in a set of @c KeyValue.
Parent elements:
- com.exalead.mercury.mami.master.v10.CustomConfigList (as CustomConfigList)

Attributes:


Name	Type	Default value	Description
`name`	`string`		Name of the custom configuration entry.

Nested elements:


Name	Type	Description
`KeyValue`	`exa.bee.KeyValue*`

SchedulingConfig

com.exalead.mercury.mami.master.v10.SchedulingConfig
Scheduled jobs configuration. Allows to run jobs periodically at a certain date or time

Attributes:


Name	Type	Default value	Description
`version`	`long`

Nested elements:


Name	Type	Description
`CalendarConfig`	`com.exalead.mercury.mami.master.v10.CalendarConfig*`
`JobConfigGroup`	`com.exalead.mercury.mami.master.v10.JobConfigGroup*`
`TriggerConfigGroup`	`com.exalead.mercury.mami.master.v10.TriggerConfigGroup*`

CronCalendarConfig

com.exalead.mercury.mami.master.v10.CronCalendarConfig
Set to exclude a time range defined with a Quartz Cron expression.
Parent elements:
- com.exalead.mercury.mami.master.v10.SchedulingConfig (as SchedulingConfig)

Attributes:


Name	Type	Default value	Description
`name`	`string`		Name of the calendar.
`cronExpression`	`string`		The Quartz Cron expression.

DailyCalendarConfig

com.exalead.mercury.mami.master.v10.DailyCalendarConfig
Used to exclude a time range from a day.
Parent elements:
- com.exalead.mercury.mami.master.v10.SchedulingConfig (as SchedulingConfig)

Attributes:


Name	Type	Description
`name`	`string`	Name of the calendar.
`startTime`	`string`	Time range start.
`endTime`	`string`	Time range end.

MonthlyCalendarConfig

com.exalead.mercury.mami.master.v10.MonthlyCalendarConfig
Used to exclude a set of days from a month. Contains the range of days to exclude (1-31)
Parent elements:
- com.exalead.mercury.mami.master.v10.SchedulingConfig (as SchedulingConfig)

Attributes:


Name	Type	Default value	Description
`name`	`string`		Name of the calendar.

Nested elements:


Name	Type	Description
`IntValue`	`exa.bee.IntValue*`

WeeklyCalendarConfig

com.exalead.mercury.mami.master.v10.WeeklyCalendarConfig
Used to exclude a set of days in the week. Contains the range of days to exclude (1-7).
Parent elements:
- com.exalead.mercury.mami.master.v10.SchedulingConfig (as SchedulingConfig)

Attributes:


Name	Type	Default value	Description
`name`	`string`		Name of the calendar.

Nested elements:


Name	Type	Description
`IntValue`	`exa.bee.IntValue*`

JobConfigGroup

com.exalead.mercury.mami.master.v10.JobConfigGroup
Configuration for a group of jobs.
Parent elements:
- com.exalead.mercury.mami.master.v10.SchedulingConfig (as SchedulingConfig)

Attributes:


Name	Type	Default value	Description
`name`	`string`		Group name.

Nested elements:


Name	Type	Description
`JobConfig`	`com.exalead.mercury.mami.master.v10.JobConfig*`

DispatchJobConfig

com.exalead.mercury.mami.master.v10.DispatchJobConfig
Generic job used to dispath a message to a service
Parent elements:
- com.exalead.mercury.mami.master.v10.JobConfigGroup (as JobConfigGroup)

Attributes:


Name	Type	Default value	Description
`name`	`string`		Job name.

Nested elements:


Name	Type	Description
`DispatchMessage`	`exa.bee.DispatchMessage`

TriggerConfigGroup

com.exalead.mercury.mami.master.v10.TriggerConfigGroup
Configuration for a group of triggers
Parent elements:
- com.exalead.mercury.mami.master.v10.SchedulingConfig (as SchedulingConfig)

Attributes:


Name	Type	Default value	Description
`name`	`string`		Group name.

Nested elements:


Name	Type	Description
`TriggerConfig`	`com.exalead.mercury.mami.master.v10.TriggerConfig*`

SimpleTriggerConfig

com.exalead.mercury.mami.master.v10.SimpleTriggerConfig
Simple trigger <p /> The following values for {@link misfireInstruction} are available:
- fire_now: immediately fires the trigger
- reschedule_next_with_existing_count: reschedule to next execution with {@link repeatCount} left unchanged.
- reschedule_next_with_remaining_count: reschedule to next execution with repeat count set to what it would be if it had not missed any firings.
- reschedule_now_with_existing_repeat_count: reschedule now with {@link repeatCount} left unchanged.
- reschedule_now_with_remaining_repeat_count: reschedule now with repeat count set to what it would be if it had not missed any firings.
<p /> If {@link misfireInstruction} is set to null, when the trigger couldn't be fired, the following scheme applies
- If {@link repeatCount} is set to 0, the instruction will be interpreted as fire_now
- If {link repeatCount} is set to <0, the instruction will be interpreted as reschedule_next_with_remaining_count
- If {link repeatCount} is set to >0, the instruction will be interpreted as reschedule_now_with_existing_repeat_count
Parent elements:
- com.exalead.mercury.mami.master.v10.TriggerConfigGroup (as TriggerConfigGroup)

Attributes:


Name	Type	Description
`name`	`string`	Name of the trigger.
`startTime`	`long`	Start date for this trigger.
`endTime`	`long`	End date for this trigger.
`jobGroupName`	`string`	Job group for this trigger.
`jobName`	`string`	Job name for this trigger.
`calendarName`	`string`	Optional calendar name for this trigger (to exclude blocks of time), only applies to simple triggers
`misfireInstruction`	`string`	Action to execute when the trigger couldn't be fired. @refer to each trigger documentation for available misfire instructions.
`repeatCount`	`int`	Repeats count (if <0 , no limit).
`repeatInterval`	`long`	Repeats interval in milliseconds.

CronTriggerConfig

com.exalead.mercury.mami.master.v10.CronTriggerConfig
Cron based trigger <p /> The following values for {@link misfireInstruction} are available:
- do_nothing: nothing is done when a trigger has been misfired.
- fire_once_now: the trigger is immediately executed when it has been misfired.
<p /> If {@link misfireInstruction} is set to null, when the trigger couldn't be fired, the following scheme applies:
- The instruction will be interpreted as fire_once_now.
Parent elements:
- com.exalead.mercury.mami.master.v10.TriggerConfigGroup (as TriggerConfigGroup)

Attributes:


Name	Type	Description
`name`	`string`	Name of the trigger.
`startTime`	`long`	Start date for this trigger.
`endTime`	`long`	End date for this trigger.
`jobGroupName`	`string`	Job group for this trigger.
`jobName`	`string`	Job name for this trigger.
`calendarName`	`string`	Optional calendar name for this trigger (to exclude blocks of time), only applies to simple triggers
`misfireInstruction`	`string`	Action to execute when the trigger couldn't be fired. @refer to each trigger documentation for available misfire instructions.
`cronExpression`	`string`	Cron expression.

ValidatorConfig

com.exalead.mercury.mami.master.v10.ValidatorConfig
No documentation for this element.

Nested elements:


Name	Type	Description
`ValidatorGroup`	`com.exalead.mercury.mami.master.v10.ValidatorGroup*`

ValidatorGroup

com.exalead.mercury.mami.master.v10.ValidatorGroup
List of Validators that have the same runtime or target the same configuration. Allows to run specific validators at the same time.
Parent elements:
- com.exalead.mercury.mami.master.v10.ValidatorConfig (as ValidatorConfig)

Attributes:


Name	Type	Default value	Description
`name`	`string`		Name of this group of validators.
`autorun`	`boolean`	`True`	Default way to run all the group's validators. Default set to true (meaning the group will be ran at apply config time).

Nested elements:


Name	Type	Description
`Validator`	`com.exalead.mercury.mami.master.v10.Validator*`	List of validators belonging to this group.

Validator

com.exalead.mercury.mami.master.v10.Validator
No documentation for this element.
Parent elements:
- com.exalead.mercury.mami.master.v10.ValidatorGroup (as ValidatorGroup)

Attributes:


Name	Type	Default value	Description
`classId`	`string`
`name`	`string`		Unique identifier of the validator.
`autorun`	`boolean`	`True`	True if validator is to be ran at apply configuration time. Otherwise, will only be ran manually.

CustomValidator

com.exalead.mercury.mami.master.v10.CustomValidator
No documentation for this element.
Parent elements:
- com.exalead.mercury.mami.master.v10.ValidatorGroup (as ValidatorGroup)

Attributes:


Name	Type	Default value	Description
`classId`	`string`
`name`	`string`		Unique identifier of the validator.
`autorun`	`boolean`	`True`	True if validator is to be ran at apply configuration time. Otherwise, will only be ran manually.

Nested elements:


Name	Type	Description
`KeyValue`	`exa.bee.KeyValue*`

AdminUIConfig

com.exalead.mercury.mami.adminui.v10.AdminUIConfig
No documentation for this element.

Attributes:


Name	Type	Default value	Description
`version`	`long`
`identityProvider`	`string`
`useHttps`	`boolean`
`serverCertificate`	`string`

Nested elements:


Name	Type	Description
`Role`	`com.exalead.mercury.mami.adminui.v10.Role*`

Role

com.exalead.mercury.mami.adminui.v10.Role
No documentation for this element.
Parent elements:
- com.exalead.mercury.mami.adminui.v10.AdminUIConfig (as AdminUIConfig)

Attributes:


Name	Type	Default value	Description
`name`	`string`

Nested elements:


Name	Type	Description
`Permission`	`com.exalead.mercury.mami.adminui.v10.Permission*`

Permission

com.exalead.mercury.mami.adminui.v10.Permission
No documentation for this element.
Parent elements:
- com.exalead.mercury.mami.adminui.v10.Role (as Role)

Attributes:


Name	Type	Default value	Description
`id`	`string`
`permission`	`string`

DispatchMessage

exa.bee.DispatchMessage
No documentation for this element.
Parent elements:
- com.exalead.mercury.mami.master.v10.DispatchJobConfig (as DispatchJobConfig)

Attributes:


Name	Type	Default value	Description
`serviceName`	`string`
`messageName`	`string`
`outputFormat`	`string`

Nested elements:


Name	Type	Description
`messageContent`	`exa.bee.KeyValue*`

KeyValue

exa.bee.KeyValue
No documentation for this element.
Parent elements:
- com.exalead.mercury.mami.master.v10.CustomConfig (as CustomConfig)
- com.exalead.mercury.mami.master.v10.CustomValidator (as CustomValidator)
- exa.bee.KeyValue (as KeyValue)
- exa.bee.DispatchMessage (as messageContent)

Attributes:


Name	Type	Description
`key`	`string`	The name of the key
`value`	`string`
`type`	`string`
`description`	`string`

Nested elements:


Name	Type	Description
`KeyValue`	`exa.bee.KeyValue*`

IntValue

exa.bee.IntValue
No documentation for this element.
Parent elements:
- com.exalead.mercury.mami.master.v10.MonthlyCalendarConfig (as MonthlyCalendarConfig)
- com.exalead.mercury.mami.master.v10.WeeklyCalendarConfig (as WeeklyCalendarConfig)

Attributes:


Name	Type	Default value	Description
`value`	`int`