Space banner

 

This documentation supports the 19.08 version of Remedy IT Service Management Suite.

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

Onboarding users using the BMC Remedy Smart Reporting Admin console

BMC Remedy Smart Reporting is installed with a BMC Remedy Smart Reporting Admin console that provides options to onboard and off-board users.

The following video demonstrates how to onboard users from a single company:

Before you begin

  • Read how multicompany user onboarding works.
  • If secured login (https) is enabled on the Apache Tomcat server for BMC Remedy Smart Reporting, configure the onboarding and content import links for secured login.
  • (Only for multicompany user onboarding) If you are upgrading from a previous version of BMC Remedy Smart Reporting to version 9.1.x, you must manually update the qualification criteria in a BMC Remedy AR System form after upgrade completes and before the BMC 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 BMC Remedy Smart Reporting you cannot onboard multiple customers for the same BMC Remedy AR System server. If you have already onboarded a customer, offboard the existing customer before onboarding another customer for the same AR System server. For multicompany user onboarding, you must perform the same procedure if you want to again onboard a company that you deleted earlier. For more information, see Offboarding users and clearing the database in BMC Remedy Smart Reporting.

  • If you previously deleted the client organization for a particular company manually, you must manually delete the entries for that client organization from the SmartReporting_ClientOrg_Content_Info form. For example, if you deleted the client organization clientorg, you must delete all entries that have clientorg in the Client Org Name field of the SmartReporting_ClientOrg_Content_Info form.

  • If you previously uninstalled BMC Remedy Smart Reporting and then reinstalled it by pointing to the same BMC Remedy AR System server, ensure that you delete all entries from the SmartReporting_ClientOrg_Content_Info and SmartReportingServer_Info forms, before you start the user onboarding process. You must do this as a cleanup process; it does not apply if you are upgrading BMC Remedy Smart Reporting from a previous version.

To onboard users in BMC Remedy Smart Reporting

  1. Log in to the BMC Remedy Smart Reporting Admin console as the BMC Remedy Smart Reporting super admin user. By default, the URL is http://<Reporting Server HostName>:<port>/AdminConsole/#.

  2. From the Services section, select Customer Onboarding and then select Onboard new customer.

  3. Consider the following scenarios:

    1. If BMC Remedy IT Service Management is installed, then depending on your deployment scenario, select Single Company User On-boarding or Multi Company User On-boarding to open the Onboarding Type tab.

    2. If BMC Remedy IT Service Management is not installed, then the "Single Company Users" Onboarding Type is automatically selected and the Customer details tab is displayed.

    Enter the following details for onboarding the customers:

     Click here to expand...

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

    Select On-boarding Type

    Applies to:

    • Single Company Users - onboard one company at a time
    • Multi Company Users - onboard multiple companies in bulk


    (Only if BMC Remedy IT Service Management is installed) For BMC Remedy IT Service Management multicompany onboarding scenario, select if you want to onboard users from one company at a time or from multiple companies  in bulk.

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

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

    Identifier for the BMC Remedy AR System Server of the Customer for whom you are onboarding the data.

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

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

    Note: The Customer Name should be in lower case, without any special characters.

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

    Select user creation filter criteria

    Applies to:

    • All users:
    • Users from selected groups(s)

    You can either onboard all users from BMC Remedy AR System into BMC Remedy Smart Reporting, or you can select specific groups from which you want to onboard the users. For more information, see User Creation Filter Criteria.

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


    AR Groups

    Applies to:

    • single company user onboarding
    • multi company user onboarding - one company at a time

    Criteria to filter and onboard only specific users from selected BMC Remedy AR System groups.

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


    Notes
    :Select one or more groups.

    • The user onboarding webpage displays the list of BMC Remedy AR System groups only after it authenticates and connects to the AR System server. You must enter correct AR System server details. Enter the value of BMC 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 BMC Remedy AR System groups using the CSV file .
    Calendar Viewer, Config Master, Admin

    Select Company

    Applies to:

    • multi company user onboarding - one company at a time


    Company for which you want to onboard the users.

    Select a company to be onboarded.

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

    Calbro Services

    Select CSV File

    Applies to:

    • multi company user onboarding - multiple companies in bulk


    A CSV file that contains one entry for each company to be onboarded. For more information, see Onboarding multiple companies in bulk.

    Browse and upload the CSV file.

    Note: Make sure that the timezone that you enter in the CSV file is a Java supported timezone code. 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

    Time Zone Region

    Applies to:

    • Single and multicompany users
    • Multicompany bulk onboarding

    In BMC 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.

    Starting from version 9.1.03, BMC Remedy Smart Reporting administrator can specify the default time zone for all users of a client org 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 org.

    • Select the Time Zone Region of the customer.
    • For multicompany bulk onboarding, a CSV file is used to specify the company-specific data for all companies. As CSV format represents tabular data in plain text, 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 BMC 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. 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 BMC Remedy Smart Reporting User Sync utility.

        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 BMC 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

    BMC Remedy Smart Reporting Administrator
    Username
    and
    BMC Remedy Smart Reporting Administrator Password

    User name and password of the BMC Remedy Smart Reporting super administrator.

    The default super administrator name is siadmin.

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

    User name: siadmin

    Password: siadmin

    Assign an existing BMC Remedy AR System Server user as the Reporting Administrator

    Applies to:

    • single company user onboarding
    • multi company user onboarding - one company at a time
    User ID of the BMC Remedy AR System user who will be the BMC 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 multi company 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

  4. Click Next. For multi company 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 BMC 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.

  5. For multi company user onboarding, the Continue button is enabled only when all the company data in the CSV file is valid. If the data is invalid, you must view the smartreporting.log file, correct the data in the CSV file, and then run the onboarding process again.

  6. (Optional) Click Check Progress to check the onboarding status.

  7. 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 <Smart_reporting_install_location>/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, you must 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, you must 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.

