TotalAgility concepts used in this tutorial

This topic describes the TotalAgility concepts used in this tutorial.

Data models

A data model is a user-defined data structure that represents a collection of data.

Data models simplify integration with REST APIs and reduce database storage space. A data model is used to group data together. The data held within the structure can be used in processes and forms using the Data object variable.

A Data model can be global or local.

A global model is available to all processes and forms, but a local model is available only to the form or process it is defined for. A local data model is useful for one-off integrations when you do not have to reuse the data model.

You can create a global or local data model manually or using a sample JSON.

If you use a JSON file, the JSON format is parsed, and a tree structure is created. The field names in the data model match that of the JSON, and the field types are implied from the JSON sample. Any ambiguous field types are set to String. You can edit the data model by changing field types or deleting the fields that you do not want.

Data object variable

A Data object variable is used to hold a data model (global or local). This data model then can be used in a process and form.

You can create multiple Data object variables referring to the same or different data models.

You can use a data object variable to store the request sent and/or response received from a RESTful service.

RESTful service activity

The RESTful service activity is used to integrate TotalAgility with external applications. This activity can integrate with external applications through the RESTful web service references.

TotalAgility supports only simple types of RESTful web services, which should not be used with complex data structures.

RESTful web services typically map the four main HTTP methods to the operations they perform: Post, Get, Put and Delete.

The web service only sends the basic HTTP verbs - GET, PUT, POST, and DELETE - to the server and expects JSON or XML as response.

For example, http://service.com/emp/123

XML format JSON format
<Emp>
           <Name>ABC</Name>
           <Id>321</Id>
           <Email>abc@domain.com</Email>
           <Org>Kofax</Org>
</Emp>
{
         "Name":"ABC",
         "Id":"321",
         "Email":"abc@doamin.com",
         "Org":"Kofax"
}

Web service references

The Web service references are used to connect to the third-party software applications, regardless of how each web service is implemented. For example, TotalAgility can integrate with a web service that automatically retrieves vehicle details or retrieves safety test history for a vehicle.

Document templates

A document template is used to create a document.

You can upload document templates to TotalAgility and use these templates in a Document creation activity to create a document.

Note: TotalAgility only supports Microsoft Word templates, .dotx and .dotm.