Configuring XAPO in Civic Platform

By default, Civic Platform uses address, parcel, and owner (APO) data from a database included in the Civic Platform deployment. If your agency has a map service that provides APO data, your external APO (XAPO) data source can be integrated with Civic Platform via Accela GIS. This section describes how to configure Civic Platform to integrate to an XAPO data source via Accela GIS.

To configure the XAPO standard choices in Civic Platform:

Login Civic Platform Classic Administration.
Navigate to Agency Profile > Standard Choices.
On the Standard Choices Item search field, type "External" to look up the external APO standard choices.
- If no standard choice records are found, click Add to create all of the following XAPO standard choices:
- If the XAPO standard choices are already configured and need to be updated, click the red dot next to the standard choice to edit it.
Enter the appropriate values for each of the XAPO standard choices.
- For Accela GIS (JavaScript version), see the XAPO Standard Choice Values for Accela GIS (JavaScript version).
- For Accela Silverlight GIS, see the XAPO Standard Choice Values for Accela Silverlight GIS.
For Accela GIS (JavaScript version): To enable the Accela GIS REST API for querying the XAPO data source, add the USE_GIS_REST_API standard choice, and set the standard choice value to Yes.

Note: By default, Civic Platform uses the legacy SOAP-based XAPO API to execute XAPO queries. If your agency wants to use the REST API for Accela GIS, set USE_GIS_REST_API to Yes.
Click Save or Update to save your changes.

XAPO Standard Choice Values for Accela GIS (JavaScript version)

For Accela GIS (JavaScript version), the SOURCE_LOCATION and SOURCE_REST_API_URL values are required for the EXTERNAL_ADDRESS_SOURCE, EXTERNAL_PARCEL_SOURCE, and EXTERNAL_OWNER_SOURCE standard choices.

Note: If your agency has already defined the Accela Silverlight GIS standard choice values for EXTERNAL_ADDRESS_SOURCE, EXTERNAL_PARCEL_SOURCE, and EXTERNAL_OWNER_SOURCE, you can keep them and simply add the SOURCE_REST_API_URL standard choice value.

Table 1. Standard Choice Value for Accela GIS
Standard Choice Value	Value Description	Description
SOURCE_LOCATION	External	Set the SOURCE_LOCATION value to External for an XAPO data source.
SOURCE_REST_API_URL	http:// <host>/<agissl>	The source URL for the Accela GIS REST API. For example, https://agency.com/agissl

XAPO Standard Choice Values for Accela Silverlight GIS

For Accela Silverlight GIS, the SOURCE_LOCATION and SOURCE_URL values are required for the EXTERNAL_ADDRESS_SOURCE, EXTERNAL_PARCEL_SOURCE, and EXTERNAL_OWNER_SOURCE standard choices. The rest of the standard choice values listed below are optional.

Table 2. EXTERNAL_ADDRESS_SOURCE Standard Choice Values for Accela Silverlight GIS
Standard Choice Value	Value Description	Description
SOURCE_LOCATION (Required for XAPO)	External	Set SOURCE_LOCATION to External for an XAPO data source.
SOURCE_URL (Required for XAPO)	http:// <host>/<agissl>/<xapo.asmx?wsdl>	The external APO source URL. For example, https://agency.com/agissl/xapo.asmx?WSDL
CAN_CONTAIN_ PARCELS	Yes No	This value specifies whether the parcel information associated with the selected address can populate within the application. If you set the value description to Yes, the Parcel tab of the reference Address detail portlet can list all the parcels related to the address.
CAN_CONTAIN_ OWNERS	Yes No	This value specifies whether the owner information associated with the selected address can populate within the application. If you set the value description to Yes, the Owner tab of the reference Address detail portlet can list all the owners related to the address. If you set the value description fields for CAN_CONTAIN_OWNERS and CAN_CONTAIN_PARCELS to Yes and you enable FID 8232 Get Parcel And Owner, Accela Automation exposes the Get Parcel & Owner button on the Address section of the application intake form.
SOURCE_ATTRIBUTES_ MAPPING_ENABLE	Yes No	This value specifies whether the external APO data source handles the mapping between the address template attributes and the GIS map layer fields. When Civic Platform uses Accela GIS as its external APO data source and each APO template attribute is mapped to a GIS map layer field, users can search for external APO data by template attribute.
SOURCE_AUTH_PWD	<webServiceAuthPassword>	This is the user password for accessing the web service.
SOURCE_AUTH_USER	<webServiceAuthUsername>	This is the user name for accessing the web service.
SOURCE_ID	<sourceId>	This unique value identifies the source in the code.
SOURCE_MAP_SERVICE _ID	<mapServiceId>	This value specifies the map service from which you want to retrieve geocoded addresses as external addresses. The mapServiceId must match the map service name configured in Accela Silverlight GIS Admin.
SOURCE_METHOD	Web Service	The APO source method to connect to the external source. Accela Automation only supports "Web service".
SOURCE_NAME	<xapoSourceName>	The name of the external source.
WEB_SERVICE_SSL_SU PPORTED	Yes No True False Default: Yes.	This value defines whether the web service needs SSL data transfer.
IS_XML_DATA	Yes No Default: No.	Specifies whether to use the XML data source.
XAPO_CLIENT_VERSION	7.2.3	7.2.3 stands for Accela Automation Version 7.2.0 Feature Pack 3. In 7.2.0 Feature Pack 3, Accela Automation added 5 address fields: House # Alpha (start), House # Alpha (end), Level Prefix, Level # (start), and Level # (end). You must define this Standard Choice value so users can search for addresses by the 5 address fields in the external APO source.

