yuuvis® RAD Q&A - Recent questions and answers

Answered: How to get the fulltext of a document out of Core-Service-REST-WS?

Tue, 16 Dec 2025 16:09:02 +0000

Hello Mr Dünkel,

you can use the endpoint DmsService.getItemContent with the Rendition Parameter set to "TEXT"

empty table doesn't trigger errormessage

Tue, 05 Aug 2025 12:40:26 +0000

Hello,
we want the “netamount” field to be a mandatory field in the table "vatrates", and we also need to ensure that there is at least one row in the table. We have tried that in yRAD 9.16 and 10.16.

Here is our script:

function checkvatrates() {
if (scope.model.vatrates.value === null || scope.model.vatrates.value.length < 1) {
	scope.model.vatrates.error = { msg: 'Mindest eine Zeile in Tabelle Steuerbeträge benötigt' };
} else {
	scope.model.vatrates.error = null;
}

}
if (scope.situation !== 'SEARCH') {

checkvatrates();
scope.model.vatrates.onrowedit=function(table,row){
	row.model.netamount.required=true;
	checkvatrates();
}
scope.model.vatrates.onchange=function(table,row){
	checkvatrates();
}

}

(quoting seems not to work -preview always quotes just parts of my code)

The script works, but if I delete the row after creating it, no error is displayed. What are we doing wrong?

Answered: Prioritizing Full-text Hit Lists for Set

Fri, 26 Apr 2024 14:22:50 +0000

Hi Mathias,

Currently, the sets are not supported by this feature. We have to check whether Elasticsearch supports this and how. So you have to send us a change request.
May be I can answer you at the end of next week.

But our developers have a first question to this topic: How should the scoring work? Only for one value of the set, and if more the one, should they again be scored? Please, can you ask your customer about is expectations?

Best Regards,
Martin

Answered: Labels for language definitions

Mon, 08 Apr 2024 13:00:37 +0000

Hi Mathias, the labels of the buttons are configured in the extend.json as described in the documentation:

https://help.optimal-systems.com/yuuvisRAD/v90/admin/de/administration/client-config/config_custom_languages.htm

BR Martin

Answered: Storage information available for all users after Update

Wed, 27 Mar 2024 14:09:49 +0000

Hi Mathias,

OK, we lost the storage information during one of the 9.x version and brought it back but without checking the system privilege to manage storages. This is a bug and we will track this with ticket TUK-4689.

Best Regards,
Martin

Answered: “Add to favorites” action is missing

Wed, 27 Mar 2024 13:43:47 +0000

Hi Mathias,

we have removed it with 9.2, two reasons:

reduce the items of the list, it is enough to click on the symbol in the object detail header
the dialog to enter a custom title for the favorites list could not be offered in that way.

Best Regards,
Martin

Answered: Custom Dashboard: Reset to default

Mon, 25 Mar 2024 18:00:44 +0000

Hi Mathias,

Currently, is is not possible to reset the Dashlets to the default one. This missing feature will come with one of the next hotfixes.

And yes, the mentioned dashboard.json can be changed and used as the new default dashboard.

Best Regards,
Martin

Answered: is it possible to show an case-specific information for a form field to the user?

Mon, 11 Mar 2024 18:33:44 +0000

Version 10.0 will support you here. It will be possible to overwrite the description of a field via form script like:

scope.model.myfield.description = 'My description'

The description is shown below the form field.

Answered: Is it possible to configure booleans in away to only show false and true but not the NuLL mode?

Mon, 11 Mar 2024 18:26:54 +0000

These are the three possibilities to configure booleans and when to use it:

Boolean data field + default value = true/false + mandatory field:
-> Only 2 states are offered in the client.
-> This is how you get a yes/no field where you prefer a value for users in advance
Boolean data field +default value = null + mandatory field:
-> In the client, zero is offered first, then it goes through 2 states
-> You use this setting when you want to force a decision from the user,
-> but no value offered/preferred in advance
(this means that the user has to actively decide - it is not enough to simply click on forward)
Boolean data field + any default value:
o Three states are offered in the client
o Usable in cases where users need a choice between yes/no/don't know

