Offices

From Xminder
Jump to: navigation, search

Xminder ADMIN - Offices Section


Languages: English, Romanian



Contents


Manage


This section display the list of all offices and include controls for office management: add office, delete office etc.


Information about offices


The offices list contains certain information about each item:

Information about offices
Field Description
Id The office id (unique parameter).
Name The name of the office.
Active Select if the office is active or not. ( Yes / No )
Options Drop-down list with all the options that redirect to different pages, containing actions available for each office: Activate/Deactivate, Edit Office, Users, Credit (Credit Line), Addons, Campaigns, Offer Packages, Packages Purchased, Rates, Dids, Smtps, Sips, API, Send Email to Office, Call the Office, Asterisks, Delete Office.
Phone Lines Number of phone lines per office. ( Available lines / Lines in use / Reserved lines )
SMS Lines Number of SMS lines per office. ( Available lines / Lines in use )
Email Lines Number of Email lines per office. ( Available lines / Lines in use )
Credit (Credit Line) The amount that the office has in the account.
Expiration Credit The date until the credit is valid. If the date is displayed in red, the credit has already expired.
Rank Priority parameter for the dialers. The bigger the rank is, the higher priority the office has when the dialer calls.
First Name Fist Name of the contact person for the office.
Last Name Last Name of the contact person for the office.
Email Email address of the contact person for the office.
Phone Phone number of the contact person for the office.
Location Address of the office - billing address.
Created On Date when the office has been created.


Filter and sort


In order to find quickly information about offices, filters and sort criteria can be used:

  • The office list can be displayed taking into account different criteria: Id, Name, Rank, First Name, Last Name, Credit, Phone, Location, Email, Created On, Expiration Credit.
  • In order to use these filters, the admin must type the key word in the empty filter field/fields, then press the apply button. The key word may be a group of one or several characters.
  • The filter may be done with an exact match (exact match) or with an approximate match (use 'like' match).
  • The admin can set the number of offices displayed by page (Limit), the criteria of ordering them (by Id, Name, Rank, First Name, Last Name, Credit, Phone, Email, Created On, Expiration Credit) and the type (Ascending or Descending).
  • If there are more than one page to be displayed, the admin may choose the desired page by using the Page field from the top of the page or by using the Last Page and Next Page icons from the bottom of the page.
  • The filters and the sort criteria can be canceled using the reset button, which will restore the default settings.


Add office


The button Add Office redirects to a form for creating an office.

Adding offices - Form fields
Section Field / Property Description
Account Details Office Name The name of the office.
Email (account login) The email address is the Username for the main user to log on the desktop interface.
Password The password for the main user.
Confirm Password The password's confirmation.
Rank Priority parameter for the dialers. The bigger the rank is, the higher priority the office has when the dialer calls.
Max Sessions The maximum number of simultaneous sessions that can be run by this office.
Account Types The type of account: SMS Text Message Marketing / Email Marketing / Voice Broadcast etc.
Credit Credit Value The amount that the office has in the account.
Expiration Date The date until the credit is valid.
Call Center Type Choose the call center login type: Call (server dial to agent) / Dial (agent dial to server) / Queue CallBack.
Number The SIP extension for call center login.
Rates Calls Choose the rates table for calls.
SMS Choose the rates table for SMS.
MMS Choose the rates table for MMS.
Contact First Name First name.
Last Name Last name.
Phone Phone number.
Gender Gender.
Location Address Street's name and number.
City City.
State State.
Zip Code Zip code.
Timezone Timezone.
Lines Phone Number of phone lines per office: Available, Reserved, In Use.
SMS Number of SMS lines per office: Available, In Use.
MMS Number of MMS lines per office: Available, In Use.
Email Number of email lines per office: Available, In Use.
Asterisk Servers Select the servers for the Asterisk.
Modules Select the modules for the office: Audio Files, Users, Office Options, Messages, Database, Campaign Builder, Calendar, Task, Account Billing, Call Center, API, Queue Callback.
Editors Select the campaign editors for the office: broadcast - SMS, broadcast - email, broadcast - mms etc.


Activate/Deactivate


The option Activate/Deactivate from the field Options of an office redirects to the page Offices :: Activate/Deactivate, where the admin can change the activation status of the office.
The new page will contain details for the office (id, name, contact person, email address and phone number) and the table Activate/Deactivate with one field: Active.
To activate/deactivate an office, the status of the field Active must be changed, then press the Save button.


