Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The DCM_CaseSearch service

...

The case engine will retrieve the case using the id you added as a parameter. It will then use the information of the case to go to the Customer Data Store and retrieve both the metadata and dossierdata and returns that to the runtime.

The runtime searches in the metamodel if the retrieved aggregates can be loaded into the profile and will do that if it can and should, according to the readMetadata and readDossierdata parameters.

This service call definition is part of the DCM library. It is only available when the case-engine-client profile is enabled.

Parameters

...

is used to search for specific cases, for example related cases to the current one based on some condition. A list of search criteria can be set as input and and the service returns one or multiple case IDs as output. Process data, case data, case metadata and dossier metadata can be used to search for cases, each with their own properties. It's required to specify the case aggregate if 'case metadata' is added as a criteria entry. Also, there is an option to set the maximum amount of results. The output parameter, the attribute which will contain the case IDs, can either be single or multivalued. The DCM Lists Service will be used as the source for case data.

Parameters

Parameter

Direction

Value

Description

Required

Case aggregateInputModule element AggregateSelect the case aggregate type to search. This is only required if a search criteria entry of type 'case metadata' exists.No
Target attribute for case id(s)OutputEntity

Select an attribute of the target entity on which attribute you want to store the found case Id(s).
This attribute can be singlevalued or multivalued.

Yes
Maximum resultsInputIntegerThe maximum number of results, the system will stop after reaching this number.No
Search criteriaInputList of search criteria.See "Search Criteria".Yes

Search Criteria

Data

Select an entity/attribute from the process profile to filter on.

Case data

Select a data field from the case aggregate to filter on.

Case metadata

Select a metadata field from the case aggregate to filter on.

Dossier metadata

Select a metadata field from the dossier aggregate to filter on. The field property is not validated against a list of possible metadata fields as, most of the time, the dossier aggregate is not in scope where the service is used.  

Filter

The search criteria all adhere to the pattern <type><properties><operator><value>. The value can be single or multi, depending on the operator. See the list below.

Operator

Used with metadata of type

Value can be

EqualsAll single-valued datatypesSingle value
Not equalsAll single-valued datatypesSingle value
Less thanAll single-valued datatypesSingle value
Less than or equalsAll single-valued datatypesSingle value
Greater thanAll single-valued datatypesSingle value
Greater than or equalsAll single-valued datatypesSingle value
LikeStringSingle value
Not likeStringSingle value
InAll multivalued datatypesMultivalued
Not inAll multivalued datatypesMultivalued

Example

Image Added

Example

Image Removed

This picture shows how the parameters would be filled for the DCM Foundation project.