Headless Mode

Headless Mode Setup

The Ares Kudo application supports headless mode, enabling operation without a graphical user interface (GUI) using a script.

To run the application in headless mode, replace /editor with /startScriptJob in the URL.

Example:

http://localhost:8081/startScriptJob?server=http://localhost:3000&file=Construction.dwg&script=file:///C:/Users/Rishi Jaiswal/Downloads/2078.scr

• server: API backend connection information API Server: Connecting ARES Kudo to a data backend

Using apiToken: Process to request token

https://app.kudo.graebert.com/startScriptJob?apitoken={apitoken}

The script should resemble this format:

2078.scr

Note: Ensure that the _EXIT command is added at the end of the script to close the headless application after completing all commands.

This action will generate a JobID.

To check the status of the running headless application, use the JobID in the following URL:

Example:

http://localhost:8081/scriptJobStatus?jobId=…&auth={auth}

By using this jobId, you can check if your script execution was successful or not.

headless (mandatory): Enable headless mode.

Application Root Directory Configuration

The application root directory, where essential resources are stored, needs to be specified. The path can be absolute or relative to the working directory.

• approot (mandatory): Set the application root directory. If not moved, approot's default location is at /opt/graebert-gmbh/Kudo-Server/Resources.

Source Data

Provide input file for processing. Two options are available:

• file: Input file accessed from API backend.

• fileUrl: Input file URL to be processed.

File Conversion / Export Settings
Specify output file type and additional parameters for file conversion or export.

• fileType: Output file type options include PDF, DWG, DXF, PNG, SVG, BMP and JPG.

• dwgVersion: For DWG and DXF files specify version. Available versions include 2018,R32; 2013,R27; 2010,R24;2007,R21;2004,R18;2000,R15.

Output Configuration
Configure output path and filename for processed files.

• outputPath: Path where output files are saved.

• outputFile: Name of output file.