Delete office


The only delete operation that cand be made to an office is a soft delete operation. This means that the office will be marked as deleted and it and its users will not be active for any further actions.

In order to delete an office you must first select the office (use the check box), then use the button soft delete.
Another way to delete an office is by using the Delete Office option from the Options drop-down list of the office. This action will open the Delete Office page where are displayed info about the office. To delete the office the admin must choose the Soft delete option then press the Delete button.

The office can be restored using the button soft undelete.



Users


The section Users help you to manage users for each office. In order to do this, select the office name from the drop-down list and press the button Select.
The new page will contain contact details for the office (name, contact person, email address, phone number and the number of users), the users list and controls for users management.


Information about users


The users list contains certain information about each item and is displayed taking into account some parameters:

Information about users
Field Description
Id The user ID (unique parameter).
Username Username. The username is identical with the email address.
Active Shows if the user is enabled or not. ( Yes / No )
First Name The user's first name.
Last Name The user's last name.
Email The user's email address. The email address is identical with the username.
Registration Date The date the user was added to the system.
Options Operations using the user's account: Edit User and Delete User.


Filter and sort


In order to find quickly information about users, filters and sort criteria can be used:

  • The users list can be displayed taking into account different criteria (Id, Username, First Name, Last Name, Email, Registration Date, Active).
  • In order to use these filters, the admin must type the key word in the empty filter field/fields, then press the apply button. The key word may be a group of one or several characters.
  • The filter may be done with an exact match (exact match) or with an approximate match (use 'like' match).
  • The admin can set the number of users displayed by page (Limit), the criteria of ordering them (Id, Username, First Name, Last Name, Active, Email, Registration Date) and the type (Ascending or Descending).
  • If there are more than one page to be displayed, the admin may choose the desired page by using the Page field from the top of the page or by using the Last Page and Next Page icons from the bottom of the page.
  • The filters can be canceled using the reset button, which will restore the default settings.


Add users


If the admin wants to add a new user to the current office he must use the Add User button from the top-right corner of the page. This action will redirects him to the Add User page where he can fill the User Form with the necessary information, then click on the Save button.


Edit users


For editing an existing user the admin must click on the Edit User icon from the Option field (the last column of the Users list). This action will redirects him to the Update User page where he can fill the User Form with the necessary information, then click on the Save button.


Add / Edit Users - User Form
Section Field Description
Authentication Username (email address) User's ID. The Username is identical with the email address.
Password User's password.
Confirm Password Password confirmation.
Active The user will be enabled or not. ( Yes / No )
System The type of the user account will be system account or not. ( No / Yes )
Contact First Name User's first name
Last Name User's last name
Cell Phone User's cell phone number
Home Phone User's home phone number
Office Phone User's office phone number
Location Address Street's name and number
City City
State State
Country Country
Zip Code Zip code
Timezone Timezone
Profile Gender User's gender. ( M / F )
Birth Date User's date of birth.
Date Format Format of the date.
Time Format Time format.
Password Expired No / Yes - if the password has expire or not.


Delete users


The only delete operation that cand be made to an user account is a soft delete operation. This means that the user's account will be marked as deleted and the user can't use the desktop interface for any further actions.

In order to delete one or more users the admin must first use the check boxes to select them, then use the button soft delete from the bottom-left side of the users list.
Another way to delete an user is by using the Delete User icon from the Options field.

A deleted user can be restored using the button soft undelete.


Enable / Disable users


To enable an user the admin must use the check box to select that user, then use the button enable.

The user can be disabled using the button disable.

If the user is disabled, he will not be able to log in the system anymore.



Asterisks


The section Asterisks allows the admin to view and assign one or more asterisks to an office. In order to do this, the office name must be selected from the drop-down list, then press the button Select.

The new page will contain contact details for the office (name, contact person, email address and phone number), the list of asterisks (active or inactive) on the office and controls for asterisks management.


Information about asterisks


The list of asterisks on the office contains certain information about each item and is displayed taking into account some parameters:

Information about asterisks
Field Description
Name (IP) The name and IP of the asterisk.
Active Shows if the asterisk has been enabled or not.
Max Agents The maximum number of agents from the same office that can be logged in simultaneously.
Real Agents The number of agents that are logged in at the current moment.
Options Operations using the asterisks: Add Office Asterisk, Update Office Asterisk and Delete Office Asterisk.


