PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

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
Warning
From version 20 (58), ActionPlanParameter is kept for backward compatibility. This function is replaced by ActionPlanConfigure.
Configures an action plan in the software factory.
Example
// Creates the instance of action plan for compiling my project
ArrParameter is associative array of Variants
ArrParameter["project"] = "MyProject"
ActionPlanConfigure("FacCoord", "admin", "fackey", "MyLibrary" + TAB + ...
"PlanCompilProject", "PlanCompilMyProject", ArrParameter)
Syntax
<Result> = ActionPlanConfigure(<Coordinator> , <User> , <Password> , <Name of Action Plan> , <Instance of Action Plan> [, <Parameters> [, <Time-out> [, <Required Information> [, <Recipients>]]]])
<Result>: Boolean
  • True if the action plan was configured,
  • False if the action plan was not configured. 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)
Password of user.
<Name of Action Plan>: Character string (with quotes)
Name of the action plan to configure.
To configure an action plan of a given library, the name of the action plan must have the following format:
<Llibrary name> + TAB + <Name of action plan>
Notes:
  • The extension of the library must not be specified. The name of the library may contain (or not) the extension.
  • If the library name is not specified, the first action plan found corresponding to the specified name will be configured.
<Instance of Action Plan>: Character string (with quotes)
Name of the instance of the action plan created or modified with the specified parameters.
<Parameters>: Associative array
Name of Associative Array variable containing the parameters of the action plan. This associative array is indexed on the name of parameters.
<Time-out>: Optional integer or optional Duration
Maximum duration for running the instance of the action plan in seconds. This parameter can correspond to:
  • an integer corresponding to the number of seconds,
  • a Duration variable,
  • Versions 23 and later
    the duration in clear ('1s' for example).
    New in version 23
    the duration in clear ('1s' for example).
    the duration in clear ('1s' for example).
<Required Information>: Optional Integer constant
Versions 21 and later
Indicates in which case a message must be sent by the in-house messaging application (WDBal). Corresponds to one of the following constants:
apStatusCompletedFailureThe execution of the plane ended with error.
apStatusCompletedOKThe execution of the plane ended without error.
New in version 21
Indicates in which case a message must be sent by the in-house messaging application (WDBal). Corresponds to one of the following constants:
apStatusCompletedFailureThe execution of the plane ended with error.
apStatusCompletedOKThe execution of the plane ended without error.
Indicates in which case a message must be sent by the in-house messaging application (WDBal). Corresponds to one of the following constants:
apStatusCompletedFailureThe execution of the plane ended with error.
apStatusCompletedOKThe execution of the plane ended without error.
<Recipients>: Optional character string (with quotes)
Versions 21 and later
List of persons to inform via the WDBal messaging. The names of recipients are separated by CR characters (Carriage Return). This parameter has the following format:
"Name recipient 1" + CR + ... + CR + "Name recipient N"
New in version 21
List of persons to inform via the WDBal messaging. The names of recipients are separated by CR characters (Carriage Return). This parameter has the following format:
"Name recipient 1" + CR + ... + CR + "Name recipient N"
List of persons to inform via the WDBal messaging. The names of recipients are separated by CR characters (Carriage Return). This parameter has the following format:
"Name recipient 1" + CR + ... + CR + "Name recipient N"
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