com.filenet.operations
Class Bp8Operations

java.lang.Object
  extended bycom.filenet.operations.Bp8Operations

public class Bp8Operations
extends java.lang.Object

Title: BPF Operations Java Adapter for P8 Component Integrator.

Description: BPF Operations is a P8 Component Integrator component that allows manupulating BPF Case object from a workflow component step.

Copyright: FileNet (c) 2004-2005

Company: FileNet Corp.


Field Summary
static java.lang.String BP8_CE_FIELD_DOCSATTACHED
           
static java.lang.Integer BP8_OBJECT_TYPE_CE_CUSTOM_OBJECT
           
static java.lang.Integer BP8_OBJECT_TYPE_CE_DOCUMENT
           
static java.lang.Integer BP8_OBJECT_TYPE_CE_FOLDER
           
static int CATEGORY_SYSTEM
           
static java.lang.String CE_CLASSNAME_BP8ATTACHMENT
           
static java.lang.String CE_CLASSNAME_BP8AUDITLOGITEM
           
static java.lang.String CE_FIELD_ACTION
           
static java.lang.String CE_FIELD_ATTACHMENT_CASE
           
static java.lang.String CE_FIELD_AUDITLOGITEM_CASE
           
static java.lang.String CE_FIELD_BP8_OBJECT_VS_ID
           
static java.lang.String CE_FIELD_CASEID
           
static java.lang.String CE_FIELD_CASETYPE
           
static java.lang.String CE_FIELD_DESCRIPTION
           
static java.lang.String CE_FIELD_EVENTCATEGORY
           
static java.lang.String CE_FIELD_ID
           
static java.lang.String CE_FIELD_OBJECT_VS_ID
           
static java.lang.String CE_FIELD_OBJECTCLASS
           
static java.lang.String CE_FIELD_OBJECTGUID
           
static java.lang.String CE_FIELD_OBJECTID
           
static java.lang.String CE_FIELD_OBJECTREPOSITORYID
           
static java.lang.String CE_FIELD_OBJECTTYPE
           
static java.lang.String CE_FIELD_REASON
           
static java.lang.String CE_FIELD_USER_NAME
           
static java.lang.String CE_FIELD_USER_SID
           
static java.lang.String DEFAULT_CASE_ACTION
           
static java.lang.String DEFAULT_CASE_ACTION_DESCRIPTION
           
static java.lang.String DEFAULT_CASE_ACTION_REASON
           
static java.lang.String DEFAULT_OBJECT_ACTION
           
static java.lang.String DEFAULT_OBJECT_ACTION_DESCRIPTION
           
static java.lang.String DEFAULT_OBJECT_ACTION_REASON
           
static java.lang.String DESCRIPTION
           
static java.lang.String FIELD_LAST_CASEID
           
static java.lang.String FIELDTYPE_BOOLEAN
           
static java.lang.String FIELDTYPE_DATE
           
static java.lang.String FIELDTYPE_DATETIME
           
static java.lang.String FIELDTYPE_MONEY
           
static java.lang.String FIELDTYPE_NUMERIC
           
static java.lang.String FIELDTYPE_STRING
           
static java.lang.String FIELDTYPE_WFGROUP
           
static java.lang.String GUID_CUSTOMOBJECT_SETTINGS
           
static java.lang.String KEY_MAPPING_ATTACHMENT_FIELD
           
static java.lang.String KEY_MAPPING_CASE_FIELD
           
static java.lang.String KEY_MAPPING_DATA_TYPE
           
static java.lang.String KEY_MAPPING_WORKFLOW_FIELD
           
static java.lang.String PARTICIPANT_SEPARATOR
           
static int RESULT_ALREADY_ATTACHED
           
static int RESULT_ATTACH_ERROR
           
static int RESULT_ATTACHMENT_ALREADY_CREATED
           
static int RESULT_ATTACHMENT_CREATED
           
static java.lang.String SETTING_INDEX_CASE_ID
           
static java.lang.String SETTING_LOCK_TIMEOUT
           
static java.lang.String SETTING_LOCK_WAIT_TIMEOUT
           
