featureservice2trigger
A command line tool for creating Geotrigger Rules from an ArcGIS FeatureService.
Installation
Just install with NPM. You will need Node.js installed.
$ npm install -g featureservice2trigger
Usage
To print the full usage information just do...
$ featureservice2trigger
Here is an example of using featureservice2trigger to import a Feature Service of city parks.
$ featureservice2trigger --clientId=YOUR_CLIENT_ID --clientSecret=YOUR_CLIENT_SECRET --tag=parks --tag=portland --serviceUrl="http://services.arcgis.com/rOo16HdIMeOBI4Mb/arcgis/rest/services/Parks_pdx/FeatureServer/0" --notificationTemplate="Welcome to {{NAME}}"
Options
Many of these options refer to parameters in trigger/create method of the Geotrigger Service API. You should familiarize yourself with the parameters for trigger/create before using this script.
| Options | Description |
|---|---|
clientId |
Required Application client id - http://developers.arcgis.com/en/applications/. |
clientSecret |
Required Application client secret - http://developers.arcgis.com/en/applications/. |
serviceUrl |
Required The URL of the Feature Layer you would like to import. You can find urls for your existing services at http://developers.arcgis.com/en/hosted-data/. |
tag |
Required Tag or tags to apply to the triggers created in the Geotrigger API. You can define tag as many times as you like to apply multipile tags to each trigger. Tags can also be Mustache templates so a feature with {type: School}and a template like"type-{{type}}will turn intotype-school`. |
buffer |
If you are importing point features, buffer them by this amount to create the trigger area. Defaults to 250 meters. |
useFeatureIds |
Use the ids of the features as the id of the trigger. |
callbackUrl |
When the triggers condition is satisfied a POST request will be sent to this URL |
notificationTemplate |
A Mustache template for the push notification. Feature attributes will be passed into the template context. So a feature with attributes like {NAME: Mt. Tabor Park} and a template like "Welcome to {{NAME}} will turn into Welcome to Mt. Tabor Park. |
trackingProfile |
Changes the devices tracking profile to this when the trigger is fired. Should be off, adaptive, fine, or rough |
direction |
The direction the device shold be traveling to fire the trigger. Either enter or leave |
authenticate |
If the feature service you are trying to use requires authentication you must pass this flag to enable authentication. Defaults to false |
concurrency |
The number of concurrent requests that will run. Reduce if you see errors, increse to increse import speed. Defaults to 50 |
Notes
Feature Services should be hosted on arcgis.com or an on-premise ArcGIS Server 10.1 or higher. If you are using this with a feature service hosted on-premise the service must be publically accessible.
If you are using a feature service that is hosted on arcgis.com that is not shared publically you will need to pass --authenticate along with other options to authenticate and access the service.
Resources
Issues
Find a bug or want to request a new feature? Please let us know by submitting an issue.
Contributing
Esri welcomes contributions from anyone and everyone. Please see our guidelines for contributing.
Licensing
Copyright 2013 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.