Answered: Disabled Instances keep "hanging" in Gateway

Tue, 30 Jan 2024 13:12:04 +0000

Hello Felix,

this is a configuration of the spring boot eureka component. Please see here for a possible solution:
https://stackoverflow.com/questions/32616329/eureka-never-unregisters-a-service?rq=2

Best regards
Nicolai

Answered: Deploying custom plugin in basic client

Tue, 30 Jan 2024 13:08:18 +0000

Hello Andy,

please see here: https://yuuvisdevelop.atlassian.net/wiki/spaces/onpremise/pages/319620001/Extending the Client with Plug-ins

Best regards
Nicolai

Answered: Sending emails using server hosted in AWS

Tue, 30 Jan 2024 12:59:38 +0000

The problem is OAuth2 and/or 2FA which was not supported until version 9.12.
With the current version 9.16 LTS this is supported and can be configured as described here:
https://yuuvisdevelop.atlassian.net/wiki/spaces/onpremise/pages/538902548/Sending Emails via OAuth2 Authentication for Microsoft Office 365

Best regards
Nicolai

Answered: Timeout in BPM Script

Tue, 30 Jan 2024 10:28:48 +0000

Hi Mathias,

with yRAD 10.0 we will introduce the new feature: HTTP-Request timeout can be configured for each request.
As before, the complete documentation can be found in server-documentation pages.

The parameter is optional and if nothing is configured, the server-timeout will be used for the request.

best regards,
Bratislav

Answered: How to add table fields in form in process model?

Mon, 08 Jan 2024 10:15:10 +0000

Hi,

I did not fully understand the question.
Could you please provide a bit more information and an example?

best regards,
Bratislav

Answered: How to add a file to bpm process

Fri, 05 Jan 2024 15:53:25 +0000

Hello Jan!

I am not sure what exactly the problems is, but I have 2 things I noticed, one of mich might be the cause of the problem.

First, you're mixing some stuff here in the http request.
You're using string concatenation for adding the process- and object-id to the request, but thenn still use the "param" function which is meant to replace placeholders in the path.
So as is, you could remove the two ".param" calls as they don't do anything currently.
Or you can change the .path call to:

.path('/api/bpm/process/{processId}/file/{dmsObjectId')

For the two .param calls to do anything.

Secondly, what is "dmsObjectType" defined as / are you sure it's defined somewhere? Your script doesn't include the definition of "dmsObjectType", so if you forgot to define it, then it will result in a call with the type "undefined" and there will be no object with the type "undefined" and the id of your object.

The second point, looking at the 404 response, is most likely the root cause, so I hope this will solve your problem.

Sincerely,
Yannick

Answered: System-Admin and System-Global-Admin - what's the difference?

Fri, 05 Jan 2024 15:31:35 +0000

Hi Stepan,
The System-Global-Admin is no longer used. It was used in Cluster-Situation but we removed that, but not that specific user yet. But thx for that hint, I will ceck this and we will remove it in the next major version.
Best Regards,
Martin

Answered: Designer warning regarding obsolete forms

Fri, 05 Jan 2024 15:29:25 +0000

Hi Gabriel,
please, can you contact our support for this topic?
Thx and Best Regards,
Martin

Answered: How to do a controlled soft-delete with API-key authentication

Fri, 05 Jan 2024 15:21:15 +0000

Currently there is no other option. The system user has no recycle bin and a soft delete is not possible from a microservice using this user by default.
As a solution for this scenario the yuuvis RAD system could provide a solution by using the default admin account as recycle bin for the system user. Could be implemented in a future version.

As a workaound/solution for now: I would recommend to use a dedicated user and assign it to the microervice. As it is not possible at the moment to get an API key for a user, the mircroservice has to store username/password in the configuration. The calls can be done by using basic authentication. This dedicated user must have the rights to move the objects to the recycle bin. Currently there is no other way.

Answered: yuuvis RAD Agent

