PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
Runs an instance of the action plan in the software factory from a WINDEV application or from a WEBDEV site. This allows you to automate the triggering of action plans. For example, an action plan for running tests can be started from a batch application.
Example
// Runs the instance of action plan for compiling my project
ActionPlanExecute("FacCoord", "admin", "fackey", "PlanCompilMyProject")
// Runs the instance of action plan for compiling my project
InstanceID is int
InstanceID = ActionPlanExecute("FacCoord", "admin", "fackey", "PlanCompilMyProject")
Syntax
<Result> = ActionPlanExecute(<Coordinator> , <User> , <Password> , <Instance of Action Plan> [, <Monitoring Procedure>])
<Result>: Boolean
  • True if the instance of action plan was started,
  • False if the instance of action plan was not started. The corresponding error message is returned by ErrorInfo.
<Coordinator>: Character string (with quotes)
Name of computer used to coordinate the execution of action plans.
<User>: Character string (with quotes)
User name. This user must be allowed to run the action plan on the coordinator.
<Password>: Character string (with quotes)
User password.
<Instance of Action Plan>: Character string (with quotes)
Name of instance of action plan to run.
To run an instance of action plan of a given library, the instance name must have the following format:
<Library Name> + TAB + <Name of Instance of Action Plan>
If the library name is not specified, the first instance of the action plan found corresponding to the specified name will be run.
<Monitoring Procedure>: Optional character string (with or without quotes)
WLanguage procedure that will be called when running the action plan. This procedure is used to follow the execution of the action plan and to find out whether its execution was ended properly.
This procedure has the following format:
PROCEDURE ProcedureName(<Instance of Action Plan>, <Current Step>,
<Progress>, <Status>)
where:
  • <Instance of Action Plan> is a string corresponding to the name of the instance run.
  • <Current Step> is a string corresponding to the caption of the current step.
  • <Progress> is an integer corresponding to the percentage of execution progress (between 0 and 100).
  • <Status> is an Integer constant indicating the execution status:
    apStatusDisconnectedThe robot used to run the action plan does not respond anymore.
    apStatusPendingThe action plan is waiting to be run.
    apStatusInProgressThe action plan is currently run.
    apStatusStartupThe coordinator is going to start the action plan.
    apStatusCompletedFailureThe execution of the plane ended with error.
    apStatusCompletedOKThe execution of the plane ended without error.
<Result> = ActionPlanExecute(<Coordinator> , <User> , <Password> , <Instance of Action Plan> [, <Monitoring Procedure>])
<Result>: Integer
Versions 21 and later
  • Identifier of instance of action plan if this one was started,
  • 0 the instance of action plan was not started. The corresponding error message is returned by ErrorInfo.
New in version 21
  • Identifier of instance of action plan if this one was started,
  • 0 the instance of action plan was not started. The corresponding error message is returned by ErrorInfo.
  • Identifier of instance of action plan if this one was started,
  • 0 the instance of action plan was not started. The corresponding error message is returned by ErrorInfo.
<Coordinator>: Character string (with quotes)
Name of computer used to coordinate the execution of action plans.
<User>: Character string (with quotes)
User name. This user must be allowed to run the action plan on the coordinator.
<Password>: Character string (with quotes)
User password.
<Instance of Action Plan>: Character string (with quotes)
Name of instance of action plan to run.
To run an instance of action plan of a given library, the instance name must have the following format:
<Library Name> + TAB + <Name of Instance of Action Plan>
If the library name is not specified, the first instance of the action plan found corresponding to the specified name will be run.
<Monitoring Procedure>: Optional character string (with or without quotes)
WLanguage procedure that will be called when running the action plan. This procedure is used to follow the execution of the action plan and to find out whether its execution was ended properly.
This procedure has the following format:
PROCEDURE ProcedureName(<Instance of Action Plan>, <Current Step>,
<Progress>, <Status>)
where:
  • <Instance of Action Plan> is a string corresponding to the name of the instance run.
  • <Current Step> is a string corresponding to the caption of the current step.
  • <Progress> is an integer corresponding to the percentage of execution progress (between 0 and 100).
  • <Status> is an Integer constant indicating the execution status:
    apStatusDisconnectedThe robot used to run the action plan does not respond anymore.
    apStatusPendingThe action plan is waiting to be run.
    apStatusInProgressThe action plan is currently run.
    apStatusStartupThe coordinator is going to start the action plan.
    apStatusCompletedFailureThe execution of the plane ended with error.
    apStatusCompletedOKThe execution of the plane ended without error.
Components
WINDEVWEBDEV - Server codeReports and Queries wd230std.dll
Minimum required version
  • Version 20
This page is also available for…
Comments
Click [Add] to post a comment