Installation and
Configuration Guide
BlackBerry Resource Kit for BES12
Version 12.1
Published: 2015-03-26
SWD-20150326092634405
Contents
What is BES12?................................................................................................................ 4
Key features of BES12.......................................................................................................................................................4
What is the BlackBerry Resource Kit for BES12?................................................................5
Downloading the BlackBerry Resource Kit for BES12.........................................................................................................5
System requirements........................................................................................................7
Compatibility with other releases.......................................................................................................................................7
System requirements: BES12 Log Monitoring Tool ............................................................................................................ 7
System requirements: BlackBerry Push Initiator Tool.........................................................................................................8
Installing tools from the BlackBerry Resource Kit............................................................ 10
Install tools from the BlackBerry Resource Kit................................................................................................................. 10
Files for the BlackBerry Resource Kit tools.......................................................................................................................11
Support for UTF-8 encoding............................................................................................................................................11
Configure command-line tools to use UAC-compliant file paths........................................................................................11
Postinstallation tasks...................................................................................................... 12
BlackBerry Push Initiator Tool......................................................................................................................................... 12
Configure the BlackBerry Push Initiator Tool for a BES12 connection........................................................................12
Configure the BlackBerry Push Initiator Tool for a BlackBerry MDS Connection Service connection...........................13
Remove the BlackBerry Resource Kit tools......................................................................14
Glossary......................................................................................................................... 15
Legal notice ................................................................................................................... 16
What is BES12?
What is BES12?
1
BES12 is an EMM solution from BlackBerry. EMM solutions help you do the following:
•
Manage mobile devices for your organization to protect business information
•
Keep mobile workers connected with the information that they need
•
Provide administrators with efficient business tools
With BES12, you can manage the following device types:
•
BlackBerry 10
•
BlackBerry OS (version 5.0 to 7.1)
•
iOS
•
Android (including Samsung KNOX)
•
Windows Phone
You can manage these devices from a single, simplified UI with industry-leading security.
Key features of BES12
Feature
Description
Management of many types of devices
You can manage BlackBerry 10, BlackBerry OS (version 5.0 to 7.1), iOS,
Android, and Windows Phone devices.
Single, unified UI
You can view all devices in one place and access all management tasks in a
single, web-based UI. You can share administrative duties with multiple
administrators who can access the management console at the same time.
Trusted and secure experience
Device controls give you precise management of how devices connect to your
network, what capabilities are enabled, and what apps are available. Whether
the devices are owned by your organization or your users, you can protect your
organization's information.
Balance of work and personal needs
BlackBerry Balance and Secure Work Space technologies are designed to
make sure that personal information and work information are kept separate
and secure on devices. If the device is lost or the employee leaves the
organization, you can delete only work-related information or all information
from the device.
4
What is the BlackBerry Resource Kit for BES12?
What is the BlackBerry Resource Kit
for BES12?
2
The BlackBerry Resource Kit is a collection of tools that you can use to manage, monitor, and troubleshoot devices that are
associated with BES12. You can download the BlackBerry Resource Kit from Software Download for BlackBerry Enterprise
Server Resource Kit.
The BlackBerry Resource Kit for BES12 includes the following tools:
Tool
Description
BES12 Log Monitoring Tool
A command-line tool that you can use to monitor the information that is written to the log files
for BES12 components. You can specify actions that you want the tool to perform when it
encounters specific values, such as text strings. For example, you can configure the tool to run
a custom batch file when it finds a specific text string in a log message.
BlackBerry Push Initiator Tool An application that you can use to push data to apps installed on BlackBerry 10 devices. For
example, you can push mapping information about folders in an organization's network that
BlackBerry 10 device users can then access using the BlackBerry Work Drives app without the
users needing to configure access to the folders. You can customize the data for group
members or individuals. You can create a batch file to specify the mapping information that
the BlackBerry Push Initiator Tool uses. You can use a scheduling tool to run the batch file.
BlackBerry Enterprise
Transporter for BES12
An application that you can use to move user accounts between BlackBerry Enterprise Server
domains, and between BES5 5.0.4.10 and BES12 domains. The BlackBerry Enterprise
Transporter for BES12 has separate documentation from the other BlackBerry Resource Kit
tools.
Visit help.blackberry.com/blackberry-resource-kit-for-bes12/current/manuals to see the documentation for the BlackBerry
Resource Kit.
Downloading the BlackBerry Resource Kit for
BES12
You can download the BlackBerry Resource Kit for BES12 from Software Download for BlackBerry Enterprise Server Resource
Kit. To download the installation file, select a version of the BlackBerry Resource Kit for BlackBerry Enterprise Service 12 from
the drop-down list and follow the prompts. The software must be compatible with your version of the BlackBerry Enterprise
Service 12.
5
What is the BlackBerry Resource Kit for BES12?
Related information
System requirements, on page 7
Install tools from the BlackBerry Resource Kit, on page 10
Compatibility with other releases, on page 7
6
System requirements
System requirements
3
Compatibility with other releases
This document assumes that you are using the tools in the BlackBerry Resource Kit to manage BES12 version 12.1. If you want
to use the tools with previous releases that are supported, visit www.blackberry.com/go/serverdocs to see the documentation
for the appropriate version of the BlackBerry Resource Kit.
Previous versions of the tools have been released for use with the BES5, the BlackBerry Device Service, the Universal Device
Service, and BES10. You cannot use the setup application for the BlackBerry Resource Kit for BES12 version 12.0 or later to
upgrade previous versions of the tools.
Related information
System requirements: BES12 Log Monitoring Tool, on page 7
System requirements: BlackBerry Push Initiator Tool, on page 8
System requirements: BES12 Log Monitoring
Tool
Item
Requirement
Operating system
Any operating system that BES12 version 12.1 supports. Visit docs.blackberry.com/
bes12 to see the BES12 Compatibility Matrix.
Supported environments
The following environment has been fully tested and is recommended for use with the
tool:
•
BES12 version 12.1
Access to the computer hosting
the BES12 log files
You must run the BES12 Log Monitoring Tool on the computer that hosts the BES12 log
files, or a computer with sufficient access to the files.
Log files
The BES12 Log Monitoring Tool can monitor only one log file at a time.
Multiple instances
You can install an instance of BES12 Log Monitoring Tool version 12.1 and BES12 Log
Monitoring Tool version 12.0 on the same computer. You cannot run multiple instances of
the tool at the same time.
7
System requirements
Item
Requirement
User Account Control restrictions
When you use the tool on an operating system that features User Account Control (UAC),
such as Windows Server 2008, you might receive an error message when you try to run
commands.
If you are using the tool on an operating system that uses UAC, run the tool as an
administrator (right-click the application on the start menu, or the .exe file, and click Run
as administrator). Type cd to reset the directory to "C:\", then type cd "<file_path>",
where <file_path> is the full path to the .exe file for the tool (for example, Program Files
(x86)\BlackBerry\BlackBerry Resource Kit for BlackBerry Enterprise Service
12\BlackBerry Enterprise Service 12 Log Monitoring Tool).
System requirements: BlackBerry Push Initiator
Tool
Item
Requirement
Operating system
Any operating system that BES12 version 12.1 supports. Visit docs.blackberry.com/
bes12 to see the BES12 Compatibility Matrix.
Supported environments
The following environment has been fully tested and is recommended for use with the
tool:
•
Unsupported environments
BES12 version 12.1
The following environments are not supported for use with the tool:
•
All versions earlier than BES12 version 12.1
Remote computer installation
Install the tool on a computer that does not host an instance of BES12 version 12.1.
Microsoft .NET Framework
Microsoft .NET Framework 3.5 (full package) must be installed on the computer that
hosts the tool.
Access to the server instances
The computer that hosts the tool must be able to access the computers that host
instances of BES12 version 12.1.
Administrator permissions
The administrator account that you configure the tool to use must exist on the same
server instance that you want the tool to connect to.
8
System requirements
Item
Requirement
The administrator account must have one of the following roles, or a role with equivalent
permissions:
•
Security Administrator
•
Enterprise Administrator
•
Senior Helpdesk
•
Junior Helpdesk
For more information about administrative roles and permissions, visit
docs.blackberry.com/bes12 to see the BES12 documentation.
Multiple instances
You can install an instance of BlackBerry Push Initiator Tool version 12.1 and BlackBerry
Push Initiator Tool version 12.0 on the same computer. You cannot run multiple instances
of the tool at the same time.
User Account Control restrictions
When you use the tool on an operating system that features User Account Control (UAC),
such as Windows Server 2008, you might receive an error message when you try to run
commands.
If you are using the tool on an operating system that uses UAC, run the tool as an
administrator (right-click the application on the start menu, or the .exe file, and click Run
as administrator). Type cd to reset the directory to "C:\", then type cd "<file_path>",
where <file_path> is the full path to the .exe file for the tool (for example, Program Files
(x86)\BlackBerry\BlackBerry Resource Kit for BlackBerry Enterprise Service
12\BlackBerry Push Initiator Tool).
BlackBerry MDS Connection
Service
BES12 version 12.1
9
Installing tools from the BlackBerry Resource Kit
Installing tools from the BlackBerry
Resource Kit
4
Install tools from the BlackBerry Resource Kit
Before you begin: Check the system requirements for the tools that you want to install.
1.
On the computer where you plan to install the tools, create a folder for the installation files.
2.
In a browser, visit Software Download for BlackBerry Enterprise Server Resource Kit.
3.
Select the installation file for the BlackBerry Resource Kit for BES12 and follow the prompts.
4.
Extract the contents of the installation file to the folder that you created.
5.
Double-click the brk<version>.msi file.
6.
Click Next.
7.
In the drop-down list, click your location. Read and accept the end-user license agreement. Click Next.
8.
In the drop-down list for each tool, perform one of the following actions:
9.
•
To install the tool, click Will be installed on local hard drive.
•
To prevent the setup application from installing the tool, click Entire feature will be unavailable.
Click Next.
10. Verify the file path where the tools will be installed. If you want to change the file path, click Change and select a new
location.
11. Click Next.
12. If you do not want the tools to use UAC-compliant file paths for configuration files, input files, output files, and log files,
clear the Use Windows UAC compliant paths check box.
13. Click Next.
14. Click Install.
15. When the installation process completes, click Finish.
After you finish:
Configure the BlackBerry Push Initiator Tool.
Related information
10
Installing tools from the BlackBerry Resource Kit
System requirements, on page 7
Postinstallation tasks, on page 12
Files for the BlackBerry Resource Kit tools
The default location of the files for the BlackBerry Resource Kit tools is <drive>:\Program Files (x86)\BlackBerry\BlackBerry
Resource Kit for BlackBerry Enterprise Service 12\. After you install the tools, you can access them from the Start menu.
Tool
Executable file
BES12 Log Monitoring Tool
LogMonitor.exe
BlackBerry Push Initiator Tool
PushInitiator.exe
Configuration file
—
PushInitiator.exe.config
Support for UTF-8 encoding
The tools in the BlackBerry Resource Kit support UTF-8 encoding for input files. The command-line tools support UTF-8
encoded characters that you type using keystroke commands or that you copy and paste from the character map.
Configure command-line tools to use UACcompliant file paths
If you install any tools that use a command-line interface, when you run the setup application, you specify whether you want the
tools to use UAC-compliant file paths for configuration files, input files, output files, and log files. The setup application creates a
subfolder for the files in the application data folder for the current user. For example:
•
Configuration files: <drive>:\Users\<user_name>\AppData\Local\VirtualStore\Program Files (x86)\BlackBerry
\BlackBerry Resource Kit for BlackBerry Enterprise Service 12
•
Log files, reports, input files, and output files: <drive>:\Users\<user_name>\AppData\Roaming\BlackBerry\BlackBerry
Resource Kit for BlackBerry Enterprise Service 12 or <drive>:\Documents and Settings\<user_name>\Application
Data\BlackBerry\BlackBerry Resource Kit for BlackBerry Enterprise Service 12
When you use any of the command-line tools, you can use the -uac or -no_uac subparameters to override the setting that you
configured when you installed the tool. For example, if you configured the BES12 Log Monitoring Tool to use a UAC-compliant
file path, you can use the -no_uac subparameter to write output files and log files to a file path that is relative to the current
working directory (for example, <drive>:\Program Files\BlackBerry\BlackBerry Resource Kit for BlackBerry Enterprise Service
12\BlackBerry Enterprise Service 12 Log Monitoring Tool).
11
Postinstallation tasks
Postinstallation tasks
5
BlackBerry Push Initiator Tool
Before you can push data to BlackBerry devices, you must configure a connection to the BES12 and the BlackBerry MDS
Connection Service. The BES12 provides access to the groups, email accounts, and BlackBerry device applications, (for
example, the BlackBerry Work Drives app), that you must specify when configuring the data that you need to push to
BlackBerry devices. The BlackBerry MDS Connection Service is responsible for providing enterprise push functionality to push
data to BlackBerry devices.
Configure the BlackBerry Push Initiator Tool for a BES12
connection
1.
On the computer that hosts the BlackBerry Push Initiator Tool, on the taskbar, click Start > All Programs > BlackBerry
Resource Kit for BlackBerry Enterprise Service 12 > BlackBerry Push Initiator Tool Client.
2.
On the Configuration tab, click BlackBerry Web Service Connection.
3.
In the Authentication Type drop-down list, select the authentication method for the administrator account that you want
to use to log in:
•
Active Directory
•
LDAP Directory
•
Native
•
Single Sign On
4.
Type the username and password of the administrator account.
5.
In the Domain field, type the name of the BES12 domain.
6.
In the Label field, type a label for a BES12 domain.
7.
In the Hostname field, type the FQDN.
8.
In the Port field, type the port number for the management console. The default value for the BlackBerry Web Service
Connection is 18084.
9.
Click Save.
12
Postinstallation tasks
Configure the BlackBerry Push Initiator Tool for a BlackBerry
MDS Connection Service connection
1.
On the computer that hosts the BlackBerry Push Initiator Tool, on the taskbar, click Start > All Programs > BlackBerry
Resource Kit for BlackBerry Enterprise Service 12 > BlackBerry Push Initiator Tool Client.
2.
On the Configuration tab, click MDS-CS Push Service Connection.
3.
In the Authentication Type drop-down list, select the authentication method for the administrator account that you want
to use.
•
No Authentication
•
Native
4.
If you selected Native authentication, in the Username and Password fields, type the username and password of the
administrator account.
5.
In the Domain field, type the name of the BES12 domain.
6.
In the Hostname field, type the FQDN of the push server that hosts the BlackBerry MDS Connection Service.
7.
In the Port field, type the port number for the management console. The default values for the BlackBerry MDS
Connection Service are the following:
Default Port Number
Type
10080
HTTP
10443
HTTPS
8.
Click Save.
13
Remove the BlackBerry Resource Kit tools
Remove the BlackBerry Resource Kit
tools
1.
On the computer that hosts the tools, on the taskbar, click Start > All Programs > BlackBerry Resource Kit for
BlackBerry Enterprise Service 12 > Uninstall or Modify Installation.
2.
Click Next.
3.
Click Remove.
4.
Click Remove again.
5.
Click Finish.
14
6
Glossary
Glossary
7
BES5
BlackBerry Enterprise Server 5
BES12
BlackBerry Enterprise Service 12
FQDN
fully qualified domain name
LDAP
Lightweight Directory Access Protocol
UAC
User Account Control
UTF-8
8-bit UCS/Unicode Transformation Format
15
Legal notice
Legal notice
8
©2015 BlackBerry. All rights reserved. BlackBerry® and related trademarks, names, and logos are the property of BlackBerry
Limited and are registered and/or used in the U.S. and countries around the world.
Android is a trademark of Google Inc. iOS is a trademark of Cisco Systems, Inc. and/or its affiliates in the U.S. and certain other
countries. iOS® is used under license by Apple Inc. Microsoft, Windows, Windows Phone, and Windows Server are trademarks
of Microsoft Corporation. All other trademarks are the property of their respective owners.
This documentation including all documentation incorporated by reference herein such as documentation provided or made
available on the BlackBerry website provided or made accessible "AS IS" and "AS AVAILABLE" and without condition,
endorsement, guarantee, representation, or warranty of any kind by BlackBerry Limited and its affiliated companies
("BlackBerry") and BlackBerry assumes no responsibility for any typographical, technical, or other inaccuracies, errors, or
omissions in this documentation. In order to protect BlackBerry proprietary and confidential information and/or trade secrets,
this documentation may describe some aspects of BlackBerry technology in generalized terms. BlackBerry reserves the right to
periodically change information that is contained in this documentation; however, BlackBerry makes no commitment to provide
any such changes, updates, enhancements, or other additions to this documentation to you in a timely manner or at all.
This documentation might contain references to third-party sources of information, hardware or software, products or services
including components and content such as content protected by copyright and/or third-party websites (collectively the "Third
Party Products and Services"). BlackBerry does not control, and is not responsible for, any Third Party Products and Services
including, without limitation the content, accuracy, copyright compliance, compatibility, performance, trustworthiness, legality,
decency, links, or any other aspect of Third Party Products and Services. The inclusion of a reference to Third Party Products
and Services in this documentation does not imply endorsement by BlackBerry of the Third Party Products and Services or the
third party in any way.
EXCEPT TO THE EXTENT SPECIFICALLY PROHIBITED BY APPLICABLE LAW IN YOUR JURISDICTION, ALL CONDITIONS,
ENDORSEMENTS, GUARANTEES, REPRESENTATIONS, OR WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
WITHOUT LIMITATION, ANY CONDITIONS, ENDORSEMENTS, GUARANTEES, REPRESENTATIONS OR WARRANTIES OF
DURABILITY, FITNESS FOR A PARTICULAR PURPOSE OR USE, MERCHANTABILITY, MERCHANTABLE QUALITY, NONINFRINGEMENT, SATISFACTORY QUALITY, OR TITLE, OR ARISING FROM A STATUTE OR CUSTOM OR A COURSE OF
DEALING OR USAGE OF TRADE, OR RELATED TO THE DOCUMENTATION OR ITS USE, OR PERFORMANCE OR NONPERFORMANCE OF ANY SOFTWARE, HARDWARE, SERVICE, OR ANY THIRD PARTY PRODUCTS AND SERVICES
REFERENCED HEREIN, ARE HEREBY EXCLUDED. YOU MAY ALSO HAVE OTHER RIGHTS THAT VARY BY STATE OR
PROVINCE. SOME JURISDICTIONS MAY NOT ALLOW THE EXCLUSION OR LIMITATION OF IMPLIED WARRANTIES AND
CONDITIONS. TO THE EXTENT PERMITTED BY LAW, ANY IMPLIED WARRANTIES OR CONDITIONS RELATING TO THE
DOCUMENTATION TO THE EXTENT THEY CANNOT BE EXCLUDED AS SET OUT ABOVE, BUT CAN BE LIMITED, ARE HEREBY
LIMITED TO NINETY (90) DAYS FROM THE DATE YOU FIRST ACQUIRED THE DOCUMENTATION OR THE ITEM THAT IS THE
SUBJECT OF THE CLAIM.
TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW IN YOUR JURISDICTION, IN NO EVENT SHALL BLACKBERRY
BE LIABLE FOR ANY TYPE OF DAMAGES RELATED TO THIS DOCUMENTATION OR ITS USE, OR PERFORMANCE OR NONPERFORMANCE OF ANY SOFTWARE, HARDWARE, SERVICE, OR ANY THIRD PARTY PRODUCTS AND SERVICES
REFERENCED HEREIN INCLUDING WITHOUT LIMITATION ANY OF THE FOLLOWING DAMAGES: DIRECT, CONSEQUENTIAL,
16
Legal notice
EXEMPLARY, INCIDENTAL, INDIRECT, SPECIAL, PUNITIVE, OR AGGRAVATED DAMAGES, DAMAGES FOR LOSS OF PROFITS
OR REVENUES, FAILURE TO REALIZE ANY EXPECTED SAVINGS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, LOSS OF BUSINESS OPPORTUNITY, OR CORRUPTION OR LOSS OF DATA, FAILURES TO TRANSMIT OR
RECEIVE ANY DATA, PROBLEMS ASSOCIATED WITH ANY APPLICATIONS USED IN CONJUNCTION WITH BLACKBERRY
PRODUCTS OR SERVICES, DOWNTIME COSTS, LOSS OF THE USE OF BLACKBERRY PRODUCTS OR SERVICES OR ANY
PORTION THEREOF OR OF ANY AIRTIME SERVICES, COST OF SUBSTITUTE GOODS, COSTS OF COVER, FACILITIES OR
SERVICES, COST OF CAPITAL, OR OTHER SIMILAR PECUNIARY LOSSES, WHETHER OR NOT SUCH DAMAGES WERE
FORESEEN OR UNFORESEEN, AND EVEN IF BLACKBERRY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW IN YOUR JURISDICTION, BLACKBERRY SHALL HAVE NO
OTHER OBLIGATION, DUTY, OR LIABILITY WHATSOEVER IN CONTRACT, TORT, OR OTHERWISE TO YOU INCLUDING ANY
LIABILITY FOR NEGLIGENCE OR STRICT LIABILITY.
THE LIMITATIONS, EXCLUSIONS, AND DISCLAIMERS HEREIN SHALL APPLY: (A) IRRESPECTIVE OF THE NATURE OF THE
CAUSE OF ACTION, DEMAND, OR ACTION BY YOU INCLUDING BUT NOT LIMITED TO BREACH OF CONTRACT,
NEGLIGENCE, TORT, STRICT LIABILITY OR ANY OTHER LEGAL THEORY AND SHALL SURVIVE A FUNDAMENTAL BREACH OR
BREACHES OR THE FAILURE OF THE ESSENTIAL PURPOSE OF THIS AGREEMENT OR OF ANY REMEDY CONTAINED
HEREIN; AND (B) TO BLACKBERRY AND ITS AFFILIATED COMPANIES, THEIR SUCCESSORS, ASSIGNS, AGENTS, SUPPLIERS
(INCLUDING AIRTIME SERVICE PROVIDERS), AUTHORIZED BLACKBERRY DISTRIBUTORS (ALSO INCLUDING AIRTIME
SERVICE PROVIDERS) AND THEIR RESPECTIVE DIRECTORS, EMPLOYEES, AND INDEPENDENT CONTRACTORS.
IN ADDITION TO THE LIMITATIONS AND EXCLUSIONS SET OUT ABOVE, IN NO EVENT SHALL ANY DIRECTOR, EMPLOYEE,
AGENT, DISTRIBUTOR, SUPPLIER, INDEPENDENT CONTRACTOR OF BLACKBERRY OR ANY AFFILIATES OF BLACKBERRY
HAVE ANY LIABILITY ARISING FROM OR RELATED TO THE DOCUMENTATION.
Prior to subscribing for, installing, or using any Third Party Products and Services, it is your responsibility to ensure that your
airtime service provider has agreed to support all of their features. Some airtime service providers might not offer Internet
browsing functionality with a subscription to the BlackBerry® Internet Service. Check with your service provider for availability,
roaming arrangements, service plans and features. Installation or use of Third Party Products and Services with BlackBerry's
products and services may require one or more patent, trademark, copyright, or other licenses in order to avoid infringement or
violation of third party rights. You are solely responsible for determining whether to use Third Party Products and Services and if
any third party licenses are required to do so. If required you are responsible for acquiring them. You should not install or use
Third Party Products and Services until all necessary licenses have been acquired. Any Third Party Products and Services that
are provided with BlackBerry's products and services are provided as a convenience to you and are provided "AS IS" with no
express or implied conditions, endorsements, guarantees, representations, or warranties of any kind by BlackBerry and
BlackBerry assumes no liability whatsoever, in relation thereto. Your use of Third Party Products and Services shall be governed
by and subject to you agreeing to the terms of separate licenses and other agreements applicable thereto with third parties,
except to the extent expressly covered by a license or other agreement with BlackBerry.
The terms of use of any BlackBerry product or service are set out in a separate license or other agreement with BlackBerry
applicable thereto. NOTHING IN THIS DOCUMENTATION IS INTENDED TO SUPERSEDE ANY EXPRESS WRITTEN
AGREEMENTS OR WARRANTIES PROVIDED BY BLACKBERRY FOR PORTIONS OF ANY BLACKBERRY PRODUCT OR SERVICE
OTHER THAN THIS DOCUMENTATION.
BlackBerry Limited
2200 University Avenue East
17
Legal notice
Waterloo, Ontario
Canada N2K 0A7
BlackBerry UK Limited
200 Bath Road
Slough, Berkshire SL1 3XE
United Kingdom
Published in Canada
18