Project Options

get there in apiUi by choosing `Project -> Options`

General

versionInfo

Allows you to store version information in your project. Project version information is shown with the Project -> Information and the Project -> Information from remote server commands.
The latter one is especially useful to check which version of your project is running remotely.

SaveRelativeFileNames

Default true.

When 'true', stored filenames will be relative to the projectfilename. 

Note: Do not store any data in the project folder because you will loose that data once your apiUi project is saved again.

projectFolders

Specify folders here where apiUi can store snapshots and reports.
Press the TestFolders button to check if the named folders do exist. The current- and reference-folder should not be the same. 

Note: Do not store any data in the project folder because you will loose that data once your apiUi project is saved again.

Log

maxEntries

The apiUi log keeps track, in memory, of each request/response pair. By default apiUi will keep adding log-records as long as apiUi is alive.
To avoid running out of memory, specify a maximum number of log records here. apiUi will remove the eldest request/response pair first (first-in-first-out).

DisplayedColumns

Maintain a list of column headers.
Which data will be displayed in a column depends on the logged message.
Specifying which data to display is done in the log panel self, click in the cell and select the desired item. Repeat this for each distinct opration (obviously not possible before such a message is logged at least once).

formGeneration

Some options with regard to generating initial forms on introspecting schema's.

OperationsWithEndpointOnly

Default "true"
When "true", apiUi will not show operations that lack an end-point (sometimes the case with Soap/Xml services) When "false", operations without endpoint will also be shown.

CHANGING THIS SETTING REQUIERS SAVE AND RELOAD OF YOUR PROJECT

MaxDepthWhenRecursive

Default "1";
Specifies the maximum depth when working with recursive elements (bill of material).
Keep this number as low as possible for better performance.
When a message-candidate has deeper levels, apiUi will show them all regardless of this setting.

CHANGING THIS SETTING REQUIERS SAVE AND RELOAD OF YOUR PROJECT

MaxDepthStructure

Default "9999";
Specifies the maximum depth when generating forms for XML or JSON messages.

Lower this number in case initial loading of project or messages takes a long time.

CORS

Cross-Origin Resource Sharing.
Default is to accept CORS preflight requests without logging.
Other options are:

exceptionResponse

apiUi will respond with an exception (default 500)

refuse

apiUi will respond with http "204" but with no requested access permitted.

UnknownOperations

Set the apiUi response to unknown operations.

OperationDefaults

Set operation default values on project level.
Properties set here can be overridden on operation level.

DatabaseConnection

To use Embedded SQL you first have to connect a database.

Enabled

Set this flag to direct apiUi to connect the specified database when activated.

Type

Supported databases are:

  • MSSQLServer
  • ODBC
  • Oracle
  • SQLite3

Stipulated that de database is accessible from the system hosting apiUi.

DatabaseName

In case of ODBC and working without DSN, specify the name of the ODBC driver; e.g.: MS Access Database.
For other databases this will be the name of a known pre-configured connection, or the location of the database file.

HostName

Specifies database engine listener.

Params

A string that contains name/value pairs, separated by semicolons. E.g:

DBQ=C:\yourFolder\yourAccesDb.mdb;Uid=Admin;Pwd=%pwd%

You can avoid having your password readable in a file by replacing it by %pwd% and enter your password in the Password parameter. Then your password will be encripted.

UserName

Name of the database user for the connection.
This user must have sufficient privileges to perform the tasks that you want to perform while connected to the database.

Password

Associated with the specified database user.

ConnectionString

A string that specifies the means of connecting to a data source.
Most commonly used for database connections but also for spreadsheets or text files. May include the name of the driver, server and database, user name and password. You can hide a password by using a %pwd% placeholder in this connectionstring and provide the password as property.

Visit http://www.connectionstrings.com for more information on connectionstrings and lots of examples.

TestConnection

Press the TestConnection button to test the database connection.