Page History: Web Service Interface
Compare Page Revisions
Page Revision: 2009/07/11 14:31
Web Service Interface
This page describes how to use the Jetfire Web Service Interface to gain access to your Jetfire workflows.
Target Audience: designers building Jetfire applications.
Introduction
The Jetfire Web Service emulates many of the functions seen in Jetfire workflows. Like any web service, it does so by abtracting the characteristics of the implementation. Functions of the Web Service include:
- Login/Logout
- Create/Delete/Save a Workflow
- Execute commands on a Workflow
- Get Workflow
- Get Workflows
- by name
- by guid
- by state
- by class name
- Get Workflow Class
Workflow Members
Workflow members include:
- Properties are the attributes of the workflow
- Methods are typically used as commands that connect to the user
- States are used to transition the workflow
Methods and States are fairly simple. Properties are more characteristics.
Each State in the Workflow has a name. The Current State and Previous State are tracked in the workflow by properties, CurrentState and PreviousState respectively.
To the user (and Jetfire GUI designer), Methods are represented by a (unique) Name. They also have a Display Name, i.e. the name displayed to the user, and a ToolTip, i.e. a description that provides a 'what does this command do?' explanation.
Properties
Properties have a number of characteristics that include:
- Name - a unique name for the property in the workflow
- Display Name - the name displayed to the user for the property
- ToolTip - a description of the property
- Value - the value of the property
- ClassName - the data type used to define the property value
- Guid (optional - only used if the property is a workflow)
- DefaultValue - the default value used if the value is blank
- Display? - a flag that indicates whether to display the property
- FormElement - the type of Control used to display the property
- Position - used in the display of the property
Display, FormElement and Position are display characteristics that are set in the Server. The designer may choose to ignore these attributes to create custom displays.