RISC Portal User Administrators Guide

Modified on Fri, 15 Mar 2024 at 02:30 PM

Contents

1.      Introduction to RISCPortal 1

2.      Login4

3.      For Fulcrum Administrators4

3.1        Add Agency4

3.2        View/Edit Agency Details and Delete Agency7

a.      About7

b.      Devices7

c.      Delete Agency8

d.      SFTP.. 9

3.3        Fulcrum Employee11

a.      List of Users11

b.      List of Users. Click the Add User button (A)11

c.      Delete Fulcrum Employee / Super admin user. 12

3.4        Agency Users13

a.      Search Agency13

b.      View/Edit Agency User14

3.5        Agency Settings14

a.      Search Agency14

b.      View/Edit Agency Settings15

a.      Setup/View/Edit Encryption and Decryption Key15

b.      OTP Settings15

c.      Policy Parameters16

3.6        Audit Logs17

3.6 Filter18

 

 
 

 

  1. Introduction to RISCPortal

 

RISCPortal is designed to provide users with the ability to manage their agencies and user accounts. With its user management capabilities, the website allows users to easily manage their accounts, including user creation, OTP generation that is used by the mobile app, and encryption and permissions management. The agency management capabilities allow users to manage their agencies, including creating and managing agency accounts, assigning agency roles, and monitoring agency usage. The portal is built with the latest technology to ensure that user data is secure, and the experience is seamless.

 

Feature

Description

Authentication

Access to the RISCPortal site is restricted to super admin / agency admins only.

Agency Management

Agency admins have the ability to add, update, and delete agencies.

User Management

Agency admins can create, update, and delete users.

Agency Settings

Agency admins can configure various settings for each agency.

Audit Logs

Agency admins can view user activities, such as login times and transaction histories. They can also monitor the progress of each EBTS transaction, checking if it is ongoing or completed.

 

 

 

 

 

 

 

Network Diagram:

A diagram of a computer

Description automatically generated

 

 

  1. Login

  2. Input the email address and password provided by the portal administrator to login. 
      

 

  1. For Fulcrum Administrators

    1.  Add Agency

  2. In the Agency tab (A), tap on ADD AGENCY (B). A form will appear.

A screenshot of a computer

Description automatically generated 

  • Enter the necessary agency details and tap NEXT (A). Once the required fields are filled out, create the agency by tapping CREATE (B).   

A screenshot of a computer

Description automatically generated A screenshot of a computer

Description automatically generated

 

 

A screenshot of a computer

Description automatically generated

  • If the agency is created successfully, the agency list is updated with the new agency.
  • If there are errors in the agency creation (e.g., the ORI already exists in the database), the error will be displayed above ADD AGENCY
    1.  View/Edit Agency Details and Delete Agency

A screenshot of a computer

Description automatically generated

A screenshot of a computer

Description automatically generated

In the Agency tab (A), the list of Agencies is displayed. Tap on an agency to view/edit its details (B).

 

B

  

A screenshot of a computer

Description automatically generated

  1. About

This section contains the agency information details. To update, tap on the EDIT () icon and an update form will appear.  

A screenshot of a computer

Description automatically generated

  1. Devices

This section shows a list of devices (A) that are registered in an agency.

 

A

  

 

B

C

  
A screenshot of a computer 

 

  1. Generate an OTP to Activate a Device using the RISCMobile Android App

 

  • Tap ACTIVATION OTP (B), a popup will appear. Tap NEW.

A screenshot of a device

Description automatically generated

 

 

 

 

 

 

 

 

 

  • A 6-digit OTP is generated which will expire in 5 minutes.

A screenshot of a device activation program

Description automatically generated

 

 

 

  1. Delete Agency

To delete an Agency, click the Delete icon at the right-hand side of the screen (A). Remember that an agency can only be deleted when there’s no user on that agency.

 

A

  

 

 

 

 

  1. SFTP

This section contains the SFTP setup for the Agency. Fill in the necessary fields and tap UPDATE (D).

User and Password: to be used to authenticate to the SFTP Server

            Host and Port: host and port of the SFTP server

            Input Path: a path on the SFTP server where transactions from the RISC              mobile app will be uploaded.

            Output Path: A path for storing the output transaction response.

 

A screenshot of a computer

Description automatically generated

 

 

 

 

 

 

 

 

 

 

 

  1.  Fulcrum Employee

  1. List of Users

  2. List of Users.
     Click the Add User button (A)

