std.GetCPObjectInfo

This job returns the compact metadata for a DMS object that a worker service of the content/processing pipeline (full-text indexer, rendition cache, …​) needs in order to process the object — in particular processing status, mime type, hash, hierarchical path and whether a full-text content is already available.

The typical call context is the direct follow-up job after a successful std.GetNextCPMessage pickup; see Lifecycle of a message.

This job is not listed in the official enaio® standard engine overview (std).

1. Input Parameters

Name Type Required Description

ObjectID

INT

Yes

Numeric ID of the DMS object whose metadata is requested.

[ObjectType]

INT

No

Numeric object type ID. If not given, the server resolves the type itself. Passing it when known saves a database lookup.

Flags

INT

Yes

Controls the level of detail in the output. Typical value: 2 (full metadata including Hash, MimeTypeGroup and Pathes).

[Rights]

STRING

No

Access rights to check, as a letter combination (e.g. RWXDU). Only if this parameter is set does the server perform a permission check against the object and return the effectively granted rights in the output parameter of the same name. Without Rights, no check is performed — the call is intended for internal service contexts without a user check.

[OutputUnicode]

INT

No

1 — string fields in the output are returned as UTF-16. Default: ANSI.

2. Output Parameters

The server returns only those fields that apply to the given object. For container objects (portfolios, folders, registers), document-related fields such as MimeType, PageCount, Hash and HasVolltextFile are empty or 0/false.

Name Type Dependency Description

[ObjectType]

INT

Optional

Numeric object type ID. May differ from the input ObjectType if, for example, a variant was addressed.

[OriginalObjectType]

INT

Optional

Original object type ID before any resolution (e.g. variant → main object).

[PageCount]

INT

Optional

Number of document pages. 0 for non-document objects.

[Rights]

STRING

When Rights was set in the input

Effectively granted rights as a letter combination (same format as input).

[Hash]

STRING

Optional

SHA-256 hex hash of the document content (64 characters). Suitable for change detection against the last indexed state.

[ForeignID]

INT

Optional

External reference ID of the object (for third-party-system integrations). 0 if none.

[SystemID]

INT

Optional

enaio® system ID of the object (relevant in multi-system setups).

[MimeType]

STRING

Optional

MIME type of the document content (e.g. application/pdf, message/rfc822, image/jpeg).

[MimeTypeID]

INT

Optional

Numeric MIME type ID.

[MimeTypeGroup]

STRING

Optional

Coarse classification of the mime type, selecting the responsible converter/rendition pipeline. Known values: PDF, MAIL, WORD, POWERPOINT, IMAGE.

[Extension]

STRING

Optional

File extension (e.g. pdf).

[Pathes]

STRING

Optional

Hierarchical path of the object through the folder/register structure as a /-separated chain of object IDs with a trailing ;. Multiple paths (multi-location storage) are separated by ;. Example: 2408495/2660649/2678228;.

[ObjectTypePathes]

STRING

Optional

Same as Pathes, but with object type IDs instead of object IDs. Position-wise correspondence with Pathes. Example: 33/6488103/262248;.

[Deleted]

BOOL

Optional

true if the object is marked as deleted. Workers abort processing in this case.

[Recycled]

BOOL

Optional

true if the object was deleted again after a previous restore.

[InactiveVariant]

BOOL

Optional

true if the object is an inactive document variant (not the currently active version).

[HasAnnotations]

BOOL

Optional

true if annotations (notes, markings, stamps) exist on the object. Relevant for rendition: whether annotations need to be burned into the rendition output.

[HasVolltextFile]

BOOL

Optional

true if an extracted full-text content is already available for the object — the indexer can then read it directly from the cache instead of requesting a new rendition.

[ClientCrypted]

BOOL

Optional

true if the object is client-side encrypted.

3. Return Value

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

4. Notes

  • Pure read operation — repeated calls are idempotent.

  • HasVolltextFile drives the next step: if true, the full-text content can be read directly via std.GetCPObjectIdxFulltext; if false, a rendition has to be requested first, e.g. through std.CreateCPMessages with CreateRenditionMessages=true.

  • Hash can be compared against the last processed value to decide whether re-indexing is actually needed.

  • Pathes and ObjectTypePathes correspond position-wise: every component in Pathes has its matching object type ID at the same position in ObjectTypePathes.

5. Related Jobs