Table 3. EXTERNAL_PARCEL_SOURCE Standard Choice Values for Accela Silverlight GIS
Standard Choice Value	Value Description	Description
SOURCE_LOCATION (Required for XAPO)	External	Set SOURCE_LOCATION to External for an XAPO data source.
SOURCE_URL (Required for XAPO)	http:// <host>/<agissl>/<xapo.asmx?wsdl>	The external APO source URL. For example, https://agency.com/agissl/xapo.asmx?WSDL
CAN_CONTAIN_ ADDRESSES	Yes No	This value specifies whether the address information associated with the selected parcel can populate within the application. If you set the value description to Yes, then the Address tab of the reference Parcel detail portlet lists all the addresses related to the parcel. If you set the value description fields for CAN_CONTAIN_ADDRESSES and CAN_CONTAIN_OWNERS to Yes and enable FID 8234 Get Address And Owner, Accela Automation exposes the Get Address & Owner button on the Parcel section of the application intake form.
CAN_CONTAIN_ OWNERS	Yes No	This value specifies whether the owner information associated with the selected parcel can populate within the application. If you set the value description to Yes, then the Owner tab of the reference Parcel detail portlet lists all the owners related to the parcel.
SOURCE_MAP_SERVICE _ID	<mapServiceId>	This value specifies the map service from which you want to retrieve external parcels. The mapServiceId must match the map service name configured in Accela Silverlight GIS Admin.
SOURCE_ATTRIBUTES_ MAPPING_ENABLE	Yes No	This value specifies whether the external APO data source handles the mapping between the parcel template attributes and the GIS map layer fields. When Accela Automation uses Accela GIS as its external APO data source and each APO template attribute is mapped to a GIS map layer field, users can search for external APO data by template attribute.
SOURCE_AUTH_PWD	<webServiceAuthPassword>	This is the user password for accessing the web service.
SOURCE_AUTH_USER	<webServiceAuthUsername>	This is the user name for accessing the web service.
SOURCE_ID	<sourceId>	This unique value identifies the source in the code.
SOURCE_METHOD	Web Service	The APO source method to connect to the external source. Accela Automation only supports "Web Service".
SOURCE_NAME	<xapoSourceName>	The name of the external source.
WEB_SERVICE_SSL_SU PPORTED	Yes No True False Default: Yes	This value defines whether the web service needs SSL data transfer.
IS_XML_DATA	Yes No Default: No	Specifies whether to use the XML data source.

Table 4. EXTERNAL_OWNER_SOURCE Standard Choice Values for Accela Silverlight GIS
Standard Choice Value	Value Description	Description
SOURCE_LOCATION (Required for XAPO)	External	Set SOURCE_LOCATION to External for an XAPO data source.
SOURCE_URL (Required for XAPO)	http:// <host>/<agissl>/<xapo.asmx?wsdl>	The external APO source URL. For example, https://agency.com/agissl/xapo.asmx?WSDL
SOURCE_METHOD	Web Service	The APO source method to connect to the external source. Accela Automation only supports "Web Service".
SOURCE_NAME	<xapoSourceName>	The name of the external source.
WEB_SERVICE_SSL_SU PPORTED	Yes No True False Default: Yes.	This value defines whether the web service needs SSL data transfer.
IS_XML_DATA	Yes No Default: No.	Specifies whether to use the XML data source.

If your agency uses an external APO data source but not Accela GIS, a custom XAPO adapter can be written to integrate with Civic Platform. For Accela Silverlight GIS, a custom adapter can use the AGIS SOAP API methods to access the XAPO data source. For Accela GIS (JavaScript version), a custom adapter can use the Accela GIS REST API to access the XAPO data source.