User creation filter criteria in onboarding

The user creation filter criteria works in the following manner:

  • The BMC 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 in all BMC Remedy AR System groups are onboarded.
  • When you apply BMC Remedy AR System groups as a filter criteria users that fulfill all of the following criteria are onboarded:
    • Licence type: Fixed, Floating, or Bundled
    • Status: Current
    • Group membership: The selected BMC Remedy AR System group

The user creation filter criteria is applicable to single company onboarding and multi-company onboarding.

Onboarding multiple companies in bulk

The file contains comma separated values of the company name, user name of reporting administrator for that company, and BMC Remedy AR System groups set as the filter criteria. The entries in the CSV file must have the following format:

  • For a single BMC Remedy AR System group set as a filter criterion—<companyname>,<username>,<AR Group;>
  • For multiple BMC Remedy AR System groups set as filter criteria—<companyname>,<username>,<AR Group 1;AR Group 2; ... ;AR Group N;>

You must add an entry for one company on one line in the CSV file. Note the following points about the CSV file:

  • Adding BMC 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 BMC 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 BMC Remedy AR System group that you select.
  • Do not add any spaces between the input parameters in the CSV file.
    Sample CSV file

Where to go from here

Importing out-of-the-box content in BMC Remedy Smart Reporting

Creating a view


Related topics

Troubleshooting Onboarding and Import content

Offboarding users and clearing the database in BMC Remedy Smart Reporting

Updating the AR System group filter criteria

Updating the qualification criteria for multicompany user onboarding for upgrade scenarios


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

Comments

  1. Dmitry Baryshnikov

    Hi! All the hyperlinks in the "Before you begin" section are not working or misleading. Please correct it to the good ones.

    Nov 22, 2019 01:52
    1. Vrishali namdev Galinde

      Hello Dmitry,

      Thank you for pointing this out and apologies for the inconvenience caused. I have fixed all the broken links.


      Thanks & Regards,

      Vrishali

      Dec 03, 2019 12:28