Transflo DMS Enterprise API

To help you understand the different types of API documentation and processes for TRANSFLO® Enterprise, this knowledge base (KB) provides the steps, terms, concepts, and sample code that describe what is required. For example, you can use the API to submit a batch to the TRANSFLO® Server using the TRANSFLO® Web Service Interface.

The following types of API configurations are covered:

 

 

Transflo DMS API Glossary of Terms

alias 

In Transflo DMS, an alias is a subset or subclass of the fields and properties of a Transflo document class. An alias is essentially a copy of a document class. Creating multiple aliases for a document class allows you to have multiple instances of that document class. Aliases are used by Capture and Batch Scan. During imports, aliases map Gauss bases to workflows. By default, each document class that you create is automatically assigned an alias of the same name. You can edit the name and create more aliases. You can use an alias to configure fields, document types, and other parameters to customize the Capture application.

batch

In Transflo DMS, a batch is a collection of document images with associated metadata. A batch is often stored in a ZIP file that contains the TIFF images and the metadata in an XML data set.

case

In Transflo DMS, a case is an instance of a workflow process.

COM

Component Object Model (COM) is a Microsoft standard for the interface used for communication across components. In Transflo DMS object models, data architectures, and APIs, the Microsoft COM standard plays a key role. COM specifies the basic binary object standard, defines certain basic interfaces that provide functions common to all COM-based technologies, and provides a small number of functions that all components require.

COM defines how objects work together over a distributed environment and has added security features to help provide system and component integrity. A software object is made up of a set of data and the functions that manipulate that data. Access to COM object data is achieved exclusively through one or more sets of related functions called interfaces. The functions of an interface are called methods. COM requires that the only way to gain access to the methods of an interface is through a pointer to the interface.

DIME

Direct Internet Message Encapsulation (DIME) is the binary message format used by the TRANSFLO® Web Service Interface to transmit document batches and associated metadata.

document

In Transflo DMS, a document is an image file of a scanned page usually stored as a black and white TIFF image.

document class

In Transflo DMS, a document class (DocClass) is a defined set of document types and associated fields. A Transflo document class has built-in security and is a good way to separate types of documents by department where document data is sensitive in nature, such as documents for human resource personnel records, taxes, billing, security, military, or government data.

document type

In Transflo DMS, document types are the different document types determine how documents are classified. Examples include bill of lading (BOL), proof of delivery (POD), receipt, lumper, and driver log.

field

In Transflo DMS, a field is a metadata element for a document (for example, to store the document type and other properties) or a batch of documents (batch-level field).

indexing application

A Transflo DMS software application that includes a document viewer and a data entry component used to attach metadata to individual documents or a batch of documents.

.NET Framework

A software technology by Microsoft that includes a large library of pre-coded solutions to common programming problems, a run-time or virtual machine that manages the execution of programs written specifically for the framework, and a set of tools for building and configuring applications. Transflo DMS requires and attempts to install .Net if not already installed on the server and client machines.

queue

In Transflo DMS, a queue is a location where batches accumulate to be processed in first-in first-out (FIFO) order by a Transflo application or service.

TIFF

Tagged Image File Format (TIFF) is a compressed file format for storing images.

WFI

In Transflo DMS, a workflow indicator (WFI) is a database flag used to determine whether a batch of documents should also trigger the creation of a workflow process case. An associated workflow initiator file contains the data required to start a case (an instance of a workflow file).

WSDL

Web Services Description Language.

WSE

Web Services Enhancements (WSE) is an add-on to the Microsoft .NET Framework which includes a set of classes that implement additional WS-* Web service specifications chiefly in areas such as security, reliable messaging, and sending attachments.

 

The TRANSFLO® API is intended for software developers, engineers, and architects who are implementing solutions that will expand the TRANSFLO® DMS suite of products. Pegasus TransTech reserves the right to make updates and improvements to any Transflo API with or without notice.