View on GitHub


AgileXRM Documentation

Home –> AgileXRM Quick Start

AgileXRM Quick Start


NOTE: This guide assume you selected the Install QuickStart Samples option in the Installer.

This QuickStart document describes how to create a sample process from scratch.

The content of the process is oriented to show several AgileXRM features using the components of the platform:

The sample process here is not based on a real scenario; the idea is to show the basic concepts of AgileXRM.

The walkthrough starts with a very simple Process and through the following stages, new activities and steps are added.

The time needed to complete this walkthrough is around 50 minutes.

Disclaimer of warranty

Disclaimer of warranty

Quick Start Pre-requisites

This document assumes that:

Stage 1: Designing and running your first process

Duration: 10 minutes

Objectives: Show basic concepts of modeling, publishing and running a process


We have a custom entity in CRM called Parent Entity. The process will manage the lifecycle of Parent Entity. We will create a CRM Task and when this Task is completed, the Status of the record will be changed to Inactive.

Create the process template

The XRM Connection window opens.

Configure Connection Settings

Enter the CRM Server URL, Organization name (use your own values) and AgileDialogs Server

Configure Main Entity

Set Process Name

Add steps (shapes)

The process is modeled and ready to be published.

Publish Process

Review process information and verify Release Option is Release Now and click OK

The process is deployed and ready to be executed.

Running the process

An AgileXRM process can be initiated in several ways:

In this example, we are going to create a CRM Workflow to start the process:

Configure the step to launch the previously created process:

Congratulations! You’ve successfully launched your very first AgileXRM Process!

Now let’s complete the Task created by the process and see the process move forward:

This concludes this stage.

Stage 2: Using Activity-based Forms with AgileDialogs

Duration: 5 minutes



In this stage we are going to add an AgileDialogs Form to be used in Task 1; such Form is going to contain the input fields to be filled in by the user. We will also add a second shape which will update the underlying entity with the chosen values.

Associate a form to a Task

Publish and test new process

This concludes this stage.

Stage 3: Updating Child Entity records

Duration: 5 minutes



In this stage we are going to create children entities of Child Entity type attached to our Parent Entity record in CRM, all by using our process template. For that goal, a new shape will be added with functionality to add those children entities through AgileDialogs interface.

Adding new Dialog Task shape

This concludes this stage.

Stage 4: Changing process flow at runtime

Duration: 5 minutes



In this stage we are going to skip a process activity at runtime.

Change the flow

This concludes this stage.

Stage 5: Process migration

Duration: 10 minutes



In this stage we are going to modify the process definition and migrate the process instance that we have left running in the previous stage to the new version of the process. The new process definition will include a multiple condition shape with a loop and a shape to update the Status of all child records.

Add the multiple condition shape

We want to go back to Task 1 if the Option Set field in Task 2 is set to the value Option 1:

Add the multiple change status shape

As the query expression for this shape is the same as the earlier Update Children step, let’s copy the query definition:

You can see that the process is now running with the latest version of the process definition.

This concludes this stage.

Stage 6: Using AgileDialogs.

Duration: 10 minutes



An AgileXRM task can be associated to a dialog created using AgileDialogs instead of an AgileLightForm. These dialogs are used to gather information from the user via a wizard-like interface.

We are going to change Task 1 to use a predefined dialog instead of an AgileLightForm.

Deploy the Dialog

The dialog is already modeled and is stored in a Visio file where the SDK is installed (normally in C:\Program Files (x86)\AgileXRM\SDK\Samples\QuickStart )

Adding the Dialog Task

Notice that when the dialog is finished the process continues to the next step.

This concludes this stage.

Stage 7: Starting Processes from SharePoint

NOTE: This stage assumes you enabled a SharePoint Web Application when you installed AgileXRM via the Quick Installer. If you did not, this stage cannot be completed.

Duration: 5 minutes

Objectives: Show that people outside CRM or even outside the company can initiate and interact with processes (and dialogs)


We are going to start a process using a pre-created Start-Up Form from SharePoint.

Preparing SharePoint

It is assumed you are familiar with SharePoint.

Setting StartUp Form

In order to allow starting a process from SharePoint, the process must have a start-up form.

Since we are changing the launch method (via external web instead of via CRM WF), we need to deactivate the CRM Workflow we created in Stage 1 so that we do not end up with two instances of the process for the same record.

Initiate Process via SharePoint

The start-up form is opened:

This concludes this stage.

Manual Installation Instructions