Easily Integrate HCL Domino Data in Lazarus Pascal IDE

Lazarus Pascal IDE is a powerful, free, open-source development environment for building cross-platform applications. With the CData ODBC Driver for HCL Domino, you can seamlessly integrate and query live HCL Domino data, bringing real-time insights within your Lazarus Pascal IDE applications to enhance reporting, dashboards, and workflows.

This guide provides a comprehensive walkthrough, from setting up the connection to leveraging live HCL Domino in Lazarus Pascal IDE. Whether you're building reports, dashboards, or complex workflows, you'll gain the tools to unlock real-time insights and functionality within your applications.

Overview

Here is an overview of the steps:

1. Configure the DSN for HCL Domino data in the CData ODBC Driver for HCL Domino with the necessary connection properties.
2. Set up the ODBC connection in Lazarus by configuring the TSQLConnector, TSQLQuery, TDataSource, and TDBGrid components with the required details.
3. Test the connection to HCL Domino data by writing sample code on the Main form.
4. Compile and run the application to verify the successful integration and display of live HCL Domino data.

Prerequisites

Before starting, ensure you have the following:

• Lazarus IDE (version 3.4 recommended). Download from here.
• CData ODBC Driver for HCL Domino. Download and try the latest version from here.

Configure the HCL Domino DSN Using the CData ODBC Driver

To start, configure the DSN (Data Source Name) for HCL Domino data in your system using the CData ODBC Driver for HCL Domino. Download and install a 30-day free trial with all the features from here.

Once installed, launch the ODBC Data Source Administrator:

• On Windows: Search for ODBC Data Source Administrator in the Start menu and open the application.
• On Mac: Open Applications, go to Utilities, and select ODBC Manager.
• On Linux: Use the command line to launch ODBC Data Source Administrator or use unixODBC if installed.

Once launched, double-click on the CData HCL Domino data Source and enter the required values to establish a connection:

Connecting to Domino

To connect to Domino data, set the following properties:

• URL: The host name or IP of the server hosting the Domino database. Include the port of the server hosting the Domino database. For example: http://sampleserver:1234/
• DatabaseScope: The name of a scope in the Domino Web UI. The driver exposes forms and views for the schema governed by the specified scope. In the Domino Admin UI, select the Scopes menu in the sidebar. Set this property to the name of an existing scope.

Authenticating with Domino

Domino supports authenticating via login credentials or an Entra ID (formerly Azure AD) OAuth application:

Login Credentials

To authenticate with login credentials, set the following properties:

• AuthScheme: Set this to "OAuthPassword"
• User: The username of the authenticating Domino user
• Password: The password associated with the authenticating Domino user

The driver uses the login credentials to automatically perform an OAuth token exchange.

EntraID (formerly AzureAD)

This authentication method uses Entra ID (formerly Azure AD) as an IdP to obtain a JWT token. You need to create a custom OAuth application in Entra ID (formerly Azure AD) and configure it as an IdP. To do so, follow the instructions in the Help documentation. Then set the following properties:

• AuthScheme: Set this to "EntraID (formerly AzureAD)"
• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
• OAuthClientId: The Client ID obtained when setting up the custom OAuth application.
• OAuthClientSecret: The Client secret obtained when setting up the custom OAuth application.
• CallbackURL: The redirect URI defined when you registered your app. For example: https://localhost:33333
• AzureTenant: The Microsoft Online tenant being used to access data. Supply either a value in the form companyname.microsoft.com or the tenant ID.

  The tenant ID is the same as the directory ID shown in the Azure Portal's Entra ID (formerly Azure AD) > Properties page.

Create a New GUI Project

1. Launch the Lazarus IDE.
2. Navigate to File > New > Application to create a new GUI project with a Main form.

Add Required Connection Components to the Form

1. Go to View > Component > Palette and check the Keep open at the bottom-left to keep the Components window persistently open.
2. Search for the following components and add them to the Main form Form1 by clicking on Use at the bottom right.
   1. TSQLConnector
   2. TSQLTransaction
   3. TSQLQuery
   4. TDataSource
   5. TDBGrid

Configure the TSQLConnector Component

The TSQLConnector component in Lazarus Pascal IDE facilitates connections between your application and various databases or database APIs. Here's how to configure it:

