edoc contract Administration Guide
edoc contract Administration Guide
Breadcrumbs

Install and uninstall edoc contract

You install edoc contract on the server with edoc automate. Familiarize yourself with edoc automate before installing edoc contract.

For more information see the edoc automate guide.

How to install edoc contract on the server with edoc automate

To install, perform the following steps:

  1. Import edoc contract into edoc automate.

  2. Go to the administration of the MySQL database instance by clicking on phpMyAdmin in the App editor under App Details in the burger menu.

  3. Log in to the database instance app-server-mysql of the respective environment (e.g. master).

  4. Create a database for edoc contract. The default name of the database is edoc_contract.

  5. Create the required tables in the database with the appropriate SQL script:

    1. Click on Files in the app editor under App details in the burger menu to open the edoc automate file manager.

    2. Execute the SQL script in the path assets/sql/create.sql in phpMyAdmin.

Configure the database connections in the app details in the Datasources section. These data sources are available:

  • app_db: customize the access data for the local app database.

  • SMTP Reminder: configure the access data for the SMTP server to send e-mails.

  • Content Service: adjust the access data for the ECM system. Be sure to enter the module (ModuleId) of edoc content services (e.g. d3one) and the connection string (ConnectionString). Examples for the composition of the connection string:

    • d.velop d.3ecm-API (deprecated) (ID=d3):

      targethost=<hostname>;repositoryid=<d.3 repository id, e.g. A>;user=<user>;password=<password>;

    • d.velop documents, d.velop cloud (REST-API) (ID=d3one):

      targethost=<hostname, z.B. https://<d-velop_documents.customer.local>;repositoryid=<d.3one repository id>;apikey=<idp api key>;

More configuration steps for using edoc contract in d.3one

If you want to use edoc contract in d.3one (d.velop documents), you must also perform the following steps:

  • Customize "Content-Security-Policy" in Keycloak: you must allow to display Keycloak in d.3one in Keycloak. In the Keycloak administration under Realm Master > Realm Settings > Security Defenses > Headers, add the entry Content-Security-Policy with the host of the d.3one server. If you use the d.velop cloud, also enter https://sc.edoc.de.

    frame-src 'self' https://d3one.customer.local; frame-ancestors 'self' https://d3one.customer.local; object-src 'none';

  • Specify the base URL of d.3one in edoc automate: specify the base URL of d.3one in the edoc automate configuration (local.php). In this way, edoc automate recognizes that the application is running in d.3one. Automatic registrations are then also possible. You need eas-admin rights to view or edit local.php.

Tip

How to find the local.php file:

  1. Open the editor of an app in edoc automate.

  2. Click on Files in the burger menu to open WebDAV.

  3. Go to the automate system config directory to edit the local.php file.

For more information about WebDAV see the edoc automate guide.

Example of a basic URL in the "local.php" file:

PHP
<?php
return [
  'dvelopaddons' => [
    'base_uri' => 'd3one.westeurope.cloudapp.azure.com'
  ]
];

How to uninstall edoc contract from the server with edoc automate

To uninstall, delete the app from edoc automate and remove the database from the database instance.

The edoc contract application has been completely uninstalled.


See also