Document Properties

A Document as JSON

{
  "id": "1065ff43-2181-4880-905d-bc1d6caefe4e",
  
  // document-key
  "key": "MSProSAP.Invoice",
  "context": null,
  "userId": "24-001",
  
  // document-indentifier = document-key [rank]
  "rank": 0,
  
  // Content
  "contentType": "application/json",
  "content": "{ \"Prop1\" : \"abc\" }",
  
  // User-State
  "userState" : 99,
  "userInfo" : "ERR: Duplicate Invoice",
  
  // State
  "lastUpdateUtc": "2024-05-22T17:57:13.585Z",
  "createdDateUtc": "2024-05-22T17:57:13.585Z",
  
  "clientId": "MyLaptop",
  "clientVersion": 1716400633585,
    
  // Lifetime
  "expirationDateUtc": "2024-05-22T18:57:13.585Z"
}

Index

The Document's Index is a unique reference to a document.

The id is always unique. The Id can be client-provided when creating a new Document or it is created by the service and responded to the client.

Document identifier: Either id or the document-key (key,context,userId) is used to identify an existing record. When the document-key is provided the key field is mandatory, while context and userId are optional. Multiple documents with the same document-key can co-exist with a different rank. The rank used as an indexer: document-key [rank] -> document.

Property	Description
key (mandatory)	The key is the type-name of the document. It describes what the document contains. I recommend to using namespaces for keys. Example: MSPro.Templates.WelcomeEMail
context (default = null)	The context describes the context in which the current document exists. You can use, for example a ServiceReferenceID an execution-id etc. You may compare the Context with a directory in your filesystem. Example: Key=MSPro.Inbound.ServiceRequest; Context=<CustomerName>
userId (default = null)	The UserId was introduced to support an index that came with the document itself. For example, an external key/id like an invoice-id.
rank (default = 0)	Rank is used to store multiple documents (Array) with the same document-key information.

Content

The document content can be any information, like a JSON or an XML document, a string or a binary stream. Provide an appropriate contentType when creating the document.

Property	Description
content (mandatory)
contentType (mandatory)	The following content-types are supported: text/plain, text/html, text/xml, application/json, application/xml more to come...

User-State

The two user fields are not used or interpreted by the service. It is solely up to the user to give them a meaning and to use them.

Property	Description
userState (mandatory, default=0)	The intention of the userState was to offer some processing state for the Document, like: 0=pending -> 1=in process -> 2=processed -> 99=error . You may completely ignore this is go with the default=0. The userState is part of the APIs and can be used to GET or Query (filter) Documents. For example, all Documents: key="MSPro.SAP.Invoice" and userState=99 to fetch all documents with error (see below).
userInfo	Any text information you might find useful storing with the Document.

State

Property	Description
lastUpdateUtc	The UTC date/time with milliseconds when the document was updated last.
createdDateUtc	The UTC date/time with milliseconds when the document was created.
recordVersion	uNow.ToUnixTimeMilliseconds() when the document was updated. You can use this long (64-bit) integer to check if a document has changed. Basically a different format for lastUpdateUtc.

Lifetime

All documents do have a life-time which is, by default, one hour!

This means, by default, documents are deleted after one hour.

Each document has a expirationDateUtc which tells you exactly when the life-time expires. You can set or update that property at any time to adjust a dcoument's life-time according to your needs.

Note, that your Plan may limited the maximum lifetime you can define.