Skip to main content

Archibus (Eptura)

Archibus by Eptura is a comprehensive Integrated Workplace Management System (IWMS) used by enterprises, government agencies, healthcare systems, and higher education institutions to manage real estate portfolios, space utilization, building operations, assets, maintenance, capital projects, and service desk activities. The Archibus REST API exposes Web Central data sources (Api_*_v1) and service desk endpoints over HTTP/JSON, enabling integration of IWMS data such as buildings, floors, rooms, employee locations, and work requests with downstream analytics, reporting, and workflow systems.

Archibus (Eptura) icon

Power end-to-end data operations for your Archibus (Eptura) API with Nexla. Our bi-directional Archibus (Eptura) connector is purpose-built for Archibus (Eptura), making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Archibus (Eptura) or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Archibus (Eptura) workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites​

The Archibus (Eptura) connector authenticates to the Archibus Web Central REST API using a 2-legged OAuth 2.0 Client Credentials flow brokered by an external OpenID Connect (OIDC) identity provider — typically Okta or Microsoft Azure. Archibus Web Central does not issue its own API tokens; instead, it verifies signed JWT access tokens issued by your configured identity provider.

Before creating a credential in Nexla, complete the following setup steps on the Archibus and identity provider sides.

Archibus Web Central Configuration​

