Initial Setup

This chapter guides you through all the relevant steps to configure aqishare and start a container based on the image. It covers the necessary configuration files that must be present and properly configured to replicate metadata from SAP to the documents in the related repository.

Before you go

Make sure to have the following files and packages available from the Download, at least:

• aqishare Docker image
• SAP SDK libraries
• License Key

Configuration Files

The configuration is split across several YAML files. Make sure these files are set up in the right structure and kept up to date to ensure aqishare runs smoothly.

Filename	Description
app.yaml	This file is crucial for the basic startup process as it contains essential settings needed to run aqishare successfully, such as the license key, the port number of the application or even logging.
storage.yaml	This file specifies the connection details for the related storage systems (Hyland Nuxeo or Microsoft SharePoint).
sapConnection.yaml	To replicate metadata from SAP or trigger an action in SAP, the SAP systems must be specified to establish a connection between aqishare and the SAP system.
tasks/myTask1.yaml, tasks/myTask2.yaml, tasks/myRepo/anothertask.yaml	Each file in the /tasks/ subfolder defines a self-contained, modular action for execution against the SAP system. The tasks are responsible for exchanging metadata, starting an SAP Workflow, or initiating an SAP Barcode scenario. They connect to the desired SAP system and trigger the action either through REST or RFC calls. Additionally, the creation of custom subfolder structures within /tasks/ is permitted, and the files will be automatically recognized and processed. Files within these folders may also be renamed with descriptive names to better reflect their function. Refer to Tasks section.

Overview of File Structure

The example below demonstrates the recommended structure that should be created and mapped into the container. We recommend creating this structure with the related configuration files inside. The subsequent sections in this chapter will make use of it and refer to it.

/configs/
    |
    + app.yaml
    + storage.yaml
    + sapConnection.yaml
    + /tasks/
        |
        + task1.yaml
        + task2.yaml
        + /myRepo/
            |
            + anothertask.yaml

Create File Structure from Scratch

To create the recommended structure choose the operating system and copy the script.

Unix

To create the recommended structure, navigate to the directory where you want the /configs/ directory to be created and paste the commands below into your Unix terminal:

Bash Script

# Create the main configs directory and its subdirectories
mkdir -p configs/tasks/myRepo

# Create files in the configs directory
touch configs/app.yaml
touch configs/storage.yaml
touch configs/sapConnection.yaml

# Create task files in the tasks directory
touch configs/tasks/task1.yaml
touch configs/tasks/task2.yaml

# Create another task file in the myRepo subdirectory within tasks
touch configs/tasks/myRepo/anothertask.yaml

Windows PowerShell

On Windows, open a PowerShell and navigate to the directory where you want the /configs/ directory to be created and execute the follwing commands in the given order:

Windows PowerShell Script

# Create the main configs directory and its subdirectories
New-Item -ItemType Directory -Path "configs\tasks\myRepo"

# Create files in the configs directory
New-Item -ItemType File -Path "configs\app.yaml"
New-Item -ItemType File -Path "configs\storage.yaml"
New-Item -ItemType File -Path "configs\sapConnection.yaml"

# Create task files in the tasks directory
New-Item -ItemType File -Path "configs\tasks\task1.yaml"
New-Item -ItemType File -Path "configs\tasks\task2.yaml"

# Create another task file in the myRepo subdirectory within tasks
New-Item -ItemType File -Path "configs\tasks\myRepo\anothertask.yaml"