A screenshot of a computer

Description automatically generated

A screenshot of a computer

Description automatically generated

Fill Up the following information and click the save button.
 

A screenshot of a computer

Description automatically generated


 

  1. Delete Fulcrum Employee / Super admin user.

Click the user to be deleted in the user list table. Click the Delete button on the right-hand side of the page.

A screenshot of a computer

Description automatically generated

It will then pop-up a confirmation dialog and click Confirm.

A screenshot of a computer

Description automatically generated

  1.  Agency Users

  1. Search Agency

  2. In the Agency Users tab (A), input the Agency name in the text field (B) and tap SEARCH (C).

 

B

  

A screenshot of a computer

Description automatically generated

 

  • In the results list(A), tap on an agency to display the list of users (B)

 

AB

  

A screenshot of a computer

Description automatically generated

 

B

  

A screenshot of a computer

Description automatically generated

  1. View/Edit Agency User

Tap on a user from the User list. Refer to Section 4.1 to Add User and View/edit Agency User information.

 

 

  1.  Agency Settings

  1. Search Agency

In the Agency Settings tab (A), input the Agency name in the text field (B) and tap SEARCH (C).  From the agency list, tap on an agency to View/Edit its configuration (D).

 

B

  

A screenshot of a computer

Description automatically generated

 

D

  

A screenshot of a search engine

Description automatically generated

  1. View/Edit Agency Settings

  1. Setup/View/Edit Encryption and Decryption Key

Note: This field is not mandatory, and you can leave it blank. This Agency Encryption/Decryption keys are not related to the FBI encryptions; this is another security layer for the server / client communication encryption and decryption. Also, if you generate the keys here, your users must activate the device again.

  •  Click the Generate Button to automatically generate the secret key and iv key.
  1. OTP Settings

  • Below the Encryption/Decryption Keys section is the OTP Settings. 
  • Set “Send e-mail” to CHECKED to enable sending of the OTP to the registered user email address. The default value is UNCHECKED.
  • The OTP validity duration is the amount of time for which the OTP is valid after it has been generated. By default, the OTP is valid for 5 minutes.
  • To save any changes, tap on SAVE.
  1. Policy Parameters

  • Below the OTP Settings section is the Policy Parameters that is used by the RISCMobile Android App session.
  • Set Photo Capture to ON to enable selfie image capture when adding a transaction via the app. The default value is OFF.
  • The inactivity timeout is the duration for which the session is kept running without any user action. The session ends if the timeout is reached. The timeout resets every time there is user action. By default, the session inactivity timeout is set to 180 minutes.
  • The response timeout is the duration for which the mobile app keeps on polling for the result of a transaction. If the timeout is reached, the app stops waiting for results. By default, the response timeout is set to 5 hours (300 minutes).
  • The request timeout is the duration for which the mobile app waits for the server to respond before it is considered that the server is not responding. By default, the request timeout is set to 30 seconds.
  • The response check frequency is the interval at which the mobile app requests for the response for a transaction. By default, the response check frequency is set to 60 seconds.
  • The inactivity timeout warning message is the message that appears as an alert dialog or a notification (if the app is minimized) to warn the user that the inactivity timeout is approaching. 
  • The PIN Rules are the rules used to validate a Personal Identification Number (PIN) entered during enrollment in the mobile app.

A screenshot of a computer

Description automatically generated

A screenshot of a computer

Description automatically generated

A screenshot of a computer

Description automatically generated  A screenshot of a computer

Description automatically generated

 

  1. Audit Logs 

The audit logs are a collection of records of internal activity relating to any RISC transaction. It contains detailed historical information recorded during the occurrence of an event, the time at which it occurred, the responsible user or service, and the impacted entity. 

  • Tap on the Audit Logs tab (A) to view the logs.
  • To configure displaying more than 10 items per page click on Row per page drop down (B). You have an option to display 10, 25 or 50 items per page.
  • To navigate to different page, click the page number on the pagination bar (C)
  • To view more detailed information on each log on the list, click anywhere in the row. It will pop up a dialog box. (D) 

 

A

  

 

C

  
 

B

  
A screenshot of a computer

Description automatically generated

 

 

D

  

A screenshot of a computer

Description automatically generated

3.6 Filter 