Archibus Web Central must be configured to trust your OIDC identity provider before the REST API will accept access tokens.

  1. Log in to the Archibus Web Central server as an administrator with access to the configuration files.

  2. Open the /WEB-INF/config/oidc.properties file in your Web Central deployment.

  3. Populate the following properties using values from your identity provider:

    • oidc.audience: The audience claim that your identity provider issues for the Archibus application (e.g., the Authorization Server audience configured in Okta).

    • oidc.issuer: The issuer URL of your OIDC identity provider (e.g., https://yourorg.okta.com/oauth2/default).

    • oidc.jwksUrl: The URL of the identity provider's JSON Web Key Set, which Web Central uses to validate token signatures.

    • oidc.username.claim: The claim Web Central will use to map the token to an Archibus user (defaults to sub).

  4. Restart Web Central so the new OIDC configuration takes effect.

    Archibus Web Central does not accept unsigned tokens. Tokens must be signed with a key published in the configured JWKS endpoint and must include valid sub, iss, aud, and exp claims. For complete information, see the Archibus documentation on configuring Web Central to use the Okta Identity Provider.

Identity Provider (Okta) Configuration​

The following steps describe how to create a Service App in Okta that will issue access tokens to Nexla. The general flow is similar for other OIDC providers such as Microsoft Azure.

  1. Sign in to the Okta Admin Console using an account with administrative privileges.

  2. Navigate to Applications > Applications, and click Create App Integration.

  3. Select API Services as the sign-in method, and click Next.

  4. Enter a descriptive name for the application (e.g., "Nexla – Archibus Integration"), and click Save.

  5. On the General tab of the new application, locate the Client Credentials section, and copy the Client ID and Client Secret values. These will be used in Nexla.

    Important

    Copy the Client Secret immediately and store it securely. Depending on your Okta configuration, the secret may not be retrievable after the application is first created.

  6. Confirm that the Client authentication setting is set to Client secret so that the application can use the OAuth 2.0 Client Credentials flow.

  7. Open the Okta API Scopes tab (or your custom Authorization Server in Security > API) and grant the scope that your Archibus deployment expects (commonly archibus). The scope value must match the value configured in your Archibus oidc.properties file.

  8. From your Okta Authorization Server, note the Token URL (e.g., https://yourorg.okta.com/oauth2/default/v1/token). This will be entered into Nexla as the OAuth2 Token URL.

    Additional details about creating a service application and configuring scopes are available in the Okta documentation for implementing OAuth for Okta with a service app.

Archibus Web Central Base URL​

The base URL of your Archibus Web Central instance is required so that Nexla can compose REST API requests. The base URL follows the pattern https://<host>/<context>, where <context> is typically archibus for on-premises installs and may differ for SaaS deployments.

  • Confirm the base URL with your Archibus administrator (e.g., https://archibus.yourcompany.com/archibus). Do not include a trailing slash.

Authenticate​

Create a credential in Nexla​

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Enter the base URL of your Archibus Web Central instance in the Web Central Base URL field (e.g., https://archibus.yourcompany.com/archibus). This URL is the root of all REST API calls Nexla will make to your Archibus deployment.

  4. Enter the OAuth 2.0 token endpoint of your identity provider in the OAuth2 Token URL field (e.g., https://yourorg.okta.com/oauth2/default/v1/token). Nexla will exchange the client credentials for an access token at this endpoint before each call (or on token refresh).

  5. Enter the Client ID value copied from your Okta service application in the Client ID field.

  6. Enter the Client Secret value copied from your Okta service application in the Client Secret field. This value is encrypted at rest in Nexla.

    The Client Secret is treated as sensitive credential material. Rotate the secret in your identity provider on the cadence required by your organization's security policies, and update the corresponding Nexla credential whenever it is rotated.

  7. Enter the OAuth 2.0 scope(s) required by your Archibus deployment in the OAuth2 Scopes field as a space-separated list. The default value is archibus, which matches the scope name commonly created in Okta. Adjust this value to match the exact scope(s) configured in your authorization server.

  8. Click the Save button at the bottom of the overlay to save the configured credential. Nexla will perform a test request against the Archibus Web Central API to verify that the credential is configured correctly. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source​

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Archibus (Eptura) connector tile, then select the credential that will be used to connect to the Archibus (Eptura) instance, and click Next; or, create a new Archibus (Eptura) credential for use in this flow.

Endpoint templates​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Archibus (Eptura) endpoints. Each template wraps a specific Archibus REST API endpoint — including data sources of the form Api_*_v1 and dedicated Service Desk endpoints — so that you can pull workplace data into Nexla without composing API URLs manually. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

Get Buildings

This endpoint retrieves all buildings from your Archibus portfolio inventory using the Api_Buildings_v1 data source. Use it to feed downstream space, real estate, and reporting flows with the latest building records.

  • Enter the 0-based row index from which Nexla should begin paging results in the Page Start (offset) field. The default value of 0 performs a full sync from the first row.
  • Enter the number of records per page in the Page Size field. The default value of 100 is a balanced choice; set this value to 0 to fetch all rows in a single call.

Records are returned from the Archibus bl table by way of the Api_Buildings_v1 data source. For complete information about this endpoint and the available fields, see the Archibus Buildings REST API documentation.

Get Floors

This endpoint retrieves floor records from Archibus using the generic Data Source API and the Api_Floors_v1 data source. Use it to enrich building data with floor-level inventory for space planning and occupancy reporting.

  • Enter the 0-based row index from which Nexla should begin paging results in the Page Start (offset) field.
  • Enter the number of floor records per page in the Page Size field. Set this value to 0 to fetch all floors in a single call.

The Data Source API respects Archibus per-user and per-role Virtual Private Archibus (VPA) restrictions, so the records returned will reflect the visibility rules associated with the Archibus user mapped to the OIDC token.

Get Rooms / Spaces

This endpoint retrieves room and space inventory records from Archibus using the Api_Rooms_v1 data source. It is the core space utilization feed for occupancy analysis, charge-back reporting, and AI-driven workplace optimization use cases.

  • Enter the 0-based row index from which Nexla should begin paging results in the Page Start (offset) field.
  • Enter the number of room records per page in the Page Size field. Set this value to 0 to fetch all rooms in a single call.

Room records include attributes such as area, room category, room type, and division/department codes — refer to the Archibus Data Source REST API reference for a complete list of fields available from Api_Rooms_v1.

Get Employee Locations

This endpoint queries employee seat assignments and location data via the Api_HrEmLocations_v1 data source. Use it to align HR data with workplace assignments and to power people-and-place analytics.

  • Enter the 0-based row index from which Nexla should begin paging results in the Page Start (offset) field.
  • Enter the number of employee location records per page in the Page Size field.

Datetime fields returned from this endpoint follow the format yyyy-MM-dd'T'HH:mm:ss'Z'. The Api_HrEmLocations_v1 data source supports incremental retrieval by filtering on the last-updated field — combine this endpoint with a Nexla scheduled ingest to capture only records changed since the previous run.

Get Service Requests

This endpoint retrieves service desk work requests from Archibus (sourced from the activity_log table). Use it to feed status dashboards, SLA reporting, and downstream ticketing or ITSM integrations.

  • Enter the 0-based row offset for paging through service requests in the Page Start (offset) field.
  • Enter the number of service request records per page in the Page Size field.

Datetime fields are returned in the format yyyy-MM-dd'T'HH:mm:ss'Z'. For complete information about service desk record structure and lifecycle status codes, see the Archibus Service Desk REST API documentation.

Get Data via DataSource

This generic endpoint allows you to query any Archibus REST data source by name (Api_*_v1). Use it to access domain tables beyond the curated endpoints — including assets, leases, preventive maintenance schedules, problem types, and any custom data sources that follow the Archibus data source naming convention.

  • Enter the Archibus data source name in the Data Source Name field (e.g., Api_Buildings_v1, Api_HrEmLocations_v1, Api_ProbTypes_v1). Data source names follow the pattern Api_[dataSourceName]_v[version] and are defined in schema/ab-products/common/api/ab-api-datasources.axvw.
  • Enter the 0-based row index from which Nexla should begin paging results in the Page Start (offset) field. Use 0 for a full sync.
  • Enter the number of rows per page in the Page Size field. Set this value to 0 to fetch all rows in a single call.

The Data REST API accesses the Archibus database only via data sources and enforces Archibus security, including per-user and per-role VPAs and per-field security groups. For more information about defining and using custom data sources, see the Archibus Data Sources REST API documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration​

Archibus (Eptura) data sources can also be manually configured to ingest data from any valid Archibus Web Central REST API endpoint, including custom data sources of the form Api_*_v1 and ad hoc endpoints under /api/v1/... not covered by the pre-built templates, as well as sources that select specific fields via query parameters, apply Archibus filter expressions, or chain API calls. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, pagination, and request headers.

Archibus Data REST API endpoints follow the pattern <base_url>/api/v1/data/<resource>?dataSource=Api_<Name>_v1, and service desk endpoints follow <base_url>/api/v1/service-desk/.... Records are typically returned as a top-level JSON array, so use $[*] as the path to data. Field selection and filtering can be applied via Archibus query parameters, and field names must match the Archibus schema field names defined in the AFM Fields table. Paging is offset-based via the pageStart and pageSize query parameters (default page size 100; set pageSize=0 to return all rows in a single call). Only Content-Type: application/json is required — the OAuth 2.0 bearer token is added automatically from your credential.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Archibus (Eptura) data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination​

Click the + icon on the Nexset that will be sent to the Archibus (Eptura) destination, and select the Send to Destination option from the menu. Select the Archibus (Eptura) connector from the list of available destination connectors, then select the credential that will be used to connect to the Archibus Web Central instance, and click Next; or, create a new Archibus (Eptura) credential for use in this flow.

Endpoint templates​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Archibus (Eptura) endpoints. Each template is designed for a specific Archibus REST API write operation — covering both Service Desk request lifecycle endpoints and the generic Data Source write endpoint — making destination setup easy and efficient. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Create Service Request

This endpoint submits a new service desk request to Archibus by writing to the activity_log table. Use it to push tickets, work orders, or maintenance requests generated in upstream systems into the Archibus service desk.

  • This endpoint requires no additional parameters in Nexla — the entire request body is sourced from the Nexset record. Ensure your Nexset records include the following Archibus-required fields:

    • activity_type — the activity type code defined in Archibus (e.g., SERVICE DESK - MAINTENANCE).
    • requestor — the employee code (em.em_id) submitting the request.
    • prob_type — the problem type code from the Archibus probtype table.
    • description — a free-text description of the request.
  • The request will be sent as a POST with Content-Type: application/json.

For complete information about required and optional service desk fields, see the Archibus Service Desk REST API documentation.

Update Service Request

This endpoint updates an existing Archibus service request, identified by its activity_log_id. Use it to push status changes, satisfaction notes, or resolution details from external systems back into the Archibus service desk.

  • Enter the unique Archibus request code in the Activity Log ID field. This is the value of the activity_log.activity_log_id column in Archibus and must reference an existing record.
  • The Nexset record body should contain at least one field to update — for example, status, date_closed, or satisfaction_notes.
  • The request will be sent as a PUT with Content-Type: application/json.

The Activity Log ID is required. To update many requests in a single flow, drive the Activity Log ID field from a record attribute by leveraging Nexla's macro support, or use the generic Write via DataSource endpoint instead.

Write via DataSource

This generic endpoint writes or updates records in any Archibus data table via the Data REST API. Use it for any write operation that does not have a dedicated template — for example, updating employee locations, lease records, asset attributes, or any custom Archibus data source.

  • Enter the Archibus data source name in the Data Source Name field (e.g., Api_HrEmLocations_v1). The data source must be configured for write access in Archibus and must follow the Api_[dataSourceName]_v[version] naming convention.
  • Each Nexset record will be sent as a JSON payload whose property names must exactly match the Archibus schema field names (as defined in the AFM Fields table).
  • The request will be sent as a POST with Content-Type: application/json.

The Data REST API enforces Archibus security including per-user, per-role VPAs and per-field security groups. The OAuth 2.0 client used by Nexla must map to an Archibus user with permission to write to the targeted data source. For more information, see the Archibus Data Sources REST API documentation.

Manual configuration​

Archibus (Eptura) destinations can also be manually configured to send data to any valid Archibus Web Central REST API endpoint, including custom service desk endpoints and any Archibus data source configured for write access. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Archibus REST endpoints accept JSON payloads. Common write endpoints are <base_url>/api/v1/service-desk/requests (create a service request, POST), <base_url>/api/v1/service-desk/requests/{activity_log_id} (update a service request, PUT), and <base_url>/api/v1/data?dataSource=Api_<Name>_v1 (write through the generic Data REST API, POST). For update operations against a specific record, include the record ID at the end of the URL. Only Content-Type: application/json is required — the OAuth 2.0 bearer token is added automatically from your credential.

Save & activate​

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Archibus (Eptura) endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Archibus REST API until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.