This documentation supports the 20.02 version of Remedy Smart Reporting.

To view an earlier version, select the version from the Product version menu.

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:

 https://youtu.be/rvRHwk1Lp7w

This topic discusses how to onboard users. See also the following subtopics:

Before you begin

  • Read how multicompany user onboarding works.

  • 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

  1. 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/#.
  2. From the Services section, select Customer Onboarding > Onboard new customer.

  3. 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.
  4. Enter the following details for onboarding the customers:

     Click here to expand...

    Field nameDescriptionExample value
    AR System server details tab
    AR System server host nameHost name of the Remedy AR Server you are onboarding.ars-srv
    AR System server portPort number defined for the Remedy AR Server.0
    AR System server administrator
    username
    User name of the Remedy AR System Server administrator. The user can be any user defined as an administrator on the Remedy AR System server.Allen
    AR System administrator
    password
    Password of the Remedy AR System user.password
    Onboarding type tab

    Select On-boarding Type



    The type of onboarding you want to perform:

    • Single Company Users—Onboard one company at a time
    • Multi Company Users—Onboard multiple companies in bulk

    The tab and options appear if Remedy IT Service Management is installed. For Remedy IT Service Management multicompany onboarding scenario, select whether you want to onboard users from one company at a time or from multiple companies  in bulk.

    Note: If Remedy IT Service Management is not installed, the Customer details tab is displayed.

    • Single company at a time
    • Bulk
    Customer details tab
    Customer Name

    Remedy AR System Server identifier of the customer for whom you are onboarding the data.

    At the time of onboarding, you can provide a name to distinguish among the Remedy AR System servers in your environment.

    In a Remedy IT Service Management multicompany environment, run the onboarding process for each company defined in the Remedy ITSM environment.

    Note: The Customer Name should be in lowercase without any special characters.

    If you are onboarding data for Calbro Services, the Customer Name for a Remedy AR System server in the development environment could be calbroservicesdev, and the name for a server in the production environment could be calbroservicesprod.

    Select user creation filter criteria

    You can onboard all users from Remedy AR System into Remedy Smart Reporting, or you can select specific groups from which you want to onboard the users. For more information, see "How user creation filter criteria works in onboarding" below.

    Note: This field is displayed only if you have Remedy IT Service Management installed on the AR System Server.


    AR Groups

    Criteria to filter and onboard only specific users from selected Remedy AR System groups. This field is visible only if you have Remedy IT Service Management installed on the AR System Server.

    This field applies to:

    • Single company user onboarding
    • Multicompany user onboarding—one company at a time

    Notes:

    • The user onboarding webpage displays the list of Remedy AR System groups only after it authenticates and connects to the Remedy AR System server. You must enter correct Remedy AR System server details. Enter the value of Remedy AR Server Administrator Password and press Tab to view the AR Groups list.
    • For multicompany user onboarding (multiple companies in bulk), you can enter the Remedy AR System groups using a CSV file.
    Calendar Viewer, Config Master, Admin

    Select Company


    Company for which you want to onboard the users. This field applies to multicompany user onboarding, one company at a time.

    Note: The Select Company drop-down list displays only those companies that belong to the supported company types.

    Calbro Services

    Select CSV File


    A CSV file that contains one entry for each company to be onboarded. This field applies to multicompany user onboarding when you are onboarding multiple companies in bulk. For more information, see How multicompany user onboarding works.

    Note: Make sure that the timezone that you enter in the CSV file is a timezone code that Java supports. For the list of supported timezones, see the attached excel sheet.

    Calbro Services,Allen,Public;Administrator;

    Invention Inc,Daniel,Administrator,AMERICA/CHICAGO



    Time zone details tab

    Time Zone Region

    In Remedy Smart Reporting, specifying the time zone for users is essential when working with business-time related calculations. For example, time zone is considered to evaluate the status of a Service License Agreement.

    The Remedy Smart Reporting administrator can specify the default time zone for all users of a client organization while onboarding them from a single company or multiple companies (individually or in bulk).

    Specifying the time zone while onboarding sets the default time zone for all users of a client organization.

    • Select the Time Zone Region of the customer.
    • For multicompany bulk onboarding, use a CSV file to specify the company-specific data for all companies. CSV format represents tabular data in plain text, so the CSV file contains an additional column Time zone in which you can mention the time zone region and time zone. For example, AMERICA/CHICAGO.

       Time zone considerations
      • The time zone specified for a user on the Locale tab of AR System User Preference form always takes precedence.
      • If a time zone is not specified on the Locale tab of AR System User Preference form and in Remedy Smart Reporting, GMT is considered as the default time zone for a user.
      • The time zone specified for users during the onboarding process is considered only when the time zone is not specified on the Locale tab of AR System User Preference form.
      • After the onboarding process is completed, users can update their preferred time zone on the Profile Settings page. (For more information, see the  Profile Settings in the Yellowfin documentation.) However, this time zone is overwritten by the time zone specified on the Locale tab of AR System User Preference form when you run the Remedy Smart Reporting User Sync utility.

        Best practices

        BMC recommends that you always update your preferred time zone on the Locale tab of AR System User Preference form so that the time zone remains the same even after running the Remedy Smart Reporting User Sync utility. For details about how to specify the time zone for a user in the AR System User Preference form, see Setting the Locale tab .

    Time Zone Region: AMERICA Time Zone: Chicago(-6:00)

    Note: -6:00 indicates GMT-6:00.

    Smart Reporting Details tab

    Remedy Smart Reporting Administrator
    Username
    and
    Remedy Smart Reporting Administrator Password

    User name and password of the Remedy Smart Reporting super administrator. The default super administrator name is siadmin.

    Note: Change the default password after you install Remedy Smart Reporting. For more information, see Changing the Remedy Smart Reporting super admin password after installation.

    User name: siadmin

    Password: siadmin

    Assign an existing Remedy AR System Server user as the Reporting AdministratorUser ID of the Remedy AR System user who will be the Remedy Smart Reporting Administrator.
    • For single company user onboarding, this user must belong to the AR System server for which you are onboarding. 
    • For multicompany user onboarding (one company at a time), this user must belong to the company for which you are onboarding.

    Note: For multicompany user onboarding (multiple companies in bulk), this field is not available. You can specify the name of the reporting administrator in the CSV file.

    Bob

  5. 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

  6. 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.

  7. (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.

Where to go from here

Importing out-of-the-box content

Creating a view of database tables and fields

Was this page helpful? Yes No Submitting... Thank you

Comments

  1. Lindsay Barrett

    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?

    Jul 27, 2020 08:32
    1. Lindsay Barrett

      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.

      Aug 11, 2020 03:41
      1. Vrishali namdev Galinde

        Hello Lindsay Barrett,

        Thank you for pointing this out. I have updated the documentation based on your inputs.


        Thanks & Regards,

        Vrishali

        Aug 21, 2020 12:18
        1. Lindsay Barrett

          Thank you, Vrishali!

          Aug 21, 2020 07:44