Fri, 05 Jan 2024 15:09:37 +0000

Hi Olaf,
which version of the agent do you have installed? The current version 7.5.11 should work fine.
Best Regards,
Martin

Answered: Can I add another client language by myself or do I always need OS Support? We

Fri, 05 Jan 2024 15:03:39 +0000

Hi Olaf,
you can add other language files on you own.
See the documentation:
https://help.optimal-systems.com/yuuvisRAD/v90/admin/en/administration/client-config/config_custom_languages.htm
Best Regards,
Martin

Answered: What are your experiences combining Yuuvis and Cloud Based Services?

Fri, 05 Jan 2024 15:00:54 +0000

Hi Felix,
do you speak about the yuuvis RAD or Momentum Environment?
BR Martin

Answered: How to encrypt repository files

Fri, 05 Jan 2024 14:49:00 +0000

Hi Henry,
we had to hide the documentation for repository encryption due to European Union regulations. If you want to use this feature inside the EU are, please, tell me and I will give you the information. Otherwise, you may wait some weeks or months. The EU has changed the regulations and we are waiting for the allowance to ship this feature outside the EU as well.
Best Regards,
Martin

Answered: Is it possible to change the user in process?

Fri, 05 Jan 2024 12:45:41 +0000

Yes, this is possible. Currently, an administrator has to do this job via the management-studio. Open the Processes view and search for your process. Here you can change the receiver of the current activity.
In the future we are looking forward to support process responsible in the client to change the receiver.
Best Regards, Martin

Answered: Offering restricted soft-delete with API-key rather than user credentials

Fri, 18 Aug 2023 09:53:54 +0000

Hi Stephan,

if all objects can be put in the same recycle bin, then you can change your microservice to not use the feign client but use a http framework and do the authentication with user-credentials itself.

If the objects should be put in the recycle bin of the user that started the custom action, the best thing would be to let the microservice return a list of object-IDs (Item-IDs) back to the custom action and then iterate over these within the custom action and call the soft-delete endpoint for each Item-ID. Since the custom action is run in the calling user's context, the objects will be put in this user's recycle bin.

Best regards
Nicolai

Answered: Manipulate documenttype order

Fri, 07 Jul 2023 14:00:48 +0000

Hi Marcel,

Sorry but there is currently no other way of sorting and we did yet have planned to do more on this side. Please, can you send your Change Request to pm[at]optimal-system.de with your specific use case. The product management team will evaluate this in the next time and will give you an answer with the decision.

Best Regards
Martin

Answered: yuuvis RAD Agent - Custom File type

Fri, 07 Jul 2023 13:54:25 +0000

Hi Marcel,

please contact our support.

Best regards
Nicolai

Answered: Is it also possible to connect more than one server to Abbyy-Finereader/OCR Server

Fri, 16 Jun 2023 12:09:36 +0000

No, this is not supported because
a) the ocr-service would need to cluster with both systems and then it is basically one system again (which is not valid / consistent)
b) it would violate the license agreement of ABBYY FineReader

Best regards
Nicolai

Answered: Using REST API with LDAP Gateway

Thu, 01 Jun 2023 13:18:58 +0000

OK I found a solution.

I just send the username and passwort as payload (type application/X-www-form-urlencoded) to the Login URL. (/login)

Then the authentication works.

First I tried to put the authentication into the header like in the Basic auth.
But this didn't work

Answered: How to enable direct links in a custom client

Tue, 09 May 2023 11:52:46 +0000

Hi Stefan,

please, can you check this configuration information as well?

https://yuuvisdevelop.atlassian.net/wiki/spaces/onpremise/pages/319621248/Adding a Second Subdomain to yuuvis RAD client

Best Regards
Martin

Answered: AD Synchronisation ldaps support

Wed, 05 Apr 2023 09:31:22 +0000

Hello schulerb,

yes it is possible with java.naming.provider.url=ldaps\://ldaps.XXX.de\:636.

