How to Configure the West km Connector

All BA Insight connectors can be downloaded from Right Answers under Knowledge > BA Insight > Product Downloads > Connectors.

This connector is installed with the same generic steps as any BA Insight connector.

Satisfy the Prerequisites for your connector before installing.

Configuration specifics are detailed below.

How to Configure West KM Connector

  1. Add the Component West KM Metadata.

  2. Click Existing Components to see the Configuration section:

  3. Elastic Server Address:

    1. Specify the Elastic Server Address

    2. All Elastic v6.x versions are supported

  4. Click Validate:

    1. User and Password fields may be required if Elastic is secured.

  5. User Id:

    1. Provide your Elasticsearch User ID, if required.

  6. User Password:

    1. Provide your Elasticsearch user password, if required.

  7. Timeout:

    1. Provider desire Timeout.

    2. Default: 30

  8. Load/Select Index:

    1. Select the desired West km index for vetted documents

  9. Metadata Property:

    1. Enter metadata property to match the Elastic document.

    2. Typically, DocumentId

  10. Index Key Field:

    1. Enter elastic document number index field.

    2. Typically, doc_num

  11. Include Cite Recognition:

    1. Select this option to include Cite Recognition data

  12. Include Classification:

    1. Select this option to include Classification data

  13. Litigation Properties:

    1. Enter litigation properties, semi-colon separated, to retrieve as metadata from the Elastic Index.

    2. Leave empty to ignore litigation properties.

    3. Configuration defaults standard West Metadata fields

  1. Include Unresolved Litigation Properties:

    1. Select this option to include metadata that West KM has extracted but are not fully resolved by West KM.

  2. Transactional Properties:

    1. Enter transaction properties, semi-colon separated, to retrieve as metadata from the Elastic Index.

    2. Leave empty to ignore litigation properties.

    3. Configuration defaults standard West Metadata fields

Output Properties

Classification Properties

Property Type
WKMClassification Text – Multi

Citation Properties

Property Type Description
WKMCitation Text – Multi Citation Title
WKMCitationLink Text – Multi Delimited Citation field for UI display. Separator: "|" Format: Citation Title|Citation Normalized|Cite Publication|Cite Serial Number|Cite Summary if available
WKMCiteNormalized Text – Multi Citation Title without special characters
WKMCitePublication Text – Multi Citation Publication Number
WKMCiteSerialNumber Text – Multi Citation Serial Number

Transactional Properties

Transaction Properties are dynamic based on input properties.

  • Default Properties:

    • law_firm_name;attorney;party;governing_law

  • Example:

    • law_firm_name when detected returns WKMTransLawFirmName

West km Property Property Type
law_firm_name WKMTransLawFirmName Text – Multi
attorney WKMTransAttorney Text – Multi
party WKMTransParty Text – Multi
governing_law WKMTransGoverningLaw Text – Multi

Litigation Properties

Litigation properties are dynamic, based on input properties.

  • Default Properties:

    • company.name;expert_witness.name;law_firm.name;judge_primary.name;judge_secondary.name;attorney.name;document_type.name

West km Property Property Type
company.name WKMLitCompanyName Text – Multi
expert_witness.name WKMLitExpertWitnessName Text – Multi
law_firm.name WKMLitLawFirmName Text – Multi
judge_primary.name WKMJudgePrimaryName Text – Multi
judge_secondary.name WKMJudgeSecondaryName Text – Multi
attorney.name WKMAttorneyName Text – Multi
document_type.name WKMDocumentType Text – Multi

Note: Transaction properties can be combined for UI display purposes.

Example

Copy 
company.name|company.url
 
Return Property  WKMLitCompanyName: ACME|http://www.westlaw.com/......

Including Additional Properties

Additional Elastic Properties can be included.

  • Use Elastic to search for a document

  • Download the JSON Results

  • The JSON results are flattened

Copy 
litigation_metadata.company.westlaw_id = 2883123
litigation_metadata.company.name = Capital Trade
litigation_metadata.company.id = 2fffabf0-e33b-4ae8-a1a8-143acd501ed6
litigation_metadata.company.url = http://www.westlaw.com/Search/Results.html?query=advanced%3a+WCAID(I48F4449042B311DDA5520014224D2780)&jurisdiction=ALLCASES&saveJuris=False&contentType=BUSINESS-INVESTIGATOR&startIndex=1&contextData=(sc.Default)&categoryPageUrl=Home%2fCompanyInvestigator&originationContext=document&transitionType=DocumentItem&vr=3.0&RS=wlw