Status Page
The Status page displays general information, account usage information, and licensing information. The Status page also exposes various system configuration options.
- Environment: Environment associated with the user's account. There are two possible values for this field:
- SAFR Cloud: A SAFR Server in the cloud maintained by RealNetworks. Cloud deployments use this environment.
- SAFR Local: A locally installed SAFR Server that the user maintains. On-premise deployments use this environment.
- Version: The SAFR version.
- Tenant ID: The name of the person currently logged in.
- User Directory: User directory where the user's data is stored. The default value for this is
main
.
- People in Directory: Number of people enrolled in your Person Directory.
- Display Language: Language used by SAFR.
- Theme Color schema used by Web Console. Can be either Light Theme or Dark Theme.
Displays account usage information about the current SAFR Account.
- Number of Directories: Number of directories in your SAFR Account.
- Number of People: Number of people currently registered.
- Number of Faces: Number of faces currently stored in SAFR's Identity Database.
- Sites with active recognitions: Number of defined sites. A site can consist of one or more cameras, although usually it consists of multiple cameras.
- Sources with active recognitions: Number of defined sources. A source can consist of one or more cameras, although usually it consists of a single camera.
- Feeds with active recognitions: Number of feeds currently running across the SAFR system.
- Load: Number of recognition attempts every second across all video feeds that are currently active in your SAFR system.
- Latency: Number of milliseconds it takes for your SAFR Server to generate a response after it receives a recognition request from a client.
Displays account usage information across all user accounts. This section is only available for on-premises deploymenbts.
- Number of People: Number of people currently registered.
- Number of Faces: Number of faces currently stored in SAFR's Identity Database.
- Sites with active recognitions: Number of defined sites. A site can consist of one or more cameras, although usually it consists of multiple cameras.
- Sources with active recognitions: Number of defined sources. A source can consist of one or more cameras, although usually it consists of a single camera.
- Feeds with active recognitions: Number of feeds currently running across the SAFR system.
- Load: Number of recognition attempts every second across all video feeds that are currently active in your SAFR system.
- Latency: Number of milliseconds it takes for your SAFR Server to generate a response after it receives a recognition request from a client.
Enables a central SAFR server to control this server.
- Local server name: Name of the local SAFR Server.
- Video viewing allowed: Enables the central server to view video feeds connected to the local server.
- Configuration allowed: Allows the central server to configure the local server.
- Central server
- Host VIRGA address: The IP address of the central server's VIRGA service.
- Host VIRGA port: The port of the central server's VIRGA service. This field defaults to VIRGA's default port number, 8085.
- Host CVOS address: The IP address of the central server's CVOS service.
- Host CVOS port: The port of the central server's CVOS service. This field defaults to CVEV's default port number, 8087.
- Host User Id: The user id of a user with the credentials to log into the central server.
- Host password: The password of a user with the credentials to log into the central server.
Enables the identity synchronization feature.
When enabled and configured correctly, your Person Directory will sync with another Person Directory. The Person Directory that you're syncing with can belong to another SAFR system, or it can belong to a different user directory within your own SAFR system. See Identity Synchronization Configuration for more information about configuring identity synchronization, including more advanced directory configurations.
Selecting the Set up Identity synchronization box causes the following dialogue to appear:
- User directory name: The name of the user directory that you're trying to sync identities with.
- Only sync identities with the following attributes: When selected, it causes only identities with the specified attributes to be synced.
- Person type: The Person types that identities must have to be synced.
- Id-Classes: The Id Classes that identities must have to be synced.
- Only sync from host but not back to host: When enabled, the identity synchronization is uni-directional. When this is not enabled, then any identity within either Person Directory that isn't registered in the other Person Directory will be copied so that both directories will end up having identical sets of registered identities.
- Merge matching anonymous identities: When enabled, anonymous imported identities whose faces match faces already in the local Identity Database will be merged.
- Host COVI address: The IP address or hostname of the target host machine's CoVi service.
- Host COVI port: The port number that the target machine's CoVi server listens on. This field defaults to CoVi's default port number, 8081.
- Host CVOS address: The IP address or hostname of the target host machine's CVOS service.
- Host CVOS port: The port number that the target machine's CVOS server listens on. This field defaults to CVOS's default port number, 8087.
- Host User Id: The User Id of a user who has the credentials to log into the host machine.
- Host password: The password of a user who has the credentials to log into the host machine.
Enables your event archive to automatically sync with another SAFR account's event archive. The target SAFR account can be on the same SAFR Server, or on a different SAFR Server. Your event archive will sync with the target Event Archive once every 10 minutes. Events are guaranteed to be synced; if an error is encountered while attempting to sync, the sync will be repeatedly retried untl it's successful.
Note: This sync does not sync event deletions. Thus, if an event is deleted in the target event archive, that event will NOT automatically be deleted in your event archive as well.
Selecting the Set up Event archive box causes the following dialogue to appear:
- User directory name: The name of the user directory whose event archive you're trying to sync with.
- Only archive events with the following attributes:
- Person types: Only events generated by the specified Person types will be synced. If this field is left blank, then events generated by any Person type will be synced.
- Id-Classes: Only events generated by the specified Id Classes will be synced. If no Id Classes are selected, then events generated by any Id Class will be synced.
- Only archive events occured after specific date: If selected, then only events generated after the specified date will be synced.
- Use more bandwidth to expedite archiving of recognized events: When enabled, your machine will use as much bandwidth as possible to synchronize events, thus possibly throttling other network activities on the machine.
- Host EVENTS address: The IP address or hostname of the target host machine's CVEV service.
- Host EVENTS port: The port number that the target machine's CVEV server listens on. This field defaults to CVEV's default port number, 8083.
- Host CVOS address: The IP address or hostname of the target host machine's CoVi service.
- Host CVOS port: The port number that the target machine's CoVi server listens on. This field defaults to CVOS's default port number, 8087.
- Host User Id: The User Id of a user who has the credentials to log into the host machine.
- Host password: The password of a user who has the credentials to log into the host machine.
Enables identity synchronization with a third party access control platform.
Selecting the et up External Identity synchronization box causes the following dialogue to appear:
- User directory name: The name of the user directory.
- External identity host: The name of the third party access control platform you want to sync with. There are two possible values:
- Host Address: The IP address or hostname of the target host machine.
- Host Port: The port number that the target machine is listening on.
- Host User Id: The User Id of a user who has the credentials to log into the host machine.
- Host Password: The Password of a user who has the credentials to log into the host machine.
Configure SAFR so that it can use an email server to send email messages. Before you configure SAFR to send emails, make sure you obtain an SMTP server account that you can use to send emails.
When you click on Set up SMTP Email Service, a dialogue will pop up requesting configuration information.
- Email Server: The address of the SMTP email server.
- Server Port: The email server port. The default port for SMTP is 587.
- Sender Email: The email username of the SMTP account. (e.g. Susan.Johnson@gmail.com)
- Password: The password for the SMTP account.
- From Email Address: The email address that will appear on the "From" line. This feature isn't supported by all email servers; if this field isn't used then the Sender Email value is used for the "From" line.
- Sender Name: The display name on the "From" line. (e.g. Susan Johnson)
- Test Email: Configure the test email that will be sent after you finish setting up the SMTP email service.
- To Email: The email address to which the test email will be sent.
- Subject: The test email's subject.
- Body: The test email's body.
After you click Apply, verify that the specified email address received a test email.
Configure SAFR so that it can use a short message service (SMS) server to send SMS messages.
When you click on Set up SMS, a dialogue will pop up requesting configuration information.
If you're using a cloud license, you'll see the following dialogue.
- SMS Provider: Your SMS Provider. You can select either SAFR Cloud or Amazon SNS from the drop-down menu. The SAFR Cloud provider is much easier to set up however, so you should probably select the default SMS Provider, SAFR Cloud.
- Test Message: Send a test message to verify that your SMS is properly configured.
- To Phone Number: The phone number to which the test message will be sent. The number should be in the E.164 format. (e.g. +12065551313)
- Message: The text message that will be sent.
If you're using an on-premises license, or if you select Amazon SNS for your SMS Provider, you'll see the following dialogue.
- SMS Provider: The SMS provider that you're using. If you're seeing this dialogue, then this value will be
Amazon SNS
. To use Amazon SNS (Simple Notification Service), you must first sign up for the service, as described on Amazon's site here: https://aws.amazon.com/sns/?whats-new-cards.sort-by=item.additionalFields.postDateTime&whats-new-cards.sort-order=desc.
- Amazon SNS Access Key: Your Amazon SNS Access Key.
- Amazon SNS Secret Key: Your Amazon SNS Secret Key.
- Amazon SNS Region: The region of your Amazon SNS.
- Amazon SNS Sender Id: The name that will be used to send the SMS notifications.
- Test Message: Send a test message to verify that your SMS is properly configured.
- To Phone Number: The phone number to which the test message will be sent. The number should be in the E.164 format. (e.g. +12065551313)
- Message: The text message that will be sent.
Sets up biometric indexing on events. Biometric indexing is required to allow event searching by image on the Web Console's Events Page or the Desktop Client's Search by Image Window.
This setting is only visible to users with CONFIG_PRIVILEGE or SUPER_CONFIG_PRIVILEGE privilege levels. See the Desktop Client's Manage Users Preferences documentation for information about user privilege levels.
- User directory name: The name of the user directory whose event archive you want to biometrically index.
- Indexing speed: The speed at which the event can be located when search by image is executed. Faster indexing speeds can lower system performance.
- Immediately index new events: Specifies if events should be biometrically indexed as soon as they're created. Enabling this option can affect your system performance when events are created.
- Only index events occurred after specific date: When checked, specifies the date after which events should be biometrically indexed. If this checkbox isn't checked, then all the events in the event archive are indexed.
Enables the automatic removal of events after the specified time interval.
- Remove Anonymous Events after: Determines how many days to wait before removing events triggered by people without a name attribute. Floating point numbers are valid. If this value is set to zero, then all anonymous events will automatically be removed after a couple seconds.
- Remove Known Identity Events after: Determines how many days to wait before removing non-anonymous events. Floating point numbers are valid. If this value is set to zero, then all non-anonymous events will automatically be removed after a couple seconds.
Enables the automatic removal of identities after the specified time interval has passed since the identity was last updated (i.e. the last time the person was seen).
- Target Directory: Determines the directory whose identities are to be automatically removed.
- Remove Anonymous Identity after: Determines how many days to wait before removing identities that don't have a name attribute. Floating point numbers are valid. If this value is set to zero, then anonymous identities will automatically be removed after a couple seconds.
- Remove Identities of person type: Select the Person Type of the identities you'd like removed. If you don't modify this field, then identities of all Person Types will be removed.
- after: Determines how many days to wait before removing identities of the specified Person Type. Floating point numbers are valid. If this value is set to zero, then identities with Person Types will automatically be removed after a couple seconds.
Shows the operating limits of your SAFR license. See On-Premises Licensing for additional information about on-premises SAFR licenses, or Cloud Licensing for additional information on cloud SAFR licenses.
- Expiration date: The date when the SAFR license expires. After this date, SAFR software discontinues operation.
- Max Feeds per Hour: Maximum number of video feeds that can be used at one time by the SAFR system. If you attempt to connect more video feeds than your license allows, the excess video feed connection attempts will all fail. Existing video feeds must be disconnected for a period of 1 hour before new video feeds are allowed to re-use the license.
Note: If a single camera is providing video feeds to 2 different Desktop Client instances, that counts as 2 video feeds for licensing purposes.
- Max Faces: Maximum number of faces that can be stored in SAFR's database. Attempting to save more faces than this limit allows results in an error.
- Max Days Between Reports: The maximum elapsed time that can pass before the SAFR system must report its status to a SAFR License Server. To communicate with the SAFR License Server, your SAFR Server must be able to make connections to cv-instam.real on port 443. Your SAFR Server will discontinue operation if it's unable to reach the SAFR License Server after the specified time has elapsed. If you need to operate your SAFR system on a private network that isn't connected to the Internet, contact your SAFR account manager to acquire a special offline license.
Note: This metric is only applicable for on-premises deployments and won't appear on the Web Consoles of cloud deployments.