Administration Guide for End Customers · 2017. 7. 13. · Registrar Text Required if Recorder is to be reached from Internet. The SIP Registrar is typically the

Administration Guide for End Customers

Version 1.1 (August 18th, 2016)

REC.VC is a cloud service by

REC.VC Administration Guide for End Customers, Version 1.1 (August 18th, 2016) 1

REC.VC Administration Guide for Resellers

Table of Contents Table of Contents 1. Introduction 2. Admin Interface login 3. Sub Companies (and Hierarchies)

3.1 Introduction 3.2 Creating a Sub Company 3.3 Navigating the hierarchy

4. Provisioning of Users and Recorders 4.1 Introduction 4.2 Users

4.2.1 Creating a User 4.2.2 Self-registration / trials 4.2.3 Viewing and editing Users

4.3 Recorders 4.3.1 Creating a Recorder from scratch 4.3.2 Creating a Recorder based on existing User 4.3.3 Viewing and editing Recorders

5. Subscriptions 6. Billing, Usage and Recording Log

6.1 Billing 6.2 Usage 6.3 Recording Log


1. Introduction The REC.VC Administration Guide for End Customers covers the following aspects of the REC.VC Admin Interface:

● Admin Interface login ● Sub Companies (and Hierarchies) ● Provisioning of Users and Recorders ● Subscriptions ● Usage and Recording Log

Users can be provisioned with the following types of access to the Admin Interface:

● Admin access with read/write permission ● Admin access with read permission

You may send any questions, comments and suggestions regarding this guide to [email protected]. You can also email [email protected] to request admin access for your Company.

2. Admin Interface login The REC.VC Admin Interface is available via the following URLs:

my.rec.vc/adm, or <white-label-site>/adm

Enter email and password and click on LOGIN to access the admin interface. For users with both Admin access and associated Recorder, the login credentials will be the same for both the User Interface and the Admin Interface.


mailto:[email protected]


3. Sub Companies (and Hierarchies)

3.1 Introduction REC.VC enables creation of any number of Sub Companies at any sub level, allowing creation of hiarchies to match your End Customer organization. Please note that each Sub Company created requires an additional REC.VC Subscription as all metering of recording, storage and streaming activties are per Sub Company. For most End Customers, it is sufficient to have all Users and Recorders within one Company and not split Users and Recorders between multiple Sub Companies.

Hierarchy example A Hierarchy example B

End Customer Organization ● HR ● Marketing ● Sales ● IT ● Etc

End Customer Organization ● Division 1

○ HR ○ Marketing ○ Sales ○ Etc

● Division “n”

When accessing the Admin Interface, you login at the root level of your organization.

3.2 Creating a Sub Company To create a new Sub Company, click on the green + button available under Sub Companies.

The following fields are available under Settings of the Sub Company:

Field Type Description Required

Name Text Company or organization name. Also used to create additional hierarchical levels, e.g Customers and Prospects.

Yes


External Reference

Text Can be used to set a unique identifier between Company and third-party system, e.g. your CRM or billing system.

No

Parent Company

Search Defines where the Sub Company is placed in the hierarchy. This field can be used to move a Company around in the hierarchy.

Yes

3.3 Navigating the hierarchy You navigate the hierarchy by clicking on a Sub Company.


The breadcrumb shows where you are in the hierarchy and can also be used to navigate the hierarchy.

4. Provisioning of Users and Recorders

4.1 Introduction REC.VC enables creation of any number of Users and Recorders within a Sub Company (including root level). The relationship between User and Recorder is as follow:

● One User can have access to one Recorder (use case: personal recorders) ● Multiple Users can have access to one Recorder (use case: shared recorders) ● Note: One User cannot have access to multiple Recorders

A User with access to a Recorder can access the User Interface via the following URLs:

my.rec.vc, or <white-label-site>

A User with Admin Access (read or read/write) also access the Admin Interface via the following URLS:

