ActionPlanConfigure (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage functions / Standard functions / Windows functions / Software Factory functions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

ActionPlanConfigure (Function)

In french: PlanActionParamètre

Warning
From version 20 (58), ActionPlanParameter is kept for backward compatibility. This function has been replaced with ActionPlanConfigure.

Configures an action plan in the software factory.

Example

// Crée l'instance de plan d'action de compilation de mon projet 
TabParamètre is associative array of Variants
TabParamètre["projet"] = "MonProjet"
ActionPlanConfigure("CoordFab", "admin", "clefab", "MaBibli" + TAB + ...
	"PlanCompilProjet", "PlanCompilMonProjet", TabParamètre)

// Crée l'instance de plan d'action avec en paramètre ouverture d'un projet depuis le GDS
// L'action "Ouvrir un projet depuis le GSD" du plan prend le nom du projet 
// dans un paramètre "paramProjetAOuvrir"
TabParamètre is associative array of Variants
TabParamètre["paramProjetAOuvrir"] = "CS:\\TEST:4900\GDS"+CR+"GDS:\Projets WinDev\Mon_Projet"
ActionPlanConfigure("CoordFab", "admin", "", "MaBibli", "Mon_Instance_PLAN_TEST", ...
	TabParamètre, 30 s, apStatusCompletedFailure + apStatusCompletedOK, "GB")

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:
<Nom de la bibliothèque> + TAB + <Nom du plan d'action>
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,
duration in plain text (e.g. '1s').

<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:
"Nom destinataire 1" + RC + ... + RC + "Nom destinataire N"

<Labels>: Array of strings

List of labels required by a program to be able to execute the set action plan.
Reminder: It is possible to allocate one or more labels to an automation system.. This parameter can be used to execute an action plan only on some programs.

Business / UI classification: Neutral code

Component: wd300std.dll