Once you are done with composing and orchestrating your project
1 - you can launch it directly on any computer using the Designer:
Previously you can open the Project Details to set the Run Options (mouse over the option to get explanations):
Click Run button as below
Click button 1 to run a selected project
Click button 2 to run a currently opened project (same as the Run button in the Project Details window above)
The following window is displayed:
Properties:
Unselect “Run in Interactive mode” to run the project in the background if you want to use appRules during the execution. (if you have specified Viewxxxx activities (Base Toolbox) or display results in the activities definition, they will not be displayed during the execution)
The Project is Run by Default as a process launch by the HostService or IIS, but you can also Run it remotely using a selected WebApi Service (Run On server list) - in this case the service must be defined in File-->Master Admin Settings-->WebApi Server Definitions.
Debug (tick this checkbox if you want to log every activities execution details during execution - this info is saved in a file accessible from the Logs/Statistics -> System Log Files menu option - the file name is : project name_timestamp.log - file location: C:\ProgramData\appStrategy\PortalData\Default\Logs)
Monitor Job (check this option to Monitor the execution)
Click the Run button at the top of window to start the execution.
At the end of the execution, click on the Logs/Stats button in the project ribbon to display the project execution statistics
If you tick the View execution Flow checkbox, the process shows the activities executed at run time (in green with a delay at each step specified in the Delay field) and an Execution flow window displayed at runtime allows you to end the execution flow display or cancel the job.
You can also schedule the workflow to run at a specific time or regularly: see Schedule a Project
You can launch a project remotely on the current or a distant machine using the Web Api Service, this service is installed by the appRules Portal Installation Package. see:Web Api Setup for Manual Installation this service can be called by a POST request using Postman for example or can be also launched by an executable with parameters (see Using Web Api)
You can run your project directly from the appRules Home Page. Click the Run button on the Project Toolbar and the following modal will be displayed:
Enter an optional reference for the job, the Server on which to run the job (or Default). "Max Run Time" and "Cache TimeSpan" are defined in the project settings for the project.
Check whether to run the job in background and if extended logging is required (for example if you are debugging the project).
Click the Run toolbar button to run to job.
To schedule a job, display the job scheduling window as follows:
1 - Select the Projects option from the Settings Menu.
2 - In the window displayed, select the project to schedule from the list and click on the Schedule Tab:
Tick the schedule project checkbox and enter the required fields:
Next Run Date/Time: initialize with the first launching date
End Run Data/Time; Set the ending date for the scheduling (Run Until date)
Frequency: Preset (will fill the cron settings for you) or Custom
Hour: 7-22 to run between 7 and 22h59
Day of Week= 0 to 6 (sunday to saturday)
Cron examples:
The Scheduler Service must be installed and started on the machine. see: Scheduler Service Setup
min
hour
day/month
month
day/week
Execution time
30
0
1
1,6,12
*
— 00:30 Hrs on 1st of Jan, June & Dec.
0
20
*
10
1-5
–8.00 PM every weekday (Mon-Fri) only in Oct.
0
0
1,10,15
*
*
— midnight on 1st ,10th & 15th of month
5,10
0
10
*
1
— At 12.05,12.10 every Monday & on 10th of every month
The web api service must be first installed and started (see topic Web Api Service Setup)
The following Postman screens shows how to setup a sample project call using the web API:
The following C# shows how to setup a sample project using the web api:
Connection Params
Description
Organization
The organization. When not specified, Default is used
DatabaseId
The id the project database.
UserId
The user id for running the job
Password
The encrypted user password for running the job.
ApiKey
Security feature, Optional if a webapi key is not specified in the WebApi service config file, Must match the ApiKey on the server if specified - the project will be only run if Apikeys match on client and server
Execution Params
Description
Projectid
The integer id of the project to run
Reference
Optional reference for the job
Interactive
Mode for running the job: false = background (the project is launched only), true = foreground (the api waits for the project to end (used when return arguments are specified -example waiting for a return code to execute another project), Note: Default is false
Arguments
Optional name/value dictionary of arguments for running the job in Json format, leave blank if none (remove the Arguments json)