ABMS icon

ABMS

ABMS Node

Actions11

Overview

The node provides integration with an ABMS (presumably a backend management system) web service via HTTP requests. It supports multiple operations such as creating, deleting, describing elements, querying data, retrieving specific records, and managing sessions through login/logout mechanisms.

For the Retrieve operation specifically, the node fetches a single record or element from the ABMS system by its unique identifier (Webservice ID) within an active session. This is useful when you need to get detailed information about a particular item stored in the ABMS system.

Practical examples:

  • Fetching details of a customer or order by its ID.
  • Retrieving configuration or metadata objects stored in the ABMS.
  • Accessing a specific record for further processing or conditional logic in an automation workflow.

Properties

Name Meaning
Session Name The name of the active session obtained from a prior Login operation; required to authenticate the request.
Webservice ID The unique identifier of the element or record to retrieve from the ABMS system.

Output

The output is a JSON array containing the response from the ABMS web service for the retrieve operation. The structure depends on the ABMS API but typically includes the requested element's data fields.

Example output structure (conceptual):

[
  {
    "id": "12345",
    "name": "Example Element",
    "type": "SomeType",
    "attributes": {
      "field1": "value1",
      "field2": "value2"
    }
  }
]

No binary data output is indicated by the code.

Dependencies

  • Requires an active ABMS API credential with host URL, username, and access key.
  • Uses HTTP requests to communicate with the ABMS web service endpoint /webservice.php.
  • Relies on the crypto-js library internally for hashing during login (not relevant for Retrieve but part of the node).
  • The node expects the user to have performed a successful login operation beforehand to obtain a valid session name.

Troubleshooting

  • Common issues:

    • Using an invalid or expired session name will likely cause authentication errors.
    • Providing an incorrect or non-existent Webservice ID will result in empty or error responses.
    • Network connectivity or incorrect host URL in credentials can cause request failures.

  • Error messages:

    • If the session is invalid or missing, the ABMS API may return an error indicating unauthorized access.
    • If the Webservice ID does not exist, the API might return a "not found" error or empty result.
    • The node throws errors if unsupported operations are selected or if required parameters are missing.

  • Resolution tips:

    • Ensure the session name is obtained from a successful login operation before using Retrieve.
    • Verify the Webservice ID is correct and exists in the ABMS system.
    • Check network settings and API host URL in the node credentials.

Links and References

  • No direct external links provided in the source code.
  • Refer to your ABMS system API documentation for details on the /webservice.php endpoints and expected request/response formats.

Discussion