static java.lang.String SETTING_ROSTER
           
static java.lang.String SETTING_SEQUENCE_SIZE
           
static java.lang.String SQL_FIELDS_MAPPING
           
static java.lang.String SQL_SEARCH_CASES
           
static java.lang.String SQL_SEARCH_DOCUMENTS_ATTACHED
           
static java.lang.String WF_FIELD_BP8ATTACHMENT
           
static java.lang.String XML_ELEMENT_ZROW
           
 
Constructor Summary
Bp8Operations()
           
 
Method Summary
 java.lang.String[] attachDoc(java.lang.String objectStoreName, filenet.vw.api.VWAttachment[] attachments, java.lang.String auditAction, java.lang.String userName, java.lang.String sql)
          attachDoc
 java.lang.String[] attachDocWithRoster(java.lang.String objectStoreName, filenet.vw.api.VWAttachment[] attachments, java.lang.String auditAction, java.lang.String userName, java.lang.String sql, java.lang.String sRosterName)
          attachDocWithRoster
 int attachFolder(java.lang.String objectStoreName, filenet.vw.api.VWAttachment caseAttachment, filenet.vw.api.VWAttachment attachment)
          attachFolder Attach folder to the Bp8 Case Object
 java.lang.String[] createCase(java.lang.String objectStoreName, java.lang.String caseClassName, filenet.vw.api.VWAttachment[] attachments, java.lang.String actionName, java.lang.String actionUserName, java.lang.String[] caseFields)
          createCase This method is used to create instance of the Bp8 Case object
 filenet.vw.api.VWAttachment createObject(java.lang.String objectStoreName, java.lang.String objectClassName, java.lang.String[] objectFields)
          createObject This method is used to create an instance of custom object in Content Engine
 int detachFolder(java.lang.String objectStoreName, filenet.vw.api.VWAttachment caseAttachment, filenet.vw.api.VWAttachment attachment)
          detachFolder Detach folder from Bp8 Case Object
 int detachFolderWithRoster(java.lang.String objectStoreName, filenet.vw.api.VWAttachment caseAttachment, filenet.vw.api.VWAttachment attachment, java.lang.String sRosterName)
          detachFolderWithRoster Detach folder from Bp8 Case Object
 int getNextCaseId(java.lang.String objectStoreName)
          getNextCaseId
 void logEvent(filenet.vw.api.VWAttachment attachment, java.lang.String actionName, java.lang.String actionReason, java.lang.String actionDescription, java.lang.String actionUserName, int eventCategory)
          logEvent Add record to the Case Audit Trail
 int updateCase(java.lang.String objectStoreName, java.lang.String[] caseIDs, java.lang.String[] caseFields)
          updateCase This method is used to update CE Case object and mapped Process and Attachment fields WARNING: This method is designed solely for updating Cases *other* than the *current* Case - i.e.
 int updateCaseWithRoster(java.lang.String objectStoreName, java.lang.String[] caseIDs, java.lang.String[] caseFields, java.lang.String sRosterName)
          updateCaseWithRosterThis method is used to update CE Case object and mapped Process and Attachment fields WARNING: This method is designed solely for updating Cases *other* than the *current* Case - i.e.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CE_FIELD_ID

public static final java.lang.String CE_FIELD_ID
See Also:
Constant Field Values

CE_FIELD_CASEID

public static final java.lang.String CE_FIELD_CASEID
See Also:
Constant Field Values

CE_FIELD_OBJECTID

public static final java.lang.String CE_FIELD_OBJECTID
See Also:
Constant Field Values

CE_FIELD_OBJECTGUID

public static final java.lang.String CE_FIELD_OBJECTGUID
See Also:
Constant Field Values

CE_FIELD_OBJECTTYPE

public static final java.lang.String CE_FIELD_OBJECTTYPE
See Also:
Constant Field Values

CE_FIELD_OBJECTCLASS

public static final java.lang.String CE_FIELD_OBJECTCLASS
See Also:
Constant Field Values

CE_FIELD_OBJECTREPOSITORYID

public static final java.lang.String CE_FIELD_OBJECTREPOSITORYID
See Also:
Constant Field Values

CE_FIELD_ATTACHMENT_CASE

public static final java.lang.String CE_FIELD_ATTACHMENT_CASE
See Also:
Constant Field Values

CE_FIELD_ACTION

public static final java.lang.String CE_FIELD_ACTION
See Also:
Constant Field Values

CE_FIELD_AUDITLOGITEM_CASE

public static final java.lang.String CE_FIELD_AUDITLOGITEM_CASE
See Also:
Constant Field Values

CE_FIELD_DESCRIPTION

public static final java.lang.String CE_FIELD_DESCRIPTION
See Also:
Constant Field Values

CE_FIELD_EVENTCATEGORY

public static final java.lang.String CE_FIELD_EVENTCATEGORY
See Also:
Constant Field Values

CE_FIELD_REASON

public static final java.lang.String CE_FIELD_REASON
See Also:
Constant Field Values

CE_FIELD_USER_NAME

public static final java.lang.String CE_FIELD_USER_NAME
See Also:
Constant Field Values

CE_FIELD_USER_SID

public static final java.lang.String CE_FIELD_USER_SID
See Also:
Constant Field Values

CE_FIELD_CASETYPE

public static final java.lang.String CE_FIELD_CASETYPE
See Also:
Constant Field Values

CE_FIELD_OBJECT_VS_ID

public static final java.lang.String CE_FIELD_OBJECT_VS_ID
See Also:
Constant Field Values

CE_FIELD_BP8_OBJECT_VS_ID

public static final java.lang.String CE_FIELD_BP8_OBJECT_VS_ID
See Also:
Constant Field Values

KEY_MAPPING_CASE_FIELD

public static final java.lang.String KEY_MAPPING_CASE_FIELD
See Also:
Constant Field Values

KEY_MAPPING_ATTACHMENT_FIELD

public static final java.lang.String KEY_MAPPING_ATTACHMENT_FIELD
See Also:
Constant Field Values

KEY_MAPPING_WORKFLOW_FIELD

public static final java.lang.String KEY_MAPPING_WORKFLOW_FIELD
See Also:
Constant Field Values

KEY_MAPPING_DATA_TYPE

public static final java.lang.String KEY_MAPPING_DATA_TYPE
See Also:
Constant Field Values

WF_FIELD_BP8ATTACHMENT

public static final java.lang.String WF_FIELD_BP8ATTACHMENT
See Also:
Constant Field Values

CE_CLASSNAME_BP8ATTACHMENT

public static final java.lang.String CE_CLASSNAME_BP8ATTACHMENT
See Also:
Constant Field Values

CE_CLASSNAME_BP8AUDITLOGITEM

public static final java.lang.String CE_CLASSNAME_BP8AUDITLOGITEM
See Also:
Constant Field Values

DEFAULT_OBJECT_ACTION

public static final java.lang.String DEFAULT_OBJECT_ACTION
See Also:
Constant Field Values

DEFAULT_OBJECT_ACTION_REASON

public static final java.lang.String DEFAULT_OBJECT_ACTION_REASON
See Also:
Constant Field Values

DEFAULT_OBJECT_ACTION_DESCRIPTION

public static final java.lang.String DEFAULT_OBJECT_ACTION_DESCRIPTION
See Also:
Constant Field Values

DEFAULT_CASE_ACTION

public static final java.lang.String DEFAULT_CASE_ACTION
See Also:
Constant Field Values

DEFAULT_CASE_ACTION_REASON

public static final java.lang.String DEFAULT_CASE_ACTION_REASON
See Also:
Constant Field Values

DEFAULT_CASE_ACTION_DESCRIPTION

public static final java.lang.String DEFAULT_CASE_ACTION_DESCRIPTION
See Also:
Constant Field Values

BP8_OBJECT_TYPE_CE_DOCUMENT

public static final java.lang.Integer BP8_OBJECT_TYPE_CE_DOCUMENT

BP8_OBJECT_TYPE_CE_FOLDER

public static final java.lang.Integer BP8_OBJECT_TYPE_CE_FOLDER

BP8_OBJECT_TYPE_CE_CUSTOM_OBJECT

