Onboarding users by using the Remedy Smart Reporting Admin console
Remedy Smart Reporting is installed with a separate Remedy Smart Reporting Administration console that provides options to onboard and offboard users.
The following video demonstrates how to onboard users from a single company:
This topic discusses how to onboard users. See also the following subtopics:
Before you begin
- If secured login (https) is enabled on the Apache Tomcat server for Remedy Smart Reporting, configure the onboarding and content import link for secured login.
(Optional) Set the default role of the users. For more information, see Setting the default role.
(For multicompany user onboarding only) If you are upgrading from a previous version of Remedy Smart Reporting to version 9.1.x, manually update the qualification criteria in a Remedy AR System form after upgrade completes and before the Remedy Smart Reporting User Sync (User Sync) utility runs. Otherwise, users from the companies that you onboarded in previous versions are deleted after User Sync utility runs.
In Remedy Smart Reporting, you cannot onboard multiple customers for the same Remedy AR System server. If you have already onboarded a customer, offboard the existing customer before onboarding another customer from the same AR System server. For multicompany user onboarding, perform the same procedure if you want to onboard a company that you deleted earlier. For more information, see Offboarding users and clearing the database in Remedy Smart Reporting.
If you previously deleted the client organization for a particular company manually, manually delete the entries for that client organization from the SmartReporting_ClientOrg_Content_Info form. For example, if you deleted the calbro_org client organization , you must delete all entries that have calbro_org in the Client Org Name field of the SmartReporting_ClientOrg_Content_Info form.
- If you previously uninstalled Remedy Smart Reporting and then reinstalled it by pointing to the same Remedy AR System server, perform a cleanup. Before you start the user onboarding process, delete all entries from the SmartReporting_ClientOrg_Content_Info and SmartReportingServer_Info forms. (This cleanup process does not apply if you are upgrading Remedy Smart Reporting from a previous version.)
To onboard users
- Log in to the Remedy Smart Reporting Administration Console as a Smart Reporting super administrator (siadmin).
The path to the console is http://RemedySmartReportingServerHostName:port/AdminConsole/#. From the Services section, select Customer Onboarding > Onboard new customer.
Consider the following scenarios:
If Remedy IT Service Management is installed and depending on your deployment scenario, select Single Company User On-boarding or Multi Company User On-boarding to open the Onboarding Type tab.
- If Remedy IT Service Management is not installed, Single Company Users is automatically selected on Onboarding Type tab, and the Customer details tab is displayed.
Enter the following details for onboarding the customers:
Click Next.
For multicompany user onboarding (multiple companies in bulk), the interface displays a summary of the CSV file. The summary lists the following items:
Invalid data such as companies or users not available in Remedy AR System and users not present in the selected AR Groups
Missing company names and user names
A list of companies that are already onboarded
Click Continue to begin the onboarding process.
For multicompany user onboarding, the Continue button is enabled only when all the company data in the CSV file is valid. If the data is invalid, view the smartreporting.log file, correct the data in the CSV file, and then run the onboarding process again.
(Optional) Click Check Progress to check the onboarding status.
When the onboarding is complete, the interface displays a confirmation message.
In multi company user onboarding (multiple companies in bulk), if some companies fail to onboard, the entire onboarding process does not roll back. Instead, the onboarding process displays an error message on the summary screen. For details about companies or users that failed to onboard, see the RemedySmartReportingInstallLocation/SmartReporting/appsserver/logs/smartreporting.log file.
If you modify the role of an already onboarded user to a CMDB user after the onboarding process is complete, manually change the role of that user to Dashboard Consumer after the User Sync utility runs.
If you want to onboard users from a different AR Group after you have completed the onboarding of a company, update the filter criteria manually. When the User Sync utility runs, users belonging to the new filter criteria are onboarded. For more information, see Updating the AR System group filter criteria.
How user creation filter criteria works in onboarding
The user creation filter criteria works in the following manner:
- The Remedy AR System groups filter criterion lists all the groups that are available in the Group form, except the Computed group.
- You can select multiple groups; however, if you do not select any groups, users from all Remedy AR System groups are onboarded.
- When you apply Remedy AR System groups as a filter criteria, users that fulfill all of the following criteria are onboarded:
- License type: Fixed, Floating, or Bundled
- Status: Current
- Group membership: The selected Remedy AR System group
The user creation filter criteria is applicable to single company onboarding and multicompany onboarding.
Onboarding multiple companies in bulk
The CSV file for onboarding multiple companies contains:
- Comma-separated values of the company name
- User name of reporting administrator for that company
- Remedy AR System groups set as the filter criteria
The entries in the CSV file must have the following format:
- For a single Remedy AR System group set as a filter criterion—companyName,userName,AR Group;Timezone
- For multiple Remedy AR System groups set as filter criteria—companyName,userName,AR Group 1;AR Group 2; ... ;AR Group N;Timezone
You must add an entry for one company on one line in the CSV file. Note the following points about the CSV file:
- Adding Remedy AR System groups as filter criteria is optional. If you do not add any groups, users from all groups who match the default License Type and Status filter criteria are onboarded.
When you add any groups as filter criteria, only the users of the selected group that have a Fixed or Floating license and the Current status are onboarded. - The companyName that you specify must be one of the supported company types.
- The userName that you specify must be the Remedy Smart Reporting Administrator. For a company, you can assign only one user as the reporting administrator. Thus, the CSV file contains only one userName record per company. All other users for that company are automatically onboarded, based on their License Type, Status, and the Remedy AR System group that you select.
- Do not add any spaces between the input parameters in the CSV file.
See the attached Sample CSV file.
Comments
When onboarding users in bulk, it appears in the tool as if the .csv file should also include a 4th column for timezone (Timezone is included in the confirmation screen). And if not, how are the timezones for each client organization specified?
Hi Vrishali
You are misunderstanding my comment. The CSV file SHOULD include a column for timezone. You have just left it out of the documentation. I do not see a way to attach an image here, so I will send it to you separately in an email, - Please look for my screenshot from within the tool which describes the formatting of the CSV file. Thank you very much for your time.
Hello Lindsay Barrett,
Thank you for pointing this out. I have updated the documentation based on your inputs.
Thanks & Regards,
Vrishali
Thank you, Vrishali!
Log in or register to comment.