Micro Focus Service Management Automation X (SMAX)
App Vendor: Micro Focus
App Category: ITSM
Connector Version: 1.0.0
API Version: 1.0.0
Notice
This is a beta-app and the documentation is in progress.
About App
This app performs advanced IT service management (ITSM) operations using the Micro Focus Service Management X (SMAX) rest APIs.
The Micro Focus Service Management Automation X (SMAX) app is configured with Orchestrate to perform the following actions:
Action Name | Description |
|---|---|
Bulk Action | This action performs create or update bulk actions on entities. |
Get Entity Details | This action retrieves the details of an entity. |
Get Lock Status | This action retrieves the lock status of a user. |
Lock User | This action locks a user. |
Query Entity | This action queries the entities. |
Unlock User | This action unlocks a user. |
Configuration Parameters
The following configuration parameters are required for the Micro Focus Service Management Automation X (SMAX) app to communicate with the Micro Focus Service Management Automation X (SMAX) enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Username | Enter the username to access the Micro Focus Service Management Automation X (SMAX) instance. | Text | Required | |
Password | Enter the password of the Micro Focus Service Management Automation X (SMAX) instance to authenticate the client. | Password | Required | |
Server Address | Enter the base URL of the Micro Focus Service Management Automation X (SMAX) instance. Example: "https://smax.microfocus.com" | Text | Required | |
Tenant ID | Enter the tenant ID of the Micro Focus Service Management Automation X (SMAX) instance. | Text | Required |
Action: Bulk Action
This action performs create or update bulk actions on entities.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Entity Type | Enter the entity type to perform the bulk operation. Example: "User" | Text | Required | Allowed values:
|
Entity ID | Enter the entity ID. Example: "123651234" | Text | Required | |
Action Type | Enter the action to perform on the entity. Example: "lock" | Text | Required |
Action: Get Entity Details
This action retrieves the details of an entity.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Entity Type | Enter the entity type to retrieve details. Example: "User" | Text | Required | |
Entity ID | Enter the entity ID. Example: "123456789" | Text | Required | |
Entity Fields | Enter the entity fields to be retrieved. Examples:
| Text | Required |
Action: Get Lock Status
This action retrieves the lock status of a user.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
User ID | Enter the user ID to retrieve the lock status. Example: "123456789" | Text | Required |
Action: Lock User
This action locks a user.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
User ID | Enter the user ID to lock the user. Example: "123651234" | Text | Required | You can retrieve the user ID using the Query Entity action. |
Action: Query Entity
This action queries entities.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Entity Type | Enter the entity type. Example: "User" | Text | Required | |
Entity Fields | Enter the entity fields to query. Examples:
| Text | Required | |
Query Filter | Enter the filter for the query. Example: "firstname:john" | Text | Required | |
Size | Enter the maximum number of results to retrieve. Example: "10" | Text | Required | |
Order by | Enter the entity field name and sorting order for the query. Example: "firstname:asc" | Text | Required | |
Skip | Enter the number of records to skip. Example: "10" | Text | Required |
Action: Unlock User
This action unlocks a user.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
User ID | Enter the user ID to unlock the user. Example: "123651234" | Text | Required | You can retrieve the user ID using the Query Entity action. |