Skip to main content

SMAX Data Connector Set Up

The Service Management Automation X (SMAX) Data Connector syncs data from OpenText/Micro Focus SMAX  via the EMS REST API.

Entity Configuration

Configured via entity_types in connector config. Each key is a case-sensitive SMAX entity type.

Common Entity Type

Description

Incident 

Incidents

Request 

Service requests

Change 

Change requests

By default only the Incident entity type is synced. Any SMAX entity type can be configured.

Optional Per Entity Configuration

Option

Description

fields 

List of fields to fetch; omit for FULL_LAYOUT(all fields)

filter 

SMAX filter expression (e.g. Status != 'Complete')

Many entity fields contain numeric ID references rather than human-readable names. Ensure human-readable fields are included in the entity configuration for best results.

Authentication

The SMAX connector uses a proprietary token-cookie mechanism rather than standard OAuth. Credentials are stored as basic username and password in the Secrets Manager, where SMAX retrieves the secret as a cookie on all requests.

The SMAX JWT token expires after an hour, and will be auto-refreshed on subsequent requests. Long-running requests may be canceled or encounter issues on auto-expiration. As a result, SMAX rejects queries that match more than 10,000 entities. Adjust configuration using date and time filters to reduce the number of entities returned per request.

Secrets

Credentials required to be stored in the Secrets Manager:

Field

Description

Username

smax_username_{connection_id} Username of the account used to access SMAX.

Password

smax_password_{connection_id} Password of the account used to access SMAX.

The SMAX authentication process follows these steps

  1. Credentials are stored as basic strategy (username + password in the Secrets Manager)

  2. SmaxClient POSTs to /auth/.../token?TENANTID={id} to get a JWT

  3. Token is sent as Cookie: SMAX_AUTH_TOKEN={token} on all requests

  4. Token auto-refreshes on expiry (~1 hour)

Sync preferences

Provide the following information about your sync preferences to BigPanda:

Required Configuration

Option

Description

Mode

Determine whether you’d like to set up an incremental or historical sync. 

Most organizations will need to use both modes. See the Streaming Modes section for more information.

Pipeline Configuration

Option

Description

Tenant ID

SMAX tenant ID

Entity Types

Map of entity type and per-entity config. Default: {"Incident": {}}

Start Date

YYYY-MM-DD format

If you’re setting up a historical sync, provide the date of when you’d like the sync to begin. If no start date is provided, all data will be synced.

SMAX rejects queries matching more than 10,000 entities — use date/type filters to limit query size.

End Date

YYYY-MM-DD format

Used for historical syncs only. Provide an end date to backfill historical syncs.

Rate limit

API requests per interval. Default: 5

Page size

The number of items requested in a single call. Default: 250

Rate Limit Timeout (MS)

The timeout period in seconds. Default: 60