Modify Core Script Files
This topic describes how to modify, in general terms, the core script files
used by the default HTML Step Processors and Launch Step Processors. Unlike
the other topics detailing the files in the \WF_Html_toolkit\core
directory, this file lists the constructors and available method for the client-side
object.
Caution You can add new functions
or extend the existing function in these files; however, you must not delete
or alter the existing functions.
step.js
The step.js file defines and declares methods for the creating and working
with step element (PW_StepElement), step information (PW_StepInfo), step parameter
(PW_StepParameter), milestone (PW_Milestone), and work group (PW_WorkGroup)
objects.
This topic summarizes the methods supported for each Javascript object. If
you want more detailed objects reference information, review the Javascript
code contained in the file for the constructor and method parameter information.
PW_StepElement (Step Element) Object
The PW_StepElement object supports the following methods:
- addAttachment() - add an attachment object to a step element
- getAttachment() - retrieve a specific attachment
- getAttachmentCount() - determine the number of attachments on a step element
- getResponse() - check the response array for an index value
- setComment() - set the comment for the step element
- setSubject() - set the subject for the step element
- setUserInfoList() - add user information to an array
- toXML() - create 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() - modies boolean to indicate 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() - retrieve the milestone name.
- getMessage() - retrieve the message associated with the milestone.
- getReached() - get 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() - modies boolean to indicate the parameter needs to be saved
to the server.
- toString() - return 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 file defines and declares methods for the creating and working
with attachment (PW_Attachment) objects. Review the Javascript code contained
in the file for more information about constructor information and method parameter
information.
Because the attachments are stored in either Content Services or Image Services
libraries, the implemented functions rely on the client-side Javascript IDMWSC_Library
object, which is supplied by the Panagon Web Services, to create and work with
attachment objects. Refer to the Referenced
Panagon Web Services Files for a brief description of the available client-side
API objects, or refer to Locate
the Panagon Web Services Toolkit Help for more information on using the
Panagon Web Services components.
PW_Attachment (Attachment) Object
The PW_Attachment object supports the following methods:
- assign() - assign an attachment a specific place in an array
- deleteIDMObj() - delete an attachment from a specific place in an array
- getDescription() - return an attachment description
- getIconFile() - return a string to locate the icon associated with
the object type
- getIDMAttachment() - retrieve an array from a specific location in an array
- getIDMAttachmentCount() - determine the number of attachments in an array
- getToolTip() - return a description of well-known object types
- insert() - put an attachment into an array
- setDirty() - set a flag to true to indicate that the attachment parameter
was modified and it needs to be saved to the server
- setReadOnly() - prevents UI from changing the attachment parameter value
- toString() - get the attachment name
- toXML() - create and XML string the describes the attachment object
- unassignIDMObj() - unassign an attachment at a given location in an array