Application Engine UI Service Command Reference
This section describes the URL-based commands supported by the Application Engine UI Service.
NOTE FileNet® P8 4.0 provides support for Java™ Authentication and Authorization Service (JAAS) container-managed authentication, which represents enhancements to existing application-managed authentication features. JAAS facilitates integration with third-party SSO products that integrate with Java 2 Enterprise Edition (J2EE)/JAAS systems, such as Netegrity. However, when using JAAS container-managed authentication, Workplace does not generate user tokens because it does not have access to full user credentials and therefore, has nothing to encrypt as the basis for the token. As a result, in situations where Workplace might expose an action that invokes some piece of UI hosted by, for example, Records Manager (RM), and container-managed authentication is in use, the user will be presented with a second sign-in page when launching the RM-based action. To avoid the second sign-in page, the site must install and configure an SSO solution which offers JAAS support, such as Netegrity SiteMinder.
Required Versus Optional Parameters
All parameters sent to the AE UI Service are considered to be optional, unless they are identified
as [required]. If you don't specify an optional
parameter, the AE UI Service will either ignore the parameter, or it will use a
wildcard for the parameter values. For example, the Checkout List command uses
a mimeTypes parameter. If you don't include the mimeTypes
parameter in the URL, all MIME types will be used when Checkout List executes.
The same logic applies for other command input parameters, such as document
classes and object store names.
Encoding and Decoding Parameters
Some parameters require label encoding or decoding and
are identified using the [encode] and
[decode] notation. As was previously discussed, when sending commands to the AE UI Service, some URL parameters must
be label-encoded or URL-encoded. In addition, request parameters that are
label-encoded in a J2EE Web application must be explicitly decoded. However,
URL-encoded parameters are automatically decoded when they are returned from
request.getParameter(...)
, including the
_responseURL parameter.
Prefill Options for the FileNet P8 eForms Commands
The Add Form Data and Launch Form Data commands allow additional data to be specified for use in prefilling a Workplace form prior to rendering. The prefill parameter of each command is used to specify the additional data, and the mergeData parameter indicates the manner in which the prefill data should be applied to the form in relation to initial form data.
Prefill form data is specified using either the "post", "get", or "parameter" mechanism, which operate in the same basic manner by passing initial form data into a Workplace servlet via the http request object. The prefill data is specified using either URL parameters in the query string, as POST data in the http request object, or through a form data ".ifx" file located on the Application Engine (AE) server. Each mechanism requires a custom URL to be constructed and presented by your custom web application. However, Workplace does not in any way directly expose these URLs to the application. The following sections describe each mechanism in more detail.
"post" Mechanism
The "post" mechanism specifies the prefill form data using either XML or "file" type input, as follows:
- A standard html input field (which may be hidden) that contains form data formatted as XML. This data must be placed in a field called “data” (this is the default field name of a standard form submit as well). The XML should be formatted in the standard form data schema.
- A standard html input field that is of type “file”. This causes the standard file selection button (Browse…) for the browser to be positioned next to the input control. The file is picked up off the clients local file system and packaged as part of the http form submit. This data must be placed in a field called “fileName”.
NOTE In order to use the "post" mechanism, the user must either already be logged into the Application Engine (Workplace), or they must pass login credentials on the URL via the user tokens. If the user is not logged in, the AE UI Service command (in actuality, the Workplace controller) will redirect the user to the Sign In page. However, the process of redirecting causes the http post information to be lost, as the Workplace Sign In page does not forward any posted data. For information about passing login credentials on the URL, see Creating a Sign-In Policy.
"get" Mechanism
The "get" mechanism specifies the file path location of the prefill form data in the query string. The filePath parameter of the string contains the location of the form data ".ifx" file on the AE server or on a shared drive visible from AE.
Once the form data .ifx file has been obtained and processed by the command, the file is deleted.
"parameter" Mechanism
NOTE This mechanism is deprecated for eForms 4.x and is intended for internal use only. Continued use of this mechanism is not recommended because, due to architectural constraints, the "parameter" mechanism may not operate exactly as it did in 3.5.1. Instead preference should be given to the "post" or "get" mechanism for providing prefill data to the form.
The "parameter" mechanism specifies prefill form data using two parameters to define name/value pairs for form cells in the query string. The data parameter provides references to data sources that are used to prefill the form. This first parameter has a urlencoded
format setting that allows the request-based data to be specified through an independent query string or second form parameter, independent of the first parameter. The second parameter provides the actual form data as a URL-encoded collection of name-value pairs:
... data=urlencoded,mydata ...
The URL syntax supports the specification of a variety of data sources which may be used to prefill the form. Each name/pair consists of the symbolic name and prefill value for a form cell. Cells with multiple values are represented using either multiple parameters, or with a single, vertical tab-separated value:
... Name=John%20Smith&Age=43&Kids=Matthew&kids=Ruth&kids=Mary&kids=Mark&kids=Luke&kids=Sarah
... Name=John%20Smith&Age=43&Kids=Matthew%11Ruth%11Mary%11Mark%11Luke%11Sarah
Each parameter may occur either on the query string or as a form parameter. Those parameters which occur on the query string must be URL-encoded to prevent conflicts with other URL syntax:
data=urlencoded,mydata&mydata=Name%61John%3720Smith%38Age
%6143%38Kids%61Matthew%3711Ruth%3711Mary%3711Mark%3711Luke%3711Sarah
While manually creation of query string parameters can be confusing, convenient calculations are provided for doing so with a form. For example, the following link is created using embedded calculations which properly encode the data:
Page.jsp?data=urlencoded,mydata&mydata=<<UrlEncode(UrlEncoding(“Name,Age,Kids”, Name, Age, Kids))>>
Application Engine UI Service Commands
The following table lists the commands according to functional groups: actions, forms, lists,
and properties. For details on a specific command, click the applicable link.
You can also get online command help from the AE UI Service.
Actions |
Command Description |
1010 |
Add Document |
1012 |
Add Document with User-Selected Template |
1015 |
Add Object |
1020 |
Add Document with Specified Template |
1030 |
Check In Document |
1050 |
Declare Versions as Record |
1060 |
Declare as Record |
1070 |
Create a Link |
1080 |
Select File Plan |
1090 |
Launch Workflow |
1090 |
Launch Workflow Subscription |
1100 |
Get User Token |
1200 |
Get Processor |
Forms |
Command Description |
1400 |
Open Form |
1410 |
Render Form |
1420 |
Add Form Data |
1430 |
Launch Form Data |
1440 |
Take Form Offline |
1460 |
Bring Form Online |
Lists |
Command Description |
2010 |
Select Object |
2020 |
Select Entry Template |
2030 |
Checkout List |
2035 |
Cancel Checkout from List |
2037 |
Check In from List |
2040 |
Browse List |
2050 |
Tasks List |
2060 |
Search Results List |
2100 |
Select Multiple Objects |
2110 |
Select Public Inbox |
2120 |
Select Object from Tree View Control |
Properties |
Command Description |
3010 |
Show Properties |
3030 |
Queue Info Page |
3040 |
Milestone Info Page |
Add Document
Launches the Workplace Add Wizard for adding a document to an object store.
Command ID 1010
- Input Parameters
- rootDocClass - The GUID identifier of a document class,
which will be the initially selected document class within the Wizard.
The passed-in GUID specifies the "root" class. If the
restrictDocClass
parameter is set to false
,
then the root class's subclasses (children) will also
be available to select as the document class.
- restrictDocClass - Specifies whether to restrict the
selection of document class to the rootDocClass and its children.
Ignored if rootDocClass is excluded.
- - Set to
true
to allow only the specified root
document class ID to be selectable for the add operation.
- - Set to
false
to allow the specified root document class
ID or any of its children to be selectable for the add operation.
- Response Parameters
- confirmationURL - [decode]
A URL-encoded value to the Workplace confirmation page. It is up to
the calling application to navigate to the confirmation page.
Note that under the following conditions, a confirmationURL
parameter will not be returned:
- - The Workplace site preference "Confirmation page visibility"
is set to
hide
- and
- - There are no post-command operations, such as Declare Records or
Launch Workflow, that can be performed on the object affected by the
command. The availability of these operations supersedes the preference
setting above.
- objectStoreName - [decode]
The object store name where the document was created.
- label - [decode]
The label of the new document.
- id - The document version ID for the new document.
- vsId - The document version series ID for the new document.
- objectType - The object type of the object added to the object store.
- See Also
- Add Document with User-Selected Template
- Add Document with Specified Template
Add Document with User-Selected Template
Adds a new document by first displaying an entry template selection page.
When the user selects an entry template, the Workplace Entry Wizard is launched.
To add a document with a specified template, that is, where the user cannot select
the entry template, see the Add Document with Specified Template command.
Command ID 1012
- Input Parameters
- None.
- Response Parameters
- confirmationURL - [decode]
A URL-encoded value to the Workplace confirmation page. It is up to the
calling application to navigate to the confirmation page. Note that under
the following conditions, a confirmationURL parameter will not be returned:
- - The Workplace site preference "Confirmation page visibility" is set to
hide
.
- and
- - There are no post-command operations, such as Declare Records or Launch
Workflow, that can be performed on the object affected by the command.
The availability of these operations supersedes the preference setting above.
- See Also
- Add Document
- Add Document with Specified Template
Add Object
Launches the Workplace Add Wizard for adding an object to an object store.
Command ID 1015
- Input Parameters
- objectType - [required]
The type of object added. Valid values
are "document", "folder", and "customobject".
- rootClass - The GUID identifier of an object class, which will
be the initially selected object class within the Wizard. The passed-in
GUID specifies the "root" class. If the restrictClass
parameter is set to
false
, then the root class's subclasses
(children) will also be available to select as the object class.
- restrictClass - Specifies whether to restrict the selection
of object class to the root object class and its children. Ignored if
restrictClass is excluded.
- - Set to
true
to allow only the specified root object
class ID to be selectable for the add operation.
- - Set to
false
to allow the specified root object
class ID or any of its children to be selectable for the add operation.
- folderName - The folder name should be specified along
with the GUID value in the call to the AE UI Service. The name
of the folder is displayed in the Summary section of the Add Document
Wizard panel.
- folderId - The GUID of the folder where the object will
reside. If this parameter is used, the Wizard panel for selecting
a folder location is skipped.
- objectStoreName - [encode]
The object store name where the object will reside.
- Response Parameters
- confirmationURL - [decode]
A URL-encoded value to the Workplace confirmation page. It is up to the
calling application to navigate to the confirmation page. Note that under
the following conditions, a confirmationURL parameter will not be returned:
- - The Workplace site preference "Confirmation page visibility" is set to
hide
.
- and
- - There are no post-command operations, such as Declare Records or Launch
Workflow, that can be performed on the object affected by the command.
The availability of these operations supersedes the preference setting above.
- objectStoreName - [decode]
The object store name where the object was created.
- label - [decode]
The label of the new object.
- id - The version ID for the new object.
- vsId - The version series ID for the new object.
- objectType - The type of the object added to the object store.
- folderId - The ID of the folder to which the user added the object.
- See Also
- Add Document
Add Document with Specified Template
Adds a new document using a specified entry template from the Workplace Entry Wizard.
Command ID 1020
- Input Parameters
- templateObjectStoreName - [required,
encode]
The name of the object store in which the entry template resides.
- templateId - [required]
The GUID of the entry template to be used for the add operation.
- templateVsId - [required]
The GUID of the entry template's version series.
- Response Parameters
- confirmationURL - [decode]
A URL-encoded value to the Workplace confirmation page. It is up to the
calling application to navigate to the confirmation page. Note that under
the following conditions, a confirmationURL parameter will not be returned:
- - The Workplace site preference "Confirmation page visibility" is set to
hide
.
- and
- - There are no post-command operations, such as Declare Records or Launch
Workflow, that can be performed on the object affected by the command.
The availability of these operations supersedes the preference setting above.
- objectStoreName - [decode]
The object store name where the document was created.
- label - [decode]
The label of the new document.
- id - The document version ID for the new document.
- vsId - The document version series ID for the new document.
- objectType - The type of object that the template adds.
For this release of Workplace, only documents can be added.
- See Also
- Add Document
- Add Document with User-Selected Template
Check In Document
Invokes a Wizard for checking in a previously checked out document.
The response specifies the new document version.
Command ID 1030
- Input Parameters
- objectStoreName - [required,
encode]
The object store where the document will be checked in.
- id - [required]
The reservation id of the object to be checked in.
- objectType - required]
The object type of object to be checked in. For this release of Workplace,
only documents can be checked in.
- rootDocClass - The value of this parameter is the GUID identifier
of a document class which will be the initially selected document class within
the Wizard. The passed-in GUID specifies the "root" class. If the
restrictDocClass parameter is set to
false
, then the
root class's subclasses (children) will also
be available to select as the document class.
- restrictDocClass - Specifies whether to restrict the selection of
document class to the rootDocClass and its children.
Ignored if rootDocClass is excluded.
- - Set to
true
to allow only the specified root document
class ID to be selectable for the add operation.
- - Set to
false
to allow the specified root document class
ID or any of its children to be selectable for the add operation.
- quickCheckin - Specifies whether the Wizard displays pages for
setting property values and access rights. If you set to
true
,
the document's property values and access rights from its previous version
are automatically applied to the new version. Default value is false
.
- Response Parameters
- confirmationURL - [decode]
A URL-encoded value to the Workplace confirmation page. It is up to the
calling application to navigate to the confirmation page. Note that under
the following conditions, a confirmationURL parameter will not be returned:
- - The Workplace site preference "Confirmation page visibility" is set to
hide
.
- and
- - There are no post-command operations, such as Declare Records or Launch
Workflow, that can be performed on the object affected by the command.
The availability of these operations supersedes the preference setting above.
- objectStoreName - [decode]
The object store where the object was checked in.
- label - [decode]
The label of the checked in document.
- id - The version ID for the checked in document.
- vsId - The version series ID for the checked in document.
- objectType - The type of object that was checked in.
For this release of Workplace, only documents can be checked in.
- See Also
- Checkout List
- Cancel Checkout from List
- Check In from List
Declare Versions as Record
Selects one to many versions of a document's version series
to be declared as a single record.
Command ID 1050
- Input Parameters
- objectStoreName - [required,
encode]
The object store where document resides.
- id - [required]
The ID of the document.
- objectType - [required]
Specify "document".
- mode - [required]
For single-document declaration, specify 1 (default). For document-versions
declaration, specify 2.
- classificationIds - Classification folder IDs separated by commas.
If present, the command will add the specified classification folder IDs to
the template-defined classifications. To use this parameter, a Declare Record
template must be specified in the wizard, and the template must define an
object store; otherwise, an exception will be thrown.
- Response Parameters
- confirmationURL - [decode]
A URL-encoded value to the Workplace confirmation page. It is up to
the calling application to navigate to the confirmation page.
- recordInfoId - Record Info ID if declaration succeeds, or
null
if error occurred during declaration.
- templateId - Record template ID, if the user selects a template
to declare the record.
- templateObjectStoreName - [decode]
Record template object store name, if the user selects a template to declare
the record.
- See Also
- Declare as Record
Declare as Record
Uses a wizard to declare document as a record. If template information
is passed to the wizard, then the wizard is guided by the template;
otherwise, it runs in free mode.
Command ID 1060
- Input Parameters
- objectStoreName - [required,
encode]
The object store where the document resides.
- id - [required]
The document ID. You can pass in multiple document IDs separated by commas.
The document IDs can be from the same or different version series.
The documents must be from the same object store.
- label - [encode]
The name of the document.
- templateId - [required]
The GUID of the entry template or record template.
- templateObjectStoreName - [encode]
The name of the object store where the entry template resides.
- templateType - The type of template, either record or entry.
The default is record template, if no value is specified. To specify
entry template, pass in
_entryTemplate
.
- classificationIds - Classification folder IDs separated by commas.
If present, the command will add the specified classification folder IDs to
the template-defined classifications. To use this parameter, a template must
be specified in the wizard, and the template must define an object store;
otherwise, an exception will be thrown.
- Response Parameters
- confirmationURL - [decode]
A URL-encoded value to the Workplace confirmation page. It is up to
the calling application to navigate to the confirmation page.
- recordInfoId - Record Info ID if declaration succeeds, or
null
if error occurred during declaration.
- templateId - Record template ID, if the user selects a template
to declare the record.
- templateObjectStoreName - [decode]
Record template object store name, if the user selects a template to declare
the record.
- See Also
- Declare Versions as Record
Create a Link
Creates a new link by associating an object to some other object.
The response specifies the newly added link. For more information, see
Work with Link Objects.
Command ID 1070
- Input Parameters
- objectStoreName - [required,
encode]
The object store from which the object will be linked.
- id - [required]
The ID of the object that will be linked from.
- objectType - [required]
One of the following types of objects that will be linked from: "folder",
"document", "customobject".
- label - [required,
encode] The label of the object
linked from. It appears in the "Link From" field.
- classId - The class ID of the root link class.
- Response Parameters
- confirmationURL - [decode]
A URL-encoded value to the Workplace confirmation page. It is up to
the calling application to navigate to the confirmation page.
- objectStoreName - [decode]
The object store where the link object was created.
- id - The object ID for the new link.
- objectType - The "link" object type.
- See Also
- Select Object
- Show Properties
Select File Plan
Select a default file plan. The response specifies the default
file plan ID, label, and object store name.
Command ID 1080
- Input Parameters
- None.
- Response Parameters
- objectStoreName - [decode]
The object store name where the file plan resides.
- id - The object ID for the selected file plan.
- label - [decode]
The name of the selected file plan.
Launch Workflow
Displays the Launch Workflow page.
NOTE There are two versions of the
Launch Workflow command. This version of the command launches a workflow
by displaying the FileNet Workplace Launch Workflow page. The other
version, Launch Workflow Subscription,
launches a workflow based on the subscriptions defined for the object.
Command ID 1090
- Input Parameters
- launchObjectStoreName - [required,
encode]
The name of the object store where the workflow resides.
- launchObjectId - [required]
The object ID for the selected workflow.
- launchObjectType - [required]
The object type of the selected workflow.
- Response Parameters
- The status parameters only.
- See Also
- Launch Workflow Subscription
- Get Processor
Launch Workflow Subscription
Launches a workflow selection page for the specified document,
folder or custom object, based on the
workflow subscriptions defined for an object. See Workflow Subscription Wizard for more information.
NOTE There are two versions of the
Launch Workflow command. While this version of the command launches a
workflow based on subscriptions defined for an object,
Launch Workflow launches the workflow by displaying
the FileNet Workplace Launch Workflow page.
Command ID 1090
- Input Parameters
- launchObjectStoreName - [required,
encode]
The name of the object store where the object resides.
- launchObjectId - [required]
The object ID for the selected object.
- launchObjectVsId - [required]
The version series ID if the selected object is a document.
- NOTE This is not a required parameter
for a folder or custom object.
- launchObjectLabel - [required,
encode]
The label of the selected object.
- launchObjectType - [required]
The object type of the selected object.
- Response Parameters
- The status parameters only.
- See Also
- Launch Workflow
- Get Processor
Get User Token
Displays the Workplace sign-in page and returns the user token based on the user's credentials.
Command ID 1100
- Input Parameters
- showPersist - Set to
true
to show a check box
on the sign-in page, allowing users to indicate whether they want to
persist their credentials in the calling application.
- Response Parameters
- ut - A valid, URL-encoded user token.
- persist - Returns
true
or false
to indicate whether or not the user requested persisting credentials.
Note that it is up to the calling application to persist credentials.
If the showPersist parameter is set to false
, or not
passed in the request, then this response parameter is set to false
.
Get Processor
Invokes the specified launch or step processor.
Command ID 1200
- Input Parameters
- processorType - [required]
Required for both step and launch processors. The processor type,
either "launch" or "step".
- stepProcId - [required]
Required for both step and launch processors. Integer identifying processor to invoke.
You can retrieve this value from the Process Java API.
- returnUrl - [encode]
Optional for both step and launch processors. Return URL after processor is closed.
- queueName - [required,
encode] Required for step processors;
not applicable for launch processors. Queue name, such as "inbox".
You can retrieve this value from the Process Java API.
- wobNum - [required]
Required for step processors; not applicable for launch processors.
The task item work object number. You can retrieve
this value from the Process Java API.
- stepName - Optional for step processors; not applicable for launch processors.
Specifies the step name.
- workflowVersion - [required,
encode] Required for launch processors.
Workflow version, as set in the vwVersion property of the workflow definition
stored in the Content Engine.
- subject - Optional for launch processors; not applicable for step processors.
String specifying the subject when the workflow is launched.
- attachmentId - Optional for launch processors; not applicable for step processors.
Document ID to set as initiating attachment.
- propertyMap - Optional for launch processors; not applicable for step processors.
For a workflow subscription, mappings between the properties of a versionable-related
object and workflow data fields.
- Response Parameters
- The status parameters only.
- See Also
- Launch Workflow
- Launch Workflow Subscription
Open Form
Opens and displays the form (form template) corresponding to the specified
document or workflow form policy. The form can then be filled out and the values saved as a form data instance.
Command ID 1400
- Input Parameters
- objectStoreName - [required,
encode]
The name of the object store where the the form policy is located.
- id - The ID (GUID) of the form policy. If this parameter is not specified, the vsId parameter must be specified.
- vsId - The version series ID of the form policy. When this parameter is
specified, the command will use it to select
the specified version of the form policy. If this parameter is not specified, the id parameter must be specified. When the
id parameter is not specified, the "release" version is used.
- mimeType - [encode]
The mime type of the form policy, which should be specified using one
of the following definitions. When not specified, the command will use
object value property settings to determine the value, which
can increase command execution time. If more than one form template is involved in the workflow form policy, then only the form template on the launch step will be displayed.
"application/x-filenet-documentpolicy"
"application/x-filenet-workflowpolicy"
- op - [required]
The operation to perform, which for this version of Workplace,
must be "display".
- Response Parameters
- objectStoreName - [decode]
The object store where the form data instance was created.
- label - [decode]
The label of the new form data instance.
- id - The ID (GUID) of the new form data instance.
- See Also
- Render Form
- Add Form Data
- Launch Form Data
- Take Form Offline
- Bring Form Online
Render Form
Renders the form corresponding to the specified form template or form data. The command checks the object type and uses
object value property settings to locate the associated form template. The
form is rendered as a static PDF, TIFF, or print image.
Command ID 1410
- Input Parameters
- objectStoreName - [required,
encode]
The name of the object store where the the form object is located.
- id - The ID (GUID) of the form object. If this parameter is not specified, the vsId parameter must be specified.
- vsId - [required]
The version series ID of the form policy or form template. When this parameter is specified, the command will use it to select the specified version of the form policy or form template. If this parameter is not specified, the id parameter must be specified. When the id parameter is not specified, the "release" version is used.
- mimeType - [encode]
The mime type of the form object, which should be specified using one
of the following definitions. When not specified, the command will use
object value property settings to determine the value, which
can increase command execution time. If more than one form template is involved in the workflow form policy, then only the form template on the launch step will be displayed.
"application/x-filenet-documentpolicy"
"application/x-filenet-workflowpolicy"
"application/x-filenet-formdata"
- image - [required]
The type of image to render, which must be specified using one of the supported
formats: "pdf", "tiff", and "print".
The pdf and tiff options render the specified format in the browser window.
The print option sends the form to the specified printerName.
- compression - The type of tiff compression, if any. Valid values are: "CCITT3", "CCITT4", "Deflate", "JpegTTN2", "LZW", "PackBits", "RLE", "None" (default). The values are case-sensitive.
- resolution - Image resolution. Any numeric value. Default is "144".
- printerName - [required,
encode] The name of the
printer. This parameter is only required when the image parameter is set to "print".
- numCopies - [required]
The number of copies to print. This parameter is only required when the image parameter
is set to "print". If not specified, the default behavior is to
print only one copy.
- op - [required]
The operation to perform, which for this version of Workplace,
must be "render".
- Response Parameters
- None.
- See Also
- Open Form
- Add Form Data
- Launch Form Data
- Take Form Offline
- Bring Form Online
Add Form Data
Allows you to specify additional data with which to prefill a form template before
it is rendered. The command can be configured to save the form with for future rendering, or without UI.
The prefill data is in addition to the initial form template data
gathered through normal entry template or workflow mechanisms. The command uses
the entry template that corresponds to the specified form or workflow policy and
prefills the form template with the additional data. When the specified policy is a
workflow policy, the form is prefilled with the data and placed in the "Saved" state, but the workflow is not launched. (The "Saved" state is when the form data is saved to Content Engine as a new (or versioned) form data instance. This is the same as clicking Save on a Launch Form.) The Launch
Form Data command can be used to both prefill the form and launch the workflow.
NOTE The method in which the additional prefill data is specified for the form, as well
as the manner in which the data is applied in relation to the existing initial data,
is described in Prefill Options for the eForms Commands.
Command ID 1420
- Input Parameters
- objectStoreName - [required,
encode]
The name of the object store where the the form policy is located.
- id - The ID (GUID) of the form policy. If this parameter is not specified, the vsId parameter must be specified.
- vsId - [required] The version series ID of the form policy. When this parameter is specified, the command will use it to select the specified version of the form policy. If this parameter is not specified, the id parameter must be specified. When the id parameter is not specified, the "release" version is used.
- mimeType - [encode]
The mime type of the document or workflow form policy, which should be
specified using one of the following definitions. When not specified,
the command will use object value property settings to determine the value,
which can increase command execution time. If more than one form template is involved in the workflow form policy, then only the form template on the launch step will be displayed.
"application/x-filenet-documentpolicy"
"application/x-filenet-workflowpolicy"
- op - [required]
The operation to perform, which must be "add".
- prefill - Specifies additional form data with which to prefill the form
template. The form data must be specified using one of the supported mechanisms:
"post", "parameter" or "get". For more information
about the supported mechanisms,
see Prefill Options for the eForms Commands.
When this parameter is not specified, the form template will be displayed with
initial form data from the entry template or workflow fields.
- displayForm - [required]
Indicates whether the Form Template Page should be shown. Specified as
"true" or "false". Default is "false".
- showConfirm - Indicates whether the Confirmation Page should be shown.
Specified as "true" or "false". Default is "true".
- NOTE The value of showConfirm overrides the Workplace
User Preference showConfirm property setting.
- mergeData - Indicates whether the passed in prefill data
should be merged over any initial form data that may have come from entry template
or workflow fields. Specified as "true" or "false".
When "true", the prefill data is merged in over the top of
any initially specified data (the prefill data has precedence). If "false," no merging takes place - only the prefill data is used to fill the form. For more information
about prefill behavior,
see Prefill Options for the eForms Commands.
- Response Parameters
- objectStoreName - [decode]
The object store where the form data instance was created.
- label - [decode]
The label of the new form data instance.
- id - The ID (GUID) of the new form data instance.
- See Also
- Open Form
- Render Form
- Launch Form Data
- Take Form Offline
- Bring Form Online
Launch Form Data
Allows you to specify additional data with which to prefill a form template before
it is rendered, and then launch the associated workflow. The prefill data is in
addition to the initial form template data gathered through normal entry template
or workflow mechanisms. The command uses the entry template that corresponds to the
specified workflow policy and prefills the form template with the additional data.
The Add Form Data command can be used to prefill the form
without launching the workflow.
NOTE The method in which the additional prefill
data is specified for the form, as well as the manner in which the data is applied
in relation to the existing initial data, is described in
Prefill Options for the eForms Commands.
Command ID 1430
- Input Parameters
- objectStoreName - [required,
encode]
The name of the object store where the the workflow policy is located.
- id - The ID (GUID) of the workflow policy. If this parameter is not specified, the vsId parameter must be specified.
- vsId - [required] The version series ID of the workflow policy. When this parameter is specified, the command will use it to select the specified version of the workflow policy. If this parameter is not specified, the id parameter must be specified. When the id parameter is not specified, the "release" version is used.
- mimeType - [encode]
The mime type of the workflow policy, which should be specified as
"application/x-filenet-workflowpolicy"
. When not specified,
the command will use object value property settings to determine the value,
which can increase command execution time. . If more than one form template is involved in the workflow form policy, then only the form template on the launch step will be displayed.
- op - [required]
The operation to perform, which must be "launch".
- prefill - Specifies additional form data with which to prefill the form
template. The form data must be specified using one of the supported mechanisms:
"post", "parameter" or "get". For more information
about the supported mechanisms,
see Prefill Options for the eForms Commands.
When this parameter is not specified, the form template will be displayed with
initial form data from the entry template or workflow fields.
- displayForm - [required]
Indicates whether the Form Template Page should be shown. Specified as
"true" or "false". Default is "false".
- showConfirm - Indicates whether the Confirmation Page should be shown.
Specified as "true" or "false". Default is "true".
- mergeData - Indicates whether the passed in prefill data
should be merged over any initial form data that may have come from entry template
or workflow fields. Specified as "true" or "false".
When "true", the prefill data is merged in over the top of
any initially specified data (the prefill data has precedence). If "false," no merging takes place - only the prefill data is used to fill the form. For more information
about prefill behavior,
see Prefill Options for the eForms Commands.
- Response Parameters
- objectStoreName - [decode]
The object store where the form data instance was created.
- label - [decode]
The label of the new form data instance.
- id - The ID (GUID) of the new form data instance.
- See Also
- Open Form
- Render Form
- Add Form Data
- Take Form Offline
- Bring Form Online
Take Form Offline
Takes a form offline by gathering the form template, form policy, and any
initial form data specified in the entry template or workflow data fields (when the workflow policy has a form specified in the launch step) into
a packaged XML file, which is then downloaded to the local file system.
Command ID 1440
- Input Parameters
- objectStoreName - [required,
encode]
The name of the object store where the the form policy is located.
- id - The ID (GUID) of the form policy. If this parameter is not specified, the vsId parameter must be specified.
- vsId - [required] The version series ID of the form policy. When this parameter is specified, the command will use it to select the specified version of the form policy. If this parameter is not specified, the id parameter must be specified. When the id parameter is not specified, the "release" version is used.
- mimeType - [encode]
The mime type of the form policy, which should be
specified using one of the following definitions. When not specified,
the command will use object value property settings to determine the value,
which can increase command execution time. If more than one form template is involved in the workflow form policy, then only the form template on the launch step will be displayed.
"application/x-filenet-documentpolicy"
"application/x-filenet-workflowpolicy"
- op - [required]
The operation to perform, which must be "offline".
- Response Parameters
- None.
- See Also
- Open Form
- Render Form
- Add Form Data
- Launch Form Data
- Bring Form Online
Bring Form Online
Displays a standard Bring Form Online operation-style page for selecting a
local form data file to be brought back online. The Bring Online operation
can display the form template to accomodate additional input, such as
signatures or for adding attachments.
Command ID 1460
- Input Parameters
- op - [required]
The operation to perform, which must be "online".
- Response Parameters
- objectStoreName - [decode]
The object store where the form data instance was created.
- label - [decode]
The label of the new form data instance.
- id - The ID (GUID) of the new form data instance.
- See Also
- Open Form
- Render Form
- Add Form Data
- Launch Form Data
- Take Form Offline
Select Object
Displays a list of objects from which the user may select on the
Workplace Browse or Search page. The response specifies the metadata
of the selected object.
NOTE In Workplace versions
earlier than 3.5.1, this command invoked the Workplace UI with links
to Browse, Search, and My Search pages. In the current Workplace version,
the Search link invokes the simple Search page, which closely corresponds
with the My Search page of earlier Workplace versions. The simple
Search page also contains a link to the Search Template view, which
closely implements functionality provided by the Search page of earlier
Workplace versions.
Available User Actions
The combined values of the allowCheckout and selectMode
parameters determine the actions available to a user for a selected
document or folder. The table below identifies the available actions
based on the specified values of these two parameters.
allowCheckout |
selectMode |
Available Actions |
false |
documentsOnly |
Select a document. |
true |
documentsOnly |
Select or check out a document. |
false |
foldersAndDocuments |
Select a document, or select a folder. |
true |
foldersAndDocuments |
Select or check out a document, or select a folder. |
true or false |
foldersOnly |
Select a folder. |
Command ID 2010
- Input Parameters
- showSelectReleased - Turns on or off "Select Released Version"
link. Valid values are
true
(default) and false
.
- showSelectCurrent - Turns on or off "Select Current Version"
link. Valid values are
true
(default) and false
.
- showSelectFromVersions - Turns on or off "Select from Versions"
link. Valid values are
true
(default) and false
.
- showReleasedOnly - For document objects only, turns on or off
"Show Released" link. This parameter supersedes all of the
other show-link parameters. It affects both Browse and My Search pages.
Valid values are
true
and false
(default).
- path - [encode]
Sets the page title. Default is "Select Object".
- class - Limits the selection on the Search page to objects of
the specified class. Limits the selection on the Browse page for both
"documentsOnly" and "foldersOnly" modes. This should
be a symbolic name. Default value is
null
.
- selectEventName - The name of the event to be fired when the user
selects an object. This would be the "eventName" parameter in the
select URL. Default value is
null
.
- selectEventTarget - The target module that handles the event. This
would be the "eventTarget" parameter in the select URL. Default
value is
null
.
- objectStoreName - [encode]
Specifies the object store where the selection will be made. Default value
is
null
.
- folderId - Specifies the ID (GUID) of the folder where the selection will be made. If you include this parameter, then you must also include the
objectStoreName parameter.
- showRoot - If
true
, the command honors the objectStoreName and folderId settings. Otherwise, a list of all object stores is displayed, from which the user must navigate to the specific folder or document to select. Default value is true
.
- hideButtons - Hides the actions in the Information pages. Default
value is
true
.
- hiddenTab - Multi-value parameter that specifies which page links
to hide. Valid values are "search", "mySearch", and
"browse". You specify one "hiddenTab=<value>"
parameter for each tab you want to hide. Default value is
null
.
- NOTE
To hide the Search link, you specify this parameter two times:
&hiddenTab=search&hiddenTab=mySearch
.
- selectMode - Specifies the objects that can be selected. Valid values
are "allObjects", "foldersOnly", "documentsOnly",
"foldersAndDocuments", "customObjectsOnly" and
"searchTemplatesOnly". Default value is "allObjects".
- NOTE The combined values of the
allowCheckout and selectMode parameters determine
the actions available to a user for a selected document or folder.
See Available User Actions.
- mimeTypes - Multi-value parameter that filters the selection by mime
type. The filtering is determined by the object types specified in the
selectMode parameter.
- NOTES
- • If the containerTypes parameter is not specified, the mimeTypes
parameter is used to filter the Search page and the Browse page as follows.
For the Search page, mimeTypes filters on "foldersAndDocuments".
For the Browse page, mimeTypes filters on "documentsOnly".
- • If the containerTypes parameter is specified, the mimeTypes
parameter is used to filter the Search page and the Browse page as follows.
For the Search page, mimeTypes filters on "documentsOnly"
only. For the Browse page, mimeTypes filters on "documentsOnly",
"foldersAndDocuments", and "allObjects".
- • You specify one "mimeTypes=<value>" parameter for each
mime type, for example, "&mimeTypes=application/msword&
mimeTypes=application/vnd.ms-excel&mimeTypes=application/vnd.ms-powerpoint".
Default value is
null
(all MIME types).
- containerTypes - A multi-value parameter that filters the selection
by container type. A container type identifies a folder by the type of content
stored in it and is user defined. For a list of container types used in Workplace,
see the containericons.properties file in the <AE_deploy_path>/FileNet/Config/AE
directory. For more on container types, see
Properties of Folder Class and Subclasses.
- NOTES
- • Container type filtering is determined by the object types specified in
the selectMode parameter. For the Search page, containerTypes
filters on "foldersOnly". For the Browse page, containerTypes
filters on "foldersOnly", "foldersAndDocuments", and
"allObjects".
- • You specify one "containerTypes=<value>" parameter for
each container type, for example, "&containerTypes=application/
x-filenet-rm-classificationschemeroot&containerTypes=application/
x-filenet-rm-physicalcontainer&containerTypes=application/
x-filenet-rm-volumeelectronic".
- • Default value is
null
, which means all container types are
displayed, except for in the Search page when a containerTypes
parameter is used with a mimeTypes parameter.
- hideMySearchFilterClass - Hides the Search "Filter by Class"
option. Valid values are
true
and false
(default).
- includeSubClass - Includes "Include subclasses"
option in the Search page. Valid values are
true
(default)
and false
.
- allowCheckout - A boolean value to indicate whether the object
can be checked out. If the value is
true
, the "Checkout"
link replaces the "Select" link. Default value is false
.
- NOTE The combined values of the
allowCheckout and selectMode parameters determine
the actions available to a user for a selected document or folder.
See Available User Actions.
- forceHideCustomObjects - Hides custom objects in Search
and Browse pages. Valid values are
true
and false
(default).
- Response Parameters
- objectStoreName - [decode]
The object store name where the selected object resides.
- label - [decode]
The label of the selected object.
- id - The ID of the selected object.
- vsId - The version series ID for the selected object.
- contentId - The ID of the content element for the selected object.
- objectType - The type of selected object.
- minorVersion - The minor version number for documents.
- majorVersion - The major version number for documents.
- versionStatus - The version state of the selected document,
expressed as an integer, and defined using the following constants.
For more information, see
Versioning Properties.
- 1 = Released
- 2 = In Process
- 3 = Reservation
- 4 = Superseded
- mimeType - The MIME type of the selected document.
Applies to documents only.
- commandAction - The select command action. Valid values are
"select" and "checkout". The value is "checkout"
only when the allowCheckout parameter is set to
true
.
- fileName - The original file name of the selected document.
Applies to documents only.
- reservationId - Reservation ID. This is valid only when
the allowCheckout parameter is set to
true
.
- See Also
- Select Multiple Objects
- Select Object from Tree View Control
- Browse List
- Search Results List
Select Entry Template
Displays a lists of entry templates for selection. The response contains the data
describing the entry template selected by the user.
Command ID 2020
- Input Parameters
- objectStoreName - [encode]
The object store from which the entry template will be selected.
- entryTemplateType - The type of entry template to display for selection.
Valid values are:
- -
document
- -
folder
- -
customobject
- -
page
- -
section
- -
localsection
- -
converttoweb
- targetDocClass - Target document class ID (GUID) of templates
to be listed. If specified, the command only shows entry templates that create
items of this class and templates that create descendants of this doc class.
- restrictDocClass - Specifies whether to restrict the selection
of document class to the class specified in
targetDocClass
.
Set to true
to only show entry templates of the document class
specified in targetDocClass
, and to not show templates that
create descendants of the specified document class. This parameter is ignored
if targetDocClass
is excluded.
- Response Parameters
- objectStoreName - [decode]
The object store name from which the entry template was selected.
- label - [decode]
The label of the selected entry template.
- id - The document version ID of the selected entry template.
- vsId - The document version series ID of the selected entry template.
Checkout List
Displays the user's currently checked-out objects for selection.
For this release of Workplace, only documents are listed.
If the user selects a document, the response specifies the selected
checked-out document. Otherwise, the response specifies that the
command was canceled.
Command ID 2030
- Input Parameters
- objectStoreName - [encode]
Limits the list to the specified object store.
- mimeTypes - Filters the list view to show only the specified
MIME types. Specify one "mimeTypes=<value>" for each
mimetype to include. To specify all MIME types, use this wildcard:
*/*
.
- Response Parameters
- objectStoreName - [decode]
The object store from which the object was selected.
- label - [decode]
The label of the selected object.
- id - The ID of the current version of the selected object.
- vsId - The version series ID of the selected object.
- objectType - The type of selected object.
- See Also
- Check In Document
- Cancel Checkout from List
- Check In from List
Cancel Checkout from List
Cancels checkout from the user's checkout list. If the object is not checked out when this command is invoked, null
is returned.
Command ID 2035
- Input Parameters
- None.
- Response Parameters
- The status parameters only.
- See Also
- Check In Document
- Checkout List
- Check In from List
Check In from List
Checks in a document from the user's checkout list.
Command ID 2037
- Input Parameters
- None.
- Response Parameters
- confirmationURL - [decode]
A URL-encoded value to the Workplace confirmation page. It is up to
the calling application to navigate to the confirmation page.
Note that under the following conditions, a confirmationURL
parameter will not be returned:
- - The Workplace site preference "Confirmation page visibility"
is set to
hide
- and
- - There are no post-command operations, such as Declare Records or
Launch Workflow, that can be performed on the object affected by the
command. The availability of these operations supersedes the preference
setting above.
- See Also
- Check In Document
- Checkout List
- Cancel Checkout from List
Browse List
Displays the contents of a folder or stored search.
Command ID 2040
- Input Parameters
- objectStoreName - [required,
encode]
The object store name that you want to browse.
- id - [required]
The ID of the folder or stored search that you want to browse.
- objectType - [required]
One of the following types of objects that you want to browse:
"folder" or "storedsearch".
- Response Parameters
- No command-specific parameters. If the command is canceled, the
status parameters returned.
- See Also
- Tasks List
- Search Results List
Tasks List
Displays a queue content list.
Command ID 2050
- Input Parameters
- queueName - [required,
encode] The queue name.
- queueType - [required]
One of the following queue types: "Process", "User",
"ActiveWorkflows".
- Response Parameters
- No command-specific parameters. If the command is canceled, the
status parameters returned.
- See Also
- Browse List
- Search Results List
- Queue Info Page
Search Results List
Displays the result set of a content-based retrieval (CBR) search. CBR enables
users to search an object store for documents and annotations that contain
specific words or phrases. For more information,
see
Content-based retrieval (CBR).
Command ID 2060
- Input Parameters
- objectStore - [encode]
The object store to search.
- searchCriteria - The content for which to search.
- maxResults - Maximum results to display in the list.
- viewStyle - Either "searchViewDetailed" or "searchViewMagazine".
- searchVersion - Either "searchVersionCurrent" or "searchVersionReleased".
- Response Parameters
- No command-specific parameters. If the command is canceled, the
status parameters returned.
- See Also
- Browse List
- Tasks List
Select Multiple Objects
Allows users to select one or more objects from the Workplace Browse
or Search page. Selected objects are listed on the Multi Select page.
You can pass an XML objectset to provide users with an initial set of
selected objects listed on the Multi Select page. The user-selected
objects are returned in an XML objectset.
NOTE In Workplace versions
earlier than 3.5.1, this command invoked the Workplace UI with links
to Browse, Search, and My Search pages. In the current Workplace version,
the Search link invokes the simple Search page, which closely corresponds
with the My Search page of earlier Workplace versions. The simple
Search page also contains a link to the Search Template view, which
closely implements functionality provided by the Search page of earlier
Workplace versions.
Command ID 2100
- Input Parameters
- showSelectReleased - Turns on or off "Select Released" link.
Valid values are
true
and false
.
Default is true
.
- showSelectCurrent - Turns on or off "Select Current" Link.
Valid values are
true
and false
.
Default is true
.
- showSelectFromVersions - Turns on or off "Select from Versions"
link. Valid values are
true
and false
.
Default is true
.
- showReleasedOnly - Allows the selection of only the release
version of a document type. This parameter overrides all of the other
show parameters. It affects both Browse and MySearch pages.
Default is
false
.
- path - [encode]
Sets the page title. Default is "Multi Select".
- class - Limits the selection on the Search page to only objects
of the specified class. Limits the selection on the Browse page for both
documentOnly
and folderOnly
select modes. Use the
symbolic name of the class. Default value is null
.
- objectStoreName - [required,
encode] Specifies the object
store where the selection will be made. Default value is
null
.
- folderId - Specifies the ID (GUID) of the folder where the selection will be made. If you include this parameter, then you must also include the
objectStoreName parameter.
- hideButtons - Hides the actions in the Information pages. Default
value is
true
.
- hiddenTab - Multi-value parameter that specifies which page links
to hide. Valid values are "search", "mySearch", and
"browse". You specify one "hiddenTab=<value>"
parameter for each tab you want to hide. Default value is
null
.
- NOTE
To hide the Search link, you specify this parameter two times:
&hiddenTab=search&hiddenTab=mySearch
.
- selectMode - Specifies the objects that can be selected. Valid values
are "allObjects", "foldersOnly", "documentsOnly",
"foldersAndDocuments", "customObjectsOnly" and
"searchTemplatesOnly". Default value is "allObjects".
- NOTE The combined values of the
allowCheckout and selectMode parameters determine
the actions available to a user for a selected document or folder.
See Available User Actions.
- mimeTypes - Multi-value parameter that filters the selection by mime
type. The filtering is determined by the object types specified in the
selectMode parameter.
- NOTES
- • If the containerTypes parameter is not specified, the mimeTypes
parameter is used to filter the Search page and the Browse page as follows.
For the Search page, mimeTypes filters on "foldersAndDocuments".
For the Browse page, mimeTypes filters on "documentsOnly".
- • If the containerTypes parameter is specified, the mimeTypes
parameter is used to filter the Search page and the Browse page as follows.
For the Search page, mimeTypes filters on "documentsOnly"
only. For the Browse page, mimeTypes filters on "documentsOnly",
"foldersAndDocuments", and "allObjects".
- • You specify one "mimeTypes=<value>" parameter for each
mime type, for example, "&mimeTypes=application/msword&
mimeTypes=application/vnd.ms-excel&mimeTypes=application/vnd.ms-powerpoint".
Default value is
null
(all MIME types).
- containerTypes - A multi-value parameter that filters the selection
by container type. A container type identifies a folder by the type of content
stored in it and is user defined. For a list of container types used in Workplace,
see the containericons.properties file in the <AE_deploy_path>/FileNet/Config/AE
directory. For more on container types, see
Properties of Folder Class and Subclasses.
- NOTES
- • Container type filtering is determined by the object types specified in
the selectMode parameter. For the Search page, containerTypes
filters on "foldersOnly". For the Browse page, containerTypes
filters on "foldersOnly", "foldersAndDocuments", and
"allObjects".
- • You specify one "containerTypes=<value>" parameter for
each container type, for example, "&containerTypes=application/
x-filenet-rm-classificationschemeroot&containerTypes=application/
x-filenet-rm-physicalcontainer&containerTypes=application/
x-filenet-rm-volumeelectronic".
- • Default value is
null
, which means all container types are
displayed, except for in the Search page when a containerTypes
parameter is used with a mimeTypes parameter.
- hideMySearchFilterClass - Hides Search "Filter by Class" option.
Valid values are
true
and false
(default).
- includeSubClass - Includes "Include subclasses" option in the
Search page. Valid values are
true
(default) and false
.
- forceHideCustomObjects - Hides custom objects in Search and Browse pages.
Valid values are
true
and false
(default).
- selectedObjects - [encode]
XML objectset containing a listing of selected objects (folders, documents, custom
objects), as shown in the
selectedObjects
example below. Alternatively, you can pass null
to have no
objects initially appear in the Multi Select page.
- AlternateNameProperty - The name of a property that will be used as an
alternate for the object title if the object store's assigned property does not exist.
- Response Parameters
- objectStoreName - [decode]
The object store name.
- selectedObjects - [decode]
XML objectset containing a listing of selected objects (folders, documents, custom
objects), as shown in the
selectedObjects
example
below.
- Example
- The following XML provides an abbreviated example of the
selectedObjects
parameter that you would send in the Select Multiple Objects command. Only one document
object is passed.
<response xmlns="http://filenet.com/namespaces/wcm/apps/1.0">
<objectset>
<count>0</count>
<document>
<id>{713CB528-F401-46E4-8B2A-9766C37C6CBA}</id>
<objectstore>
<id>{597EC696-714F-481E-89D1-F6D6C34F3759}</id>
<name>LaurentOS</name>
</objectstore>
<classdesc>
<id>{01A3A8C2-7AEC-11D1-A31B-0020AF9FBB1C}</id>
<name>Document</name>
</classdesc>
<iscurver>1</iscurver>
<ispublication>0</ispublication>
<isreserved>0</isreserved>
<mimetype>image/pjpeg</mimetype>
<verstatus>1</verstatus>
<majorvernum>1</majorvernum>
<minorvernum>0</minorvernum>
<verserid>{1287C565-84AB-4ACA-AC09-B9698CFBFB94}</verserid>
<properties>
<property>
<name>ObjectType</name>
<symname>ObjectType</symname>
<value>1</value>
<datatype>6</datatype>
</property>
<property>
<name>Id</name>
<symname>Id</symname>
<value>{713CB528-F401-46E4-8B2A-9766C37C6CBA}</value>
<datatype>5</datatype>
</property>
<property>
<name>LastModifier</name>
<symname>LastModifier</symname>
<value>administrator</value>
<datatype>8</datatype>
</property>
<property>
<name>DocumentTitle</name>
<symname>DocumentTitle</symname>
<value>image1</value>
<datatype>8</datatype>
</property>
<property>
<name>DateLastModified</name>
<symname>DateLastModified</symname>
<value>2004-10-05T18:54:21Z</value>
<datatype>3</datatype>
</property>
<property>
<name>Id</name>
<symname>Id</symname>
<value>{713CB528-F401-46E4-8B2A-9766C37C6CBA}</value>
<datatype>5</datatype>
</property>
<property>
<name>Creator</name>
<symname>Creator</symname>
<value>administrator</value>
<datatype>8</datatype>
</property>
<property>
<name>OIID</name>
<symname>OIID</symname>
<value>dma:///9bb79d30-7208-11d1-8a25-008048e14c74/597ec696-714f-481e-89d1-f6d6c34f3759/S01a3a8c2;guid=713cb528-f401-46e4-8b2a-9766c37c6cba</value>
<datatype>8</datatype>
</property>
</properties>
</document>
</objectset>>
</response>
- See Also
- Select Object
- Select Object from Tree View Control
- Browse List
- Search Results List
Select Public Inbox
Displays the selection page of eProcess public inboxes.
Command ID 2110
- Input Parameters
- None.
- Response Parameters
- queueName - The name of the selected queue.
- queueType - The type of the selected queue.
- See Also
- Get Processor
- Queue Info Page
- Milestone Info Page
- Launch Workflow
- Launch Workflow Subscription
Select Object from Tree View Control
Displays a tree view control from which users may select objects.
NOTE You can configure the maximum
number of items returned to and displayed by the tree view control in
PagingConfiguration.xml.
Command ID 2120
- Input Parameters
- objectStoreName - [encode]
Specifies an object store from which to display objects. You can specify
one "objectStoreName=<value>" parameter for each object
store, for example,
"&objectStoreName=OS1&
objectStoreName=OS2&objectStoreName=OS3"
. If you exclude
this parameter, all object stores are shown.
- folderId - The ID (GUID) of a folder that you set as the root
folder. If you include this parameter, then you must also include the
objectStoreName parameter.
- flatView - Shows the control in a flat mode, where all matched
documents and custom objects display at the same level under the object
store node. Valid values are
true
and false
(default).
- canSelectFolders - Enables selection of folders.
Valid values are
true
(default) and false
.
- canSelectObjectStores - Enables selection of object stores.
Valid values are
true
and false
(default).
- canSelectDocuments - Enables selection of documents.
Valid values are
true
(default) and false
.
- canSelectCustomObjects - Enables selection of custom objects.
Valid values are
true
(default) and false
.
- mimeTypes - Specifies the document MIME types to show. You can
specify one "mimeTypes=<value>" parameter for each mime type,
for example,
"&mimeTypes=application/msword&mimeTypes=
application/vnd.ms-excel&mimeTypes=application/vnd.ms-powerpoint"
.
To specify all MIME types, use this wildcard shortcut: */*
.
If the parameter is not specified, no documents will be shown.
- containerTypes - Specifies the folder container types to show.
(This parameter takes the value of the ContainerType property on the Folder class.)
The containers that will be shown start at the root of the object store.
Subfolders will also be shown, if they are of the same folder
container type as the parent.
- NOTES
- • You can specify one "containerTypes=<value>"
parameter for each container type. To specify all container types,
use this wildcard shortcut:
*/*
.
- • If a subfolder is a different container type than its parent,
then you can get it to show by including a "containerTypes=<value>"
parameter for both the parent and the subfolder.
- customObjectTypes - Specifies the custom object types to show.
(This parameter takes the value of the CustomObjectType property on the
CustomObject class.)
- NOTES
- • You can specify one "customObjectTypes=<value>"
parameter for each custom object type. To specify all custom object types,
use this wildcard shortcut:
*/*
. If neither this parameter
nor the customObjectClass parameter is included, no custom
objects will be shown.
- • For setting up custom object types, see
Mapping Images to Custom Object Types.
- documentClass - Sets the document class to show. Subclasses
will also be shown. Specify either the symbolic name or GUID of the class.
- folderClass - Sets the folder class to show. The folders
that will be shown start at the root of the object store. Subfolders
will also be shown, if they belong to the same class as the
parent. Specify either the symbolic name or GUID of the class.
- customObjectClass - Sets the custom object class to show.
Subclasses will also be shown. Specify either the symbolic name or
GUID of the class. If neither this parameter nor the customObjectType
parameter is included, no custom objects will be shown.
- Response Parameters
- objectStoreName - [decode]
The name of the object store from which the object was selected.
- label - [decode]
The label of the selected object.
- vsId - The version series ID if the selected object was a document.
- majorVersion - The major version number if the selected object was a document.
- minorVersion - The minor version number if the selected object was a document.
- versionStatus - Version status if the selected object was a document.
- mimeType - The mime type if the selected object was a document.
- containerType - The folder container type if the selected object was a folder
that includes the ContainerType property.
- customObjectType - The custom object type if the selected item
was a custom object that includes the CustomObjectType property.
- id - The ID of the selected object.
- objectType - The type of the selected object.
- See Also
- Select Object
- Select Multiple Objects
- Browse List
- Search Results List
Show Properties
Displays the properties for a specified object.
Command ID 3010
- Input Parameters
- objectStoreName - [encode]
The object store where the object resides.
- id - The ID (GUID) of the object.
- vsId - The version series ID (GUID) of the object.
If you specify this parameter without the id parameter,
then the properties of the highest major version are displayed.
If there are only minor versions, then the properties of the
highest minor version are displayed.
- objectType - The type of object: "document",
"customObject", "folder", "storedsearch",
or "searchtemplate".
- Response Parameters
- No command-specific parameters. If the command is canceled, the
status parameters returned.
- See Also
- Select Object
Queue Info Page
Displays the Information page for a specified eProcess queue item. Parameters are
included for specifying the location of a step processor, which you can then launch
from the Information page. You can get the parameter values with the getter methods
in WcmEProcessDataProvider.
Command ID 3030
- Input Parameters
- queueName - [required,
encode] The task item queue name.
- queueType - [required]
The task item queue type: "User", "Process", ActiveWorkflows".
- wobNum - [required]
The task item work object number.
- appType - [required]
The workflow processor type: "java" or "html".
- stepName - [required,
encode] The task item step name.
- stepProcId - [required]
The integer value that represents the unique ID for the step processor.
- Response Parameters
- The status parameters only.
- See Also
- Select Public Inbox
- Milestone Info page
- Get Processor
- Launch Workflow
- Launch Workflow Subscription
Milestone Info Page
Displays the Information page for the eProcess Milestone items.
Command ID 3040
- Input Parameters
- queueName - [required,
encode] The task item queue name.
- wobNum - [required]
The task item work object number.
- Response Parameters
- The status parameters only.
- See Also
- Select Public Inbox
- Queue Info Page