HIS LenelS2 OnGuard Agent

Prerequisites

• LenelS2 OnGuard instance, with the following attributes properly configured:

  • user_name; this can be your system account created during PACS installation or newly created API user - see steps below

  • password;

  • application_id, that it's provided as part of the license; and

  • directory_id (These values will be required as part of the agent configuration.)

• API version: LenelS2 OnGuard 1.2 or later.

Configuration

PACS Configuration

Step 1: Create a New API User in Lenel OnGuard

• 1.1 Go to user administration

  • Login to Lenel System Administration using your system administrator account.

  • Click Administration → Users.

• 1.2 Add a new local user

  • Click Add on left bottom corner.

  • Click Internal Account tab on right side menu.

  • Add your new API username

  • Add password

  • Repeat password

• 1.3 Set administrator permissions

  • Click Permission Groups on right side menu

  • Check “SA delegate (SA permissions). This will ensure user has administrative privilegues needed to administer PACS system.

  

• 1.4 Confirm

  • Click OK on left bottom corner.

  

• 1.5 Verify

  • You should now be able to login to System Administration and API using this newly created user.

  • Assuming Directory Accounts was not modified, user should have directory id-1.

Step 2: Add custom fields

• Open FormsDesigner and log in.

• Select Cardholder:

• Click Insert Text Field and place it onto the form.

• Set the field properties:

  • Field name: C_EXTID

  • Length: 150

Once added, the C_EXTID field becomes available for use on cardholders by the agent.

• Repeat the process for all required fields:

  • Cardholder Fields:

    • C_EXTID (Text, Length: 150)

    • C_TECHBG (Numeric, Length: 10)

  • Visitor Fields:

    • C_EXTID (Text, Length: 150)

    • C_VISIT (Numeric, Length: 10)

    • C_TECHBG (Numeric, Length: 10)

Some of these fields are of numeric type; you can create them by clicking the Insert Numeric Field button instead of the text field option:

To configure visitor fields, open the Visitor form and repeat the process:

Step 3: Add Inactive badge status

• By default, Lenel does not include an Inactive status for badges. This status must be explicitly added using the ListBuilder functionality in the System Administration application:

• All statuses except for Active should be removed, and a new status called Inactive needs to be added:

Step 4: Add technical badge types

• We need to add CARDHOLDER_TECHBG_TYPE and VISITOR_TECHBG_TYPE. These badge types are used for internal storage of access levels.
  Navigate to the System Administration application and select Badge Types.

• Create a new badge type and complete the form as follows:

• For the CARDHOLDER_TECHBG_TYPE, set the Class to Standard and choose a value for Default deactivation that suits your needs - for example, 100 years, so it effectively never expires.

• The VISITOR_TECHBG_TYPE is almost identical, except the Class must be set to Visitor.

Step 5: Badge ID allocation and ranges

• Because HIS sets the Badge ID when creating a new badge, you must also configure Badge ID Allocation to all of your Badge Types.

• In the Badge ID Allocation tab:

  • Set Generate badge ID to Manual Entry, and

  • In the ID Ranges subtab, specify the valid ranges for your badges.

You will need to provide these badge ID ranges to the agent in its configuration so it knows which ranges to send to HIS.

Agent Configuration

General agent startup

Step 1: Download

Download the pacs-agent-{pacs-name} Docker image using the manual described in the SFTP section of the documentation.

Step 2: Create environment

Create a file named .env with the following content:

Agent__TenantId=example-tenant-id
Agent__PacsId=example-pacs-id
Auth__ClientId=your-client-id
Auth__ClientSecret=your-client-secret

In case you are connecting to a different environment than HID production, you need to set the proper URLs:

Auth__AuthNProvider=https://auth.example.com
Agent__PlatformUrl=https://platform.example.com

Step 3: Run Docker image

docker run -d \
  --env-file .env \
  pacs-agent-{pacs-name}:latest

Step 4: Check that the Docker image is running

docker ps

Environment variables description

Related to HIS

• Agent__PlatformUrl: HID Integration Service URL (https://his.hidglobal.com/ais/v1).

  • This information is provided by HID. Since Genetec agent version 1.1, this is set automatically to the production environment value and does not need to be set manually in most cases.

• Agent__TenantId: Tenant ID within HID Integration Service.

  • This information is provided by HID.

• Agent__PacsId: Unique ID assigned to the agent during registration.

  • This information is provided by HID.

  • If you registered your PACS on your own, this would be the ID you gave to the PACS.

Related to HID Authentication Service

• Auth__AuthNProvider: HID Authentication Service URL (https://auth-us.api.hidglobal.com/idp/t89d23e0b2445510399335/authn).

  • This information is provided by HID. Since Genetec agent version 1.1, this is set automatically to the production environment value and does not need to be set manually in most cases.

• Auth__ClientId: Client ID obtained during registration.

  • This information is provided by HID.

• Auth__ClientSecret: Client secret obtained during registration.

  • This information is provided by HID.

Agent-specific configuration

Environment variables for LenelS2 OnGuard:

• Lenel__Url: LenelS2 OnGuard API URL (excluding /onguard).

  • The default port for Lenel is 8080, but it can be changed.

  • If the agent is running on the same machine as the Lenel OnGuard, you can enter http://localhost:8080 or https://localhost:8080 (in case SSL is enabled).

  • In case Lenel OnGuard is running on a different machine than HIS agent, firewall network access and a valid IP address reachable on the same network are required.

• Lenel__ApplicationId: LenelS2 OnGuard Application ID.

  • This value should be provided with your OnGuard license.

• Lenel__DirectoryId: LenelS2 OnGuard Directory ID.

  • Please refer to the above section on how to configure Lenel S2 for API access.

• Lenel__UserName: API username.

  • Please refer to the above section on how to configure Lenel S2 for API access.

• Lenel__Password: API password.

  • Please refer to the above section on how to configure Lenel S2 for API access.

Agent-specific .env file part example:

Lenel__Url=https://localhost:8080
Lenel__ApplicationId=applicationID
Lenel__DirectoryId=id-1
Lenel__UserName=apiUsername
Lenel__Password=apiPassword

Limitations

Unsupported operations

Limited operation

Naming Mapping

Entities

• Identity in HIS maps to Cardholder in LenelS2 OnGuard.

• Visit in HIS maps to Visitor in LenelS2 OnGuard.

• Credential in HIS maps to Badge in LenelS2 OnGuard.

Creation of extension fields

HIS supports custom extension fields:

• Register the custom fields at both the tenant and agent (PACS) levels through the AIS; this process is documented here.

• Configure these fields within LenelS2 OnGuard. The process is identical to what you’ve already done when adding the required custom fields for the agent in the setup section.