Remote SDK stream

The distant request systems

Process provides a system of distant services enabling data exchange with external applications.

The SDK integrates a system of remote services allowing external applications to communicate. It can be read elements of the instance or even create, modify.

All this takes place in a secure context for which the directory remains the guarantor (security in place on the instance).

Technologies

The web services perform data exchange based on a simple HTTP layer. You can use either XML or JSON format.

The syntax used in these flows will have to meet a standard defined by Process.

Principle of exchanges

Securing data flows

Securing data flows is possible at two levels:

• By the authentication flow and the principle of “token” that follow different data flows.
• By restricting the access by setting up an allowed IP range. The configuration key is:com.axemble.security.ExternalAuthenticationAction.allowedAddresses.

Une simple surcharge dans le fichier CustomResources.properties vous permettra de personnaliser cette configuration.

API Cliente (Objets)

Distant request is a first step for us in the inter-connectivity between Process and outside. The second step is to provide APIs client in the most used languages. Obviously, this APIs will call flows and convert them into objects.

This project is still ongoing. Here’s the progress:

Technical overview of flows

Classification of flows by modules

The flows are classified by “modules”, it is simply a thematic gathering of flows.

For instance, flows linked to process’s will be in the Workflow module.

Flow call principle

We will always call the same Controller to execute our flows (the servlet principle) and it will be possible to specify options.

Details of options:

Here’s an example of URL call: http://myvdocserver/vdoc/navigation/flow?module=workflow&cmd=create&_AuthenticationKey=...

XML/JSON envelopes

In the above example, the URL will send (in “POST”) a flow characterizing our request, to which Process will respond with another flow in response to the request.

Prerequisites for the use of these remote flows

The only requirement to be able to handle authentication is to activate the “Login Module” com.axemble.security.loginmodules.ExternalAuthenticationLoginModule. This login module is already set in the default JAAS config but commented. (see the “Login modules” page).

Flow modules

In the context of this flows presentation, the examples will be in XML because it is much easier for human to read. However, the logic of JSON syntax is quite identical.

For information about how streams can be adapted to JSON format, see the page “Flux XML/JSON”.

Information

The flows are led to manipulate different types of data. The page “Types de données” detail the syntax of these different types.

General module : Portal

Upload and Download module : IO

A global module

It should be understood that the “io” module is very versatile.

It allows us to manipulate the files of all other modules: workflow, data universe, library, …

GUID principle

GUID is an acronym for ‘Globally Unique Identifier’, it’s a unique reference number used as an identifier in computer software.

Here’s the principe:

• When you want to download a file, you first prepare the file by booking a GUID that will be returned by the flow. From there, the GUID allows you to download the file at any time, it has been reserved for you.
• When you want to upload a file, we store it in a “temporary” state and we return you a GUID. You can use this GUID to attach your file to a Process document (a “FileCenter” document for example).

Workflow module : Workflow

Data universe module : workflow

Document spaces module : Library

Directory module : Directory

Source : https://wiki.myvdoc.net/xwiki/bin/view/Dev+Floor/SDKFlowsReference