With the help of defined filters, one can easily filter out the required information from the audit logs. These filters are based on various characteristics such as user action, audit event class, audit event subclass, and audit event fields. 

  • To add filter on the audit logs, click Add Filter button (E)

 

E

  

A screenshot of a computer

Description automatically generated

  • Options for filters are the following: User, Transaction Id, Outcome, Component and Event, Date, and Agency (for super admin account). You can combine multiple filters that suit your query needs. Example you can query a specific user and look for logs created between Nov 1 to 30 2023. 
    1. User – to query specific logs that were initiated by the username that you will enter below.

A blue and grey line

Description automatically generated with medium confidence

  1. Date – To query logs that were logged between selected from-date to end-date. 

 

  1. Outcome – To query logs that are either successful or a failure. 

 

  1. Component and Event – Each log is part of a component and event. In this way it is easier to locate the logs to which component and event they are being executed. If something unusual happens it will be easier to debug and investigate. See below table for the list of components and its events with their description.

 

Component

Event

Job Upload – A job that will get trigger every 30 seconds and look for a pending transaction to be uploaded to sftp server. This will insert a message to queue for upload function to trigger

  1. Job Failed – this entails that the job fails.
  2. Job Ongoing – this entails that the job is currently being processed.
  3. Job Success – this entails that the job is successfully executed.
  4. Job Exception Occurred – this entails that the job execution encountered an exception.

Job Check Ebts – A job that will get trigger every 30 seconds and look for any transaction that are waiting for a transaction output from the sftp server.

Function Upload – An azure function that will trigger when a message is inserted to the upload queue (these messages are being inserted by the jobs). When function found a message (the message is simply the transaction id of the request) in a queue, it will then look for the request ebts data and upload it to the input folder of the sftp server configured by the agency administrator.

  1. Func Failed – this entails that the function failed.
  2. Func Ongoing – this entails that the function is currently processing the task.
  3. Func Success – this entails that the function successfully executed the task.
  4. Func Exception Occurred – this entails that the function encountered an exception.

 

Function Download – An azure function that will trigger when a message is inserted to the download queue (these messages are being inserted by the check ebts job). When a message is found, the function will try to connect to the sftp server and find the ebts output. If found it will download the file and convert to base64 and save it to the db. Otherwise, the check ebts job will keep sending a message to download queue to keep looking for the output file.

Agency Management – This component involves around agency management data updates. (Section 3)

  1. Create Agency – when an agency is successfully created.
  2. Update Agency – when an existing agency is being updated.
  3. SFTP Update – when the sftp configuration is being updated.

Agency Settings – Section 4.2

  1. Update Crypto Key – when the encryption/decryption keys are being generated/re-generated.
  2. Update Otp Settings – when otp setting is being updated.
  3. Update Policy Parameter Settings – when policy parameter is being updated.

User Management 

For Super Admin – section 3.3

For Agency Admin – section 4.1

  1. User Info Update – when a user info is being updated.
  2. User Enrollment – when a user is successfully enrolled using the risc mobile app.
  3. Add User – when user is being added to an agency by super admin or agency admin.
  4. Otp Generate – when an enrollment otp is generated by super or agency admin.
  5. Otp Cleared – when the generated otp is being cleared by super or agency admin.

 Device Management – Section 3.2.b

  1. Otp Generation – the super or agency admin generated an otp for device activation.
  2. Device Created – when the risc mobile user successfully activated the device.
  3. Activation Otp Expired – when user inputted an expired otp.
  4. Otp Invalid – when the user inputs an invalid otp.
  5. Activation OTP Removed – when admin cleared the generated OTP.

Ebts Transaction Management – This is the most important feature of the risc ecosystem. The events logged is triggered by the risc mobile user. (These logs are logged inside the transaction APIs)

  1. Transaction Inserted – when risc mobile user push an ebts request (this ebts request includes the subject fingerprints)
  2. Pull Transaction – the risc mobile user requested for the output of the request he/she made. 
  3. Quick Response Created – this is used for the testing environment.
  4. Transaction Deletion – when the transactions have been received by the user successfully, these transaction will be deleted immediately.

Authentication – When user calls the authentication API

  1. Login – login event will be logged every time user tries to login in the system.

System Failure – when an un-handled exception encountered by the system.

  1. Error – an error event will be logged and its stack trace to easily identify the issues/errors.
  • Click the Apply Selected Filters button once you’re done configuring the filters and it will return the filtered results.


Example result:

 

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article