In this article:
Related Esri documentation:
Resources open in a new tab. Please note that the related documentation is maintained by Esri, and Infotech is not responsible for any errors they may contain.
The Appia-powered Esri Capital Project Coordination integration lets users share the construction administration data gathered in their Appia projects to their Capital Project Coordination (CPC) solution in Esri ArcGIS. By connecting the two solutions, your CPC layer can pull robust project data from Appia to maintain a geolocated, authoritative data layer in your organization's ArcGIS environment.
Quick guide: Deploy the integration
See the following sections for detailed instructions on each step.
- In ArcGIS: Deploy the CPC solution to create the assets.
- In ArcGIS: Define project polygons using the CPC web map application.
- Optionally, use the Appia feature layer service to share project points to the map to aid in visualization.
- In Appia: Deploy the integration.
- In Appia: Generate a personal access token (PAT) and save it securely.
- In ArcGIS: Authenticate the connection using your Appia PAT.
- In ArcGIS: Run the pipeline as needed to pull Appia data to your CPC layer.
- Optionally, schedule the data pipeline to run automatically.
Note: Before you can deploy the Appia integration to your CPC layer, you'll need to connect your Appia and ArcGIS accounts. Then create the project geometry in the ArcGIS solution and deploy the integration within Appia to begin sharing project data.
In ArcGIS: Deploy the CPC solution
First, you'll need to deploy the Capital Project Coordination solution from the ArcGIS marketplace to your ArcGIS organization to create the solution assets needed for the spatial join with your Appia projects.
- Navigate to the CPC solution in the ArcGIS marketplace.
- Click Deploy now. The ArcGIS login window will appear.
- Enter your login details and click Sign In.
For help with this step, see the Esri documentation on deploying the CPC solution.
In ArcGIS: Define project polygons
The integrated solution uses spatial join to sync project polygons in your CPC Infrastructure Projects feature layer with the Appia projects you share. Define location boundaries for your capital projects using the CPC web mapping application before deploying the integration in Appia.
For help with this step, see the Esri documentation on creating projects in the CPC solution.
Things to know
- Each defined location boundary of a capital project polygon must intersect with a single Appia project location, which is defined as a point when shared to the solution. If more than one project point occurs within a bounding polygon, spatial conflicts will occur.
- Tip: Export existing Appia project locations to the CPC web map to aid in polygon creation. See the following Optional section on sending project location points.
- While some attribute fields are mandatory for creation of the polygon, many fields will be overwritten with the project data from Appia once the data pipeline is run.
Optional: Send Appia project location points to Esri
To help visualize project locations and prevent spatial join conflicts when defining project polygons in the CPC layer, you can use Appia's feature layer service to send all opted-in projects with project location to the CPC map. Project locations sent via feature service appear as single points around which you can draw the location boundary of a project polygon.
- First, follow the instructions to send Appia project data to Esri.
- Once your feature layer has been exported, navigate to the Capital Project Catalog web map.
- This web map is pulled into the Capital Project Catalog web mapping application.
- Click Open in Map Viewer to open the web map in the full map viewing mode.
- Add your Appia feature layer to the map:
- From the sidebar under the web maps feature layers area, click Add.
- Select your Appia feature layer in the content display and click +Add.
- Click Save to save the web map.
- Return to the Capital Project Catalog web mapping application in your ArcGIS Online content. The Appia projects will be displayed as points.
In Appia: Deploy the integration
Once the CPC solution is deployed in your ArcGIS organization, you can connect your Appia projects by deploying the integration within Appia. Follow these steps to deploy the integration.
- In Appia, navigate to System Mgt Integrations.
- If you haven't already done so, connect your ArcGIS and Appia accounts.
- In the Capital Project Coordination panel, click Deploy Now.
- The credential authentication window will appear.
- Re-enter your Esri username and password to authenticate the connection.
- Click Login.
- The feature layer selection window will appear.
- Use the drop-down menu to select your organization's CPC Layer ID.
- Note: only the feature layers accessible by the credentials entered will be available for selection.
- Select the checkbox to agree to the terms and conditions.
- Click Deploy.
Good to know: CPC Layer ID criteria
For the correct feature layer to appear in the selection drop-down menu, it must fit the following criteria:
- Exists within the organization to which your credentials are associated
- Accessible by the credentials used
- Has the tags of
CIP,Capital Projects, andArcGIS Solutions- Note: these tags are automatically generated when the solution is deployed
In Appia: Generate a personal access token (PAT)
For authentication within the CPC solution, you'll need to supply a PAT generated in Appia with the correct scope selected. Here's how to generate your PAT.
- In Appia, navigate to System Mgt API.
- Click Go to Personal Access Tokens.
- From the Personal Access Tokens page, click Generate new token.
- Enter a name for the new token.
- Select the checkbox for Capital project coordination.
- Click Generate new token.
- From the new token window, click Copy Token, then click Done.
- Click on the title of your newly generated token.
- In the Token name field, replace the name of the token with the token ID you copied when the token was created.
- Click Update token.
In ArcGIS: Launch data pipeline and authenticate with PAT
Next, you will return to the CPC solution in ArcGIS to complete the pipeline connection.
- From your ArcGIS Online content, select Appia CPC Connection.
- Click Open in Data Pipelines.
- Select the Appia projects URL parameters input box.
- Click Add connection.
- The Add a service connection window will appear.
- In the API Key field, enter the PAT token ID you generated and copied in the previous step.
- In the Parameter name field, enter the term Authorization.
- In the API key prefix (optional) field, enter the term Bearer.
- Click Next.
- In the Title field, enter a name for this service connection.
- The service connection will appear as an item in your ArcGIS Online content, and can be re-accessed if the connection is lost.
- Optionally, add a description for the service connection to the Summary field.
- Click Save.