Versions Compared

Key

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

...

TopicMessageDescription

documentChanged

indexDataChanged


Since version 9.6.0
or 8.16.43 of the
service-manager:

renditionText


Code Block
{
  "itemid"    : "4D5678653345678",
  "typeid"    : "34522456755ABDE",
  "typename"  : "kundenakte",
  "versionid" : "675849384758694",
  "version"   : 1
  "action"    : "update" OR "new"
  "messageid" : "45678454ABABABA",
  (cond. "disableQueing": "false"),
  (cond. "isrenditiontextenabled" : "false")
}


  • If a dms-object with content-file is created or the content-file is changed, a message with the topic documentChanged is sent.
  • If a dms-object is created or its metadata is changed, a message with the topic indexDataChanged is sent.
  • If both metadata and content-file are created or changed in an update, messages for both topics are sent.


  • The version field informs if the dms-object was created or updated: 
    If the value of version is equal to 1, a dms-object is created and action will have the value new. If a dms-object is updated (version > 1), action will have the value update.

  • If a dms-object (with our or without content-file) is deleted (hard), the then a message with the topic documentDeleted is sent - see further below.


  • If rendition-plus extracted fulltext from the content-file, the renditionText message is sent (fulltext can be fetched from rest-ws endpoint DmsService.getItemContent with parameter "rendition" set to "TEXT".
    This message is also sent (again) if a subsequent full-text indexing operation is run with "perform content file export" parameter set to true or if the rendition is created again - if pushed out of the cache or manually deleted.
 
journalObjectCreated


Code Block
{
  "itemid"    : "4D5678653345678",
  "typeid"    : "34522456755ABDE",
  "typename"  : "kundenakte",
  "versionid" : "675849384758694",
  "action"    : "new"
  "messageid" : "45678454ABABABA",
  "indexDataMap": { "label1": "value1",
                    "label2": "value2"}
  (cond. "contenttext": "text")
}



contentLinkCreated


Code Block
{
  "messageid" : "45678454ABABABA",
  "action"    : "contentLinkCreated",
  "itemid"    : "4D5678653345678",
  "version"   : 1,
  "versionid" : "675849384758694" 
}


Code Block
{
  "messageid" : "45678454ABABABA",
  "action"    : "contentLinkCreated",
  "itemid"    : "4D5678653345678",
  "version"   : 1,
  "versionid" : "675849384758694",
  "contentid" : "234234234234234",
  "sourcecontentlinkedcount": 3,
  "modified"  : "2023-02-17T12:36:21+00:00",
  "modifierid": "1D23F87G34897",
  "modifier"  : "name",
  "modifiertitle": ""
}



technicalUpdate


Code Block
{
  "itemid"     : "4D5678653345678",
  "typename"   : "kundenakte",
  "islocationchanged" : "false",
  "acl"        : ["...", "..."],
  "aclchanged" : "true",
  "messageid"  : "45678454ABABABA"
}


Code Block
{
  "typename"          : "kundenakte",
  "islocationchanged" : "false",
  "aclchanged"        : "true"
}



inboxChanged


Code Block
{
  "type"  : "resubmission"/"subscription"
  "action": "create"/"update"/"delete"
  "userid": "45678454ABABABA"
  "ids"   : ["1..23", "45..24"]
}


Code Block
{
  "type"   : "workflow",
  "userid" : "45678454ABABABA",
  "refreshedItems": ["1..23", "45..24"],
  "removedItems"  : ["1..23", "45..24"]
}



fileChanged
The process file of a workflow (bpm) instance was changed.
documentDeleted


Code Block
{
  "itemid"    : "4D5678653345678",
  "typeid"    : "34522456755ABDE",
  "action"    : "delete"
  "messageid" : "45678454ABABABA"
}


This message is sent if a dms-object and/or content-file is deleted hard (i.e. not into the recycle bin).
redServerChanged


Code Block
{"ORGANISATION_CHANGED" : "Date"}


Code Block
{"SECURITY_SYSTEM_CHANGED" : "Date"}


Code Block
{"USER_ACL_CHANGED" : null}


Code Block
{"SERVER_SHUTDOWN" : ""}


Code Block
{"SERVER_START" : ""}


Code Block
{"SCHEMA_CHANGED" : ""}


These are DMS service events that indicate that the system status has been changed.

This includes:

  • Organization changed
  • Security system changed
  • DMS service stopped/started
  • Schema definition changed


...