Please make sure that firewalls are configured accordingly and credentials are correct. Also if the ldaps-server uses a self-signed certificate, it needs to be imported to the truststore of the core-service at <core-service>\jdk\lib\security\cacerts.

Best regards
Nicolai

Answered: CORS Settings

Mon, 27 Mar 2023 15:07:10 +0000

Hi Martin,

you can add the following section to your <service-manager>\config\gateway-prod.yml file to control if CORS is enabled or not and what domains, headers and methods are allowed. The shown values for headers and methods are the default values (you don't have to list them) and can be extended as you desire.

cors.enabled: true
cors.domains: qa-rad.yuuvis.com
cors.headers:
  - X-Requested-With
  - Content-Type
  - Accept
  - Origin
  - Authorization
cors.methods:
  - HEAD
  - GET
  - POST
  - PUT
  - DELETE
  - PATCH

Best regards
Nicolai

Answered: How to sort fields or table-rows?

Fri, 17 Mar 2023 13:05:26 +0000

this is currently not possible, but we will add the function in one of next releases.

thanks for reaching out!
bratislav

Answered: Prioritizing Full-text Hit Lists

Thu, 16 Mar 2023 12:32:24 +0000

Hi Mathias,

please, can you tell us why you want to deactivate this scoring?

We are currently discussing whether to introduce a switch that allows disabling the scoring feature.

Best Regards,
Martin

Answered: Ignore/filter specific word for search

Thu, 16 Mar 2023 10:42:40 +0000

Hi Mathias,

hmm, I do not understand your question. If the user has entered the company name because he wants to get specific objects for this why should this name then be ignored? So he will get nothing.

BR Martin

Answered: Active Directory synchronization issue, 'no user account available'

Thu, 16 Mar 2023 10:21:14 +0000

Hi Umar,

if an AD account is deleted the ad-sync operation first checks if this user can be deleted in yuuvis RAD as well. If there are no constraints that make deletion impossible (for example history entries that would otherwise point to an unknown user), i.e. if the user was interacting with the system in a read-only manner, then the user is deleted. If there are such constraints, the user cannot be deleted but will be deactivated and moved to the deactivatedobjectsparent (here "benutzer_inaktiv"). Also the users account is deleted, so that (manual) re-enabling and logging in becomes impossible.
If, due to changes in the AD group structure, a user has no parent group / OU anymore that is part of the synced structure, the user becomes dangling. To prevent it from floating it is moved to the danglingobjectsparent group (which you defined to be "benutzer_inaktiv" as well). In this case the user stays active and present because the user itself was not deleted.

Best regards
Nicolai

Answered: Unzip file on the fly on its way to custom viewer

Thu, 16 Mar 2023 10:06:41 +0000

Hi Stefan,

a content-file stored in yuuvis RAD is not processed or changed in any way - due to compliance reasons. For generating the preview the rendition-plus component unzips a local copy of compressed files and tries to generate a preview pdf of the contents. This pdf file is saved in the rendition-cache.
Therefore out-of-the-box you only have the choice of the original zip-file or the generated pdf-preview file.
If desired you could adapt the processing route in rendition-plus to not generate pdf-preview files but simply unzip compressed files and save the result as the preview-pdf. However this may only be a single file - so what if the zip contains several files? And what if it is not the expected file-type?
A better solution would probably be to implement a custom microservice that does the unzipping for you. So you could pass the viewer a URL to the custom-microservice with a reference to the content-file and when called the microservice retrieves this file, unzips it and returns the result.

Hope that helps.
Best regards
Nicolai

Answered: Recommended way to build a custom client

Thu, 16 Mar 2023 09:45:18 +0000

Hi Marcel,

please take a look at this documentation-page: https://yuuvisdevelop.atlassian.net/wiki/spaces/onpremise/pages/319620113/Getting Started

Best regards
Nicolai

Answered: How to build custom JSON structure tree so that Subfolder is possible and tree doesn't disappear in parts

Wed, 25 Jan 2023 13:18:24 +0000

Hello,
The "showempty" property works only if your also provide a field property, to let the system know what to provide as child nodes for the data, that is not returned by the search. If the field is a catalogue - all catalogue entries from the system definition are included. If the field is a string - you can provide your own list - if the field is type, the system types are given out.

This sadly doesn't work for folders, like your 'documents' folder, that are view separation only folders that don't provide a type, field, or condition. So if the child folder elements are empty, they get hidden.

Currently the only workaround I can suggest, is to move the folder up one level and don't use the view separation folder 'documents'. Like in this example:

[
  {
      "key": "foto",
      "type": "passfoto",
      "title": "Passfoto",
      "expanded": true
  },
  {
      "key": "vertragsunterlagen",
      "type": "vertragsunterlagen",
      "title": "Vertragsunterlagen",
      "field": "vertragsunterlagen.typ",
      "expanded": true,
      "showempty": true
  },
  {
      "key":"others",
      "title" : "Andere dokumente",
      "condition":"type!='vertragsunterlagen' AND type!='passfoto'"
  }
]

Hope this helps.
br
Frank Klingebiel

Answered: Duplikatserkennung

Tue, 24 Jan 2023 12:55:08 +0000

Hello Can,

a manual duplicate check can be done either via the REST-WS API or via the Search-Service API as follows:
REST WS API:
- Create the SHA-256 digest of the file (SHA-256 is the default, if something else is configured, this algorithm must be used)
- Call the REST-WS API endpoint ResultService.getEsqlResult (/result/raw) with the following ESQL - replacing it with the determined digest:

SELECT doc.sysitemid,typeqname(doc) FROM dms:sysdocument doc WHERE sysboxid 
IN(
  select [b2n].sysid1
  from 
  [dps]:[sysbox2actualnode] [b2n] 
  join 
  [dps]:[sysactualnode] [n] 
  join 
  [dps]:[sysactualnode2nodeelement] [n2e] 
  join [dps]:[sysnodeelement] [e] 
  WHERE [e].sysdigest='<SHA-256-Digest>'
)

SEARCH-SERVICE API:
- Create the SHA-256 digest of the file (SHA-256 is the default, if something else is configured, this algorithm must be used)
- Call the search service API /search with the following body - replacing <SHA-256-Digest> with the determined digest:

{"filters":{"digest":{"o":"eq","v1":"<SHA-256-Digest> [SHA-256]"}}}

This search is much faster - but has one disadvantage: It only returns results if the document is already indexed. When creating a new object - if immediate indexing is not activated - then it can take some time (depending on the system load) - until the object is also found in the index.

For API description - see here:
https://yuuvisdevelop.atlassian.net/wiki/spaces/onpremise/pages/319620127/Search Service API

VG
Nicolai

Answered: Change the MIME-TYPE of a file of the custom client

Mon, 23 Jan 2023 13:08:14 +0000

Hello,
the Yuuvis RAD system stores the mimetype that is given by the client. Only if the uploading client does not provide a mime type, or just provides application/octet-stream, the mime type is determined by a mapping of file extensions to mime type list, that is kept on server side.

By uploading content while providing the mime type, this mime type gets stored. For an api client it can be set by providing a 'Content-Type' http header. A browser sends (in most cases) the Content-Type header according to the OS settings. In windows it is possible to add a custom mimetype mapping in the CLASSES registry.
Example for WebAssembly files:

Windows Registry Editor Version 5.00

[HKEY_CLASSES_ROOT\.wasm]
@="WebAssembly"
"Content Type"="application/wasm"

By importing this win registry entry on the client machine, a uploaded wasm file, will get the content type application/wasm.

The other way to solve this problem, is to adjust the server extension to mimetype mapping. This is done by editing the jas-systemmimetypes.xml file in the configuration folder. Advantage: No need to change an individual client - Disadvantage: Core-Service restart is necessary to get the configuration active. After Update/New installation this configuration has to be done again.

Hope this helps.

Answered: Is it possible to move the FineReader to another server under Yuuvis?

Mon, 23 Jan 2023 11:52:40 +0000

Hello Enno,

yes it is possible to do it. The following has to be done:
- Install FineReader 12 on the new server
- Install the Service-Manager on the new server
- Enable only the OCR-Microservice and the Framework Microservices - Admin and Discovery
- Edit the file <service-manager>\config\application-cloud.yml and add the address of the existing server to defaultZone Parameter as shown in the commented example one line below
- Do the same on the existing server for the new server (add new server to defaultZone)
--> This connects the service-manager installations so that they cluster.
- Make sure all configuration files (except servicewatcher-sw.yml) are identical on both servers, even if the microservice is not active on one server. The configurations are read on an arbitrary server and then exchanged with all clustered servers.
- The OCR-Service will connect to the rendition-plus database via the rendition-sidecar. So make sure the according ports are open.

Best regards
Nicolai

Answered: mixed Structure and Reference Trees

Wed, 21 Dec 2022 15:38:25 +0000

Hello,
currently it is not possible to merge the structure tree and reference tree together.
The trees get distinct inputs: While the structure tree is using all child documents of the folder - the reference tree uses all folder and documents that are referencing the folder. But the parent-child relation between the folder and the child documents can be seen as a system internal reference.
From this point of view we investigate possibilities to merge all input data together while not confusing the user and to still be able to build up the aggregation tree with a single elastic search query. This change may be incorporated in version 9.0 - but this depends on the result of the investigation.

There is no way in the standard client to inject custom scripting for the structure/reference tree. With a custom client this is possible, while using the structure service as data source.

Answered: How to encrypt repository files

Wed, 21 Dec 2022 11:28:03 +0000

Hi,

Thank you for your detailed question we currently do not answer in our documentation. We will do this the next time. You will be contacted this week getting some more information that will help you to configure your systems as needed.

Answered: Can someone help me to put some .eml-Files from Lotus Notes to Yuuvis RAD 8.14?

Mon, 19 Dec 2022 17:39:32 +0000

Hello,

I expect a bug here. MSG files have to be imported. May be the Lotus Notes msg files differ somewhat so that our format scanner aren't able to handle those well.

Please, can you open a support case and add some examples files?

Answered: Make a table row mandatory under Yuuvis RAD 8.14

Mon, 19 Dec 2022 16:05:24 +0000

Hello,

we checked this behavior and right, this table attribute does not have any influence on the table logic. I expect that we will remove this in the next time.

But the solution is to check the table with form scripting. If no row exists the table should be set to error. And with an onchange event, it can be reset.

Answered: File name limitation

Wed, 14 Dec 2022 12:00:06 +0000

Hi Mathias,

I was able to reproduce the behaviour. We will work on this in ticket DB-6855.

Best regards
Nicolai

Answered: How can I migrate files from one storage to another without archiving them?

Wed, 14 Dec 2022 10:54:52 +0000

Hi Enno,

you can use the "synchronize storage" operation to copy all files from one storage to another.

After that you can use the "cleanup storage" operation to delete all files that have at least one other location from the selected storage.

Since synchronize storage made sure all files are on at least one other storage all files can and will be deleted from the selected storage (S3).

After the successful run of the cleanup storage operation you can delete the storage.

Best regards
Nicolai

Answered: FineReader 12 Update

Wed, 14 Dec 2022 10:49:29 +0000

Hi Mathias,

a new license file is necessary. Please contact us for it.

Best regards
Nicolai

Answered: How to create a yuuvis-user via API

Mon, 28 Nov 2022 16:04:48 +0000

If you plan to add/create lots of users/groups, it is better to use the batch-create (POST /organization/batch/create), since it will be more efficient.

If users are added individiually, it will trigger several actions in backend (such as ACL and inbox calculations) that can become costly when adding one by one - you can notice slowdown as you add more and more users individually.

best regards,
bratislav

Nested custom action

Fri, 28 Oct 2022 13:02:19 +0000

Hello,

is it possible to build nested cutom actions in a custom client?
It should work in a similar way as in the 'Download document file' action in the standard client: