Oracle® Beehive Installation Guide Release 1 (1.4) for Microsoft Windows (32-Bit) Part Number E13792-02 |
|
|
View PDF |
This module describes how to install and configure Oracle Beehive Integration for Outlook.
Installing Oracle Beehive Integration for Outlook Using Remote Downloader
Installing Oracle Beehive Integration for Outlook Interactively
Installing Oracle Beehive Integration for Outlook Using Remote Downloader Silently
Using Oracle Beehive Integration for Outlook as Migration Tool
Installing Oracle Beehive Integration for Outlook Using Active Directory
Updating Oracle Beehive Integration for Outlook in the DMS Repository
Updating the Language Pack for Oracle Beehive Integration for Outlook
Downgrading your Oracle Beehive Integration for Outlook Installation
Microsoft Windows XP Service Pack 2 or later is required on Windows XP computers where users intend to leverage non-English locales with Oracle Beehive Integration for Outlook. Attempting to run Oracle Beehive Integration for Outlook with a non-English locale on a computer with Windows XP Service Pack 1 (or earlier) may result in the computer failing to operate normally.
You can install Oracle Beehive Integration for Outlook by distributing a remote downloader to end users. The remote downloader allows end users to download and install the provisioned Oracle Beehive Integration for Outlook application from the Device Management Service (DMS) repository. By default, the DMS contains a pre-seeded Oracle Beehive Integration for Outlook application that is provisioned for all end users. For more information on how to provision applications for specific users or groups of users, see the "Managing the Device Management Service" module in Oracle Beehive Administrator's Guide.
Retrieve the remote downloader outlook_integration_downloader.exe
at <Oracle-Home>
/beehive/bootstrap/obio/downloader
, where <Oracle-Home>
is the name of your Oracle Beehive directory.
You may also retrieve the remote downloader from the download page of Oracle Beehive Central.
The remote downloader prompts the end user to provide a server name, account name, and password to initiate download and installation. If you wish to pre-seed a server name to prevent end users from having to specify a server name on their own, rename the remote downloader to <fully qualified server name>
.exe
. For example, if your server name is faulkner.oracle.com, your remote downloader name would be faulkner.oracle.com.exe
.
You can pre-seed the port number that Oracle Beehive Integration for Outlook should use when connecting to the server, as well as whether a secure connection should be used, by using commas to delimit the additional information.
For example, if your remote downloader name is faulkner.oracle.com.exe
and you wish to pre-seed the port number and secure connection in the downloader, you would rename the file to faulkner.oracle.com,5223,SSL.exe
, where 5223
is your port number and SSL
is the secure connection.
If you want to use a non-secure connection, replace SSL
with the string NOSSL
in the file name. For example, for a non-secure connection, rename the file to faulkner.oracle.com,5223,NOSSL.exe
.
Note:
You can only pre-seed port number and connection type when using the direct connection method for Oracle Beehive Integration for Outlook.You can give end users direct access to the Oracle Beehive Integration for Outlook installer. End users install the product by double-clicking the installer and following the on-screen instructions.
Retrieve the installer outlook_integration_setup.exe
at <Oracle-Home>
/beehive/bootstrap/obio/setup
, where <Oracle-Home>
is the name of your Oracle Beehive directory.
You can install Oracle Beehive Integration for Outlook silently without users having to provide input or perform an installation themselves.
To install Oracle Beehive Integration for Outlook silently:
Execute the following command:
outlook_integration_setup.exe /s UI=
<Installer-UI-Option>
<Installer-UI-Option>
can be one of the four values provided in the table below.
Table 30-1 Installer UI Options
Value | Function |
---|---|
|
No user interface during install |
|
Displays only a progress bar during install |
|
Presents an install screen with different dialog boxes but does not require user input to run |
|
Runs a fully interactive installer requiring user input |
To uninstall Oracle Beehive Integration for Outlook in silent mode, use the Msiexec.exe /x {A634A2AF-2495-4F36-B88F-0B24B84A183C} /qn
command.
The Oracle Beehive Integration for Outlook downloader can also be used to provide a full, non-interactive deployment option. To do so, use the silent switch, /s
.
Specify the required connection parameters through the command line or through an initialization file.
Command Line Example
outlook_integration_downloader.exe /server example.com /user OracleBeehiveUserName /pass Welcome1 /direct port=5224 secure=true /https port=443 secure=true /s
Initialization File Example
outlook_integration_downloader.exe /s c:\testSilentDownloader.ini
If you use the silent switch with a UI=1
parameter, the connection dialog will be presented in which all the controls are disabled and only the password field is enabled:
outlook_integration_downloader.exe /s UI=1 c:\testSilentDownloader.ini
The return result of the downloader is set accordingly to represent the failure/success (1/0) of the operations done by the downloader.
Use the following template to create a silent initialization file:
Template for Silent Initialization File
[OBIO] Server= User= Password= Direct_Port= Direct_Secure= HTTPS_PORT= HTTPS_Secure= Proxy_Type= Proxy=
Table 30-2 Silent Initialization File Parameters
Parameter Name | Description |
---|---|
|
Oracle Beehive server address |
|
Oracle Beehive user account |
|
User's password |
|
Valid port number to be used to establish a direct connection |
|
Boolean value; specifies whether to use a direct connection ( |
|
Valid port number to be used to establish an HTTPS connection |
|
Boolean value; specifies whether to use an HTTPS connection ( |
|
Specifies the proxy type. It may have a value of 0, 1, or 2:
|
|
Manual proxy configuration (for example, |
You can also use the Oracle Beehive Integration for Outlook downloader as a tool to migrate and integrate some configurations settings into an Oracle Beehive Integration for Outlook profile. This includes the following options:
Migrating existing personal folder data files (files with a .pst extension) from previous profiles
Migrating LDAP settings from previous profiles
Adding new LDAP settings
Adding a new personal folders data file
Use the /migrate
switch as follows:
outlook_integration_downloader.exe /migrate c:\migrateinifile.ini
If you do not provide an initialization file, you will be presented with an interactive user interface that enables you to choose the personal folders data files and the LDAP settings from previous profiles to migrate.
Use the following template to create a migration initialization file:
Template for Migration Initialization File
[migrate_psts] Src= Dest= CopyFile= [migrate_ldaps] Src= Dest= [add_pst] Path= Dest= [add_ldap] Name= Host= Port= Base= SSL= Dest=
Table 30-3 Migration Initialization File Parameters
Section Name | Parameter Name | Description |
---|---|---|
|
|
Migrates existing personal folder data files (files with a .pst extension) from the specified profile or profiles. It may have one of the following values:
|
|
An existing Oracle Beehive Integration for Outlook profile to which the migrated settings should be added. This may be the Oracle Beehive profile created with the downloader. |
|
|
One of the following values:
|
|
|
|
Migrates LDAP settings from the specified profile or profiles. It may have one of the following values:
|
|
An existing Oracle Beehive Integration for Outlook profile to which the migrated settings should be added. This may be the Oracle Beehive profile created with the downloader. |
|
|
|
Adds the settings from a specified PST file. It may have one of the following values:
|
|
An existing Oracle Beehive Integration for Outlook profile to which the settings should be added. This may be the Oracle Beehive profile created with the downloader. |
|
|
|
Display name of LDAP |
|
LDAP host name |
|
|
LDAP port number |
|
|
LDAP base distinguished name (DN) |
|
|
Boolean value; specifies whether SSL is enabled ( |
|
|
An existing Oracle Beehive Integration for Outlook profile to which the settings should be added. This may be the Oracle Beehive profile created with the downloader. |
End users can remove Oracle Beehive Integration for Outlook from their computers by clicking Add/Remove Programs, selecting Oracle Beehive Integration for Outlook from the list, and clicking Remove.
If your end users are running systems on Windows 2000, Windows XP, or Windows Vista that are locked down, they can install Oracle Beehive Integration for Outlook using Active Directory Group Policy. To perform an Active Directory installation, the domain administrator must create a package for Oracle Beehive Integration for Outlook in the Active Directory Administrative Tool and then assign the package to the organization units that contain the intended end users. The software will then be installed on end users' computers during startup.
Active Directory only recognizes software packaged in the msi file format, which contains information about the application setup and installation.
To create an msi installation package for Oracle Beehive Integration for Outlook:
Extract the outlook_integration_application.msi file from the Oracle Beehive Integration for Outlook package using the outlook_integration_setup.exe /export type=client
<Extracted folder path>
command.
Extract the prerequisite.msi file from the Oracle Beehive Integration for Outlook package using the outlook_integration_setup.exe /export type=system
<Extracted folder path>
command.
Before proceeding, make sure you have extracted the msi files for Oracle Beehive Integration for Outlook to an accessible location.
To deploy Oracle Beehive Integration for Outlook using Active Directory Group Policy:
From the Start menu, select Control Panel, then Administrative Tools.
Click Active Directory Users and Computers.
Create an organization unit that includes all the computers on which you want to install Oracle Beehive Integration for Outlook. Alternatively, select an existing organization unit.
Right-click your chosen organization unit in the Active Directory Users and Computers tree.
From the Shortcut menu, click Properties.
In the Properties dialog box, click the Group Policy tab.
Click Edit if you are modifying an existing group policy, or Add if you are creating a group policy.
Note:
The following steps will ensure that Oracle Beehive Integration for Outlook is installed on all computers in your chosen organization unit. It also ensures that all users of a given computer have access to Oracle Beehive Integration for Outlook.Select and expand the Computer Configuration node.
Under the Computer Configuration node, expand the Software Settings folder.
Right-click Software Installation and select New.
From the Shortcut menu, click Package.
Enter the path to your extracted prerequisite.msi file.
Selected Assigned and click OK.
Repeat steps 10-13 for your extracted outlook_integration_application.msi file.
Note:
For more information on how to obtain msi files for Oracle Beehive Integration for Outlook, see Creating an msi installation package for Oracle Beehive Integration for Outlook.In the Properties dialog box, click OK.
Exit the Active Directory Users and Computers console.
To verify that Oracle Beehive Integration for Outlook is available to end users for installation, restart any computer in the domain and make sure that Oracle Beehive Integration for Outlook installation starts when the computer restarts.
You can update the existing version of the Oracle Beehive Integration for Outlook package in the DMS repository using the beectl
command-line tool located at <Oracle-Home>
/beehive/bin
. If Oracle Beehive Integration for Outlook is running on an end user's computer, it will automatically prompt the end user to download and install updates from the DMS repository. End users can also manually search for updates by selecting About Oracle Beehive Integration for Outlook from the Help menu and clicking Check for Updates.
To update Oracle Beehive Integration for Outlook in the DMS repository:
Make sure the application package for the updated version of Oracle Beehive Integration for Outlook is accessible to the Oracle Beehive server.
Upload the updated version of Oracle Beehive Integration for Outlook to the DMS by executing the following command:
beectl upload_client_application
--file <Path to Oracle Beehive Integration for Outlook zip file>
Note:
This command will upload the new version of the Oracle Beehive Integration for Outlook application to the DMS repository and will make it available for those who are already provisioned to it.If you have not provisioned Oracle Beehive Integration for Outlook, run the provisioning commands (such as beectl add_client_application_provisioning
). Refer to "Managing the Device Management Service" in Oracle Beehive Administrator's Guide for more information.
You can localize the user interface of Oracle Beehive Integration for Outlook to match Outlook languages by updating the language pack with the one found at the following location:
<Oracle-Home>
/beehive/bootstrap/obio/languagepack
The following languages are currently supported in the language pack:
French
German
Italian
Spanish
Brazilian Portuguese
Japanese
Korean
Simplified Chinese
Traditional Chinese
To update the language pack for Oracle Beehive Integration for Outlook, you must upload it to the DMS repository using the beectl
command-line tool located at <Oracle-Home>
/beehive/bin
.
By default, the language pack is uploaded and provisioned to all users.
To update the language pack for Oracle Beehive Integration for Outlook:
Make sure the language pack for Oracle Beehive Integration for Outlook is accessible to the Oracle Beehive server.
Upload the language pack for Oracle Beehive Integration for Outlook to the DMS by executing the following command:
beectl upload_client_application
--file <Path to Oracle Beehive Integration for Outlook language pack>
If Oracle Beehive Integration for Outlook is running on an end user's computer, it will automatically prompt the end user to download and install updates (including language packs) from the DMS repository. End users can also manually search for updates by selecting About Oracle Beehive Integration for Outlook from the Help menu and clicking Check for Updates.
Note:
The language installed by the Oracle Beehive Integration for Outlook language pack will automatically match the Outlook language installed by the end user, provided that Oracle Beehive Integration for Outlook supports the language. If the end user has installed Outlook in an unsupported language, Oracle Beehive Integration for Outlook will default to English.When deploying Oracle Beehive Integration for Outlook from the DMS, you can apply customized configuration settings to end users' computers.
To apply configuration settings from the DMS:
Create an XML provisioning file that includes all the setting parameters you want to apply. For more information, see Customizing General Installation Settings.
Obtain your Oracle Beehive Integration for Outlook identifier by executing the beectl list_client_applications
command and locating the identifier from the generated list.
Obtain your Oracle Beehive Integration for Outlook version identifier by executing the following command:
beectl list_client_application_versions --application
<Identifier>
<Identifier>
is the Oracle Beehive Integration for Outlook identifier you obtained in the previous step.
Include the obtained Oracle Beehive Integration for Outlook version identifier in your XML provisioning file. For more information on beectl
commands, see the module "Oracle Beehive Command-Line Utility" in the Oracle Beehive Administrator's Reference Guide.
Upload your XML provisioning file to the server by executing the following command:
beectl add_client_application_configuration --file
<Path-to-XML-Provisioning-File>
Provision end users for the uploaded application configuration object by executing the following command:
beectl add_client_application_provisioning
--community
<Your-Enterprise-ID>
--configuration
<Your-Application-Configuration-ID>
You can control general settings by creating an XML provisioning file and adding or modifying Property
nodes in the config
section of the file. Each Property
node should contain two parameters: name
and value
.
You can modify the default public properties in your provisioning file by changing the value
parameter associated with any of the INSTALL:
<X>
Property
nodes.
Table 30-4 Public Properties
Property | Function | Example |
---|---|---|
|
Sets the name of the registered Oracle Beehive Integration for Outlook end user that appears in the About box. |
|
|
Sets the name of the registered company that appears in the About box. |
|
|
Sets the location of the Oracle Beehive Integration for Outlook installation. |
|
|
Determines if an Oracle Beehive Integration for Outlook profile should be created on the user's computer during installation. This parameter can be assigned one of the following values:
|
Not applicable |
|
Changes the name of the profile created during installation of Oracle Beehive Integration for Outlook. The default profile name is |
The values you set for the first three parameters in the table only apply when you are installing Oracle Beehive Integration for Outlook for the first time and do not apply to product upgrades.
By default, Oracle Beehive Integration for Outlook will only detect updates if the server version is newer than the currently installed version. If you wish to allow end users to install downgraded versions of Oracle Beehive Integration for Outlook as updates, set the value of the INSTALL:AllowDowngrade
Property node to TRUE
in your provisioning file.
You can modify the registry information on end-user computers by changing the values for certain Property
nodes in your provisioning file. Modifying registry information enables you to control end user settings from the server side.
WARNING:
If you modify the registry incorrectly, serious problems may occur that could require you to reinstall your operating system. Modify the registry at your own risk.
Add a key or registry value using the following coding structure:
<Property name="REG:ADD:
{HIVE}
\
{keypath}
:
{Value Name
}:
{DataType}
" value="
{Value Data}
"></Property>
The value for {HIVE}
can be either HKLM
or HKCU
, which are the two locations where user registry information can be stored and which correspond to the HKEY_LOCAL_MACHINE
and HKEY_CURRENT_USER
hives.
The value for {DataType}
can be String
, Binary
, or Dword
.
If you are adding a key, you do not need to provide values for {Value Name}
, {DataType}
, or {Value Data}
.
Delete a key or registry value using the following coding structure:
<Property name="REG:Delete:
{HIVE}
\
{keypath}
:
{Value Name}
" value=""></Property>
If you are deleting a key, do not provide a value for {Value Name}
. Additionally, the key must reside at least two levels under the user hive.
You can modify Oracle Beehive Integration for Outlook ini settings by including a property with the following coding structure:
<Property name="FILE:Beehive.ini:
{Section Name}
:
{Property Name}
" value="
{Value Data}
"></Property>
You can force end users to upgrade to a new version of Oracle Beehive Integration for Outlook that you have uploaded to the DMS. End users will not be able to use Oracle Beehive Integration for Outlook until they upgrade.
To force end users to upgrade to a new version of Oracle Beehive Integration for Outlook:
In your XML provisioning file, add a property with the following coding structure:
<Property name="INSTALL:ForceClientVersion:{Comparison Operation}" value="
{Build-Number}
"></Property>
{Build-Number}
is the Oracle Beehive Integration for Outlook build number which will be used for the comparison operation.
Optionally, you can allow end users to continue using their old version of Oracle Beehive Integration for Outlook for a specific period of time or for a fixed number of log-ins to Oracle Beehive.
To allow end users to use an older version of Oracle Beehive Integration for Outlook until a certain date:
In your XML provisioning file, add a property with the following coding structure:
<Property name="INSTALL:graceperioddate" value="
{YYYYMMDD}
"></Property>
{YYYYMMDD}
is the final date on which the user can use Oracle Beehive Integration for Outlook without having to upgrade.
To allow end users to use an older version of Oracle Beehive Integration for Outlook for a fixed number of log-ins:
In your XML provisioning file, add a property with the following coding structure:
<Property name="INSTALL:graceperioditerations" value="
{Number-of-Log-ins}
"></Property>
{Number-of-Log-ins}
is the number of times end users are allowed to log in to Oracle Beehive Integration for Outlook before they are forced to upgrade.
Note:
For formatting purposes, line breaks have been inserted in some attribute values.<?xml version="1.0" encoding="UTF-8"?> <ClientAppConfig> <Name>Oracle Beehive Integration for Outlook-test2</Name> <Version CollabId="6EAB:574C:capv:4672A63200D4B462E040548C17821C2E000000014C0A"/> <Config> <!--Install Company name--> <Property name="INSTALL:COMPANYNAME" value="TestCompany"></Property> <!--Install user name --> <Property name="INSTALL:USERNAME" value="Edith Wharton"></Property> <!--Install directory--> <Property name="INSTALL:INSTALLDIR" value="C:\Program Files\Oracle\myinstall"></Property> <!--Allow Downgrade--> <Property name="INSTALL:AllowDowngrade" value="TRUE"></Property> <!--Install Create Profile--> <Property name="INSTALL:CREATE_PROFILE" value="2"></Property> <!--Install Profile Name--> <Property name="INSTALL:PROFILE_NAME" value="OracleBeehive"></Property> <!--Install ForceUpgrade--> <Property name="INSTALL:ForceClientVersion:Larger" value="20201"></Property> <!--Install Grace Period for ForceUpgrade--> <Property name="INSTALL:graceperioddate" value="20080215"></Property> <Property name="INSTALL:graceperioditerations" value="3"></Property> <!--ini File Modification--> <Property name="FILE:Beehive.ini:OBIO:APP-AUTOUPDATE-STARTUP" value="FALSE"></Property> <!--Registry Modification--> <!--ADD Section--> <!--ADD Key--> <Property name="REG:ADD:HKCU\Software\1\2\3:" value=""></Property> <!--ADD String Value (remove line breaks from the value of the name parameter) --> <Property name= "REG:ADD:HKLM\Software\Microsoft\Exchange\Client\Extensions: Outlook Setup Extension1:String" value="4.0;Outxxx.dll;7;00000000000000;0000000;OutXXX"></Property> <!--ADD DWORD Value (remove line breaks from the value of the name parameter) --> <Property name="REG:ADD:HKLM\Software\Microsoft\Exchange\Client\Extensions: Outlook Setup Extension2:DWORD" value="50"></Property> <!--ADD Binary Value (remove line breaks from the value of the name parameter) --> <Property name="REG:ADD:HKLM\Software\Microsoft\Exchange\Client\Extensions: Outlook Setup Extension3:Binary" value="1234567890ABCDEF"></Property> <!--Delete Section--> <!--Delete Key--> <Property name="REG:DELETE:HKCU\Software\1\2" value=""></Property> <!--Delete Value (remove line breaks from the value of the name parameter)--> <Property name= "REG:DELETE:HKLM\Software\Microsoft\Exchange\Client\Extensions: Outlook Setup Extension1" value=""></Property> </Config> </ClientAppConfig>