Split Case service
The Split Case service is used in the custom client-side human services to split an
existing case and create a new case by using a service call. The custom client-side human service
provides a user interface that displays the properties and documents from the parent case. You can
either modify the properties or retain the existing values from the parent case before the Split
Case service is initiated. The documents attached to the new case depend on whether you choose a
subset of documents or all the documents from the parent case.
The Split Case service in the Split Case client-side human services takes these properties and documents as input to create the new case.
Name | Description | Data type |
---|---|---|
caseId | The case instance ID that is passed as input to the Split Case service. Map this config option to tw.local.caseId. | String |
tosName | The target object store name that is passed as input to the Split Case service. Map this configuration option to tw.local.tosName. | String |
caseType | The case type that is passed as input to the Split Case service. Map this configuration option to tw.local.caseType. | String |
jsonProps | The string representation of the JSON value of case properties that is passed as input to the Split Case service. Map this configuration option to JSON.stringify(tw.local.caseProperties). | String |
docsToFile | A string list of document IDs that is internally set as a binding when you select a subset or all documents from the parent case. These documents are already part of the parent case and only the document IDs are passed to the split case service to be added to the new case. | String List |
description | An optional string parameter that can be used to set an optional description for the new case. | String |
caseClientTabID | The Case client tab ID that is passed as input to the Split Case service. Map this config option to tw.local.caseClientTabID. | String |
Name | Description | Data type |
---|---|---|
result | The result of type CaseObject that receives the output from the execution of the Split Case Service. Map the output result(CaseObject) to tw.local.caseInstance CaseObject. | Any |
Name | Description | Data type |
---|---|---|
caseId | The Case Identifier of the new case. | String |
tosName | The Target Object Store name where the new case is available. | String |
caseTitleProperty | The Case Type of the fetched case instance. | String |
caseTypeName | The Case Type name of the case instance that you query. | String |
isAutoLaunch | The property that indicates whether the new case must be opened automatically after creation. | Boolean |
errorString | The Create Case service error message that appears when the service fails to create the case. | String |
messageString | The message that the service creates upon successful execution of the service, which can be used to broadcast a message back to the Case Client or Workplace. For example, this message can be bound as data to the End node. | String |
modified Date | The last modified date of the Case instance. | String |
healthIndicator | The health of the Case instance if Case health is configured. | String |
caseClientURI | The base URI of the Case Client that can be used internally by the associated views. | String |
caseState | The state of the Case instance. | String |
isPropertiesDirty | The property that indicates whether the Case properties got modified. | Boolean |
icnRepoId |
The repository name mapping that represents the Target Object Store in Content Navigator. This is used internally by the Case Views for building the Daeja Viewer URL to view case documents by using Daeja Viewer. | String |
caseTypeSymbolicName |
The Case Type Symbolic name of the case instance internally used by the view. | String |
originalCaseProperties |
Copy of the Case Properties content object that is used for comparing with the changed values in the Case Properties to filter out only the modified properties that need saving. | ANY |
graphQLEndpointUrl |
GraphQL Servers end-point URL, which can be internally used by the associated views. This value is available, if GraphQL Server is available and configured. On Traditional WebSphere Application Server, this parameter gets its value if it is set in the configuration that uses the setBPMExternalECM or updateBPMExternalECM admin commands. On CP4BA, this value is automatically set, if GraphQL is part of the Cloud Pack for Business Automation. | String |
solutionPrefix | The prefix of the solution that is being deployed. | String |
solutionName | The name of the solution that is being deployed. | String |
currentRole | The current Role of the logged in user. | String |
isCaseOwner | The property that indicates whether the user is a case owner. | Boolean |