Skip to main content

Archibus (Eptura) Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to an Archibus (Eptura) destination.
archibus_api.png

Archibus (Eptura)

Create an Archibus (Eptura) Destination​

  1. 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.

  2. 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.

  3. In Nexla, Archibus (Eptura) destinations can be created using pre-built endpoint templates, which expedite destination setup for common Archibus REST API endpoints. Each template is designed specifically for the corresponding Archibus endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    Archibus (Eptura) destinations can also be configured manually, allowing you to send data to Archibus endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

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.

  • To configure this destination using a template, 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.

Configure Manually​

Archibus (Eptura) destinations can 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.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Archibus API after each call to a new Nexla webhook data source — enabling round-trip tracking of created or updated Archibus records.

API Method​

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Archibus REST API from the Method pulldown menu:

    • POST: For creating new records (e.g., new service requests, new rows in a data source).
    • PUT: For updating existing records by ID (e.g., updating a service request by activity_log_id).

Data Format​

  1. Select the format in which the Nexset data will be sent to the Archibus REST API from the Content Format pulldown menu. Archibus REST endpoints accept JSON payloads, so select JSON for all standard Archibus write operations. Nexla will automatically convert the data to the selected format for each API call.

API Endpoint URL​

  1. Enter the URL of the Archibus REST API endpoint to which you want to send the Nexset data in the URL field. Archibus write endpoints typically follow these patterns:

    • <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)
    • <base_url>/api/v1/data?dataSource=Api_<Name>_v1 — write through the generic Data REST API (POST)

    For update/upsert operations against a specific record (e.g., PUT /service-desk/requests/{activity_log_id}), include the ID of the object to be updated at the end of the URL. The ID can be sourced dynamically from a Nexset record attribute via a lookup-based macro.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Archibus REST endpoints generally only require Content-Type: application/json, which is included automatically by the pre-built templates.

    You do not need to include any headers already present in the credentials. The OAuth 2.0 bearer token is added automatically by Nexla based on your credential configuration.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this Archibus (Eptura) destination, select the attributes from the Exclude Attributes pulldown menu. This is particularly useful when upstream Nexsets carry computed or system-only fields that should not be persisted to Archibus.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching. Batching can dramatically improve throughput when bulk-loading records into an Archibus data source that supports array payloads.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings—click on an algorithm listed below to view instructions for configuring these settings.

    Property Inside JSON Object

    1. Enter the name of the JSON property that should contain the batched records in the Property Name field.
    2. If any additional properties should be included in the request, enter the properties in the Other Props field in JSON format.

    Code

    1. Enter the code that will be used to create the batched request in the code editor below the Grouping Algorithm field.

Response Webhook​

Optional

Nexla can automatically send the response received from the Archibus REST API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call — including the newly assigned activity_log_id for created service requests.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the Archibus REST API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.
  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)​

After all endpoint settings have been configured, Nexla can send a test payload to the Archibus REST API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Archibus REST API using the current settings.

Save & Activate the Destination​

  • 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.