my.rec.vc/adm, or <white-label-site>/adm

4.2 Users

4.2.1 Creating a User To create a new User, click on the green + button available under Users.


The following fields are available in the Use Edit Interface:


First Name Text User’s first name Yes

Last name Text User’s last name Yes

Email Email User’s email address. The address needs to be unique and cannot be used by other Users. The email is used as login username.

Yes

Password Pwd User’s password. User can change password by using the Forgot password feature on the login page.

Yes

Company Search Defines where the User is placed in the hierarchy. A User is normally placed within the same Company as the User’s Recorder.

Yes

Recorder Search Defines which Recorder the User has access to when login via the User Interface. Multiple users can point to the same Recorder.

No

Enabled Check Use this field to activate/deactivate User No

Streaming allowed

Check Permission providing User with Live Streaming feature set when login via the User Interface. Live Streaming is an add-on feature.

No

Role Subscription

Check Permission to manage Subscriptions for a Company. Permission provided upon request and subject to reseller agreement.

No

Role Admin Check Admin Permission enabling creation of Sub Companies, Users and Recorders at any level, from root level and below.

No

Role Admin Read-only

Check Admin Read-only Permission providing view access to all Sub Companies, Users and Recorders any level, from root level and below.

No


4.2.2 Self-registration / trials Any person registering on my.rec.vc or <white-label-site> will show up as User in Company / Sub Company entered during the registration process (based on Company Name). An email alert will go out to Resellers that have chosen to do provisioning of Recorders themselves, for other Resellers, the provisioning will be conducted by the REC.VC team.

4.2.3 Viewing and editing Users You can click on Users in the main menu to get a list of all Users for the Sub Company in question. In the list of Users, you can

● Click on the Name to access the Edit Interface of the User. ● Click on the Recorder to access the Edit Interface of the associated Recorder ● If Recorder is not set, you can click “Recorder not set, click to add” to provision a

Recorder to the User in question (this will set User to Enabled and create an association / link between the User and the Recorder you create).


4.3 Recorders

4.3.1 Creating a Recorder from scratch To create a new Recorder, click on the green + button available under Recorders.

The following fields are available in the Recorder Edit Interface:


Name Text Display Name of the Recorder. Yes

SIP URI Text The video address of the recorder, e.g. ● [email protected] ● firstname.lastname@<white-label-site> ● username@<white-label-site>

Yes

Location Single Select

Location of Recorder and Storage Yes

SIP Registrar

Text Required if Recorder is to be reached from Internet. The SIP Registrar is typically the <white-label-site> domain pointing to reseller’s VCS. Contact [email protected] to confirm details for your SIP Registrar

No



SIP Proxy Text Required if outbound calls from the Recorder is to go via a VCS for interworking (SIP<>H.323). The SIP Proxy is in most cases the same as the SIP Registrar.

No

SIP Username

Text VCS username for registrations. No

SIP Password

Pwd VCS password for registrations. No

Storage Type

Single Select

