Add Calendar Activity

Use this system function to add one activity to the calendar control.

Parameters

Calendar Control

Input, required. The calendar form control (FC) to affect.

Activity ID

Input, required. The ID of the activity in the database to be added to the calendar. Set the parameter to an applicable object from the object list.

Subject

Input, required. The title of the activity as it should appear on the calendar for the user. Set the parameter to an alphanumeric constant (<Literal>) or an applicable object from the object list.

Start Date and Time

Input, required if All Day Activity = False. The starting time and date, in UTime, for the activity. Literal date value in JDEUTime format.

End Date and Time

Input, required if All Day Activity = False. The ending time and date, in UTime, for the activity. Literal date value in JDEUTime format.

All Day Activity

Input, required. The indicator of whether the activity is to be displayed as an all day activity instead of having start and end date and times. Any activity that is equal to or greater than 24 hours automatically becomes an all day activity. All day activities are displayed in the all day activity area in the interface. Set the parameter to <TRUE>, <FALSE>, or an applicable object from the object list.

Recurrence

Input, required. The indicator of whether the activity occurs more than once. This parameter merely sets a flag; the control displays an icon to indicate that the activity has been flagged as reoccurring, but the system performs no other action in connection with recurrence. Set the parameter to <TRUE>, <FALSE>, or an applicable object from the object list.

Type

Input, required. The classification of the activity (meeting, appointment, and so forth). This parameter does not appear on the calendar. Set the parameter to an alphanumeric constant (<Literal>) or an applicable object from the object list.

Commitment Level

Input, required. The relative value of the activity. The value assigned affects the icon displayed and the color of the duration bar for the activity. Set the parameter to <Low Commitment> (1), <Default> (2), or <High> (3).

Private

Input, required. The indicator of whether to display the "private" icon. Set the parameter to <TRUE>, <FALSE>, or an applicable object from the object list.

Location

Input, required. The name of the place where the activity is to occur as it should appear on the calendar for the user. Set the parameter to an alphanumeric constant (<Literal>), <N/A>, or an applicable object from the object list.

Organizer

Input, required. The name of the creator of the activity as it should appear on the calendar for the user. Set the parameter to an alphanumeric constant (<Literal>), <N/A>, or an applicable object from the object list.

Font

Input, required. The font to use to display the activity to the user. Set the parameter to a font and related settings from the Font dialog (<Pick Font>) or the default font and related settings (<Reset Font>).

Bitmap

Input, required. The bitmap of an icon to display to the user on the calendar in association with the activity. To add an icon to the list, save a GIF-type graphic in both of these locations: The B9\<pathcode>\res folder on the machine where FDA is located and the webclient.war/img/res folder on the machine or machines hosting the Web server. Set the parameter to a bitmap from the system-supplied list (<Choose Calendar Bitmap>) or the default icon (<Default Calendar Bitmap>).

Background Color

Input, required. The color to appear behind the information on the calendar. Set the parameter to a color from the color palette (<Pick Color>) or the default color (<Reset Color>).

Additional Notes

When you add an activity through the system function, Add Calendar Activity, you can affect these aspects of how the activity appears and acts on the calendar:

  • Name of the activity (subject).

  • Start and end day and time.

    The system requires this value in JDEUTime, even when you designate an activity as an all-day activity. You can also flag an activity for reoccurrence.

    If the start and stop times result in a span of time that is greater than or equal to 24 hours, then the system converts the activity to an all day activity. All day activities are displayed in the all day event area in the interface.

  • Additional information associated with the activity.

    You can set values for the type (meeting, appointment, and so forth), the commitment level (low, medium, or high), the activity location, and the activity organizer.

  • Private.

    This option causes the system to display a special icon next to the activity. No other logic is applied automatically, however. If you wish to restrict access to an event marked private, then you must do so within the application.

  • Font, color, and icons.

    You can set the font and related attributes, set a background color, and associate an icon with any activity. The icons from which you have to choose must already reside in the system. To add an icon to the list, save a GIF-type graphic in both of these locations: the B9\<pathcode>\res folder on the machine where FDA is located and the webclient.war/img/res folder on the machine or machines hosting the web server.

Whenever you want to load the calendar with events that exist in a given time period, use this formula:

SELECT from where T2 >= S and T1 <= E

where

  • T2 is the activity end time,

  • S is the system variable, Slstart,

  • T1 is the activity start time, and

  • E is the system variable, Slend.