There are a number of ways that address information can be extracted or used within the system. On this page, we answer common questions and provide guidance on using the locations (address data) in the application.
What Is a Location?
A location is a geographical location or address. This could be a postal address, DX or other courier addresses or coordinates. Location types can be configured within the system, which identify what each location is used for. Common examples are 'correspondence', ‘billing’, and ‘registered’.
Locations are stored at two primary levels within the system:
- ODS (Master Data) - when an ODS entity is created in the system, such as a person, team, organisation or user, then location information can be stored centrally as part of the master data record for that entity. This location information is then available across the system for use when that entity is acting as a participant on a particular piece of work. For example, a large bank may have several hundred locations stored against it in master data; however, in the context of a single lending transaction, only one of those locations would be relevant.
- Participant Locations - when an ODS entity participates in a piece of work, the user is able to select from their master data addresses to say which one(s) are relevant to this particular piece of work. The user can define a location type to determine what the address is being used for, e.g., correspondence or billing. This location type may differ from the location type held on the master data record. For example, an address held as the registered office on the master data record may be used on a piece of work as the correspondence address.
Common Address Fields
The fields available will vary based on your product configuration, but these are the common ones.
| Address Field | Description |
|---|---|
| Line1 - 4 | Lines 1 - 4 of the address |
| Town / City |
|
| County / State | County or State in which the address resides (text) |
| Country | Option set - drill down further to get the name |
| Postcode / Zipcode |
|
| Formatted | Provides the address in letter format |
| FormattedCSV | Provides the address in a comma-separated single-line format, e.g. the witness lives at 68 Chance Street, Wilmslow, SK10 1AAD.' |
| DX Exchange | Use on DX addresses |
| DX Number | DX Number |
Common Address Queries (for Document Tagging)
These tags are provided in the format of a document template; however, they can be easily converted to a work item format by replacing the prefix from workitem to context.
-
Work Item Version:
workitem.roles.client.locations.5002500.formatted -
Document Version:
context.roles.client.locations.5002500.formatted
| Common Requirement | Sample Tag | |
|---|---|---|
| Participant Address (letter format) | context.roles.client.locations.5002500.formatted |
This tag is looks for the client role on the matter (this role is configured to only have one participant and not multiple), it then goes to locations and selects the type of correspondence. There are many different options on the address itself. The formatted option will bring the address back in a letter format. Note that the address is taken from the location area on participant rather than from clicking on the ods option. This is because we are looking for the address that has been selected for this entities participant in this particular piece of work rather than any addresses we might hold on their master data record. 68 Chance Street Wilmslow Cheshire SK10 1AAD |
| Participant Address (single line format with elements separated by comma) | context.roles.customer!1.locations.5002500.formattedCsv |
This works the same as the above only in this instance there can be more than one entity holding this role - the !1 will select the first entity. 68 Chance Street, Wilmslow, Cheshire, SK10 1ADD Note: if you need addresses in a different format then you can configure a calculated field to create the addresses in the required format. |
| Participant Postcode | context.roles.customer!1.locations.5002500.address.postcode | This tag pulls an individual address item out from the address |