Introduction

The TIBCO Foresight® REST API is a front-end API to the TIBCO Foresight® Instream® and the TIBCO Foresight® Translator engines. Foresight® REST API is a Java-based application and uses the Foresight® Instream and Foresight® Translator Java libraries for validation and translation processing.

Validation Process

TIBCO Foresight® Instream® validates an EDI datafile against a guideline and reports any errors found. The user can also produce EDI response documents if the Response Generator options are specified, and can split the datafile into smaller parts if the Doc Splitter options are specified.

Inputs	Outputs
EDI datafile	Validation results
Guideline	Response documents (Optional)
Validation controlfile (Optional)	Split files (Optional)
Response Generator controlfile (Optional)
Doc Splitter controlfile (Optional)

Translation Process

Foresight Translator translates an EDI datafile into other formats, such as XML, Flatfile, EDI, etc. and vice versa. To perform the translation, it uses two guidelines or schemas (a ‘from’ guideline/schema and a ‘to’ guideline/schema) and a map that links the from fields to the to fields.

Inputs	Outputs
EDI or XML data file or Flatfile	Translated data files
Map file
Source (or From) guideline or schema
Target (or To) guideline or schema
Translation type

Technical Overview

Foresight REST API is based on Java API/DLLs and uses four REpresentational State Transfer (REST) operations: PUT, GET, POST, and DELETE. It uses the following resources as input, for processing and for generating the output:

• Guidelines (PUT, GET, and DELETE)

• Data Files (PUT, GET, and DELETE)

• Control Files (PUT, GET, and DELETE)

• Map Files (PUT, GET, and DELETE)

• Jobs (POST, GET, and DELETE)

• Output Files (GET, and DELETE)

Foresight REST API includes four types of callbacks:

• Foresight Instream/Foresight TranslatorMid-Processing Callback

• File Request Callback

• Notification Callback

• Message Callback