public static final java.lang.Integer BP8_OBJECT_TYPE_CE_CUSTOM_OBJECT

FIELDTYPE_STRING

public static final java.lang.String FIELDTYPE_STRING
See Also:
Constant Field Values

FIELDTYPE_NUMERIC

public static final java.lang.String FIELDTYPE_NUMERIC
See Also:
Constant Field Values

FIELDTYPE_DATETIME

public static final java.lang.String FIELDTYPE_DATETIME
See Also:
Constant Field Values

FIELDTYPE_DATE

public static final java.lang.String FIELDTYPE_DATE
See Also:
Constant Field Values

FIELDTYPE_BOOLEAN

public static final java.lang.String FIELDTYPE_BOOLEAN
See Also:
Constant Field Values

FIELDTYPE_MONEY

public static final java.lang.String FIELDTYPE_MONEY
See Also:
Constant Field Values

FIELDTYPE_WFGROUP

public static final java.lang.String FIELDTYPE_WFGROUP
See Also:
Constant Field Values

DESCRIPTION

public static final java.lang.String DESCRIPTION
See Also:
Constant Field Values

SETTING_LOCK_TIMEOUT

public static final java.lang.String SETTING_LOCK_TIMEOUT
See Also:
Constant Field Values

SETTING_LOCK_WAIT_TIMEOUT

public static final java.lang.String SETTING_LOCK_WAIT_TIMEOUT
See Also:
Constant Field Values

SETTING_SEQUENCE_SIZE

public static final java.lang.String SETTING_SEQUENCE_SIZE
See Also:
Constant Field Values

SETTING_ROSTER

public static final java.lang.String SETTING_ROSTER
See Also:
Constant Field Values

SETTING_INDEX_CASE_ID

public static final java.lang.String SETTING_INDEX_CASE_ID
See Also:
Constant Field Values

RESULT_ATTACH_ERROR

public static final int RESULT_ATTACH_ERROR
See Also:
Constant Field Values

RESULT_ALREADY_ATTACHED

public static final int RESULT_ALREADY_ATTACHED
See Also:
Constant Field Values

RESULT_ATTACHMENT_CREATED

public static final int RESULT_ATTACHMENT_CREATED
See Also:
Constant Field Values

RESULT_ATTACHMENT_ALREADY_CREATED

public static final int RESULT_ATTACHMENT_ALREADY_CREATED
See Also:
Constant Field Values

PARTICIPANT_SEPARATOR

public static final java.lang.String PARTICIPANT_SEPARATOR
See Also:
Constant Field Values

BP8_CE_FIELD_DOCSATTACHED

public static final java.lang.String BP8_CE_FIELD_DOCSATTACHED
See Also:
Constant Field Values

SQL_SEARCH_CASES

public static final java.lang.String SQL_SEARCH_CASES
See Also:
Constant Field Values

SQL_SEARCH_DOCUMENTS_ATTACHED

public static final java.lang.String SQL_SEARCH_DOCUMENTS_ATTACHED
See Also:
Constant Field Values

SQL_FIELDS_MAPPING

public static final java.lang.String SQL_FIELDS_MAPPING
See Also:
Constant Field Values

GUID_CUSTOMOBJECT_SETTINGS

public static final java.lang.String GUID_CUSTOMOBJECT_SETTINGS
See Also:
Constant Field Values

FIELD_LAST_CASEID

public static final java.lang.String FIELD_LAST_CASEID
See Also:
Constant Field Values

CATEGORY_SYSTEM

public static final int CATEGORY_SYSTEM
See Also:
Constant Field Values

XML_ELEMENT_ZROW

public static final java.lang.String XML_ELEMENT_ZROW
See Also:
Constant Field Values
Constructor Detail

Bp8Operations

public Bp8Operations()
Method Detail

getNextCaseId

public int getNextCaseId(java.lang.String objectStoreName)
                  throws com.filenet.wcm.toolkit.util.WcmException
getNextCaseId

Parameters:
objectStoreName - - Content Engine Object Store name.
Returns:
int If function execution was successful, returns Bp8CaseID from the settings object.
Throws:
java.lang.Exception
com.filenet.wcm.toolkit.util.WcmException

