1.0.1 What is this about?
In order to perform the service you need to configure some SIP accounts, meaning who is going to place and receive secure calls. In PrivateServer you can't create Accounts outside a Group. As there's no default group your first goal is to manage Groups.
1.0.2 Groups Management
A Group is just a container of users' accounts. It is useful to organize your users in a sort of address book, dividing them amongst departments or buildings for example.
Tip |
---|
There is no other use of the Groups. Each Account on your PrivateServer can call or receive calls from another one, even if they belong to different Groups. |
1.0.2.1 Create
On your left you can find the main menu, which first line reads "Groups & Accounts".
Subtitle |
---|
Prefix | figure |
---|
SubtitleText | Groups & Accounts |
---|
AnchorName | groups and accounts |
---|
|
Image Modified
|
You have to click on it to gain access to the group management page ( Xref |
---|
AnchorName | groups and accounts |
---|
|
).
Your first action will be to create a new group. Thus click on the "New group" icon on the top of the page.
Subtitle |
---|
Prefix | figure |
---|
SubtitleText | Group creation Form |
---|
AnchorName | group creation form |
---|
|
Image Modified
|
You'll be redirected on the group creation form ( Xref |
---|
AnchorName | group creation form |
---|
|
).
The only mandatory field is "Group Name", so please pick a meaningfull name and choose whether to fill all fields. We suggest you to fill almost the IT Email Address field which we'll show up in the Groups & Accounts page after the creation procedure is completed. Please also pay attention to the Provisioning Profile you assign to the group.
Subtitle |
---|
Prefix | figure |
---|
SubtitleText | The group has been created successfully |
---|
AnchorName | group created |
---|
|
Image Modified
|
After you're done, complete the creation procedure clicking on the "Create" icon on the bottom of the page. Then you'll get back on the group management page, but this time you'll have the group just created listed as in . The Group name value is shown and the "IT Email Address" as well. The latter is found into the Admin Contact column.
Tip |
---|
An advisory line (in blue) informs you about the operation and gives you the group id. |
1.0.2.2 Update
To Update group's data you first have to select the group to modify. Click on the Id number down the Id column and you'll get back to the group creation form. All the field you filled can be read as when you create a new Group.
Subtitle |
---|
Prefix | figure |
---|
SubtitleText | "Update" and "Delete" icons |
---|
AnchorName | update_delete_buttons |
---|
|
Image Modified
|
Change the necessary fields (ie IT Email Address or some other). When you are done just click on the Update button at the bottom of the page ( Xref |
---|
AnchorName | update_delete_buttons |
---|
|
). You'll get back to the Groups & Accounts page where you will read the Group list once again. The new values, if they are the ones showed in the Group list table, are readable. If they are not among the ones that are shown then you just click again on the Group's Id and check the fields you changed.
1.0.2.3 Delete
It's possible to drop a Group when it's no more useful. To perform a Delete action you click on the Group's name in the Group's list.
Subtitle |
---|
Prefix | figure |
---|
SubtitleText | Delete Group Confirmation Pop-Up Window |
---|
AnchorName | delete_confirmation |
---|
|
Image Modified
|
You will come again in the Edit Group form ( Xref |
---|
AnchorName | group creation form |
---|
|
). This time push on the Delete button in the bottom area. A confirmation pop up page asks for confirmation. To continue you just push the Ok button or press Enter on your keyboard. After that you'll get back at the Groups & Accounts page.
Warning |
---|
Be careful to delete just empty groups. If you delete a Group that has Accounts belonging to it, those Accounts will be deleted as well ( Xref |
---|
AnchorName | delete_confirmation |
---|
| ) |
Subtitle |
---|
Prefix | figure |
---|
SubtitleText | After the Group has been dropped |
---|
AnchorName | group deleted |
---|
|
Image Modified
|
This time the Group list is empty and a warning line informs you about the deletion just occurred.
1.0.3 Accounts Management
Once you have almost one group you can fulfill it with SIP Accounts. In the Group List (
) click on the Accounts icon on the right of each group's row. You have three way for create new users:
- the plain way: manual creation
- the wizard way: automatic activation
- tha batch way: massive creation
Subtitle |
---|
Prefix | figure |
---|
SubtitleText | The Sip Users Table |
---|
AnchorName | sip users table |
---|
|
Image Removed
|
1.0.3.1 Create a new account, the plain way
The "plain way" is a completely manual creation of the account. In this way you control any feature of the account, but you also need to configure the user's client manually. This way is the opposite of the automatic activation.
Warning |
---|
This is the only way for creating account comely to the SNOM platform. |
In the Account List page (
Xref |
---|
AnchorName | sip users table |
---|
|
) you can see an empty list of accounts. To create a new Sip User you have to click on the New Account button in the top of the page. Subtitle |
---|
Prefix | figure |
---|
SubtitleText | Sip Account creation form |
---|
AnchorName | account creation form |
---|
|
Image Removed
|
The Create Account page will show a form with many fields. Mandatory ones are:
- Username
- Password/Repeat Password
- Virtual Phone Number
- Account Type
- Security Model
- Obfuscation Mode
- Obfuscation Key
- Keep-alive Enabled
Username/Password
Fill the Username with a numeric value as suggested by the default value into the field. Type in a password and repeat it in the proper fields.
Warning |
---|
Username MUST be unique as Virtual Phone Number! |
Virtual Phone Number
Set a Virtual Phone number as a numeric value of your choice. Please consider that the Virtual Phone Number is the number to be dialed to call the Account (and also the number shown as the caller, when the Account places a call). We suggest a three character number such as "111" or "123" for testing purpose. For production please insert the real phone number.
Warning |
---|
If you do not insert the international prefix before the real phone number then you cannot use the automatic activation features |
Account Type
Account types:
- To configure a PrivateGSM account select "PGSM" by the drop down menu in "Account Type".
- To configure a SNOM account select "SNOM" by the drop down menu in "Account Type".
Security Models
Security models:
- To configure a PrivateGSM Enterprise account the security model must be "SDES" in the "Security Model".
- To configure a PrivateGSM Professional account the security model must be "ZRTP".
- To configure a Snom account the security model must be "SDES".
Obfuscation Mode
The Obfuscation mode is a simple but quite efficient trick to let the VoIP pass without being recognised by router that could perform Quality of Service degrading the call.
It's not known to be a perfect mask and it aims not to be one, still it works fine until now and our suggestion is to keep it enabled as by default,
Obfuscation Key
The key used by the obfuscator can be an arbitrary one, still "9" is the default value. It doesn't matter which number you put in here as long as it is the very same one you set up on the client side.
Warning |
---|
If the Obfuscation Key value is not the same on both client's account and server's one, then the call won't be placed properly and it might end suddenly voiceless. |
Xrefanchor |
---|
AnchorName | PSOM_keep_alive |
---|
|
Keep-alive Enabled |
Info |
---|
|
Since the present version you can enable a server side check on the user's reachability! |
To be reachable the client must set up a stable socket to the server. Each client sends a "keep alive" request to the server it's connected to in order to keep up the socket. This is necessary as the TCP socket has an idle timeout after which the socket is closed. Some aggressive network devices can short the standard timeout under 10 minutes, making impossible for the client to send the "keep alive" request because it would always be late (the client sends its request every 10 minutes or so).
In order to avoid the socket break caused by such aggressive network devices, you can set up a server side "keep alive" request that is going to be performed every 3 minutes. In this way you can be sure that the socket and thus the connection would remain up and stable under every circumstances.
Note |
---|
The downside of this option is that there will be some more traffic on the socket (each passage of the request is 1.8 KiloByte, thus you can count almost 3.6 KB of traffic every 3 minutes) |
Warning |
---|
title | Battery life warning |
---|
|
This option can afflict the battery life since more traffic means more radio transmission and on same devices the radio wouldn't have a proper timeout for going idle. |
The actual default value for the keep-alive interval is 60 seconds. You can configure the general keep-alive timeout in the NAT configuration form. Please read PSAM 2.4 Asterisk advanced configurations to get informations about it.
Warning |
---|
|
All the PrivateGSM clients prior to the 11.1 version cannot respond to the keep-alive request and thus if such option was enabled for their users, then those users won't ever be on-line and reachable. |
After you completed to fill the form please click on the Create icon at the page's bottom.
Subtitle |
---|
Prefix | figure |
---|
SubtitleText | new SIP account |
---|
AnchorName | new sip account |
---|
|
Image Removed |
Tip |
---|
An information line advice the operation just performed. |
You'll get back the Account List page and the table shows now your new user (
Xref |
---|
AnchorName | new sip account |
---|
|
). Note |
---|
Using this way makes the account enabled by default. |
To use the automatic activation even in the plain way go reading the paragraph 1.0.3.6.
1.0.3.2 Create a new account, the wizard way
The "wizard way" is the new method for creating accounts. It's made for easing the load on the service manager's shoulder, letting him/her focusing on the service configuration without having to bother about the installation and configuration of the client.
In the Account List page (
Xref |
---|
AnchorName | sip users table |
---|
|
) you can see an empty list of accounts. To create a new Sip User you have to click on the New Account (Activation Wizard) button in the top of the page. Subtitle |
---|
Prefix | figure |
---|
SubtitleText | new account by wizard |
---|
AnchorName | new account by wizard |
---|
|
Image Removed |
You'll see the "Edit Account page" with a precompiled, non-editable username as in
Xref |
---|
AnchorName | new account by wizard |
---|
|
.Please set a Virtual Phone Number and choose a Provisioning Profile.
Warning |
---|
If you do not insert the international prefix before the real phone number then you cannot use the automatic activation features |
If not differently configured, the default values for the Obfuscation are fine. The other fields are optional.
Note |
---|
In this mode the password is automatically chosen by the system and it's not editable |
Compile all necessary fields of the new account, select a Provisioning Profile and click on "Create". Now jump to paragraph 1.0.3.6 for activate the user.
Warning |
---|
In the "wizard way" the user's account are DISABLED until the automatic activation is performed! |
1.0.3.2 Create a new account, the batch way
The "batch way" is an account creation mode designed specifically for large number of users to be created quickly.
Starting from Account List page
Xref |
---|
AnchorName | sip users table |
---|
|
click on the Create batch account action to open Create batch account page: Subtitle |
---|
Prefix | figure |
---|
SubtitleText | create batch account |
---|
AnchorName | create batch account |
---|
|
Image Removed |
Prepare a .csv file with some account. The file must be formatted as the example below.
Code Block |
---|
language | none |
---|
title | batch users csv |
---|
|
fullName,gsmNumber,email,securityModel,description
Alessandro Bergamaschi,+391234567890,alessandro.bergamaschi@privatewave.com,end-to-site,Personal account
Luigi Rossi,+3932456753,luigi.rossi@privatewave.com,end-to-site,Personal account
Marco Bianchi,+39432242342,mbianchi@gmail.com,end-to-site,Personal account
Mario Colombo,+394325346546,colombo.mario@privatewave.com,end-to-site,Personal account |
Select the default provisioning profile and a group for the newly account created. Upload the file and click create: you'll be leaded to the Group list page
1.0.3.4 Update
To change the SIP Account values you must first select it from the Accounts List: just click on the Username and the Edit Account form is shown (
Xref |
---|
AnchorName | account creation form |
---|
|
).Change the values you need to and then click on the Update button at the bottom of the form to save the changes. The new values are shown into the Accounts' table back in the "Account List" page. Subtitle |
---|
Prefix | figure |
---|
SubtitleText | The Account has been updated |
---|
AnchorName | account updated |
---|
|
Image Removed
|
...
1.0.3.5 Delete
Select the Account from the Account List and get the Edit Account page. Click on the Delete button at the bottom of the page to delete the SIP Account. A warning pop up window will be shown.
Just select the "Ok" button or press Enter to confirm. The Account List page will show up without the Account.
Subtitle |
---|
Prefix | figure |
---|
SubtitleText | The Account has been deleted |
---|
AnchorName | account deleted |
---|
|
Image Removed
|
1.0.3.6 Automatic Activation
After you created your new account(s) you have to configure the customer's client application PrivateGSM. In the wizard way it's MANDATORY to use the automatic activation in order to enable the account. In the plain way it's optional, though useful.
When you have just finished creating the new account (as in
Xref |
---|
AnchorName | new sip account |
---|
|
) or picking up the account from the account list ( see Xref |
---|
AnchorName | account updated |
---|
|
) you can send to the customer both a download SMS and a configuration SMS so that he/she would proceed with the installation of the client without any other human help. Click on the "Send installation SMS" to send the link for downloading the application. Subtitle |
---|
Prefix | figure |
---|
SubtitleText | confirm sms |
---|
AnchorName | confirm sms |
---|
|
Image Removed |
Confirm as in the above picture and the PrivateServer advices the operation has been completed:
Subtitle |
---|
Prefix | figure |
---|
SubtitleText | installation sms sent |
---|
AnchorName | installation sms sent |
---|
|
Image Removed |
Warning |
---|
The SMSes are sent to the account's Virtual Phone Number, so please check it exist as an actual mobile phone number before using the Automatic Activation |
Getting back to the account list you can read the exact status and the time of its change:
Subtitle |
---|
Prefix | figure |
---|
SubtitleText | account status |
---|
AnchorName | account status |
---|
|
Image Removed |
So what's happened is that the status has changed from "Created" to "Installation SMS sent" and the "Last Status date" has been updated to the time the SMS has been sent to the customer.
Note |
---|
The Automatic Activation and the Provisioning Profiles must be set up to have this procedure to work. |
After the customer has downloaded and installed the application, the "Last status" changes to "Installed" but the "Enabled" is still "False". "Last Status date" is updated as well.
Next step is to send the "Activation SMS" in order to enable the user to place and receive calls.
Just click on the related link at the end of the customer's row in the Account list table. As for the "Installation SMS" you are requested to confirm the action (refer to
).Note the change in the "Last Status" and in the "Last Status date": the former is now "Activation SMS sent", the latter is updated to the new time the action was performed.
You can know for sure that the user has configured his/her PrivateGSM application because after the action has been performed the account's "Last Status" becomes "Activated" and the "Last Status date" is updated as in the former cases.
Now the "Enabled" fields is changed to "true" meaning that the customer is ready to go.
Note |
---|
Please remember that if you created the account in plain way then the account is enabled by default, no matter if you sent the Activation SMS or not. |
If the customer actually goes on line with the PrivateGSM application, than the "Last Status" becomes "Connected".
Tip |
---|
You can check if the customer is connected using the "Registered Account" menu. |