Configuring environment settings

1. REST API should be accessible on AR server for HTTP and HTTPS.
2. For HTTPS, there are two scenarios : Only AR server HTTPS configuration or AR server HTTPS configuration with RSSO.
3. The AR user should have following permissions for fetching the user records from REST API + CTM:People Form:
   
   1. As an administrator, log in to the AR Server.
   2. On the Home page, select Administrator Console > Application Administration Console.

   3. To open the CTM:People form, on the Application Administration Console page, click the View link corresponding to the People option.
      The CTM:People form opens with user records.

   4. From the user records table, select a single user whose permissions you want to update.

   5. Click the Login/Access Details tab.

   6. Navigate to Access restriction tab.
   7. Select the Unrestricted Access check box.
   8. Click Save.
4. If AR server is connected to the load balancer, which is in turn configured with HTTPS protocol and RSSO server, then the JWT access should be enabled is the prerequisites for AR server REST API consumption.
   For more information, see Everything that you need to know about accessing new CMDB UI.
   

   For an RSSO enabled server, the entry is must be: /api/jwt/login*

   Frequently asked question
   Customer’s REST APIs stopped working after SP4 in RSSO environment. What do I do?

   When you enable RSSO for AR, Jetty also gets enabled with RSSO (as Jetty is embedded in AR and the REST API runs on Jetty), which results in failed REST API calls due to redirection to RSSO.

   In such case, the exclude url in the server’s rsso-agent.properties file must contain /api/jwt/login* so that the existing REST APIs are not redirected to RSSO.
   Given below is a sample patter of the exclude url:

   excluded-url-pattern=.*\\.xml|.*\\.gif|.*\\.css|.*\\.ico|/shared/config/.*|/WSDL/.*|/shared/error.jsp|/shared/timer/.*|/shared/login_commn.jsp|/shared/view_form.jsp|/shared/ar_url_encoder.jsp|/ThirdPartyJars/.*|/shared/logout.jsp|/shared/doc/.*|/shared/images/.*|/shared/login.jsp|/services/.*|/shared/file_not_found.jsp|/plugins/.*|/shared/wait.jsp|/servlet/GoatConfigServlet|/servlet/ConfigServlet|/shared/HTTPPost.class|/shared/FileUpload.jar|/BackChannel.*|/servlet/LicenseReleaseServlet.* |/api/jwt/login*

5. The REST API generally runs on 8008 port for HTTP and 8443 port for HTTPS. You must confirm these ports on the Jetty server entry and make sure that these ports are free.
   You can configure the servername:8008 AR server so that it has both HTTP and HTTPs protocols enabled.
   
   Example for AR REST API access:
   http://servername:8008/api/jwt/login
   https://servername:8443/api/jwt/login
   
   Example for accessing CTM:People form
   http://servername:8080/arsys/forms/servername/CTM%3APeople/Default+User+View

• Ensure that the BMC Discovery environment is configured with HTTPS.
• Ensure that the BMC Discovery credentials have administrative rights to collect the BMC Discovery license information.
• For BMC Discovery version 11.1, users need to have API access permission to query and get data.

• For BMC Discovery version 11.2.x and later, enter the user with Rest API and license data permission over HTTPS. Do not use the system user.

  • User should be part of the api-access group.
  • User needs the api/license_data permission.
    For example, select Administration > Groups > Action > Edit, on the api-access group, add the api/license_data permission.

UNIX

1. Ensure that the SSHD process is running on the respective port.

Windows and UNIX

Identify the servers where BMC Server Automation (BSA) Appserver is installed. 

Windows

Ensure that the NSH folder is in the system path. 

UNIX

Ensure that the SSHD process is running on the respective port.

Windows and UNIX

1. For UNIX, ensure that the SSHD process is running on the respective port.
2. Identify the servers where the BMC Performance Manager Portal database is installed.
3. Ensure that, on the Oracle database server, either the ORACLE_BASE or the DATASTORE_HOME environment variable is set.
   The License Utility will check for these two environment variables.
4. For Windows, ensure that %ORACLE_BASE%\utility\BPM_Datastore_Utility or %DATASTORE_HOME%\utility\BPM_Datastore_Utility exists and is accessible.

   For Unix, ensure that $ORACLE_BASE/utility/BPM_Datastore_Utility or $DATASTORE_HOME/utility/BPM_Datastore_Utility exists and is accessible.

While configuring the BMC Performance Manager Portal, ensure that the following tasks as complete:

• SQL Plus is invoked and running with the database user that is provided on the BMC License Usage Collection Utility.
  To verify that SQL Plus is invoked, ensure that the tnsnames.ora file is present with correct instance names of the BMC Performance Manager Portal database configured.
• For UNIX, you have Bash shell installed on the machine where you have the BMC Performance Manager Portal database.

Windows

Ensure that the "ORACLE_BASE or DATASTORE_HOME " environment variable is set for the logged-in user (Server user field value) on that server.

UNIX

1. Ensure that the "ORACLE_BASE or DATASTORE_HOME " environment variable is set in the “. profile” file for the logged-in user (Server user field value) on that server.
2. Make sure one of the following files has the execute permission:
   1. $ORACLE_BASE/utility/BPM_Datastore_Utility/DatastoreCliBMCPDS.sh
   2. $DATASTORE_HOME/utility/BPM_Datastore_Utility/DatastoreCliBMCPDS.sh 
3. If not, assign the permission using the following command: chmod +x DatastoreCliBMCPDS.sh.

Windows

1. Identify the server where Remedy AR System Server (ARS) is installed.
2. Ensure that the "BMC_AR_SYSTEM_HOME" environment variable is set on that server.

UNIX

1. Ensure that the SSHD process is running on the respective port.
2. Ensure that the user whose credentials are being used by the License Utility to connect to this server has BMC_AR_SYSTEM_HOME mapped to the correct directory and exported in the .profile file. For example:  Export BMC_AR_SYSTEM_HOME=/<dir1>/<dir2>/ARSystem
3. Ensure that the non-root user as read access permission for the $BMC_AR_SYSTEM_HOME/db/LicenseReport.txt file.
4. If the BMC_AR_SYSTEM_HOME variable is not set:
   1. Log in to the Unix machine with the user name and credentials used in the "Server User" and "Server password" fields on the License Utility UI while adding the deployment.
   2. Copy the script from location:"<LU_Install_Directory>/licenseusagecollector/EnvVariableScripts" to the Unix machine.

   3. Give execute permission to the script using chmod +x <scriptname>.

   4. Execute the script.
      
      

       Sample run...