Schedule

Note: This page includes content based on the F1 documentation for Centura development. It may be partially converted to support APF development, but should be regarded to be of uncertain actuality. It is provided as is. Eventually, it should be replaced by documentation available from within Visual Studio.

SalNumber Schedule( SalString nWhat,
                 SalString sMethodName )

The Schedule method opens the "Schedule Task Wizard" dialog with predefined parameters (if any) for the Task. When the "Finished" button is pressed, a Scheduled Task is created that schedules background jobs that later executes the actual Task. If you want to run the Task directly, not scheduling it, use the ExecuteOnline method instead.

Parameters

Name	Description
SalString nWhat	Const.METHOD_Inquire to inquire if target object is available, Const.METHOD_Execute to perform the actual action.
SalString sMethodName	The method name of the Task

Returns

When nWhat is Const.METHOD_Inquire: TRUE if the Task is available, FALSE otherwise
When nWhat is Const.METHOD_Execute: Schedule ID of the Scheduled Task that was created, 0 otherwise.

Comments

The task must first be registered and granted (as a Presentation Object) in order to be scheduled. All necessary security checks are made by running the method with nWhat set to Const.METHOD_Inquire.

Example

Function: UM_AnalyzeSchema
   Parameters
      Number: nWhat
   Actions
      Return TaskScheduler. Schedule( nWhat, 'DATABASE_SYS.EXECUTE_ANALYZE_SCHEMA__' )

C# code

switch (TypeGetFromUrl(url.LocalPath))
{
	case Const.NAVIGATOR_TypeScheduledTask:
		Var.TaskScheduler.Schedule(Const.METHOD_Execute, ActionGetFromUrl(url.LocalPath));
		break; 
...............