SmDmsWorkflowPreprocess()

Programming Guides › Programming Guide for C › DMS Workflow API › Write and Define a DMS Workflow › SmDmsWorkflowPreprocess()

SmDmsWorkflowPreprocess()

SiteMinder calls this function so that a workflow library can preprocess a DMS event.

Syntax

Sm_DmsWorkflowApi_Status_t SM_EXTERN SmDmsWorkflowPreprocess(
   const Sm_Api_Context_t*             lpApiContext,  
   const Sm_Api_DmsContext_t*          lpDmsContext,
   const char *                        lpszWorkflowOid,
   const int                           nCategoryId,
   const int                           nEventId,
   const char *                        lpszObjectPath,
   const int                           nAttributes,
   const Sm_DmsWorkflow_Attribute_t*   pAttributes,
   const int                           nBytesErrMsg,
   char *                              lpszErrMsg
);

Parameter	I/O	Description
lpApiContext	I	Pointer to the API context structure.
lpDmsContext	I	Pointer to the DMS context structure.
lpszWorkflowOid	I	Unique workflow identifier.
nCategoryId	I	DMS event type.
nEventId	I	DMS event identifier
lpszObjectPath	I	Distinguished name of the object that is the target of this event, if any. The target object DN will be available for requests to create, delete, and modify directory objects.
nAttributes	I	Number of attributes in the array of request attributes.
pAttributes	I	Array of DMS request attribute/value pairs.
nBytesErrMsg	I	Maximum size of the output error buffer.
lpszErrMsg	O	Output buffer to receive the error text. Use this buffer to return an error message to the DMS application.

Returns

Sm_DmsWorkflowApi_Success. Function was successful.
Sm_DmsWorkflowApi_Failure. Function was not successful.
Sm_DmsWorkflowApi_NoUserContext. An administrative user event was generated and the user context could not be determine.
Sm_DmsWorkflowApi_SkipSuccess. The event will be handled by the preprocess function and no further processing is desired.
Sm_DmsWorkflowApi_Ignore. The event was of no interest to this step.

Remarks

A return of Sm_DmsWorkflowApi_Success or Sm_DmsWorkflowApi_Ignore causes processing to continue. Any other return causes processing to stop, and an error code is returned to the application. The error code indicates that there was a failure in the DMS preprocessing step.

Sm_DmsWorkflowApi_SkipSuccess causes processing to stop, but a success status is returned to the application. It is up to the implementation of the preprocess function to fulfill the desired goal. If the function fails, it should return a failure code rather than Sm_DmsWorkflowApi_SkipSuccess.

The character array lpszErrMsg may be used by the preprocess function to send an error message back to the application. The maximum size of the character array is specified in nBytesErrMsg.

Email CA about this topic