Class FSCNOTIFICATION@1.1001:Notification

Notification Message

Class Hierarchy

Properties

Type	Property	Name
Object[]	notificationattachments	Affected Object
ComponentObject	notificationbasedateattr	Base Date
Object	notificationbasedateobj	Object for Base Date for Time Interval
WorkFlowDiagram	notificationbpmndiagram	Process to Be Executed
User[]	notificationcompletedby	Completed by
date	notificationdate	Date
DeadlineReiteration	notificationdeadlinereiteration	Repetition Rule
date	notificationdispatchedat	Executed on/at
User[]	notificationdispatchedto	Sent to
AdministrationObject[]	notificationdisprecipient	Recipient
string[]	notificationmessage	Message
Object	notificationperiod	Time Span
boolean	notificationperiodsubtract	Subtract Time Span
string	notificationreason	Reason
boolean	notificationrecalcdate	Recalculate the Date When the Base Date Changes
AdministrationObject[]	notificationrecipient	Recipient
boolean	notificationrepeatedly	Execute Follow-Up Repeatedly
NotificationRepetionType[]	notificationrepetition	History
Object	notificationsource	Notification Source
ComponentState	notificationstate	State
date	notificationstatechangedat	State Change on/at
User[]	notificationsubscribers	Subscribers
NotificationTemplate	notificationtemplate	Template
ResubmissionNotificationType	notificationtype	Action
boolean	notificationusedate	Use Explicit Date
boolean	personalnotification	Private Follow-Up
Object[]	personalnotificationattachments	Affected Object

Actions

Return Type	Signature
datetime	GetNextNotificationDate( out retval datetime nextnotificationdate, out optional TypeLongTermDeadlines deadlineentry)
void	ReCalculateResubmissionDate( optional boolean disablemodifiedcheck, optional datetime notificationdate)

Properties

Affected Object (FSCNOTIFICATION@1.1001:notificationattachments)

Stores the objects for which the follow-up was created.

Explanation:
The follow-up refers to this object.

unique Object[] FSCNOTIFICATION@1.1001:notificationattachments readonly

Additional Information

Access Types for Reading Property: AccTypeRead
Property for Back Link: objresubmissions

Base Date (FSCNOTIFICATION@1.1001:notificationbasedateattr)

Stores if the base date attribute to calculate the notification date.

Explanation:
Defines the property for the base date from when the time period is calculated.

ComponentObject FSCNOTIFICATION@1.1001:notificationbasedateattr readonly

Additional Information

Object Classes Allowed: RetentionDateTimeDef, AttributeDateTimeDef

Object for Base Date for Time Interval (FSCNOTIFICATION@1.1001:notificationbasedateobj)

The object from which the base date for dynamic deadline date calculation is taken.

Object FSCNOTIFICATION@1.1001:notificationbasedateobj readonly

Process to Be Executed (FSCNOTIFICATION@1.1001:notificationbpmndiagram)

Stores the process diagram which is started when the follow-up is dispatched.

Explanation:
Defines the process that should be executed.
Note: The process has to be released for the user who executes the follow-up.

WorkFlowDiagram FSCNOTIFICATION@1.1001:notificationbpmndiagram not null readonly

Additional Information

Object Classes Allowed: WorkFlowDiagram

Completed by (FSCNOTIFICATION@1.1001:notificationcompletedby)

Stores the users who completed the follow-up.

Explanation:
Shows the user who has completed the follow-up.

User[] FSCNOTIFICATION@1.1001:notificationcompletedby readonly

Date (FSCNOTIFICATION@1.1001:notificationdate)

Calculates the notification date when the recipients are informed about the follow-up.

Explanation:
The defined action is executed on this date. If the base date does not yet contain a value, no date can be displayed.

date FSCNOTIFICATION@1.1001:notificationdate local readonly volatile

Repetition Rule (FSCNOTIFICATION@1.1001:notificationdeadlinereiteration)

Stores the reiteration rules to execute the follow-up repeatedly.

DeadlineReiteration FSCNOTIFICATION@1.1001:notificationdeadlinereiteration readonly

Executed on/at (FSCNOTIFICATION@1.1001:notificationdispatchedat)

Stores the time stamp when the notification for the follow-up was dispatched or the configured process was started.

date FSCNOTIFICATION@1.1001:notificationdispatchedat local readonly

Sent to (FSCNOTIFICATION@1.1001:notificationdispatchedto)

Stores the users who have been informed by the follow-up.

Explanation:
Shows to whom the follow-up was sent.

User[] FSCNOTIFICATION@1.1001:notificationdispatchedto readonly

Recipient (FSCNOTIFICATION@1.1001:notificationdisprecipient)

Calculated the notification recipients for mail notification.

unique AdministrationObject[] FSCNOTIFICATION@1.1001:notificationdisprecipient readonly volatile

Additional Information

Access Types for Reading Property: AccTypeRead

Message (FSCNOTIFICATION@1.1001:notificationmessage)

Stores the notification message which is sent by mail to the recipient.

Explanation:
The message that should be sent as notification.

string[] FSCNOTIFICATION@1.1001:notificationmessage readonly

Time Span (FSCNOTIFICATION@1.1001:notificationperiod)

Stores the time interval to calculate the notification date of the follow-up.

Explanation:
The follow-up date is calculated using the time span based on a base date.

Object FSCNOTIFICATION@1.1001:notificationperiod not null readonly

Additional Information

Object Classes Allowed: TimeInterval, TimeIntervalComponentObject

Subtract Time Span (FSCNOTIFICATION@1.1001:notificationperiodsubtract)

