OnBaseAccelaCfg.xml - Integration for Accela - English - Foundation 22.1 - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

Integration for Accela

Platform
OnBase
Product
Integration for Accela
Release
Foundation 22.1
License
Standard
Essential
Premier

The OnBaseAccelaCfg.xml file contains Integration for Accela configuration information. Information stored in this file includes how the connection to the OnBase Application Server is made, as well as how data is sent from the Accela Web Service to OnBase. Document import and document retrieval configuration information is also stored in this file.

To configure OnBaseAccelaCfg.xml settings:

  1. Open OnBaseAccelaCfg.xml in a plain-text editor.
    Note:

    The *.config file should only be edited in a plain-text editor, such as Notepad, or a utility specifically designed to edit XML files. It should not be edited in a binary editor, such as Microsoft Word. Using a binary editor can introduce invalid characters to the file and make it unreadable by the software.

  2. In the AccelaAgency element, replace [AGENCY NAME] with the Agency name sent by Accela. All messages from Accela Automation include an Agency name.
  3. In the ConnectionInformation element:
    1. Replace the value of the datasource attribute with the name of the OnBase data source.
    2. Replace the value of the hylandserviceurl attribute with the URL of the OnBase Application Server.
  4. In the Authentication element:
    1. Replace the value of the username attribute with the user name of the OnBase Service Account.
    2. Replace the value of the password attribute with the password for the OnBase Service Account.
  5. In the DocumentViewer element, replace the value of the url attribute with the URL to the DocPop *.aspx page.
  6. In the LoggingOptions element, set the value of the displaytrace attribute to specify whether logging information is displayed on the Errors tab in the Diagnostics Console:
    • TRUE: logging information is displayed on the Errors tab

    • FALSE: logging information is not displayed on the Errors tab

  7. In the ImportDocuments element, map Accela Category field values to OnBase Document Types using the following XML elements and attributes:
    Note:

    The Accela Category, Entity, and Keyword descriptions are not case sensitive.

    XML Element

    Attribute

    Description

    AccelaCategory

    name

    Enter the name of the Accela Category. This name is defined by Accela.

    Tip:

    The Accela configuration team can help you match the Accela Category name to the OnBase Document Type name.

    AccelaEntity

    name

    Enter the name of the Accela Entity. Valid values are:

    • ASSET

    • ASSETCA

    • CAP

    • EVIDENCE

    • INSPECTION

    • LICENSEPROFESSIONAL

    • PARCEL

    • PART

    OnBaseDocType

    Enter the name of the OnBase Document Type that is used for the given Accela Entity.

    Keywords/Keyword

    AccelaField

    The Keywords element is used to map the Keyword Types to Accela Fields. Each Keyword Type is defined with its own Keyword child element.

    Enter the name of the Accela Field to map to the OnBase Keyword Type. This value corresponds to the name of the Accela Entity defined above. The [name of entity] ID field must be defined for each entity. The [name of entity] ALT ID field is optional.

    For example, the CAP Accela Entity must have the CAP ID defined in this section. The CAP ALT ID field is optional.

    Valid values are:

    • ASSET ID and ASSET ALT ID

    • ASSETCA ID and ASSETCA ALT ID

    • CAP ID and CAP ALT ID

    • EVIDENCE ID and EVIDENCE ALT ID

    • INSPECTION ID and INSPECTION ALT ID

    • LICENSEPROFESSIONAL ID and LICENSEPROFESSIONAL ALT ID

    • PARCEL ID and PARCEL ALT ID

    • PART ID and PART ALT ID

    OnBaseKeywordName

    Enter the OnBase Keyword Type name that is populated with the value in the Accela Field.

    CommonElements/Keywords/ Keyword

    AccelaField

    The CommonElements element is used to map the common Keyword Types to the corresponding Accela Fields. It contains a Keywords child element. Each Keyword Type is defined with its own Keyword grandchild element.

    Enter the name of the Accela Field to map to the OnBase Keyword Type. Valid values are:

    • CATEGORY

    • DESCRIPTION

    • FILENAME

    OnBaseKeywordName

    Enter the OnBase Keyword Type name that is populated with the value in the Accela Field.

  8. In the RetrieveDocuments element, define the Custom Query that is used for retrieving documents.
    1. In the AccelaEntity child element, update the value of the Name attribute to the name of the Accela Entity used to retrieve documents. This name is defined in the corresponding AccelaEntity tag.
    2. In the CustomQuery child element, update the value of the Name attribute to the name of the OnBase Custom Query used to retrieve documents.
    3. In the Keyword child element, update the value of the AccelaField attribute to the name of the Accela Field used by the Custom Query.
    4. In the Keyword child element, update the value of the OnBaseKeywordName attribute to the OnBase Keyword Type that is populated by the Accela Field used by the Custom Query.
    5. When documents are imported to OnBase directly and not uploaded through Accela, in order for the category column to be displayed, the CategoryMapping child element must be configured.

      If the selected OnBase Keyword Type used for the OnBaseKeywordName is unavailable or blank, then it will use the DefaultValue attribute. The DefaultValue attribute will be the literal string value to be displayed.

    6. In the FileNameMapping child element, update the value of the OnBaseKeywordName attribute to an OnBase Keyword Type. This will be used in the File Name column in Accela.

      If a File Name is not mapped, the Auto-Name value for the document type is used.

  9. Save and close OnBaseAccelaCfg.xml.