Modifying HTML Step Processor Toolkit Core Script Files
This topic describes how to modify the core JavaScripts supplied with the
HTML Step Processor Toolkit for the FileNet Web Services web application. These
core scripts, shared by both the default HTML Step Processor and Launch Step
Processor, 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).
Note This topic summarizes the constructors and methods available for
the client-side objects. For more detailed information, see the code in the
JavaScript file itself.
Depending upon your application requirements, you may modify either or both
of the following HTML Step Processor Toolkit core .JS files (click on the link
for details):
- step.js implements functions for creating
and working with client-side objects.
- att.js implements functions for creating
a client-side attachment objects.
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.
step.js
The step.js JavaScript specifies functions for creating and working
with client-side Step Processor objects. These functions declare methods for
the following client objects:
PW_StepElement (Step Element)
Object
The PW_StepElement object supports the following methods:
- addAttachment() - adds an attachment object to a Step element.
- getAttachment() - retrieves a specific attachment.
- getAttachmentCount() - determines the number of attachments on a Step element.
- getResponse() - checks the response array for an index value.
- setComment() - sets the comment for the Step element.
- setSubject() - sets the subject for the Step element.
- setUserInfoList() - adds user information to an array.
- toXML() - creates an XML string that represents the Step element.
PW_StepInfo (Step Information)
Object
The PW_StepInfo object does not support any methods.
PW_StepParameter (Step
Parameter) Object
The PW_StepParameter object supports the following methods:
- getDescription() - returns the parameter description.
- setDirty() - boolean; sets a flag to true to indicate that the parameter
needs to be saved to the server.
- toString() - returns the parameter name.
- toXML() - creates an XML string, using the step information, to send from
the client to the server.
PW_Milestone (Milestone) Object
The PW_Milestone object supports the following methods:
- getName() - retrieves the milestone name.
- getMessage() - retrieves the message associated with the milestone.
- getReached() - gets the information about the milestone.
- toXML() - creates an XML string, using the milestone information, to send
from the client to the server.
PW_WorkGroup (Work Group) Object
The PW_WorkGroup object supports the following methods:
- getDescription() - returns the work group description.
- setDirty() - boolean; sets a flag to true to indicate that the parameter
needs to be saved to the server.
- toString() - returns the work group name.
- toXML() - create an XML string, using the work group information, to send
from the client to the server.
att.js
The att.js JavaScript specifies functions for creating and working with
the client-side attachment object (PW_Attachment).
These functions declare methods for the PW_Attachment
object, including checking for the attachment type: document, folder, and stored
search. This script also uses some of the FileNet
Web Services client-side Javascript API objects to work with attachments.
Because attachments are stored in FileNet Content Services or Image Services
libraries, the implemented functions rely on the client-side JavaScript IDMWSC_Library
object (the FileNet Web Services Library.js
provides the ability to create an IDMWSC_Library
object and use methods supported by the object) to create and work with attachment
objects. For additional information on client-side objects provided by FileNet
Web Services files, see FileNet
Web Services Files Referenced By Process Applications.
PW_Attachment (Attachment)
Object
The PW_Attachment object supports the following methods:
- assign() - assigns an attachment to a specific place in an array.
- deleteIDMObj() - deletes an attachment from a specific place in an array.
- getDescription() - returns an attachment description.
- getIconFile() - returns a string to locate the icon associated with
the object type.
- getIDMAttachment() - retrieves an array from a specific location in an array.
- getIDMAttachmentCount() - determines the number of attachments in an array.
- getToolTip() - returns a description of well-known object types.
- insert() - puts an attachment into an array.
- setDirty() - boolean; sets a flag to true to indicate that the attachment
parameter was modified and that it needs to be saved to the server.
- setReadOnly() - prevents the user interface from changing the attachment
parameter value.
- toString() - gets the attachment name.
- toXML() - creates an XML string that describes the attachment object.
- unassignIDMObj() - unassigns an attachment at a given location in an array.