Configuring the ARCAD-API Server

To configure the ARCAD-API Server, click on the configure icon in the navigator.

To open the configuration settings from a navigator, enter the following URL: <address>:<port>/console.

Warning!

Enabling the H2 console on production environment is not recommended, it may expose the server to security vulnerabilities, especially if the connections are not limited to the localhost. It may also expose other H2 Database servers hosted on other server, if they also accept remote connections.

Defining the API Gateway General Settings

Access

ARCAD-API Common Settings→

API Gateway General Settings

Change the default values for the API Gateways to connect to the ARCAD-API Server.

ARCAD-API Base URL: The base URL of the ARCAD-API Server. This URL will be used to define a service in the API Gateways.
ARCAD-API User & Password: A valid ARCAD-API user and password. This user will be used by the API gateways to execute all the reachable web services on the ARCAD-API Server.

Important!

Ctrl+s will not save your changes in the server configuration editors. To save, click the Actions drop-down menu and select Save.

Reference

For more information about API Gateways, refer to API Gateways settings.

Defining the use of HTTP headers

Access

ARCAD-API Descriptor Settings→

General Settings

ARCAD-API Design Execution Settings→

Execution Settings

This option is available for both the API Server ("Design" server) and the API Production Server.

To simplify the call and the analysis of the JSON result of a web service, some information can be passed or retrieved using custom headers.

Input Custom Headers

These headers can be used to pass some technical information when calling a web service:

Input custom headers
Custom Header	Parameter	Description	Ws Type	Scope
arcapi-ibmi-host	server.host	The IP Adress or DNS of the IBM i server	ALL	Design
arcapi-ibmi-ccsid	server.ccsid	The CCSID used by the connection	ALL	Design / Production
arcapi-ibmi-session	server.session	The 5252-session name	ALL	Design / Production
arcapi-ibmi-login	server.user	The IBMi User login	SQL	Design / Production
arcapi-ibmi-password	server.password	The IBMi Password	SQL	Design / Production

Output Custom Headers

These headers can be used to retrieve some technical values

Output custom headers
Custom Header	Description	Scope
arcapi-x-status	Functional Status	Design
arcapi-x-result	Execution Result	Design / Production
arcapi-x-instance	Execution Instance ID.	Design / Production

Important!

Ctrl+s will not save your changes in the server configuration editors. To save, click the Actions drop-down menu and select Save.

Reference

For more information about HTTP headers in the JSON output, refer to Testing the execution of the web service.

Configuring the Mail Sender Settings

Access

ARCAD-API General Functions →

Mail Configuration

These settings are used when an automatic email is sent, if the project allows it.

Important!

The use of the SMTPS protocol is highly recommended to ensure the secure transfer of notification messages.

Transport/Protocol: The transport protocol used to reach the server.
Use SSL: Tick to use the SSL connection.
Host: The DNS or the IP Address of the SMTP server.
Port: The communication port used to reach the SMTP server.
Use Authentication: Authenticated connection required.
Login / Password: The Login / Password used to connect to the SMTP server.
Use Encoded Password: Tick to use encoded password.
Displayed Name: The name that will be displayed in the From field of the sent email.
Email: The email address that will be displayed in the From field of the sent email. This value is skipped if the Displayed Name is defined.
Charset: The charset used to encode non US-ASCII characters contained in the email subject.
Timeout: The communication timeout value in milliseconds.
Connection Timeout: The connection timeout value in milliseconds.

To test that the mail sender has been properly configured, enter an email address in the Test field and restart the server. If the parameters are correct, a number of test emails will be sent to the address entered every time the server is started.

Important!

If you do not want to receive an email every time the server is started, remove the addresses entered in the Test field.

Important!

Ctrl+s will not save your changes in the server configuration editors. To save, click the Actions drop-down menu and select Save.

Configuring the binary files repository

Access

Administration →

Binary Files Repository

This configuration section allows the storage of large binary files on the server file system.

Repository Path

Sets the local path where the binary files are stored. This path can be relative to the application home directory.
If the field is left empty, the default repository is ./files/bin/.

Key Cache duration

Sets the limit, in millisecond, of the temporary public key to a file. Once this limit is reached, the file is no longer available with this key and a new one must be generated.
By default, the value is set to 9,000,000 milliseconds.

Maximum File Size

Sets, in bytes, the maximum file size allowed to be uploaded through the HTTP server set below.
By default, the value is set to 10,240,000 bytes.

Server HTTP Address

Sets the HTTP server address hosting the file repository.

This allows the local application to delegate the management of binary files to another server, but most of the time this server is the same as the web-services server.

The default server address does not contain a port number and is automatically changed into the real web-service server name.

By default, the address is http://localhost.

Working with database scripts

Access

Database →

Database Scripts

The ARCAD-API Server comes with a set of scripts for its integrated H2 database. They are top-level SQL scripts that allow you to perform maintenance actions on the database.

Step 1 Access the server's scripts.

Connect to the updated ARCAD-API Server.
Open the Configuration view. You may need to right-click on the server to find this option if it isn't in the navigator's toolbar.
Select Database > Database Scripts to open the Database Scripts editor.

Step 2 Select the database script from the SQL Scripts drop-down.

Step 3 Click the Actions drop-down menu and select Run.

Result Scripts are executed as a background operation. To check its execution status click the Actions drop-down menu and select Show.

Create initial ARCAD-API database: This script creates an empty H2 database in the server.

Warning!
This script will overwrite the H2 database already existent in the server.
Restore latest update backup: This script restores the latest update backup that was created for the H2 database.
Save latest: This script saves the latest version of the H2 database on the server.
Update ARCAD-API database to latest version: This script performs an update of the H2 database after a server update.
Update missing required data: This script allows the addition of required data or project options.

Important!

Ctrl+s will not save your changes in the server configuration editors. To save, click the Actions drop-down menu and select Save.

Submit Search

go back to top