Creating an action plan

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 / Editors / Software Factory

Overview
How to?
Creating an action plan
Describing an action plan
Actions that can be used in an action plan
Characteristics of the actions
Action with parameters
Managing the failures and errors
Specific action: Launch of WINDEV, WEBDEV or WINDEV Mobile
Specific action: Implementation of an action plan
WLanguage events associated with an action plan
Testing an action plan

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Creating an action plan

Overview

The action plans group all actions that will be performed by the software factory. An editor of action plans is used to easily define these actions. It is used to define the sequence of actions to be performed automatically. Action plans are created from WINDEV, WEBDEV or WINDEV Mobile.

How to?

Creating an action plan

To create an action plan:

Open the project for which an action plan must be created.
Note An action plan is not necessarily linked to a single project, since it can be used for several projects. However, a project must be used to create an action plan. You also have the ability to create an "Action plan" project.
Click in the quick access buttons.
- The window for creating a new element appears: click on "Automation", then on "Action plan".
- The wizard for creating a project configuration is automatically started on the current project.
In the wizard, specify:
- the name and description of the action plan.
- the elements included in the action plan. In most cases, no element must be included in the action plan. This plan allows you to include elements used by a specific action of the action plan (procedure used by a WLanguage action for example).
Validate the creation of project configuration.
A default action plan is generated and it is displayed in the editor of action plans.
Save the action plan (Ctrl + S). The action plan corresponds to a file with a "wpa" extension. The action plan is displayed in the project explorer.

Describing an action plan

The editor of action plans is as follows:

1 Action plan name. The "Description" option of the context menu is used to:

modify the name of the action plan.
specify the parameters of the action plan.

2 List of actions that can be carried out under the action plan. To add an action to the action plan, all you have to do is "drop" an action into the list of actions of the plan. The action will be included at the location hovered by the mouse cursor when the action is dropped.
The context menu of the action is used to:

Display the description window of the action. This window is used to specify the necessary parameters (the name of the project to open for example) and to manage the errors and the persons affected by the status report.
Move up, move down or delete the action.

3 List of actions in the action plan.

4 Action taken in the event of an error. This operating mode was defined in the action configuration window.

Actions that can be used in an action plan

The following is a non-exhaustive list of actions that can be executed in an action plan:

Open WINDEV, WEBDEV, WINDEV Mobile.
Close WINDEV, WEBDEV, WINDEV Mobile.
Open a project from the SCM.
Open a project on the disk.
Close the project.
Migration of a project from the SCM.
New in version 2025
Migration of a project from disk.
Clone and open a project from Git.
Commit and push project to Git.
New in SaaS
Change save format.
This action switches from binary to text format and vice versa.
Attention This feature is only available in WINDEV Suite SaaS 2025 Update 1. For more details, see Using new features exclusive to WINDEV Suite SaaS 2025.
Update components.
Update web services.
Template synchronization.
Update styles.
Update skins.
HTML generation.
Component relocation.
Select a configuration.
Generate a configuration.
Multiple generation.
Generating a library patch.
Generate help about new features.
Compilation of help files.
Publish external component in SCM.
Generate project technical documentation.
Generating the installation.
32/64-bit installation generation.
Launching setup.
Deploy installation to a Private Store.
Deploy site / web service to PCSCloud or to an application server.
Push a docker image to GitHub.
Extraction of messages for translation (WDMSG).
Reintegration of translated messages (WDMSG).
Reintegration of all elements in the SCM.
Cancellation of all SCM extractions.
Label SCM.
SCM check-out.
Check-out from SCM for test.
SCM check-in.
Cancel SCM extraction.
Cancellation of all text extractions from the SCM.
Recovering the contents of an SCM directory in a local directory (outside the project).
Search in SCM history.
Create SCM branch.
New in SaaS
Deleting branches in the SCM.
Note: It is not necessary to open the project to delete a branch, but it is necessary to open the product (WINDEV, WEBDEV, WINDEV Mobile). The action plan can therefore be composed of three actions: opening the product, removing branches, closing the product.
Note: This feature is only available from WINDEV Suite SaaS 2025 - Update 3.
For more details, see Using new features exclusive to WINDEV Suite SaaS 2025.
New in version 2025
Project added to SCM.
Detaching the project from the SCM.
Launching the static audit.
Run automated tests.
Command line of test mode.
Enable code coverage.
Disable code coverage.
Reinitialize code coverage.
Check code coverage.
Test library generation.
Recompile project.
Repare project.
Activation / Deactivation:
- UI errors
- warnings.
- programming standard errors
- information.
- Reports & Queries software.
- programming guidelines.
Show / Hide code prefixes.
Enable / disable audit on spelling mistakes.
Deleting test data.
Deleting test mode parameters.
Executing a WLanguage procedure.
Execute exe, bat, etc.
Running an action plan.
Execute an action plan for all configurations.
Define the comment.
Define name of the file to be generated.
Define version number.
Definition of the version string of the generated file.
Definition of major version number.
Enable / Disable version number increment.
Define Copyright.
Manifest settings.
Signature of the executable.
Name of the company.
URL of the company site.
Email address of company.
Description of the generated file.
Executable icon.
Splash screen image.
Change the way the library is used.
Regeneration of component documentation.
Reset WLangage error message.
Last compatible version of the component.
Path of the Android SDK.
Android application package.
Android application signature.
SCM directory for publishing external component.
Delay.
Emit a sound.
Copying files.
Copy a directory.
Burn a CD or DVD.
Deleting a directory.
Open/close all project elements.
Close all open elements.
Add a file to the project.
Sending an email.
Restart software factory after the action plan is completed.
Delete unused items from the analysis.
Save and generate analysis.
Reset analysis generation version number to 1.
Stop execution if an error occurs.

