Integrated Development Environment

This section covers the appRules Designer environment.  It covers the main components including the toolbox, the designer, the property grid associated with the active activity, the Main Menu and Ribbon bar.

 

image019.jpg 

1   Configuration Menu

       

The main top configuration menu gives access to the general features like datasources definitions, datasource Browser…

 

2        Designer

 

The Designer is the work surface for composing appRules projects.  It is the drag/drop environment on which activities are defined and connected to form the flow of the process.  To add a workflow activity to any part of the designer, drag it from the toolbox and drop it on the designer. 

 

 

 

3        ToolBox

 

The Toolbox shows the available workflow activities including the Generic activities and appConnector activities.  The activities in the toolbox are grouped into sections. 

 

4       Project Ribbon

 

This Ribbon gives access to the project management and the properties of the current opened Project

 

 

 


 

image024.jpg 


Menu
Option Description
File Log Into Project Database To Open a different project Database
  User Settings To Edit the current user settings
  Configure Toolbox To Add or Remove activity modules from the current Toolbox
  Switch Window To switch to a different opened window
  Master Admin Options This submenu gives access to the Admin features (Create project Database, License Manager…). It will require to login as a Master Admin
  Developer Options This submenu gives a quick access to the project management options (like Edit or Schedule a specific project)
  Log Out Log Off from the current database and close the application  
Settings RunTime Settings Define the runtime settings for the different environment (test, Production, Development…)
  Users (Admin Only) Define the users and passwords, and their types (Admin, Dev…)
  DataSources Manage the datasources used in the current project database (Datasource Connections, Metadata, File Definitions…)
  Projects Access the Project management window (to copy, delete a project, manage arguments and variables, custom functions and script definitions, project notes…)
Run Validate a Project Allows to Validate the projects one by one without opening them in the Designer (for details about the Validate option see the Ribbon Bar related button in the following pages)
  Run a Project Select a Project and Run it from the application  


 

Logs/Statistics Project Run Details   Display the complete Logs/Stats of a selected project orderderd by Run Instances
  Project Run Instances Display the Run Instances of a selected Project
  Database Log Entries Display the content of the logs for a selected Project (less or more detailed depending on the project settings) Selection can be done in a date range
  Project Activity Statistics Display the statistics related to project activities (number of times that an activity is executed and counters by Status Valid or Invalid)
  Project Datasource Statistics Display the statistics about the project datasources (number of read, update, insert, delete)
  System Log Files Access the Log Files generated by debugging
CheckIn/CheckOut CheckIn Project Database   To Copy a database to another database (the source database elements are not locked for editing)
  CheckOut Project Database   To Copy a database to another database (the source database elements are locked for editing)
DataSource Browser   Allows to read/write Datasources using SQL. Datasources can be accessed using the project database datasources or dynamically setting up the connection in the browser
Utilities Purge Database Logs Entries   Delete the logs in a date range (LogsDetails table)
  Purge Project Run Instances Delete the Run Instances in a date range (WorkflowRunSummary table)  
  Recreate Run Instances Table Drop and Create the Run Instances table (the instanceId counter will be set back to zero  
Monitor Display the list of current running or completed projects, memory usage etc   Allows to filter running processes and kill a selected process.  


Ribbon Bar

image025.jpg 

Option Description
image026.jpg To create a new project
  image027.jpg
image028.jpg Open an existing project
  image029.jpg  
image030.jpg Save the current project


 

image031.jpg Set the current project properties, rename or validate the project, revert activities to a specific version, define/declare the customfunctions and scripts used, set scheduling etc
image032.jpg  


 

imagenotes1.jpg Displays the Notes associated to the current Project
imagenotes2.jpg


 

image033.jpg Displays a summary window of the validation errors for the activities used in the current project   image034.jpg


 

image035.jpg Run the current project
  image036.jpg  


 

image037.jpg Displays summary information and statistics about the project including activity, data source and other counts.   image038.jpg    


 

image039.jpg   Allows revert the current project displaying the list of the saved versions.
image040.jpg   Schedule the project to run at a specific date/time (using the scheduling service)

 


 


Adding Modules to appRules Toolbox

 

To include activity modules in the appRules toolbox, click the button located at the top right of the toolbox :


 

or select “Configure Toolbox” from the File Menu

 

image044.jpg 

Check the selected modules to be included into the Designer and Click ”Reset Toolbox” when done

 

This section explains what is required in Visual Studio to design custom functions that will be called in the appRules Projects.

The appRules Portal installation contains a sample Visual Studio Project that you can duplicate to make your own library (located in the CustomFunctions folder of your appRules Portal installation.

 

image045.jpg

 

Once defined, compile your library and copy it into the C:\ProgramData\appStrategy\PortalData\Default\CustomFunctions folder (NB: if your custom function uses external dlls, put them in the appRulesPortal\bin folder)