DMS Workflow API Reference

Programming Guides › Programming Guide for C › DMS Workflow API › DMS Workflow API Reference

DMS Workflow API Reference

To create a custom workflow library:

Include the SmApi.h file, as follows:
```
#include "SmApi.h"
```
Include the SmEventApi.h file, as follows:
```
#include " SmEventApi.h"
```
Make sure the following functions are externally visible:

Function	Description
SmDmsWorkflowInit()	Initializes the workflow library. The library should initialize whatever resources it needs at this time.
SmDmsWorkflowPostprocess()	Performs the workflow postprocess step.
SmDmsWorkflowPreprocess()	Performs the workflow preprocess step.
SmDmsWorkflowRelease()	The library should release whatever resources were created by initialization at this time.

Each entry point in the shared library must be defined according to specified syntax.

Note: If you are using Microsoft Visual Studio, export the function addresses to a modular definition file (.DEF) file. To export the function addresses, create a .DEF file. In the file’s export section, list all the functions described in the previous table. Once you have created the .DEF file, add it to the Microsoft Visual Studio project.

Compile the code into a DLL or shared library. The name of this file will be specified as the library in the SiteMinder Registration Properties dialog.

When you have written a custom workflow, such as the example provided at the end of this chapter, you must define the workflow in the Registration Properties dialog using the Administrative UI.