The Client Service supports storing documents for registered devices.
Device documents are bound to the capability DEVICE_DOCUMENTS.
Device documents are stored with the device registration. If a device is moved (i.e. registered at another location within the same customer) device documents will automatically re-linked to the new registration. If a device is moved to a different customer device documents are not re-linked. If a device is unregistered and then registered again device documents will also not be re-linked.
Additional to general attributes stored for device documents a device document also stores a flag for restricted access. This flag is used in the logic to determine if an document stored for a device can be viewed or edited by a specific user. Users with permission VIEW_DEVICES can view all device documents with access restriction set to none, users with permission VIEW_DEVICES_RESTRICTED can also view documents with flagged for restricted access.
Device documents are part of the effective device documents.
Users with the <%PC EDIT_DEVICES_COMPETENCECLASS%> (for the competence class of the device's device-type) AND the permission EDIT_DEVICE_DOCUMENTS can create and modify device documents users with the additional permission EDIT_RESTRICTED_DEVICE_DOCUMENTS can also create and modify documents flagged for restricted access.
Table 35 shows the attributes stored with a document.
Attribute |
Description |
|---|---|
ID |
Integer, mandatory. A unique ID of the document assigned by the Client Service. |
File size |
Integer, mandatory. Size of the file in the document in bytes, detected and set by the Client Service. |
MIME type |
MIME type string as defined in RFC6838 The MIME type of the file detected by the Client Service |
Created at |
Date-time, mandatory The date when the document was crated on the Client Service |
Last modified at |
Date-time, mandatory The date and time when the document's data was last modified. |
File name |
String, mandatory Max Length 100 The file name provided on creation of the document. The file name length must be greater or equal 1 and less or equal 100 characters. The file name must not include any invalid file name characters. |
File last modified at |
Date time, mandatory Date and time when the file was last modified. This information is provided on document creation, by the uploading client. |
Title |
String, mandatory. Max length 100 The title of the document. If the title is not given it will be set to the file name, trimmed to 100 characters. |
Description |
String, optional Max Length 1000 Additional description of the document |
Restricted access |
Boolean, mandatory, default False This flag is used in the logic to determine if a document stored for a specific entity can be viewed or edited by a specific user. |
Content language |
ISO 2 letter language code, optional, default null. The locale of the content of the file. If not set the document's locale is unknown. |
Table 35: Attributes of a document
