Set Up and Configure the Litera Foundation Connector
All BA Insight connectors can be downloaded from the Upland Right Answers Portal under Knowledge > BA Insight > Product Downloads > Connectors. You must review and comply with the Connector Prerequisites before installing the connector using the installation wizard.
Dataset Connection
The Litera Foundation Connector can create individual datasets for 3 item types: Matters, Clients, and People. Each item type has a separate .asmx file. The default DataConnector.asmx is used to index Matters.
-
In Connectivity Hub, navigate to Connectivity Hub > Datasets > DataSet Connections > New > Web Service Dataset Connection.
-
When creating a new connection, use the appropriate .asmx file that corresponds to the item type that will be indexed.
Dataset | DataConnector file to use |
---|---|
Matters | DataConnector.asmx |
Clients | DataSetConnectorClients.asmx |
People | DataSetConnectorPeople.asmx |
Connection Info
After you complete the basic settings for this Web Service Dataset Connector, navigate to the General Settings tab and use the following table to complete the fields:
Setting |
Required |
Description |
---|---|---|
Login |
Yes |
Enter a Litera Foundation email account with Admin access |
Password | Yes | The Litera Foundation API key created during Prerequisites |
API Key name | Yes | The name of the previously created API key |
Base Url | Yes |
The base url used for API calls. The URL must be in the format https://{firmname}.foundationsg.com/ |
Additional properties | No |
If you wish to index additional metadata Provides context with details such as the source, type, owner, and relationships to other data sets. Metadata provides details around the item being crawled by Connectivity Hub. that is not part of the out-of-the-box metadata. Add the json paths for the new metadata, one on each line. You will need to use the Litera Foundation response json structure to obtain the correct json paths. |
DataSet
-
The default DataSet configuration is the same across all 3 DataSets.
-
The only difference is in the properties field.
Properties - a comma separated list of properties that will be used when mapping a webservice Connector to the Dataset.
-
You must use at least one of the specified properties.
Dataset | Properties |
---|---|
Matters | Id,MatterNumber,SourceRecordId |
Clients | Id,Number |
People | Id,Email,SourceRecordId |
Metadata
Each Dataset comes with a number of out of the box metadata. Go to DataSet > Actions > Metadata > Generate to generate the metadata properties for the selected Dataset. A custom Foundation Field is supported and properties are created when generating metadata.
Additional Properties
-
If Additional Properties are configured in the Dataset Connection, the corresponding metadata needs to be created manually.
-
On the Dataset Metadata page click New > Text Metadata
Field | Description |
---|---|
Title | The display name of the metadata |
Value |
Select the Define by Template option Add the json path used in the Connection Config between "[]" [jsonPath] Array json path
If your json path is an array value replace the inner "[ ]" with "_". This change should only be done in the Metadata page and not in the "Additional Properties" field in the connection. Example: languages[0].name becomes languages_0_.name |
Configurable Metadata
Availability settings for Clients and Matters have configurable values via the Foundation UI.
To reflect these values you must modify the connector web.config file.
The web.config file contains 3 custom config sections:
- matterConfig - For Matter Availability settings
- clientConfig - For Client Availability settings
- restrictionsConfig - For Use Restrictions
Below are the default values.
<matterConfig>
<availabilityTypes>
<availabilityType key="0" name="Unspecified" />
<availabilityType key="1" name="Available For Marketing" />
<availabilityType key="2" name="Available With Restrictions" />
<availabilityType key="4" name="For Internal Use Only" />
</availabilityTypes>
</matterConfig>
<clientConfig>
<clientAvailabilityTypes>
<availabilityType key="0" name="Unspecified" />
<availabilityType key="1" name="Available" />
<availabilityType key="2" name="Available With Restrictions" />
<availabilityType key="4" name="Do Not Reference" />
</clientAvailabilityTypes>
</clientConfig>
<restrictionsConfig>
<useRestrictions>
<restriction key="0" name="None" />
<restriction key="1" name="Do not disclose client name" />
<restriction key="2" name="Do not disclose financial information" />
<restriction key="4" name="Contact Responsible Lawyer prior to use" />
<restriction key="8" name="Do not publish on website" />
<restriction key="16" name="Do not use in submissions" />
<restriction key="32" name="Lawyer Bio Use Only" />
<restriction key="256" name="Do not use client logo" />
</useRestrictions>
</restrictionsConfig>
If the setting names are modified in Litera Foundation, the "name" field must be manually edited to reflect it's most recent value.
-
Matter Availability Settings are found under: matterConfig → availabilityTypes → availabilityType
-
Client Availability Settings are found under: clientConfig → clientAvailabilityTypes → availabilityType
Example of How to Edit Matter Availability Settings
- In Foundation "For Internal Use Only" Matter availability was changed to "Only For Development"
- In the web.config file, change the following line:
- <availabilityType key="4" name="For Internal Use Only" />
to - <availabilityType key="4" name="Only For Development" />
- <availabilityType key="4" name="For Internal Use Only" />
- Do not change the key values
The same logic can be used to update Client Availability settings.
-
Restrictions are common between Client and Matters.
-
Their values can be found under restrictionsConfig → useRestrictions → restriction
-
You can add up to 12 restrictions to Foundation.
-
To add additional restrictions to the web.config file go to restrictionsConfig→ useRestrictions and add a new <restriction key="" name=""/> tag.
Attribute | Value |
---|---|
key |
The internal Foundation ID of the Restriction. Use one of the following key values:
|
name |
The name of the Restriction |