Characteristics of the actions

Action with parameters

An action may require parameters. For example, the action called "Open a project from SCM" requires the name of the project to open.

The definition of these parameters is performed in the "General" tab of the description window of the action ("Description" in the context menu of the action).

The parameters can be defined:

As a "fixed" value: the value is specified directly in the action plan.
As parameters passed during the execution of the action plan.

This parameter will be required to run the action plan.

For the name of the project to open, it must be specified as parameter by the developer.

Tip Whenever possible, it is advisable to use parameters when creating action plans, so that they can be reused for different projects.

Managing the failures and errors

An important part of the action plan: defining what to do if the action fails. A simple example: what to do when updating a window that has been extracted exclusively by a developer.

The management mode of errors that is the most consistent with the action is selected by default. You also have the ability to customize it. Let's take a look at the possible management modes of errors:

Stop the execution of the action plan and save the error in the status report.
This management mode is reserved for the major errors (for example, a project that failed to open): there is no need to try to continue.
Run the custom error process of the action plan.
This management mode allows you to manage a specific error mechanism. For example, send an SMS if an error occurs.
Save the error in the status report and continue the execution.
This management mode allows you to continue the execution of the action plan even if an error occurs.
For example, if a component is not updated (offline server, etc.), the action plan can continue.
Save for information but do not generate any error.
For example, when the audit detects that unused files are found in the project directory, this is not an error but it may be important to have this information.

If the action fails, you have the ability to select one or more persons to inform ("Message" tab of the description window of the action).

In any case, the owner of the action plan is informed of the execution result (success or failure).

Tip To obtain all potential errors in a project, you can use the "Record error in report and continue" mode and a special action: "Stop execution in case of error". For example, if the synchronization of the templates is not performed, the error is saved and the action plan continues to run. In the rest of the action plan, if the recompilation detects some UI errors, these errors will be stored. Therefore, all the project errors are found in a single execution of the action plan.

Special case: carrying out a procedure as part of an action plan:

Depending on the result of the procedure, the action plan must be interrupted. The following code must be used in the WLanguage procedure:

IF bRes = False THEN
	sMessageErreur is string = "Erreur dans ma fonction XXX" + CR + ... 
		ErrorInfo(errSystemMessage)
	ExceptionThrow(1, sMessageErreur)
END

New in version 2025

Specific action: Launch of WINDEV, WEBDEV or WINDEV Mobile

The action for launching the product via an action plan for the software factory contains several parameters in the "General" tab of the description window:

Version and directory of the product to be launched.
The type of license used: license with physical key or SaaS license.
Project Management Hub user name and password.

In the case of a license with a physical key, each automation device must have a local physical key or a network key.

SaaS Exclusivity
In the case of a SaaS license, the license is the one already in use on the workstations running the PLCs. Therefore, you must:

have a SaaS license for each automation device.
have launched the required product at least once on the automation to log in with the corresponding subscription credentials.
connect to Control Centers using this license.

Specific action: Implementation of an action plan

You can run an action plan from another action plan.

This action may be useful to share the operations common to the WINDEV, WEBDEV and WINDEV Mobile projects.

For example, a specific action plan can be used to start WINDEV, WEBDEV or WINDEV Mobile according to a parameter. The useless actions can be disabled by apDisableAction.

In this case:

The action plan contains the 3 startups of the products.

The initialization code of the action plan is as follows:

SWITCH pNomProduit
	CASE ~= "WD"
		// On ne veut pas lancer WEBDEV ni WINDEV Mobile
		paDésactiveAction(Lancement_de_WEBDEV)
		paDésactiveAction(Lancement_de_WINDEV_Mobile)

	CASE ~= "WB"
		// On ne veut pas lancer WINDEV ni WINDEV Mobile
		paDésactiveAction(Lancement_de_WINDEV)
		paDésactiveAction(Lancement_de_WINDEV_Mobile)

	CASE ~= "WM"
		// On ne veut pas lancer WINDEV ni WEBDEV
		paDésactiveAction(Lancement_de_WINDEV)
		paDésactiveAction(Lancement_de_WEBDEV)

	OTHER CASE
		ExceptionThrow(1, "Ce type de projet n'est pas associé à un produit")
END

WLanguage events associated with an action plan

Two events associated with an action plan:

Event	Runtime condition

Initialization of action plan	Run before the execution of action plan.
End of action plan	Run after the execution of action plan.

Testing an action plan

WINDEV allows you to perform a "Go" of an action plan in order to check its operating mode locally, especially the custom actions containing WLanguage code.