Method and apparatus for utilizing a standard transaction format to provide application platform and a medium independent representation and transfer of data for the management of business process and their workflows

BACKGROUND OF THE INVENTION
1. Field of the Invention
Businesses are demanding new systems that directly support the management of business processes, systems that bring order and coordination to the flow of work. They are seeking to automate that part of office work that has been impervious to conventional data processing and information processing systems, which were not designed for business process management and are not well-suited to help with it.
The present invention is part of a system that, when implemented in software, provides businesses with the tools they need to manage business processes efficiently and cost-effectively.
The invention can be applied to such a system, whether the system is a simple application, such as intelligent forms routing, to sophisticated mission-critical enterprise-wide systems that integrate all marketing, production, and customer fulfillment processes.
The resulting system enables users of the system to take coordinated action quickly and to manage processes painlessly. The results are increased productivity, reduced cycle time and hence, improved customer satisfaction.
Workflow-enabled systems facilitate business processes. To do so, a workflow management system performs eight key functions:
Notifies the user that he or she has a step to begin or to complete.
Provides the user with the proper tools to complete a task.
Provides the user with the proper information to complete a task.
Allows the user to see where a task fits in the overall process.
Manages the proper reminders, alerts, and follow-ups to keep the process moving.
Automates certain standard procedures.
Integrates with the organization's existing business systems.
Provides simple application program interfaces (APIs) that allow developers to develop new custom applications that are workflow-enabled.
The workflow system's architecture is designed to fit within a variety of computer systems, collecting around itself not only specific applications, but also system enhancements and utilities from users and third-party developers. In addition, the architecture is designed to allow for interoperability among different applications and across diverse platforms.
A fundamental concept of a workflow system is that any business process can be interpreted as a sequence of basic transactions called workflows. Every workflow has a customer, a performer, and conditions of satisfaction. The customer and performer are roles that participants can take in workflows. In addition, each workflow can have observers.
In a workflow, the customer is the person for the sake of whom the work is done, either because they made a request or accepted an offer. It is customers who are responsible for evaluating performed work and determining whether this work meets their conditions of satisfaction.
The performer is the person who is responsible for completing the work and for declaring to the customer when the work is done.
Requests and Offers are the two basic types of workflows. There are other workflow types such as Question, Inform and Note that are simplified derivations of Request and Offer. The conditions of satisfaction specify the work to be performed by the performer. In a request, the customer specifies the conditions of satisfaction, and in an offer the performer specifies them. (Then, of course, the two can enter into negotiation about the work to be done.)
For example, given the sentence:
"John asked Frank to prepare the report and deliver it by noon on Friday,"
John is the customer for this workflow, Frank is the performer, and the conditions of satisfaction are "prepare the report and deliver it by noon on Friday." Further, because John asked for the report rather than Frank offering it, this workflow is of the type Request.
Given the sentence:
"John proposed to prepare the report and deliver it by noon on Friday for Frank,"
John is the performer for this workflow, Frank is the customer, and the conditions of satisfaction are still "prepare the report and deliver it by noon on Friday." Further because John proposed the report rather than Frank asking for it, this workflow is of the type Offer.
Observers of workflows take no direct action; they usually observe for management or training purposes.
Business process maps display the workflows as loops, and display the relevant information about each workflow--the customer, the performer, the conditions of satisfaction and the cycle time. FIG. 1 is a business process map having a primary workflow 11, conditional workflows 13 and 15, a conditional link 17, parallel workflows 19 and 21, serial workflows 23 and 25. In a workflow system of the type used in conjunction with the present invention, associated with each workflow are various parameters such as roles, cycle time, conditions of satisfaction or associated semantics to the links that imply automated action or provide the framework for application building, all of which are necessary to create a useful business process representation.
Each workflow has four phases as shown in FIG. 2. The first phase is called the proposal phase during which a request is made of the prospective performer by a customer or an offer to a customer is made by a prospective performer. The second phase is called the agreement phase during which the offer is accepted by the customer or the request is agreed to by the performer and conditions of satisfaction are identified. Of course, during the agreement phase the original conditions of satisfaction can be negotiated by the customer and performer until an agreement is reached. The third phase is called the performance phase during which the performer undertakes to meet the agreed to or accepted conditions of satisfaction. When the performer believes that the conditions of satisfaction have been met, the performer declares completion. The last phase is the satisfaction phase during which the customer determines whether or not the conditions of satisfaction have been met by the performer, and if so, declares satisfaction.
A workflow system incorporates the following components which are shown in FIG. 3, a workflow server and databases, application program interfaces (APIs) and workflow server manager. In addition, a complete workflow system of the type in which the standard transaction format (STF) processors of the present invention may be utilized includes an application builder, analyst, workflow enabled applications and reporter components. The application builder, analyst, workflow enabled applications and reporter components, while useful components of a complete workflow system, do not form part of the present invention and details concerning such components are set forth herein only as needed for an understanding of the invention. The present invention is concerned mainly with STF processors used in combination with a complete workflow system.
A workflow system provides certain services as follows:
transactions services which are those related to initiating and acting in workflows by users and agents;
definition services which are those related to defining the elements of a business process and its workflows and workflow links;
names and routing services which are those related to defining organizational roles and identities;
configuration services which are provided to the system administrator through a specific configuration database;
scheduling services which allow an authorized user to create, modify and delete records of scheduled business processes; and
STF processing services which are provided by the server to STF processors (which are the subject of the present invention as described below) through an STF queue database.
Further details concerning the definition services, names and routing services, configuration services and scheduling services are set forth in co-pending U.S. Ser. No. 08/014,796 filed Feb. 8, 1993. The present invention is directed to the STF processing services provided by a workflow system as well as STF processors.
In addition to the foregoing services provided by a workflow system, external interfaces to the system provide services that are used by end-user applications, the workflow application builder, the workflow reporter and the STF processors.
A workflow system utilizes a workflow server which concentrates workflow operations in the server rather than in the end user applications.
All work done by the server is performed by one of three processes which are referred to as the transaction manager, follow-up manager and date/time schedule manager. Processes are software components or tasks that are architected to run as separate entities from each other. The workflow server controls the three basic processes based upon workflow system server administration data in a configuration database in the following manner. First, it determines when to run the transaction manager and spawns that process. Second, it determines when to run the follow-up manager and spawns that process. Third, it determines when to run the date/time schedule manager and spawns that process.
These processes may be separate executables or simply separate tasks within the body of the workflow system server.
A workflow system also utilizes:
a definitions database which contains records of the definitions of the organizations, business processes, workflows, roles, and acts;
a transactions database which contains records of the enactment of workflows;
a names/routings database which contains records of the roles and identities of the organization where the workflow system is installed;
a schedule database which stores the date and time when a business process must be initiated;
an administration/configuration database which stores information needed by the workflow server to operate; and
a STF queue database which stores the records of notifications to be sent to users that interact with the workflow system through an STF processor interface.
The remaining elements of a workflow system are:
1) Workflow APIs which provide a programming interface to access the services of the workflow server. Workflow enabled applications, STF processors and the application builder are all developed using these APIs. APIs of a workflow system are as follows: transactions API, definitions API, reporter API, names and routings API, schedule API and administration API.
2) Workflow server manager which is a component of the workflow system that provides a user interface for specific maintenance and administration services of the workflow server.
3) Workflow application builder which is a Graphical User Interface (GUI) application that allows a business process designer to specify the business process design with its network of workflows and to automatically generate the definitions needed for a workflow enabled application to work.
4) Workflow analyst which is a GUI application that allows a business process analyst to specify the map of business processes with its network of workflows.
5) Workflow reporter which is a GUI application that provides an interface to the transaction databases through the workflow reporter API of the system.
6) Workflow-enabled applications which interface to the server via the workflow APIs or via direct access to the transactions database of the workflow server, or via the use of an STF processor which can use different interfacing mechanisms such as messaging, database or inter-process communication.
7) STF processors which are a set of mechanisms for developing workflow-enabled applications are provided in a workflow system through the definition of a standard transaction format (STF). Such STF processors are the subject of the present invention.
In U.S. Ser. No. 600,144 filed Oct. 17, 1990 and U.S. Ser. No. 07/368,179 filed Jun. 19, 1989, both owned by Action Technologies, Inc., the assignee of the present application, methods and systems for managing workflows, called conversations in the referenced applications, are described. However, the teachings in the cited references are limited to single workflows with no capability for mapping business processes made up of a number of workflows linked together. In U.S. Ser. No. 08/005,236 filed Jan. 15, 1993 now U.S. Pat. No. 5,630,069, a method and apparatus are disclosed for creating and modifying business process maps which is a desirable but not necessary component of a workflow system. This component is referred to as the workflow analyst. In U.S. Ser. No. 08/014,796 filed Feb. 8, 1993, a method and apparatus are disclosed for implementing a complete workflow system for managing business processes and their workflows.
BRIEF SUMMARY OF THE INVENTION
The present invention is a method and apparatus which is used to enable application developers to generate workflow enabled applications which request services from the workflow server component of the workflow system, remotely and indirectly using messaging, shared databases or inter-process communications. The present invention provides a standard transaction format (STF) for accessing such a workflow system through STF processors via messaging, updates to the shared databases or inter-process communications. Workflow enabled applications are used by users to act and participate in business processes and enable users and managers to observe and query the status of workflows and business processes.
In describing the invention, the following terms with their indicated definitions are used:
Act
Basic linguistic occurrence by which people intervene in moving a workflow towards completion.
Agreement
The outcome of the negotiation phase, in which two parties come to a common agreement of the conditions of satisfaction.
Business Process
A network of workflows linked together that represent the recurrent process by which an organization performs and completes work, delivers products and services and satisfies customers.
Business Process Map
This is a graphical representation of business process, which shows its workflows and their relationship.
Primary Workflow
This is the first workflow which is initiated when a business process is initiated. Its condition of satisfaction represent the condition of satisfaction of the business process.
Conditional Link
A link that indicates that only one of a group of workflows will be triggered based on some condition.
Conditions of Satisfaction
Conditions declared by or agreed to by a customer. The fulfillment of which is the purpose of a workflow.
Customer
The role in a workflow who makes a request or accepts and offer.
Customer Satisfaction
The objective of a workflow, the accomplishment of which is declared by the customer when the conditions of satisfaction in the workflow have been fulfilled.
Cycle Time
A measure of the time from initiation to successful completion of a workflow phase, a complete workflow or a business process.
Exception Flow
The path in the business process workflow map which is followed if a customer cancels or a performer revokes or declines.
Link
A defined dependency between two workflows and the mechanism by which dependencies between workflows is established.
Loops (Workflow)
A workflow is represented graphically by an elliptical loop with arrows shown in a clockwise direction wherein each quadrant of the ellipse signifies different phases of the workflow.
Normal Flow
This is the path followed in a business process map when workflows complete with customer satisfaction.
Observer
A role in a workflow who cannot perform acts in the workflow, but is informed of acts in the workflow, and has access to the information and data associated with the workflow.
Offer
The act by which the performer can initiate a workflow, specifying conditions of satisfaction that he is willing to satisfy for a customer.
Organization Roles
Named positions in an organization who are authorized to make certain requests, agreements, take certain actions, set certain policies, and make certain decisions. The kind of roles will be accountant, office manager, etc.
Performer
One of the principal roles in a workflow: the role that commits to complete the conditions of satisfaction.
Phase
A characterization of the status of a workflow based on the acts that have happened and the acts that are permitted. Each workflow has four phases namely, the proposal phase the agreement phase, the performance phase and the satisfaction phase
Request
A customer does this act to initiate a workflow and declare conditions of satisfaction.
Trigger
An action in a workflow which causes an action in some other workflow.
Triggered
Action in a workflow based on certain conditions/status in some other workflow.
Workflow
A structured set of acts between customers and performers organized to satisfy a customers conditions of satisfaction.
Workflow Activation
A triggered action that enables the customer or performer of the workflow to take the initial act of the workflow.
Workflow Initiation
An act of request or offer initiates a workflow.
Workflow Roles
The association of participants in the workflows that take the acts in workflows; three roles are distinguished in workflows: customer, performer, and observer.
Workflow Type
This indicates whether the workflow is of request, offer or note type.

BRIEF DESCRIPTION OF THE DRAWINGS
FIG. 1 is pictorial representation of a business process, i.e., a set of linked workflows.
FIG. 2 shows the phases of a workflow.
FIG. 3 is a block overview diagram of a complete workflow system including STF processors.
FIG. 4 is a block overview diagram showing the major components of an STF processor.
FIG. 5 shows the exchange of STF transactions between a workflow enabled application, the STF processor and server.
FIG. 6 is a generic class hierarchy diagram of a STF processor showing how the classes in STF processors are linked.
FIG. 7 shows the interaction of workflow enabled application, STF processor and workflow server for different kinds of transactions.

