Skip to main content

Installation Manual

Overview​

This section describes

  • the installation of the Report Creator for Word app
  • the set-up of the connection between the Report Creator and ADONIS instance

Where to get ADONIS Report Creator for Word​

The ADONIS Report Creator for Word can be found on Microsoft AppSource (coming soon).

Configuration of ADONIS​

This chapter describes the needed configuration to allow access to the ADONIS instances by Report Creator for Word.

note

In order to use Report Creator for Word with your ADONIS instance, the Standard RESTful services module must be licensed and enabled for each of them!

Detailed documentation can be found here:

Please note that some specific settings are required. Report Creator can be configured to work either with Basic Auth or OAuth 2.0

REST API with Basic Auth​

  1. Administration Toolkit REST scenarios required (more details):
    • Repository read APIs
    • Repository write APIs
    • Repository search APIs
    • Users read APIs
    • Users write APIs
    • Metamodel read APIs

REST API with OAuth 2.0​

  1. Administration Toolkit REST scenarios required (more details):

    • Repository read APIs
    • Repository write APIs
    • Repository search APIs
    • Users read APIs
    • Users write APIs
    • Metamodel read APIs

  2. OAuth 2.0 client configuration (more details):

ADONIS CORS policy for OAuth 2.0​

All ADONIS REST API requests are sent directly from the client web browser. There are 2 ways To allow such requests:

1. For ADONIS Versions 14.1.14 or 15.0.9 and newer: Modify settings in ADONIS Admin toolkit​

The latest ADONIS versions support the configuration of CORS settings via Authentication Configuration settings on the web admin page (./admin.view).

Once logged in to the admin page, navigate to Authentication and open the Security settings.

In the Security window, "allow_cors:" has to be set to "true" twice and confirmed by Save changes. CORSAdmin

2. For ADONIS Versions older than 14.1.14 or 15.0.9: Modify server settings file​

the following settings of the adoxx_web.properties server file must be set to true:

  • for all requests: security.rest.allow.cors
  • for OAuth 2.0 authentication process requests: security.allow.cors
note

If you are using ADONIS as SaaS, you can contact hotline@boc-group.com to configure the CORS policy.

Access rights to save templates (as ADONIS objects)​

Make sure proper access rights are set in ADONIS Admin toolkit

Report Creator makes one folder 'Report Templates WRC' in Object's root directory and stores templates in that folder as ADONIS documents. Therefore:

First user that creates and saves templates, must has write-access rights to root folder, so that folder can be created (this folder can also be created manually instead) After folder is created, every Report Creator user must has access to create objects in this folder