1. API Guide
  2. ISR FACE
  3. Oracle Communications Interactive Session Recorderi FACE

Oracle Communications Interactive Session Recorderi FACE

The Oracle Communications Interactive Session Recorderi supports FACE. FACE is a feature for the aggregation and control of events. It is a centralized component used to control both Oracle Communications Interactive Session Recorderi and integrated third-party services. It can also retrieve audio, video, and detailed metadata for recordings stored in the Oracle Communications Interactive Session Recorderi. The initial third-party integration is with the ObserveIT Visual Session Recording solution. This provides the key activities necessary for desktop screen capture and for associating the captured screens to related audio recordings.

The controls currently available include full recording control (start, stop, split, pause, and resume, where split stops recording the current segment and starts recording a new segment, and where pause and resume can aid in the omission of sensitive information from the recording), retrieval of recorded files and metadata, as well as starting and stopping screen capture on an ObserveIT agent host. FACE also supports a policy system allowing incoming events to trigger actions, with the current set of actions dedicated to screen capture control.

The Oracle Communications Interactive Session Recorderi FACE contains the following components:
  • FACE Policy System—Handles automatic actions for specific Oracle Communications Interactive Session Recorderi events.
  • External Event Notification Listener—Receives events from Oracle Communications Interactive Session Recorderi components and passes them to Policy System.
  • FACE REST API—API for communication and control of Oracle Communications Interactive Session Recorderi components.

For more information on ISR FACE, see the API Reference Guide.

Creating an API User

In order to use the audioRecording commands of the FACE REST API, you must create an API User via the Dashboard.

To Add an API User:

  1. After logging into the Oracle Communications Interactive Session Recorderi Dashboard, click Admin in the main menu (or Edit System Configurations on the Home page).
  2. Click Users.
    The Users page displays.
  3. Click New User
    The New User page displays. The New User screenshot shows the new user window and includes Account, Name, Email, Password, Confirm Password, Preferred Time Zone Locale, and Type of User.
  4. Enter the relevant Account, Name, Email, Password, and Preferred Time Zone Locale for the User.
  5. Type of User—Select API User from the dropdown menu.
  6. Click Create.

    For more information on configuring Users, see "Managing Users" in the Oracle Communications Interactive Session Controller Administrator Guide.

    Note:

    Your API User password will expire based on the value you configure in the Dashboard Security Settings Users Password Expires in parameter. When the API User password expires, the FACE API client application/s will no longer be authorized for requests until the password has been changed and reflected accurately in the client user's password configuration. For more information on configuring Dashboard Security Settings, see "Managing User Dashboard Security Settings" in the Oracle Communications Interactive Session Controller Administrator Guide.

User Time Zone Configuration

By default, FACE responses are returned in UTC time zone. However, by enabling the userTimeZoneFeatureEnabled command, FACE responses are returned with the time zone format configured during the user's creation. This command is set to false by default.

To enable this feature:
  1. Access the file /usr/share/tomcat/webapps/Face/WEB-INF/web.xml and manually change the parameter userTimeZoneFeatureEnabled to true.
  2. Restart Tomcat service using the command -service tomcat restart.

Note:

Regardless of the Time Format set during API user creation, FACE always returns responses in a 24 hour format.