Difference between revisions of "Retain Blackberry"

Revision as of 17:03, 8 October 2014

The BlackBerry module allows the collection of BlackBerry phone data from the Enterprise server into the Retain system. BES 5.x and 10.x are supported.

To archive the BlackBerry information, the BlackBerry Enterprise Server must be configured to log phone calls, PIN, BBM and SMS data. The server log files are what Retain uses to collect the information about phone activity, and as such no software or modification needs to be made to any system phones. If the BlackBerry server has not been configured to log the data, Retain will be unable to archive the information.

For BES 5.x, instructions to modify the logging in the BlackBerry Enterprise Server can be found in the BlackBerry Enterprise Server help file. (Found under Start | Programs | BlackBerry Enterprise Server | Help | BlackBerry Manager Help)

For BES 10.x, users must be set on EMM – Regulated mode and have the logging set to ‘yes’ for all types desired. Balanced mode users will not have logs created for them in the BES system and as a result will not be archived.

Installing the BlackBerry Module is incredibly simple. Essentially, the module needs to be enabled and configured with the BES log file location. Afterwards, the data is treated the same as any other data entering the Retain archive. Data is archived in the database under the user/phone it originated from and can be searched and viewed through the Search Messages interface.

BlackBerry Module Configuration

- Open an Internet Browser and go to your Retain Web Management page (http://ip_address/RetainServer)

- Log in as Administrator or as a user with Administration rights

- Under the Configuration section on the left side navigation pane click Module configuration

- Select BlackBerry under Unconfigured Modules

- There are two tabs within the BlackBerry Module configuration.

   Core Settings - To enable the BlackBerry Module, select the ‘BlackBerry Module’ from the module page and click ‘configure’. The BlackBerry module needs to be enabled on this page 
   to make it active in the Retain system. Before data can be archived, the BES log file path must be provided.
 
   The log file location must be the address to the log files from the Blackberry Server. Regardless of where the worker is installed, local or remote to the Blackberry Server, it must have
   direct file access to the logs. This access can be accomplished through a shared folder or location, but it must be available to the Retain worker. Appropriate access through firewalls or
   network security must be made available if the worker is not installed on the BES system.

   SMTP Connector - In order to allow the forwarding of BES items out of the Retain system, the Blackberry Module needs to be configured with an SMTP connector. This connector will 
   provide an outlet into the mail system, for Blackberry data to be forwarded if desired. 
   
   The amount of configuration necessary for the SMTP Connector depends on the specific setup of the SMTP system. If a username and password are required for the host SMTP system,
   then it must be provided. If it is not required, the configuration of the username and password is optional. 
   
   The address of the Mail Server, the SMTP Mail From Address, and the SMTP Mail To Address, must all be configured for the system to function correctly. The ‘to’ address
   is the destination address where the data will be forwarded to. The ‘from’ is the specified ‘from’ address. 
   
   In addition, the ‘Enable SMTP Connector’ option must be enabled in the‘jobs’ configuration for the Blackberry section.

Schedule

Schedules define WHEN to perform the data collection as defined in a JOB. A Job defines what SCHEDULE, PROFILE and WORKER to use.

 -You can create as many schedules as you need. 
 -Schedules have no functionality until they are associated with one or more JOBs. 
 -They can be shared across multiple JOBs. 
 -You cannot DELETE a schedule that is currently associated with a JOB.
 -Schedules can be recurring or one-time.

SINGLE schedules are configured with one start time, and one date.To keep jobs from queuing up to the worker, select the box to do not resend a job that has an elapsed start time. Otherwise, a job will queue up on the worker if a previous job has not yet completed, causing the new job to start as soon as the current job is complete or terminated.

RECURRING schedules are configured using a start and interrupt time, and which days to start on. Choose when on which days you want this schedule to trigger a job. You may specify maximum job duration. If the job runs longer than the time limit you set, it will be interrupted. For cases where you do not want the job to be interrupted – for example, with a job you know will last longer than 22 hours, you may prevent the schedule from interrupting the job. Don’t forget to “Save Changes”.

Profile

A profile assigned to a job tells the system what to archive. Message types, status, date ranges, excluding or including specific users, private or public folders or both, and redundancy check settings are all configured under the profile. The profile defaults to collecting all data, with no date restrictions. After Retain has finished collecting data the first time, you'll want to narrow the date range and criteria considerably, or pay a high price in performance.

To create a new profile to archive BlackBerry data, first select the ‘add profile’ button and name the profile. Then continue configuring as desired.

Core Settings:

The Core Settings tab holds the enabling setting, which allows jobs connected to this profile to run. This must be checked before jobs will run.

Message Settings:

The Message Settings tab can be used to exclude or include specific data types for this profile. By default all types of messages will be archived. All BlackBerry data which is selected to be archived MUST be logged in the BlackBerry Enterprise Server or the data will not be available for Retain to archive it.

Scope:

The Scope tab dictates how pervasive the attached archiving jobs are, and what kind of duplicate checking is done, or not done, in the Retain system. The Date Range instructs Retain to scan for, and archive, messages after, or before, a certain date. This is useful if only specific chunks or areas of mail are to be archived. The duplicate check either scans for all messages, or instructs Retain to only look for messages which are newer than the Item Store Flag, which is a time-stamp on the system. All messages newer than the time stamp will be archived by Retain if the item store flag is utilized, but Retain will ignore all messages which are older. It is recommended to have at least the first job archive everything, with the item store flag checked to archive everything possible in the logs, while setting the item store flag. Subsequent jobs should use the duplicate check and the item store flag to only archive new data afterwards.

Advanced:

If you want to be more specific as to what to dredge or not to dredge, add the criteria here. Each line will be logically AND-ed together. Think “Dredge all items where the following is true:” Criteria A and Criteria B and Criteria C etc.

You may select based on:

 -Subject
 -Sender
 -Recipient
 -Size
 -Attachment Name

Whether they are equal to, not equal to, whether they contain or do not contain the item you specify. This gives you great flexibility and granularity. It allows you to customize dredges and retention for many different groups, or even individuals.

Worker

The worker is the part of Retain that actually pulls the data from the message system servers. The Worker contacts the Retain Server and gathers information on which jobs are associated with it, when to start them, and which items to get. Workers can only run one job at a time. Workers are not module specific, but may require module specific settings. These settings, where applicable, are found under the module specific tab.

Worker Configuration From the Retain home page, click Workers.

1) Click “Add Worker”.

