Can you update the 'Default Home Page' option for a user via the API (or another automated option)?

[StevenDavis]

We have a system with hundreds of Archer users, most of which were using the 'Task Driven Landing Page' option which is being deprecated in the latest release. After the new release, those users will now have the 'User Selection' option selected and will have to choose their own dashboard when they log in for the first time after the release.  We would like those users who were using anything other than the 'Use a Dashboard' option to be assigned a specific dashboard and avoid seeing this 'choose your home dashboard' pop up when they log in for the first time.

Using the API I am able to update a user's DefaultHomeDashboard property successfully, but updating this property for a user who currently has the 'User Selection' option selected will not automatically be changed from 'User Selection' to 'Use a Dashboard'. The 'User Selection' option remains selected and the user is still prompted by the same pop up upon log in. If I query a user after assigning them a DefaultHomeDashboard I can see that the update was successful, but since the 'Default Home Page' option is still set to 'User Selection' the dashboard I selected is not shown. I can't find any way to update the 'Default Home Page' option to set it to 'Use a Dashboard' so that my update will actually have any affect. Is there a way to update to this option?

[PhilMc]

Hi Steven, you could try using  the "Internal" API to get this information. I've used it in the past for datafeed management processes that you can't do with the supported end-user APIs.

api/V2/internal/ManageUsers/Get

api/V2/internal/ManageUsers/Save

To use this, you'll need to only modify the parameter needed to change the settings above (if this is even in the objects retrieved via this API) and then pass the whole object back to save / update the user account. If you drop other attributes then it can cause issues by removing those settings.

[AlexLahoski · Accepted solution]

I'm working through this as well.  I'm wondering if it's not just the dashboard that needs to be updated, but also the workspace - I assume the two keys work together.  For example, if I query a user with the TDLP as the homepage, I get the following:

"Links": [],
"RequestedObject": {
"Id": 773,
"UserName": "SomeAdmin",
"DisplayName": "Admin, Some",
"DefaultHomeDashboardId": -1,
"DefaultHomeWorkspaceId": -1,
"LastLoginDate": "2023-11-16T19:17:59.487"

For a user that hasn't logged in, you get nulls:

"Links": [],
"RequestedObject": {
"Id": 794,
"UserName": "OtherAdmin",
"DisplayName": "Admin, Other",
"DefaultHomeDashboardId": null,
"DefaultHomeWorkspaceId": null,
"LastLoginDate": null

And for a set Dashboard you get numbers for both:

"Links": [],
"RequestedObject": {
"Id": 499,
"UserName": "AdminLahoski",
"DisplayName": "Lahoski, Admin",
"DefaultHomeDashboardId": 9,
"DefaultHomeWorkspaceId": 14,
"LastLoginDate": "2024-06-25T13:51:56.563"

(That's the Dashboard/Workspace ID for Task Management in my system.)

[StevenDavis]

Bingo. Updating both the DefaultHomeDashboardId and the DefaultHomeWorkspaceId moved the 'Default Home Page' option from 'User Selection' to 'Use a Dashboard'. I also tested in one of our sandboxes which still has the 'Use Task Driven Landing Page' option and it successfully changed that as well.

[AlexLahoski]

Awesome!  Are you using the REST API to do the updates?  I'd be interested to know how you're cycling through the user list to do the updates.

Life is slightly harder in SaaS-land to do these updates.  I never thought I'd say this, but I miss SQL Server...

[prameela]

For additional reference:
1. Blog and discussion around retirement of TDLP - https://www.archerirm.community/t5/roadmap-blogs/retiring-the-task-driven-landing-page-tdlp/ba-p/717773

2. KB article that could be helpful - https://www.archerirm.community/t5/knowledge-base/how-to-update-the-task-driven-landing-page-home-page-for-users/ta-p/737871

[AlexLahoski]

The article in #2 is great, if you are on prem (all the code given is SQL).  For those of us in SaaS, Rest API is the way...