Versions Compared

Old Version 2

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Nikolai Denissov

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Accounting Service is installed as part of SSO installation / upgrade. You can find instructions on how to install and upgrade Ubisecure SSO in Installation - SSO and Upgrade - SSO, respectively. Read and proceed with those instructions first.

...

  • Configuration of the Accounting Service integration in the SSO directory entry: CN=Ubisecure Accounting under CN=Services, OU=System
  • Accounting site and application in SSO directory
  • Accounting Service, which is a standalone Spring Boot application running as a service in your operating system (ubisecure-accounting), see Verify the running service below

Finalise access rights

After the installation you will have a Accounting application in SSO that you can verify and manage with Management user interface - SSO. This application controls access to the Accounting Service endpoints like reporting, see Using Accounting Service.

Figure 1. Accounting application in SSO Management

...

Note
We suggest to reconfigure the allowed users for the Accounting application in the group named Accounting Users according to your needs, see SSO Management UI Groups.

Anchor
service
service
Verify the running service

In order to verify that Accounting Service has been successfully installed or upgraded and started follow the guidelines in the subsequent sections. See Troubleshooting Accounting Service if any of the steps fail.

Accounting Service log

Verify from the application log (by default accounting/logs/ids-accounting.log under ubilogin-sso installation directory) that the service has started without errors.

...

Note

To access Accounting Service actuator endpoints you can naturally use also curl or similar tool instead of the browser. Since Accounting Service v. 2.3 (SSO v. 9.3) health check does not anymore require authentication. If you send and an authenticated request you'll get a more verbose response, see Accounting Service management / Health endpoint detailed information.


Preconditions:

  1. Accounting Service needs to be running
  2. Need to know the HTTP Basic authentication credentials, see Accounting Service management - SSO / Actuator endpoint authentication

Steps with browser:

  1. Open browser and navigate to the following path: http(s)://<host>:<port>/actuator/health

  2. Verify from the response that the overall status is 'UP'

    Figure 3. Accounting Service health check response in JSON format


    1. In normal conditions, the results result will read show "UP" and the endpoint will return a HTTP 200 error response.

    2. In error conditions, the results result will read show "DOWN" or "OUT_OF_SERVICE" and the endpoint will return a HTTP 503 error response.

If you don't perceive the expected outcome see Troubleshooting Accounting Service.

Accounting Service version info

...

  1. Accounting Service needs to be running
  2. Need to know the HTTP Basic authentication credentials, see Accounting Service management - SSO / Actuator endpoint authentication

...

Verify the functionality

See also Using Accounting Service.

Accounting Service OAuth2 authentication check

...

  1. Open browser and navigate to the following URL: https://accounting.example.com/accounting/report (the actual URL depends on your network configuration, see Network requirements)

  2. Enter the credentials in SSO

  3. A CSV download file with total of 0 users is downloaded (when this check is done before the first scheduled monthly calculation)

    Code Block
    languagetext
    titleMonthly active unique user counts empty CSV example
    Month,Authentication Method,User Count
2019-03,TOTAL,0


  4. Verify the audit log events about the access has been written, see Accounting Service logging / Audit log

If you don't perceive the expected outcome see Troubleshooting Accounting Service.

Verify SSO event recording in the Accounting Service

...

  1. Authenticate into some other SSO managed application than Accounting and preferably with some other user or other authentication method than password
  2. Open browser and navigate to the following kind of URL: https://accounting.example.com/accounting/verify/events/<yyyy-MM-dd> where <yyyy-MM-dd> is replaced with the current date, see Using Accounting Service

  3. Enter the credentials in SSO

  4. A CSV download file with an event for each authentication on that day is downloaded, the last row shows the last event

    Code Block
    languagetext
    titleDaily successful authentication events CSV example
    Timestamp,Authentication Method,Pseudonymised User ID
2019-03-15T09:09:00Z,PASSWORD,3b4e5ba2d62e69b6de6730d407f94c999b01c17e10b0d110ed98dfffcbd92191


If you don't perceive the expected outcome see Troubleshooting Accounting Service.