2) Put the name of the worker in the “Worker” box. Example: “BES Worker 1”.

3) Check the Connections Tab to be sure the Retain Server IP address settings are correct. This tells the Worker where the Retain Server is located. Server Host Name or IP address must be correct this should be populated automatically, but double check for accuracy. The Server Connection setting must be able to resolve to the Retain Server if placed in a browser address bar. The Connection tab holds very important contact information for the worker’s connection to the RetainServer. Make sure that the Retain Server connection address is correct, or the Retain Worker will not be able to talk to the server.

4) The Module Specific tab contains information specific to individually configured modules. The settings specified here are tied only to the specific worker configured, and does not affect the rest of the system. In general this setting may be ignored unless required. If required, input the appropriate information.

5) After you have checked and set your settings, click “Save Changes” before browsing to another page to finish creating and to save your worker.

After the worker has been saved, two additional tabs become visible for settings on the worker. You MUST save changes on a newly created worker before the ‘Bootstrap’ tab is available to be used. The status tab for the new worker will not hold any pertinent information until a job has been run or the worker has registered to the server and is in communication. Once a job has been completed, information will be displayed on the general status of the selected Worker.

6) After you have saved the changes, the Bootstrap tab appears (see below). Click “Download File” to save the configuration to a local workstation.

7) Save this file to your hard drive in a place where you can find it. Click “Save”.

8) Open a new browser window and type: http://< your-RetainWorker-ip >/RetainWorker

When a worker has not been initialized a screen will appear asking you to upload a bootstrap file.

9) Upload the bootstrap file.
 -Click “Browse” to find the file you just downloaded to select it
 -Click “Open”.
 -Click “Upload File”.
 -If the upload went well, you will see a message that says "Configuration Complete. From now on, you'll have to log in as a user (such as the initially created admin user) with the Manage Workers right:

After you click the “Continue” button, you will be returned to the login page.

10) Login as Admin.
11) Verify the Retain Server connection success by selecting the Server Connection tab.

BlackBerry Job

Back to Module Configuration