Actr_ScheduleEvent (function reference)

Activator Plug-in > Functions reference > Actr_ScheduleEvent
Activator Plug-in for FileMaker Pro

Actr_ScheduleEvent

This function will schedule a script to be automatically triggered in the future.

SyntaxFunction badge

Actr_ScheduleEvent ( switches ; datetimestamp ; fileName ; scriptName ;
yourID ; usertext )

Parameters

switchesset to "-AddSingleEvent" (in the future new switches may be added)
datetimestampthe timestamp indicating the date and time the script must be triggered
fileNamethe name of the file that contains the script
scriptNamethe name of the script
yourID(optional) a free to use ID that you can supply to identify the event
usertext(optional) a free to use text that you can supply for your own needs

Returned Result

Data type returned

Text

Result

If successful an eventID is returned: this is an internal eventID that the plug-in assigns, for example 4242.

If unsuccessful it returns an error code starting with $$ and the error code. Returned error codes can be:

$$-50parameter error, check if your parameters are correct
$$-41not enough memory
$$-4216OLE error (windows)
$$-4223maximum number of events scheduled (1000)
$$-4226you can’t schedule an event in the past

Other errors may be returned.

Originated in

Activator Plug-in 1.2

Compatibility

FileMaker Pro 12 to 16

Considerations

The date parameter should be in the same format as a FileMaker date field.
The time parameter should be in the same format as a FileMaker time field.

IMPORTANT: Don’t forget to delete triggered events in the triggered scripts, as this might fill up the memory. See Actr_DeleteEvent.

NOTE: Starting with version 1.3 this function works for all versions of FileMaker Pro and bound runtimes from FileMaker Pro Advanced on all platforms.

Example

Set Field [ result ; Actr_ScheduleEvent ( "-AddSingleEvent" ; 
				Timestamp ( "12/16/2017" ; "12:22:45 PM" ) ;
				"Events.fmp12" ; "TriggerScript1" ; "12345" ; "hi!" ) ]

This command will trigger the script “TriggerScript1” in file “Events.fmp12” on day December 16th, 2017, at 12:22:45 PM. Note that this example is somewhat simplified, normally you should not use hardcoded dates like in the above example, as this will only work on a system with US dates. See also example 2, for a more robust example.

Example 2

We assume that in your FileMaker file the following fields are defined:

gTriggerDate		Global, date
gTriggerTime		Global, time
gEventID		Global, number

gTriggerDate and gTriggerTime can be filled with the date and time the script should be triggered. Add the following script step:

Set Field [ gEventID ; Actr_ScheduleEvent ( "-AddSingleEvent" ; 
				Timestamp ( gTriggerDate ; gTriggerTime ) ; Get ( CurrentFileName ) ; 
				"TriggerScript" ; Get ( CurrentRecordID ) ; "Check record please." ) ]

This command will trigger the script “TriggerScript” in the current file. It will be triggered on the day and time that are in the global fields gTriggerDate and gTriggerTime.

Related functionsFunction badge

Actr_Control
Actr_DeleteEvent
Actr_GetEventInfo
Actr_RunScript

Related topics

Activator Plug-in online help (overview)


Online Help Page for Activator Plug-in for 12 to 16 –> Actr_ScheduleEvent (actrp4614) 2017-0822 17:37:49