CyberGate Management Portal

how to use the cybergate management portal introduction the cybergate management portal is designed to easily setup and configure cybergate it allows you to setup cybergate consent, licensing, device creation, groups definition enable features within cybergate recording, portal access monitor cybergate call log, audit trail, notifications configure the cybergate for teams app about this manual this manual describes all functionality of the cybergate management portal using screenshots, description of features and examples the cybergate management portal the cybergate management portal is the portal to configure cybergate to fit your requirements after cybergate is activated you can login to the cybergate management portal at any time, as long as you log in with one of the following microsoft admin accounts global administrator application administrator cloud application administrator teams administrator you can also assign a microsoft group that contains one or more users that are also allowed to access the cybergate management portal although they have no administrator rights see 'portal access' for more information cybergate management portal features licensing increase / decrease the number of devices you would like to use to connect to microsoft teams you don't have to go to microsoft marketplace or a microsoft portal to change this, you can modify this amount easily in the cybergate management portal portal access manage access of non admin users to the cybergate management portal notifications cybergate can send notifications via email and/or teams channels configure the receivers of notifications and the notification types call log view and/or download the call log cybergate keeps track of all calls made via cybergate global set admin consent access the audit trail enable / disable features call forwarding trunk support call recording modify security policies access cybergate tools network manage allowed public wan ip addresses / domain names (cybergate whitelist) sip trunk configure sip trunks (only available when 'trunk support' is enabled device settings add / remove devices rename devices this will change the identification of the device when calling to microsoft teams enable / disable the recording of calls per device enable / disable the option to call the device from microsoft teams enable / disable cybergate add ons call groups add / remove call groups a call group is a group of users and/or groups that can be used in cybergate modify call group settings and/or participants cybergate teams app modify settings related to the cybergate for teams app cybergate menus the cybergate management portal consists of four main sections administration basic teams app support administration the administration section contains license related settings of the cybergate subscription licensing name the name of the subscription created the creation date of the subscription plan the name of the chosen plan during cybergate purchasing quantity shows the actual licensed amount of intercoms that can be used requested quantity the amount of requested device licenses usually the 'requested quantity' number is equal to the 'quantity' number enabled if the cybergate license is active and paid, the 'enabled' status will show 'yes' if it shows 'no', this subscription and the intercoms using this subscription will not work in that case check the subscription in the microsoft portal ( https //portal microsoft com ) for more details to increase or decrease the number of licensed devices, click on the blue 'edit' symbol and click on the '+' or ' ' symbol by increasing the number of licenced devices the monthly cost will also be increased, decreasing the number of licenced devices will decrease the monthly cost after modifying the amount of licenced devices, the 'quantity' number might not be equal to the 'requested quantity' number it can take up to 10 minutes for microsoft to implement the subscription change after that, the numbers should be equal portal access the portal access section lets you modify access to the cybergate management portal it allows non admin users to log in to the cybergate management portal to add a group click 'add group' to grant a group access to the portal pick a group from the drop down menu or enter the group id to add to revoke access to the cybergate management portal, click the red 'delete' button in the action menu access for the deleted group will be revoked immediately notifications cybergate can send notifications for different subjects regarding the cybergate service these notifications can be send via email or posted on a microsoft teams channel the notifications section lets you configure what notifications to receive and who should receive them cybergate can send notifications for the following categories tech alerts about service disruptions and information about new features email only license receive alerts when subscriptions are about to expire device notifications regarding device status news latest news and updates about the product and company (might contain marketing) email only survey surveys to gather user feedback and improve our services contacts in the contacts tab, click 'add contact' to add an email contact add the following information first name first name of the contact last name last name of the contact email the email address on which to receive the email use the blue 'edit' button to edit the email contact, the red 'delete' button will delete the contact teams channel to add a teams channel as notification navigate to the teams channel tab click 'add teams channels' to add a teams channel add the following information channel name enter the channel name teams webhook url enter the teams webhook url see note 1 note 1 follow these steps to add the app to your channel if your team and channel already exist, skip to the next step otherwise, create them first search for 'workflows' app in the searchbar of teams create a new flow with the 'send webhook alerts to a channel' template follow the installation wizard copy the webhook url provided this is the url you will paste into the management portal to test that it’s working go to the modal for teams channels and paste the link a test button will appear click it if everything was set up correctly, you’ll see a message use the blue 'edit' button to edit the name of the teams channel, the red 'delete' button will delete the teams channel call log the call log provides a detailed overview of all calls processed by cybergate you can view call details, filter and sort entries, inspect individual call events, export logs to csv, and configure how long call data is retained call log the call log will show the most used information in the overview the caller, responder, call status, timing, and duration to see more detail, click the 'show detail' button to see every registered step per call log event, click the blue 'info' button for a more detailed description of the call log entries, filtering options and details, see the docid\ a5lf paikpw2esmiyzorw document export navigate to the export tab click 'generate csv' to generate a csv file from the call log the csv generation runs in the background, the download button will appear once the export is ready retention navigate to the 'retention' tab modify the retention time of the call log (1 30 days, 8 days is the default value) changes to the retention period can take up to one hour to take effect decreasing the retention period will permanently remove call log entries older than the new retention time api access cybergate exposes a customer api that allows you to programmatically manage your tenant's resources retrieve the call log retrieve the audit trail set availability status for the configured call groups open the door using an api call (during an active call) for a more detailed description of the cybergate api, see the docid\ wnuet5cdj labmdwmxyob document the api access menu lets you create and manage api secrets that are used to authenticate your api calls api access must be enabled for your tenant before you can create api secrets if the customer api is not yet enabled, the page displays a notice with a contact support button clicking this button opens a pre filled support request to enable api access for your tenant manage the api secrets used to authenticate calls to the cybergate customer api each api secret has a name, a validity period, and a secret value that acts as a bearer token for api authentication click 'create api secret' to generate a secret add the following information name enter the name for this secret validity period (days) set the period this secrets remains valid (10 365 days) after creation, the modal displays the generated secret value along with a copy button copy and store the api secret immediately the full secret value is only shown once and cannot be retrieved later if you lose it, you will need to create a new secret you can have a maximum of 4 api secrets at any time if you have reached this limit, the create button will be disabled with a tooltip explaining the restriction delete an api secret to delete an api secret, click the red 'delete' button in the actions column deletion of the api secret cannot be undone the deleted secret will be revoked immediately and all api calls using this secret wil l fail from the moment of deletion basic the basic section allows you to modify general cybergate settings global c onsent admin consent has to be provided for cybergate to be able to communicate to the teams environment of the tenant this is already done during the cybergate purchase and configuration future updates of cybergate might require updating the admin consent to activate new features audit trial the cybergate audit trail feature consists of the audit trail that tracks all actions done in the cybergate management portal with the option to set a custom retention period and option to download the audit trail as a csv file change settings modify the audit trail retention time show audit trail show the complete trail export to csv download the audit trail as csv file features the features tab contains optional cybergate features, all disabled by default call forwarding the 'call forwarding' option in this section enables / disables calls to teams users that are forwarded to other users or to the teams voice mail system by default, calls to forwarded destinations (such as voice mail) are ignored therefore a call from the device will not be answered by the voice mail system if a teams user has its account forwarded to another teams user, call forwarding should be enabled to make it work keep in mind that this will also enable call forwarding to the teams voice mail system trunk support the 'trunk support' option enables the possibility to connect sip trunks to cybergate sip trunk support is necessary when your intercoms are connecting via another device that connects to cybergate this is usually called a sip trunk please contact cybertwice when you have questions regarding this feature call recording recordings are handled by the cybertwice cloud service called attest when enabled, calls from all your devices will be recorded you can disable recording per device in the device section see the seperate docid\ bqis0jlckmucnuzpshpas for information about the recording feature and instructions on how to use it security the security tab show option regarding to extra security settings security policies the secure only policy will enforce secure sip communication using tls 1 2 and encrypted audio/video for all the devices you connect to cybergate when enabled, connecting over udp / tcp to cybergate will not be possible anymore, only sip tls and srtp will be allowed when the policy is disabled, devices can communicate using both secure sip tls and unsecure udp / tcp, as well as use encrypted and unencrypted audio/video tools communication test script the communication test script helps with troubleshooting possible connection problems between your local network and the online cybergate service this easy to run powershell script detects any connections that might be blocked by a firewall network the network section lets you configure your cybergate white list one of the security measures of cybergate is a white list that contains the public wan ip addresses used to connect to cybergate in order for a device to register with cybergate, the public wan ip address your intercom is using to connect to cybergate has to be configured in the basic network menu the network section also features an option to add 'configured device location domain names' this option is currently limited to users of the genetec sipelia cloud deployments to add one or more wan ip addresses click 'add wan ip address or range' add the wan ip address (optional define a range of addresses) add an optional description and / or location sip trunk the sip trunk menu is only visible when the option 'enable trunk support' in the global menu is enabled sip trunk settings lets you add and delete one or more sip trunks or modify the name of a sip trunk sip trunks can currently only be used with commend comelit and genetec when using a sip trunk to connect to cybergate, cybergate will detect all the devices that are calling through that sip trunk and will automatically add these devices to the sip trunk section of the device section each created sip trunk generates its own authentication username and password this information can be easily copied using the blue 'copy to clipboard' buttons and can be used in the sip configuration of the sip trunk outgoing username and outgoing password some sip trunks such as genetec sipelia require credentials to communicate back to the sip trunk modify these credentials by clicking the blue edit symbol modify a sip trunk click on the blue 'edit' button in the actions column to edit the name of the sip trunk delete a sip trunk to remove a sip trunk, click on the red 'delete' button to delete it this action can not be undone a sip trunk can not be deleted if there are devices that use this sip trunk in that case delete these devices in the device section before deleting the sip trunk device device the device shows all devices available in cybergate by default, no device is displayed the device menu lets you add, modify or delete devices the 'sip trunks' section in the device menu is only visable when the sip trunk feature is enabled add a device to add a new device, click on the blue 'add device' button it will open a dialog box to configure the new device add / change the following information and click 'add' display name enter the name for this device type set the type to match your device (intercom / camera / pager) record device only available when recording is enabled (basic global features) allow 2 way video only avaible for devices that support receiving video allow calls from teams to device enable for the option to call the device from teams client notifications enabled enable to receive notifications regarding this device availability the device will be created and will automatically generate a sip username and sip password that can be used in the device use the blue copy buttons to conveniently copy the username and password in the device configuration when configuring your device each device added shows display name the display name is the name that will be shown in microsoft teams when the device calls a teams user authentication username the username is necessary when configuring the device password the password is necessary when configuring the device add ons shows the (optional) installed add ons for this device licensed you can create more devices than your subscription allows in that case the devices that exceed the number of devices on your subscription will show 'licensed no' and will not work as soon as you increase the amount of intercoms on your subscription the device licensed state will change to 'yes' recorded indicates if recording for this device is enabled or not teams to device indicates if the teams to device feature (makes it possible to call the device from the teams client) for this device is enabled or not modify a device click on the blue 'edit' button in the actions column to edit the device settings after changing the device name, you'll have to download and execute the powershell script on this page using the download link delete a device to remove a device, click on the red trash can symbol to delete it this action can not be undone if the display name field will show the name and show an exclamation mark symbol, the device will be able to call to microsoft teams, but will show the name 'intercom' instead of the custom display name until you execute the powershell script that can be downloaded on this page refer to docid 9eb9dah1 czwry zltcdq f or instructions on how to modify the display name from the default 'intercom' to the display name given call group the call group section lets you configure one or more call groups each call group can contain teams users and/or other call groups (depending on the call group type) a call group can be called directly from a device and will initiate calls to the entries in the call group as if it was one destination there are three types of call groups multi ring can contain up to 15 participants a participant in a multi ring group is always a teams user all participants in this group will be called simultaneously the 1st responder will be connected to the device sequential can contain up to 15 participants a participant in a sequental group can be teams user or a multi ring group the participants will be called after each other (top to bottom) as soon as one participant answers, the sequential calling stops meeting can contain up to 15 teams participants a participant in a meeting group is always a teams user when calling a meeting group from a device, the device will start the meeting and actively call all configured participants to join the just started meeting the device keeps ringing until the first participant joins this way, multiple teams users can communicate with the device and see its video c re ate a call group click 'add call group' to create a call group group there are three different call groups to choose from multi ring n ame name the group description describe the group type select multi ring sequential n ame name the group description describe the group type select sequential ring duration set the ring duration per entry (between 5 30 seconds) make sure the call timeout configured in the device is set to a value that allows sufficient time for all participants to ring meeting n ame name the group description describe the group type select meeting teams meeting url insert the meeting url of an existing teams meeting this meeting wil be started when this group is called by the device timeout no participants joined set the time the device waits for participants to join the meeting if this time expires the connection from the device will be disconnected (between 15 600 seconds) timeout no participants left set the time the device waits before disconnecting when all connected participant have left the meeting (between 1 600 seconds) to retrieve the necessary teams meeting url, see the docid\ v3pbyfy4unt qvnbe4zx7 faq document each call group has a name consisting of the given name combined with the fixed domain cybergate cybertwice com e g if the name is 123, the name to dial in the intercom will be 123\@cybergate cybertwice com this name can be copied using the blue copy button behind the name and pasted in the device configuration the domain part of a call group is always cybergate cybertwice com, this is because a call group is a cybergate feature and not a microsoft teams domain feature add participants to a group each newly created group is configured without participants to call click on the blue 'edit participants' button in the actions column to add / edit the participants add the paticipants by pick from the dropdown start typing a name and select from the suggestions these are users and groups from your organization type an email manually enter a full email address the domain has to be one of your organization's verified domains click show to see the list of verified domains you can add multiple participants simultaneously expanding rows to see participants click the arrow (>) on the left of any row to expand it and see who's in the group for sequential groups, participants show up numbered so you can see the ringing order at a glance reordering participants (sequential only) for sequential groups, the order of the participants determines who rings first, second, third, and so on tor reorder the participants open the sequential call group by clicking the blue 'edit' button in the action menu drag the participants in the right order using the 'handle' icon on the left side the new order saves automatically deleting a call group click the red 'delete' button in the actions column this is permanent the group and all its participant associations are deleted immediately ad d supervisors to a group a supervisor is a teams user that has the permission to modify call groups from the 'cybergate for teams app' by default a call group does not have a supervisor defined as this is an optional feature and not necessary for the functioning of a call group a supervisor of a call group can perform the following tasks in the cybergate for microsoft teams app can add and delete users in the call group modify the sequence of participants to call in a sequential call group set the availability for all participants in the call group add/edit a supervisor of a call group by clicking the blue 'edit supervisor' button select or type the email address of the supervisor to add you can add multiple supervisors simultaneously teams app the teams app section allows you to set permissions for the cybergate for teams app the cybergate for teams app enables teams users to set their call group availability and to view all devices connected to cybergate and quickly initiate calls to these devices the cybergate for teams app is an app developed to run from within microsoft teams it can be downloaded from within the teams client via the app menu direct link to the cybergate for teams app https //teams microsoft com/l/app/8dd84f10 2fbf 4c8b 9116 7eb326bd7c8e?source=app details dialog device the device section shows all created devices by default everyone can see a device in the cybergate for teams app restrict this access to a limited group of users by configuring one or more groups to a device after adding a group to a device, it will only be visible for the users within the added group(s) add a group click on the blue edit symbol to add one or more groups select a group or type to filter a group to add all groups will be shown microsoft365, security, team, aad groups