Skip to main content

Configure the Drawing Generation Web Application (REST API)

Set up the Drawing Generation Web Application — the test frontend that lets you verify LDAWP outputs, and that can also be embedded as a visualization tool in client frontends.

Written by Sabine Bunese

Prerequisites

  • Common settings are defined.

  • The Automation Data Pool is configured.

Set the API parameters

In the Drawing Generation Web Application Configuration section of LDAWP Administrator, configure:

  1. Result Root Url.
    The public URL used to access drawing files on the server. Already adjusted if the option Apply DNS/IP to all in the Common Settings section was chosen.

  2. Source Root Url.
    The public URL to the inbound directory. Already adjusted if the option Apply DNS/IP to all in the Common Settings section was chosen.

  3. Max concurrent sessions.
    ​

  4. Clean result path.
    The interval (in minutes) at which output data in the Result Path is automatically deleted.

  5. Minimum free space.
    Minimum required disk space in Mb on the drive hosting the Result Path.

  6. Service timeout.
    timeout in seconds for the entire LDAWP drawing generation process. This should be >= LDOOP Timeout to prevent premature termination of the instance.

  7. File Count.
    the maximum number of unique XML filenames stored in the session list. The list behaves on a first-in, first-out basis(FIFO): once you submit more than three different XML documents within a single client session, the name of the document you submitted first is removed from the list, and the name of the newest document is added to the end.

  8. ASP.NET Core Request Timeout.
    How long an HTTP request may run on the API; synchronize with the LDOOP timeout for big projects.

  9. Number of processes in LDOOP Pool.
    Specifies the number of preloaded LDOOP Instances for the LDAWP Service. (0 = none; 1–n = pre-warmed). Instances are initialized upon the first request to reduce latency for subsequent requests.

  10. Default LDOOP Pool initialization project.
    Default project used to initialize pooled LDOOP processes.

  11. Webhook Url.
    Empty = disabled. If set, the API POSTs a JSON payload after every InitProject, Create*, and ExportReport call.
    ​

Configure the Web Application

LDAWP Administrator has a further configuration panel, specific to the newer ASP.NET Core 8 REST API (LDAWP_DrawingGenerationAPI, running under LDAWPCore_AppPool):

  1. Endpoint config file path.
    Where this section's configuration file is saved.

  2. API endpoint root URL.
    The root URL of the API. Already set for you if you used Set URL in Common Settings (see "Enter your LDAWP serial number and configure LDOOP permissions").
    ​

Set the web application favicon (optional)

  1. In the Drawing Generation Web Application Favicon section, either reset the icon to the default version or upload a custom file.

  2. Click Fix permissions to save the change.
    ​

Result: The Drawing Generation Web Application is configured and ready to verify generated outputs, or to be embedded in a client-facing frontend.

Related Articles
Did this answer your question?