Stores if the notification period should be added or subtracted from the base date.

boolean FSCNOTIFICATION@1.1001:notificationperiodsubtract readonly

Reason (FSCNOTIFICATION@1.1001:notificationreason)

The reason of the follow-up is displayed as a suffix of the follow-up name and calendar event.

Explanation:
The reason of the follow-up is displayed as a suffix of the follow-up name and calendar event.

string FSCNOTIFICATION@1.1001:notificationreason readonly

Recalculate the Date When the Base Date Changes (FSCNOTIFICATION@1.1001:notificationrecalcdate)

Defines if the notification date for the follow-up should be recalculated on base date change.

Explanation:
Defines whether the follow-up date is recalculated when the base date value changes.

boolean FSCNOTIFICATION@1.1001:notificationrecalcdate readonly

Recipient (FSCNOTIFICATION@1.1001:notificationrecipient)

Stores the recipient for mail notification of the follow-up.

Explanation:
The follow-up is sent to the defined recipients.

unique AdministrationObject[] FSCNOTIFICATION@1.1001:notificationrecipient not null readonly

Additional Information

Access Types for Changing Property: AccTypeChangeSecRel
Access Types for Reading Property: AccTypeRead
Object Classes Allowed: User, Group
Property for Back Link: recipientresubmissions

Execute Follow-Up Repeatedly (FSCNOTIFICATION@1.1001:notificationrepeatedly)

Defines if the follow-up is executed repeatedly.

boolean FSCNOTIFICATION@1.1001:notificationrepeatedly readonly

History (FSCNOTIFICATION@1.1001:notificationrepetition)

Stores a history of notification states for repeatedly executed follow-ups.

NotificationRepetionType[] FSCNOTIFICATION@1.1001:notificationrepetition readonly

Notification Source (FSCNOTIFICATION@1.1001:notificationsource)

Stores the category from which the follow-up was added to the current object.

Object FSCNOTIFICATION@1.1001:notificationsource readonly

State (FSCNOTIFICATION@1.1001:notificationstate)

Stores the state of the follow-up.

Possible values are:

NotifyStateInitialized
NotifyStateReInitialized
NotifyStateDispatched
NotifyStateCancelled
NotifyStateDone

Explanation:
Shows the state of the follow-up.

ComponentState FSCNOTIFICATION@1.1001:notificationstate readonly

Additional Information

Access Types for Changing Property: AccTypeRead

State Change on/at (FSCNOTIFICATION@1.1001:notificationstatechangedat)

Stores the time stamp when the state of the follow-up was changed the last time.

Explanation:
Shows when the follow-up was carried out.

date FSCNOTIFICATION@1.1001:notificationstatechangedat local readonly volatile

Subscribers (FSCNOTIFICATION@1.1001:notificationsubscribers)

Stores the users who added the follow-up to their notification widget.

User[] FSCNOTIFICATION@1.1001:notificationsubscribers readonly

Additional Information

Access Types for Changing Property: AccTypeRead

Template (FSCNOTIFICATION@1.1001:notificationtemplate)

Stores the notification template the follow-up was created from.

NotificationTemplate FSCNOTIFICATION@1.1001:notificationtemplate readonly

Action (FSCNOTIFICATION@1.1001:notificationtype)

Stores the notification type of the follow-up.

Explanation:
Defines the action that is executed upon reaching the follow-up date.

ResubmissionNotificationType FSCNOTIFICATION@1.1001:notificationtype readonly

Use Explicit Date (FSCNOTIFICATION@1.1001:notificationusedate)

Defines if an explicit date is entered for dispatch of the follow-up or if the notification date is calculated by a base date attribute.

Explanation:
Defines whether a date or a time span based on a base date can be specified.

boolean FSCNOTIFICATION@1.1001:notificationusedate readonly

Private Follow-Up (FSCNOTIFICATION@1.1001:personalnotification)

Stores if the follow-up is personal or visible to all users who have access to the attachments.

Explanation:
Defines whether the follow-up is only personally visible to the user.

boolean FSCNOTIFICATION@1.1001:personalnotification readonly

Affected Object (FSCNOTIFICATION@1.1001:personalnotificationattachments)

Stores the objects for which the personal follow-up was created.

Explanation:
The follow-up refers to this object.

unique Object[] FSCNOTIFICATION@1.1001:personalnotificationattachments readonly

Additional Information

Access Types for Reading Property: AccTypeRead

Actions

FSCNOTIFICATION@1.1001:GetNextNotificationDate

Retrieve the next notification date of the current object

datetime FSCNOTIFICATION@1.1001:GetNextNotificationDate(
out retval datetime nextnotificationdate,
out optional TypeLongTermDeadlines deadlineentry)

Name	Description
nextnotificationdate	the date of the next notification
deadlineentry	the deadline entry of the next notification date

FSCNOTIFICATION@1.1001:ReCalculateResubmissionDate

Recalculate the resubmission date of the current object based on the defined notification period and notification base date.

Note: For follow-ups which should be executed directly after the last modification (ModifiedAtDateTimeDef) the notification date is cleared by execution of this action.
To use the recalculated date for this case can be achieved by setting the parameter disablemodifiedcheck to true.

void FSCNOTIFICATION@1.1001:ReCalculateResubmissionDate(
optional boolean disablemodifiedcheck,
optional datetime notificationdate)

Name	Description
disablemodifiedcheck	paramter for special handling for notification directly executed after last modification.
notificationdate	the notification date can be set for notifications which use an explicit notification date (`notificationusedate`).