std.CPRenditionChanged

This job signals to the server that a property of a DMS object’s rendition has changed. Typically called by the rendition service whenever it has freshly produced, updated or discarded a rendition or one of its aspects.

The job returns no data; instead — depending on the supplied Reason — it triggers server-side follow-up actions:

  • Update of the indexing status in osftslog (column flag2, see value range flag2).

  • Creation of a follow-up message in oscpmqueue — typically a message in the FULLTEXTDOC queue so the full-text indexer reprocesses the object with the updated content.

  • Update of the page count in the object metadata (when Reason = PAGECOUNT).

The complete CP lifecycle is described under Capture and Processing Messages (CP).

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 rendition has changed.

ObjectType

INT

Yes

Object type ID of the DMS object.

Reason

STRING

Yes

Kind of rendition change. Known values: see Values for Reason.

ServiceName

STRING

Yes

Identifier of the reporting service instance (typically: os-rendition-cache). Used for tracking and identification in follow-up messages — the server does not validate the value against the calling connection context.

Flags

INT

Yes

Reserved; always pass 0.

[OutputUnicode]

INT

No

1 — string fields in the output as UTF-16. No practical effect for this job since it produces no string output.

1.1. Values for Reason

Value Meaning

TEXT

The extractable full-text content of the object has changed (new OCR extraction or text layer from a PDF/Office document). Triggers a re-indexing via a new FULLTEXTDOC message.

PAGECOUNT

The page count of the rendition has been (re-)determined — either because the document was converted for the first time or because the conversion yielded a different page count. Primarily updates the stored page count; a re-indexing is only triggered if indexing depends on the page count.

SLIDE

A slide representation (preview image / per-page images for quick display) has been produced or changed. Affects mainly the display cache and typically does not trigger a re-indexing.

2. Return Value

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

3. Notes

  • Asynchronous in effect: the call returns immediately after the status changes and messages have been queued. The actual re-indexing happens later when the full-text indexer picks up the new message.

  • No caller-side deduplication: multiple calls with the same (ObjectID, Reason) insert a new message in oscpmqueue each time. The implicit collapse happens only on pickup — see Coalescing of redundant messages.

  • The job is intended for internal service contexts (technical user) and performs no content-level permission check.

4. Related Jobs