attachDoc

public java.lang.String[] attachDoc(java.lang.String objectStoreName,
                                    filenet.vw.api.VWAttachment[] attachments,
                                    java.lang.String auditAction,
                                    java.lang.String userName,
                                    java.lang.String sql)
                             throws java.lang.Exception
attachDoc

Parameters:
objectStoreName - - Content Engine Object Store name.
attachments - - An array containing Document objects that will be attached to the Case.
auditAction - - This paramenter allows to configure action name. If no value specified, a default action of "Document Added" will be created.
userName - – user name that will be written to the Audit Trail as part of the event. By default, name of the interactive user will be written.
sql - - SQL statement that specifies search criteria for locating Case objects the document needs to be attached to. First field in the SELECT statement should always be Id. Example: "SELECT Id FROM CaseManagement WHERE AccountNumber='" + AccountNumber + "'"
Returns:
String[] If function succeeded, returned array contains list of Bp8CaseId document is attached to. if document was already attached to the Case, it will not be attached to that Case again however the Case ID where this document was already attached to will be returned in the list of Case IDs. If the same document also be attached to cases which didn't match the SQL criteria, there Bp8CaseIDs will not be returned. If function fails, the array contains only one element "0".
Throws:
java.lang.Exception

attachDocWithRoster

public java.lang.String[] attachDocWithRoster(java.lang.String objectStoreName,
                                              filenet.vw.api.VWAttachment[] attachments,
                                              java.lang.String auditAction,
                                              java.lang.String userName,
                                              java.lang.String sql,
                                              java.lang.String sRosterName)
                                       throws java.lang.Exception
attachDocWithRoster

Parameters:
objectStoreName - - Content Engine Object Store name.
attachments - - An array containing Document objects that will be attached to the Case.
auditAction - - This paramenter allows to configure action name. If no value specified, a default action of "Document Added" will be created.
userName - – user name that will be written to the Audit Trail as part of the event. By default, name of the interactive user will be written.
sql - - SQL statement that specifies search criteria for locating Case objects the document needs to be attached to. First field in the SELECT statement should always be Id. Example: "SELECT Id FROM CaseManagement WHERE AccountNumber='" + AccountNumber + "'"
sRosterName - - Configuration key for the Workflow Roster to use for this operation (configuration key and value need to be set in the bp8_config.xml within bp8ciops.jar).
Returns:
String[] If function succeeded, returned array contains list of Bp8CaseId document is attached to. if document was already attached to the Case, it will not be attached to that Case again however the Case ID where this document was already attached to will be returned in the list of Case IDs. If the same document also be attached to cases which didn't match the SQL criteria, there Bp8CaseIDs will not be returned. If function fails, the array contains only one element "0".
Throws:
java.lang.Exception

detachFolder

public int detachFolder(java.lang.String objectStoreName,
                        filenet.vw.api.VWAttachment caseAttachment,
                        filenet.vw.api.VWAttachment attachment)
detachFolder Detach folder from Bp8 Case Object

Parameters:
objectStoreName - - Content Engine Object Store name (symbolic name).
caseAttachment - - Bp8 Case object to detach folder from
attachment - - An VWAttachment representing folder that will be deattached from the Case.
Returns:
int If function execution was successful, returns 1 If function execution failed, returns 0

detachFolderWithRoster

public int detachFolderWithRoster(java.lang.String objectStoreName,
                                  filenet.vw.api.VWAttachment caseAttachment,
                                  filenet.vw.api.VWAttachment attachment,
                                  java.lang.String sRosterName)
detachFolderWithRoster Detach folder from Bp8 Case Object

Parameters:
objectStoreName - - Content Engine Object Store name (symbolic name).
caseAttachment - - Bp8 Case object to detach folder from
attachment - - An VWAttachment representing folder that will be deattached from the Case.
sRosterName - - Configuration key for the Workflow Roster to use for this operation (configuration key and value need to be set in the bp8_config.xml within bp8ciops.jar).
Returns:
int If function execution was successful, returns 1 If function execution failed, returns 0

attachFolder

