Versions Compared

Key

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

This page explains how Portrait can be connected to a given ELO archive.

Prerequisites

Before you can use ELO as a source for Portrait, we need to make sure that the following prerequisites are met.

Info

ELOoffice is generally not supported - only ELOprofessional or ELOenterprise can be connected.

ELO Server

Portrait will access the ELO instance via ELO Indexserver. Make sure the Portrait-App Instance has direct access to the ELO Indexserver - this is especially relevant if the Portrait runs in a DMZ or external network.

...

Code Block
https://eloserver:9090/ix-Archive1/ix

In the given example, the Server is called eloserver and the repository Archive1.

Be aware that the URL is case-sensitive.

ELO Service-User

Create a specific user for the Portrait - we recommend the name portraitservice PortraitService, since it is as service user only used for Portrait.

Check if the user for the Portrait-App has this general rights (only available up to ELO9):

  • Dokumentendateien sichtbar

Don't set this user rights, because it acts as a limiter:

  • ELOxc Client Benutzer, nur E-Mails

  • DMS Desktop Benutzer, keine Workflows

Info

Above-mentioned permissions are global permissions. Keep in mind that permissions inside the ELO Archive must be checked as well.

Set up a connection

Inside the application.yml file, we need to add a new entry inside the connections section:

Code Block
languageyaml
connections:
  eloconnection:
    - connectionIdentifierid: 'ix-Archive1'
      type: ELO
      nameurl: 'https://eloserver:9090/ix-ArchiveArchive1/ix'
      userNameusername: portraitservicePortraitService
      userPasswordpassword: 's3cur3d'
      computerNametimeoutInSeconds: pap-node3925
      runAs:
      hostname: 'https://eloserver:9090'
      path: '/ix-Archive1/ix'
      appName: Portrait Documentation Hub
      appVersion: 1.1.2

You can have several connections, each of them must start with a “-”.

the The yml-file is formatted with whitespaceswhite spaces. Ensure you have the correct intentationindentation: first level = 2 whitespaceswhite spaces, second level = 4 whitespaceswhite spaces, and so on. You will get an error in the logs at startup if the yml YML is malformed.

After you added the connection, you can jump to the next chapter: Adding an ELO source.sources.

Properties

  • timeoutInSeconds: optional, default value is 5