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 out, retrieving elements, listing types, and updating elements.
For the Query operation specifically, the node allows users to execute custom queries against the ABMS system using a session established through prior login. This is useful for fetching filtered or specific data sets from the system based on user-defined query strings.
Practical examples include:
- Retrieving records that match certain criteria.
- Running complex queries to extract data for reporting or further processing.
- Integrating ABMS data retrieval into automated workflows.
Properties
| Name | Meaning |
|---|---|
| Session Name | The name of the active session obtained through a successful Login operation. Required to authenticate requests except for login itself. |
| Query | The query string to be executed against the ABMS system. Supports multiline input. |
Output
The output is a JSON array containing the response from the ABMS webservice API corresponding to the executed query. The structure depends on the query but generally includes the queried data records or metadata returned by the system.
No binary data output is produced by this node.
Dependencies
- Requires an API key credential with host URL, username, and access key for authentication.
- Uses HTTP requests to communicate with the ABMS webservice endpoint
/webservice.php. - For login operation, uses the
crypto-jslibrary to generate an MD5 hash for secure authentication.
Troubleshooting
Common issues:
- Invalid or expired session name will cause authentication failures.
- Malformed or incorrect query strings may result in errors or empty responses.
- Network connectivity or incorrect host URL can prevent communication with the ABMS service.
Error messages:
- If the login challenge request fails, the node throws an error with the message and code returned by the ABMS API.
- Operations not implemented (e.g., "extend_session", "logout", "sync") throw explicit errors indicating lack of support.
- General HTTP or API errors are surfaced as node operation errors with descriptive messages.
Resolutions:
- Ensure the session name is valid and obtained from a successful login.
- Validate query syntax according to ABMS query language.
- Verify API credentials and host configuration.
- Check network connectivity and firewall settings.
Links and References
- No direct external links provided in the source code.
- Users should refer to their ABMS system API documentation for details on query syntax and available operations.