public int attachFolder(java.lang.String objectStoreName,
                        filenet.vw.api.VWAttachment caseAttachment,
                        filenet.vw.api.VWAttachment attachment)
attachFolder Attach folder to the Bp8 Case Object

Parameters:
objectStoreName - - Content Engine Object Store name (symbolic name).
caseAttachment - - Bp8 Case object to attach folder to
attachment - - A VWAttachment representing folder that will be attached to the Case.
Returns:
int If function execution was successful, returns 1 If function execution failed, returns 0

createObject

public filenet.vw.api.VWAttachment createObject(java.lang.String objectStoreName,
                                                java.lang.String objectClassName,
                                                java.lang.String[] objectFields)
                                         throws java.lang.Exception
createObject This method is used to create an instance of custom object in Content Engine

Parameters:
objectStoreName - - Content Engine Object Store name.
objectClassName - - Content Engine custom object class name.
objectFields - – An array of the field mappings for the object being created. Each entry consists of the following elements:
1. Name: CE object symbolic field name.
2. Type: Field type. Valid values are: DATETIME, NUMERIC, STRING, BOOLEAN, MONEY
3. Value. Value could be static string, workflow field, or expression.
Example: {"LoanNumber", "STRING", "1234567890", "LoanAmount", "MONEY", "LoanAmount")
Throws:
java.lang.Exception

createCase

public java.lang.String[] createCase(java.lang.String objectStoreName,
                                     java.lang.String caseClassName,
                                     filenet.vw.api.VWAttachment[] attachments,
                                     java.lang.String actionName,
                                     java.lang.String actionUserName,
                                     java.lang.String[] caseFields)
                              throws java.lang.Exception
createCase This method is used to create instance of the Bp8 Case object

Parameters:
objectStoreName - - Content Engine Object Store name (symbolic name).
caseClassName - - Content Engine class name (Case object symbolic class name). The class should be defined as inherited from the Bp8Case base object class.
attachments - - Array of documents or folders. If this property is populated, the component will attach all documents or folders to the newly created Case.
actionName - – Name of the action written to Audit Trail when Case is created. The default value is "Case Created" and could be overwritten by populating this property. This parameter cannot be empty or null, use the following syntax: ""
actionUserName - – user name that will be written to the Audit Trail as part of the event. By default, name of the interactive user will be written. To specify the default value, use the following syntax: ""
caseFields - – Array of field mapping for the Case object being created. Each entry consist of the following elements:
1. Name: CE object symbolic field name.
2. Type: Field type. Valid values are: DATETIME, NUMERIC, STRING, BOOLEAN, MONEY
3. Value. Value could be static String value or workflow field or expression.
All entries have to be defined as are comma-separated. NOTE: Make sure to always specify the appropriate Case Type ID as one of the entries via the following assignment: "Bp8CaseType", "NUMERIC",numbertostring(1) Example: {"Bp8CaseType", "NUMERIC", numbertostring(1), "LoanNumber", "STRING", "1234567890", "LoanAmount", "MONEY", "LoanAmount", "ReceivedDate", "DATETIME", "01/31/2007 10:12:58"}
Returns:
String[] - first element - VWAttachment object which represent created Case, second element - Bp8CaseId of new Case
Throws:
java.lang.Exception

logEvent

public void logEvent(filenet.vw.api.VWAttachment attachment,
                     java.lang.String actionName,
                     java.lang.String actionReason,
                     java.lang.String actionDescription,
                     java.lang.String actionUserName,
                     int eventCategory)
              throws java.lang.Exception
logEvent Add record to the Case Audit Trail

Parameters:
attachment - - Case object.
actionName - - Action name.
actionReason - - Action reason.
actionDescription - - Action description.
actionUserName - - Action user name
eventCategory - - Event Category 1 = CAse level event 2 = Document level event
Throws:
java.lang.Exception

updateCase

public int updateCase(java.lang.String objectStoreName,
                      java.lang.String[] caseIDs,
                      java.lang.String[] caseFields)
               throws java.lang.Exception
