vtx.GetSimilarDMSObjects

This job delivers a list of other objects whose textual content is similar to the passed object.

This similarity search is currently only supported when using OSFTS as the full-text engine, configured with analyzer intrafind there, and the license OKM is present. Whether the search is supported can be determined with vtx.IsSearchForSimilarDMSObjectsEnabled.

1. Input Parameters

Name Type Required Description

Name	Type	Required	Description
`ObjectID`	INT	Yes	ID of the DMS object for which similar objects should be searched
`[MaxHits]`	INT	No	Maximum number of hits to be returned. If the parameter is not passed, the maximum hit count is determined based on registry entries.

ObjectID

INT

Yes

ID of the DMS object for which similar objects should be searched

[MaxHits]

INT

Maximum number of hits to be returned. If the parameter is not passed, the maximum hit count is determined based on registry entries.

2. Output Parameters

Name Type Dependency Description

Name	Type	Dependency	Description
`Result`	STRING	—	Found documents as semicolon-separated list; each entry consists of object ID, object type, ranking, and hit ID (comma-separated).

Result

STRING

—

Found documents as semicolon-separated list; each entry consists of object ID, object type, ranking, and hit ID (comma-separated).

3. Return Value

(INT): 0 = Job successful, otherwise error code.

Supported engines: lu

4. See Also

vtx.IsSearchForSimilarDMSObjectsEnabled