DETAILED DESCRIPTION OF THE INVENTION
Overview
The present invention is directed to a Standard Transaction Format (STF) specification to address the requirements of applications, platform and medium independent representation and transfer of data related to business processes of a workflow system. The present invention is also directed to STF processors which are the modules that provide the server-side connection point for client/server interactions using any of several STF specification variants. These STF specification variants are messaging, updates to shared databases and inter-process communications. By accessing STF processors workflow enabled applications, using a standard transaction format, are able to request services from the workflow server component of the workflow system, remotely and indirectly using messaging, shared databases or inter-process communications. In other words, the STF specification defines the semantics for accessing the workflow services.
For each one of these types of interfaces there is a syntactic definition that gives the specific format for the representation of the workflow data and the process specific data in that medium. This syntax definition constitutes an STF specification that a particular workflow enabled application will then use.
The communication and interface between workflow enabled applications and the server is provided by STF processors. These STF processors map and translate between a workflow-enabled application's data format and the data elements of the workflow system APIs.
STF processors provide a layer for integration of many different protocols and technologies. STF processors can be constructed for any message transport database technology, and inter-process communication protocol.
The interface from STF processors to the server is accomplished through the workflow system APIs. From the point of view of workflow services, the STF processors appear to the server as additional applications.
Since an STF processor is an application whose job is to interface external systems to the workflow system, there is one STF processor for each different type of system that interfaces to the workflow system.
Business processes can be managed across platforms in diverse locations with diverse interconnections through the management of a class of transaction called STF transactions. Transactions include taking acts, getting reports of status, and notifications of acts taken by other workflow participants, among others.
Three classes of STF processors are described, which are characterized by the method of connection between client and server, which, as previously noted are: messaging, shared database, and inter-process communication. Within these interfaces, STF processor variants are required to conform to the various syntactic requirements of the communication technology. The particulars of such variants depend upon such syntactic requirements, however, the implementation details of such STF processor variants should be apparent to persons skilled in the art having knowledge of the syntactic requirements and the descriptions contained herein.
The client/server communications medium determines whether a client application can run synchronously with the server--making server requests and receiving server responses during the duration of a connection, or asynchronously--making server requests, disconnecting, and reconnecting later for responses. Inter-process communications media typically allow synchronous connections between client and server, message based media typically allow only asynchronous communication between client and server, and clients and servers which communicate through a shared database can operate either synchronously or asynchronously.
Thus, while STF processors may be provided for several STF specification variants, an STF processor with generic functional requirements is described. Further, this description focuses particular attention to the requirements of an STF processor for a messaging platform known as MHS (message handling system) available from Novell Corporation which will serve as an example case.
FIG. 4 shows the major components of an STF processor, namely, a transporter module, which includes a transaction parser and a transaction formatter, and a transaction processor module. The transaction processor module processes STF transactions received from workflow enabled applications through the transporter module and sent to workflow server via calls to the workflow server APIs. Similarly, it processes transactions queued by the workflow server and passes them to the transporter module to be sent to the WEA. The transaction processor is environment independent. The transporter module is adapted to the STF environment (i.e., messaging, shared database or inter-process communication) and receives incoming transactions from a messaging application, shared database or inter-process communication and sends outgoing transactions to a messaging application, shared database or inter-process communication.
The workflow transactions API provides an interface to the workflow server. The workflow server responds to transactions it finds in the transactions database and updates the workflow and places status information in the STF queue database to be processed by STF processors.
STF Transactions
An STF transaction is a workflow transaction defined in a specific format called Standard Transaction Format (STF). This standard enables any application to interface to the workflow server. An application is said to be a Workflow Enabled Application (WEA) when it is able to send/receive the workflow transactions in STF. STF transactions are passed from the STF processor to the workflow server via calls to the transactions API.
An STF transaction is composed of an envelope and workflow data. The envelope provides connection and addressing information translated by STF processors to formats appropriate for the particular medium supported by the STF processor. Workflow data includes workflow specific data and bound process data. STF transactions are exchanged between client and server as shown in FIG. 5. The figure shows some types of transactions as well as the role of the STF processor.
There are five STF transaction types as follows:
Initiating a workflow
Acting in a workflow
Requesting the status of a workflow
Requesting list of declared business processes
Requesting list of workflows with pending actions
Components of STF Transactions
STF Envelope
The STF envelope is entirely platform and medium dependent. The envelope contains addressing information. In a messaging environment, the STF envelope would typically specify user and STF processor email addresses or equivalent. In an IPC environment (connection oriented), the STF envelope would typically specify a logical unit identifier or equivalent. In a database environment, the STF envelope would typically specify user and STF processor identifications or equivalent.
It contains STF Processor ID for identification of a particular STF processor. Essentially this is the address with which a WEA sends an STF transaction.
For example, to address an STF processor STFPROC1 in work group ATI, a WEA in a messaging environment might specify the STF processor address as follows:
To: STFPROC1@ATI
Workflow Data
As previously noted, workflow data includes workflow specific data and bound process data.
Workflow Specific Data
All workflow transactions include a set of required workflow specific data elements that are defined by the STF specification.
The workflow specific data component of an STF transaction contains workflow attributes required to do each of the five types of transactions. Each type of STF transaction has a different set of workflow information. The STF transaction sent by a WEA must contain a Transaction ID (STFID) keyword. This aids the WEA and STF processor in identifying a transaction uniquely and helps the STF processor in sending status transactions to the WEA. Each STF transaction also has a set of mandatory parameters called minimal transaction parameters. Each STF transaction may also contain other optional parameters which are called extended set parameters.
An example of a minimal set of parameters for the workflow specific data component of an STF transactions is as follows:
STF type (transaction type)
STF transaction identification
An example of an extended set of parameters for the workflow specific data component of an STF transactions is as follows:
workflow participants or users
workflow type
transaction type
expected and/or requested workflow completion dates
workflow status
Bound Process Data
Bound process data are data elements which are managed by the workflow server for purposes of management and as values in assignment, calculation, and flow control statements. Bound data elements are application-specific extensions to the STF specification. Examples include sales price, image data, and quantity ordered. These additional data elements can be used in processing and display definitions of client applications and the processing and control of business process definitions at the workflow server. For example, a time sheet submission workflow includes bound process data in the form of project names and hours worked. The business process definition might specify that the sum of hours worked on a particular day is used to calculate an employee's paycheck amount which is used in a recurrent automated workflow to cut a pay check.
The STF interchanges shown in FIG. 5 are realized via client applications, STF processors, and workflow server interfaces. For example, a workflow enabled application may use MHS messages to send STF transactions to the workflow server. STF transactions are sent as attachments to MHS messages. The STF processor receives these messages, identifies the STF transaction, parses the transaction and passes information as required to the workflow server.
Mapping Between STF Transactions And Workflow Server APIs
The workflow server APIs provide the following functions:
Initiate a workflow
Act in a workflow
Bind process data
Get bound process data
Get field attributes
Get Workflow Status
Get Available acts
Get Available Business Processes
Get Workflows in progress and pending actions
The STF transaction set is designed to facilitate the invocation of workflow server API functions and to return status reports. Workflow server API functions to STF transaction mapping is shown in Table 2. Descriptions of the specified workflow server APIs may be found in co-pending U.S. application Ser. No. 08/014,796 filed Feb. 8, 1993.
TABLE 2______________________________________STF Transaction AWS APIs called by STF Processor(Transaction Keyword) and their purposes______________________________________Initialising a BeginTransactionBusiness Process AWSTBEGINTRANSACTION ()(InitBP) Initialise Business Process AWSTINITBP () Bind Application Data to the BP AWSTBINDAPPDATA () End Transaction AWSTENDTRANSACTION ()Initialise a Workflow BeginTransaction(InitWF) AWSTBEGINTRANSACTION () Initialise workflow AWSTINITWF () Bind Application Data to the WF AWSTBINDAPPDATA () End Transaction AWSTENDTRANSACTION ()Take an Act in a WF BeginTransaction(Act) AWSTBEGINTRANSACTION () Take an Act in the WF AWSTACTINWF () Query the Status of the Act AWSTACTSTATUSQUERY () Bind Application Data to the WF or BP AWSTBINDAPPDATA () End Transaction AWSTENDTRANSACTION ()Bind Application data BeginTransactionto a Workflow AWSTBEGINTRANSACTION ()(Bind Data) Bind Application Data to the WF or BP AWSTBINDAPPDATA () End Transaction AWSTENDTRANSACTION ()Get the status of a Get the status and dates of the WFWorkflow AWSTSTATUS ()(GetWFStatus) Get the number of available acts AWSTNUMAVAILABLEACTS () Get the available acts AWSTAVAILABLEACTS () Get the number of App data structures AWSTGETNUMAPPDATA () Get the App data bound of the WF AWSTGETAPPDATA () Get the moment specific App Data of the WF AWSTGETAPPDATAFIELDATTRIBUTES ()Get Available Business Get the Number of Available BPsProcesses for specified identity(GetAvailableBPs) AWSTNUMAVAILABLEBP () Get the Available BPs for specified identity AWSTAVAILABLEBP ()Get the Workflows Query for the number of Pendingwhere action is WFspending) AWSTNUMQUERYWF ()(GetPendingActions) Get the Pending WFs AWSTQUERYWF ()Notification generated Poll STFQ for Notificationsby Workflow Processor AWSTPOLLSTFQUEUE ()(ReturnWFStatus) Get the status and dates of the WF AWSTSTATUS () Get the number of available acts AWSTNUMAVAILABLEACTS () Get the available acts AWSTAVAILABLEACTS () Get the number of App data structures AWSTGETNUMAPPDATA () Get the App data bound of the WF AWSTGETAPPDATA () Get the moment specific App Data of the WF AWSTGETAPPDATAFIELDATTRIBUTES ()______________________________________
In the case of a message type of interface, both the STF processor and the Workflow Enabled Application (WEA) read (write) messages from (into) predefined message queues (i.e., directories). Similarly, in a database type of interface they read/write records of a shared database. The STF processor is constantly servicing requests from a WEA. The interface of STF processor with the WEA and the server in both these cases is asynchronous. However, in the case of a IPC based interface, the interaction between WEA and the STF processor is synchronous.
Each type of STF processor is a separate executable (EXE). When installing the STF processor, its ID (name) is registered in the server via the workflow server manager module.
To provide the necessary functionality, an STF processor deals with these different requirements through creation of a base Transporter class. Three subclasses are derived from the Transporter for: Msg, Database, and IPC. From Msg, further subclasses can be derived for the various messaging platforms supported, such as MHS, VIM or MAPI. From Database, a subclass such as for SQL can be derived. From IPC, subclasses can be derived for environments such as APPC. FIG. 3 shows the interrelation of these classes in the cases of incoming and outgoing transactions.
STF Transaction Definitions
InitBP
This transaction is used to initialize a business process and the primary workflow associated with the business process. To initialize a business process, InitBP needs the following parameters:
minimal transaction parameters:
STF Transaction ID
Business Process Name
Identity
extended set parameters:
Customer Name
Performer Name
CompletionDate
Response Date
Initiate Date
Organization Roles to Identity mappings for the business process as well as the primary workflow.
BoundData
The STF processor makes the workflow server API call to initiate the business process and primary workflow. The workflow name of the primary workflow need not be provided by the WEA. Both the Business Process Transaction ID and the workflow name (of the primary workflow) are returned to the WEA by the STF processor. If there was an error, it is returned to the WEA.
InitWF
This transaction is used to initialize a workflow (other than the primary workflow). InitWF needs the following parameters:
minimal transaction parameters:
STF Transaction ID
Business Process Transaction ID
Workflow name
Identity
extended set parameters:
Customer Name
Performer Name
Completion Date
Reply Date
Organization Roles to Identity mapping for the workflow
BoundData
Act
This transaction specifies an Act to take in a workflow in a business process. In the case of the Act Transaction, the following parameters need to be passed:
minimal transaction parameters:
STF Transaction ID
Business Process Transaction ID
Workflow Name
Act to take
Identity
extended set parameters:
Completion Date
Reply Date
BoundData
If the Completion and Reply dates are not specified then the default values for that workflow are assumed by the server. If there is any process data that the WEA needs to bind to the business process or workflow instance then the name, type and value of the bound data can also be passed along with the Act transaction. The Act Transaction returns whether the Act transaction has been logged successfully in the Transaction database or not.
Bind Data
This transaction is to bind data to a workflow or a business process. In the case of the Bind data Transaction the following parameters need to be passed:
minimal transaction parameters:
STF Transaction ID
Business Process Transaction ID
Identity
Data to be bound to the business process or workflow instance.
extended set parameters:
Workflow Name
The Bind Data Transaction returns status as to whether the application data has been bound to the business process or workflow instance successfully or not.
Get Workflow Status
This transaction is used to retrieve information related to a workflow instance. This information includes:
WEA data bound to the workflow instance.
List of bound data field names and attributes, when requested.
The status of the workflow instance.
The acts available in the workflow for the role of the specified identity.
The Get Workflow Status Transaction needs the following parameters to be passed:
minimal transaction parameters:
STF Transaction ID
Business Process Transaction ID
Workflow Name
Identity
Workflow Role of the Identity
extended set parameters:
Act or State Flag(Act or State) for bound data
Act or State value for bound data
Return Bound Data Flag(YES or NO)
If the extended parameter, Bound Data (Boolean) is not specified then its default value is YES and bound data fields and attributes are returned to WEA.
The Get Workflow Status Transaction returns the following:
Bound Data
Status String
Completion and Reply dates
List of available acts for the Identity
WF status for Act or State
Get Pending Actions
This transaction is used to retrieve information about workflows for an Identity having an Organization Role from the set of instantiated business processes with the specified business process name, which fall into the specified time slot between the start date and end date. This information includes, for each workflow, BP Name and ID, Workflow Name and ID, Customer ID, Performer ID, Completion and Reply Dates, Status and form name. Essentially, it is the list of workflows where an action is pending.
The Get Pending Actions Transaction needs the following parameters to be passed:
minimal transaction parameters:
STF Transaction ID
Identity
Workflow Role of the Identity
extended set parameters:
Organization Role
Business Process Name
Start Date
End Date
If Organization Role is absent, then information about workflows for the Identity in all valid Organization Roles from the set of instantiated business processes with the specified business process name is returned. If Business Process name is absent, then information about workflows for the Identity in all valid Organization Roles from the complete set of instantiated business processes is returned. If the Start Date and End Date are absent then the time slot for the required information will span the entire database.
This transaction returns a list of workflows which includes:
Business Process Name
Business Process ID
Workflow Name
Customer Name
Performer Name
Completion Date
Reply Dates
Status string
Get Available Business Processes
This transaction is used to get the list of business processes that the specified Identity with a specific Organization role can initiate. The Get Available Business Processes Transaction needs the following parameters to be passed:
minimal transaction parameters:
STF Transaction ID
Identity
extended set parameters:
Business Process Status(Active or Inactive)
This transaction returns a list of business processes available for the Identity.
ReturnWFStatus
This transaction is generated by the workflow processor whenever workflow participants need to be informed about the workflow status. The STF processor polls the workflow processor continuously for any of the Notification events. If it finds one, it calls the Server APIs to get the workflow status (exactly similar to the GetWFStatus Transaction) and send all the workflow information to the participant.
This transaction is generated by the workflow processor and hence requires no parameters from the WEA.
The ReturnWFStatus Transaction returns the following:
Notification string
Notification Event
Status String
Completion and Reply dates
List of available acts for the participant
Bound Data
STF Transaction Representation in a Messaging Environment
The following describes the STF transaction representation in a messaging environment. The STF transaction travels as an attachment to the message. In a messaging environment, an STF transaction has the following format.
SIGNATURE
WORKFLOW DATA
The signature and addressing information, together constitute the STF Transaction Envelope.
Signature
Each STF Transaction starts with the Signature. It could be a line containing the following:
STFMHS-01
Workflow Data
This includes the STF type, STF instance, workflow participants, workflow type, transaction type, start date, expected and/or requested dates and completion dates, workflow status etc.
STF Keyword Format
The STF keyword format in a messaging environment consists of four fields in the following format.
<Keyword (field name)><delimiter><Field value><terminator>
Keyword (field name)
See Table 3 below.
Delimiter
The delimiter is a character such as a ":" used to separate the field name and the field value.
Field value
The syntax and semantics of the field value varies and will depend on the field. The following fields have a specific format in which data is to be sent.
Sent by WEA to STF Processor
Date
OrgRole to Identity
BoundData
Sent by STF Processor to WEA
Acts
Status
BoundData
Business Process List
Workflow List
Terminator
The terminator consists of the carriage return--line feed pair <CR><LF>.
A sample STF transaction in a messaging environment would be as follows:
TABLE 3______________________________________SIGNATURE STFMHS-01______________________________________WORKFLOW DATA STFTYPE:GetWFStatus STFID:10002 WFNAME:PrintPaySlips BPID:10202 IDENTITY:Mani-ID ACTORSTATE:Act ACTSTATE:Request______________________________________
STF Transaction Keyword Data Formats
The following describes the STF transaction keyword data formats which are medium independent.
__________________________________________________________________________ Description, Data Type, Format and ValidSTF Keyword Values__________________________________________________________________________ACT Description: Act to be taken Data type and format: string of up to 64 characters Valid values: Request, Offer, Accept.sub.-- CounterOffer, Accept.sub.-- Offer, Agree, Cancel, Counter, CounterOffer, Counter.sub.-- with.sub.-- request, Declare.sub.-- Completion, Declare.sub.-- Dissatisfaction, Declare.sub.-- Satisfaction, Decline.sub.-- Request, Decline.sub.-- Offer, Decline.sub.-- CounterOffer, RevokeACTS Description: List of Acts with their canonical and English names Data type and format: Canonical name of Act, English Name of the act, . . . Where Canonical Name of the Act - String of up to 64 characters English Name of the Act - String of up to 64 charactersACTORSTATE Description: Act or State flag for which workflow status has been requested Data type and format: String Valid values: Act, State. Default is ActACTSTATE Description: Act or State value Data type and format: String Valid values for Act: Request.sub.-- Offer, Accept.sub.-- CounterOffer, Accept, Offer, Agree, Cancel, Counter, CounterOffer, Counter.sub.-- with.sub.-- request, Declare.sub.-- Completion, Declare.sub.-- Dissatisfaction, Declare.sub.-- Satisfaction, Decline.sub.-- Request, Decline.sub.-- Offer, Decline.sub.-- CounterOffer, or Revoke Valid values for State: Inactive, Initial, Request, Offer, Recounter, OCounter, Agreement, Completion, Satisfaction, Cancel, Decline, or RevokeBOUNDDATA Description: Application data associated with a workflow Data type and format: Bounddata format to be sent by WEA to STF Processor: BDfieldName, BDfieldValue; BDfieldName, BDfieldValue where, BDFieldName - string of up to 64 characters BDfieldValue - string of up to 255 characters. Each bounddata field is separated by comma and items are separated by semicolons. The last item need not contain a semicolon. All the fields in BoundData are mandatory and no blank values are allowed. Data type and format: Bounddata format to be sent by STF Processor to WEA BDfieldName, BDfieldValue, AttributeFlag; where, BDFieldName - string of up to 64 characters BDfieldValue - string of up to 255 characters. AttributeFlag - string of 2 digits specifying Attribute Attribute Flag Values 0 - Read Only 1 - Hidden 2 - MustFill 3 - Editable 4 - Reserved 5 - ReservedBPTID Description: Business Process Transaction ID returned by workflow server and is subsequently used by WEA for queries. Data type and format: String of up to 64 charactersBPLIST Description: Business Process list sent by Workflow Processor Data type and format: list of Business process names and IDs BPNAME; BPTID, BPNAME, BPTID, . . . where BPNAME.sub.-- Business Process Name of String up to 64 characters BPTID - Business Process Transaction ID of String up to 64 charactersBPNAME Description: Business Process Name Data type and format: String of up to 64 charactersBPSTATUS Description: Business Process status required (active or inactive) Data type and format: String Valid values: Active, or InactiveCDTIME Description: Customer request completion date and time Data type and format: Date formats 1. mm dd-yyyy HH:MM:SS 2. MMM dd yyyy HH:MM:SS 3. MMMMMMMM dd yyyy HH:MM:SS where mm - Month (01-12) MMM - Month (Jan-Dec) MMMMMMMM - - Month Name (January - December) dd - Day (0-31) yyyy - Year (1970-200x) HH - Hour (0-23) MM - Minute (0-59) SS - Second (0-59) This is optional All the fields in the date and time are mandatory except the seconds field The delimiters separating date fields can be blank, hyphen, forward slash, or dot (.). Examples of Date and Time for November the 20th 1992 at 10 am can be specified as: November-20-1992 10:00, Nov-20-1992 10:00:00, or 11-20-1993 10:00COMMENT Description: Comment associated with an STF Transaction Data type and format: String of up to 255 charactersCUSTOMERID Description: Workflow customer Name Data type and format: Customer name. String of up to 64 charactersENDDTIME Description: End of date and time range for Get Pending Action Data type and format: Date format (as in CDTIME)ERROR Description: Error code returned by Workflow Processor to an STF Transaction Data type and format: String of digits up to 8 charactersERRORMSG Description: Error message corresponding to ERROR Data type and format: String of up to 1024 charactersFORMID Description: ID for form in WF definition, returned as part of Bound Data Data type and format: String of up to 64 charactersIDENTITY Description: Identity who is participant in the Workflow Data type and format: String of up to 64 charactersIDTIME Description: Initiate time of a Business Process or Workflow Data type and format: Date format (as in CDTIME)NOTIFICATION Description: Notification string returned by Workflow Processor to WEA Data type and format: String of up to 255 characters specifying the Notification string Possible strings are Performer response past due, Performer completion past due, Performer completion coming due, Customer Response past due, Act taken.NOTIFICTYPE Description: Notification Type returned by the Workflow Processor to the WEA Data type and format: String of 1 digit Notification event types 0 - Follow Up 1 - Follow Up 2 - Reminder 3 - Follow Up 4 - ActOBSERVERID Description: Name of observer in workflow Data type and format: String of up to 64 charactersORG2IDENTITY Description: Organizational Role to Identity Mapping for the workflow Data type and format: Organization roles and identities list ORGROLE=IDENTITY;ORGROLE=IDENTITY; . . . where ORGROLE - String of up to 64 characters IDENTITY - String of up to 64 characters All the fields in ORG2IDENTITY are mandatory and no blank values are allowed.ORGROLE Description: Organizational Role of the Identity Data type and format: String of up to 64 charactersPENDINGACTIONS Description: List of Workflows where some act is pending Data type and format: List of Workflows where actions are pending BPNAME, BPTId, WFNAME, CUSTOMER, PERFORMER, COMPLETIONDATE, REPLYDATE, STATUS; . . . where BPNAME - Business Process Name of String up to 64 characters BPTId - Business Process Transaction ID of String up to 64 characters WFNAME - Workflow Name of String up to 64 characters CUSTOMER - Customer Name of String up to 64 characters PERFORMER - Performer Name of String up to 64 characters COMPLETIONDATE - Completion Date (as inCDTIME) REPLYDATE - Reply Date (as in CDTIME) STATUS - Status stringPERFORMERID Description: Name of Performer in the Workflow Data type and format: Performer Name. String of up to 64 charactersRDTIME Description: Date and Time by which a participant asks for a response to his act. Data type and format: Date format (as in CDTIME)RTNBOUNDDATA Description: Flag indicating whether to return application data to WEA Data type and format: String Valid values: Yes, No. Other than 'No' will be taken as 'Yes' and Default is YesRTNSTATUS Description: Flag indicating whether to return status to WEA Data type and format: String Valid values: Yes, No. Other than 'No' will be taken as 'Yes' and Default is YesSTARTDTIME Description: Start date for Pending Actions Data type and format: Date format (as in CDTIME)STATUS Description: Status of Workflow Data type and format: Workflow status string format WFStatus , Completion Date1, Reply Date1, Completion Date2, Reply Date2 WFStatus - A string of up to 64 characters containing the WF status string Possible values are, Inactive, Initial, Request, Offer, Recounter, Counter, Agreement, Completion, Satisfaction, Cancel, Decline, or Revoke Completion date1 - Completion requested by Customer (Completion due for Performer) with format as in CDTIME Reply Date1 - Reply due to Performer from Customer (Reply due to customer from Performer) with format as in CDTIME Completion Date2 - Completion due by Performer (Completion requested by Customer from Performer) with format as in CDTIME Reply Date2 - Reply due by Performer to Customer (Reply due by Customer from Performer) with format as in CDTIMESTFID Description: STF Transaction ID specified by WEA Data type and format: String of up to 255 charactersSTFTYPE Description: STF Transaction Type Data type and format: String of up to 64 charactersSTFVER Description: STF Transaction Version Data type and format: String of up to 64 charactersWFNAME Description: Workflow Name Data type and format: String of up to 64 charactersWFROLE Description: Identity's role in workflow Data type and format: String of up to 64 characters Valid Values: Customer, Performer, Observer__________________________________________________________________________Transaction types (STFTYPE)Type Identifier__________________________________________________________________________InitBP INITBPInitWF INITWFAct ACTBind Data BINDDATAGet Workflow Status GETWFSTATUSGet Available Business GETAVAILBPROCSProcessesGet Pending Actions GETPENDINGACTIONSReturn WF Status RETWFSTATUS__________________________________________________________________________
The STF transaction is placed in an attachment file. This file needs to be specified in the attachment IPM Header. An STF processor makes use of the following SMF headers from the MHS Message to retrieve addressing information for the STF Transaction. Other header information is ignored by the STF Processor.
From
To
Attachment
The following are the complete STF transactions as received by a STF processor from a WEA via MHS. It also illustrates the STF Transaction sent by STF Processor in reply to the WEA via MHS.
Example of MHS message header file received (from WEA) by STF Processor through MHS
______________________________________ MHS Message______________________________________ SMF-70 001From: Mani@Host2 001To: STFPROC1@Host1 200Attachment: FILE1.STF . . . (other info put by MHS , but ignored by STF Processor)______________________________________
Example of MHS message header created by the STF Processor in response to the above header file (To WEA)
______________________________________SMF MessageSMF-70001From: STFPROC1@Hos1001To: Mani@Host2200Attachment: STF00000InitBPAttachment file containing InitBP TransactionCOMMENT: This is an example of InitBPSTFVER:STFMHS-01STFTYPE:InitBPBPNAME:STAFFPAYROLLIDENTITY:Mani-IDSTFID:10401CUSTOMERID:Lakshman-IDPERFORMERID:Manoj-IDCDTIME:01-02-1993 17:00RDTIME:01-02-1993 09:00IDTIME:01-02-1993 17:00ORG2IDENTITY:Mani-ID=Ac.Officer;Ted-ID=Ac.MgrBOUNDDATA:GR8-BAS,40.00;EMPNAME,BhatRTNSTATUS:YES______________________________________
The corresponding workflow server API Calls would be:
AWSTBeginTransaction()
AWSTInitBP();
AWSTBindAppData();
AWSTEndTransaction()
The values returned by the workflow server APIs will be sent to the WEA as Return Status transaction (if WEA had set RTNSTATUS to YES. By default, STF Processor assumes RTNSTATUS as YES). ERROR keyword is set to 0 if there was no error processing the Transaction. Otherwise ERROR will be set to a value and the error message corresponding to the ERROR will be sent in ERRORMSG.
______________________________________Attachment file containing ReturnStatus to InitBPTransaction:______________________________________STFTYPE:ReturnStatusSTFID:10401BPID:10000WFNAME:FixBugsERROR:00000000ERRORMSG:Transaction with workflowserver is successful______________________________________
Suppose that an error occurred in the InitBP Transaction that BPNAME keyword was not found, then the values returned by the workflow server APIs will be sent to the WEA as Return Status transaction (if WEA had set RTNSTATUS to YES. By default, STF Processor assumes RTNSTATUS as YES).
______________________________________Attachment file containing ReturnStatus to InitBP Transactionfor Error:STFTYPE:ReturnStatusSTFID:10401ERROR:00000197ERRORMSG:Could not find keyword(s):BPNAME.InitWFAttachment file containing InitWF TransactionSTFVER:STFMHS-01STFTYPE:InitWFSTFID:10402BPID:10000WFNAME:PrintPaySlipsIDENTITY:Mani-IDCUSTOMERID:Lakshman-IDPERFORMERID:Manoj-IDCDTIME:02-01-1993 17:00RDTIME:Feb-01-1993 17:00IDTIME:February-01-1993 10:00ORG2IDENTITY:Manoj-ID=Pgmr;Lakshman-ID=AnalystRTNSTATUS:YES______________________________________
The corresponding workflow server API calls would be:
AWSTBeginTransaction()
AWSTInitWF();
AWSTBindAppData();
AWSTEndTransaction()
The values returned by the workflow server APIs will be sent to the WEA as Return Status transaction (if WEA had set RTNSTATUS to YES. By default, STF Processor assumes RTNSTATUS as YES).
______________________________________Attachment file containing ReturnStatus to InitWF TransactionSTFTYPE:ReturnStatusSTFID:10401ERROR:00000000ERRORMSG:Transaction with workflowserver is successfulActAttachment file containing Act TransactionSTFVER:STFMHS-01STFTYPE:ActBPID:10000STFID:10403WFNAME:PrintPaySlipsACT:AgreeIDENTITY:Mani-IDCDTIME:02-01-1993 17:00RDTIME:02-01-1993 17:00BOUNDDATA:GR8-BASIC, 3000.00; GR7-BASIC, 3500.00RTNSTATUS:YES______________________________________
The corresponding workflow server API calls would be:
AWSTBeginTransaction()
AWSTActInWF();
AWSTActStatusQuery();
AWSTBindAppData();
AWSTEndTransaction()
The values returned by the workflow server APIs will be sent to the WEA as Return Status transaction (if WEA had set RTNSTATUS to YES. By default, STF Processor assumes RTNSTATUS as YES).
______________________________________Attachment file containing ReturnStatus to Act TransactionSTFTYPE:ReturnStatusSTFID:10403ERROR:00000000ERRORMSG:Transaction with workflowserver is successfulBind DataAttachment file containing Bind Data TransactionSTFVER:STFMHS-01STFTYPE:BindDataBPID:10000STFID:10407WFNAME:PrintPaySlipsIDENTITY:Mani-IDRTNSTATUS:YESBOUNDDATA:GR8-BASIC, 3000.00; GR7-BASIC, 3500.00;GRG-BASIC, 4000.00;PAYDATE, 02-01-1993 17:00______________________________________
The corresponding workflow server API call for the Bind Data Transaction would be:
AWSTBeginTransaction()
AWSTBindAppData();
AWSTEndTransaction()
The values returned by the workflow server APIs will be sent to the WEA as Return Status transaction (if WEA had set RTNSTATUS to YES. By default, STF Processor assumes RTNSTATUS as YES).
______________________________________Attachment file containing ReturnStatus to Bind DataTransactionSTFTYPE:ReturnStatusSTFID:10407ERROR:00000000ERRORMSG:Transaction with workflowserver is successfulGet Workflow StatusAttachment file containing Get Workflow Status TransactionSTFVER:STFMHS-01TIME:Sep-24-1992 10:40STFTYPE:GetWFStatusBPID:100000WFNAME:PrintPaySlipsSTFID:10404WFROLE CustomerIDENTITY:Mani-IDRTNSTATUS:YESRTNBOUNDDATA:YESACTORSTATE:ActACTSTATE:Agree______________________________________
Since this transaction is used to retrieve all information related to a workflow instance, it maps to several workflow server APIs
The corresponding workflow server API Calls would be:
AWSTStatus();
AWSTAvailableActs();
AWSTGetAppData();
The values returned by the workflow server APIs will be sent to the WEA as Return Status transaction (if WEA had set RTNSTATUS to YES. By default, STF Processor assumes RTNSTATUS as YES). If RTNBOUNDDATA is set to YES, then BoundData is returned to the WEA. The Bound Data attribute sent by workflow server is the "moment" attribute flag of a workflow if the Bound data is required for a state.
______________________________________Attachment file containing ReturnStatus to Get WorkflowStatus Transaction______________________________________STFTYPE: ReturnStatusSTFID: 10404STATUS: Completed, 02-01-1993 17:00, 02-01-199317:00, 02-01-1993 17:00; 02-01-1993 17:00ACTS: Agree, PrintSlipsFORMID: SAMPLEFORMBOUNDDATA: GR8-BASIC, 3000.00, 01; GR7-BASIC,3500.00, 01; GR6-BASIC, 4000.00, 01ERROR: 00000000ERRORMSG: Transaction with workflow server issuccessful______________________________________ Note: STATUS and ACTS keyword format
STATUS: WFStatus, Completion Date1, Reply Date1, CompletionDate2, Reply Date2where,______________________________________WFStatus string Workflow status string (Inactive, Initial, Request, Offer, Recounter, Counter, Agreement, Completion, Satisfaction, Cancel, Decline, or Revoke)Completion Date1 Completion requested by Customer (Completion due for Performer)Reply Date1 Reply due to Performer from Customer (Reply due to customer from Performer)Completion Date2 Completion due by Performer (Completion requested by Customer from Performer)Reply Date2 Reply due by Performer from Customer (Reply due by Customer from Performer)______________________________________ACTS: Act Type, Act Namewhere,______________________________________Act Type string Act Type string (Request, Offer, Accept.sub.-- CounterOffer, Accept.sub.-- Offer, Agree, Cancel, Counter, CounterOffer, Counter.sub.-- with.sub.-- request, Declare.sub.-- Completion, Declare.sub.-- Dissatisfaction, Declare.sub.-- satisfaction, Decline.sub.-- Request, Decline.sub.-- Offer, Decline.sub.-- CounterOffer, Revoke, or Null)Act Name Act Name string.______________________________________Get Available Business ProcessesAttachment file containing Get Available Business ProcessesTransaction______________________________________STFVER: STFMHS-01STFTYPE: GetAvailableBPsSTFID: 10405IDENTITY: Mani-IDBPSTATUS: Active______________________________________
The Get Available Business Processes returns the list of Business Processes that the identity (in the specific role) can initiate. The BPSTATUS is an optional parameter which specifies whether active or inactive (all) BPs are required by the WEA.
The corresponding workflow server API Call would be:
AWSTAvailableBP();
The values returned by the workflow server APIs will be sent to the WEA as Return Status transaction (if WEA had set RTNSTATUS to YES. By default, STF Processor assumes RTNSTATUS as YES)
______________________________________Attachment file containing ReturnStatus to Get Available BPsTransactionSTFTYPE:ReturnStatusSTFID:10405BPLIST:BugReportingSystem, 1000;BugReportingSystem, 10001ERROR:00000000ERRORMSG:Transaction with workflow server issuccessfulGet Pending ActionsAttachment file containing Get Pending Actions TransactionSTFVER:STFMHS-01STFID:10406STFTYPE:GetPendingActionsWFROLE:PerformerORGROLE:Ac. OfficerBPNAME:STAFFPAYROLLIDENTITY:Mani-IDSTARTDTIME:02-01-1993 17:00ENDDTIME:02-01-1993 17:00RTNSTATUS:YES______________________________________
The Get Pending Actions returns information about the workflows for the specified identity (having the specific Organization role) from the set of instantiated business processes with the specified Business Process name.
The corresponding workflow server API Call would be:
AWSTQueryWF();
The values returned by the workflow server APIs will be sent to the WEA as Return Status transaction (if WEA had set RTNSTATUS to YES. By default, STF Processor assumes RTNSTATUS as YES)
______________________________________Attachment file containing ReturnStatus to Get PendingActions TransactionSTFTYPE:ReturnStatusSTFID:10405PENDINGACTIONS:WFNAME1;WFNAME2ERROR:00000000ERRORMSG:Transaction with workflow server issuccessfulReturnWFStatusAttachment file containing ReturnWFStatus TransactionNone______________________________________
This Transaction is generated by the Workflow Processor whenever the Workflow participants are needed to be informed about the Workflow status. The STF Processor will poll the Workflow Processor continuously for any of the Notification events. If it finds one, it calls the Server APIs to get the Workflow Status (exactly similar to the GetWFStatus Transaction) and send all the workflow information to the participant.
The corresponding workflow server API Calls would be:
AWSTBeginTransaction()
AWSPollSTFQueue()
AWSTStatus();
AWSTAvailableActs();
AWSTGetAppData();
AWSTEndTransaction()
The values returned by the workflow server APIs will be sent to the WEA as Notification transaction.
______________________________________Attachment file containing ReturnWFStatus Transaction______________________________________STFTYPE:ReturnWFStatusNOTIFICATION:Performer Response Past DueNOTIFICTYPE:1STATUS:Completed,02-01-1993 17:00,02-01-199317:00,02-01-1993 17:00,02-01-1993 17:00ACTS:Agree, PrintSlipsFORMID:SAMPLEFORMBOUNDDATA:GR8-BASIC, 3000.00,01; GR7-BASIC,3500.00,01; GR6-BASIC, 4000.00,01______________________________________
STF Transaction Representation in a Database Environment
In the case of a shared database environment, the STF transaction format is a set of tables.
Each table has a record structure as follows:
______________________________________Table Name Description______________________________________Act Data required ActActs List of canonical acts and their English namesBindData Binding Application specific Data to WorkflowBoundData Application specific Bound DataBusinessProcessList List of Available Business ProcessesError Error information returned by STF Processor to the WEAGetAvailableBPs Get Available TransactionsGetPendingActs Get Pending Actions TransactionGetWFStatus Get Workflow Status TransactionInitBP Initialize Business Process TransactionInitWF Initialize Workflow TransactionOrg2Identity Organizational Role to Identity MappingPendingActions List of Workflows where some act is pendingReturnWFStatus Return Workflow Status (Notification) TransactionWorkflowStatus Workflow Status data returned by GetWFStatus and ReturnWFStatus______________________________________
Each table consists of a set of columns in a relational table. The first field in the table is the Transaction ID which is the primary key for the table--its value can never be void. Other fields may contain void values depending upon whether those fields are of the minimal set or the extended set of parameters of the respective STF transaction.
An alternative implementation of the STF transaction representation in a database environment would consist of three tables as follows:
______________________________________Keyword Index Table STF Keyword Index______________________________________ ACT 1 ACTS 2 ACTORSTATE 3 . . . . . .______________________________________Incoming Transactions______________________________________STF Trans ID Keyword Value______________________________________Outgoing Transactions______________________________________STF Trans ID Keyword Value______________________________________
where the STF Trans ID column contains STF transaction identification, the keyword column contains a keyword index corresponding to the keyword index table; and the value column contains one of the valid values from the STF Transaction Keyword Data Formats table.
STF Transaction Representation in an Inter-Process Communication Environment
The STF transaction in an IPC environment is represented by a set of parameters in a remote procedure call, in a manner similar to the parameters of a workflow API call as described in U.S application Ser. No. 08/014,796 filed Feb. 8, 1993.
STF Processors
The following is a description of the three types of STF processors needed for messaging, shared database and inter-process communication. Details for the messaging type are explained by way of an example using MHS and VIM. Details needed for the shared database type by way of examples using SQL. Details for the inter-process communication type should be apparent to persons skilled in the art from this description.
In the preferred embodiment as set forth below, the invented system is implemented using the Model, View, Class (MVC) paradigm of object oriented programming.
Transporter Module
The transporter module of an STF processor handles the reception of inputs arriving via messaging, shared database or IPC and the preparation of outputs via messaging, shared database or IPC. The transporter recognizes, reads and writes entire transactions. The transporter accesses all items of bound data or transaction data via keyword entries. Client input/output content is required to be formatted as keyword, value(s), flags for each item of a transaction or bound data.
The transporter class provides basic interaction with the WEA software. In the case of MHS, for example, the transporter class provides the messaging interface. It gets and puts messages and passes them to the TxParser, which is a class that understands and reads the MHS message and extracts from it the STF transaction. The transporter also receives the message from the TxFormatter which is a class that constructs the message in MHS format. When a developer creates a new STF processor, it is necessary to derive from the subclasses of the transporter class an interface to the required transport medium to the STF processor.
The TxProcessor and STF.sub.-- Transaction (STF.sub.-- Tx) classes form the core of the STF processor. The TxProcessor is the controlling class that keeps track of transactions queued up to be done. The STF.sub.-- Tx creates all the objects which between them contain all the methods necessary to interface to the workflow server.
Since the STF processor converts a WEA-formatted transaction into a workflow server-formatted transaction, the transaction classes center the conversion process and provide methods to both sides of the conversion.
Transaction Processor
The TxProcessor is the central controller class in STF Processor. It has pointers to Error, INIFile, Transporter, TxParser, TxFormatter and STF.sub.-- Tx base classes in the STF Processor. FIG. 6 illustrates the generic class hierarchy diagram of a STF processor and how the classes in STF processors are linked.
TxProcessor has methods to process input and output transactions. The TxProcessor constructor instantiates TransMsgMHS (for a messaging environment based on MHS), TxParser and TxFormatter.
Within the TxProcessor method, to process input Transactions, a parser method to get input from Transporter is called which loads the input transaction.
Next, STF.sub.-- Tx is instantiated in inbound or outbound mode depending upon TXProcessor method for processing input or output Transactions.
Pointers to Transporter, TxParser and TxFormatter are passed on to STF.sub.-- Tx private data members through the constructor. The STF.sub.-- Tx constructor then gets the Transaction Type by calling parser method for processing inbound Transactions or calls a method for polling STFQ for processing outbound Transactions.
Depending upon the Transaction Type appropriate transaction objects are instantiated which in turn process the Bound data, Envelope data and call appropriate workflow server APIs.
The return status of the workflow server API's is handled by creating a return Transaction which is internally passed over to TxFormatter for onward delivery to Transporter. Cleanup operation is done by calling TxProcessor's methods to do the same. This completes one inbound or outbound transaction processing
All the output transactions are processed. If there are no output transactions pending, a message is posted to process input transactions.
STF Processor Class Descriptions
Class Name: INIFile
Class Description
This is the INI file base class that handles STF Processor INI file loading. The INI file is created during STF Processor installation. STF Processor will assume a default STF.INI in the current directory. If the STF.INI is not found in the current directory, it will be searched in PATH environment variable. The INI file is similar to OS/2 INI files. The INI file will have keywords and values. Following is the content of the INI file in STF Processor Ver1.0.
______________________________________ STFProcessorName: STFPROC1 ErrorLogFile: C:.backslash.TEMP Super Class None sub Classes None Classes Used None AttributesAttribute Name Attribute Description______________________________________szINIFilName INI file nameszSTFProcID STF Processor IDszSTFExeFilName STF EXE file nameszSTFErrFilName Error log file name______________________________________Public MethodsMethod Name Method Description______________________________________INIFile(PSZ pszINIFilName) Constructor updates the INI file name szINIFilNameUSHORT uFillINIData( ) reads the INI file and fills the INI file information in the attributesBOOL bParseINILine(PSZ parses INI file line usingpszLinebuf, PPSZ array of INI keywords andppszItemNames, PSZ pszValue, returns value and indexUSHORT *puIndex) associated with the INI file keywordPSZ pszGetINIFilName( ) returns INI file name stored in szINIFilNamePSZ pszGetSTFProcID( ) returns the STF Processor name stored in szSTFProcIDPSZ pszGetSTFExeFilName( ) returns the EXE file name of STF Processor stored in szSTFExeFilName.PSZ pszGetSTFErrFilName( ) returns the error log file name stored in szSTFErrFilName.PSZ pszGetSTFVariantName( ) returns the STF variant name stored in szSTFVariantName______________________________________
Class name: STFTransporter
Class description
This is an abstract base class which is responsible for getting WEA inputs and returning responses to the WEA. It contains methods to interface with the external environment as well as provides methods for TxParser, TxFormatter and Envelope objects for reading and writing transactions and user information. The STFTransporter class contains a set of virtual methods which are overloaded by the methods of the appropriate derived classes(STFTransMsg, STFTransDb or the STFTransIPC class). In the case of messaging environment like MHS, the STFTransporter virtual methods are replaced by the methods of the STFTransMsgMHS class. STFTransporter accepts and passes an array of strings containing Transaction items, values, and flags to the TxParser.
______________________________________Super ClassNoneSub ClassesSTFTransMsg, for handling Messaging environmentSTFTransDB for handling Database environmentSTFTransIPC for handling IPC environmentClasses UsedNoneAttributesAttribute Name Attribute Description______________________________________None None______________________________________Public MethodsMethod Name Method Description______________________________________virtual USHORT A pure virtual method whichuGetInputTx(PPSZ will be overloaded byppszAWESTFInputTx, USHORT* appropriate method of deriveduITCount, BOOL*pbMore) classes STFTransMsg, STFTranSDB, STFTransIPC. Overloaded methods get a reference to array of pointers to strings containing transaction items, values, flags from the WEA inputvirtual BOOL A pure virtual method that isbWriteWEAOutput(PPSZ overloaded by appropriateppszFmtOutput, USHORT public methods of the deriveduFOCount) classes STFTransMsg, STFTransDB, STFTransIPC. It creates the Transaction header and posts it along with the attachment file (in case of messaging environment) as output to WEA application. It returns Boolean indicating success or failure of the posting operation. This method is used by formatter to send transactions to WEA.virtual BOOL A pure virtual method that isbGetInUserInfo(PPSZ overloaded by methods ofppszInUserInfo, USHORT* derived classes STFTransMsg,puInUICount ) STFTransDB, STFTransIPCvirtual BOOL A pure virtual method that isbPutOutUserInfo(PPSZ overloaded by appropriateppszOutUserInfo, USHORT methods of derived classesuOutUICount) STFTransMsg, STFTransDB, STFTransIPCvirtual BOOL bDeleteTx(USHORT A virtual method that is*uDeleteTxFlag) overloaded by appropriate methods of derived classes. The overloaded method marks inputs from WEA as read. It is called once an Input from WEA is completely processed.______________________________________
Class Name: STFTransMsg
Class Description
STFTransMsg derived class consists of a set of public methods which overload the appropriate methods of the STFTransporter class to incorporate message specific features. The STFTransMsg derived class also contains a set of protected virtual methods which are used in defining the set of the STFTransMsg public methods, i.e. in writing the code of these public methods. This set of protected virtual methods in turn is overloaded by the methods of the derived class STFTransMsgMHS in case of messaging environment based on MHS and by methods of STFTransMsgVIM derived class in the case of a messaging environment based on VIM.
______________________________________Super ClassSTFTransporterSub ClassesSTFTransMsgMHS handles MHS messaging environmentSTFTransMsgVIM handles VIM messaging environmentClasses UsedNoneAttributesAttribute Name Attribute Description______________________________________ppszInUserInfo input user info used for storing addressing information of inbound transactions.uInUserInfoCount number of elements in ppszInUserInfo.ppszOutUserInfo Output user Info used for addressing outbound transactions.uOutUserInfoCount number of elements in ppszOutUserInfo______________________________________Public MethodsMethod Name Method Description______________________________________STFTransMsg( ) Constructor used for initializing private data members of STFTransMsg class.USHORT uGetInputTx(PPSZ This method uses protectedppszAWESTFInputTx, USHORT* virtual methods which areuITCount, BOOL *pbMore) overloaded by appropriate methods of STFTransMsgMHS and STFTransMsgVIM derived classes. It gets the inbound transaction, user information and number of strings present in Input transaction and user information data structures respectively. The user information data is stored in its private data members. Various arguments are described below. 1. ppszWEASTFInputTx argument receives reference to array of pointers to strings containing transactions sent by WEA. 2. uITCount specifies count of strings in ppszWEASTFInputTx. 3 pMore flag indicates if more unread input messages are present. This flag is useful in processing multiple input transactions.BOOL bWriteWEAOutput(PPSZ This method acceptsppszFmtOutput, USHORT parameters for creating anuFOCount) outbound transaction to be sent to WEA. It accepts array of pointers to strings from which a return Transaction is formulated (In case of messaging environment it creates an attachment file) and posts the message along with formulated transaction (attachment file in Messaging environment) as WEA output. It makes use of protected virtual methods that are overloaded by the appropriate methods of STFTransMsgMHS and STFTransMsgVIM derived classes. Various arguments are given below: 1. ppszFmtOutput argument contains formatter output Transaction for onward delivery to WEA. 2. uFOCount argument specifies number of strings in ppszFmtOutput.BOOL bGetInUserInfo(PPSZ This method gets UserppszInUserInfo, USHORT* Information that is stored inpInUICount) ppszInUserInfo private data member. This is used for addressing the responses to the current transaction. The various arguments passed are given as under. 1. ppszInUserInfo argument contains Input user information for addressing purpose. 2. pInUICount points to number of strings in ppszUserInfo.BOOL bPutOutUserInfo(PPSZ This method accepts userppszOutUserInfo, USHORT information to be used withinuOutUICount) transporter for addressing outbound transaction. The various arguments are described below: 1. ppszOutUserInfo argument contains array of pointers to strings containing user information for addressing outbound transaction. 2. uOutUICount specifies number of strings in ppszOutUserInfo data structure.BOOL bDeleteTx(USHORT This method marks the input*uDeleteTxFlag) messages from WEA as read once they are processed and deletes the memory allocated for private data members of STFTransMsg..about.STFTransMsg( ) Destructor used for deleting ppszInUserInfo data member.______________________________________Protected MethodsMethod Name Method Description______________________________________virtual BOOL bCreateMsg(PPSZ This is a protected virtualppszFmtOut, USHORT method that is overloaded byuFmtOutCount) appropriate member functions of STFTransMsgMHS and STFTransMsgVIM derived classes. It creates an attachment file from array of pointers to strings passed as argument to it.virtual BOOL bSetMsgHdr( ) This is a protected virtual function that will be overloaded by bSetMsgHdr( ) methods of STFTransMsgMHS or STFTransMsgVIM derived classes. It creates the message header structure from array of pointers to string containing user information like receiver name and address as inputvirtual BOOL bSendMsg( ) This is a protected virtual function that will be overloaded by bSendMsg( ) methods of STFTransMsgMHS or STFTransMsgVIM derived classes. It posts the attachment file and message as output to WEA.virtual BOOL This method is overloaded bybQueryNewMsg(BOOL *pbMore) bQueryNewMsg( ) method of STFTransMsgMHS or STFTransMsgVIM derived classes. It polls for WEA input and returns Boolean indicating presence or absence of WEA input. It as well sets the more flag in case more unread messages are present.virtual BOOL bOpenMsg( ) This method is overloaded by bOpenMsg( ) method of STFTransMsgMHS or STFTransMsgVIM derived classes. It opens and reads the incoming unread message file for attachment file name and user information.virtual BOOL This method is overloaded bybMarkMsgRead(USHORT bMarkMsgRead( ) functions of*uDeleteTxFlag); STFTransMsgMHS or STFTransMsgVIM derived classes.virtual BOOL bGetMsgItem(PPSZ This method is overloaded byppszInputTx, USHORT* bGetMsgItem( ) method ofpuInputTx) STFTransMsgMHS or STFTransMsgVIM derived classes. It passes reference to array of pointers containing item names, values and flags of the transaction. It will be used by bGetInputTx( ) public method of this class.virtual BOOL bCloseMsg( ) This method closes all the resources opened by bOpenMsg( ) method.______________________________________
Class Name: STFTransMsgMHS
Class Description
The STFTransMsg MHS derived class consists of a set of public methods which overload the methods of the STFTransMsg derived class. This set of public methods are specific to MHS messaging environment.
______________________________________ Super Class STFTransMsg Sub Classes None Classes Used None AttributesAttribute Name Attribute Description______________________________________pIniFile pointer to INIFileppszMsgHdr array of pointers to store message header.uMsgHdrCount number of elements in ppszMsgHdrhOutMsgFil Output message file handle.pszInAttFilName Input attachment file namepszOutAttFilName Output attached file name.pszUnreadMsgFilName Input Unread message file nameszInMsgFilPath Input message mail directory path.szInAttFilPath Input parcel directory(attached file) pathszSndMsgFilPath Output message directory path.szSndAttFilPath Output parcel directory(attached file) path.pszStfAppName STF Application name.szSMF.sub. --70[ ] constant char string containing SMF signature SMF- 70szFrom[ ] constant char string containing SMF "From:"field.szTo[ ] constant char string containing SMF "To:" field.szAttachment[ ] constant char string containing SMF "Attachment:" field.szStf constant string containing STF keyword.______________________________________Private MethodsMethod Name Method Description______________________________________BOOL bSetPath( ) This method sets up the paths specific to MHS messaging environment. Returns true if paths are set properly.PSZ pszGetMHSMV( ) This method returns the master volume environment variable MV necessary for setting up the MHS environment.______________________________________Public MethodsMethod Name Method Description______________________________________STFTransMsgMHS( ) Constructor of STFTransMsgMHS class. It initializes private data members of STFTransMsgMHSvirtual BOOL This creates a temporary file frombCreateMsg(PPSZ array of pointers to strings passed byppszFmtOut, USHORT formatter in ppszFmtOut and assigns theuFmtOutCount) unique file name created to pszOutAttFilName data member. The steps followed by this method are given below. 1. Create a unique file from a global integer variable which is appended with STF keyword. 2. Open the file using DOS Open command in non-shareable, write only mode. 3. Writes strings from ppszFmtOut into file separating them with a new line character (0x0D 0x0A)virtual BOOL The procedure followed by this methodbSetMsgHdr( ) to accomplish its task is broadly categorized in following steps. 1. Allocate storage for ppszMsgHdr data member. 2. Create SMF message header as array of strings in ppszMsgHdr using ppszOutUserInfo and uOutUserInfoCount for recipient (To:) field. 3. Assign the attachment file name created by bCreateMsg( ) method (pszOutAttFilName) to Attachment field of SMF header. 4. Assign the Attachment type field of SMF header as STF. 5. Assign From:field of SMF to application name given by pszStfAppName variable.virtual BOOL This method creates a message file frombSendMsg( ) array of pointers to strings compiled by bSetMsgHdr( ) in ppszMsgHdr data structure in output mail directory. This completes the posting operation of SMF message in MHS environment. It returns Boolean indicating success or failure of the operation. The steps followed in this method are given below: 1. Create a unique file from a global integer variable which is appended with STF keyword. 2. Open the file using DosOpen command in non-shareable, write only mode. 3. Writes strings from ppszMsgHdr into file separating them with a new line character (0x0D 0x0A)virtual BOOL This method polls the (STF processor)bQueryNewMsg(BOOL mail directory to check for incoming*pbMore) messages. Returns Boolean indicating presence or absence of inputs from WEA and stores the name of first unread file in pszUnreadMsgFilName private data member. It as well updates a more flag if more unread messages are present.virtual BOOL This method opens up the first unreadbOpenMsg( ) message given by private data member pszUnreadMsgFilName, scans message file for attachment file name and From fields. The steps followed by this method are given below. 1. Opens the file given by pszUnreadMsgFilName using fopen( ) in read only mode. 3. Reads contents of file using fgets( ) function and compares each string with szAttachment. Extracts the name of file and sets it in pszInAttFilName data member. 4. Similarly compare each string with szFrom to get the sender of the message and assign it in pszInUserInfo field data member.virtual BOOL This method formulates an array ofbGetMsgItem(PPSZ pointers to strings in ppszInputTx andppszInputTx, pointer to count of strings containedUSHORT*, in pInputTxCount from the data readpInputTxCount) from pszInAttFilName member. The steps followed in this method are given below. 1. Opens attachment file given by pszOutAttFilName and szInAttPath using fopen( ) function. 2. Allocate memory for ppszInputTx elements. 3. Reads the contents of file line by line using fgets( ) function and stores it as a string in ppszInputTx. 4. Sets the number of lines read in pInputTxCount. 5. Closes attachment file.virtual BOOL Closes all the resources opened bybCloseMsg( ) bOpenMsg( ) method.virtual BOOL This method stamps the messages as readbMarkMsgRead(USHORT after a transaction is processed.*uDeleteTxFlag).about.STFTransMsgMHS( ) Destructor for STFTransMsgMHS. It deletes memory for some of its private data members.______________________________________
Class Name: STFTransMsgVIM
Class Description
The STFTransMsg VIM derived class consists of a set of public methods which overload the methods of the STFTransMsg derived class. This set of public methods are specific to VIM messaging environment.
______________________________________ Super Class STFTransMsg Sub Classes None AttributesAttribute Name Attribute Description______________________________________vSession VIM session identifiervMsg VIM open message identifiervInMsg VIM open Message identifier for inbound messagevRef VIM message reference positionvContainer VIM open message container identifier______________________________________Public MethodsMethod Name Method Description______________________________________TransMsgVIM(INIFILE Constructor of STFTransMsgVIM*pINIFile) object. It opens a VIM session using VIMOpenSession( ) API call.virtual BOOL CreateMsg(PPSZ This method creates anppszFmtOut, USHORT outbound message. It uses theuFmtOutCount) VIMCreateMsg( ) VIM API provided in VIM.DLL.virtual BOOL SetMsgHdr( ) It gets pointer to string containing user information like sender, recipient from TransMsg methods from which it creates the message header using following VIM API calls 1. VIMSetMessageHeader( ) 2. VIMSetMessageRecipient( )virtual BOOL SendMsg( ) This method posts the message along with attachment file using following VIM API calls. 1. VIMSetMessageItem associates an attachment file with message formulated by VIMCreateMessage( ) 2. VIMSendMessage( ) posts the message along with attachment file.virtual BOOL This method polls the mailQueryNewMsg(BOOL directory to check for new*pMore) messages. Uses following VIM API calls 1. VIMOpenMessageContainer( ) opens a message container containing inbound mail. 2. VIMEnumerateMessages( ) enumerates the messages and gets the message reference of first unread message.virtual BOOL OpenMsg( ) Opens the incoming message using VIMOpenMessage( ) method provided by VIM.DLL..virtual BOOL GetMsgItem(PPSZ This method extracts theppszInputTx, USHORT * attachment file informationuInputTxCount) from container box using following VIM API calls. 1. VIMEnumerateMessageItems( ) enumerates the message for attachment files. 2. VIMGetMsgItem( ) extracts the attachment file item and stores the contents in ppszInputTx.virtual BOOL CloseMsg( ) Closes all the resources opened using VIMCloseMessage( ) API call.virtual BOOL MarkMsgRead( ) This method stamps the messages after they are read. It uses VIMMarkMessageRead( ) method of VIM.DLL..about.TransMsgVIM( ) Destructor of STFTransMsgVIM. Closes a VIM session using VIMCloseSession( ) function.______________________________________
Class Name: STFTransDB
Class Description
STFTransDB derived class consists of a set of public methods which overload the appropriate methods of the STFTransporter class to incorporate Database specific features. The STFTransDB derived class also contains a set of protected virtual methods which are used in defining the set of the STFTransDB public methods, i.e. in writing the code of these public methods. This set of protected virtual methods in turn is overloaded by the methods of the derived class STFTransDBSQL in case of Database environment based on SQL.
______________________________________Super ClassSTFTransporterSub ClassSTFTransDBSQL handles SQL Database environmentClasses UsedNoneAttributesAttribute Name Attribute Description______________________________________ppszDBServerInfo Database Management System InformationuDBServerInfoCount number of elements in ppszDBServerInfo______________________________________Public MethodsMethod Name Method Description______________________________________STFTransDB( ) Consructor used for initializing the database management system information.USHORT uGetInputTx(PPSZ This method uses protectedppszAWESTFInputTx, USHORT* virtual methods which areuInTxCount, overloaded by appropriateBOOL *pbMoreInputs) methods of STFTransDBSQL derived class. It gets the inbound transaction, database server information. 1. the ppszAWEASTFInputTx argument receives reference to array of pointers to strings containing transactions sent by WEA. 2. uInTxCount specifies count of strings in ppszAWEASTFInputTx. 3 pMoreInputs flag indicates if more unread STF database records are present. This flag is useful in processing multiple input transactions.BOOL bWriteWEAOutput(PPSZ This method accepts parametersppszFmtOutput, USHORT for creating an outbounduFOCount) transaction to be sent to WEA. It accepts array of pointers to strings from which a return Transaction is formulated as a database record and writes it onto the STF shared database. It makes use of protected virtual methods that are overloaded by the appropriate methods of STFTransDBSQL derived class. Various arguments are given below. 1. ppszFmtOutput argument contains formatter output Transaction for onward delivery to WEA. 2. uFOCount argument specifies number of strings in ppszFmtOutput.BOOL bGetInDBInfo(PPSZ This method gets STF databaseppszDBServerInfo, USHORT* and dictionary information thatpDBInfoCount) is stored in ppszDBServerInfo private data member. This is used for writing the database records onto STF Database. The various arguments passed are given as under. 1. the ppszDBServerInfo argument contains Input STF Database management system information for reading and writing records to the database. 2. pDBInfoCount points to number of strings in ppszDBServerInfo.BOOL bPutOutDBInfo(PPSZ This method accepts databaseppszDBServerInfo, USHORT management system information touOutDBCount) be used within the transporter for addressing outbound transaction. The various arguments are described below. 1. the ppszDBServerInfo argument contains array of pointers to strings containing user information for addressing outbound transaction. 2. uOutDBCount specifies number of strings in ppszDBServerInfo data structure.BOOL bDeleteTx(USHORT This method marks the input*uDeleteTxFlag) database record from WEA as read once they are processed and deletes the memory allocated for private data members of STFTransDB..about.STFTransDB( ) Destructor used for deleting ppszDBServerInfo data member.______________________________________Protected MethodsMethod Name Method Description______________________________________virtual BOOL This is a protected virtualbCreateSTFRecord(PPSZ method that will be overloadedppszFmtOut, by appropriate member functionsUSHORT uFmtOutCount) of STFTransDBSQL derived class. It creates a database record from array of pointers to strings passed as argument to it.virtual BOOL This method is overloaded bybQueryNewSTFRecord(BOOL bQueryNewSTFRecord( ) method of*pbMore) STFTransDBSQL derived class. It polls for AWEA records written onto STF Database and returns Boolean indicating presence or absence of AWEA input. It also sets the more flag in case more unread records are present in the STF Database.virtual BOOL This method is overloaded bybDeleteSTFRecord(USHORT bDeleteSTFRecord( ) method of*uDeleteTxFlag). STFTransDBSQL derived class.virtual BOOL This method is overloaded bybReadSTFRecord(PPSZ bReadSTFRecord( ) method ofppszInputTx, STFTransDBSQL derived class. ItUSHORT* puInputTx) passes reference to array of pointers containing STF keyword names, values and flags of the transaction. It is used by bGetInputTx( ) public method of this class.______________________________________
Class Name: STFTransDBSOL
Class Description
The STFTransDBSQL derived class from STFTransDB consists of a set of public methods which overload the methods of the STFTransDB derived class. This set of public methods are specific to SQL Database Server environment.
______________________________________ Super Class STFTransDB Sub Classes None Classes Used None AttributesAttribute Name Attribute Description______________________________________pszSQLDBName SQL database nameppszSQLTabName Array of SQL tables in the SQL database.uSQLTabCount number of tables in the SQL database______________________________________ Private Methods None Public MethodsMethod Name Method Description______________________________________STFTransDBSQL( ) Constructor of STFTransDBSQL class. It initializes private data members of STFTransDBSQLvirtual BOOL This creates record in thebCreateSTFRecord(PPSZ output STF DB tables and writesppszFmtOut, USHORT strings from ppszFmtOut into theuFmtOutCount) database tables.virtual BOOL This method polls the STFbQueryNewSTFRecord(BOOL processor database tables for*pbMore) new transactions with Transaction ID as the key. Returns Boolean indicating presence or absence of inputs from WEA and stores the WEA input record. It updates a more flag if more unread records are present in the STF database.virtual BOOL This method formulates an arraybReadSTFRecord(PPSZ of pointers to strings inppszInputTx, USHORT* ppszInputTx and pointer to countpInputTxCount) of strings contained in pInputTxCount from the data read from the STF database tables.virtual BOOL This method deletes thebDeleteSTFRecord(USHORT processed STF Record from the*uDeleteTxFlag) STF SQL database tables..about.STFTransDBSQL( ) Destructor for STFTransDBSQL It deletes memory for some of its private data members.______________________________________
Class Name: TxParser
Class Description
This class parses the WEA input which is stored as an array of strings stored in the attributes. It has methods for parsing and returning keyword values from input STF Transactions. Please refer to Appendix-B for a list of keywords and their explanations. The TxParser object is created by the TxProcessor for getting Input Transaction from STFTransporter.
______________________________________Super ClassNoneSub ClassesNoneClasses UsedSTFTransporter - used to get STF Transaction strings.______________________________________AttributesAttribute Name Attribute Description______________________________________pTransporter Pointer to STFTransporter base classppszInSTFTx pointer to array of strings containing input transactions read from transporter.uInSTFTxCount Number of strings stored in ppszInSTFTx______________________________________Method Name Method Description______________________________________Public MethodsTxParser (STFTransporter Constructor that accepts pointer*pTransporter) to STFTransporter and stores it in its private data member.USHORT This method calls theuGetTransInput (BOOL STFTransporter method*pbMoreTx) bGetInputTx () to get the STF Transaction and stores it in ppszInSTFTxBOOL bIsSTFTxKwdExist (PSZ This method checks whether thepszKwd) given keyword exists in the ppszInSTFTx. It returns TRUE if the keyword exists, else FALSE.INT iIsSTFTxKwdExist (PSZ This method checks whether thepszKwd) given keyword exists in the ppszInSTFTx. It returns the index of the keyword in ppszInSTFTx array of strings and returns -1 if the keyword was not found.PSZ pszParseSTFValue (PSZ This method returns the keywordpszKwd, CHAR *pcFlag, value associated with the pszKwdUSHORT * puPrsStatus) and updates the STF keyword type flag in pcFlag.BOOL bGetSTFTxType This method updates the puType(USHORT *puType) with the STF Transaction type.The following methods are used to get STF Transaction keywordvalues are overloaded for different keyword types.USHORT This method updates the keyworduGetSTFTxKwdValue (PSZ value ppszKwdValue associatedpszKwd, PPSZ ppszKwdValue) with the pszKwd keyword.USHORT This method updates the keyworduGetSTFTxKwdValue (PSZ value puKwdValue associated withpszKwd, USHORT *puKwdValue) the pszKwd keyword.USHORT This method updates the keyworduGetSTFTxKwdValue (PSZ value piKwdValue associated withpszKwd, INT *piKwdValue) the pszKwd keyword.USHORT This method updates the keyworduGetSTFTxKwdValue (PSZ value plKwdValue associated withpszKwd, LONG *plKwdValue) the pszKwd keyword.USHORT This method updates the keyworduGetSTFTxKwdValue (PSZ value pbKwdValue associated withpszKwd, BOOL *pbKwdValue) the pszKwd keyword.USHORT This method updates the keyworduGetSTFTxKwdValue (PSZ value structure pDateTime.pszKwd, LPDATETIMETpDateTime)USHORT This method updates theuGetSTFTxKwdValue (PSZ structure pORG2ID and the countpszKwd, LPORG2ID pORG2ID, associated with the pszKwd.INT *piCount)USHORT This method updates theuGetSTFTxKwdValue (PSZ structure pBData and the countpszKwd, LPTXBDFIELDSTRUCT associated with the pszKwd.pBData, INT *piCount)BOOL bcheckInputTx () Checks if data is present in ppszInSTFTx.VOID vDeleteParserData () Deletes data stored in ppszInSTFTx and resets the uInSTFTxCount..about.TxParser () This method is the destructor which deletes the transaction data.______________________________________
Class Name: TxFormatter
Class Description
This class contains methods to produce STF Transaction from keyword values for the STFTransporter. This class will hide the Transaction from knowing about the external interface to WEA. It will essentially format the data required by the STFTransporter to output an STF Transaction. This class is used by Transaction class. The TxFormatter will call STFTransporter method and pass array of STF keyword strings stored by the TxFormatter. The TxFormatter keeps on accumulating STF keyword strings till it gets bFmtEnd() message. The bFmtEnd() will call STFTransporter method to write the STF Transaction to the WEA.
______________________________________Super ClassNoneSub ClassesNoneClasses UsedSTF.sub.-- Tx STF.sub.-- Tx class to get the STFTransporterpointerSTFTransporter STFTransporter class to output the STFTransactionAttributesAttribute Name Attribute Description______________________________________ppszOutSTFTx data structure containing output transaction.uOutSTFTxCount Number of strings in ppszOutSTFTx.______________________________________Public MethodsMethod Name Method Description______________________________________TxFormatter( ) This method is he constructor for this class which initializes the attributes.BOOL bFmtStart( ) This method starts the formatter initializing the array of pointers to hold the STF keywords and values. This is equivalent to opening a file.BOOL bFmtEnd(STF.sub.-- Tx *pSTF.sub.-- Tx) This method signals the formatter that all the data that needs to be sent to WEA has been formatted and can call STFTransporter method to write the STF Transaction to the output. This is equivalent to closing and flushing a file.______________________________________
The following methods are used to format STF Transaction keyword and value are overloaded for different keyword types.
______________________________________Method Name Method Description______________________________________BOOL bFmtKwd (PSZ pszKwd, This method formats the pszKwdPSZ pszKwdValue) and pszKwdValue in the form pszKgwd:pszKwdValue.BOOL bFmtKwd (PSZ pszKwd, This method formats the pszKwdINT iKwdValue) and iKwdValue in the form pszKwd:iKwdValue.BOOL bFmtKwd (PSZ pszKwd, This method formats the pszKwdUSHORT uKwdValue) and uKwdValue in the form pszKwd:uKwdValue.BOOL bFmtKwd (PSZ pszKwd, This method formats the pszKwdLONG lKwdValue) and lKwdValue in the form pszKwd:lKwdValue.BOOL bFmtKwd (PSZ pszKwd, This method formats the pszKwdLPWFLIST pWFList, INT iCount) and pwFList contents in the form pszKwd:pWFList[0];pWFList[1]; . . . pWFList [iCount-1]BOOL bFmtKwd (PSZ pszKwd, This method formats the pszKwdLPBPLIST pBPList, INT iCount) and ppBPList contents in the form pszKwd:pBPList[0];pBpList[1]; . . . pBpList [iCount-1]BOOL bFmtKwd (PSZ pszKwd, This method formats the pszKwdLPSTATUS pStatus) and pStatus contents in the form pszKwd:pStatusBOOL bFmtKwd (PSZ pszKwd, This method formats the pszKwdLPACTINFO pActInfo, INT and ppActInfo contents in theiCount) form pszKwd:pActInfo[0];pActInfo[1]; . . . pActInfo[iCount-1].about.TxFormatter () This method is the destructor for this class which de- initializes the attributes.______________________________________
Class Name: Envelope
Class Description
This class handles addressing information of WEA. It is used by STF.sub.-- Tx, BoundData and Transaction classes.
______________________________________Super ClassNoneSubclassNoneClasses UsedSTF.sub.-- Tx used to access STFTransporter, BoundDataand Transaction methods.STFTransporter used to get addressing information ofinbound transactions.Transaction used to get addressing information ofoutbound transactions.BoundData used to get addressing information ofoutbound transactions.AttributesAttribute Name Attribute Description______________________________________ppszInUserInfo pointer to array of strings containing inbound user information.uInUserInfoCount Number of items in ppszInUserInfoppszOutUserInfo pointer to array of strings containing outbound user info.uOutUserInfoCount Number of items in ppszOutUserInfo______________________________________Public MethodsMethod Name Method Description______________________________________Envelope( ) This method is the constructor which initializes the attributes.BOOL bPutInUserInfo(STF.sub.-- Tx This method calls transporter*pSTF.sub.-- Tx) method bGetInUserInfo( ) to get addressing information of currently processed inbound transaction and stores it in its private data member.PSZ pszGetInUserInfo( ) This method returns a string containing addressing information which is built from various elements of ppszInUserInfo.BOOL bPutOutUserInfo(STF.sub.-- Tx This method accepts string*pSTF.sub.-- Tx, PSZ pszUserInfo) containing user information converts it into appropriate format as required by STFTransporter for addressing and calls STFTransporter method for handing user information for current Outbound transaction.BOOL bGetOutUserInfo(PPSZ This method returns theppszOutUserInfo, USHORT outbound user information*puOutUserInfoCount) stored in the attributes..about.Envelope( ) This method is the destructor which de-initializes the attributes.______________________________________
Class Name: BoundData
Class Description
This class stores and handles all bound data associated with a transaction.
______________________________________ Super Class None Sub Classes None Classes Used STF.sub.-- Tx, STFTxKwd AttributesAttribute Name Attribute Description______________________________________pSTFTx Pointer to STF.sub.-- Tx objectszBDKwd BOUNDDATA keyword stringszFormName Form NameiBDCount Number of BD structurespBoundData Pointer to array of Bound Data structures______________________________________Public MethodsMethod Name Method Description______________________________________BoundData(STF.sub.-- Tx *pSTF.sub.-- Tx) This method is the constructor which updates pSTFTx with the passed parameter and szBDKwd by instantiating STFTxKwdUSHORT uPutInTxBoundData( ) This method updates the bound data attributes from the input transaction using TxParser method.BOOL bPutGetTxBoundData(BOOL This method gets thebActOrState, INT iActOrState) ActOrState Flag and ActOrState value and updates the bound data attributes by calling AWSTGetBoundData( ) and AWSTGetBDFieldAttributes( ). This method is for `Get` type of transactions.BOOL bPutRtnTxBoundData(LONG This method gets thelTxId) Transaction ID and calls the overloaded methods of AWSTGetBoundData( ) and AWSTGetBDFieldAttributes( ) and updates the bound data attributes. This method is for `Return` type of transactions.BOOL bBindAppData( ) This method is used to call AWSTBindAppData( ) to bind the application data with respect to a business process or a workflow.PSZ pszGetBoundDataStream( ) This method is used to return the bound data structure values as a string..about.BoundData( ) This method is the destructor which de-initializes the attributes.______________________________________
Class Name: STF TX
Class Description
This class is used to process the inbound as well as the outbound transactions. It has methods to get the transaction type. It initiates the Transaction class based on the transaction type.
______________________________________Super ClassNoneSub ClassesNoneClasses UsedTransaction, STFTransporter, TxParser, TxFormatter,INIFile, Envelope, and BoundData.AttributesAttribute Name Attribute Description______________________________________uInOrOutTx Flag to indicate Inbound or Outbound TransactionuTxType Transaction typelTxID Transaction ID assigned by the workflow serverbConstrFailed Flag to indicate whether STF.sub.-- Tx constructor failed or notpTransaction Pointer to Transaction classpTransporter Pointer to STFTransporter classpTxParser Pointer to TxParser classpTxFormatter Pointer to TxFormatter classpINIFile Pointer to INIFile classpEnvelope Pointer to EnvelopepBD Pointer to BoundData______________________________________Private MethodsNonePublic MethodsMethod Name Method Description______________________________________STF.sub.-- Tx(USHORT uInOrOutTx, This method is theSTFTransporter *pTransporter, constructor which accepts theTxParser *pTxParser, mode which indicates whetherTxFormatter *pTxFormatter, input or output transaction.INIFile *pINIFile) Based on this mode, it instantiates the transaction objects..about.STF.sub.-- Tx( ) This method is the destructor which deletes all data related to transaction instantiated in the constructor.______________________________________
Class Name: TxProcessor
Class Description
This is the main controlling class of STF processor. It has pointers to STFTransporter TxParser, TxFormatter and STF.sub.-- Tx and INIFile classes in the STF Processor. TxProcessor will be instantiated once during an STF Session (in the main program).
______________________________________Super ClassNoneSubclassNoneClasses UsedSTFTransporter, TxParser, TxFormatter, STF.sub.-- Tx andINIFile.AttributesAttribute Name Attribute Description______________________________________pTransporter Pointer to STFTransporter classpTxPrs Pointer to TxParser classpTxFormatter Pointer to TxFormatter classpSTF.sub.-- Tx Pointer to STF.sub.-- Tx classpINIFile Pointer to INIFile class______________________________________Public MethodsMethod Name Method Description______________________________________TxProcessor( ) This method is the constructor of TxProcessor which instantiates STFTransporter, TxParser, TxFormatter and INIFile.BOOL bProcessInputTx(BOOL This method processes the input*pbMoreTx) Transaction data by instantiating STF.sub.-- Tx in Input mode.BOOL bProcessOutputTx( ) This method processes the output Transaction data by instantiating STF.sub.-- Tx in Output mode..about.TxProcessor( ) This method is the destructor of TxProcessor which deletes all data member pointers.______________________________________
Class Name: Transaction
Class Description
This class is the base class for the various types of WEA transaction classes It has virtual method to process the required Transactions.
______________________________________Super ClassNoneSub ClassesInitBP, InitWF, Act, BindData, GetWFStatus,GetPendingActions, GetAvailableBPs, ReturnWFStatusClasses UsedSTF.sub.-- TxAttributesAttribute Name Attribute Description______________________________________pSTF.sub.-- Tx Pointer to STF.sub.-- Tx classbRtnStatus Flag to indicate whether WEA requested Status of TransactionbRtnBData Flag to indicate whether WEA requested Bound DatalAWSTError Error returned by workflow server API(s)BPTid Business Process Transaction IDWFTid WorkFlow Transaction IDIdentity Identity of the person who is initiating the Transaction.ppszSTFTxId STF Transaction ID sent by WEA______________________________________Public MethodsMethod Name Method Description______________________________________Transaction(STF.sub.-- Tx *pSTFTx) This method is the constructor which accepts the pointer to STF.sub.-- Tx class and substitutes it in pSTF.sub.-- Tx data member.virtual BOOL bDoIt( ) This virtual method is used to call workflow server API(s) and Formatter to process the Transactions. By default it processes invalid Transactions..about.Transaction( ) This method is the destructor which de-allocates all the memory occupied by data members.______________________________________
Class Name: STFTxKwd
Class Description
This class defines STF Transaction keywords. This is used by the Transaction class to get keyword string and values for calling workflow server APIs and to send return values of workflow server APIs to TxFormatter. The constructor of this class gets the keyword string from Resource.
______________________________________ Super Class None Sub Classes None Classes Used TxParser STF Transaction Parser AttributesAttribute Name Attribute Description______________________________________pSTF.sub.-- Tx Pointer to STF.sub.-- Tx class (to get Parser pointer)szKwd STF Keyword string______________________________________Public MethodsMethod Name Method Description______________________________________STFTxKwd(STF.sub.-- Tx *pSTFTx, This constructor accepts theUSHORT uKwdID) pointer to STF.sub.-- Tx class and the keyword ID (defined in the Resource). It fills the szKwd data member corresponding to uKwdID from the Resource.PSZ pszGetKwd( ) This method returns szKwd stored in the object.VOID vGetKwd(PSZ pszKwd) This method updates pszKwd with szKwd stored in the object. This method assumes that the caller allocates memory for pszKwd.USHORT uGetKwdValue(PPSZ This method outputs the keywordppszKwdValueStr) value corresponding to the szKwd stored in the object using Parser's method bGetSTFTxKwdValue( ).______________________________________
The following methods are overloaded for different keyword data types.
______________________________________Method Name Method Description______________________________________USHORT uGetKwdValue(USHORT This method outputs the keyword*puKwd) value in puKwd corresponding to the data member szKwd stored in the object using Parser's method bGetSTFTxKwdValue( ).USHORT uGetKwdValue(INT This method outputs the keyword*piKwd) value in piKwd corresponding to the data member szKwd stored in the object using Parser's method bGetSTFTxKwdValue( ).USHORT uGetKwdValue(LONG This method outputs the keyword*plKwd) value in plKwd corresponding to the data member szKwd stored in the object using Parser's method bGetSTFTxKwdValue( ).USHORT uGetKwdValue(BOOL This method outputs the keyword*pbKwd) value in pbKwd corresponding to the data member szKwd stored in the object using Parser's method bGetSTFTxKwdValue( ).USHORT This method outputs the keyworduGetKwdValue(LPDATETIMET value in pDataTimepDateTime) corresponding to the data member szKwd stored in the object using Parser's method bGetSTFTxKwdValue( ).USHORT This method outputs the keyworduGetKwdValue(LPORG2ID values in pOrg2ID and piCountpOrg2ID, INT *piCount) corresponding to the data member szKwd stored in the object using Parser's method bGetSTFTxKwdValue( )..about.STFTxKwd( ) This method is the destructor which does nothing.______________________________________
Class Name: InitBP
Class Description
This class is derived from Transaction class and it has methods to call workflow server API and the TxFormatter.
______________________________________ Super Class Transaction Sub Classes None Classes Used STF.sub.-- Tx, STFTxKwd. AttributesAttribute Name Attribute Description______________________________________None None______________________________________Private MethodsMethod Name Method Description______________________________________BOOL bCallAPI( ) This method is used to call the workflow server API to initiate business process. To get the parameters needed for the workflow server API call, it instantiates the STFTxKwd objects for different parameters.BOOL bCallFormatter(STF.sub.-- Tx This method is used to call*pSTF.sub.-- Tx) TxFormatter to format the return values got from workflow server API. Using pSTF.sub.-- Tx, it gets the pointer to TxFormatter.______________________________________Public MethodsMethod Name Method Description______________________________________InitBP(STF.sub.-- Tx *pSTFTx) This method is the constructor which accepts the pointer to STF.sub.-- Tx class which will be used by other methods of this class.virtual BOOL bDoIt( ) This method calls the private methods bCallAPI( ) and bCallFormatter( ) to process this Transaction..about.InitBP( ) This method is the destructor which de-initializes all the attributes.______________________________________
Class Name: InitWF
Class Description
This class is derived from Transaction class and it has methods to call workflow server API and the TxFormatter.
______________________________________ Super Class Transaction Sub Classes None Classes Used STF.sub.-- Tx, STFTxKwd. AttributesAttribute Name Attribute Description______________________________________None None______________________________________Private MethodsMethod Name Method Description______________________________________BOOL bCallAPI( ) This method is used to call the workflow server API to initiate workflow. To get the parameters needed for the workflow server API call, it instantiates the STFTxKwd objects for different parameters.BOOL This method is used to callbCallFormatter(STF.sub.-- Tx TxFormatter to format the return*pSTF.sub.-- Tx) values got from workflow server API. Using pSTF.sub.-- Tx, it gets the pointer to TxFormatter.______________________________________Public MethodsMethod Name Method Description______________________________________InitWF(STF.sub.-- Tx *pSTFTx) This method is the constructor which accepts the pointer to STF.sub.-- Tx class which will be used by other methods of this class.virtual BOOL bDoIt( ) This method calls the private methods bCallAPI( ) and bCallFormatter( ) to process this Transaction..about.InitWF( ) This method is the destructor which de-initializes all the attributes.______________________________________
Class Name: Act
Class Description
This class is derived from Transaction class and it has methods to call workflow server API and the TxFormatter.
______________________________________ Super Class Transaction Sub Classes None Classes Used STFTxKwd, STFTxKwd. AttributesAttribute Name Attribute Description______________________________________None None______________________________________Private MethodsMethod Name Method Description______________________________________BOOL bCallAPI( ) This method is used to call the workflow server API(s) to act on a workflow. To get the parameters needed for the workflow server API call, it instantiates the STFTxKwd objects for different parameters.BOOL bCallFormatter(STF.sub.-- Tx This method is used to call*pSTF.sub.-- Tx) TxFormatter to format the return values got from workflow server API. Using pSTF.sub.-- Tx, it gets the pointer to TxFormatter.______________________________________Public MethodsMethod Name Method Description______________________________________Act(STF.sub.-- Tx *pSTFTx) This method is the constructor which accepts the pointer to STF.sub.-- Tx class which will be used by other methods of this class.virtual BOOL bDoIt( ) This method calls the private methods bCallAPI( ) and bCallFormatter( ) to process this Transaction..about.Act( ) This method is the destructor which de-initializes all the attributes.______________________________________
Class Name: BindData
Class Description
This class is derived from Transaction class and it has methods to call workflow server API and the TxFormatter.
______________________________________ Super Class Transaction Sub Classes None Classes Used STFTxKwd AttributesAttribute Name Attribute Description______________________________________None None______________________________________Private MethodsMethod Name Method Description______________________________________BOOL bCallAPI( ) This method is used to call the workflow server API to bind the application data to a business process or a workflow. It instantiates Bound Data object to perform this operation.BOOL bCallFormatter(STF.sub.-- Tx This method is used to call*pSTF.sub.-- Tx) TxFormatter to format the return values got from workflow server API. Using pSTF.sub.-- Tx, it gets the pointer to TxFormatter.______________________________________Public MethodsMethod Name Method Description______________________________________BindData(STF.sub.-- Tx *pSTFTx) This method is the constructor which accepts the pointer to STF.sub.-- TX class which will be used by other methods of this class.virtual BOOL bDoIt( ) This method calls the private methods bCallAPI( ) and bCallFormatter( ) to process this Transaction..about.BindData( ) This method is the destructor which de-initializes all the attributes.______________________________________
Class Name: GetWFStatus
Class Description
This class is derived from Transaction class and has methods to call workflow server API and the TxFormatter.
______________________________________ Super Class Transaction Sub Classes None Classes Used STFTxKwd, STFTxKwd. AttributesAttribute Name Attribute Description______________________________________pStatus Structure which has the Status stringiActCount Number of ActInfo structures returnedppActInfo Array of ActInfo structures______________________________________Private MethodsMethod Name Method Description______________________________________BOOL bCallAPI( ) This method is used to call the workflow server API(s) to get the status of the workflow. To get the parameters needed for the workflow server API call(s), it instantiates the STFTxKwd objects for different parameters. To process Bound Data related information, it instantiates Bound Data object.BOOL bCallFormatter(STF.sub.-- Tx This method is used to call.*pSTF.sub.-- Tx) TxFormatter to format the return values got from workflow server API. Using pSTF.sub.-- Tx, it gets the pointer to TxFormatter.______________________________________Public MethodsMethod Name Method Description______________________________________GetWFStatus(STF.sub.-- Tx *pSTFTx) This constructor which accepts the pointer to STF.sub.-- Tx class which will be used by other methods.virtual BOOL bDoIt( ) This method calls the private methods bCallAPI( ) and bCallFormatter( ) to process this Transaction..about.GetWFStatus( ) This method is the destructor which de-initializes all the attributes.______________________________________
Class Name: GetPendingActions
Class Description
This class is derived from Transaction class and it has methods to call workflow server API and the TxFormatter.
______________________________________ Super Class Transaction Subclass None Classes Used STF.sub.-- Tx, STFTxKwd. AttributesAttribute Name Attribute Description______________________________________iWFCount Number of WorkFlow list structures returnedppWFList Array of WorkFlow structures______________________________________Private MethodsMethod Name Method Description______________________________________BOOL bCallAPI( ) This method is used to call the workflow server API to get the list of workflows for which actions are pending.BOOL bCallFormatter(STF.sub.-- Tx This method is used to call*pSTFTx) TxFormatter to format the return values got from workflow server API. Using pSTF.sub.-- Tx, it gets the pointer to TxFormatter.______________________________________Public MethodsMethod Name Method Description______________________________________GetPendingActions(STF.sub.-- Tx This method is the constructor*pSTFTx) which accepts the pointer to STF.sub.-- Tx class which will be used by other methods of this class.virtual BOOL bDoIt( ) This method calls the private methods bCallAPI( ) and bCallFormatter( ) to process this Transaction..about.GetPendingActions( ) This method is the destructor which de-initializes all the attributes.______________________________________
Class Name: GetAvailableBPs
Class Description
This class is derived from Transaction class and it has methods to call workflow server API and the TxFormatter.
______________________________________ Super Class Transaction Sub Classes None Classes Used STF.sub.-- Tx, STFTxKwd. AttributesAttribute Name Attribute Description______________________________________iBPCount Number of Business Process list structures returnedpBPList Array of Business Process structures______________________________________Private MethodsMethod Name Method Description______________________________________BOOL bCallAPI( ) This method is used to call the workflow server API to get the list of available business processes.BOOL This method is used to callbCallFormatter(STF.sub.-- Tx TxFormatter to format the return*pSTF.sub.-- Tx) values got from workflow server API. Using pSTF.sub.-- Tx, it gets the pointer to TxFormatter.______________________________________Public MethodsMethod Name Method Description______________________________________GetAvailableBPs(STF.sub.-- Tx This method is the constructor*pSTFTx) which accepts the pointer to STF.sub.-- Tx class which will be used by other methods of this class.virtual BOOL bDoIt( ) This method calls the private methods bCallAPI( ) and bCallFormatter( ) to process this Transaction..about.GetAvailableBPs( ) This method is the destructor which de-initializes all the attributes.______________________________________
Class Name: ReturnWFStatus
Class Description
This class is derived from Transaction class and has methods to Poll for workflow processor generated Notifications and call workflow server API for getting Workflow status and Bound Data. It also calls the TxFormatter to send the WF status data to the WEA.
______________________________________ Super Class Transaction Sub Classes None Classes Used STFTxKwd, STFTxKwd. AttributesAttribute Name Attribute Description______________________________________pStatus Structure which has the Status stringiActCount Number of ActInfo structures returnedppActInfo Array of ActInfo structures______________________________________Private MethodsMethod Name Method Description______________________________________BOOL bCallAPI( ) This method is used to call the workflow server API(s) to get the status of the workflow. To get the parameters needed for the workflow server API call(s), it instantiates the STFTxKwd objects for different parameters. To process Bound Data related information, it instantiates Bound Data object.BOOL bCallFormatter(STF.sub.-- Tx This method is used to call*pSTF.sub.-- Tx) TxFormatter to format the return values got from workflow server API. Using pSTF.sub.-- Tx, it gets the pointer to TxFormatter.______________________________________Public MethodsMethod Name Method Description______________________________________ReturnWFStatus(STF.sub.-- Tx This constructor which accepts the*pSTFTx) pointer to STF.sub.-- Tx class which will be used by other methods.virtual BOOL bDoIt( ) This method polls to Notification events in the STD queue of the server. If it finds an event, the appropriate workflow server APIs are called to obtain WF status..about.ReturnWFStatus( ) This method is the destructor which de-initializes all the attributes.______________________________________
Class Name: Error
Class Description
This class is used for error handling. It records the errors during an STF Processor session. The error object is updated with error information by other objects in the STF Processor whenever an error occurs. The error messages are stored in a Resource file (RC) and is loaded as and when required. Whenever a non-fatal error occurs, it will be logged in an ASCII error log file whose path is specified in the STF Processor initialization file (INI file). All fatal errors will be logged and displayed on the STF Processor display as pop-up dialog boxes and after user intervention, the STF Processor will shut down. Please Refer to Sec. 10 for details of error handling in STF Processor. The Error object is Global which is used by all the classes in STF Processor when error logging is required. The format of error logged in the error log file is:
______________________________________<STF Processor Name><Date:Time><Errorcode ><Error Message>e.g.<STF01><12-14-92 12:30:00><00000168><Could not findkeyword(s):BPNAME>Super ClassNoneSub ClassesNoneClass UsedINIFile Initialization file class to obtain the errorlog file specification.AttributesAttribute Name Attribute Description______________________________________iErrcode Error Code (corresponding to string table ID in Resource file)pszErrlogStr Error log string Whether the error is fatal or notszErrLogFile Error log file path (from INIFile)pEINIFile pointer to INI file______________________________________Public MethodsMethod Name Method Description______________________________________Error( ) This method is the constructor which initializes data members.VOID vPutError(LONG This method updates Error code andlErrCode, BOOL message and writes it into errorbFatalFlag, PSZ log file. The error stringpszParam1, PSZ pszParam2, pszErrLogstr corresponding toPSZ Param3) iErrCode is accessed from the Resource. If bFatalFlag is TRUE, then the error message is logged and then popped up on the screen. If there is an error in logging, it is treated as a fatal error. The parameters are substituted to the error message loaded from the Resource. These parameters are defaulted to NULL if not specified.PSZ pszGetErrMsg( ) This method gets the error message stored in pszErrLogStr..about.Error( ) This method is the destructor which reinitializes all data members.______________________________________

	Number	Date	Country
Parent	420337	Apr 1995
Parent	023056	Feb 1993

Method and apparatus for utilizing a standard transaction format to provide application platform and a medium independent representation and transfer of data for the management of business process and their workflows

Information

Patent Number

Date Filed

Date Issued

Inventors

Original Assignees

Examiners

Agents

CPC

US Classifications

Field of Search

US

International Classifications

Abstract

Description

Claims

Parent Case Info

US Referenced Citations (1)

Continuations (2)