SipExchange System Administration

• Conventions followed in this document
• System administrator accounts
• Logging in to SipConsole
• Top-level menu
• Standard user interface concepts
• Displaying a list of something
• Icons used in the SipConsole
• Operations
• System administration
• View reports
• Configure email templates
  

Conventions followed in this document

1. We have used the term "directory" to specify a file location. This is a common Unix convention. In the Windows environment, the term "folder" is used to mean the same thing.
2. We have used the Unix directory naming convention in this document. In the Unix environment, a directory hierarchy is specified by the "/" separator. In the Windows environment, the "\" separator is used. In addition, Unix systems do not use drive letters as in Windows. If you are using Windows, you will need to modify the commands accordingly. For example, if we stated $JIPLET_HOME/bin and you are using Windows, it may translate to C:\jiplet-standalone\bin.
   
3. We have used $SIPEXCHANGE_HOME or similar names to specify variables. While installing/configuring, you will need to replace these variables with the actual value. For example, in this document, the variable $SIPEXCHANGE_HOME has been used to specify the directory where the SipExchange code binary is unpackaged. We have commonly used the following variables:
1. $JAVA_HOME - directory where the Java Runtime Environment (JRE) is installed.
2. $SIPEXCHANGE_HOME - directory where the SipExchange software is unpacked.
3. $JBOSS_HOME - directory where JBOSS is installed.
   
4. $HOST - host name/IP address of the system where the jiplet container is installed.
5. $RUN - the JBOSS run mode (default, minimal, all, etc.)
   
4. Commands are specified using bold. You need to enter the command by typing/pasting the command and pressing the Enter/Return key. Although in the Unix world this may seem natural, in the Windows environment, lots of users are lost when it comes to entering a command. Also, the prompts "#" or "C:\>" are shown, do not enter them.

System administrator accounts

Logging in to SipConsole

Top-level menu

Standard user interface concepts

Displaying a list of something

Icons used in the SipConsole

Icon	Operation
	Display a list of elements.
	Add an element. For example, if you are displaying a domain list, use this icon to add a new domain.
	Delete the element.
	Start a search.
	Drill down. When you click on this icon, SipConsole will drill down to show more details and allow you additional operations
	Go back to the previous screen or operation.
	Run the previous operation again.

Operations

1. Administer the system
   
2. View reports.

System administration

1. Create, modify and delete administrators. You can also change the password for the system administrators from here.
   
2. Create, modify and delete roles. Each SipExchange subscriber has one or more roles associated with him/her. The roles define a privilege level for every user. The default role for all subscribers is "subscriber" and this role is required to register with the SipExchange server. The role "subscriber" is created by default. So, you do not have to do any administration here.
   
3. Create, modify and delete domains. You have to create at least one domain. Create a domain by entering the domain name, a description and the domain administrator's email (optional). When connected on the Internet and users from another domain make a call to a subscriber belonging to this domain, the domain name must resolve to host name/IP address of the SipExchange server. SipExchange allows you to create more than one domain and assign subscribers to the domains.
   
4. Create, modify, delete and search for subscribers. Create subscribers by entering their user name, password, domain, role and other optional information. You must enter an email address for a subscriber if you want the subscriber to get notified by email on changes to the account. Note that the subscriber's SIP address will be sip:user@domain where user is the user name you entered and domain is the domain for the user.
5. Provision domain and subscriber-level features to a domain or subscriber respectively. This aspect is explained in more details in the Feature Management section.
   
6. Delete old CDRs. The system does not automatically delete CDRs that were generated. You can delete CDRs that you no longer require from here to re-use the disk space.
   
7. Add or delete system parameters. You can add or remove system parameters. Using system parameters, you can modify the default behavior of the system. You add a parameter by entering a name and value. Note that the parameter names are case sensitive and must be entered exactly the way it is specified. The following system parameters are currently supported:

• sipexchange.no.answer.duration : How long does the SipExchange server ring a subscriber's phone before giving up and sending a "NOT AVAILABLE" response to the calling party. If you don't specify this parameter, the duration is 60 seconds. You can change this by entering a numerical value in seconds.
• sipServerHost: For more details read the description for the email templates.
  
• sipServerPort: For more details read the description for the email templates.
• sipServerTransport: For more details read the description for the email templates.
• sipexUrl: For more details read the description for the email templates.

View reports

1. Search for users who are currently logged in to the system (registered with the SipExchange server)
2. Search for CDRs.

Configure email templates

Search this website 

Send questions or comments about this web site to webmaster@cafesip.org.
Copyright © 2005, CafeSip.org.
Licensed under the CafeSip License.
The CafeSip.org projects, web site and web facilities have been sponsored by QUIK Computing