Implementing Multi-Manager functionality using ALM’s API empowers administrators to efficiently manage learner groups based on attribute or active field values. By following the steps outlined in this article, administrators can create external applications that streamline the process of assigning and removing managers for specific user groups, such as franchise locations. ALM’s API endpoints, such as GET /managedOffices, GET /managedOffices/{id}/users, POST /managedOffices/configuration, DELETE /users/{id}/managedOffices, GET /users/{id}/managedOffices, and POST /users/{id}/managedOffices, offer the necessary tools to automate learner management tasks, improve data tracking, and ensure compliance within organizations.
By leveraging ALM’s API and Multi-Manager functionality, administrators can enhance the effectiveness of their learning management systems, optimize learner management processes, and provide a seamless experience for managers and learners alike.
Introduction:
In Adobe Learning Manager (ALM), the Multi-Manager functionality enables individual users to manage multiple user groups without hierarchy. This powerful feature allows users to become managers based on assigned attributes or active field values. By leveraging ALM’s API, administrators can create external applications to assign, remove, and update managers for specific user groups, such as franchise locations. In this article, we will explore the steps to implement Multi-Manager functionality using ALM’s API, focusing on a practical example of managing franchise locations of an organization.
Step 1: Understanding the API Endpoints:
ALM provides a set of API endpoints specifically designed for managing offices or user groups. These endpoints form the foundation of our external application. Here are the key endpoints we will be working with:
GET /managedOffices:
This endpoint retrieves the list of franchise values/names, with each franchise having a unique system ID known as “managedOffice ID”.
GET /managedOffices/{id}/users:
This endpoint retrieves the list of learners associated with a specific office or franchise location. In our example, it helps us fetch learners belonging to each franchise.
POST /managedOffices/configuration:
This endpoint configures ALM to recognize a specific attribute or active field, such as “Franchise,” for assigning users with the managerial role. This step is analogous to creating a logical column “{{ActiveFields}} managed by a user” in a CSV file. If a configuration already exists, this endpoint may not be necessary, as ALM can only maintain one configuration at a time. Removing a configuration requires the assistance of the ALM backend team.
DELETE /users/{id}/managedOffices:
This endpoint removes an office or franchise location from a specified manager’s list, effectively revoking their managerial role for that user group.
GET /users/{id}/managedOffices:
This endpoint lists the offices or franchise locations currently assigned to a manager, allowing for easy reference and management.
POST /users/{id}/managedOffices:
This endpoint adds an office or franchise location to a user, granting them the managerial role for that particular user group.
Step 2: Leveraging the API Payloads:
In order to execute the above endpoints successfully, it is essential to understand the payload structures. The payloads contain the necessary data for creating, updating, and removing managers for franchise locations. These payloads can be sent as requests to the respective API endpoints, facilitating seamless integration and automation.
The attached PDF file below has the sample payloads which you can use to try the endpoints in your ALM API swagger page.
ManagedOffice API adobe learning manager ALM
You must be logged in to post a comment.