1. Select the TSQLConnector component on the Main form.
2. Open the Object Inspector if it's not already open by going to View > Object Inspector
3. In the Object Inspector on the left, set the following properties under the Properties section:

   Property	Value
   Connected	True
   Driver	ODBC
   DatabaseName	Your DSN name (e.g., CData HCL Domino Source)
   UserName	Your database username
   Password	Your database password
   HostName	HCL Domino URL or localhost for local databases
   LoginPrompt	False
   Transaction	Select your TSQLTransaction component

If your credentials require a security token, follow these steps:

1. Double-click the Main Form in the Lazarus Pascal IDE to open the code editor.
2. Locate the procedure TForm1.FormCreate(Sender: TObject); section.
3. Paste the following code below the begin keyword. Replace 'your_security_token' with your actual security token:

   SQLConnector1.Params.Values ['Password'] := 
     SQLConnector1.Params.Values ['Password'] + 'your_security_token';
   

Configure the TSQLQuery Component

The TSQLQuery component in Lazarus Pascal IDE receives SQL code for queries and retrieves data from a database, simplifying data manipulation. Configure using the following info:

1. Select the TSQLQuery component in the Main form.
2. Set the following properties in the Object Inspector under the Properties section:

   Property	Value
   Active	True
   DataBase	Select the name of your TSQLConnector component
   SQL (Click 3 dots)	Your query (e.g., SELECT * FROM ByName)
   Transaction	Your TSQLTransaction component

Configure the TDataSource, TDBGrid, TSQLTransaction Components

The TDataSource component in Lazarus Pascal IDE bridges a dataset (e.g., TSQLQuery) with data-aware controls like TDBGrid, allowing data to be displayed and manipulated. The TDBGrid presents the data in a tabular format, while the TSQLTransaction ensures database operations maintain data integrity by executing within a transaction. Here's how to configure all three components:

1. Select the TDataSource component and set its DataSet property to the name of your TSQLQuery component.
2. Select the TDBGrid component and set its DataSource property to your TDataSource component.
3. Select the TSQLTransaction component. Set the following properties:
   1. Active: True
   2. Database: The name of your TSQLConnector component

Add Code to Test the Connection

To successfully test the connection, use the following code:

1. Double-click on the Main Form to open up the Source Editor.
2. Add the following code under the begin keyword and before the end. keyword.

procedure TForm1.FormCreate(Sender: TObject);
begin
  // Code for your Security Token
    SQLConnector1.Params.Values ['Password'] := 
        SQLConnector1.Params.Values ['Password'] + 'your_security_token';
  try
    SQLConnector1.Open;
    ShowMessage('Connection successful!');
  except
    on E: Exception do
      ShowMessage('Error: ' + E.Message);
  end;

  try
    SQLQuery1.Open;
    if SQLQuery1.IsEmpty then
      ShowMessage('No data found.')
    else
      ShowMessage('Data loaded successfully.');
  except
    on E: Exception do
      ShowMessage('Error: ' + E.Message);
  end;
end;

end.      

Compile and Run the Application

Save your project. Go to Run > Compile, then Run, or use the shortcut F9 to execute your application.

Next Steps: Play with the Data

Now that your data is successfully imported into Lazarus, here are some ideas to explore its full potential:

• Enhance Your TDBGrid: Customize your TDBGrid to enable sorting, editing, or highlighting specific rows.
• Visualize Your Data: Use components like TChart to create graphs and charts for intuitive data representation.
• Filter and Search: Use components like TDBFilter or implement custom filtering logic to allow users to quickly focus on relevant data. Add a TEdit component for user input and link it to your filtering functionality.
• Export Your Data: Utilize TSVExport or TFileStream components to save your data in formats like CSV or Excel for sharing or integration into other systems.
• Perform Calculations: Use TFPCustomDataSet or your dataset's built-in features to calculate totals, averages, or other metrics. Display results in a TLabel or add them to your TDBGrid.
• Create Forms and Reports: Design interactive forms using TForm and TDBEdit for user interaction. For reports, integrate components like RLReport or FastReport to generate and print professional-quality reports.

Take your data-driven application to the next level with these enhancements!

Simplify Data Connectivity in Lazarus with CData

Unlock the full potential of live HCL Domino data directly within Lazarus Pascal. Streamline your workflows, enhance productivity, and experience seamless integration like never before.

Start your free trial today and transform the way you connect and work with your data!