top of page
Admin Portal - Manual
Most menus in the Admin portal are designed in a spreadsheet format, allowing for sorting and searching similar to standard spreadsheets. Each table contains distinct columns that can be customized and sorted independently.
Dashboard
The Admin Portal opens to the Dashboard, displaying general account statistics. To view data for a specific date range, select the start and end dates and click the "Show" button.
Statistics include storage utilization and communication metrics for the selected dates. The page also provides information about the number and status of associated cameras. A chat feature is available for inquiries regarding VMS functionality or operations.
Menu: Users
The Users menu allows the creation of accounts with different role types, granting varied levels of access to the video and admin portals. The user list can be sorted by name, login email, role, modification date, and role type.
1. To Add a user:
Use the "Add" button, input their details, assign a role, and select options for email confirmation and password changes at first login. Clicking a username opens a detailed view with options to update user information or roles.
2. To Manage Users:
Info Tab: Update user details or assign new roles.
Security Tab: Modify passwords without notifying the user or reset the password to notify them via email.
Disable User: Temporarily restrict system access.
Set as Owner: Assign the user as the account's primary owner.
Delete User: Permanently remove the user.
Menu: Roles
Roles define camera access and permissions. Multiple roles can be assigned to a camera, each with distinct parameters.
To create a new role, use the "Add" button, provide a name and description, and assign cameras and permissions to the role.
Admin Role:
Access to the admin portal and the ability to create Guards and other Admins within their permissions.
Guard Role:
Limited to end-user interface access based on assigned permissions.
Menu: Cameras
Cameras are organized into three groups: P&P (plug & play), Customer, and Deleted cameras. Menu tabs facilitate switching between these groups. The camera list can be filtered or searched by P2P status, Camera ID, Video Status, Registration Code, User, Billing Plan, and the date of the last modification. Adding a new camera is done by selecting the Add button. Viewing camera properties is possible by clicking on the camera name within the list. Thumbnails display a recent snapshot from the camera, while offline or disabled cameras show a generic symbol. A checkmark signifies that a camera is enabled and being recorded as per the billing plan, whereas a crossed circle indicates the camera is disabled, and new footage is not stored.
Adding Cameras
To add a new camera, access the Cameras Tab and select the Add button. In the popup window, choose the preferred connection method for the camera.
1. Adding a P2P Camera
The P&P (Plug & Play) connection provides the simplest and most secure method for adding a camera. This method sends data directly to the cloud server over HTTPS without requiring a public IP address setup. The system will automatically detect the camera and establish a connection. For ONVIF-compliant cameras, access to camera settings is available directly from the Starllion Cloud admin portal.
Note: The Push method is recommended. It ensures that camera and video stream access remain uninterrupted, even if the internet provider changes the IP address or the camera is relocated. No further configuration in the admin portal is necessary.
2. Adding an ONVIF Camera
Two methods are available for integrating an ONVIF camera:
Using the URL Method
This method involves setting up Port Forwarding on the client’s network. The process requires opening HTTP and RTSP ports on the router and creating an HTTP access URL.
Input the camera information and click "Create." The camera is then added to the list, enabling modifications to supported settings via the ONVIF protocol. Analytics features for the camera are preserved.
Note: If the client’s internet provider changes the IP address, camera access may be disrupted, requiring manual adjustments. Services like DynDNS can help prevent interruptions.
Using the Registration Code
The Registration Code method is applicable if the camera is P&P-compatible and equipped with Starllion Cloud’s Push firmware. This approach is useful for:
Adding a duplicate camera with a different streaming profile (e.g., for long-term time-lapse recording).
Cameras connected to a multi-channel device, such as an NVR/DVR or a multi-sensor camera, where adding another profile is required.
3. Adding a Generic Camera
The Generic Camera setup also offers two methods:
Using the URL Method
This approach is suitable for cameras incompatible with P2P or ONVIF methods.
Configure HTTP and RTSP port rules on the client’s router.
Provide general camera information and proceed to the next step.
Enter the access URLs and credentials, then click "Create" to add the camera.
This method is recommended for older cameras lacking ONVIF support. However, it does not allow modifications to settings via the Starllion admin portal.
Note: Changes to the client’s IP address can disrupt camera access, requiring manual updates. Services like DynDNS can mitigate such interruptions.
Using the Registration Code
This method is helpful for:
Non-ONVIF-compliant cameras connected to the gateway.
Adding an ONVIF camera as Generic if the AVYCON Cloud Push module is enabled.
Settings Overview
Select a camera name from the list to open the camera information panel. Wait for the ONVIF data to fully load. The loading indicator will disappear once the process is complete.
1. Info Tab
The Info tab displays the primary information about the selected camera.
2. General
This section shows details such as the camera name, manufacturer, and model. For audio-enabled cameras, this section also provides options to enable or disable the microphone.
3. Network
The Network section contains access URL details and tools to test connections to the camera. This feature is not applicable for P2P cameras.
4. Quality
For ONVIF cameras, the Quality section allows direct adjustments to quality settings through the admin portal. The available options depend on the current billing plan and the camera's capabilities.
Stream Channels: Select the desired channel for cameras supporting multiple streams.
Resolution: Choose a resolution from the options provided by the billing plan.
FPS (Frames Per Second): Adjust the frame rate to balance storage usage and detail capture for fast-moving objects.
Image Quality Slider: Shift towards "quality" to prioritize image quality over bandwidth, increasing both bandwidth and storage usage.
Bitrate Settings:
Select VBR (Variable Bitrate) to maintain the selected bitrate as an average.
Choose Set Automatically to let AVYCON Cloud manage quality based on the image quality slider settings.
Manually set the target average bitrate for the camera, which adjusts quality depending on the scene complexity and codec efficiency.
5. Recording
The Recording tab provides options to configure archive settings for the camera.
6. Analytics
The Analytics tab is used to configure smart camera features and enable Starllion Cloud analytics.
Camera-Side Analytics: Displays available camera-side events based on the device’s capabilities. Click on a desired function to configure it. Options may be limited by the camera model.
Starllion Cloud Server-Side Analytics: Configure advanced analytics based on the billing plan. This section supports multiple modules running simultaneously, providing object-based detection and greater accuracy.
Confidence Setting: Adjust the recognition confidence threshold for marking objects according to predefined rules.
Motion Detection: Enable motion detection for specific regions by adjusting the blue mask area.
Once all desired settings are configured, press Save to apply changes. Closing the settings window without saving prompts a confirmation message.
7. Location
The Location tab allows editing and viewing the camera’s position on a map.
8. Events
The Events tab displays a history of all recognized events associated with the camera.
9. Logs
The Logs tab provides information about status changes and operational events for the camera.
10. Troubleshooting
The Troubleshooting tab helps diagnose and resolve camera-related issues.
Menu: Alerts
Alerts notify users of specific events or system statuses.
1. Create New Sensor Alert
Provide a descriptive name for the alert, as it will appear in the notification heading. Select the alert type. For proper functionality, the specified alert type must be configured and enabled in the camera settings. Choose "Any time" to keep the alert active at all times or select specific dates and times for the alert's activity period. Notification filtering can limit the number of emails or push messages sent within a selected time interval, where all events within that interval will be included in the message. If this option is disabled, notifications will be sent instantly. Choose the preferred method for receiving notifications.
IMPORTANT: If "Push" is selected, notifications will only be sent for recognized objects (server-side analytics).
Click "Next" or go to the Cameras tab to select which cameras will be included in the alert.
Note: If notification filtering is enabled and the default interval for system alerts is selected, notifications will be grouped based on the longest time interval setting.
On the Cameras tab, select the cameras for the alert. Click on a camera name to move it between columns: the left column shows available cameras, and the right column displays selected cameras. Next, go to the Contacts tab or click the "Next" button to choose users who will receive the notifications. The same principle applies—available users appear in the left column, and the right column shows users who will receive the alert. Click the "Create" button to finalize the alert creation.
2. System Alerts
The alert list displays all alerts. System alerts notify designated individuals about the status of cameras.
A system event can be created to receive notifications about camera issues at specified intervals, enabling prompt action to address any problems. Under the Daily Report tab, a daily system health report can be requested, which includes the status of all cameras. This report is generated at midnight. Clicking on a username adds that user to the list of recipients for the reports.
Under the Settings tab, alerts can be set to “Armed" (on), "On schedule" for a specific time frame, or turned off. The interval between alerts helps manage the volume of emails received within a given time period. When notification filtering is enabled, alerts are grouped within the specified interval, and a single email is sent with a list of all events. If notification filtering is turned off, the set interval is bypassed, and notifications are sent immediately for the selected alert.
3. Alerts Schedule
A schedule can be created to receive alerts only during specified hours. To set up an alert schedule, navigate to the Alerts tab, select "Create a Sensor Event," and then choose "Custom schedule" under the schedule section.
To define the schedule, click on the square boxes to select or deselect the time for each day. Each box represents a 30-minute window. Additionally, boxes can be dragged and dropped to select or deselect time slots. Orange square boxes indicate selected times for sending alerts, while greyed-out boxes represent periods when notifications will not be sent.
Menu: Events
The Events menu logs detected camera events. Users can filter, sort, and customize the view or reset settings to default.
Menu: Share
The Share menu displays a log of all instances when a camera was shared with a third party. Use the Share button to generate a web link that allows others to view the camera. Specify which cameras will be shared and the duration of the sharing. Events can be sorted using any of the available columns. The Reset settings button restores the default view of the list, and the Reset filters option clears any applied filters. Choose which columns to display for a customized view.
1. Share Cameras
To share cameras, go to the Share menu and click the Share button. Select how to share the camera:
Link option: Generates a link that can be shared with others to view the camera.
Widget option: Generates HTML code to embed the camera stream into a website.
To create a temporary link, select the cameras to be shared, add a name and description for the shared link, and choose the access method. Access can be granted via a simple link, or a password can be required for viewers to access the camera. Set a password and specify the expiration time for the link. Enter the email addresses of the recipients. Once the Share button is clicked, emails containing the link will be sent to the specified addresses. Afterward, the shared link can be reopened to copy and share it again.
2. Share Cameras: Widget
Select the Widget option to create HTML code for embedding the camera stream on a website. Choose the camera to share, then add a name and description. After clicking Share, a window with widget properties will appear.
Select the desired options for the widget and click Save to apply changes. Press Copy to copy the HTML code to the clipboard. Open the website editing tool, and paste the code into the site's HTML to embed the stream.
Menu: Profile
The Menu Profile allows for adjustments to user account details, including changes to account credentials, password, username, and Multifactor Authentication (MFA) settings.
1. Accessing the Menu Profile
To access the Menu Profile, click on the dropdown next to the account name and select 'Profile' under the User section.
2. Modifying First Name, Last Name, and Email ID
Changes to the first name, last name, and email address can be made under the User Info tab in the Menu Profile. After making the desired changes, click Save to confirm them.
Note: The first name, last name, and email differ from the contact information found in the Account Profile section.
3. Changing the Account Password
To change the password for the Admin Portal, go to the Password tab within the Menu Profile. Enter the current password, followed by the new password.
Note: If the password is forgotten, a new password can be requested from the Admin portal login page by clicking the Forgot password link.
4. Changing the Username
By default, the username is the email address used during account creation. It can be updated by navigating to the Username tab under the Menu Profile.
To change the username, first uncheck the box labeled Use email as the username. After saving, the new username will be required for logging into the Admin Portal, and the previous email ID will no longer work for login.
To revert the username to the original email ID, simply select the Use email as username option again.
5. Enabling Multi-factor Authentication (MFA)
To activate MFA, go to the Multi-factor Authentication tab within the Menu Profile and click the Enable button. After enabling, a list of supported authenticator mobile apps will be provided.
Once an authenticator app is installed, scan the QR code displayed on the MFA tab with the app on your phone. A 6-digit code will be generated by the app, which should be entered into the code box on the MFA tab. After entering the code, click Enable to activate MFA for future logins.
Upon visiting the Admin portal, the Dashboard page will be displayed. This page provides general statistics related to the account. To view statistics for a different date range, select the desired start and end dates, then click the Show button.
To view the statistics in a graphical format, click the Charts button. This will open a new page displaying visual representations of camera, overall storage, traffic, and clip duration data accumulated over the past three months.
Most Admin portal menus are structured like spreadsheets, allowing for sorting and searching similar to any other spreadsheet. Each table has its own set of columns that can be individually modified and sorted.
The Support button provides quick access to the Help Center.
The Language selector enables the interface language to be changed, affecting only the user’s default settings.
1. Menu Customers
The Menu Customers displays a list of all current customers and integrators. To view customer details, click on the customer name. The table does not refresh in real-time; it is updated when opened or by using the Refresh button. If any changes were made in the column while the table was open, a refresh will be needed to view those updates.
To view deleted customers and integrators, use the Deleted Customers tab.
To adjust which columns are displayed, click the Columns button and select the columns to show.
The number of entries displayed on a single page can be adjusted.
The table can be sorted by any column. Simply click the arrows to set the selected column as the main sorting column and choose either ascending or descending order.
Start typing in a column header to search for specific IDs, names, emails, etc. Partial values can be entered in multiple column headers to narrow down the results. Use the "x" to clear the search text.
Click the Reset Filters button to remove any applied filters across all columns at once.
Click the Reset Settings button to restore the table to its default configuration.
2. Menu Managers
The Menu Managers displays all users with manager access levels. There are two types of managers:
Operational Manager
Billing Manager
Currently, both types of managers have the same permissions, access levels, and functions. However, when billing features expand in the future, these two roles will have distinct responsibilities. For now, the*Operational Manager role should be used if the new account is intended for managing existing customers or creating new customers.
To change a manager’s password, delete a manager, or review activity logs, click on the manager's name in the table and select the appropriate tab. In the User tab, the current role can be deleted, and a new role can be assigned to the manager.
In the Security tab, a new password can be assigned to the manager's account. Additionally, the manager’s access can be disabled to restrict system access. There are two options for changing the password:
Without notifying the manager.
With a notification email, which will include the new password.
To create a new manager, click the Add button. In the window that appears, provide the manager's name and email, select a role, and create a secure password. Alternatively, a temporary password can be generated, which will be sent in the invitation email. The manager will be required to change the password upon their first login.
To adjust which columns are displayed, click the Columns button and select the desired columns.
The number of entries shown per page can be adjusted.
The table can be sorted by any column. Click the arrows to set the selected column as the main sorting column and choose either ascending or descending order.
Start typing in a column header to search for specific IDs, names, emails, etc. Partial values can be entered in multiple columns to narrow down the results. Use the "x" to clear the search text.
Click the Reset Filters button to remove any applied filters across all columns at once.
Click the Reset Settings button to restore the table to its default configuration.
3. Menu Cameras
The Menu Cameras at the integrator level displays cameras assigned to all customers, excluding those of sub-integrators. To view cameras assigned to customers of sub-integrators, log in with the operational manager credentials of the respective sub-integrator.
The Menu Cameras opens on the P&P Cameras tab, showing only P&P cameras for all customers. To view ONVIF and Generic cameras, switch to the Customer Cameras tab. To access the history of deleted cameras, use the Deleted Cameras tab.
To register a new camera, click the Add button. When using the Add button from this menu, there will be additional options compared to the customer-level menu.
The first step involves selecting a customer to assign the new camera to or choosing the Your P&P Cameras option to pre-register the camera for future quick assignment.
This option allows creating a stock of cameras in the system, which will be listed as Registered in the table.
This approach reduces the steps needed for activation to just two once the camera is deployed on the customer's premises:
Select the customer to assign the camera to.
Choose a billing plan.
To view the camera's properties, click the camera name. The table does not refresh in real-time but is updated when opened or by using the Refresh button. If the camera's state changes after the table is opened, the update will not be shown automatically. To refresh the camera statuses, use the Refresh button.
To adjust which columns are visible, click the Columns button and select the desired columns.
The number of entries shown per page can be adjusted.
The table can be sorted by any column. Click the arrows to set the selected column as the main sorting column and choose either ascending or descending order.
Start typing in a column header to search for specific IDs, names, emails, etc. Partial names and values can be entered in multiple columns to filter the table. Use the "x" to clear the search text.
Click the Reset Filters button to clear any applied filters across all columns at once.
Click the **Reset Settings** button to restore the table to its default configuration.
4. Menu Alerts
The Menu Alerts at the Integrator level allows for the creation of alerts for system events, which can be sent to the main integrator email inbox or to registered managers. This feature enables the setup of rules to consolidate alerts for all customers into a single inbox, rather than sending separate emails for each customer.
To create a new alert, click the Create System Event button and select the customer for whom the alert is being created. On the next page, configure the parameters for the alert.
The Notification Filtering option aggregates multiple alerts into a single notification, preventing separate alerts from being sent for each issue related to the selected cameras.
Note: Mobile push notifications for Camera Down events are currently not functioning. This page will be updated once the issue is resolved. To use mobile push notifications for Camera Down events, a ticket can be submitted, and updates will be provided when this feature becomes available. Object detection push notifications are working as expected.
5. Menu Logs
The Menu Logs at the Integrator level provides access to a record of all manager and integrator activities.
The table can display logs in three different formats:
By Count: Shows either the last entries up to the selected time or the most recent entries within the chosen timeframe.
By Time: Displays logs for the most recent specified number of hours.
By Period: Displays logs for the selected time period.
To view the details of any log entry, click on it. The table does not refresh in real-time, so updates made after the table was opened will not be shown automatically. To refresh the logs, use the Refresh button.
To modify which columns are visible, click the Columns button and select the desired columns.
The number of entries displayed on a single page can be adjusted.
The table can be sorted by any column. Click the arrows to set the selected column as the main sorting column and choose either ascending or descending order.
Start typing in a column header to search for specific IDs, names, emails, etc. Partial names and values can be entered across multiple columns to filter the table. Use the "x" to clear the search text.
Click the Reset Filters button to remove any filters applied to all columns.
Click the Reset Settings button to restore the table to its default configuration.
6. Menu API Keys
API methods enable integration with both custom and third-party software on the platform. Currently, over 75 methods are available, allowing for the creation, modification, and deletion of various platform components, as well as automating routine tasks via a custom interface.
For the API methods to function, the correct API key for the appropriate customer level is required. Each integrator and customer have a unique API key, which can be found in the API Keys menu or retrieved using the Get API Key method with the integrator API key. For example, to create a new customer, the integrator API key must be used, while for creating and assigning a new camera to an existing customer, the customer API key is required.
To access documentation and view the integrator API key, open the Profile menu and select the API option from the dropdown.
API keys for customers can be renamed by selecting them and editing the name field.
To disable API methods for a specific customer, use the Enable/Disable slider.
To view API documentation and examples on how to use the methods, open the API menu from the profile dropdown and click on the API Documents link.
7. Menu Profile
The Menu Profile allows for the modification of user account credentials. Changes can be made to the account password and username, including switching from the default email ID. Additionally, the Multifactor Authentication (MFA) feature can be enabled or disabled.
Changing the Account’s First and Last Name and Email ID
Under the User Info tab in the Menu Profile, modifications can be made to the first and last name, as well as the email address. Remember to click Save to apply the changes.
Note: The First and Last Name, as well as the email, are distinct from the contact information stored under the "Account Profile" menu.
Changing the Account Password
To change the password for the Admin Portal, navigate to the Password tab. Enter the current password to update it.
Note: In case of a forgotten password, a new one can be requested from the Admin portal login page by clicking the "Forgot Password" link.
Changing the Username
By default, the username is the email address used during account creation, and this email is used to log in to the Admin Portal. It is possible to change the username to something other than the default email ID by going to the Username tab within the Menu Profile.
To change the username, first uncheck the box that states, "Use email as username."
After saving the changes, login to the Admin Portal will only be possible with the new username; the previous email ID will no longer be valid. To revert the username to the default email ID, simply select the "Use email as username" option.
Using Multi-factor Authentication (MFA)
To enable MFA, click the Enable button under the Multi-factor Authentication tab in the Menu Profile.
Once MFA is enabled, several authenticator mobile app options will be provided. After installing the chosen app, scan the QR code displayed on the MFA tab using the app.
The app will generate a 6-digit code, which must be entered into the code box on the MFA tab. After entering the code, click Enable again to activate MFA for all future logins.
This article explores how to control the dimensions and aspect ratio of videos using HTML widgets. By editing the HTML code, the size and proportions of embedded videos can be customized to fit specific needs. Let's dive into the process and learn how this can be achieved.
Controlling Dimensions
To control the dimensions of a video, the width and height attributes of the HTML `<iframe>` tag can be used. These attributes allow for specifying the exact pixel dimensions of the video player. Here is an example:
Setting exact pixels:
html
<iframe src="https://portal.3deye.me/Embed?widget_id=4b&widget_token=rd561435" allowfullscreen width="560" height="315"></iframe>
In this example, the video player will have a width of 560 pixels and a height of 315 pixels. These values can be adjusted to the desired dimensions.
It is important to note that setting fixed dimensions may result in distorted videos if the aspect ratio is not maintained.
Setting a fixed width and adjusting the height to maintain the aspect ratio:
html
<iframe src="https://portal.3deye.me/Embed?widget_id=4b&widget_token=rd561435" allowfullscreen width="560" height="auto"></iframe>
In this case, the video player will have a fixed width of 560 pixels, while the height will automatically adjust to maintain the native aspect ratio of the camera widget.
Setting a fixed height and adjusting width to maintain the aspect ratio:
html
<iframe src="https://portal.3deye.me/Embed?widget_id=4b&widget_token=rd561435" allowfullscreen width="100%" height="315"></iframe>
Here, the video player will have a fixed height of 315 pixels, and the width will adjust to maintain the native aspect ratio of the camera widget.
By using these attributes appropriately, it is possible to customize the dimensions of the video player while ensuring the aspect ratio remains intact.
Controlling the dimensions and aspect ratio of videos using HTML widgets enables the creation of customized video experiences on web pages. By specifying the width and height attributes or using CSS techniques, videos can be displayed correctly while maintaining their desired proportions.
Experimenting with different dimensions and aspect ratios will help determine the best fit for a website or application. It is also important to ensure responsiveness, so videos are optimized for viewing across various devices. With these techniques, the dimensions and aspect ratio of videos can be confidently controlled using HTML widgets.
For cameras added via P&P:
The Camera WebUI can be accessed directly through the Troubleshooting tab in the camera settings. This provides the ability to control features that are not available through ONVIF.
To access the WebUI, select the camera device, then navigate to the Troubleshooting tab. Click on "Generate URL" to create a web link to the WebUI, valid for 60 minutes (a new link must be generated if additional time is needed).
Once the Public URL is generated, click "Open" to launch the link directly in a browser, or click "Copy" to manually paste it into a web tab/window. Login to the WebUI using the P&P credentials listed in the Troubleshooting tab.
Note that some cameras may have separate ONVIF and web access accounts, so the login details in the admin portal may not work. In these cases, the correct web UI credentials will be needed.
Please be aware that live video streaming is not supported by all cameras through the generated web link. Only devices that support streaming via port 80 will display a live feed. To monitor changes in real-time, it is recommended to open a video portal for live viewing.
For cameras added via ONVIF, the Camera:
The WebUI can also be accessed through the Troubleshooting tab in the camera settings.
Select the ONVIF camera device, wait for the camera to load the ONVIF protocol (ONVIF indicator will turn green), and then click the Troubleshooting tab. Copy the HTTP access URL into the web browser and press enter. Log in to the WebUI using the credentials listed in the Troubleshooting tab.
Note that live video streaming may not be available for all cameras through the generated web link. Only devices streaming through port 80 will display a live feed. To view changes in real-time, it is recommended to open a video portal feed for the camera.
It is possible to use the same email address to create additional accounts on the Starllion™ Cloud platform by utilizing the + symbol workaround, also known as plus addressing. This involves adding alphanumeric characters between the + and @ symbols in the email address. For example, if the primary email address is user@starllion.com, an additional account could be created with user+techsupport@starllion.com. This method allows managing multiple accounts under one base email address. It is important to note that only alphanumeric characters are allowed; special characters or spaces between the + and @ symbols are not permitted.
This workaround is not limited to Starllion Cloud and can be used across various platforms unless specifically restricted by the site owner. Emails sent to any of the created addresses will be delivered to the same inbox, with the "+abcd" included in the "To" line, making it easier to filter messages for specific users.
For example:
The email address used to create a customer account on the Starllion Cloud platform could be customer@starllion.com.
A guard user account can be created using customer+guard@starllion.com as the login email.
A test customer account for experimental testing can be created with customer+test@starllion.com as the login email.
All confirmation links and password recovery emails will still be delivered to the primary inbox, customer@starllion.com.
Webhooks allow for the creation of custom automations using the digital output of a camera or by activating internet-connected devices that can be triggered via a URL command. Currently, the system supports only POST requests to the end devices. If a different type of input is required, an intermediate service such as zapier.com can be used to convert the POST request into a compatible format for the device.
To begin setting up automation, refer to the device manual to understand how commands should be formatted and the type of authentication required. For example, with a Vivotek camera, a command to activate the digital output would look like this:
http://ipAddress:port/cgi-bin/dido/setdo.cgi?do0=1
This command will activate the digital output port, provided the session is authorized. To include authentication credentials, the username and password can be added before the IP address, separated by a colon and followed by the "@" symbol:
http://userName:password@ipAddress:port/cgi-bin/dido/setdo.cgi?do0=1
Once the correct command format is known, triggers can be configured to activate specific functions. These could range from simple tasks, such as turning on an LED light, to more complex operations, such as starting a production line when certain conditions are met. For example, an LED light connected to the digital output of the Vivotek FD8182-F1 camera can be activated using this logic, which can be expanded to suit nearly any project.
Creating a Webhook
To initiate an automation, a trigger condition must occur. A variety of triggers are available through the webhook creation tool. Open the Admin portal, select the customer for whom the automation is being created, navigate to the Alerts menu, select the Webhooks tab, and click the "Create Webhook" button to start the creation wizard.
If the device can accept POST requests, the URL field can be populated with the IP address and command for the automation, then the webhook can be created. If the device cannot accept POST requests and requires a different format, a third-party service like zapier.com can be used to convert the POST request into one that the device understands. In this case, for a camera that accepts GET requests, Zapier will be used to convert the POST request into GET.
Configuring Zapier
To configure Zapier, click "Create Zap" from the dashboard to start the wizard. Under "Choose app & event," select "Webhooks by Zapier." The next step will display a webhook link; copy this link as it will be used in the Admin portal when creating the webhook.
Testing the Webhook
To test the webhook, create a new webhook in the Admin portal and ping it. This will send the first request to Zapier, which is sufficient for testing the service.
Configuring the Action
Now configure the action that will be triggered by the webhook. Select "Webhooks by Zapier" and then "Custom Request".
For the camera model in this example, use GET as the method and include the username and password in the URL, followed by the IP address, port, and the command to execute. Depending on the camera or device, the settings for the action webhook might differ. Consult the device's manual for the correct procedure and authentication details.
When the test is run, the device should respond as expected. For example, an LED array connected to the camera's digital output should light up during the test.
Continuing Webhook Creation
After confirming that the URL is working, proceed with the webhook configuration. Choose one or more triggers to start the automation. "Analytics" in the platform refers to any object detection event generated by the platform or smart cameras. Selecting "Analytics" as the event trigger corresponds to selecting object detection.
Next, assign a role to the webhook, which will determine which cameras' events will trigger the webhook. In this step, the webhook's format and the information included in it can also be customized.
Additionally, security guards can trigger special events from the alarm station, allowing for further fine-tuning of the automation sequence to meet specific requirements.
Here is an example of the information that could be included in the AVYCON Cloud JSON payload:
Introduction
Starllion Cloud provides a simple solution for transferring camera layout groups between users, streamlining the process of creating groups for each individual. This feature allows for easy management of camera views by selecting the appropriate layout. If a user does not have access to specific cameras, those cameras will not appear in the copied groups.
All products maintain consistent settings for both customers and integrators, making it possible to copy any camera group, regardless of its complexity. This feature is highly recommended for synchronizing camera groups across multiple users.
Step 1: Ensure the User's Privileges
Integrators and managers have the ability to copy layouts for clients, while only Owner and Admin users can copy layouts at the customer level. However, Guard users can create their own layout groups or copy them to their accounts. Any user with access to layouts can transfer them to Guard users, and Guard users can share their created layouts with others.
The security model for layout sharing allows layouts to be shared among multiple users without requiring the same camera access. An Owner can create a group shared by users with access to the same cameras, allowing for seamless layout sharing without concerns about differing camera permissions.
Step 2: Access User Settings
To copy camera groups, navigate to the User tab and select the source user. Then, go to the Transfer Groups tab and choose the destination user. Click "Copy" to transfer the groups, or use the "Swap" icon to switch the source and destination.
Summary
Copying camera layout groups in Starllion Cloud is an efficient way to manage camera views across multiple users. By following these steps, time and effort can be saved when creating groups for different accounts.
Note: This process will overwrite any existing groups and categories for the destination user. A confirmation prompt will appear before completing the transfer, allowing verification of the decision to overwrite the existing groups and layouts.
To enhance monitoring services, Webhooks can now be used to trigger devices, websites, or other smart hubs to perform pre-programmed actions based on events generated by cameras or monitoring operators. By providing a URL, the system can send event information, and specific data to be included in the webhook can be selected.
To create a new webhook, select a customer and navigate to the Alerts menu. Then, open the Webhooks tab and click the "Create Webhook" button. Use the Ping function to test the link—if the link address is correct and a response is received, proceed to the next step.
On the following screen, one or more event types can be chosen to trigger the webhook. The "Select all" or "Deselect all" options allow for adding or removing all event types from the webhook. Click the "Next" button to continue.
Note: In this platform, "Analytics" refers to any object detection event generated by the system or smart cameras. When setting up webhooks, selecting "Analytics" as the event trigger equates to choosing object detection.
To determine which cameras will be included in the webhook alert, select the role containing those cameras. If cameras from multiple roles need to be included, a new role can be created to encompass all desired cameras, after which the webhook can be created using the new role.
The information to be included in the webhook can also be customized by selecting Payload.
The Starllion Cloud JSON Payload provides basic information about the camera and the events that occurred within it.
The Bold SIMS XML Payload allows for assigning two fields for each role and two fields for each camera, providing a URL to review the event.
To modify Bold SIMS XML Payload fields for a role:
use edit or open role and edit it from the role properties window:
or from the Role properties window:
To edit Bold SIMS XML Payload fields for the camera open camera properties and go to the Integrations tab:
Note: For object detection events (Analytics), the webhook will be triggered if the confidence level of the selected object exceeds the limit set on the Analytics tab of the camera.
To delete a webhook:
Open the desired webhook by clicking its name, then go to the "Delete" option. Type "DELETE" to confirm the action, which will turn the delete button red.
Widgets offer a way for customers to share their cameras with others. By embedding a camera on a website, visitors can view it directly. The process of creating a widget can be done through the admin portal.
1. Access the Share Menu
Log into the Admin portal and navigate to the "Sharing" tab. Click the "Share" button to begin the widget creation process.
2. Select Widget
A pop-up window will appear with three options. Choose the "Widget" option.
3. Choose the Camera
A new pop-up will appear allowing the selection of a camera for the widget. Click under "Select cameras" to open a drop-down list. Only one camera can be selected per widget.
To filter the list, users can type the camera name if it’s lengthy.
4. Enter Name and Optional Description
After selecting the camera, provide a name for the widget. A description can be added, though it is optional. This helps identify the widget in the future, especially if the use case is forgotten.
5. Click Share
To create the widget, click "Share." Note that additional charges apply when creating a widget. For more details, contact the sales team. When a widget is created, the camera plan switches to "Pay as You Go".
If the current plan isn’t "Pay as You Go," the integrator will need to assist in the process. Additionally, when the widget is active, all other camera plans are disabled, and the widget must be deleted to change the camera plan.
6. Configure Widget Options
Autoplay: Automatically starts streaming when the webpage is loaded. Without autoplay, visitors must press the play button to start.
Disable WebRTC: Limits the camera to DVR mode, improving performance on slower devices or when internet connectivity is an issue.
Timeline: Allows visitors to navigate through the camera's archive.
Enable Events: Displays events from the camera if object detection is configured.
Hide Camera Title: Removes the camera name from the widget but does not affect the OSD name if present.
PTZ Controls: Enables interaction with the PTZ camera through the widget.
Autopause: Stops the stream if the webpage is left open without being closed, reducing traffic usage.
7. Copy HTML Code
Once the widget options are configured, copy the HTML code at the bottom of the widget properties window and paste it into the website code. The exact procedure depends on the website's structure. If the widget options are changed later, the code on the website does not need to be modified—only the settings in the Admin portal need updating.
Important Considerations:
Traffic Consumption: The widget generates traffic, which increases camera consumption. For every visitor that views the camera feed, traffic is generated. As the camera operates on a Pay-as-You-Go plan, costs will depend on how frequently the feed is viewed, potentially leading to high monthly bills.
For example:
Calculate the total bitrate: Multiply the bitrate (1) by 750 Kbps, resulting in a total of 750 Kbps.
Convert Kbps to Kilobytes: Divide the bitrate by 8 to convert from Kbps to Kilobytes. 750 ÷ 8 = 93.75 KB per second.
Convert Kilobytes to Megabytes: Divide the result by 1024 to convert Kilobytes to Megabytes. 93.75 ÷ 1024 = 0.0915 MB per second.
Convert Megabytes to Gigabytes: Divide the result by 1024 again to convert Megabytes to Gigabytes. 0.0915 ÷ 1024 = 0.00008940 GB per second.
Calculate traffic per minute: Multiply the result by 60 to determine the traffic generated per minute. 0.00008940 × 60 = 0.005361 GB per minute.
If 100 visitors watch the feed for one minute, 0.53 GB of traffic is generated. In one hour, this would amount to 31.8 GB of traffic.
Understanding these factors is crucial for managing the costs associated with using the widget.
There are two types of entities that can be created by partners:
1. Integrator
An Integrator can create sub-integrators and earn profit from the business they generate. The sub-integrators created will be able to add their own customers and manage all aspects of their business while remaining part of the Integrator's business.
Note: Sub-Integrators can only be created by Integrator users.
Step 1: Selecting Customer Type
To create a new Sub-Integrator, navigate to the Customers menu from the Integrator user account and click the "Add" button. In the popup that appears, select the "Integrator" option.
Step 2: Setting the Cost for Sub-Integrator
Specify the price the Sub-Integrator will pay for storage and traffic, then click the “Next” button.
Step 3: Filling Sub-Integrator Details
Enter the Sub-Integrator's details, ensuring a real email address is used. A confirmation email with a link will be sent to this address, and the user will not be able to access the system until the "Confirm email" link is clicked from the welcome email.
Step 4: Assigning the Plans
Choose the plans that the sub-integrator will have access to and click the "Create Customer" button. This will add a new entry to the customer list.
2. Customer
The second type is the end-user Customer. It is generally recommended to add camera owners as Customers. While there are exceptions, in most cases, a new Customer account should be created for a business or homeowner wishing to add video monitoring to their property.
Step 1: Select the Customer Type
To create a new customer, go to the Customers menu and click the "Add" button. In the popup that appears, select the "Customer" option.
Step 2: Filling Customer Details
Enter the customer details and click the "Create" button at the bottom of the page. This will add a new entry to the customer list.
At the time of Customer creation, the default cloud recording settings for the Customer account can also be set. It can also be decided if the customer should have access to the Admin portal or be allowed to share the camera's link. Additionally, a temporary password can be provided for the first time, after which the customer can select their own password.
Step 3: Billing Details
Enter the billing details for the customer. The Starllion system will automatically generate an invoice based on the chosen rate if the Integrator selects the Billing mode as automatic. It is also possible to decide if tax should be included in the invoice.
Step 4: Restricting Access
By default, customers will have access to all system modules, except for the ability to add a P&P camera. Access to features can be restricted individually for each customer. Any restrictions will apply to all users of the selected customer but will not affect other customers.
If a customer is "Disabled," all cameras associated with that customer will stop recording, and access to all systems will be restricted for users under that customer. When re-enabling the customer, all cameras will be re-enabled as well, so any cameras that should remain disabled will need to be turned off after re-enabling.
Note: When entering Customer or Integrator address details, make sure the browser autofill is disabled. If autofill is enabled, the Google Maps widget may not recognize the address, causing issues with filling in the address, city/town, state/province, postal code, and country fields, which may prevent progress in customer creation.
To resolve this, select the correct address from the results returned by Google, which will automatically complete the rest of the address details.
Alert rules can be created based on any ONVIF-compliant events from cameras or server-side analytics recognition. Multiple cameras can be included in a single alert, and notifications can be sent to any number of users simultaneously.
Creating a New Alert
To create an alert, open the Alerts table from the Customer-level menus and click the Create Sensor Event button.
General Alert Settings
On the first tab of the window that appears, enter a name for the alert. This name will appear in the title of the notification email or push notification. Then, choose the Alert Type from the dropdown menu. All ONVIF events detected by the camera can be used as triggers but ensure that the detector is properly configured on the camera. If Object Detection or Face Recognition is being used, ensure that the appropriate rules are set up for the selected camera(s) under the Analytics tab.
For Object Detection, select which objects will trigger the alert. For instance, a camera may be configured to detect both cars and people, but the alert can be configured to trigger only when a person is detected.
Scheduling Alerts
Alerts can be set to be active 24/7 or on a custom schedule. To use a custom schedule, select the Custom Schedule option and specify the time intervals when the alert should be active. Active periods will be indicated by orange squares, while white squares represent disabled times.
Notification Filtering
Notification filtering allows multiple alerts to be combined into a single email. When this option is enabled, alerts will accumulate for the selected period, and a single email will be sent containing information about all events that occurred during that period.
Note: If a Custom Schedule is enabled, the maximum aggregation period will be limited by the shortest active period in the schedule.
Alert Delivery Methods
Alerts can be delivered via email or mobile push notifications. To receive push notifications, the Starllion Cloud app must be installed, and an active session must be maintained on the device. The user must also be logged into the app with the same credentials used for configuring the alert. Both delivery methods can be used simultaneously, but push notifications are only available for Object Detection or Face Recognition alerts.
Important: Avoid creating a rule that puts the Starllion Cloud app to sleep due to inactivity, as this will prevent push notifications from being received.
Adding Cameras to the Alert
Click the Next button to select the cameras to be included in the alert. Multiple cameras can be added, either by selecting each camera individually or using the All Cameras button to select all cameras at once. To remove a camera, click its name from the right column, or use All Cameras to remove all cameras at once.
To reduce the number of false alerts, enable Dual Technology. With this option, an alert will only be triggered when the event is detected on all cameras in the list simultaneously. For example, when multiple cameras are monitoring the same area from different angles, the alert will only be triggered if the event is detected by all cameras, not just one.
Note: If Object Detection or Face Recognition is selected as the Alert type, the camera list will be filtered to show only those cameras with Object Detection enabled. It is still important to ensure the appropriate detection rules are set under the Analytics tab.
Configuring Recipients for Alerts
Any number of users can be selected to receive notifications via the chosen delivery method. Use the Select All button to add all users at once or the Deselect All button to remove all users. To add a single user, click their name in the left column; to remove them, click their name in the right column.
Note: Only users who belong to the same customer as the cameras can receive notifications.
Deleting an Alert
To delete an alert, open the Alerts Menu and click on the alert name.
This will open a popup displaying the alert's settings. Click the Delete tab and then press the Delete button to remove the alert.
Disabling an Alert
Alerts can be disabled either for a specific period or permanently. To disable an alert, open it from the Alert Menu, then navigate to the Disable tab. Select a period for the alert to be disabled or choose the Permanent option to disable the alert indefinitely.
Introduction
To automate the process of Event data using the Starllion Cloud API, follow the steps below.
Before starting, ensure that Python is installed on the system. Python code will be written in the Python language. Additionally, it is recommended to install a software called "Anaconda" to easily install Python and Jupyter Notebook IDE for interacting with Python scripts.
Installing Anaconda
To download Anaconda, follow this link: (https://www.anaconda.com/).
Select the appropriate Operating System and click download. After installation, open Anaconda and select Jupyter Notebook from the dashboard.
Working with Jupyter Notebook
For instructions on how to use Jupyter Notebook, refer to the official documentation.
Once Jupyter Notebook opens in the browser, navigate to the desired directory where the code will be saved. From the 'NEW' option, select Python 3 (ipykernel) to open a new notebook in a browser tab.
The new tab will show an empty Jupyter Notebook for the project.
Writing the Code
The code should begin by importing the necessary libraries in the notebook. Insert the following lines into the notebook:
import requests
import json
import pandas as pd
from urllib.parse import quote
Next, define the necessary variables. Replace the username, password, and API key with actual credentials:
url = "https://admin-api.avycon.com/v3/auth/token"
username = quote('Your username')
password = 'Your Password'
apikey = 'Your API Key'
payload = f'username={username}&password={password}'
headers = {
'Content-Type': 'application/x-www-form-urlencoded',
'x-api-key': f'{apikey}'
}
Obtaining the API Key for Access
To obtain the Starllion Cloud API key, go to (https://admin.avycon.com), and click on the API Keys tab if signed in as an integrator. If signed in as a customer, request the API key from the integrator.
Generating the Token
Before retrieving event data, a "token" must be obtained using the GET method. To generate the token, use the integrator/customer credentials and integrator API key.
The token generation URL is: (https://admin-api.avycon.com/v3/auth/token).
In the next line, send a POST request to this URL. A response with status "200" indicates the credentials are correct and the token has been received. Any other response indicates incorrect credentials.
response = requests.request("POST", url, headers=headers, data=payload)
print(response)
Output example:
<Response [200]>
Create a function to convert the response into a JSON object to easily extract data:
def response_to_json(response):
data = json.loads(response.text)
return data
Save the token for use in future requests:
data = response_to_json(response)
token = data['accessToken']
Using the Token to Retrieve Event Data
Change the URL to retrieve a list of events from the specified camera. The URL format is:
https://admin-api.avycon.com/v3/events/camera?cameraId={camera_id}&from={time_from}&to={time_to}&type={event_type}
In the next line, insert the following code. Ensure the time format is accurate, or the API will return an error. Replace the camera ID with the actual camera ID. For the event type, enter "Analytics" for object detection events or "Motion" for motion events. In this case, "Motion" will be used as the event type.
df = pd.DataFrame()
camera_id = "Your Camera Id"
time_from = '2023-12-12T15:06:38Z'
time_to = '2023-12-13T15:06:38Z'
event_type = 'Motion'
url = f"https://admin-api.3deye.me/v3/events/camera?cameraId={camera_id}&from={time_from}&to={time_to}&type={event_type}"
payload = {}
headers = {
'Authorization': f'Bearer {token}',
'x-api-key': f'{apikey}'
}
response = requests.request("GET", url, headers=headers, data=payload)
camera_data = response_to_json(response)
try:
camera_data = pd.json_normalize(camera_data['data'])
except KeyError:
print(camera_data)
df = pd.concat([df, camera_data], ignore_index=True)
print(df['id'])
Saving Event Data as an Excel File
To save the event data to an Excel file, the pandas library can be used. Add the following line to save the data:
df.to_excel('Filename.xlsx')
The Excel file will be saved in the same folder where the Jupyter Notebook is located.
The Jupyter Notebook will look like this:
The saved Excel file will have the event data displayed in a similar format.
Stripe is a widely used payment processing platform that enables businesses to accept payments online. Integrating Stripe with Starllion Cloud can help streamline the billing process and simplify payment management.
Getting Stripe Account Information
Create a Stripe Account
To create a Stripe account, sign up on the Stripe website and provide the necessary details, such as business information, bank account data, and tax information.
Obtain API Keys
After the Stripe account is verified, the next step is to obtain the Stripe API keys. These keys are required to securely connect Stripe to the Starllion Cloud platform. The API keys can be accessed and managed through the Stripe Dashboard. The two keys needed are the Publish Key and the Secret Key, both of which should be kept confidential.
Note: Always refer to Stripe's official documentation for the latest information and best practices.
Adding Stripe Account Information in Starllion Cloud
Log in to the Admin Portal using integrator credentials. Once logged in, click on the integrator name located in the dropdown menu at the top right corner of the page.
From the dropdown menu, select Branding. This will open the Branding Page, where the Stripe Keys tab can be found.
On the Stripe Keys tab, enter the Publish Key and Secret Key in the respective fields. Ensure the Enabled checkbox is checked. After entering the keys, click Save to save the changes.
Once the integration is complete, any credit card information provided by customers will be stored in the Stripe account. When payments are processed through the admin portal, either manually or automatically, the funds will be credited to the connected Stripe account.
The Menu Profile section allows modification of user account credentials, including the ability to change the username, password, and email ID. Additionally, Multifactor Authentication (MFA) can be enabled or disabled for the account. To access the Menu Profile, click on the dropdown next to the account name and select Profile under the User section.
Changing the Account's First and Last Name
To update the first and last name, as well as the email ID, navigate to the User Info tab under Menu Profile. After making the desired changes, click Save to confirm.
Note: The first and last name or email address here is separate from the account contact information found under the Account Profile menu.
Changing the Email Address
The email address used to receive Starllion Cloud notifications can be updated. This email address also serves as the login credential unless changed to a custom username.
Changing the Account Password
To change the password for the Admin Portal, go to the Password Tab under Menu Profile. The current password must be entered before setting a new one.
Note: If the password is forgotten, a new one can be requested via the Forgot Password link on the Admin Portal login page.
Changing the Username
By default, the username is the email address used during account creation and is also used for logging into the Admin Portal. To change the username, go to the Username Tab under Menu Profile and uncheck the option to use the email as the username. After saving the changes, the email ID will no longer be used for login, and the new username must be used to access the Admin Portal.
To revert to the default email ID as the username, simply check the option to use the email again as the username.
Enabling Multi-factor Authentication (MFA)
To enable MFA, click the Enable button under the Multi-factor Authentication Tab in the Menu Profile. Multiple authenticator mobile app options will be presented. After selecting and installing an app, scan the provided QR code using the mobile app.
This will generate a 6-digit code, which must be entered in the Code box on the MFA tab. Click Enable again to activate MFA for all future logins.
Daily reports can be enabled for users at both the Integrator and Customer levels. If the users to be added to the Daily report recipients list are at the Integrator level, the report should be enabled at that level. For users at the Customer level, the Daily report must be activated at the Customer level.
There are Daily reports available for individual Customers as well as for Integrator level users, which cover all customers at once. To disable the Daily report at the Integrator level, log in with the Integrator account and navigate to the Alerts menu on the top menu bar.
To manage the Daily report for a specific Customer, first go to the Customers menu, select the Customer to modify, and then choose Alerts from the Customer's menu level.
Users in the contact list will be associated with the Customer for whom the report is being activated.
The customer owns the cameras and equipment and seeks to connect these assets to Starllion Cloud services. Access to all cameras under the customer's account is granted, unless restricted by the integrator.
Users can be assigned two types of roles:
Admin Role: Grants access to both the Admin Portal and the Video Portal.
Guard Role: Grants access to the Video Portal only.
An Admin user has access to the Admin portal and can view and configure cameras and alert settings based on assigned roles. The Admin can also add new cameras and modify those for which permission has been granted by the customer or integrator.
A Guard user has no access to the Admin portal. Guards can only view assigned cameras via the web interface or mobile app, create clips, use PTZ controls, and/or share cameras with others according to the assigned roles.
Creating a New User
To create a Customer-level user, first select the menu bar, then choose the "Users" option and click the "Add" button. If the role already exists, it can be added immediately; otherwise, the role can be left blank and assigned later.
Multiple roles can be assigned to a single user, and the same role can be assigned to multiple users. However, a user can only have one type of role at a time, either Admin or Guard. To change a user's role from Admin to Guard, all Admin roles must be removed from the user's role list, and the Guard role(s) added. This can be done by clicking on the user's name in the Users table, selecting the "Roles" line in the User Info tab, and clicking on the role names to add or remove them.
Creating a New Role
To create a role, select the customer for whom the role will be created, then go to the "Roles" option in the Customer-level menu. Click "Add," provide a name, and choose the role type. The Admin type grants access to both the Admin portal and the Video portal, while the Guard type grants access to the Video portal only.
If all cameras should be added to the role, leave the checkmark for "Add all cameras to the role" selected. If specific cameras are to be added, remove the checkmark and manually select the cameras. Cameras from other customer accounts cannot be added to the role.
To modify an existing role, click on the role in the Roles table. Camera assignments and user permissions can be changed. In the Users tab, the role can be added or removed for specific users.
Creating a sales manager user and assigning customers and/or sub-integrators to them is an effective method for managing multiple accounts. This approach helps streamline the sales process and enhances overall business performance.
This process allows different individuals to be designated as sales managers for various accounts, making it easier to track and manage sales activities.
To start, navigate to the Managers menu in the platform and click the Add button. Then, select User. From here, a new user account can be created for the sales manager by providing necessary information such as name, email, and password. The Sales Manager role should be selected from the list.
After the sales manager account is created, customers and/or sub-integrators can be assigned by selecting the "Customers" option. This grants the sales manager access to these accounts for management.
It is possible to have multiple sales managers, which is beneficial when managing a large number of accounts. Appointing different sales managers to different accounts can improve the efficiency and effectiveness of the sales process.
Note: Only one unique Sales Manager can be assigned to a customer or sub-integrator at a time.
Starllion Cloud is a cloud-based video surveillance platform that enables remote monitoring and management of cameras through a Video portal or mobile application. A notable feature of Starllion Cloud is the alert system, which sends notifications when specific events occur, such as motion detection or camera disconnection. However, there may be instances when disabling or deleting an alert is necessary to reduce the number of notifications. This guide outlines the steps to disable or delete an alert in Starllion Cloud.
Disabling an Alert
Disabling an alert temporarily stops notifications without permanently removing it. To disable an alert in Starllion Cloud, follow these steps:
Step 1: Log in to the Starllion Cloud Account
Access the Admin portal and log in using the appropriate credentials.
Step 2: Navigate to the Alert Settings
Once logged in, go to the Alert Tab. Select the desired alert and click on it to open the Settings tab.
Step 3: Disable the Alert
Under the Settings tab, go to the Disable option and select a duration from the drop-down menu. After selecting the period, click the 'Disable' button to deactivate the alert.
Starllion Cloud allows alerts to be disabled for periods ranging from 3 hours to a full day, or even permanently. Disabling alerts temporarily gives the flexibility to re-enable them later without needing to recreate the alert.
Step 4: Enabling the Alert
Alerts that are set for a specific duration will automatically reactivate once the chosen time has passed. For alerts that were permanently disabled, or if an alert needs to be re-enabled before the set duration ends, follow the same steps and, on the Disable tab, click the 'Enable' button to resume notifications.
Deleting an Alert
Deleting an alert removes it permanently from the account, meaning no further notifications will be received for that alert. To delete an alert, follow these steps:
Step 1: Log in to the Starllion Cloud Account
Log in to the Admin portal using the proper credentials.
Step 2: Navigate to the Alert Settings
Once logged in, go to the Alert Tab. Select the alert to be deleted and open the “Settings” tab.
Step 3: Delete the Alert
Click on the Delete tab and press the Delete button. Note that this action is irreversible, and no confirmation prompt will appear before the alert is permanently removed.
Disabling or deleting alerts on Starllion Cloud is a straightforward process within the Admin portal. Disabling an alert allows temporary halting of notifications without deletion; while deleting it removes the alert permanently from the account. By following these steps, managing alerts ensures that only necessary notifications are received, avoiding unnecessary interruptions.
Both integrator-level and customer-level users (owners and admins) can edit user accounts. Integrators have full control over the users within their child accounts, with the exception of the Owner account, which can only be modified by the Owner themselves. Modifications can include changing the name, username, and password, as well as enabling or disabling a user and assigning roles. Disabling a user prevents access to the platform without permanently deleting the account, allowing for easy restoration of access when needed.
To modify a user with integrator-level access, select the customer account to which the user belongs and navigate to the User tab.
For customer-level access, go to the Users menu and select the user to modify.
Changing the User's Email
To change a user's email, select the User Info tab and enter the new email address. Afterward, click Save to apply the changes.
Note: Since the platform uses the email as the username by default, changing the email will also change the login username. If the user has set a custom username, the email change will not affect the username, and the user will continue to log in with the custom username.
Changing the User's Password
To update the user's password, navigate to the Security Tab. There are two options to change the password:
1. Enter a new password without notifying the user.
2. Generate a random password and notify the user by email.
Enabling or Disabling the User
Both the Owner and the Integrator can enable or disable a user. Disabling a user is a reversible action, while deleting a user is permanent.
To enable or disable a user, go to the Security Tab under User and select the button to change the user’s status.
Assigning or Removing Roles
User roles determine which cameras and permissions a user has. Multiple roles can be assigned, but only roles of the same type can be assigned together. To change a user’s role from guard to admin or vice versa, all roles must be removed first before assigning the new role. The first role assigned to a user will define the user’s type.
Note: Shared Camera roles can be assigned to any user, regardless of other roles.
Setting a Custom Username
A custom username can only be set by the user when logging into the Admin portal. To set a custom username, the user should open the Profile option from the Profile dropdown, click on the Username tab, uncheck the "Use email as username" box, enter a new username, and click Save. After this change, the user must use the custom username to log in, and email will no longer serve as the username. The password will remain the same.
When an ONVIF camera fails and requires replacement, the following procedure should be followed:
Replace the old camera with a new one.
Configure the new camera to the same local IP address and ports or update the port forwarding rules to direct to the new camera.
Open the camera in the admin portal and wait for the servers to detect the change in ONVIF configuration.
Overwrite the existing configuration.
Adjust the camera parameters as needed.
Customized Branding
With co-branding features, various elements of the login pages can be customized:
Upload a custom logo
Change the background color
Set a custom favicon
Configure a sub-domain to align with the branding of the company or customer
Modify the colors and content of welcome and alert emails
Create individualized co-branding for each customer
While these customizations are available, Starllion Cloud will still appear in the URL, and the copyright will remain visible in multiple locations. No additional fees apply for these customizations.
Example: https://demoportal.starllion.com/
Process for Customization
The first step is for the integrator to submit a request for a URL change, which will take up to one business day. After this, the integrator can configure the branding page.
Co-branding is available at both the integrator and customer levels. If the integrator applies co-branding to their main account, it will propagate to all customers, unless a separate branding is set for a specific customer. Co-branding configured for an individual customer will not affect other customers.
This customization is particularly important for emails sent specifically to the integrator or customer.
Step-by-Step Customization Process
Step 1: Access the Branding Page
Navigate to the Branding section under the user account information to begin customizing the portal.
Step 2: Select the General Tab
In this tab, the company name or product name can be modified. This name will appear in branded emails, the Admin Portal, and the Video Portal.
Step 3: Select the Admin Portal Tab
The Admin Portal tab allows for customization of the login page. A URL change request must be submitted to begin this process.
Step 4: Request the URL Change
To request a URL change, click on "change" next to the Admin Portal URL heading. A pop-up will appear where the new URLs for the Admin Portal, Video Portal, and Alarm Station can be entered.
Note: The "starllion.com" domain will still be part of the new URL.
Custom URLs are accessible by any customer, even if the URL is not specifically assigned to them. Users can view the design created for a specific URL, even if they belong to a customer with their own co-branding.
Step 5: Set Up the Video Portal
Similar to the Admin Portal, customization of the Video Portal can occur once the URL change request is approved.
Step 6: Customize the Email Template
Letter branding allows customers to customize the emails sent from the 3dEYE server. Customers can enable or disable letter branding without submitting a request. When enabled, the header and footer of the email can be customized with a user-defined logo or text, or completely removed. Additionally, the link to the mobile app can be customized with a new app link.
Step 7: Customize the Shared Page
The Shared page branding allows customization of the page shared with users or non-users of AVYCON Cloud through a link or email. This page enables recipients to view camera clips.
Step 8: Set Up the Alarm Station
Just like the Admin Portal and Video Portal, the Alarm Station can be customized once the URL change request is approved.
Notes: When content is shared from the Starllion Cloud platform, the link generated depends on the customer to whom the camera belongs. If content is shared from a branded customer, the link will use the branded video portal URL. Content shared from an account without branding will default to the standard video portal URL.
The appearance and features of the portal are also tied to the URL. Changing the URL prefix modifies the branding and features of the portal. If the branded URL is replaced by the Starllion Cloud URL, the branding will be removed from the link. However, camera access remains unaffected by changes to the URL or branding.
Additionally, the branding of the customer to whom the camera belongs will dictate the link included in alerts, ensuring consistency in the user experience.
In summary, the generated link when sharing content, the appearance of the portal, and the link in alerts all depend on the customer’s branding and the associated URL. Customization is tied to the URL prefix, while camera accessibility remains unchanged.
Menu Alerts at the Customer level enable the creation of alerts for both sensor and system events. Alerts set up at this level can be delivered exclusively to users associated with the selected customer. Delivery methods include email alerts or push notifications when server analytics triggers the event.
To create a new alert or edit an existing one, first, open the Customers table and select the customer for whom the alert should be created or modified. Then, navigate to the Alerts tab in the customer menu and click either the "Create Sensor" or "Create System Event" button to set up a new alert. To modify an existing alert, simply click on it and adjust its settings.
For receiving notifications related to motion events, line-crossing, intrusion, analytics, or any other sensor-related events, click on the "Create Sensor Event" button.
On the first tab, provide a name for the alert and choose the Alert type, which determines the event that will trigger the alert. Alerts can be scheduled to be active at any time or during specific periods. Days and hours of the week can be selected for the alert’s active times, with orange squares indicating active periods and white squares representing inactive times.
Notification filtering allows control over the frequency of email deliveries. The system can either send notifications immediately, if the checkbox is unchecked, or aggregate events within a specified timeframe and send one email summarizing all the events.
Note: Mobile Push notifications can only be used for server-generated events, such as object detection and face recognition. Camera-side events are limited to email notifications only.
After configuring the alert settings, click "Next" or go to the Cameras tab to begin adding cameras to the alert.
Any number of cameras can be added to the alert. To reduce false alerts, the Dual Technology option can be used. When enabled, notifications will only be sent if the event is detected by all cameras in the Selected Cameras table simultaneously.
The final step is selecting recipients. Click "Next" or navigate to the Contacts tab to add users to the recipient list. To add a user, click their name from the Available Contacts table or use the "Select All" button to add all users at once.
Note: For push notifications to work, the recipient must install and log in to the mobile app using a username from the Selected Contacts table.
To set up a new alert for when a camera loses connection with the cloud, use the "Create System Alert" button.
Follow the same steps as for the Sensor alert to set the alert name, schedule, notification filtering, and delivery method. Then, add cameras and choose recipients, as described for the Sensor alert.
Note: Mobile push notifications for Camera Down events are currently unavailable. The page will be updated once this issue is resolved. For those needing push notifications for Camera Down events, submitting a ticket will ensure updates when this feature is available. Push notifications for object detection are functioning as expected.
Menu Alerts at the Integrator level provide the ability to create alerts for system events, which can be sent to the main integrator email inbox or to registered managers. This feature allows for the creation of rules to consolidate alerts for all customers into a single inbox, eliminating the need for multiple emails for each customer.
To create a new alert, click on the "Create System Event" button and select the customer for whom the alert is being created. On the following page, configure the parameters for the new alert.
The notification filtering option allows for aggregating alerts into a single notification, rather than sending a new alert each time an issue occurs with one of the selected cameras.
Note: Mobile push notifications for Camera Down events are currently unavailable. The page will be updated once this issue is resolved. For those who require push notifications for Camera Down events, submitting a ticket will ensure notifications when this functionality becomes available. Push notifications for object detection are working as expected.
API methods enable the integration of custom or third-party software with the platform. Currently, over 75 methods are available, allowing the creation, modification, and deletion of various platform components through a custom interface, with the capability to automate routine tasks.
To use the API methods, an appropriate API key for the correct customer level is required. Each integrator and customer have a unique API key, which can be accessed through the API Keys menu or by using the integrator's API key along with the "Get API Key" method from the collection. For instance, when creating a new customer, the integrator's API key is needed, while for adding and assigning a new camera to an existing customer, the customer’s API key is required.
To access documentation and view the integrator API key, open the profile menu and select the API menu.
API keys for customers can be renamed by selecting the key and editing the name field.
To disable specific API methods for a customer, use the Enable/Disable slider.
To access documentation and usage examples for API methods, open the API menu from the profile dropdown and click on the API Documents link.
The Menu Cameras at the integrator level displays cameras assigned to all customers, excluding those assigned to sub-integrators' customers. To view cameras assigned to customers under a sub-integrator, log in with the operational manager credentials of that sub-integrator.
The Menu Cameras opens on the P&P Cameras tab, showing only P&P cameras for all customers. To view ONVIF and Generic cameras, switch to the Customer Cameras tab. To see a history of deleted cameras, go to the Deleted Cameras tab.
To register a new camera, use the Add button. When accessed from this menu, the Add button provides additional options compared to when it is used in the customer-level menu.
The first step involves selecting a customer to assign the new camera to or choosing the "Your P&P Cameras" option to pre-register the camera in the system for quick future assignment.
This pre-registration creates a stock of cameras in the system, listed as Registered in the table, which simplifies the activation process to just two steps once the camera is deployed on the customer premises:
1. Choose the customer to whom the camera will be assigned.
2. Choose the billing plan.
To view the camera's properties, click on the camera name. Note that the table does not refresh in real-time; it is only updated when the table is opened or when the Refresh button is used. If the camera state changes after the table is opened, the change will not be displayed automatically. To update the camera status, click the Refresh button.
To modify the visible columns, click the Columns button and select the desired columns.
Adjust the number of entries shown per page by selecting the appropriate option.
Sort the table by any column by clicking the arrows to set the column as the primary sorting field and choose either ascending or descending order.
Use the search feature by typing in the column header to find a specific ID, name, email, etc. Partial names or values can be used across multiple columns to narrow down the table. To clear the search, click the "x" next to the text field.
Click the Reset Filters button to clear all entered filters across the columns.
To restore the table to its default settings, use the Reset Settings button.
The Menu Customers displays a list of all current customers and integrators. To view the properties of a customer, click on their name. The table is not updated in real-time; it is refreshed each time it is opened or when the Refresh button is used. Therefore, if changes have been made by others while the table was open, a refresh is required to view those updates.
For viewing deleted customers and integrators, navigate to the Deleted Customers tab.
To modify the columns displayed, click on the Columns button and select the desired columns.
The number of entries shown on a single page can be adjusted.
The table can be sorted by any column by clicking on the arrows to set the selected column as the primary one and choosing either ascending or descending order.
To search for a specific ID, name, email, or other attributes, begin typing in the column header. Partial names and values can be used across multiple columns to filter the table. To clear the search, click the "x" button.
Click the Reset Filters button to clear all applied filters across the columns.
The Reset Settings button restores the default table settings.
The Menu Events section displays a log of all events detected by the cameras or related to camera activity. This includes Sensor Events such as Object Detection, Face Detection, Motion, Intrusion Detection, and Line Crossing. The event log does not specify the type of object detected but rather identifies the event type. To filter events based on the object, the Event Menu in the Video Portal should be used.
To view the event log within a specific timeframe, first select either "By Time" or "By Period" at the top of the page. Then, choose the desired date range by adjusting the From and To fields. Clicking on the date will open a calendar where the date range can be selected.
Columns visible on the page can be customized. To adjust the columns, click the Columns drop-down menu and check or uncheck the column names. Only selected columns will be displayed. Events can be sorted by any column. Clicking the up-down arrow next to a column name will set that column as the active one, sorting the events accordingly.
To remove all filters and restore the default event view, click "Reset settings." The "Reset filters" option can also be used to clear any previously applied filters.
Under the Logs menu at the Integrator level, all manager and integrator activities can be reviewed.
The table can be displayed in three different ways:
By Count: Displays either the most recent entries up to the selected time or the last entries within the selected time.
By Time: Shows entries for the most recent specified number of hours.
By Period: Displays all logs for the chosen time period.
To view the details of any log entry, click on it. The table does not refresh in real-time but is read each time it is opened or when the Refresh button is used. Therefore, if activity occurs after the table is opened, it will not automatically appear. To update the log list, use the Refresh button.
To modify which columns are shown, click the Columns button and select the desired columns.
The number of entries displayed on a single page can also be adjusted.
The table can be sorted by any column. Clicking the arrows next to a column header will make it the primary sorting column, allowing sorting in ascending or descending order.
To search for a specific ID, name, email, or other criteria, start typing in the column header. Partial names or values can be entered across multiple columns to narrow down the results. The "x" icon clears the search text.
The Reset Filters button clears any applied filters across all columns.
The Reset Settings button restores the default table settings.
Menu managers display all users with manager access levels. There are two types of managers:
Operational manager
Billing manager
Currently, both manager types have identical permissions, access levels, and functions. However, when billing is expanded in the future, these roles will diverge. For now, use the Operational manager role for new accounts intended for existing customer management or the creation of new customers.
To modify a manager's password, delete their account, or review activity logs, click on their name in the table and select the appropriate tab. Under the User tab, the current role can be deleted, and a new role can be assigned.
In the Security tab, a new password can be set, and the manager can be disabled to restrict access to the system. Two options are available for password changes:
Without notifying the manager
With an email notification containing the new password
To add a new manager, click the Add button. In the popup window, enter the manager’s name and email, select a role, and create a secure password. Alternatively, a temporary password can be generated and sent in the invitation email, requiring the manager to change it upon first login.
To adjust the columns displayed, click the Columns button and choose the desired columns.
The number of entries shown on a page can be modified as well.
The table can be sorted by any column by clicking on the arrows to arrange the selected column in ascending or descending order.
To search for a specific ID, name, email, etc., start typing in the column header. Partial names or values can be used across multiple columns to filter the table. Clear the text using the "x" button.
Click the Reset Filters button to remove all entered filters.
To restore the default table settings, click the Reset Settings button.
Introduction
The Menu Profile section allows modification of user account credentials, including the ability to change the account password and username. Additionally, Multifactor Authentication (MFA) can be enabled or disabled. To access the Menu Profile, click on the dropdown next to the account name and select 'Profile' under the User section.
To Change the Account's First and Last Name and Email ID
Account first and last names, as well as the email ID, can be updated in the User Info tab within the Menu Profile. Changes will be saved by clicking Save.
Note: The first and last names or email address here are distinct from the account contact details stored under the "Account Profile" menu.
To Change the Account Password
To update the account password, navigate to the Password tab. The current password must be entered to set a new one.
Note: If the password is forgotten, a new password can be requested from the Admin portal login page by selecting the "Forgot password" link.
To Change the Username
The default username is the email address used during account creation. This email is also used for logging into the Admin Portal. However, the username can be changed from the default email to another preferred identifier. This can be done in the Username tab under the Menu Profile.
To change the username, first uncheck the box that uses the email as the username. After saving the changes, the account will require the new username for login; the previous email address will no longer work for logging in.
To revert to using the email as the username, simply select the option to Use email as username.
To Use Multi-Factor Authentication
To enable MFA, click the Enable button in the Multi-factor Authentication tab within the Menu Profile.
After selecting an authenticator app, install it on the mobile device. A QR code will appear in the MFA tab, which needs to be scanned with the app. The app will generate a 6-digit code, which must be entered in the provided field on the MFA tab. Click Enable again to activate MFA for the account, requiring authentication at every login.
Single Sign-On: Overview and Configuration
Understanding Single Sign-On (SSO)
Single Sign-On (SSO) is an authentication method that enables access to multiple connected but independent software systems through a single login credential. When SSO is properly implemented, a user signs in once and gains access to all related applications without repeated authentication prompts.
SSO operates through a trust relationship between an identity provider and a service provider. This relationship is typically established using a digital certificate that ensures the identity data shared between these systems originates from a trusted source.
Commonly used web applications—such as Microsoft 365, GitHub, and Salesforce—can integrate with SSO systems. These applications are accessed through web browsers and benefit from SSO by allowing seamless transitions between services without repeated logins.
SSO implementation in cloud-based applications may involve protocols like OpenID Connect, OAuth, SAML, password-based methods, or linked sign-on. It is also possible to disable SSO if needed.
Steps for Configuring SAML-Based Single Sign-On
Step 1: Set Up a Custom Domain
If a custom domain has not yet been assigned for the Admin Portal or Video Portal, it should be configured on the Branding page. Skip this step if a custom domain is already in place.
Select the “change” link within the Admin Portal page to open the domain request dialog.
Enter the desired domain and submit the request. Processing may take up to one business day.
Step 2: Configure ADFS
ADFS (Active Directory Federation Services) must be configured to support access from the defined custom domains (e.g., video-my-brand.starllion.com, admin-my-brand. starllion.com). Instructions are available at:
https://docs.microsoft.com/en-us/aspnet/core/security/authentication/ws-federation?view=aspnetcore-6.0#register-the-app-with-active-directory
Step 3: Enter SAML Configuration
Identity provider details must be added on the Single Sign-On settings page.
Service Provider Entity ID and Secret Key values can be obtained from the FederationMetadata.xml of the ADFS instance. For example:
http://your.identity.provider/FederationMetadata.xml
Sign-in page URL example:
https://your.identity.provider/adfs/ls/idpinitiatedsignon.aspx
Sign-out page URL example:
https://your.identity.provider/adfs/ls/?wa=wsignout1.0
Upon completion, the login interface will display the logo of the designated identity provider at the bottom of the login form.
Step 4: Configure User Access
Users must be added under the corresponding customer account using the same email address found in the organization's identity system. Only users assigned the "guard" role are eligible. To initiate this process, select the “Add External User” option from the customer’s User menu—this becomes available once the earlier steps are completed.
Complete the user form, ensuring email address consistency between the identity system and the platform.
Once setup is finalized, any user marked as an External user will authenticate exclusively through the organization’s identity system and will not be able to log in directly through the standard video portal. Users not marked as External will retain access through the traditional login pages.
bottom of page