# Notice

## Program ID

MetraPipeline.MTNoticePlugin.1

## Description

The algorithm for the Notice plug-in is the following:

notice = (ScheduledStartTime - CancellationTime) / NoticeTimeConversion

Notice will always be >= 0.

If Cancellation Time is after Scheduled Start time a warning is logged and the notice is set to 0.

NoticeTimeConversion is used to convert the difference between scheduledStartTime and CancellationTime. Usually this is 60.

Notice is the MAX((scheduleStartTime - Cancellation Time),0). The output of this amount is then divided by NoticeTimeConversion. In the sample file, NoticeTimeConversion is 3600; meaning that the output value is converted into hours.

## Required Input Properties

Tag name | Value type | Description
ScheduledStartTime | DateTime | The scheduled start time of the conference
CancellationTime | DateTime | The cancellation time of the conference.

## Required Output Properties

Tag name | Value type | Description
Notice | long | The amount of time before the scheduled start time that the user cancelled the conference.

## Additional Configuration Tags

Tag name | Value type | Description
NoticeTimeConversion | long | Used to convert the difference between scheduledStartTime and CancellationTime. Usually is 60.

## Configuration Example

<configdata>
<ScheduledStartTime>ScheduledStartTime</ScheduledStartTime>
<CancellationTime>CancellationTime</CancellationTime>
<Notice>Notice</Notice>
<NoticeTimeConversion ptype="INTEGER">3600</NoticeTimeConversio
</configdata>

## Remarks

- NoticeTimeConversion must be greater than 0.

- This plugin does not determine whether a conference was cancelled or if a cancellation fee applies.