Installing the Hyland Office 2019 Integration - Office Business Application for 2019 - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

Office Business Application for 2019

Platform
OnBase
Product
Office Business Application for 2019
Release
Foundation 23.1
License
Standard
Essential
Premier

To run the Hyland Office 2019 Integration installer:

  1. Execute setup.exe with administrator privileges. This can be done by right-clicking on the file name and selecting Run as administrator. The welcome page is displayed.

    This executable is usually located in the folder of your source installation files that corresponds to the version of the integration you are installing.

    Note:

    If the installer is copied from the source location to be run from a different location, the entire folder and its contents must be copied to the new location.

    The following are the default folder locations for the 32-bit and 64-bit executable files, where XX is the year of the integration:

    • Integration for Microsoft Office 20XX (32-bit): \Office Integration\Office 20XX

    • Integration for Microsoft Office 20XX (64-bit): \x64\Office Integration\Office 20XX

    Note:

    You must use the installer that matches your version of Microsoft Office. For example, if you have a 64-bit version of Microsoft Office, then the 64-bit Hyland Office Products Installer must be used.

  2. Click Next.
    The Custom Setup page is displayed.
    Note:

    The screen shots used in the following sections are for illustrative purposes. The versions of the add-ins and the components available to install will match the version of the installer you launched.

  3. Click the drop-down list beside the name of a component to display the installation options:

    Option

    Description

    Will be installed on local hard drive

    Installs the selected feature and does not install any dependent, optional functionality. To view optional functionality, click the + icon next to the feature to expand the sub-feature list.

    Entire feature will be installed on local hard drive

    Installs the selected feature and any dependent functionality. To view the dependent functionality, click the + icon next to the feature to expand the sub-feature list.

    Entire feature will be unavailable

    Removes a feature from the list of features to install.

  4. Select Will be installed on local hard drive for each component you want to install.
    To install all components, select Entire feature will be installed on local hard drive from the drop-down list beside Office 20XX Add-In.
  5. To determine the amount of space available for installation of the selected components, click Disk Usage.
    The Disk Space Requirements dialog box is displayed, with information on the space required for the selected components and the space available on the drives accessible by the installation workstation.
  6. To change the installation location of the installed components, select Office 20XX Add-In and click Browse.

    The Change destination folder page is displayed.

    Enter the name of the destination folder in the Folder name field or select it from the Look in drop-down list.

    If the destination folder is not changed, components are installed to the following default locations:

    • Office 20XX (32-bit): C:\Program Files\Hyland\Office Integration\Office 20XX\

    • Office 20XX (64-bit): C:\Program Files (x86)\Hyland\Office Integration\Office 20XX\

    Note:

    In these example default locations, XX designates the year of the integration you have installed.

  7. Click OK.
    The Custom Setup page is displayed.
  8. Click Next.
    The IdP Server URL page is displayed.
  9. Select Enable IdP Support if your system uses the Hyland Identity Provider (IdP) server for authentication, and then enter the URL to the endpoint of the Hyland IdP server in the IdP URL field. This value is case sensitive.

    For example, if the Hyland IdP server is at my.domain/identityprovider and the environment is configured for secure connections, then the value is https://my.domain/identityprovider.

    Note:

    Enabling IdP support in the installer does not work if your environment is not already configured for IdP. Additional configuration is required to enable IdP support. For more information, see the Identity and Access Management Services documentation.

  10. Click Next.
    The Service Location page is displayed.
  11. In the Display Name field, enter the name of the service location. This should be a user-friendly name for the service location.
  12. In the Service Path field, enter the full URL to the OnBase Application Server service page or Web Server address.

    An Application Server URL should use the following format: http://machinename/AppServer/Service.asmx

    A Web Server URL should use the following format: http://machinename/AppNet/Service.asmx

    Note:

    Only Application Server and Web Server URLs ending in .asmx and using SOAP can be used with the Office integrations. For example, a remote service path ending in .rem is not valid.

  13. In the Data Source field, enter the data source name for the appropriate data source.
  14. From the Use NT / LDAP Authentication drop-down list, select one of the following options:
    • Select Yes if your system uses NT or LDAP Authentication to use NT/LDAP with the components installed

      Note:

      To use NT or LDAP authentication, the Data Source entered must also be configured for NT or LDAP authentication.

    • Select No if your system does not use NT or LDAP Authentication

  15. Click Next.
    If you are installing the Outlook or WorkView integrations, the Outlook Integration Toolbar Configuration page is displayed.
  16. Select Yes to enable an option of the integration or No to disable the option.
    Note:

    Enabling options does not guarantee they are available in Outlook. Options may also require specific User Group privileges, additional licensing, or both.

    The following are the available button configurations:

    Option

    Description

    Enable Import Button

    If selected, the Import button is available on the integration with OnBase ribbon. This function allows users to import messages directly to OnBase from Outlook.

    Enable Launch Client Button

    If selected, the Launch Client button is available on the integration with OnBase ribbon. This function allows users to launch the OnBase Client directly from Outlook.

    Enable Retrieval Button

    If selected, the Retrieval button is available on the integration with OnBase ribbon. This function allows users to retrieve documents archived in OnBase directly from Outlook.

    Enable Workflow Button

    If selected, the Workflow button is available on the integration with OnBase ribbon. This function allows users to launch a Workflow client directly from Outlook.

    Enable Help Button

    If selected, the Help button is available on the integration with OnBase ribbon. This function allows users access to the relevant OnBase help files.

    Enable Create Forms Button

    If selected, the Forms button is available on the integration with OnBase ribbon. This function allows users to create E-Forms or Unity Forms from Outlook.

    Enable Import From File Button

    If selected, the Import from File button is available on the integration with OnBase ribbon. This function allows users to import selected documents to OnBase.

    Enable Imaging Group

    If selected, the Imaging options are available on the integration with OnBase ribbon. These options include the Send to Scan Queue and Batch Processing buttons. These functions allow users to route messages and attachments into a scan queue or batch scan process.

    Note:

    The Send to Scan Queue option does not populate mail System Keywords (such as MAIL To). If you need to populate mail System Keywords, open the document in Workflow and use the Set Property from Email Metadata action. For more information, see the Workflow module reference guide.

    Enable My Reading Groups Button

    If selected, the My Reading Groups button is available on the integration with OnBase ribbon. This function allows users to open the My Reading Groups interface.

  17. Click Next to continue configuring Outlook or WorkView integration options.
  18. Select Yes to enable an option of the integration or No to disable the option. The following configuration options are available:

    Admin Configuration Option

    Description

    Allow User Toolbar Configuration

    If selected, users can change the default configuration of their integration with OnBase ribbon.

    Update the Client's Default Settings

    If selected, the default settings of this deployment instance override the settings of clients installed using an earlier version of this deployment instance.

    Note:

    This option is not available if Allow User Toolbar Configuration is not selected.

    Allow User Folder Configuration

    If selected, users can change the configuration of their Outlook folders.

    Workflow Configuration Option

    Description

    Update Notification when Task is Executed

    Select to update Workflow email notifications after a task is executed. When selected, email notifications include specific information on the ad hoc task that was executed.

  19. Click Next.
    Depending on the options you selected on the Outlook Integration Toolbar Configuration page, the Import Button Configuration page may be displayed.
  20. Select Yes to enable an option of the integration or No to disable the option. The following options are available:

    Button Configuration Option

    Description

    Keep Messages in Same Folder

    If Yes is selected, email messages that are imported into OnBase are kept in the same Outlook mail folder after being imported. This option is selected by default when the Enable Import Button option is selected.

    Note:

    This option does not apply to email messages imported into OnBase using an Auto Import Folder.

    Remove Messages

    If Yes is selected, email messages that are imported into OnBase are deleted from the email server after being imported.

    Note:

    This option does not apply to email messages imported into OnBase using an Auto Import Folder.

    Move Messages To

    If Yes is selected, email messages are moved to a different Outlook folder after being imported into OnBase.

    In the field provided, enter the folder to move the imported email messages to.

    Note:

    This option does not apply to email messages imported into OnBase using an Auto Import Folder.

    Automatically select attachments for import

    If Yes is selected, all email attachments are automatically selected when importing email messages into OnBase.

    Note:

    Users can still modify which email attachments are actually included when importing email messages into OnBase. See the sections on importing attachments in the Integration for Microsoft Outlook documentation.

    Set Document Date as Sent Date

    If Yes is selected, the date that an email was sent is used as the Document Date for the message when it is imported into OnBase. If this option is not selected, the date the email message was imported into OnBase is used as the Document Date.

    Note:

    If this option is selected and an email does not have a Received Time value, the current date is used.

    Storage Option

    Description

    Store messages in MSG Format

    If Yes is selected, messages are archived in OnBase in their native Outlook format (*.msg). When messages stored in this format are retrieved, they are displayed in the Outlook message viewer instead of the OnBase document viewer. This allows you to access all of the same Outlook functionality that is available when you open a message in Outlook. For example, forwarding a message, replying to a message, etc.

    If No is selected, messages are archived in the format in which the message was created (for example, plain or rich text, or HTML). When messages are retrieved, they are displayed in the OnBase document viewer. Attachments and messages are stored as separate documents and are retrieved in their respective file formats.

    Store attachments separately

    Note:

    This option is only available if Store messages in MSG Format is selected.

    If Yes is selected, email attachments are stored as separate documents from the messages they are attached to. Attachments are stored and retrieved in their respective file formats and the Attachment button is available in the Import Document dialog box, if the message has attachments.

    If Yes is selected for the Store messages in MSG Format option and No is selected for the Store attachments separately option, all attachments are stored in the same *.msg file as the message they are attached to and the Attachment button is not available in the Import Document dialog box.

    Tip:

    For a complete description of the Outlook Integration import functionality, see the Usage chapter in the Integration for Microsoft Outlook documentation.

  21. Click Next.
    Depending on the options you selected on the Outlook Integration Toolbar Configuration page, the Client Executable Button Configuration page may be displayed.
  22. Enter the path to the OnBase Client executable in the Executable Path field, or click the Browse button next to the field to browse to the location of your OnBase Client executable.
  23. Enter any OnBase command line switches to append to the OnBase Client when it is launched from Outlook in the Executable Command Line Switches field.
    Tip:

    For more information on command line switches, see the Command Line Switches documentation.

  24. Click Next.
    The Folder Configuration (Optional) page is displayed.
  25. Edit the Folder Configuration File field based on whether you created a folder configuration file.
    • If you created a folder configuration file using the Folder Configuration Utility, enter the full path to it in the Folder Configuration File field, or click Change to navigate to the file and select it.
    • If you did not create a folder configuration file, leave the Folder Configuration File field empty.
    Note:

    See the Outlook Folder Configuration Utility chapter of the Integration for Microsoft Outlook documentation for details on using the Folder Configuration Utility.

  26. Click Next.
    The Ready to install page is displayed.
  27. Click Install.
The Hyland Office 2019 Integration is installed.