DCR Active Repository

Using the RESTful API we’ll implement all elements of the RESTful API supporting collections of Process Models, Process Model instances and events. Using the RESTful API Process Models can be modified, instantiated, executed etc.

An example of how to use DCR Active Repository using the Postman tool can be found here.

Access to DCR Active Repository requires your DCR username and password and use http basic authentication. Access to the repository requires a commercial license.

The engine API interface outlines the programmatic interface.

Notice: The list of URLs is not complete and not everything is implemented at the moment. We’ve marked working areas with an asterisk (*).

DCR Process Model are represented using DCR XML which is the output of the DCR designer tool. DCR XML is used both for classes and instances of processes.

The list of Process Model returned contain the following data:

<graphs>
<graph id=”1234″ title=”My first graph” />
</graphs>

When you initialize a Process Model you can provide the initialization time in the JSON body together with the title of the new instance:

The list of events returned contain the following data:

<events isAccepting=”true|false” nextDeadline=”…” nextDelay=”…” phase=”…”>
<event id=”Activity 3″ included=”true” enabled=”true” pending=”false” executed=”false” fullPath=”Activity 3″ roles=”” groups=”” description=”” label=”Activity 3″ eventType=”” />
<event id=”Activity 5″ included=”true” enabled=”true” pending=”false” executed=”true” fullPath=”Activity 5″ roles=”” groups=”” description=”” label=”Activity 5″ eventType=”” />
<event id=”Activity 6″ included=”true” enabled=”false” pending=”true” executed=”false” fullPath=”Activity 6″ roles=”” type=”…” referId=”…” groups=”” description=”” label=”Activity 6″ eventType=”” />
</events>

The “type” attribute can be “subprocess”, “form”, “nesting”, “instance” or just empty.

The referId attribute points to a graphId – only supported for DCR Forms.

The Execute event takes optional data parameters in the form:
{DataXML: ‘<globalStore><variable id=”‘eventid'” type=”…” value=”…” isNull=”true|false”/> </globalStore>’,
Role: ‘role }

The set absolute time of a Process Model post the following data in the body: <absoluteTime>ISO 8601 time here</absoluteTime>.
Notice – time must be GMT+0, i.e. not local time zone. Format is ISO 8601, i.e. yyyy-mm-ddTHH:MM:ssZ etc.

The data should be in JSON format so in fact we send e.g.

{
time: ‘<absoluteTime>2018-09-05T10:40:27.9197330Z</absoluteTime>.‘ }

Deleting relations take the following JSON structure as a body:
{ sourceId:”Activity1″, targetId:”Activity0″, type: “condition” , }

type is the relationType which can be one of the following values “condition”, “response”, “include”, “exclude”, “milestone” or “spawn”.

The RESTful API will be expanded to include all events and relations of Process Models as well as simulations/instances, thereby enabling adding, updating and removing events and relations directly.

Versions are returned in the following XML:
<versions >
<version id=”64774″ type=”major” title=”First major version” date=”2018-10-01 12.45.22.111z” user=”6″ />
<version id=”64772″ type=”minor” date=”2018-10-01 12.42.22.111z” user=”4″ />
<version id=”64770″ type=”minor” date=”2018-10-01 12.40.22.111z” user=”4″ />
</versions>

We’ve created a Windows application for DCR Active Repository that you can use to experiment with the DCR Active Repository. The source code in C# is available for download.

Meta data about a Process Model returns the following XML:

<graph id=”4013″ title=”Expense – milestone – good coding practice”>
<Collections>
<Collection id=”1952″ title=”DCR Academy” ></Collection>
</Collections>
<Categories>
<Category id=”2252″ title=”DCR Academy – Public Repository” >
<SharedWith>
<user id =”107″ UserName=”hnor” ModeOfSharing=”CanEdit”></user>
<user id =”1526″ UserName=”lopez@itu.dk” ModeOfSharing=”CanEdit”></user>
<user id =”4″ UserName=”marquard” ModeOfSharing=”CanEdit”></user>
</SharedWith>
</Category>
</Categories>
<Owner id=”4″ UserName=”marquard” OrganizationId=”1″ Organizationtitle=”Community” ></Owner>
<SharedWith>
<user id=”42″ UserName=”Hamza.Ahmad” ModeOfSharing=”CanEdit” ></user>
</SharedWith>
</graph>

Accessing this API requires a commercial license.