Add Office Asterisk


In order to add/assign a new asterisk on the office the admin must select the name of the asterisk from the drop-down list of the field Name (IP), insert the propper values in the Max Agents and Real Agents fields and click on the icon Add Office Asterisk from the column Options.


Update Office Asterisk


The only info that can be changed for an asterisk on the office are info from Max Agents and Real Agents fields. After editing this fields for an asterisk the corresponding icon Update Office Asterisk must be clicked.


Delete Office Asterisk


To remove an asterisk from the list of the office the corresponding icon Delete Office Asterisk must be used.



Credit (Credit Line)


The section Credit (Credit Line) allows the admin to view and modify info about the office's credit. In order to do this, the office name must be selected from the drop-down list, then press the button Select.

The new page will contain the following details for the office:


Information about credit
Field Description
Name The name of the office (email address).
Contact The main user's first name and last name.
Email Email address of the office.
Phone The main user's phone number.
Credit The amount that the office has in the account.
Credit Line The amount that can be used after the original Credit was consumed.
Expiration Date The date when the credit will expire.
Options Operation using office's credit: Update Office Credit.


Update Office Credit


In order to modify office's Credit info, the fields Credit, Credit Line or Expiration Date must be edited. After editing this fields the icon Update Credit must be clicked.



Offer Packages


The section Offer Packages allows the admin to create and modify offer packages for all the offices or for one specific office.


In order to create, modify or delete an offer package for all the offices the admin must use the table Offer packages for all the offices from the Offer Packages main section. The table contain information about offer packages and controls for management of the offer packages.


To do same operations with offer package for one specific office, the office name must be selected from the drop-down list from top of main section, then press the button Select.
The new page will contain contact details for the office (name, contact person, email address and phone number) and the table with information about offer packages and controls for management of the offer packages.


Note: The packages created for a certain office will only be available on the users interface (Billing / Account Balance / Offers) and will be activated only from the interface, by the user himself.


Information about offer packages


Whether the admin working with offer packages for one specific office or for all the offices, the list of offer packages contains certain information about each item and is displayed taking into account some parameters:

Information about offer packages
Field Description Example
Name The name of the package. 200 SMS
Validity How long will the package be available. 30
ValidityUnits A combo-box with time units. day, week, month or year.
Price The price of each package. $6.00
Type A drop-down list containing different types of packages. sms, email or phone
Quantity The number of units included in the package. 200 (sms)
Options Operations using the packages: Add Office Package, Update Office Package and Delete Office Package.


Add Office Package


In order to create and add a new package (for one specific office or for all offices) the admin must fill in all the fields of the last row in the table with information about offer packages, then click on the icon Add Office Package from the column Options.


Update Office Package


In order to modify a package from the offer (for all offices or for one specific office) the proper fields from the table with information about offer packages must be changed. After editing this fields for an offer package the corresponding icon Update Office Package (from the column Options) must be clicked.


Delete Office Package


To remove an package from the offer (for all offices or for one specific office) the corresponding icon Delete Office Package (from the column Options) must be used.



Packages Purchased


The section Packages Purchased allows the admin to check what packages a certain office has, how many units are consumed and how many units are still available.

There are 4 types of packages: Phone, SMS, MMS and Email.

In order to check the packages purchased by a certain office, the admin must use the menu Packages Purchased from the Office section of the main menu, then select the type of package and then select the office name from the drop-down list.

The new page will contain contact details for the office (name, contact person, email address and phone number) and a table with information about office's packages.


Information about office's packages


The office's packages table contains certain information about each item and is displayed taking into account some parameters:

Information about office's packages
Field Description
Name The name of the package.
Start Date The date when the package was activated on the account.
End Date The date when the package's validity ends.
Price The price of the package.
Type Type of the package.
Quantity Total number of units included in the package.
Used The number of used units.



Campaigns


The section Campaigns displays the list of campaigns by type and by office.


In order to view the campaigns of an office the admin must choose the type of campaigns, then select the office name from the drop-down list, then press the button Select. The new page will contain contact details for the office (name, contact person, email address, phone number), the campaigns list and controls for campaigns management.


There are 4 types of campaigns:



    ⇑ Top of page ⇐ Home    
Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox