# API Design elements description

This page lists SWING PDF Converter API design elements with their short description and "essential" status.

Design element is essential if without it SWING PDF Converter can not do a basic document conversion with default settings on latest Lotus Notes version.

SWING Software does not recommend omitting non essential design elements as their absence can cause problems in the long run.  

## Forms

| **Form name**        | **Description**                                                                                                           | **Essential** |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------- |
| .PDFManualActivation | <p> Used for SWING PDF Converter manual license activation.<br> This form is displayed if automatic activation fails.</p> | No            |
| Blank                | Used in Notes 6 document conversion and ProcessURL API calls                                                              | No            |
| License              | Used for storing licensing data                                                                                           | **Yes**       |
| SwExternalResources  | Holds SWING PDF Converter Java resources required for product installation                                                | **Yes**       |
| SwHeaderFooter       | Used for custom header/footer                                                                                             | No            |
| SwParams             | Used internally                                                                                                           | **Yes**       |
| SwParamsServer       | Used internally                                                                                                           | **Yes**       |
| SwWarningLog         | Used to display warning log documents in Lotus Notes                                                                      | No            |

## Views

| **View name**               | **Description**      | **Essential** |
| --------------------------- | -------------------- | ------------- |
| (LookupErrorLog)            | Used in error logs   | No            |
| (LookupSWConversionProfile) | Used internally      | **Yes**       |
| (LookupWarningLog)          | Used in warning logs | No            |

## Agents

| **Agent name**          | **Description**                                                                                                                        | **Essential**                    |
| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- |
| (ActivateLicenseManual) | <p> Used for SWING PDF Converter manual license activation.<br> This agent can be manually executed if automatic activation fails.</p> | No                               |
| (SwGetHTML)             | Used for ProcessURL API calls                                                                                                          | No                               |
| (SwInitJVM)             | Used internally                                                                                                                        | **Yes**                          |
| (SwPDFCreate)           | Used internally                                                                                                                        | **Yes**                          |
| (SwCajoR6)              | Used for Lotus Notes / Domino 6 only                                                                                                   | No                               |
| (SwGetRawDataR6)        | Used for Lotus Notes / Domino 6 only                                                                                                   | **Yes**                          |
| (SwPDFAction)           | Used for metadata, document appending and collections                                                                                  | **Yes**                          |
| (SwPDFDispose)          | Used internally                                                                                                                        | <p> <strong>Yes</strong><br></p> |
| (SwPDFInit)             | Used internally                                                                                                                        | **Yes**                          |
| (SwPDFSync)             | Used internally                                                                                                                        | **Yes**                          |

## Script libraries

| **Agent name**     | **Description** | **Essential**                    |
| ------------------ | --------------- | -------------------------------- |
| SwErrorPDFCLib     | Used internally | **Yes**                          |
| SwIOLib            | Used internally | **Yes**                          |
| SwSystemLib        | Used internally | **Yes**                          |
| SwPDFCLicenseLib   | Used internally | **Yes**                          |
| SwPDFMain          | Used internally | **Yes**                          |
| SwErrorLib         | Used internally | **Yes**                          |
| SwLogLib           | Used internally | **Yes**                          |
| SwUtilsLib         | Used internally | <p> <strong>Yes</strong><br></p> |
| SwUtilsUILib       | Used internally | **Yes**                          |
| SwCryptoController | Used internally | <p> <strong>Yes</strong><br></p> |
| SwLicenseBaseLib   | Used internally | **Yes**                          |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.swingsoftware.com/pdf-converter-for-notes/for-developers/api-design-elements-description.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.