Application Server Installation - Integration for D+H Phoenix - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - Premier - external - Standard - Essential - Premier - Standard - Essential - OnBase/Integration-for-D-H-Phoenix/Foundation-24.1/Integration-for-D-H-Phoenix/Installation/Installation/Application-Server-Installation - 2024-03-25

Integration for D+H Phoenix

Platform
OnBase
Product
Integration for D+H Phoenix
Release
Foundation 24.1
License
Premier
Standard
Essential

To install the Integration for D+H Phoenix on the OnBase Application Server:

  1. Obtain the Hyland.Integrations.HarlandPhoenix.dll from your solution provider.
  2. Copy Hyland.Integrations.HarlandPhoenix.dll into the bin folder of your Application Server.
    Note:

    If you are only installing the Member ID component, the process is complete at this point.

  3. Open the Application Server's web.config file.
  4. Locate the <configSections> tag, and add the following after this tag:
    <section name="Hyland.Integrations.HarlandPhoenix" type="Hyland.Integrations.HarlandPhoenix.ConfigurationHandler,Hyland.Integrations.HarlandPhoenix"/>
  5. Locate the <configuration> tag, and add the following after this tag:

    <Hyland.Integrations.HarlandPhoenix>

    <serviceLogin serviceUser="[user name]" servicePassword="[password]"/>

    <voucher>

    <documentType typeName="[voucher document type name]" />

    <keywordTypes>

    <keywordType baseName="reversal" typeName="[reversal keyword type name]" />

    <keywordType baseName="branchNo" typeName="[branch number keyword type name]" />

    <keywordType baseName="tellerNo" typeName="[teller number keyword type name]" />

    <keywordType baseName="tellerName" typeName="[teller name keyword type name]" />

    <keywordType baseName="journalPtid" typeName="[journal ptid keyword type name]" />

    <keywordType baseName="memberNumber" typeName="[member number keyword type name]" />

    <keywordType baseName="memberEmail" typeName="[member email keyword type name]" />

    </keywordTypes>

    <notification id="[voucher notification id]" />

    </voucher>

    <shareReceipt>

    <documentType typeName=" [share receipt document type name] " />

    <keywordTypes>

    <keywordType baseName="reversal" typeName="[reversal keyword type name]"/>

    <keywordType baseName="branchNo" typeName="[branch number keyword type name]"/>

    <keywordType baseName="tellerNo" typeName="[teller number keyword type name]"/>

    <keywordType baseName="tellerName" typeName="[teller name keyword type name]"/>

    <keywordType baseName="journalPtid" typeName="[journal ptid keyword type name]"/>

    <keywordType baseName="memberNumber" typeName="[member number keyword type name]"/>

    <keywordType baseName="memberEmail" typeName="[member email keyword type name]" />

    </keywordTypes>

    <notification id="[share receipt notification id]" />

    </shareReceipt>

    <documentStorage>

    <keywordTypes>

    <keywordType baseName="formId" typeName="[form id keyword type name]" />

    <keywordType baseName="formName" typeName="[form name keyword type name]" />

    <keywordType baseName="rimNumber" typeName="[rim number keyword type name]" />

    <keywordType baseName="memberSsn" typeName="[member SSN keyword type name]" />

    <keywordType baseName="accountType" typeName="[account type keyword type name]" />

    <keywordType baseName="memberClass" typeName="[member class keyword type name]" />

    <keywordType baseName="accountNumber" typeName="[account number keyword type name]" />

    <keywordType baseName="memberLastName" typeName="[member last name keyword type name]" />

    <keywordType baseName="memberFirstName" typeName="[member first name keyword type name]" />

    </keywordTypes>

    </documentStorage>

    </Hyland.Integrations.HarlandPhoenix>

  6. In the text you added in step 5, replace the [user name] and [password] elements with the user name and password of the OnBase service account that will be used by the integration when connecting to OnBase.
  7. In the text you added in step 5, specify the Keyword Types and Email Notification (if applicable) that will be populated when using the Voucher component by replacing the following elements:

    voucher

    Description

    [voucher document type name]

    Replace this element with the name of the Document Type being used to store vouchers.

    [branch number keyword type name]

    Replace this element with the name of the Keyword Type being used to store the branch number.

    [teller number keyword type name]

    Replace this element with the name of the Keyword Type being used to store the teller number.

    [teller name keyword type name]

    Replace this element with the name of the Keyword Type being used to store the teller name.

    [reversal keyword type name]

    Replace this element with the name of the Keyword Type being used to store the value indicating that a voucher has been reversed.

    [journal ptid keyword type name]

    Replace this element with the name of the Keyword Type being used to store the journal PTID.

    [member number keyword type name]

    Replace this element with the name of the Keyword Type being used to store the member number.

    [member email keyword type name]

    Replace this element with the name of the Keyword Type being used to store the member email address (i.e., the recipient of the signed voucher notifications).

    Note:

    This Keyword Type is only required for sending signed vouchers to one or more recipients.

    [voucher notification id]

    Replace this element with the system number of the Email Notification being used to notify one or more recipients after a voucher is signed.

    Tip:

    You can use the same Email Notification for [share receipt notification id].

    share receipt

    Description

    [share receipt document type name]

    Replace this element with the name of the Document Type being used to store share receipts.

    [reversal keyword type name]

    Replace this element with the name of the Keyword Type being used to store the value indicating that a share receipt has been reversed.

    [branch number keyword type name]

    Replace this element with the name of the Keyword Type being used to store the branch number.

    [teller number keyword type name]

    Replace this element with the name of the Keyword Type being used to store the teller number.

    [teller name keyword type name]

    Replace this element with the name of the Keyword Type being used to store the teller name.

    [journal ptid keyword type name]

    Replace this element with the name of the Keyword Type being used to store the journal PTID.

    [member number keyword type name]

    Replace this element with the name of the Keyword Type being used to store the member number.

    [member email keyword type name]

    Replace this element with the name of the Keyword Type being used to store the member email address (i.e., the recipient of the signed share receipt notifications).

    Note:

    This Keyword Type is only required for sending signed vouchers to one or more recipients.

    [share receipt notification id]

    Replace this element with the system number of the Email Notification being used to notify one or more recipients after a share receipt is signed.

    Tip:

    You can use the same Email Notification for the [voucher notification id].

  8. In the text you added in step 5, specify the Keyword Types that will be populated when storing documents using the Document Storage component by replacing the following elements:

    documentStorage

    Description

    [form id keyword type name]

    Replace this element with the name of the Keyword Type being used to store the form ID.

    [form name keyword type name]

    Replace this element with the name of the Keyword Type being used to store the form name.

    [rim number keyword type name]

    Replace this element with the name of the Keyword Type being used to store the RIM number.

    [member SSN keyword type name]

    Replace this element with the name of the Keyword Type being used to store the member's Social Security number.

    [account type keyword type name]

    Replace this element with the name of the Keyword Type being used to store the account type.

    [member class keyword type name]

    Replace this element with the name of the Keyword Type being used to store the credit union member class.

    [account number keyword type name]

    Replace this element with the name of the Keyword Type being used to store the account number.

    [member last name keyword type name]

    Replace this element with the name of the Keyword Type being used to store the member's last name.

    [member first name keyword type name]

    Replace this element with the name of the Keyword Type being used to store the member's first name.

  9. Save the Application Server's web.config file and restart IIS or reset the cache of the OnBase Application Server.
    CAUTION:

    Using the Reset Cache option in OnBase Configuration or the Reset Server Cache option in OnBase Studio may have a negative impact on system performance. Requests to the Application Server will be forced to wait until the cache is rebuilt before they can be processed. Depending on the size of the OnBase system, as well as the current server load, the performance impact of resetting the cache may be severe. To avoid performance issues, only reset the cache of the Application Server during off-peak hours. For more information about the Reset Cache option in OnBase Configuration, see the System Administration documentation. For more information about the Reset Server Cache option in OnBase Studio, see the Studio documentation.