App-Pendix Directories System
User Manual Version 8.0.33
© 2016 Syn-Apps LLC
App-Pendix Directories System
Overview
by Syn-Apps
The App-Pendix Directories System for Cisco Unified
Communications Manager consolidates IP Phone directories
and makes them accessible to all Cisco XML enabled phones.
With App-Pendix you can create a global directory, available to
all phones regardless of the Call Manager cluster configuration.
App-Pendix can also be configured to support a hosted CUCM
environment, whereby phones in a certain site only see the other
phones in that site. App-Pendix supports searching on names
as well as a configurable search field.
App-Pendix supports importing user data from SQL database
tables or Microsoft Active Directory enabled products such as
Windows 2000 Server or Exchange. Multiple Active Directory
sources are supported. App-Pendix can also be configured to
support the built in CUCM end users for one or multiple CUCM
clusters.
App-Pendix uses a new predictive directories model (IE T9
texting), whereby users only need to press a keypad button once
no matter which letter they mean to send. After each key press
the directories input screen will update reflecting the number of
users matching the current filter and the most likely match
characters.
About Syn-Apps
Syn-Apps L.L.C. was founded in 2001 as a consulting firm focused
on developing software for IP telephony platforms. Since that time,
Syn-Apps has evolved as a market leader in enterprise-wide paging
and notification solutions designed to improve business processes,
increase safety, and streamline internal and external
communication. Since 2001, over 2,000 organizations have
integrated our notification software with phones, paging systems, IP
speakers, and hundreds of other internal systems and services.
Syn-Apps has an extensive knowledge base in numerous
development technologies. In addition, Syn-Apps has a strong
background in network design and networking fundamentals. We
believe this combination of experience in a broad range of
technologies allows us to offer our customers an end-to-end
application development solution.
We believe that in order to have a successful application
deployment, one should not only understand the development
environment, but also understand how the application will interact
with the rest of network. Syn-Apps has extensive networking
experience based on a number of network development and design
projects for many Fortune 100 companies. We believe that this
enables us to become a valuable asset to any development team.
Syn-Apps developers have a wide variety of development
experience in many diverse industries. Our developers have been
employed by, or consulted for companies such as Oracle, Microsoft,
Cisco, General Motors, General Dynamics, Bloomberg, and many
others. All of our developers have a keen understanding of the
software development life cycle and know how to develop successful
applications.
At Syn-Apps we understand the importance of a team environment
and are comfortable developing and sharing information to ensure
that the best of breed product is produced.
4
App-Pendix Directories System User Manual and Install Guide
Table of Contents
Part 1 Overview
7
Part 2 Features
10
Part 3 System Requirements
12
1 Application
...................................................................................................................................
Server Requirements
13
Window s 2008..........................................................................................................................................................
Server
14
Disabling UAC
......................................................................................................................................................... 15
Disabling Public
.........................................................................................................................................................
Firew all
15
Disabling IE.........................................................................................................................................................
Enhanced Security
16
Creating ASPNET
.........................................................................................................................................................
User Account
16
Verifying IIS
.........................................................................................................................................................
Installation
17
Installing ASP.NET
......................................................................................................................................................... 18
Window s 2012..........................................................................................................................................................
Server
19
2 CUCM...................................................................................................................................
Requirements
20
3 Network
...................................................................................................................................
Requirements
21
Part 4 System Installation
23
Part 5 Configuration
25
Part 6 Web Management Interface
30
Part 7 Configuring Tenants
32
1 Tenant
...................................................................................................................................
Sites
33
2 Tenant
...................................................................................................................................
Users
34
Part 8 Configuring Custom Directories
36
1 Directory
...................................................................................................................................
Data Structure
38
2 Entering
...................................................................................................................................
Directory Data
39
Part 9 Settings
41
1 Directory
...................................................................................................................................
Settings
42
2 Soft Keys
................................................................................................................................... 45
3 Directory
...................................................................................................................................
Browser
48
4 CUCM...................................................................................................................................
Sites
49
5 LDAP...................................................................................................................................
Data Sources
50
6 Password
................................................................................................................................... 51
7 Email...................................................................................................................................
Settings
52
8 Service
...................................................................................................................................
Log Level
53
© 2016 Syn-Apps LLC
Contents
5
Part 10 Directory Browser
55
Part 11 Phone Services
58
Part 12 Accessing Directories
61
1 Accessing
...................................................................................................................................
Custom Directories
63
Part 13 Help and Support
65
1 Post Install
...................................................................................................................................
Instructions
66
2 Documentation
................................................................................................................................... 69
3 Request
...................................................................................................................................
Support: Knowledge Base
70
4 Request
...................................................................................................................................
Support: Prepare Report
71
5 Contact
...................................................................................................................................
Syn-Apps Support
72
6 Information
...................................................................................................................................
Center
72
© 2016 Syn-Apps LLC
5
Overview
Part
1
Overview
1
7
Overview
App-Pendix Directories System
The App-Pendix Directories System for Cisco Unified Communications Manager consolidates IP Phone
directories and makes them accessible to all Cisco XML enabled phones. With App-Pendix, users can create a
global directory, available to all phones regardless of the Call Manager cluster configuration. App-Pendix can also
be configured to support a hosted CUCM environment, whereby phones in a certain site only see the other
phones in that site. App-Pendix supports searching on names as well as a configurable search field.
App-Pendix supports importing user data from Microsoft Active Directory enabled products, such as Windows
2000 Server, Exchange, or Open LDAP Active Directory. Multiple Active Directory sources are supported. AppPendix can also be configured to support the built in CUCM end users for one or multiple CUCM clusters.
App-Pendix uses a T9 texting predictive directories model; allowing users to press a keypad button once to
search for contacts. After each key is pressed, the directories input screen will update reflecting the number of
users matching the current filter and the most likely matching characters.
Recent feature additions for App-Pendix include:
Feature
Description
App-Pendix 8.0.33
CUCM 10
App-Pendix now supports CUCM 10.
Cisco Phones
App-Pendix now supports Cisco 88xx and 78xx series phones.
Customizable Soft-Key
Labels
Create custom soft-key labels to be used on end-users Cisco IP phone
displays.
App-Pendix 8.0.23
Active Directory Import
The Active Directory import has been redesigned.
OpenLDAP Import
OpenLDAP servers such as Sun One LDAP can now be imported.
App-Pendix 8.0
Predictive Directories
A texting model similar to T-9 texting is now used by default. This allows
searches to be made on all searchable fields at once and provides instant
feedback after each button press.
CUCM Clusters
Support for multiple CUCM clusters. This allows multiple CUCM clusters end
users to be joined together to create a global directory.
Data Source Filters
Import user data from one or more Active Directory data sources.
Dynamic Tenants
Tenant users can be assigned dynamically using a filter, this should ease
tenant management or eliminate it all together.
Location Details
Sites and location details can be configured in the system, this will allow
location and address details to be shown for users in the directory.
Cross Cluster Prefixing
Cross cluster prefixing is supported, this will allow multi-cluster global
directories to support inter-cluster dialing.
Search by Site
Provides a menu of configured Site-Codes for users to select from, Site-Codes
can represent any number of fields.
Directory Browser
Browse and search the directory using the App-Pendix website. User images
are supported.
Contact Cards
The IP Phone directory will now show contact cards for contacts. Contact
cards include user images and pertinent user information like name, title,
department, phone numbers and email.
© 2016 Syn-Apps LLC
8
App-Pendix Directories System User Manual and Install Guide
The App-Pendix Directories System has been created using ASP.NET 3.5 to provide a rich user interface. Menus and
lists that contain multiple items are searchable, simply highlight the menu or list in question and begin to type, the
selection indicator will select the first matching item in the list. Tables and grids are sortable by clicking on the column
header or the column you wish to sort on. All entries in the GUI are validated on the client side to prevent typographical
errors. Tables and grids that can contain thousands of entries use a client side caching model that will allow for good
performance without overloading the client or server system.
© 2016 Syn-Apps LLC
Features
Part
2
10
2
App-Pendix Directories System User Manual and Install Guide
Features
The App-Pendix Directories System offers its administrators and users many useful features:
Feature
Description
Primary Features
Tenant Model
Hosted CUCM systems can provide partitioned directories to their customers.
Customer-A will only see the users for Customer-A and so forth.
Search Fields
App-Pendix provides a directory that can be searched based on first name, last name,
site-codes, and most other columns that exists in the source user database.
Predictive Directories A T9 texting model used by default. This allows searches to be made on all searchable
fields at once, thus providing instant feedback after each button press.
Multiple CUCM
Clusters
Support for multiple CUCM clusters. This allows multiple CUCM clusters end users to
be joined together to create a global directory.
Data Sources
Active Directory
Import user data from one or more Active Directory data sources.
OpenLDAP
Import user data from one or more OpenLDAP servers, such as Sun One LDAP.
AD Path Filters
Import Active Directory users that match a certain LDAP search path.
CUCM Direct
Import users and phone info from CUCM 5/6/7/8/9/10. Multiple clusters supported.
Additional Features
Dynamic Tenants
Tenant users can be assigned dynamically using a filter. This feature is designed to
ease tenant management, or eliminate it all together.
Location Details
Sites and locations can be configured in the system,allowing location and address
details to be shown for users in the directory.
Cross-Cluster
Prefixing
Cross-cluster prefixing is supported, allowing multi-cluster global directories to support
inter-cluster dialing.
Custom Directories
App-Pendix allows creation of custom directories which can be useful in many cases,
for example a directory of emergency numbers or a directory of vendors.
Local Search
Allows users to quickly search other users at their own site. Local Search requires
device to phone association in CUCM direct mode.
Cluster Search
Allows users to quickly search other users in their own cluster.
Search by Site
Provides a menu of configured Site-Codes for users to select from, Site-Codes can
represent any number of fields.
Directory Browser
Browse and search the directory using the App-Pendix web user interface. User images
are supported.
Contact Cards
The IP Phone directory will now show contact cards for contacts. Contact cards include
user images and pertinent user information such as: Name, Title, Department, Phone
Numbers, and E-Mail.
© 2016 Syn-Apps LLC
System
Requirements
Part
3
12
3
App-Pendix Directories System User Manual and Install Guide
System Requirements
In order for App-Pendix to function properly there are some system requirements that need to be met. Review the
system requirements before installing the product.
The App-Pendix system requirements are organized into the following categories:
App-Pendix Requirement
Description
Application Server Requirements
The hardware and software requirements for the server App-Pendix is to
be installed on.
Cisco Communications Manager
Requirements
The Cisco Communications Manager Requirements.
Network Requirements
Network port usage and multicast setup information.
© 2016 Syn-Apps LLC
System Requirements
3.1
13
Application Server Requirements
The App-Pendix application server must meet the following requirements:
Server Requirement
Description
Software Requirements
Supported Versions
Operating System
Windows 2008 SP2 (32-bit or 64-bit versions) or
Windows 2008 R2
Windows 2012
Note: See the following for server operating system requirement setup specifics:
Windows 2008 Server
Windows 2012 Server
Microsoft .NET
Microsoft .NET 3.5 comes with Windows 2008 R2 server
Microsoft .NET 4.5 comes with Windows 2012 server
*Automatically installed if the server has internet access (or download here)
Microsoft SQL Server
Microsoft SQL Server 2000 or greater.
*SQL Express 2008 R2 SP1 is automatically installed if the server has internet
access (or download here: 64-bit or 32-bit)
Hardware Requirements
Server hardware minimum requirements listed below
CPU
Intel Core-2 Duo (minimum recommended)
Memory
2 GB of system memory (minimum requirement)
Hard Drive
10 GB of hard drive space (minimum requirement)
© 2016 Syn-Apps LLC
14
3.1.1
App-Pendix Directories System User Manual and Install Guide
Windows 2008 Server
Windows 2008 Server Requirements
The following tables describe the Windows 2008 server requirements for the App-Pendix Directories System.
Windows 2008 R1 systems only:
Windows 2008 R1 Req. Description
Windows 2008 SP2
Make sure that Windows 2008 SP2 has been installed, which is required for
automatic configuration.
Microsoft .NET 3.5
If the application server does not have internet access make sure .net 3.5 has been
installed. .Net 3.5 and be downloaded here.
Note: If the application server does have internet access then the SA-Announce
configuration utility will automatically download and install ASP.NET 3.5.
The following are required for all Windows 2008 servers:
Server Requirement
Description
Manual Setup Requirement
These require manual setup.
Disabling Public Firewall
Firewall must be disabled or set to allow access on the
required ports (see Network Requirements).
Auto-Setup Requirement
The installer should automatically complete these.
Disabling IE Enhanced Security Configuration IE Enhanced Security Configuration must be disabled to
allow the website to function properly.
Creating ASPNET user account
Create an ASPNET user account on the App-Pendix
application server.
Installing Internet Information Service (IIS)
IIS is required for the product to function.
Installing ASP.NET
ASP.NET 3.5 is required for the product to function.
Recommended
These are recommended items.
Disabling User Account Control (UAC)
We recommend disabling UAC.
© 2016 Syn-Apps LLC
System Requirements
3.1.1.1
15
Disabling UAC
Disabling User Account Control (UAC)
To disable User Account Control on the application server (recommended) perform the following:
Disabling User Account Control
Description
Launch Control Panel
Launch Start >> Control Panel on the application server.
Launch User Accounts
Under Control Panel, launch User Accounts.
Turn User Account Control on or off Under User Accounts select Turn User Account Control on or off.
Disable UAC
Uncheck the Use User Account Control (UAC)... checkbox.
Click OK
Click OK to accept the changes.
Reboot
Windows will require a reboot. Reboot the system.
3.1.1.2
Disabling Public Firewall
Disabling Public Firewall
To disable Public Firewall on the application server (required) perform the following:
Disabling Public Firewall
Description
Launch Server Manager
Start >> Server Manager or right-click on Computer and select
Manage.
Select Windows Firewall
In Server Manager, expand Configuration and select Windows Firewall.
Select Go to Windows Firewall.
Select Windows Firewall
Properties
In Windows Firewall Configuration, click the Windows Firewall
Properties link at the bottom of the page.
Switch Firewall Off
In Windows Firewall Properties click the Public Profile tab. Switch the
Firewall State to Off.
Finalize Changes
Click OK. The Public Profile’s Firewall should now be off.
© 2016 Syn-Apps LLC
16
3.1.1.3
App-Pendix Directories System User Manual and Install Guide
Disabling IE Enhanced Security
Disabling IE Enhanced Security Configuration
To disable IE Enhanced Security Configuration on the application server (required) perform the following:
Disabling IE Enhanced Security
Description
Launch Server Manager
Start >> Server Manager or Right-Click on Computer and select
Manage.
Select Configure IE ESC
Select the Configure IE ESC option at the bottom right.
Turn IE ESC Off
Click Off for both Administrators and Users.
Finalize Changes
Click OK.
3.1.1.4
Creating ASPNET User Account
Creating ASPNET user account
To create the ASPNET user account on the application server (required) perform the following:
Create ASPNET User Account Description
Launch Server Manager
Start >> Server Manager or Right-Click on Computer and select Manage.
Add New User
Under Server Manager expand the Configuration item and expand Local
Users and Groups. Right click the Users folder and select New User.
Configure New User
In the New User dialog create user with User name ASPNET. All other fields
are optional.
***Account does not need to be active. Disable account if desired.
Click Create
Click Create on the New User dialog to create the new user.
© 2016 Syn-Apps LLC
System Requirements
3.1.1.5
17
Verifying IIS Installation
Verifying Internet Information Service (IIS)
The application installer will install and configure IIS automatically. If there are any issues during installation, this
data can be used to verify the settings.
To install the IIS Role and required Features on the application server (required) perform the following:
Installing the IIS Role Description
Launch Server Manager Start >> Server Manager or right-click on Computer and select Manage.
Go to Roles
In Server Manager with Server Manager selected, select Go to Roles.
Select Server Roles
In the Add Roles Wizard select the Web Server (IIS) role and click Next.
Add Required Features In the Add Roles Wizard click Add Required Features. The Add Roles Wizard will
appear again. Click Next to begin adding the required features.
Adding Role Services The required Role Services for the IIS role.
Select Role Services
© 2016 Syn-Apps LLC
In the Add Roles Wizard, select All Role Services for the Web Server role.
Alternatively, the Add Role Services Wizard will appear if the role was previously
installed. Click Next when all items have been selected to complete the installation.
18
3.1.1.6
App-Pendix Directories System User Manual and Install Guide
Installing ASP.NET
Installing the ASP.NET feature on Windows 2008
The application installer will install and configure ASP.NET and features automatically. If there are any issues during
installation, this data can be used to verify the settings.
To install the ASP.NET feature manually on the application server, follow the directions in the table. Note that
ASP.NET is required.
Install ASP.NET Feature
Description
Launch Server Manager
Start >> Server Manager or right-click on Computer and select Manage.
Add Features
In Server Manager with Server Manager selected, select Add Features.
Select Features
In the Add Features Wizard, select the .NET Framework 3.X feature and
all sub-features. Click Next. The features will be installed.
On Windows 2008 R1, the feature is .NET Framework 3.0 Features, on
Windows 2008 R2 the feature is .NET Framework 3.5.1 Features.
This completes the Windows 2008 Server requirements section.
© 2016 Syn-Apps LLC
System Requirements
3.1.2
19
Windows 2012 Server
Windows 2012 Server Requirements
The following tables describes the Windows 2012 Server Requirements for the App-Pendix Directories System.
Server Requirement
Description
Manual Setup Requirement
These require manual setup.
Disabling Public Firewall
Firewall must be disabled or set to allow access on the
required ports (see Network Requirements).
Auto-Setup Requirement
The installer should automatically complete these.
Disabling IE Enhanced Security Configuration IE Enhanced Security Configuration must be disabled to
allow the website to function properly.
Installing Internet Information Service (IIS)
IIS is required for the product to function.
Installing ASP.NET
ASP.NET 3.5 is required for the product to function.
Recommended
These are recommended items.
Disabling User Account Control (UAC)
We recommend disabling UAC.
© 2016 Syn-Apps LLC
20
3.2
App-Pendix Directories System User Manual and Install Guide
CUCM Requirements
Communications Manager must meet the following requirements for App-Pendix to function correctly:
CUCM Requirements
Description
CUCM 4 and above
AXL Web Service
The Cisco AXL Web Service must be enabled on all CUCM listed in App-Pendix
configuration.
Note: This setting can be found in Cisco Unified Serviceability Database and
Admin Services for CUCM 5 and greater. On CUCM 4, the AXL Web Service is
running if the Call Manager service is running.
CUCM Express
No special requirements for CUCM Express.
***These requirements are for CUCM direct integration and advanced features lik e cross cluster prefixing. They do
not pertain to phones accessing the directory. Any Cisco XML enabled phone can access the directory in the No
Tenant Mode.
© 2016 Syn-Apps LLC
System Requirements
3.3
21
Network Requirements
App-Pendix requires proper connectivity to/from the CUCM and end-point devices in order to deliver notifications.
Consult the below table to determine which ports need to be opened to allow proper operation.
Firewall requirements/port usage:
Port
Description
App-Pendix to CUCM
Protocol description
80, 443, 8443
TCP - HTTP/SOAP - AXL
App-Pendix to IP Phones
80
TCP - HTTP
IP Phones to App-Pendix
80
TCP - HTTP
App-Pendix to Active Directory
389
TCP - UDP
© 2016 Syn-Apps LLC
System
Installation
Part
4
System Installation
4
23
System Installation
The required components for ASP.NET 3.5 and SQL Express 2008 R2 SP1 must be installed if the application
server running App-Pendix does not have internet access. For additional details, see the Application Server
Requirements section for the download URLs.
Users must be logged onto the application server as an administrator (local or domain) to properly complete the
installation.
Installation Procedure Description
Start the Installer
Start the App-Pendix setup program. The App-Pendix
setup program welcome screen should appear.
Click Next to proceed.
Note: Click App-Pendix to download the product
(downloads from our Syn-Apps web site > Resources >
Product Downloads). A license is required; contact
[email protected] to request one.
Accept License
Agreement
The License Agreement page should appear.
Read and accept the license terms by selecting the
I accept the agreement radio button.
Click Next to proceed.
Requirement
Information
Review and verify the server requirements.
The server requires internet access during installation.
Click Next to proceed.
The system requirements will now be validated. Missing
components will be downloaded and installed if
necessary. This could take some time depending on the
system.
Ready to Install
Click Install to start the product installation.
Install Complete
The installation is now complete. Make sure the
Launch App-Pendix Configuration checkbox is
checked.
Click Finish to begin the App-Pendix Configuration
program.
© 2016 Syn-Apps LLC
Screenshot
Configuration
Part
5
Configuration
5
25
Configuration
To use the App-Pendix software, a valid license key must be obtained from Syn-Apps Support. If you have already
obtained your key, click Browse to locate the license file that you acquired separately.
The license file screen will only appear if the license file "Syn-Apps.license" does not exist in the program base
directory (C:\Program Files\Syn-Apps\App-Pendix\). If you encounter problems with the browser shown below,
place your license in the programs' base directory and make sure it is copied there with the precise filename SynApps.license and restart the configuration program.
The following section describes the configuration utility for the App-Pendix directories system. The App-Pendix
configuration utility will automatically run at the end of installation. The program can be run on the application server
at anytime by going to: Start >> Programs >>Syn-Apps >> App-Pendix >> Configuration.
Configuration Description
Step
License
Selection
In order to use the App-Pendix software, a valid license key
must be obtained. Contact [email protected] to obtain
a license. If the license file has already obtained, click
Browse to locate it.
The Syn-Apps.License must exist in the program base
directory in C:\ProgramFiles\Syn-Apps\App-Pendix in
order to be recognized by the application. Verify the license
file has the exact file name of Syn-Apps.License.
Click Next to proceed.
Data Source
Selection
Select the source of the users data that App-Pendix
should import.
1. Select Active Directory to import the directory
information from Windows Active Directory.
2. Select Call Manager Directory (CUCM 5/6/7/8/9/10)
to import the directory information from the CUCM end
users table.
Click Next to proceed.
Database
Instance
If SQL Express was installed during this installation, leave the
default instance name as SynAppsEnt. If an existing local SQL
server instance is to be used, select the instance name from the
dropdown list.
Only local databases are supported though remote databases can be
used by changing the following registry keys:
- HKLM>Software>Syn-Apps>App-Pendix>sqlServer to the name or
IP address of the server you would like to use.
- HKLM>Software>Syn-Apps>App-Pendix>usingNonLocalDbInstance
to true.
Trusted authentication is required to use this model (the local administrator credentials of the application server
and database server machines must match).
Click Next to proceed.
© 2016 Syn-Apps LLC
26
Directory
Columns
App-Pendix Directories System User Manual and Install Guide
The Active Directory Columns form allows configuration of
the App-Pendix Directory searchable columns and
telephone numbers.
Searchable Columns
First Name and Last Name search fields are
automatically selected. To setup an additional search
column, select the column from the Filter Column field
and specify the Filter Column Type and column Label.
Telephone Numbers
Select the Phone Number fields that should be shown by the App-Pendix IP phone directory.
up to three numbers can be selected.
The Filter Column has a special purpose for most of the new App-Pendix features. To use Location Details or
search by Site, the Filter Column needs to be populated with data matching the Site-Code of a site. Sites are
configured in the CallManager Info section of Configuration. For example, if users are conducting a CUCM
Direct Integration and the Department field of the end-users on CUCM contains a Site Code that is specific to
the Site the phone is at, you can then configure the Site-Codes in the CallManager Info section of configuration
with those site-codes.
A simpler example is a single cluster deployment where the department column contains the department,
configure the departments as Site-Codes in the CallManager Info section of configuration. See the CUCM
Information section below for further details.
Click Next to continue.
Active
Directory
Information
The Active Directory Information form is used to enter AD
server information.
Enter information for each active directory server to be
imported.
*AD data
source mode
only
One AD import license is included by default, contact [email protected] to obtain additional licensing.
Active Directory Info
Active Directory Label
Active Directory Server
(IP or host name)
User Name
Password
Domain Name
Search Path
Enter the AD Details in the provided fields.
A meaningful name for the directory to distinguish it from others.
The IP Address or host name of the Active Directory server. If
the AD does not use the standard LDAP port (389) then add a
colon and the port to the end of the server IP.
User Name: The user with access to the directory.
The user with access to the directory. For OpenLDAP servers a
fully qualified user name must be used, for example
"uid=admin,ou=people,dc=example,dc=com".
Password for the above user.
The domain name of the directory.
Add a search path for the import (IE OU=MyOrg).
Click Next/New Source to add another Active Directory source. This requires valid licensing:
one Active Directory source is provided with all licenses, additional sources must be licensed.
Click Delete Source to delete the current source.
© 2016 Syn-Apps LLC
Configuration
27
Click Next to continue.
CUCM
Information
The CUCM Information page is used to enter details about
the CUCM clusters that App-Pendix will integrate with.
Enter information for each CUCM cluster that App-Pendix
should gather data from.
One cluster license is included by default, contact [email protected] to obtain additional licensing.
CUCM Cluster Details
Call Manager Version
Call Manager Label
Call Manager IP Address
Administrator Name
Administrator Password
Enter the CUCM Cluster Details in the provided fields.
Select the version of the cluster.
Enter a label for the cluster to distinguish it from others.
Enter the IP Address of the least utilized call manager in the
cluster (the AXL web service must be running on this CUCM).
Enter a CUCM administrator user name.
Enter the password for the above user.
*Note: To facilitate CUCM Express integrations the CUCM IP Address, administrator name and administrator
password can be left blank and any version can be selected. This is possible for AD integrations only. Sites
may be entered in order to use the location details and search by site features.
Sites in Current Cluster
Enter site details if location based information or cross cluster prefixing are required. For
example to provide the site location (IE state) or site address of users in the directory.
Sites in Current Cluster
Site Code
Location
Address
Prefix
Requirements
Location Details
Cross-Cluster Prefixing
Enter Site details in the provided fields [not required]
The data in the users Filter Column that matches this site /
functional entity / etc. Site-Codes need not be physical
sites.
The location of this site / functional entity / etc.
The address or other data for this site / functional entity / etc.
The cross cluster prefix used to access this cluster.
The requirements for location details and cross cluster
prefixing.
The Filter Column data from the columns configuration
panel must contains the Site-Code of the site that the user
belongs to.
[CUCM direct integration] - User to device associations
(ccmadmin>end users: device association) are required if the
OU parameter is not specified in the directories URL.
[AD or CUCM integration] - The OU parameter is specified in
the directories URL and matches the Site-Code of the
requesting user.
Tenant Type
Device Pool
Calling Search Space
Not Using Tenants
© 2016 Syn-Apps LLC
Choose the method in which to define directory tenants (IE
Hosted CUCM)
Partition tenants into sites using Device Pool.
Partition tenants into sites using Calling Search Space.
All users of the directory access the entire directory.
28
App-Pendix Directories System User Manual and Install Guide
*Note: Custom directories are now available for both tenant and no tenant modes.
Select Next / New Site to Cluster to add a new site to the current cluster.
Select Delete Site / Cluster to delete the current site; if the current site is the first site in the
cluster, the cluster will also be deleted.
Select Next / New CUCM Cluster to add a new cluster.
Select Next to continue.
Directory
Name and
Application
Admin User
Directory Display Name
Enter the name for the Cisco IP Phone directory, this is
the name that will appear under the Directories button on
the IP phones.
Application Admin User
Setup the App-Pendix application administrator user
account credentials. This will be the system admin user
for the App-Pendix notification system. This can be a
fictitious user.
When using Communications Manager 3.x log into the Syn-Apps application server with the same user name
and password that exists on the Communications Manager. This must be an Administrator account and must
have the same user name and password as the Administrator account on Communications Manager 3.x.
Click Configure to configure the product.
Configuration When the application is configured you will see a success
Complete
window. Click OK to proceed.
An informational message will appear instructing the
installer to change the CUCM authentication URL. Click
OK to proceed.
License
Activation
If the license has not been activated the Activation Wizard
will appear.
Select Online if the App-Pendix server has access to the
Internet. Click Next to activate the license.
Select By Email if the App-Pendix server does not have
access to the Internet. Click Next. Further instructions
will be provided in this case.
When the Configuration Wizard has completed the installation a shortcut will be placed on the desktop labeled
App-Pendix, use it to access the App-Pendix web administration program. Access the App-Pendix administration
webpages form any machine on the network, simply browse to http://<application-server-ip>/App-Pendix.
The App-Pendix webpage should be displayed automatically when the configuration program completes.
Proceed to the Phone Services section to setup the IP phone directory. See the App-Pendix: Settings section for
directory settings.
© 2016 Syn-Apps LLC
Web
Management
Interface
Part
6
30
6
App-Pendix Directories System User Manual and Install Guide
Web Management Interface
The App-Pendix web management interface is accessible from any computer on the same network as the AppPendix application server. To access the App-Pendix web user interface, use one of the following methods:
Web Management
Description
Shortcut
Double click on the App-Pendix shortcut that was created on the
application server desktop.
Navigate
Open a web browser and navigate to http://
<App-Pendix-Server-IP>/App-Pendix
*Note: After configuration you will be directed to the Post Install Screen. Navigate to Main>>Tenants and the login
screen will appear.
Once the website opens you will be prompted to enter your user name and password. The default login is the same
as the account info you supplied at the end of configuration in the Application Admin User section.
Enter the admin user credentials and click Login or press Enter.
© 2016 Syn-Apps LLC
Configuring
Tenants
Part
7
32
7
App-Pendix Directories System User Manual and Install Guide
Configuring Tenants
Main >> Tenants >>Tenant Sites
To access the tenant configuration page select Tenants from the Main tab.
Tenants are used to partition the directory into logical entities. Tenants are most often used in hosted CUCM
environments to provide clients with directories for their company. This is accomplished using the tenant option
admin users selected during the configuration. Any option other than "No Tenants" must be selected in order to
use tenants. If an option is selected, then tenants will be partitioned using the parameter specified: (Device Pool /
Calling Search Space). For example, if "Device Pool" was selected as the tenant option, then the tenants will be
partitioned using Device Pools. In this case, users would associate Company-A's Device Pools and users with the
Company-A tenant.
If the option to use tenants was selected during configuration, it will be possible to select the Tenants menu button
in order to configure tenants. It is possible to associate the corporate directory list with each tenant.
To create a new tenant, select New Tenant in the Tenant to Edit field and enter the new tenant name into the
Tenant Name field. Click Save.
© 2016 Syn-Apps LLC
Configuring Tenants
7.1
33
Tenant Sites
Main >> Tenants >> Tenant Sites
The Tenant Sites tab is also where sites are associated to a tenant, this controls which phones can access the
currently selected tenant. Only phones in the tenants Selected sites (Device Pool or Calling Search space
depending on the configuration option that was selected) will be able to access the users in this tenant directory,
users are associated on the tenant members tab.
After creating a tenant you can associate sites (DP/CSS) to the tenant by selecting the DP/CSS within the Tenant
Sites tab and click the double-right arrows >>. This will move the selected DP/CSS into the Selected field. Click
the Save button.
*Note: Once a tenant has been assigned to a specific DP/CSS, that DP/CSS is no longer available to any other
tenant.
© 2016 Syn-Apps LLC
34
7.2
App-Pendix Directories System User Manual and Install Guide
Tenant Users
Main >> Tenants >> Tenant Members
The Tenant Members tab is where users are associated to the currently selected tenant. Only the selected users
will be viewable to phones able to access this tenant directory.
Associate users to the tenant by selecting and adding them on the Tenant Members tab. The associated users
will be available in the tenant directory. To filter the users in the Field menu, select the method in which you want
the users to be filtered. For example, by Last Name, First Name, or Phone Number. Click Filter. Select the users
you want to add to the selected tenant and click the double-right arrows >>, moving the user name(s) into the
Selected field. Changes are automatically saved.
The Dynamic Tenant checkbox can be used to dynamically apply the filter you have selected to the tenant. For
example, setting the Field to department and contains field to Sales would filter only the users in department >>
Sales. As new users are added to the department, there is no need to update the tenant in App-Pendix, as it will be
dynamically applied on each directory access.
*Note: Users that are not assigned to a tenant are not available in App-Pendix directory when in Tenant mode. The
selected users will be viewable to the sites that are selected for this tenant.
Enter an administrator name and password for this tenant in the provided fields on the Tenant Admin Credentials
tab
Note: NOT REQUIRED - By default, the Tenant Administrator and Password fields are set to the same as the
App-Pendix top level administrator.
© 2016 Syn-Apps LLC
Configuring
Custom
Directories
Part
8
36
8
App-Pendix Directories System User Manual and Install Guide
Configuring Custom Directories
Main >> Custom Directories >> Directory Sites
To access the custom directories setup page, click on the Custom Directories button from the Main tab.
Custom directories can be used to provide extra menu entries in the directories list in the user directory
menu. In addition to the corporate directory, users can have custom directories such as Emergency
Numbers, Vendors, and more. Custom directories examples below are shown in Tenant Mode.
© 2016 Syn-Apps LLC
Configuring Custom Directories
37
To create a new custom directory:
Custom Directory Creation
Description
Directory Sites
Select the Directory Sites tab if it is not already selected.
New Directory
Select New Directory in the Directory to Edit field.
Tenant
In the Tenant field, select the tenant that the directory will be shown to.
Directory Name
Enter a Name for the new directory in the Directory Name field.
Save
Click Save to finalize changes.
The Directory Sites tab of the custom directories page allows sites to be added to the currently selected custom
directory. Only Selected sites will be able to see the custom directory in their directories list.
You will need to select the appropriate Device Pool / Calling Search Space under the Available field and click
Add in order to move it to the Selected field. These are the tenant sites that will be able to view this particular
directory, add all sites if all of the selected tenant sites should be able to see the directory.
* If the no tenant option is in use then sites do not need to be managed here, all phones with directory access will
be able to view all custom directories.
© 2016 Syn-Apps LLC
38
8.1
App-Pendix Directories System User Manual and Install Guide
Directory Data Structure
Main >> Custom Directories >> Directory Fields
The custom directories Directory Fields tab is used to assign the columns available in the currently
selected custom directory. Field Name, Type, Role and Search Role are configurable. Up to seven
fields can be configured. If less fields are required, the extra remaining fields can be left in the default
configuration.
To assign the Field information, click Edit on the desired row in the Directory Data Structure table. After
clicking Edit, the program allows users to provide a name for your field in the Field Name area, specify
the Field Type, and Directory List Role. It is also recommended that users select a Search Field Role.
Add as many fields as necessary for the directory data.
Example: Field Name - Vendor Name, Field type - Text, Directory List Role - Entry Name, and Search Field
Role - Use as Search Field 1.
Continue to edit each row, depending on how many different fields are needed for your contact entries.
© 2016 Syn-Apps LLC
Configuring Custom Directories
8.2
Entering Directory Data
Main >> Custom Directories >> Directory Data
The custom directories Directory Data tab is used to enter directory data into the currently selected
custom directory.
After configuring the Directory Data Structure, data can be added to the directory. Click Add Row to
create a new entry. Enter the desired information in the provided fields. In the example, fields were created
for Vendor, Primary Number, Backup Number and Location.
The information for each of these fields must now be entered in order for it to be viewed in the directory. Use
the Add Row button to create for as many entries as necessary. See Accessing Custom Directories for
instructions on accessing the new directory.
Note: Using any characters other than 1-9 and a-z in a searchable field is not advised. The predictive
directory can handle the characters but they will all be mapped to the "1" key. This is generally not an
issue in the corporate directory since searches are done by first name, last name and the configurable filter.
© 2016 Syn-Apps LLC
39
Settings
Part
9
Settings
9
Settings
Main >> Settings >> Directory Settings
The Settings page is accessed from the Main tab and is only available to the Global Administrator.
© 2016 Syn-Apps LLC
41
42
9.1
App-Pendix Directories System User Manual and Install Guide
Directory Settings
Main >> Settings >> Directory Settings
The Directory Settings tab allows the administrator to control the following settings for the global directory:
Setting
Description
Number Settings
Control how telephone numbers appear in the IP phone directory.
Labels
Labels for the phone number fields that were selected in configuration.
Prefix
A prefix to add to the number. For example, most users will want to add a "9" prefix for
any external numbers in the directory like mobile or home phone.
Use Cross Cluster
Prefixing
Enable the checkbox to use the cross cluster prefix configured in the sites
configuration.
Reduce Delivered
Digits
Enter a non-zero value to strip the number to the specified number of digits. For
example, a Reduce Delivered Digits setting of 4 would reduce the number (480) 3556826 to 6826.
This setting is useful if the office phone field is populated with the external phone
number. Users may wish to set the field to the number of digits in the internal dial plan,
(assuming that gives the proper internal directory number). The prefix field can be used
in conjunction with the reduce field incase your external numbers have a different first
digit when masked to the internal number.
Replace + with
Replaces any "+" in a phone number with the specified pattern. For international
numbers generally, the default setting of 011 is for US callers.
Predictive Mode
Control the Directory Mode.
Predictive Mode
Controls the default (global mode) of the Directory shown on users Cisco phone display.
When enabled (checked), users that access the directory will be in Predictive Mode
© 2016 Syn-Apps LLC
Settings
43
(pseudo T9 texting search). When not enabled (unchecked), the initial directory display
will be displayed in Classic Mode, (field-search mode).
Mode Toggle SoftKey
Controls whether or not a Soft-Key can be used to toggle the mode between Classic
(default Cisco field search mode) and Predictive Mode (pseudo T9 texting search) is
provided on the Directory Search page.
The button label can be changed using the Soft-Keys tab in the App-Pendix user
interface. New label names will be reflected on the Cisco phone display screen.
Other Settings
Note: Sites are defined by the values configured in Filter Column drop-down list in the
App-Pendix Configuration Utility. See the App-Pendix Configuration Utility >>
Directory Columns row for details.
The Filter Colum n drop-dow n list m ust be
configured to enable custom Location/Departm ent
searchability on end-users Cisco IP phones.
Show Location
Details
Controls whether or not the location details (Location and Address) to users accessing
the directory.
Show User Details
Soft-Key
This checkbox enables a user details button (soft-key) visible on the Cisco phone
display, called Details. It provides end-users to see additional contact details from their
IP phones' display. The button label can be changed using the Soft-Keys tab in the AppPendix user interface. New label names will be reflected on the Cisco phone display
screen.
Show Sites Menu
Item
This checkbox gives users a menu of sites previously defined during configuration.
Show All Site Search Controls whether or not a Soft-Key is visible on users Cisco phones to search by site on
Soft-Key
the directory search page. If enabled, a list of Site Codes is provided for users to select
from.
Local (Site) Search
Soft-Key
This checkbox enables a Soft-Key. Pressing the soft-key displays a list of Users who
are in the searching phones' associated Site. The phone is linked to a Site through the
phone association in the CUCM End-User's configuration.
Country (Cluster)
Search Soft-Key
Enabling the Country (Cluster) Soft-Key checkbox displays a menu of countries sorted
by cluster names for users to select from their phone.
Local Search Menu
This checkbox enables the tenant's Site menu displayed on the user's phone.
This checkbox enables a Soft-Key which allows personnel to display a list of available
Sites, as defined by the Filter Column settings, (found in the Configuration Utility). The a
soft-key to search and select local users within the directory.
Country (Cluster)
Search Menu
© 2016 Syn-Apps LLC
Enabling the Country (Cluster) Search Menu checkbox allows Countries, sorted by their
Cluster name, to be searched on the user's Cisco phone.
44
App-Pendix Directories System User Manual and Install Guide
Active Directory
Settings
Settings specific to AD integration mode.
Site-Code Filter Field Controls the meaning of the OU parameter when used in the directories URL. For
example in a hosted solution with an Active Directory data source it is possible to
control the users viewable by those accessing the directory by using the OU parameter
of the service URL. The parameter will search on OU by default but this can be changed
by using this setting to search on DC or CN instead. This functionality would generally
be obtained by using dynamic tenants with a filter on the LDAP search path field. This
option is available for AD integration mode only.
To use cross cluster prefixing in AD integration mode without filtering the returned users
b ased on this parameter uncheck all b oxes and supply the OU parameter in the directories
URL, the OU value should match the accessing users Site-Code.
© 2016 Syn-Apps LLC
Settings
9.2
45
Soft Keys
Main >> Settings >> Soft Keys
The Soft-Keys tab allows users to customize the Soft-Keys and Menu Items that appear in the Cisco phone
directory:
Soft Key and Menu
Settings
Description
Note: Short values are recommended when renaming Soft-Key Labels.
Longer label names may be cut off on the phone display.
Predict
Sets the Soft-Key label name displayed on the Cisco phone for Predict soft-key.
Note: Mode-Toggle Soft-Key check box must be enabled in the Directory Settings
page in order for the Predict and Non-Predict Soft-Keys to appear on a Cisco
phone display.
Non-Predict
Sets the Soft-Key label name displayed on the Cisco phone for Non-Predict softkey.
Note: Mode-Toggle Soft-Key check box must be enabled in the Directory Settings
page in order for the Predict and Non-Predict soft-k eys to appear on a Cisco
phone display.
© 2016 Syn-Apps LLC
46
App-Pendix Directories System User Manual and Install Guide
NonPred soft-key button is displayed on
a Cisco phone.
Site Search
Sets the soft-key label name which is displayed on the Cisco phone for Site
Search.
Note: Show All Site Search Soft-Key check box must be enabled in the Directory
Settings page in order for the Site Search soft-k eys to appear on the Cisco phone
display.
Local (Site) Search
Soft-Key
Sets the label name for Local Site Search, which is displayed on Directory
Search on the Cisco phone directory. This adds an extra soft-key on the phone's
display.
Pressing this soft-key will display a searchable list of local (site) users in the
directory.
Note: This option requires users to be associated to a device in CUCM. This
option is only available for CUCM Direct integration. Note: The Local (Site)
Search Soft-Key check box must be enabled in the Directory Settings page in
order for the the soft-k ey to appear on the Cisco phone display.
Country (Cluster)
Search Soft-Key
Sets the label name for Country (Cluster) Search soft-key shown on the directory
search page displayed on Cisco phones. Pressing the soft-key allows the user
accessing the directory to search for all users configured within the same
configured cluster. This option is available for CUCM Direct integration only.
Note: Country (Cluster) Search Soft-Key check box must be enabled in the
Directory Settings page in order for the Country (Cluster) Search soft-k ey to
appear on the Cisco phone display.
Submit
Sets the soft-key label name displayed on the Cisco phone for the Submit Key.
Note: There is no check box that must be enabled in the Directory Settings page
in order for the Submit button soft-k ey to appear on the Cisco phone display.
Details
Sets the soft-key label name displayed on the Cisco phone for the Details softkey button.
Note: Show User Details Soft-Key check box must be enabled in the Directory
Settings page in order for the Details soft-k eys to appear on the Cisco phone
display.
© 2016 Syn-Apps LLC
Settings
Details soft-key button is show n on a
Cisco phone.
Site Search Menu
Item
User details appear on the the user's
phone display after clicking the
Details soft-key button
Sets the soft-key label name displayed on the Cisco phone for Site Search Menu
Item.
Note: Show Sites Menu Item check box must be enabled in the Directory Settings
page in order for the Site Search Menu to appear in the top-level directory menu
on the Cisco phones.
© 2016 Syn-Apps LLC
47
48
9.3
App-Pendix Directories System User Manual and Install Guide
Directory Browser
Main >> Settings >> Directory Browser
The Directory Browser tab allows users to select which user detail fields to show and hide.
To hide any undesired fields, disable (uncheck) the checkboxes
Note: If you do not have user images stored on the Active Directory server, then disable (uncheck) the Get user
images from LDAP server checkbox to increase the LDAP refresh speed.
© 2016 Syn-Apps LLC
Settings
9.4
49
CUCM Sites
Main >> Settings >> CUCM Sites
The CUCM Sites tab contains a table containing a list of configured CUCM Clusters and Sites. Run the
configuration from Start >> Programs >> SynApps >> App-Pendix >> Configuration to change the configured
CUCM Clusters and sites.
© 2016 Syn-Apps LLC
50
9.5
App-Pendix Directories System User Manual and Install Guide
LDAP Data Sources
Main >> Settings >> LDAP Data Sources
The LDAP Data Sources tab contains a table containing a list of configured LDAP Data sources. Run configuration
from Start >> Programs >> SynApps >> App-Pendix >> Configuration to change the configured LDAP data
sources.
© 2016 Syn-Apps LLC
Settings
9.6
Password
Main >> Settings >> Password
Use the Password tab to change the Global Administrator password.
Press Update once you have entered the new password into both fields.
© 2016 Syn-Apps LLC
51
52
9.7
App-Pendix Directories System User Manual and Install Guide
Email Settings
Main >> Settings >> Email Settings
Use the Email Settings tab to set the SMTP Server address or name and the mailer From Address.
Enter your SMTP server address or name and the address the e-mail will be sent from. Tip: Use a valid
organizational e-mail address such as: <company name>@<company name>.com.
© 2016 Syn-Apps LLC
Settings
9.8
Service Log Level
Main >> Settings >> Service Log Level
Use the Service Log Level tab to set the logging level for App-Pendix. Only change this setting at the
request of Syn-Apps Support.
© 2016 Syn-Apps LLC
53
Directory
Browser
Part
10
Directory Browser
10
55
Directory Browser
Main >> Directory Browser
The directory browser provides a way to browse the directory from any device connected to the network.
Note: The directory browser can be accessed by anyone, as it is not secured by authentication. The direct link to
the browser shown here is http://<App-Pendix-Server-IP>/Directory.aspx. To direct users to the browser only,
(without the rest of the App-Pendix website), use the following URL: http://<App-Pendix-Server-IP>/
DirectoryOnly.aspx.
The directory browser has a number of special features, including:
1. Search capabilities - Search the directory browser using the provided search box. this will search all fields at
once (even detail fields).
2. Organization - Arrange by a column by clicking that column header.
3. Easy navigation - Page through the browser using the buttons in the bottom left of the browser.
4. Expand to view details - To see user details click on the user and the "Selected User Detail" area will be
populated with that users data including a photo of the user (see below for details on user photos). The fields
shown in the Selected User Detail area are configurable. For additional details, see the Settings - Directory
Browser section of the manual.
Some fields may not be available in CUCM direct integration mode. These fields include Address, State, all phone
© 2016 Syn-Apps LLC
56
App-Pendix Directories System User Manual and Install Guide
numbers (besides the configured phone number fields), jpegPhoto and thumbnailImage.
When accessing the DirectoryOnly.aspx page it is possible to show the phone numbers with their prefixes and
reduced digits.
1. Add the callers clusterNumber parameter to the end of the URL as follows: http://<App-Pendix-Server-IP>/
App-Pendix/DirectoryOnly.aspx?clusterNumber=<n>; where <n> is the cluster number of the user accessing
the browser.
Images
1. In active directory integration mode user images will be copied from the active directory server, if they exist
(jpegPhoto or thumbnailPhoto attributes).
2. Add user images, using any mode, to the browser by placing the images in C:\Program Files\SynApps\AppPendix\UserImages. The images need to be named with the following format: (FirstName)(Initials)
(LastName).png. For example JohnHSmith.png. Valid image types are png and jpg.
© 2016 Syn-Apps LLC
Phone Services
Part
11
58
11
App-Pendix Directories System User Manual and Install Guide
Phone Services
To setup App-Pendix for use with IP Phones, one of two options can be
used:
1. App-Pendix accessed with the directories button on the phone.
2. App-Pendix as an IP Phone service (accessed via the services button
on the phone).
Cisco IP Phone Feature Buttons Area
Note that the directories b utton setup is different depending on the version of
CUCM. The first section in the tab le pertains to CUCM 7.1(1) and earlier while
the second section pertains to CUCM 7.1(2) and newer.
App-Pendix as Directories button setup
Directories Setup
Deploy App-Pendix to the Directories button on the IP phones.
Directories Button
CUCM 7.1(1) and earlier - Access the directory using the directories button.
Browse CCMAdmin Go to CUCM CCMAdmin >> System >> Enterprise Parameters.
Set Directories URL Set URL Directories to http://<App-Pendix-Server-IP-Address>/App-Pendix/PhonePages/
AppPendixMenu.aspx
Save Changes
Click Update.
Restart Phones
Restart the phones so that they can read the new configuration.
Directories Button
CUCM 7.1(2) and newer - Access the directory using the directories button.
Browse CCMAdmin Go to CUCM CCMAdmin >> Device >> Device Settings >> Phone Services
Add New Service
Add a new phone service with the following parameters:
Service Parameters
Name
Service URL
Secure-Service URL
Service Category
Service Type
Enable
Enterprise
Subscription
Some parameters may not exist on all CUCM versions.
The name the directory should be listed as (IE Corporate
Directory).
Enter http://<App-Pendix-Server-IP-Address>/App-Pendix/
PhonePages/AppPendixService.aspx?
name=#DEVICENAME#
Enter http://<App-Pendix-Server-IP-Address>/App-Pendix/
PhonePages/AppPendixService.aspx?
name=#DEVICENAME#
Select XML Service.
Select Directories.
Check the Enable check box to enable the directory.
Check the Enterprise Subscription check box.
Press Save to save the new directory phone service.
Disable Old Service If the list of phone services on CUCM already contains a Corporate Directory then it
should be disabled or it will also show in the list of directories under the phone directory
button. Edit the service to disable it by un-checking the Enable checkbox.
© 2016 Syn-Apps LLC
Phone Services
59
App-Pendix as a Phone Service setup
Phone Service Setup Deploy App-Pendix to the Services button on the IP phones.
Phone Service
Access the directory using the services button on the IP phones.
Browse CCMAdmin
Go to CUCM CCMAdmin >> Device >> Device Settings >> Phone Services
Add New Service
Add a new phone service with the following parameters:
Service Parameters
Name
Service URL
Secure-Service URL
Service Category
Service Type
Enable
Enterprise
Subscription
Some parameters may not exist on all CUCM versions.
The name the directory should be listed as (IE Corporate
Directory).
Enter http://<App-Pendix-Server-IP-Address>/App-Pendix/
PhonePages/AppPendixService.aspx?
name=#DEVICENAME#
Enter http://<App-Pendix-Server-IP-Address>/App-Pendix/
PhonePages/AppPendixService.aspx?
name=#DEVICENAME#
Select XML Service.
Select Standard IP Phone Service.
Check the Enable check box to enable the directory.
Check the Enterprise Subscription check box.
Press Save to save the new phone service.
Add Parameters
*not required
If the service is to be configured for a specific LDAP OU, add a new parameter to the
service URL. The parameter name is OU, the default value is blank, this parameter is
not required.
This option requires AD integration mode. The OU parameter can be set to represent
OU, DC or CN (simply set the value of the parameter to the value of the OU, DC or CN
in question).
Subscribe Phones
© 2016 Syn-Apps LLC
Subscribe IP phones to the service. Those phones should now be able to access the
service using the service button.
Accessing
Directories
Part
12
Accessing Directories
12
61
Accessing Directories
After the App-Pendix service or directories URL has been applied to phones the directory can be accessed using
the directories or services button on the phone. The following table describes using the predictive mode
directory on a Cisco IP Phone.
Accessing Directories
After accessing the directory using the directory button or services
button selection menu will appear (shown for directories button):
Shown for predictive mode, for an example of classic mode see the
Accessing Custom Directories section.
Select the Corporate Directory which will be named with the data
you provided in configuration. The main search screen will be
shown, at this point users begin to enter keypad numbers
corresponding to the letters they are searching on. The search
fields are first name, last name and the Filter Column you selected
in configuration, users will need to be aware of this due to
limitations in the number of characters that can be displayed on
the menu items available on the phones:
Only one button press is needed for each character. The screen
will update when a character is input showing the number of users
remaining at the bottom in the prompt area and the first match
seen at the top next to the title. Press Submit at any point to
return all matches, press the << Soft-Key to backspace the filter
(in the screen shot the number 7 [PQRS] was pressed, the users
remaining went from 100 to 94 and the first match found began with
P):
In the following screenshot one more key press has occurred. The
user has entered 74 and the first match is "Ri" with 11 users
remaining. Note that even though the first entry showed "P" that
user has now been filtered out so the text has changed to match
the new prediction:
© 2016 Syn-Apps LLC
Screenshot
62
App-Pendix Directories System User Manual and Install Guide
The 8 [TUV] button was pressed and there was only one match so
the one user was automatically returned. Location details are
turned on so the users site Location is shown in parenthesis.
The user [Last Name, First Name] was selected, displaying the
selected users' configured phone number(s). Location details are
turned on so the users site Location is shown in parenthesis and
the site address is shown in the prompt area at the bottom. At
this point the user can press one of the items by number or
highlight it and press Dial or Edit Dial if the number needs to be
edited before dialing. To see the users contact card press the
"Details" soft-key.
The "Details" soft-key has been pressed and the users contact
card is now visible. Pressing the "Photo" soft-key will show the
photo only in a larger format. Pressing the "Exit" soft-key will
return to the user numbers page for auto dialing. The user contact
card is shown below:
The "Photo" soft-key has been pressed and the users photo is now
visible. Pressing the "Details" soft-key will return to the users
contact card. Pressing the "Exit" soft-key will return to the user
numbers page for auto dialing. The user photo card is shown
below:
© 2016 Syn-Apps LLC
Accessing Directories
12.1
Accessing Custom Directories
In order to access any custom directories that have been created on the system press the directories or
services button on a subscribed IP phone. The following table describes the custom directory search
process for classic mode.
Accessing Custom Directories
When the Services menu comes up on the screen, select the AppPendix Service (or service name used when creating the service).
Select the Custom Directory you would like to access.
After selecting the desired directory, the search fields that you created
will pop up (Search Field Role). You will then be able to search for a
specific name, number, or any other specified field from this screen. If
you would like to view a complete list of all users assigned to the
selected directory, press Submit. The entire list of contacts entered
into the directory will then be viewed.
*Shown for classic mode, see Accessing Directories for an
example of predictive mode access.
Select the contact you would like to view and the screen will show all
of the available information.
All of the information for the selected contact that was entered into the
directory is now viewable on the IP phone screen. You may Dial or
Edit the number, or Exit the screen.
© 2016 Syn-Apps LLC
Screenshot
63
Help and
Support
Part
13
Help and Support
13
65
Help and Support
To access the Help and Support section of App-Pendix, select the Help tab.
The App-Pendix Help tab contains the following sections:
App-Pendix Help
Description
Post Install Instructions
A quick-start guide for the application.
Documentation
The product installation and user guide.
Request Support:
Knowledge Base
Prepare Report
The Request Support page contains two sections. The first is a link to
the product Knowledge Base for solutions to common issue. The
second is the Prepare Report feature which allows users to
automatically create a support ticket.
Contact Syn-Apps Support
© 2016 Syn-Apps LLC
66
13.1
App-Pendix Directories System User Manual and Install Guide
Post Install Instructions
Help >> Post Install Instructions
To access the Post Install Instructions section of App-Pendix, select the Help tab >> Post Install Instructions
button.
The Post Install Instructions page provides basic App-Pendix setup info. This page is shown after successful
configuration of the App-Pendix Directories System. The page contains the following tabs:
Post Install Instructions
Description
Basic Instructions
Basic information for setting up tenants and custom directories.
Directories Setup
IP phone directories service setup information.
Phone Service Setup
IP phone service setup information.
Directory Browser
App-Pendix web directory browser information.
Misc Info
Basic IP Phone requirements.
© 2016 Syn-Apps LLC
Help and Support
Post Install Instructions >> Directories Setup
Post Install Instructions >> Phone Service Setup
© 2016 Syn-Apps LLC
67
68
App-Pendix Directories System User Manual and Install Guide
Post Install Instructions >> Directory Browser
Post Install Instructions >> Misc Info
© 2016 Syn-Apps LLC
Help and Support
13.2
Documentation
Help >> Documentation
To access the Documentation section of App-Pendix, select Help >> Documentation button.
The Help >> Documentation page contains the App-Pendix User Guide in PDF format.
© 2016 Syn-Apps LLC
69
70
13.3
App-Pendix Directories System User Manual and Install Guide
Request Support: Knowledge Base
Help >> Request Support >> Knowledge Base
To access the Knowledge Base section of App-Pendix select the Help tab >> Request Support button >>
Knowledge Base tab.
The Request Support page contains a Knowledge Base tab that can be used to look at known issues and to add
feature requests. Please consult the knowledge base for solutions to known problem before proceeding to the
Prepare Report tab to enter a new trouble ticket.
© 2016 Syn-Apps LLC
Help and Support
13.4
71
Request Support: Prepare Report
Help >> Request Support >> Prepare Report
The Request Support page contains a Prepare Report tab that can be used to generate a Syn-Apps support
request. This is the preferred method of obtaining support as all log files will be automatically sent to Syn-Apps
Support and a trouble ticket will be created. FTP and email access is required for the process to work fully
automatically (See Email Settings to setup the email system before requesting support).
To request support please fill out the following information in the interface provided on the page:
Prepare Report Field
Description
Contact Email Address
Enter the email address of the person Syn-Apps Support should
contact in response to this trouble ticket.
Contact Phone Number
Enter the phone number of the person Syn-Apps Support should
contact in response to this trouble ticket.
Description
Enter a detailed description of the problem in the provided text box.
Provide as much detail as possible as to how the problem is occurring.
© 2016 Syn-Apps LLC
72
13.5
App-Pendix Directories System User Manual and Install Guide
Contact Syn-Apps Support
Please feel free to contact Technical Support directly with any issues you may have.
Email Support at [email protected] or call 1-866-664-6071 >> option 2.
13.6
Information Center
All of this information can be accessed by clicking on the Syn-Apps logo graphic located in the upper-left corner of
the user interface. To stop viewing the data,click on the Exit Menu button in the lower-right corner or click anywhere
on the main App-Pendix page to close the information window.
App-Pendix Information Menu contains information that provides quick access to the following items:
Information Center
Menu
Description
General
General information about the product
Changes
This section provides access to the App-Pendix change log. Please refer to
this section to learn about application enhancements and bug fix information.
Info
This section provides access to the application registry key settings. This is
useful when Syn-Apps support asks system configuration information. You
can also use this section to quickly verify system settings.
License
The License section provides access to the currently installed license
information including your maintenance contract number and start/end dates.
Licenses can also be updated on this page using the interface at the bottom.
Lists
User and group configuration lists
Users
This section displays a list of all users that have been provisioned for access
to the App-Pendix web interface. The values displayed are Username and if
the user has been provisioned as a global administrator.
© 2016 Syn-Apps LLC
Help and Support
© 2016 Syn-Apps LLC
73
74
App-Pendix Directories System User Manual and Install Guide
Index
-HHelp
65, 70, 71, 72
Help - Contact
72
Help - Knowledge Base
70
Help - Prepare Report
71
-AAccessing Custom Directories
Accessing Directories
61
Application Server
13
63
-I-
-CCall Manager Requirements
20
Communications Manager Requirements
Configuration
25
Configure
25
Configuring Custom Directories
36
Contact Syn-Apps
72
Cross Cluster Prefixing
41
CUCM Requirements
20
CUCM Sites
49
Custom Directories
36, 38, 39
Custom Directory Data
39
Custom Directory Data Structure
38
-D-
-KKnowledge Base
-L-
Manual
69
Mode Toggle
-F-
50
-M-
-EEmail Settings
52
Entering Custom Directory Data
70
LDAP Data Sources Viewer
License Selector
25
Location Details
41
Login
30
Defining Tenant Users
34
Directory Browser
48, 55
Directory Service
58
Documentation
69
Features
20
Information Center
72
Information Center - Changes
72
Information Center - Info
72
Information Center - License
72
Information Center - Users
72
Install Guide
23
Installation
23
IP Phone Services
58
39
41
-NNetwork
21
New Features
7
10
-O-
-G-
Overview
Global Password
7
51
© 2016 Syn-Apps LLC
Index
-PPhone Number Labels
41
Phone Number Prefixing
41
Phone Services
58
Post Install Instructions
66
Predictive Mode
41
Prepare Report
71
-RReduce Phone Number Digits
Requirements
12, 13, 21
41
-SServer
13
Service Log Level
53
Settings
41, 48, 49, 50, 51, 52, 53
Site-Code Filter Field
41
Summary
7
Support
65
System Requirements
12, 13, 21
-TTenant Members
34
Tenant Sites
33
Tenant Sites Configuration
33
Tenant Users
34
Tenants
32, 33
Tenants Basic Configuration
32
-UUser Guide
69
-WWeb GUI
30
© 2016 Syn-Apps LLC
75
2812 N Norwalk
Suite 112
Mesa, AZ 85215
Phone (866) 664-6071
Fax (866) 659-8999
[email protected]
www.syn-apps.com