RapidIdentity Administrators' and Users' Guide

Create and Modify ROI Types

ROI Types need to be created before ROI charts can be constructed. The type ID and monetary value can be configured based on the necessary system events.

Below are instructions on how to create, modify, or delete an ROI Type.

Create an ROI Type

Follow these steps to create an ROI Type:

  1. Log into RapidIdentity via a web browser: https://[your-host-name] or if you are already logged in, navigate to the Dashboard module from the top navigation drop-down list.

    Note

    This is the landing page upon logging in.

    1.jpg

  2. Select Graphs from the settings cog icon located on the top right corner.

    2.jpg

  3. Click on the Types tab in the Graphs & Types Settings.

    Types.jpg

  4. Click on Add ROI Type.

    Add_ROI_Type.jpg

  5. Fill in the appropriate fields:

    ROI_Type.jpg

    1. Specify the ID for the ROI Type whose tally will be incremented.

      Note

      A custom ROI event can be created with a naming convention similar to "dss.createSchoologyAccount" in Connect. This ID will be used to call incrementROITally (see example below).

    2. Enter the name that will be displayed for the ROI Type.

    3. Enter the amount of money associated with the ROI Type. This number will be used to calculate ROI per event.

    4. Click Save.

Modify or Delete an Existing ROI Type

The name and monetary value can be modified for existing ROI Types. They can also be deleted.

Follow these steps to modify or delete an ROI Type:

  1. Log into RapidIdentity via a web browser: https://[your-host-name] or if you are already logged in, navigate to the Dashboard module from the top navigation drop-down list.

    Note

    This is the landing page upon logging in.

    1.jpg

  2. Select Graphs from the settings cog icon located on the top right corner.

    2.jpg

  3. Click on the Types tab in the Graphs & Types Settings.

    Types.jpg

  4. Select the appropriate ROI Type from the list.

    ROI_Types_List.jpg

  5. Perform the necessary changes and click SAVE.

    Note

    To delete an ROI Type, click on DELETE from this area and click on Yes to confirm.

incrementROITally

Increment the tally for a user-defined ROI Type

Property

Value

Description

connection*

expression, variable

the Portal connection definition

roiTypeId*

choice (dss.addDistributionListMember, dss.addGroupMember, dss.changePassword, dss.createAccount, dss.createDistributionList, dss.createGroup, dss.createMailbox, dss.deleteAccount, dss.deleteDistributionList, dss.deleteGroup, dss.deleteMailbox, dss.disableAccount, dss.disableMailbox, dss.enableAccount, dss.enableMailbox, dss.moveAccount, dss.moveDistributionList, dss.moveGroup, dss.removeDistributionListMember, dss.removeGroupMember, dss.renameAccount, dss.renameDistributionList, dss.renameGroup, dss.updateAccount, dss.updateDistributionList, dss.updateGroup, dss.updateMailbox) text, expression, variable

the ID of the ROI Type whose tally should be incremented

Note

For custom ROI types, select the "text" type input option to enter the custom ID (example: "dss.createSchoologyAccount").

count

expression, variable

the number of tallies to generate (must be > 0). The default value is 1 if no value is provided

returnVariable

expression, variable

name of the variable to be assigned to the return value

Example

roiTally = incrementROITally(connection, "<roiTypeId>")
log("ROI incremented = " + roiTally, "green")
In this section: