{"type":"doc","content":[{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"The Address attribute stores a reference to a user-entered address. Introduced in 10.6.0.","type":"text"}]}]},{"type":"paragraph"},{"type":"layoutSection","marks":[{"type":"breakout","attrs":{"mode":"full-width"}}],"content":[{"type":"layoutColumn","attrs":{"width":66.66},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"minLevel":{"value":"1"},"maxLevel":{"value":"7"}},"macroMetadata":{"macroId":{"value":"5a601f346547383c100eedd505bea3a7"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"5bee6033-1a83-45ca-81bc-d6729ca1b93f"}},{"type":"heading","attrs":{"level":2},"content":[{"text":"Overview","type":"text"}]},{"type":"paragraph","content":[{"text":"The Address attribute collects a user-entered address as a single data field, eliminating the need to configure multiple, independent fields for street/city/state/etc. ","type":"text"}]},{"type":"paragraph","content":[{"text":"In addition, if the Address Verification system is enabled, user-entered addresses are geocoded (","type":"text"},{"text":"converted into lat/long GPS coordinates","type":"text","marks":[{"type":"em"}]},{"text":") and parsed into constituent elements (city/state/etc) and stored in the ","type":"text"},{"text":"ADDRESS","type":"text","marks":[{"type":"code"}]},{"text":" table.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Configuration","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":36.0},"content":[{"type":"media","attrs":{"width":703,"id":"07fb3487-7bbd-49dd-9dfa-13f0cd4b7534","collection":"contentId-2313388501","type":"file","height":567}}]},{"type":"paragraph","content":[{"text":"The only configuration option for this attribute is a JSON object containing properties that are passed through to the autocomplete UI in input mode. For more information on the available settings, see ","type":"text"},{"text":"https://smartystreets.com/docs/cloud/us-autocomplete-pro-api","type":"text","marks":[{"type":"link","attrs":{"href":"https://smartystreets.com/docs/cloud/us-autocomplete-pro-api"}}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Advanced Options (AutoComplete)","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"{\n \"max_results\": null,\n \"include_only_cities\": null,\n \"include_only_states\": null,\n \"include_only_zip_codes\": null,\n \"exclude_states\": null,\n \"prefer_cities\": null,\n \"prefer_states\": null,\n \"prefer_zip_codes\": null,\n \"prefer_ratio\": null,\n \"prefer_geolocation\": null\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Input Mode","type":"text"}]},{"type":"paragraph","content":[{"text":"In input mode, the address is collected using a single text input field that performs address completion using the ","type":"text"},{"text":"Smarty Streets service","type":"text","marks":[{"type":"link","attrs":{"href":"https://www.smartystreets.com/products/apis/us-autocomplete-pro-api"}}]},{"text":". ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start"},"content":[{"type":"media","attrs":{"width":489,"id":"ca2b6138-425b-4a53-b0bc-9a793f391481","collection":"contentId-2313388501","type":"file","height":49}}]},{"type":"paragraph","content":[{"text":"If address verification is disabled, then a single text input field is displayed ","type":"text"},{"text":"without autocomplete","type":"text","marks":[{"type":"em"}]},{"text":". Addresses can still be collected without the verification service, but they will not be geocoded, parsed into constituent pieces, etc.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Display Mode","type":"text"}]},{"type":"paragraph","content":[{"text":"In display mode, the address is displayed as readonly text.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Data Storage","type":"text"}]},{"type":"paragraph","content":[{"text":"This attribute stores ","type":"text"},{"text":"ADDRESS_ID","type":"text","marks":[{"type":"code"}]},{"text":" from the ","type":"text"},{"text":"ADDRESS","type":"text","marks":[{"type":"code"}]},{"text":" table","type":"text"}]},{"type":"paragraph","content":[{"text":"Address Attribute Fields","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"AddressId (Integer)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"OwnerMemberId (Integer)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Label (String)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"FullAddress (String)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"StreetLine1 (String)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"StreetLine2 (String)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"StreetLine3 (String)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"City (String)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"State (String)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Province (String)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ZipCode (String)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Country (String)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ValidationStatus (AddressValidationStatusEnum: Unvalidated, Failed, Validated, Errored)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ValidatedOn (DateTime)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ValidationResultJson (String)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"GpsLatitude (float)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"GpsLongitude (float)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"CreatedByProcess (AddressCreatedByProcessEnum: Workflow, Profile)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"CreatedOn (DateTime)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ModifiedOn (DateTime)","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Advanced use cases","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"These advanced use cases require that the Address Verification feature be enabled. These techniques will ","type":"text"},{"text":"not ","type":"text","marks":[{"type":"em"}]},{"text":"work on an address that is not geocoded/parsed by the validator at the time of data entry.","type":"text"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Calculating the distance between two addresses in a Template","type":"text"}]},{"type":"paragraph","content":[{"text":"Template attributes can calculate the distance between two addresses using the ","type":"text"},{"text":"GetDistanceTo()","type":"text","marks":[{"type":"code"}]},{"text":" method. ","type":"text"}]},{"type":"paragraph","content":[{"text":"Note that this calculates \"straight-line\" distance between two points; it does ","type":"text"},{"text":"not ","type":"text","marks":[{"type":"em"}]},{"text":"calculate driving or travel distance.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Distance Template","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":"@using Heuristics.LearningBuilder.WorkflowAttributes\n@DistanceFrom()\n@functions {\n\n\tpublic string DistanceFrom() {\n\t\ttry {\n\t\t\tvar address1 = Model.MemberRole.GetAttribute(\"EXT_ROLE_Address_1\");\n\t\t\tvar address2 = Model.MemberRole.GetAttribute(\"EXT_ROLE_Address_2\");\n\t\t\tif (address1 == null || address2 == null || address1.AddressId == 0 || address2.AddressId == 0) {\n\t\t\t\treturn string.Empty;\n\t\t\t}\n\n\t\t\treturn address1.GetDistanceTo(address2, DistanceUnit.Kilometers).ToString(\"N2\") + \" kilometers\";\n\n\t\t}\n\t\tcatch(Exception a) {\n\t\t\treturn a.Message;\n\t\t}\n\t}\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Extracting the address elements from an Address attribute","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Component Template","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":"@using Heuristics.LearningBuilder.WorkflowAttributes\n@using Heuristics.LearningBuilder.Web.Helpers\n@using System.Web.Mvc\n@using System.Web\n@using Heuristics.Library.Extensions\n@Raw(DisplayAddressComponents())\n@functions {\n\n\tpublic string DisplayAddressComponents() {\n\t\ttry {\n\t\t\tvar address = Model.MemberRole.GetAttribute(\"EXT_ROLE_Address_1\");\n\t\t\tif (address == null || address.AddressId == 0) {\n\t\t\t\treturn string.Empty;\n\t\t\t}\n\n\t\t\tvar output = new MvcHtmlString(\"

\");\n\n\t\t\treturn output\n\t\t\t\t.Append(\"

AddressId: \" + address.AddressId.ToString() + \"

\")\n\t\t\t\t.Append(\"

OwnerMemberId: \" + address.OwnerMemberId.ToString() + \"

\")\n\t\t\t\t.Append(\"

Label: \" + address.Label + \"

\")\n\t\t\t\t.Append(\"

Full Address: \" + address.FullAddress.ToString() + \"

\")\n\t\t\t\t.Append(\"

Validation Status: \" + address.ValidationStatus.ToDescription() + \"

\")\n\t\t\t\t.Append(\"

Created By Process: \" + address.CreatedByProcess.ToDescription() + \"

\")\n\t\t\t\t.Append(\"

Created On: \" + address.CreatedOn.ToString() + \"

\")\n\t\t\t\t.Append(\"

Modified On: \" + address.ModifiedOn.ToString() + \"

\")\n\t\t\t\t.Append(\"

Latitude: \" + (address.GpsLatitude.HasValue ? address.GpsLatitude.Value.ToString() : string.Empty) + \"

\", address.GpsLatitude.HasValue)\n\t\t\t\t.Append(\"

Longitude: \" + (address.GpsLongitude.HasValue ? address.GpsLongitude.Value.ToString() : string.Empty) + \"

\", address.GpsLongitude.HasValue)\n\t\t\t\t.ToHtmlString();\n\n\t\t}\n\t\tcatch(Exception a) {\n\t\t\treturn a.Message;\n\t\t}\n\t}\n}","type":"text"}]},{"type":"paragraph"}]},{"type":"layoutColumn","attrs":{"width":33.33},"content":[{"type":"bodiedExtension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"panel","parameters":{"macroParams":{"title":{"value":"Sample Use Cases"}},"macroMetadata":{"macroId":{"value":"4deff2b0-efee-4989-8429-77d64e090dc2"},"schemaVersion":{"value":"1"},"title":"Panel"}},"localId":"dbab14fe-834c-441c-95ed-1307167fa759"},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Collecting a user-entered address as a single element, instead of a collection of multiple street/city/state attributes.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Displaying the distance between two addresses","type":"text"}]}]}]}]},{"type":"bodiedExtension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"panel","parameters":{"macroParams":{"title":{"value":"Business Rules"}},"macroMetadata":{"macroId":{"value":"dd32d0b7-ee57-4d1d-9bc6-9c4f939d9feb"},"schemaVersion":{"value":"1"},"title":"Panel"}},"localId":"ed208b3d-c8b6-431c-9425-302cb9eae0a0"},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The user-entered address is only geocoded and parsed into its constituent elements if the ","type":"text"},{"text":"EnableAddressVerification","type":"text","marks":[{"type":"code"}]},{"text":" app config setting is enabled at the time that the address is entered.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Enabling address verification ","type":"text"},{"text":"after ","type":"text","marks":[{"type":"em"}]},{"text":"address data is collected will ","type":"text"},{"text":"not ","type":"text","marks":[{"type":"em"}]},{"text":"cause the pre-existing addresses to be validated/parsed.","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Related articles","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"contentbylabel","parameters":{"macroParams":{"cql":{"value":"label = \"activity-containers\""}},"macroMetadata":{"macroId":{"value":"9dbdc9ac-c810-4156-974a-e95341c677a9"},"schemaVersion":{"value":"4"},"title":"Content by Label"}},"localId":"ebfc5598-0858-494d-a838-edc99388ba56"}},{"type":"bodiedExtension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"details","parameters":{"macroParams":{"hidden":{"value":"true"}},"macroMetadata":{"macroId":{"value":"3c7b2eba-397f-463c-a171-b9b6a9c2890d"},"schemaVersion":{"value":"1"},"title":"Page Properties"}},"localId":"2a5105e2-6cee-47fd-b4b6-1d533b305dea"},"content":[{"type":"paragraph"},{"type":"table","attrs":{"layout":"default","localId":"c6ffff39-a2f9-4004-b319-72c3336cdb8c"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[1085.0]},"content":[{"type":"paragraph","content":[{"text":"Related issues","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[550.0]},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]}]}]},{"type":"paragraph"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}],"version":1}