Initial Setup

This chapter guides you through all the relevant steps to configure aqishare in a way that allows you to start the container based on the image and exchange metadata from the SAP system.

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 file

Configuration Files

The configuration is divided among the following YAML files. All files must be created within the proper structure and meticulously maintained to ensure successful operation of aqishare.

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, queue monitoring, and logging.
storage.yaml	This file specifies the connection details for related storage systems such as Nuxeo or SharePoint.
sapConnection.yaml	To replicate metadata from SAP or to trigger an action in SAP, the SAP systems must be specified to establish a connection from aqishare to 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 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:

# 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:

# 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"