Skip to content

Commit

Permalink
Updated install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
@jkerr5
jkerr5 authored Nov 27, 2019
1 parent 9c3d591 commit 98cc6e3
Showing 1 changed file with 57 additions and 59 deletions.
116 changes: 57 additions & 59 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,70 +4,45 @@ This project aims to provide Esri's [ArcGIS Pro](https://pro.arcgis.com) the cap
MarkLogic database straight from within the desktop application. It is built using the .NET platform and the
[ArcGIS Pro SDK](https://pro.arcgis.com/en/pro-app/sdk/).

## Dependencies

This solution has the following external dependencies:

- [ArcGIS Pro SDK for .NET](https://github.com/Esri/arcgis-pro-sdk/wiki/ProGuide-Installation-and-Upgrade) (at least version 2.1.0.10257)
- [Json.NET](https://www.newtonsoft.com/json) (at least version 10.0.3)
- .NET Framework 4.6.1
- The `marklogic-ui` server running on `http://esri-koop.demo.marklogic.com:8099`.

## Installation and Setup

Download and install [Visual Studio 2017](https://www.visualstudio.com/vs/community/) (Community or higher edition).
Ensure that at least the **.NET desktop development** workload is selected when choosing your installation configuration.

Install both [ArcGIS Pro SDK for .NET](https://github.com/Esri/arcgis-pro-sdk/wiki/ProGuide-Installation-and-Upgrade)
Visual Studio Extensions by following the instructions [here](https://github.com/Esri/arcgis-pro-sdk/wiki/ProGuide-Installation-and-Upgrade).

## Building the Project
## Installation

### via Visual Studio
Open the `arcgis-ml-addin.sln` solution file in Visual Studio.
The add-in can be deployed to a Windows machine, virtual or otherwise, with an existing installation of ArcGIS Pro. It can be install for a single user or as shared for all users (more common).

Under the `Build` menu, select `Rebuild Solution`.
### Shared

> Note: The ArcGIS Pro SDK assembly references persist themselves as absolute paths in the .csproj project file.
> If you encounter unresolved assembly reference errors when building, this can be remedied by taking the following steps:
> - In `Solution Explorer`, find and right-click on the `MarkLogicAddIn` project file.
> - Select `Pro Fix References`. This will update the project file with the correct local paths.
> - Rebuild the solution.
The add-in can be deployed on a machine with multiple ArcGIS Pro users. This process installs the add-in to a location that allows the add-in files to be publicly accessible by all of the machine's users.

### Testing it out
#### Part 1

To use the add-in you must have a valid installation of [ArcGIS Pro](https://pro.arcgis.com) of at least version 2.1.
To setup the home location of the add-in for all machine users:

Building the solution automatically registers the add-in on your local ArcGIS Pro application.
Download the zip file for the [release](https://github.com/marklogic-community/marklogic-arcgis-pro-addin/releases) you want to install (this would have been done by you or someone else when a release was created).

You can run ArcGIS Pro normally or start it via debugging `Debug -> Start Debugging` or pressing `F5` in Visual Studio.
Open Windows Explorer and navigate to your system disk (usually C:) and the directory path `Users/Public/Public Documents`.

Create a new project in ArcGIS Pro. If the project has no map, add a new map.
Create directories that follow the path `ArcGIS/AddIns/arcgis-ml-addin`.

Open the `MarkLogic` ribbon tab and click on `Search`. This will open a new dock pane (to the right by default).
Copy the archive to the destination machine and extract the files into `ArcGIS/AddIns/arcgis-ml-addin`.

Enter a query in the search box, for example `ISIS or ISIL`.
> To update the add-in, simply download a new build, delete all files under `ArcGIS/AddIns/arcgis-ml-addin`, and extract the new files into the directory.
The add-in will connect to the `esri-koop` MarkLogic server and will display the points from the search on the map. If this
is the first time the add-in will establish a connection, it will prompt the user for credentials.
#### Part 2

Type in a layer name under `Save to New Layer` and press `Save`. This will save the recently search results into a feature layer.
To setup a machine user to use the add-in:

## Release
Open ArcGIS Pro. In the main screen, select `Project` in the upper-left hand corner of the window.

Build the solution using the `Release` configuration.
Select `Add-In Manager` then open the `Options` tab. Click on `Add Folder...` and select the `Users/Public/Public Documents/ArcGIS` folder.

## Installation
ArcGIS Pro may indicate the need to restart for the changes to take effect. If so, restart ArcGIS Pro.

The add-in can be deployed to a Windows machine, virtual or otherwise, with an existing installation of ArcGIS Pro.
Go back to `Add-In Manager` and verify that the `MarkLogic Search` add-in is present under Shared Add-Ins.

### Single User

To deploy the add-in for a single user:

Download the zip file for the release you want to install (this would have been done by you or someone else when a release was created).

Create an ZIP/archive of all the files in the `bin/Release` folder.
Download the zip file for the [release](https://github.com/marklogic-community/marklogic-arcgis-pro-addin/releases) you want to install (this would have been done by you or someone else when a release was created).

Copy the archive to the destination machine and extract the files into a temporary directory.

Expand All @@ -79,37 +54,60 @@ Open ArcGIS Pro. Confirm the add-in installation by looking for the `MarkLogic`

> This process will overwrite an older version of the add-in if it exists.
### Shared
## Installation and Setup for Development

The add-in can be deployed on a machine with multiple ArcGIS Pro users. The process is similar to the above, with the exception that the add-in files must be publicly accessible by all of the machine's users.
Follow these instructions if you want to develop new capabilities for the add-in.

#### Part 1
### Dependencies

To setup the home location of the add-in for all machine users:
This solution has the following external dependencies:

Download the zip file for the release you want to install (this would have been done by you or someone else when a release was created).
- [ArcGIS Pro SDK for .NET](https://github.com/Esri/arcgis-pro-sdk/wiki/ProGuide-Installation-and-Upgrade) (at least version 2.1.0.10257)
- [Json.NET](https://www.newtonsoft.com/json) (at least version 10.0.3)
- .NET Framework 4.6.1
- The `marklogic-ui` server running on `http://esri-koop.demo.marklogic.com:8099`.

Create an ZIP/archive of all the files in the `bin/Release` folder.
Download and install [Visual Studio 2017](https://www.visualstudio.com/vs/community/) (Community or higher edition).
Ensure that at least the **.NET desktop development** workload is selected when choosing your installation configuration.

Open Windows Explorer and navigate to your system disk (usually C:) and the directory path `Users/Public/Public Documents`.
Install both [ArcGIS Pro SDK for .NET](https://github.com/Esri/arcgis-pro-sdk/wiki/ProGuide-Installation-and-Upgrade)
Visual Studio Extensions by following the instructions [here](https://github.com/Esri/arcgis-pro-sdk/wiki/ProGuide-Installation-and-Upgrade).

Create directories that follow the path `ArcGIS/AddIns/arcgis-ml-addin`.
### Building the Project

Copy the archive to the destination machine and extract the files into `ArcGIS/AddIns/arcgis-ml-addin`.
#### via Visual Studio
Open the `arcgis-ml-addin.sln` solution file in Visual Studio.

> To update the add-in, simply create a new build, delete all files under `ArcGIS/AddIns/arcgis-ml-addin`, and extract the new files into the directory.
Under the `Build` menu, select `Rebuild Solution`.

#### Part 2
> Note: The ArcGIS Pro SDK assembly references persist themselves as absolute paths in the .csproj project file.
> If you encounter unresolved assembly reference errors when building, this can be remedied by taking the following steps:
> - In `Solution Explorer`, find and right-click on the `MarkLogicAddIn` project file.
> - Select `Pro Fix References`. This will update the project file with the correct local paths.
> - Rebuild the solution.
To setup a machine user to use the add-in:
### Testing it out

Open ArcGIS Pro. In the main screen, select `Project` in the upper-left hand corner of the window.
To use the add-in you must have a valid installation of [ArcGIS Pro](https://pro.arcgis.com) of at least version 2.1.

Select `Add-In Manager` then open the `Options` tab. Click on `Add Folder...` and select the `Users/Public/Public Documents/ArcGIS` folder.
Building the solution automatically registers the add-in on your local ArcGIS Pro application.

ArcGIS Pro may indicate the need to restart for the changes to take effect. If so, restart ArcGIS Pro.
You can run ArcGIS Pro normally or start it via debugging `Debug -> Start Debugging` or pressing `F5` in Visual Studio.

Go back to `Add-In Manager` and verify that the `MarkLogic Search` add-in is present under Shared Add-Ins.
Create a new project in ArcGIS Pro. If the project has no map, add a new map.

Open the `MarkLogic` ribbon tab and click on `Search`. This will open a new dock pane (to the right by default).

Enter a query in the search box, for example `ISIS or ISIL`.

The add-in will connect to the `esri-koop` MarkLogic server and will display the points from the search on the map. If this
is the first time the add-in will establish a connection, it will prompt the user for credentials.

Type in a layer name under `Save to New Layer` and press `Save`. This will save the recently search results into a feature layer.

### Release

Build the solution using the `Release` configuration.



Expand Down

0 comments on commit 98cc6e3

Please sign in to comment.