HIS RS2 Access It! Agent

Prerequisites

• RS2 / Acre Access IT is installed and operational.

• RS2 REST API is enabled and reachable from the HIS Agent host.

• Supported RS2 / Acre Access IT versions: RS2 WEB API v 11.2.

Configuration

PACS Configuration

Step 1: Log in to Access It, and the system status screen appears.

Step 2: Click User Groups, then Administrators, and set API user access to 'API with Event Insert'.

Step 3: Click Servers ->Server Name and set the API Service Port number.

Step 4: Check you are able to access the API URL from the swagger

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 RS2 Access It! Agent:

• RS2__BaseUrl: Base URL of the RS2 REST API, e.g.: https://<rs2-server>:<api-port>/

• RS2__PublicKey: This value should be provided with your RS2 license.

• Rs2__Username: Username to authenticate the RS2 webservice.

• RS2__Password: Password for the username above.

Agent-specific .env file part example:

RS2__BaseUrl=https://localhost:9090
RS2__Username=rs2-username
RS2__Password=rs2-password
RS2__PublicKey=rs2-PublicKey

Limitations

Unsupported Operations

• Visitor-related endpoints (PACS doesn’t support native Visitors)

• PIN-Credential endpoints:

  • CreatePin (Identity / Visit)

  • GetPin (Identity / Visit)

  • UpdatePin (Identity / Visit)

  • RemovePin (Identity / Visit)

  • ActivatePin (Identity / Visit)

  • DeactivatePin (Identity / Visit)

Limited Operations

• RS2 does not support card formats while creating a credential. (The card format is ignored during creation.)

  • CreateCredentisal

  • UpdateCredentisal

  • GetCredentisal

Naming Mapping

Entities

Creation of extension fields

• RS2 supports extension fields. There are predefined user columns on the Cardholder such as UserText1 to UserText20 for text data.
  In our implementation, we use:

  • UserText1 for ExternalId

  • UserText2 for Phone

  • UserText3 for Email

  There are also UserDate1 to UserDate5 fields for date/time values, and UserNumeric1 to UserNumeric5 fields for numeric data.

Manual for Creating an EF in the PACS

• After logging in, you should see the navigation bar with Main. Click Cardholders, open any cardholder, and the General screen will appear with all the predefined user fields.

Supported entities and data types