Everything within this section is only visible while editing. Use Page Properties ID "STUB", "REFACTURE", "PROGRESS", "rDEV", "rDOC", "rLANG" and "DONE". Everything contained within the table is displayed in the (INTERNAL) Reports page.
Resources & Remarks https://wiki.optimal-systems.de/pages/viewpage.action?pageId=48466139 ...and linked within the containing article. Info MB - der user service wird benötigt - wird über das Web-API gateway angesprochen (extra Endpunkte sehen zur Verfügung) - kann hier mit dokumentiert werden und wir brauchen keine extra doku. kann auch von anderen angepsorchen werden aber immer nur über das Web-API gateway
Modification History Add a new line to this table and fill it whenever you edit the page.
Wenn wir die Formular Endpunkte beschreiben, dann muss auch folgende Erklärung für den DMS-GET-Endpunkt hinterlegt werden: Der Endpunkt gibt ein über dne architect erstelltes Custom-Formular für einen Objektype aus. Beim Erstellen wird das Formular für die Situation CREATE und beim Bearbeiten der Metadaten für EDIT Situation ausgeliefert. Wurde kein Formular hinterlegt, so wird ein Standformular ausgegeben. Es werden nicht die Attribute (Felder) ausgegeben, deren Prefix 'appClientsystem' ist, d.h. die in diesem App-Schema enthalten sind. So lassen sich technische Attribute hinterlegen, die Anwendern nicht präsentiert werden sollen. |
The higher-level client API of the Web-API Gateway, as it is useful for client application developers. |
|
There currently are two documented client services:
The third client service, the userservice, is accessed through the web-api gateway.
The yuuvis core service is considered as a backend for storing billions of objects and being strong in performance as well. To keep this performance all functionalities for a client that offers standard document management functionalities should be served by additional services. The web-API gateway (API-WEB) service is beside the userservice and the viewerservice service the main service for the client.
First of all, the service allows configuring the labels of object types and field names that should be shown to the users depending on the language the user has set in the client.
The second feature is to deliver standard forms for each object type and for the situations CREATE and EDIT, and maybe for SEARCH if necessary later on.
Currently, the API-WEB (web-api gateway) service offers several endpoints for storing this JSON-formatted data. In the future, our yuuvis® architect will support you in managing these labels. There is a Swagger-UI where administrators are supported by interfaces to maintain the data manually. Programmers get information on the URLs for the endpoints of a PUT or GET call: https://<host>/api-web/swagger-ui.html
The schema definition contains technical names for fields and object types. These fields are not really "readable" for users. To provide users with more meaningful terms in any language they may need, you have to create the respective language files. With the installation of the system, some global default settings are given for English and German language regarding the internal system fields.
The localization is in JSON format and contains key-value pairs. The key is the technical name of an object type or a field ending with _label
and _description
. The value is displayed by the client instead of the technical names referenced in the key.
{ "system:folder_label": "All folders", "system:folder_description" : "01 Across all", "system:document_label": "All Documents", "system:document_description": "01 Across all", "system:secondary_bale": "All secondary documents", "system:secondary_description": "01 Across all", "system:baseTypeId_label": "Basistype ID", "system:objectTypeId_label": "Object type ID", "system:secondaryObjectTypeIds_label": "Characteristics", "system:parentObjectTypeId_label": "Folder type", "system:objectId_label": "Object ID", "system:parentId_label": "Folder ID", "system:createdBy_label": "Creator", "system:creationDate_label": "Created on", "system:lastModifiedBy_label": "Editor", "system:lastModificationDate_label": "Edited on", "system:versionNumber_label": "Version", "system:acl_label": "Access list", "system:tenant_label": "Tenant", "system:traceId_label": "Trace ID", "system:tags_label": "Tags", "system:contentStreamLength_label": "File size", "system:contentStreamMimeType_label": "File type", "system:contentStreamFileName_label": "File name", "system:contentStreamId_label": "Content ID", "system:contentStreamRange_label": "Content range", "system:contentStreamRepositoryId_label": "Content stream repository", "system:digest_label": "Digest", "system:archivePath_label": "Archive path", "system:rmExpirationDate_label": "Retention date", "system:rmStartOfRetention_label": "Retention start", "system:rmDestructionDate_label": "Destruction date", "system:rmDestructionRetention_label": "Retention", "system:parentVersionNumber_label": "Folder version", "follow-up_label": "Follow-up", "expiryDateTime_label": "Follup-up date", "businessKey_label": "Object", "whatAbout_label": "Subject", "startTime_label": "Start time", "task_label": "Reminder", "type_label": "Type", "undefined_label": "", "document_label": "Document", "document_description": "01 Across all", "appClient_label": "Client standards", "appClient:minidoc_label": "Smallest document", "appClient:minidoc_description": "01 Across all", "appClient:clientdefaults_label": "Object header", "appClient:clienttitle_label": "Title", "appClient:clientdescription_label": "Description", "appClientsystem:leadingType_label": "Type", "appClientsystem:leadingTypeId_label": "Type" } |
{ "system:folder_label": "Alle Ordner", "system:folder_description": "01 Übergreifend", "system:document_label": "Alle Dokumente", "system:document_description": "01 Übergreifend", "system:secondary_label": "Alle sekundären Dokumente", "system:secondary_description": "01 Übergreifend", "system:baseTypeId_label": "Basistyp", "system:objectTypeId_label": "Typ", "system:secondaryObjectTypeIds_label": "Characteristika", "system:parentObjectTypeId_label": "Ordnertyp", "system:objectId_label": "Objekt-ID", "system:parentId_label": "Ordner-ID", "system:createdBy_label": "Ersteller", "system:creationDate_label": "Erstellt am", "system:lastModifiedBy_label": "Bearbeiter", "system:lastModificationDate_label": "Bearbeitet am", "system:versionNumber_label": "Version", "system:acl_label": "Zugriffsliste", "system:tenant_label": "Mandant", "system:traceId_label": "Trace-ID", "system:tags_label": "Tags", "system:contentStreamLength_label": "Dateigröße", "system:contentStreamMimeType_label": "Dateityp", "system:contentStreamFileName_label": "Dateiname", "system:contentStreamId_label": "Dateistrom-ID", "system:contentStreamRange_label": "Dateistrombereich", "system:contentStreamRepositoryId_label": "Dateistrom-Repository", "system:digest_label": "Digest", "system:archivePath_label": "Archivpfad", "system:rmExpirationDate_label": "Aufbewahrungsdatum", "system:rmStartOfRetention_label": "Aufbewahrungsstart", "system:rmDestructionDate_label": "Aussonderungsdatum", "system:rmDestructionRetention_label": "Aufbewahrung", "system:parentVersionNumber_label": "Ordner-Version", "follow-up_label": "Wiedervorlage", "expiryDateTime_label": "Wiedervorlagedatum", "businessKey_label": "Objekt", "whatAbout_label": "Betreff", "startTime_label": "Startzeitpunkt", "task_label": "Erinnerung Wiedervorlage", "type_label": "Type", "undefined_label": "", "document_label": "Dokument", "document_description": "01 Übergreifend", "appClient_label": "Client-Standards", "appClient:minidoc_label": "Kleinstes Dokument", "appClient:minidoc_description": "01 Übergreifend", "appClient:clientdefaults_label": "Objektkopf", "appClient:clienttitle_label": "Titel", "appClient:clientdescription_label": "Beschreibung", "appClientsystem:leadingType_label": "Typ", "appClientsystem:leadingTypeId_label": "Typ" } |
For object types, the _description
is used to group them in the object type selection dialog, e.g., for search or creation:
Recommendation: Group all extending object types in a group names 'Extension'. This may help the user in differentiating in object types that can be used for instantiating an object and those that can extend an existing object.
For field names, the _description
is shown below the form field.
../admin/resources/text/{locale}
to open the management form.../system/resources/text/{locale}
to open the management form. ../resources/text
,
to open the management form.In order to enhance the user experience of your client, you can configure icons for the different object types that will be displayed together with objects instantiated of the corresponding types. The icons are stored via CONFIG service either in the global or in the tenant-specific resources. The corresponding endpoints are Web-API Gateway Endpoints and thus also available via Swagger UI. The icons are expected as SVG files not larger than 512 KB.
The system-controller Endpoints for the icon management operate on the global resources:
The admin-controller Endpoints operate on the tenant-specific resources:
The endpoint of the resource-controller retrieves the tenant-specific resource if available. If not available, the global resource is read.
>> GET /api-web/resources/icon/{path} - Retrieve an icon.
Each icon is introduced into the system together with a unique key to identify it in retrieval calls. The retrieval (GET) endpoints expect a key and return the corresponding icon, if existing. If the specified key is not available in the corresponding resource(s), a default icon will be returned. Alternatively, a fallback icon can be specified in addition to the desired icon. The fallback icon is returned instead of the default icon, if the key of the desired icon does not exist. The key of the fallback icon have to exist, of course.
The icons are not configured automatically during the installation process, but have to be introduced manually afterwards. Use the technical names of object types as keys for the icon identification. For the fallback icons, the following three keys are available:
key for fallback icon | object types for which the fallback is configured |
---|---|
system:folder | all folder object types |
system:document | all document object types without floating secondary object types referenced in the schema definition |
system:dlm | all document object types with floating secondary object types referenced in the schema definition |
We recommend to use the icons of material design as they will blend in with the design of all the other icons used in our client framework. A selection for yuuvis® client as reference implementation is provided here for download:
Download ZIP
The recommended fallback icon for folder object types (system:folder
):
Download SVG
The recommended fallback icon for document object types (system:document
):
Download SVG
The recommended fallback icon for generic document types (system:dlm
):
Download SVG
tenMytenant:invoice
.email
.First the tenant-specific icons are checked. If the path is not available, the global path is checked. If this is also not available, the fallback is checked. If both are not specified, the default icon is retrieved.