ABMSInstall

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, logging in, querying data, retrieving specific records, and updating elements.

For the Login operation specifically, the node performs a two-step authentication process:

1. It requests a challenge token from the server using the username.
2. It then sends a login request with the username and an MD5 hash of the concatenated challenge token and an access key.

This node is useful for automating interactions with the ABMS system, especially when you need to programmatically authenticate and obtain a session token to perform further operations.

Practical example

• Automate user login to ABMS to retrieve a session token.
• Use the session token obtained from Login to perform subsequent operations like querying or updating data.

Properties

Name	Meaning
Session Name	The name of the session to use for operations other than login. Must be obtained through a successful Login operation.

Note: For the Login operation, the "Session Name" property is hidden and not required.

Output

The output is a JSON object representing the response from the ABMS webservice API for the Login operation. Typically, this includes:

• A success flag indicating if the login was successful.
• A result object containing session details such as the session name/token.
• In case of failure, an error message and code.

No binary data is output by this node.

Dependencies

• Requires an API host URL, username, and access key credential to authenticate against the ABMS webservice.
• Uses the crypto-js library internally to generate an MD5 hash for the login request.
• Requires network access to the ABMS webservice endpoint /webservice.php.

Troubleshooting

• Common issues:

  • Incorrect credentials (username or access key) will cause login failure.
  • Network connectivity problems to the ABMS host will prevent the node from reaching the API.
  • If the challenge request fails, the login cannot proceed.

• Error messages:

  • If the initial challenge request returns an error, the node throws an error with the message and code returned by the API.
  • Operations marked as "not implemented" will throw errors if attempted (e.g., Extend Session, Logout, Sync).

• Resolution tips:

  • Verify that the API host URL and credentials are correct.
  • Ensure the ABMS webservice is reachable from the n8n environment.
  • Check the API documentation for valid usernames and access keys.
  • Use the Login operation first to obtain a valid session name before performing other operations.

Links and References

• No direct external links provided in the source code.
• Refer to the ABMS webservice API documentation for detailed information on operations and authentication.