ABMS icon

ABMS

ABMS Node

Overview

The node provides integration with an ABMS (presumably a backend management system) via its webservice API. It supports multiple operations such as creating, deleting, describing elements, querying data, logging in, and more. The "Describe" operation specifically retrieves metadata or schema information about a specified element type within an active session.

This node is useful for automating interactions with the ABMS platform, enabling workflows to programmatically manage and query data entities. For example, you can use it to dynamically fetch the structure of a data element before performing further operations like creation or update.

Properties

Name Meaning
Session Name The name of the active session obtained from a prior login operation; required for most operations except login.
Element Type The type of element to describe or create; used to specify which entity's metadata to retrieve or manipulate.

Output

The output is a JSON array containing the response from the ABMS webservice API corresponding to the requested operation.

For the "Describe" operation, the json output contains the metadata description of the specified element type, typically including details such as fields, data types, and other schema-related information.

No binary data output is produced by this node.

Dependencies

  • Requires an API credential with host URL, username, and access key for authentication.
  • Uses HTTP requests to communicate with the ABMS webservice endpoint /webservice.php.
  • Relies on the crypto-js library internally for hashing during the login operation.

Troubleshooting

  • Common issues:

    • Invalid or expired session name will cause operations other than login to fail.
    • Incorrect element type names may result in empty or error responses when describing elements.
    • Network connectivity or incorrect host URL configuration can prevent successful API calls.
  • Error messages:

    • If the login challenge request fails, the node throws an error with the message and code returned by the ABMS API.
    • Operations marked as "not implemented" (e.g., extend_session, logout, sync) will throw explicit errors if attempted.
    • General HTTP or API errors will be surfaced as node operation errors with relevant messages.

Links and References

  • No external links provided in the source code.
  • Refer to the ABMS platform API documentation for detailed descriptions of supported operations and element types.

Discussion