ActionPlanConfigure (Function) In french: PlanActionParamètre
 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.
// 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)
// Creates the action plan instance with a parameter to open a project from the SCM
// The "Open a project from the SCM" action takes the name of the project
// in the "paramOpenProject" parameter
ArrParameter is associative array of Variants
ArrParameter["paramOpenProject"] = "CS:\\TEST:4900\SCM"+CR+"SCM:\WINDEV Projects\My_Project"
ActionPlanConfigure("FacCoord", "admin", "MyLibrary", "My_Instance_PLAN_TEST", ...
ArrParameter, 30s, apStatusCompletedFailure + apStatusCompletedOK, "MG")
Syntax
<Result> = ActionPlanConfigure(<Coordinator> , <User> , <Password> , <Name of action plan> , <Instance of action plan> [, <Parameters> [, <Timeout> [, <Required information> [, <Recipients> [, <Labels>]]]]])
<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 Name of the computer used to coordinate the execution of the action plans. <User>: Character string User name. This user must be allowed to run the action plan on the coordinator. <Password>: Character string User password. <Name of action plan>: Character string 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:
<Library name> + TAB + <Name of action plan>
Remarks: - 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 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. <Timeout>: 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,
- the duration in clear ('1s' for example).
<Required information>: Optional Integer constant Indicates in which case a message must be sent by the in-house messaging application (WDBal). Corresponds to one of the following constants: | | | apStatusCompletedFailure | The execution of the plane ended with error. | | apStatusCompletedOK | The execution of the plane ended without error. |
<Recipients>: Optional character string 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"
<Labels>: Array of strings List of labels required by a program to be able to execute the set action plan.
Reminder: You can assign one or more labels to a program. This parameter can be used to execute an action plan only on some programs. Business / UI classification: Neutral code
This page is also available for…
|
|
|
|