Here are Python scripts and sample configuration files that can be used to automate the creation of Excalibur Imagery Projects.
For more information about Excalibur and Imagery Projects see the Resources section.
- Sample JSON files that define an Imagery Project
- Sample JSON files that define overall configuration definitions for running the scripts
- Python scripts that create an Imagery Project in a portal
- Fork and then clone this repository to your machine. Or download it as a zip file and extract the contents to your machine.
- Make sure you have all the requirements.
- Copy and edit the configuration files.
- Run the script to create the project.
Detailed instructions are in the Creating a project section.
The scripts require Python 3 to be installed on your machine. The scripts were developed using Python version 3.8.6. Python 3 is already installed on your machine if you are running ArcGIS Pro. To see if Python is installed, open a terminal and run the command python. If installed, you will see the version of Python displayed and be at a command prompt for entering Python commands.
If Python is not installed on your machine, you can download the version for your OS from the Python download site. It is recommended to add the path to the Python executable to the Paths on your machine. Once installed, open a terminal and run the command python and make sure it runs without errors.
Connections to the portal and content creation are handled via the ArcGIS API for Python. You can get information about it at the API site. Detailed instructions for installing the API are here.
Excalibur is a Portal application that is supported on ArcGIS Enterprise version 10.7 and higher. To run the scripts, you must be a user on an ArcGIS Enterprise instance and you must have permissions to create new items.
- logging.conf: This is the configuration file for the logger. You do not need to update it.
- paths-sample.json: This holds the path to the directory where the project configuration files are stored and also the url to your portal. You will need to make a copy of it and name it paths.json
This is where the logs are written. The current log file is named excalibur.log. Logs are set to rotate when a log file reaches 500k and 2 backups are kept.
This is where the JSON files defining a project are stored. Samples are provided. You will need to make new JSON files and follow the samples to define your own projects
Contains the two Python scripts that write the project to the portal and the script that connects to the portal using the supplied credentials.
- Make a copy of
config/paths-sample.jsonand name it paths.json. - Update the
SHARING_URLproperty to point to your portal. Make sure the url ends insharing/rest.
NOTE: In config/paths-sample.json there is a property named 'VERIFY_SSL'. This is used to turn on/off SSL verification for http requests made by the 'requests' library. If running the script in a development environment, it might be necessary to set the flag to false
- Copy one of the JSON files in the
projectsdirectory and name it anything. - Update the JSON to describe your project. See the Project definition schema section for details about the JSON schema.
- Open a terminal and go to the directory where you cloned the repository or extracted the zip file contents, and then go to the scripts directory.
- From the scripts directory, run
python runCreateProject.py -h. This shows the arguments. They are- The name of the project JSON file. This must be the first argument
- Optional arguments:
- -s or --sharingurl: The url to the portal's REST endpoint. If the argument is not specified, the url in the
SHARING_URLproperty ofconfig/paths.jsonis used. - -u or --user: Your portal username. If the argument is not specified you get prompted for it.
- -p or --password: Your portal user's password. If the argument is not specified you get prompted for it.
- -o or --orgshare:
True/Falseflag for sharing the project item with the organization. Default isFalse(do not share it).
- -s or --sharingurl: The url to the portal's REST endpoint. If the argument is not specified, the url in the
- If the script runs successfully, you will see a console log in the terminal that has the item id of the Excalibur Imagery Project's portal item.
The properties for an imagery project. The primaryLayers entries are objects and their schema is described below.
| Name | Description | Type | Required | Default |
|---|---|---|---|---|
| title | The main display title for the project | string | Yes | |
| summary | A short summary of the project | string | No | There is no default so it is suggested to supply a summary |
| description | A more detailed description of the project | string | No | No default |
| instructions | Instructions for the person who is going to be working with the project | string | Yes | |
| webmapId | The item id of a webmap in the portal | string | No | If the webmapId is not specified, the user's default basemap is used |
| primaryLayers | Array of descriptors for an imagery layer. Currently only one layer is supported. See below for the schema | Array of Focus Image Layer | Yes |
Supported service types at versions of Excalibur
- ArcGIS Image Service - as of
v1.0 - ArcGIS Map Image Service - as of
v3.0 - ArcGIS Oriented Image Service - as of
v3.1 - ArcGIS Tiled Imagery Service - as of
v3.0 - ArcGIS Tiled Map Service - as of
v3.0 - Video Service - as of
v3.1 - WCS Service - as of
v11.5of Enterprise - WMS Service - as of
v2.1 - WMTS Service - as of
v2.1
The properties for the objects in the primaryLayers array.
| Name | Description | Type | Required | Default |
|---|---|---|---|---|
| serviceType | The type of service used for the layer. The options are image for an ArcGIS Image Service, mapImage for an ArcGIS Map Image Service, oriented-imagery for an ArcGIS Oriented Image Service, tile for an ArcGIS Tiled Map Service, tiledimagery for an ArcGiS Tiled Imagery Service, video for a Video Service, wcs for an OGC WCS Service, wms for an OGC WMS Service, wmts for an OGC WMTS Service |
Yes | ||
| itemId | The id of the portal item corresponding to the layer. The item must be in the same portal that the Excalibur application is running in | string | No (either itemId or serviceUrl must be specified) |
|
| serviceUrl | Url to the service | string | No (either itemId or serviceUrl must be specified) |
|
| rasterIds | These are the ids of images in an ArcGIS Image Service. If specified, the layer will be configured to show only the specified images. Only valid when serviceType is image |
number[] | No | [] |
| layerNames | An array of strings. These are the sublayer names in a WMS or WMTS Service. If specified, the layer will be configured to show only the specified sublayers. Only valid when serviceType is wms or wmts. WMTS layers only support displaying ONE sublayer. |
string[] | No | [] |
{
"title": "A simple imagery project",
"summary": "A simple project with just a focus image layer",
"description": "",
"instructions": "Look for damage",
"primaryLayers": [
{
"serviceType": "image",
"serviceUrl": "https://server/service-name/ImageServer",
"rasterIds": [],
"layerNames": []
}
]
}
{
"title": "A simple imagery project",
"summary": "A simple project with just a focus image layer",
"description": "",
"instructions": "Look for damage",
"primaryLayers": [
{
"serviceType": "arcgis",
"serviceUrl": "https://server/service-name/ImageServer",
"rasterIds": [1, 2, 3],
"layerNames": []
}
]
}
{
"title": "A simple video project",
"summary": "A simple project with just a video layer",
"description": "",
"instructions": "Look for damage",
"primaryLayers": [
{
"serviceType": "video",
"itemId": "27e891821878434eb06123d2bc9bd76b",
"rasterIds": [],
"layerNames": []
}
]
}
{
"title": "A simple imagery project",
"summary": "A simple project with a WMS layer",
"description": "",
"instructions": "Look for damage",
"primaryLayers": [
{
"serviceType": "wms",
"serviceUrl": "https://server/service-name",
"rasterIds": [],
"layerNames": []
}
]
}
{
"title": "A simple imagery project",
"summary": "A simple project with a WMS layer",
"description": "",
"instructions": "Look for damage",
"primaryLayers": [
{
"serviceType": "wms",
"serviceUrl": "https://server/service-name",
"rasterIds": []
"layerNames": ["damage0102", "damage0104"]
}
]
}
NOTE: WMTS service layers are cached and ONLY ONE can be displayed as the focus image layer in a project. So the layerNames property can only have one layer name.
{
"title": "A simple imagery project",
"summary": "A simple project with a WMTS layer",
"description": "",
"instructions": "Look for weather",
"primaryLayers": [
{
"serviceType": "wmts",
"serviceUrl": "https://server/service-name",
"rasterIds": []
"layerNames": ["radar-base-reflectivity"]
}
]
}
- Getting started with Excalibur
- Overview of Excalibur Imagery Projects
Find a bug or want to request a new feature? Please let us know by submitting an issue.
Esri welcomes contributions from anyone and everyone. Please see our guidelines for contributing.
Copyright 2020 Esri
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
A copy of the license is available in the repository's License.txt file.