updateCase This method is used to update CE Case object and mapped Process and Attachment fields WARNING: This method is designed solely for updating Cases *other* than the *current* Case - i.e. the Case for which the current wob (through which this operation is being called) is the primary work object. If this warning is ignored and this operation is configured to update the *current* Case, a locking problem arises, whereby Component Manager locks the wob first, so that the code here runs into an error (wob locked) when *it* tries to lock the same wob and update it. This operation was designed for use with "attach document" scenarios, where an initiating attachment launches a secondary wob that finds a primary Case (including its wob) and attaches its own attachment to that Case before terminating. *If* it is necessary, in such a scenario, for the secondary wob to update fields on the primary Case before terminating, then this operation *should* be used. *If*, on the other hand, the aim is to update fields on the Case for which the *current* wob is the primary work object, the locking problem described above will occur. Instead of doing this, therefore, the recommended best practice for updating the *current* Case is to use CE_Operations to update CE fields and simple Workflow Assignment calls in the Workflow Map to update "Read from Workflow" fields.

Parameters:
objectStoreName - - Content Engine Object Store name.
caseIDs - - Array of CaseID to be updated.
caseFields - – Array of fields to be updated. Each entry consist of the following elements:
1. Name: CE field symbolic field name.
2. Type: Field type. Valid values are: DATETIME, NUMERIC, STRING, BOOLEAN, MONEY
3. Value. Value could be static String value or workflow field or expression.
Example: {"Bp8CaseType", "NUMERIC", numbertostring(1), "LoanNumber", "STRING", "1234567890", "LoanAmount", "MONEY", "LoanAmount", "ReceivedDate", "DATETIME", "01/31/2007 10:12:58"} NOTE: Make sure to specify the appropriate Case Type ID via the following assignment: "Bp8CaseType", "NUMERIC",numbertostring(1)
Throws:
java.lang.Exception

updateCaseWithRoster

public int updateCaseWithRoster(java.lang.String objectStoreName,
                                java.lang.String[] caseIDs,
                                java.lang.String[] caseFields,
                                java.lang.String sRosterName)
                         throws java.lang.Exception
updateCaseWithRosterThis method is used to update CE Case object and mapped Process and Attachment fields WARNING: This method is designed solely for updating Cases *other* than the *current* Case - i.e. the Case for which the current wob (through which this operation is being called) is the primary work object. If this warning is ignored and this operation is configured to update the *current* Case, a locking problem arises, whereby Component Manager locks the wob first, so that the code here runs into an error (wob locked) when *it* tries to lock the same wob and update it. This operation was designed for use with "attach document" scenarios, where an initiating attachment launches a secondary wob that finds a primary Case (including its wob) and attaches its own attachment to that Case before terminating. *If* it is necessary, in such a scenario, for the secondary wob to update fields on the primary Case before terminating, then this operation *should* be used. *If*, on the other hand, the aim is to update fields on the Case for which the *current* wob is the primary work object, the locking problem described above will occur. Instead of doing this, therefore, the recommended best practice for updating the *current* Case is to use CE_Operations to update CE fields and simple Workflow Assignment calls in the Workflow Map to update "Read from Workflow" fields.

Parameters:
objectStoreName - - Content Engine Object Store name.
caseIDs - - Array of CaseID to be updated.
caseFields - – Array of fields to be updated. Each entry consist of the following elements:
1. Name: CE field symbolic field name.
2. Type: Field type. Valid values are: DATETIME, NUMERIC, STRING, BOOLEAN, MONEY
3. Value. Value could be static String value or workflow field or expression.
sRosterName - - Configuration key for the Workflow Roster to use for this operation (configuration key and value need to be set in the bp8_config.xml within bp8ciops.jar). NOTE: Make sure to specify the appropriate Case Type ID via the following assignment: "Bp8CaseType", "NUMERIC",numbertostring(1) Example: {"Bp8CaseType", "NUMERIC", numbertostring(1), "LoanNumber", "STRING", "1234567890", "LoanAmount", "MONEY", "LoanAmount", "ReceivedDate", "DATETIME", "01/31/2007 10:12:58"}
Throws:
java.lang.Exception


Copyright © 2004 FileNet Corporation. All rights reserved.