Select between the following options ● Local storage (in selected Location) ● FTP storage (automatic transfer of recorded

videos to third-party FTP server. Videos are not stored in Location once they have been processed and transferred to FTP server.

Yes

Storage URL

Text Only active when FTP storage is selected as Storage Type. The Storage URL is the FTP server address.

Yes

Storage Username

Text Only active when FTP storage is selected as Storage Type. The Storage Username is the FTP username.

Yes

Storage Password

Pwd Only active when FTP storage is selected as Storage Type. The Storage Password is the FTP password.

Yes

Company Search Defines where the Recorder is placed in the hierarchy. A Recorder is normally placed within the same Company as the User.

Yes

Enabled Check Use this field to activate/deactivate Recorder No

BFCP Activated

Check Use this field to activate/deactivate mixing of people and content on the recorder side based on the following fixed layout:

When not checked, the mixing will take place on the remote side (endpoint/MCU).

No


4.3.2 Creating a Recorder based on existing User To create a Recorder based on an existing User, click on “Recorder not set, click to add” in the Recorder column of the User list.

The following Recorder fields are prepopulated when clicking on “Recorder not set, click to add”:


● Recorder Name: <first name> <last name> (REC)* ● Recorder Company: Based on the Company where the User is located. ● User Enabled: Check ● User Recorder: Reference to this Recorder.

*We recommend adding “(REC)” to the end of the Recorder (Display) Name to distinguish the recorder from any endpoint, client or virtual meeting room which may have the same name.

4.3.3 Viewing and editing Recorders You can click on Recorders in the main menu to get a list of all Recorders for the Sub Company in question. In the list of Recorders, you can

● Click on the Name to access the Edit Interface of the Recorder. ● View details such as SIP URI, Registrar and Proxy. ● See Stream Title of the current activate Stream created by User.


5. Subscriptions You can click on Subscriptions in the main menu to get Subscription(s) for the Company in question. Subscriptions are currently managed by the REC.VC team and Admin Users will only have view access to this section.

6. Billing, Usage and Recording Log

6.1 Billing You can click on Billing to view:

● Recording, Storage and Live Streaming volumes included in Company’s subscription ● Summarized and detailed records for a Company’s Recording, Storage and Live

Streaming consumption in a particular month. ● Any Monthly excess / overage for Recording, Storage and Live Streaming (has

Company consumed more than the volume included in Company’s subscription?). On the right hand side of the Monthly Summary table you have the option to:

● Select billing month by changing Month (and Year if applicable) ● Export the report in Adobe PDF format by clicking on the PDF icon


The monthly billing report is also available via the APIs in various formats using the following URLs: HTML: https://<site>/api/v2/company/<company-id>/billingdata?year=<yyyy>&month=<m>&format=html PDF: https://<site>/api/v2/company/<company-id>/billingdata?year=<yyyy>&month=<m>&format=pdf JSON: https://<site>/api/v2/company/<company-id>/billingdata?year=<yyyy>&month=<m>&format=json

6.2 Usage You can click on Usage to view the aggregated monthly usage for a Company and optionally for any Sub-Company of the Company. Usage Types include:

● Recording Hours ○ For this Company (aggregated recording activity from all Recorders in Company). ○ For each Recorder (in Company). ○ Include Sub Companies (aggregated recording activity from all Recorders in this

Company and Sub Companies, by Company). ● Streaming View Hours

○ For this Company (aggregated live streaming activity from all Recorders in Company).

○ For each Recorder (in this Company). ○ Include Sub Companies (aggregated live streaming activity from all Recorders in

this Company and Sub Companies, by Company). ● Storage Hours

○ For this Company only.


○ Based on Peak Storage in Month. The graphs can be presented as Stacked or Grouped. In addition, you may double click on Company or Recorder in the graph legend to filter out all other data (Companies or Recorders). Example: Type: Recording | Mode: This Company


Example: Type: Recording | Mode: Show Each Recorder

Example: Type: Recording | Mode: Include Sub Companies


6.3 Recording Log The Recording Log provides overview of all calls to/from Recorder(s) within a Company, optionally also including Sub Companies. The period is defined by a start date entered by you (default date is yesterday) and with last date predefined set to today). Similar to other tabs, the log data view may be refreshed by clicking the tab heading.

Field Description

Start Data and time of recording start: YYYY-MM-DD HH:MM:SS GMT+2

Duration DD:HH:MM:SS

Source The video address (SIP URI) of the remote site (e.g. endpoint or VMR)

Direction Left arrow: Call from Recorder to Source Right arrow: Call from Source to Recorder

Recorder Recorder Name with link to Recorder

Company Company Name with link to Company


Documents

Administration Guide for End Customers · 2017. 7. 13. · Registrar Text Required if Recorder is to be reached from Internet. The SIP Registrar is typically the