std.CreateCPMessages
This job creates up to three new content/processing messages in the server-side
oscpmqueue for a DMS object: one each for full-text
indexing, filter pre-processing and rendition creation. Which messages are created is
controlled by boolean flags in the call.
Several flags may be set in a single call; for every true flag one separate message is
created — same object reference, different queuename. If all flags are false, the call
has no effect.
The complete lifecycle of a CP message is described under Capture and Processing Messages (CP).
|
This job is not listed in the official enaio® standard engine overview ( |
1. Input Parameters
| Name | Type | Required | Description |
|---|---|---|---|
|
INT |
Yes |
Numeric ID of the DMS object the created messages refer to. Stored as |
|
INT |
Yes |
Object type ID of the DMS object. Stored as |
|
BOOL |
Yes |
|
|
BOOL |
Yes |
|
|
BOOL |
Yes |
|
|
INT |
Yes |
Reserved; always pass |
2. Return Value
(INT): 0 = job successful, otherwise error code. The MessageGUID values of the created
messages are not returned — they only become visible on later pickup through
std.GetNextCPMessage.
3. Notes
-
No caller-side deduplication takes place: every requested message is created, even if an unreserved message for the same object already exists in the same queue. The implicit collapse happens only on pickup — see Coalescing of redundant messages.
-
The call returns immediately after the messages have been inserted; the actual processing happens asynchronously through the respective worker services.
-
Only the queues
FULLTEXTIDX,FULLTEXTFILTERandRENDITIONcan be addressed directly through this job. The remaining known queues (FULLTEXTDOC,FULLTEXTLOCATION,FULLTEXTDELETE,RENRESET,PAGECOUNT) are filled by other server-internal paths.
4. Related Jobs
-
std.GetNextCPMessage — worker services pick up the messages created here
-
std.DispatchCPMessage — acknowledges the processing of a picked-up message
-
std.CPRenditionChanged — called by the rendition service after processing; may itself trigger follow-up messages
-
std.IndexDataChanged — server-internal trigger after index data changes with the same effect