This topic describes how to modify the following core ASP files supplied with the HTML Step Processor Toolkit for the FileNet Web Services web application. These core files, shared by both the default HTML Step Processor and Launch Step Processor, primarily reside in the ...\Program Files\FileNet\IDM\Web\IDMWS\Redist\WF_Html_Toolkit\Core directory on the FileNet Web Services server (if a default installation has been used).
Depending upon your application requirements, you may modify one or more of the following HTML Step Processor Toolkit core ASP files (click on the link for details):
Note This topic does not describe the server-side Include files, which are located in the same directory as these files.
Caution You may add new functions or extend the existing functions in these files; however, you should not delete or alter any of the existing functions or your application may not work.
Similar to the stepElementInit.asp file. The file includes the following PJAC for FileNet Web Services Include helper files:
The file uses the JiGlue COM Bridge to work with VWAttachment objects in Process Services. Like the stepElementInit.asp file, the launchStepElementInit.asp implements server-side VBScript functions and client-side JavaScript functions for determining and initializing system field values for the user interface components.
Tip You may wish to refer to this file to determine how to create and access FileNet Content Services or Image Services attachments that can be viewed during workflow processing.
The launchStepElementInit.asp uses the FileNet Web Services client-side JavaScript IDMWSC_Result object to implement a JavaScript switch structure (this object is created by the FileNet Web Services Result.js script). For additional information on this and other FileNet Web Services files/scripts used with Process applications, see FileNet Web Services Files Referenced By Process Applications.
Includes the following PJAC for FileNet Web Services helper files:
The launchStepProcessor.asp also includes and references other files (refer to this launchStepProcessor.asp file to examine the remaining referenced and included files).
The launchStepProcessor.asp file is a top-level ASP page. The file implements VBScript functions for parsing XML Step Element strings provided from the client system. The launchStepProcessor.asp file includes a template for the XML schema used to parse the Launch Step Element string and also includes comments on assumptions used. For reference purposes, the well-formed XML schema is shown here:
<step> <comment>...</comment>
<subject>...</subject>
<wfId>...</wfId>
<selResponse>...</selResponse> -- Optional reponses
<att>
<name>...</name>
<isArray>0</isArray> -- 0 = non-array, or 1 for array.
<idmAtt>
<name>...</name>
<desc>...</desc>
<type>...</type>
<lib>...</lib>
<libType>...</libType>
<id>...</id>
</idmAtt>
... -- one or more IDM attachment
</att>
<att>
... -- One or more attachment objects
</att>
<field>
<name>...</name>
<desc>...</desc>
<type>...</type>
<value>...</value>
<isArray>...</isArray>
</field>
<field>
... -- One or more field
</field>
<workgroup>
<name>...</name>
<participants>...</participants>
</workgroup>
<workgroup>
... -- One or more work groups
</workgroup> </step>
Note A number of other core files (e.g., stepProcessorAttHelper.asp, stepProcessorFieldHelper.asp, stepProcessorWGHelper.asp) are also used to help to parse the XML strings from the client.
Includes the following PJAC for FileNet Web Services helper files:
The stepElementInit.asp also includes and references other files (refer to the file to examine the remaining referenced and included files).
The stepElementInit.asp page implements VBScript server-side functions for retrieving step element properties used to populate the client-side components.
The stepElementInit.asp uses the FileNet Web Services client-side JavaScript IDMWSC_Result object to implement a JavaScript switch structure (this object is created by the FileNet Web Services Result.js script). For additional information on this and other FileNet Web Services files/scripts used with Process applications, see FileNet Web Services Files Referenced By Process Applications.
Includes the following PJAC for FileNet Web Services helper files:
The stepProcessor.asp also includes and references other files (refer to this stepProcessor.asp file to examine the remaining referenced and included files).
The stepProcessor.asp file is a top-level ASP page. The file implements VBScript helper functions for retrieving and restructuring XML Step Element strings. The implemented functions assume that an VWSession object already exists (required for a Process session).
The file includes a template for a full well-formed XML schema (similar to that used in the launchStepProcessor.asp) used to parse the Step Element string. For reference purposes, see the XML schema as shown in the launchStepProcessor.asp file description above.
Note A number of other core files (e.g., stepProcessorAttHelper.asp, stepProcessorFieldHelper.asp, stepProcessorWGHelper.asp) are also used to help to parse the XML strings from the client.
The stepProcessorAttHelper.asp file implements server-side VBScript functions for parsing the XML string generated on the client system and saving the property information contained in the FileNet Content Services or Image Services attachment (<idmAtt>...</idmAtt>) tag set of the well-formed XML string.
The file uses the JiGlue COM Bridge to work with VWAttachment objects in Process Services.
The XML schema for working with attachments is as follows:
<att>
<name>...</name>
<isArray>0</isArray> -- 0 = non-array, or 1 for array.
<idmAtt>
<name>...</name>
<desc>...</desc>
<type>...</type>
<lib>...</lib>
<libType>...</libType>
<id>...</id>
</idmAtt>
</att>
Note The full well-formed XML schema is as shown in the launchStepProcessor.asp file description above.
The stepProcessorFieldHelper.asp file implements server-side VBScript functions for parsing the XML string generated on the client system and changing the system field property information contained in the (<field></field>) tag set of the well-formed XML string.
The XML schema for system field property information is as follows:
<field>
<name>...</name>
<desc>...</desc>
<type>...</type>
<value>...</value>
<isArray>...</isArray>
</field>
Note The full well-formed XML schema is as shown in the launchStepProcessor.asp file description above.
The stepProcessorWGHelper.asp file implements server-side VBScript functions for parsing the XML string generated on the client system and changing property information contained in the work group (<workgroup></workgroup>) tag set of the well-formed XML string.
The XML schema for work group property information is as follows:
<workgroup>
<name>...</name>
<participants>...</participants>
</workgroup>
Note The full well-formed XML schema is as shown in the launchStepProcessor.asp file description above.
The toolbarHelper.asp, working with the step.js file, defines the toolbar button behaviors. The toolbarHelper.asp file calls the toXML() method defined in the step.js file to generate an XML string, which is sent from the client to the server.