to forward only the request that exactly matches the url
35 | * 'token' = token to include for secured service, if any, otherwise leave it
36 | * empty
37 | */
38 | $serverUrls = array(
39 | array( 'url' => 'http://localhost/', 'matchAll' => true, 'token' => '' ),
40 | array( 'url' => 'https://localhost/', 'matchAll' => true, 'token' => '' ),
41 | array( 'url' => 'https://test.com/', 'matchAll' => true, 'token' => '' ),
42 | array( 'url' => 'http://test.com/', 'matchAll' => true, 'token' => '' ),
43 | array( 'url' => 'http://servicesbeta.esri.com/', 'matchAll' => true, 'token' => '' ),
44 | array( 'url' => 'https://servicesbeta.esri.com/', 'matchAll' => true, 'token' => '' ),
45 | array( 'url' => 'https://www.arcgis.com/sharing/', 'matchAll' => true, 'token' => '' ),
46 | array( 'url' => 'http://www.arcgis.com/sharing/', 'matchAll' => true, 'token' => '' ),
47 | array( 'url' => 'http://sampleserver1.arcgisonline.com/ArcGIS/rest/services/', 'matchAll' => true, 'token' => '' ),
48 | array( 'url' => 'http://sampleserver2.arcgisonline.com/ArcGIS/rest/services/', 'matchAll' => true, 'token' => '' ),
49 | array( 'url' => 'http://sampleserver1a.arcgisonline.com/arcgisoutput/', 'matchAll' => true, 'token' => '' ),
50 | array( 'url' => 'http://sampleserver1b.arcgisonline.com/arcgisoutput/', 'matchAll' => true, 'token' => '' ),
51 | array( 'url' => 'http://sampleserver1c.arcgisonline.com/arcgisoutput/', 'matchAll' => true, 'token' => '' )
52 | );
53 | /***************************************************************************/
54 |
55 | function is_url_allowed($allowedServers, $url) {
56 | $isOk = false;
57 | $url = trim($url, "\/");
58 | for ($i = 0, $len = count($allowedServers); $i < $len; $i++) {
59 | $value = $allowedServers[$i];
60 | $allowedUrl = trim($value['url'], "\/");
61 | if ($value['matchAll']) {
62 | if (stripos($url, $allowedUrl) === 0) {
63 | $isOk = $i; // array index that matched
64 | break;
65 | }
66 | }
67 | else {
68 | if ((strcasecmp($url, $allowedUrl) == 0)) {
69 | $isOk = $i; // array index that matched
70 | break;
71 | }
72 | }
73 | }
74 | return $isOk;
75 | }
76 |
77 | // check if the curl extension is loaded
78 | if (!extension_loaded("curl")) {
79 | header('Status: 500', true, 500);
80 | echo 'cURL extension for PHP is not loaded!
Add the following lines to your php.ini file:
extension_dir = "<your-php-install-location>/ext"
extension = php_curl.dll';
81 | return;
82 | }
83 |
84 | $targetUrl = $_SERVER['QUERY_STRING'];
85 | if (!$targetUrl) {
86 | header('Status: 400', true, 400); // Bad Request
87 | echo 'Target URL is not specified!
Usage:
http://<this-proxy-url>?<target-url>';
88 | return;
89 | }
90 |
91 | $parts = preg_split("/\?/", $targetUrl);
92 | $targetPath = $parts[0];
93 |
94 | // check if the request URL matches any of the allowed URLs
95 | if ($mustMatch) {
96 | $pos = is_url_allowed($serverUrls, $targetPath);
97 | if ($pos === false) {
98 | header('Status: 403', true, 403); // Forbidden
99 | echo 'Target URL is not allowed!
Consult the documentation for this proxy to add the target URL to its Whitelist.';
100 | return;
101 | }
102 | }
103 |
104 | // add token (if any) to the url
105 | $token = $serverUrls[$pos]['token'];
106 | if ($token) {
107 | $targetUrl .= (stripos($targetUrl, "?") !== false ? '&' : '?').'token='.$token;
108 | }
109 |
110 | // open the curl session
111 | $session = curl_init();
112 |
113 | // set the appropriate options for this request
114 | $options = array(
115 | CURLOPT_URL => $targetUrl,
116 | CURLOPT_HEADER => false,
117 | CURLOPT_HTTPHEADER => array(
118 | 'Content-Type: ' . $_SERVER['CONTENT_TYPE'],
119 | 'Referer: ' . $_SERVER['HTTP_REFERER']
120 | ),
121 | CURLOPT_RETURNTRANSFER => true,
122 | CURLOPT_FOLLOWLOCATION => true
123 | );
124 |
125 | // put the POST data in the request body
126 | $postData = file_get_contents("php://input");
127 | if (strlen($postData) > 0) {
128 | $options[CURLOPT_POST] = true;
129 | $options[CURLOPT_POSTFIELDS] = $postData;
130 | }
131 | curl_setopt_array($session, $options);
132 |
133 | // make the call
134 | $response = curl_exec($session);
135 | $code = curl_getinfo($session, CURLINFO_HTTP_CODE);
136 | $type = curl_getinfo($session, CURLINFO_CONTENT_TYPE);
137 | curl_close($session);
138 |
139 | // set the proper Content-Type
140 | header("Status: ".$code, true, $code);
141 | header("Content-Type: ".$type);
142 |
143 | echo $response;
144 | ?>
145 |
--------------------------------------------------------------------------------
/javascript/SearchSources.js:
--------------------------------------------------------------------------------
1 | define(["dojo/_base/declare", "dojo/_base/lang", "dojo/_base/array", "dojo/_base/json", "dojo/dom-construct", "esri/lang", "esri/tasks/locator", "esri/layers/FeatureLayer", "esri/dijit/Search"], function (
2 | declare, lang, array, dojoJson, domConstruct, esriLang, Locator, FeatureLayer, Search) {
3 | return declare(null, {
4 |
5 | constructor: function (parameters) {
6 |
7 | var defaults = {
8 | sources: [],
9 | map: null,
10 | //the map
11 | useMapExtent: false,
12 | //When true we restrict world locator to the map extent
13 | geocoders: [],
14 | esriSource: null,
15 | enableSearchingAll: true,
16 | //Geocoders defined in helper services
17 | itemData: null,
18 | //web map item info includes operational layers and info about searches configured on web map
19 | configuredSearchLayers: []
20 | };
21 |
22 | lang.mixin(this, defaults, parameters);
23 | },
24 |
25 | /* Public Methods */
26 |
27 | createOptions: function () {
28 | return {
29 | map: this.map,
30 | sources: this._createSources(),
31 | enableSearchingAll: this.enableSearchingAll,
32 | activeSourceIndex: this._getActiveSource()
33 | };
34 | },
35 |
36 | /* Private Methods */
37 |
38 | //optional array of additional search layers to configure from the application config process
39 | _createSources: function () {
40 | if (this.applicationConfiguredSources) {
41 | this._createAppConfigSources();
42 | } else {
43 | //Create services from org helper services
44 | //Create locators defined in web map item
45 | //Create configured services.
46 | this._createHelperServiceSources();
47 | if (this.itemData) {
48 | this._createWebMapItemSources();
49 | }
50 | if (this.configuredSearchLayers.length > 0) {
51 | this._createConfiguredSources();
52 | }
53 | }
54 |
55 | return this.sources;
56 | },
57 |
58 | _getActiveSource: function () {
59 | var activeIndex = 0;
60 | if (this.hasOwnProperty("activeSourceIndex")) {
61 | activeIndex = this.activeSourceIndex;
62 | }
63 | else{
64 | if (this.sources && this.enableSearchingAll && this.sources.length > 1) {
65 | activeIndex = "all";
66 | }
67 | array.some(this.sources, function (s, index) {
68 | if (!s.hasEsri && s.featureLayer) {
69 | activeIndex = index;
70 | return true;
71 | }
72 | });
73 | }
74 | return activeIndex;
75 | },
76 | _createHelperServiceSources: function () {
77 | var geocoders = lang.clone(this.geocoders);
78 | array.forEach(geocoders, lang.hitch(this, function (geocoder) {
79 | if (geocoder.url.indexOf(".arcgis.com/arcgis/rest/services/World/GeocodeServer") > -1) {
80 | var s = new Search();
81 | var esriSource = s.defaultSource;
82 | esriSource.hasEsri = true;
83 | //Some orgs have the Esri world locator added with
84 | //a custom name defined. Use that name.
85 | if (geocoder.name) {
86 | esriSource.name = geocoder.name;
87 | }
88 | //Restrict search to custom extent if defined
89 | if (this.useMapExtent) {
90 | esriSource.searchExtent = this.map.extent;
91 | }
92 | this.sources.push(esriSource);
93 | s.destroy();
94 | } else if (esriLang.isDefined(geocoder.singleLineFieldName)) {
95 | geocoder.locator = new Locator(geocoder.url);
96 | this.sources.push(geocoder);
97 | }
98 | }));
99 | },
100 |
101 | _createWebMapItemSources: function () {
102 | if (this.itemData && this.itemData.applicationProperties && this.itemData.applicationProperties.viewing && this.itemData.applicationProperties.viewing.search) {
103 | //search is configured on the web map item
104 | var searchOptions = this.itemData.applicationProperties.viewing.search;
105 | array.forEach(searchOptions.layers, lang.hitch(this, function (searchLayer) {
106 | //get the title specified in the item
107 | var operationalLayers = this.itemData.operationalLayers,
108 | layer = null;
109 | array.some(operationalLayers, function (opLayer) {
110 | if (opLayer.id === searchLayer.id) {
111 | layer = opLayer;
112 | return true;
113 | }
114 | });
115 | if (layer && layer.hasOwnProperty("url")) {
116 | var source = {},
117 | url = layer.url,
118 | name = layer.title || layer.name;
119 | if (esriLang.isDefined(searchLayer.subLayer)) {
120 | url = url + "/" + searchLayer.subLayer;
121 | array.some(layer.layerObject.layerInfos, function (info) {
122 | if (info.id === searchLayer.subLayer) {
123 | name += " - " + layer.layerObject.layerInfos[searchLayer.subLayer].name;
124 | return true;
125 | }
126 | });
127 | }
128 | //Get existing layer or create new one
129 | var mapLayer = this.map.getLayer(layer.id);
130 | if (mapLayer && (mapLayer.type === "Feature Layer" || mapLayer.type === "FeatureLayer")) {
131 | source.featureLayer = mapLayer;
132 | } else {
133 | source.featureLayer = new FeatureLayer(url, {
134 | outFields: ["*"]
135 | });
136 | }
137 | source.name = name;
138 | source.exactMatch = searchLayer.field.exactMatch;
139 | source.searchFields = [searchLayer.field.name];
140 | source.displayField = searchLayer.field.name;
141 | source.outFields = ["*"];
142 | source.placeholder = searchOptions.hintText;
143 | this.sources.push(source);
144 | }
145 | }));
146 | }
147 | },
148 | _createAppConfigSources: function () {
149 | // Configured via the new Search Configuation widget
150 | var configSource = lang.clone(this.applicationConfiguredSources);
151 | array.forEach(configSource, lang.hitch(this, function (source) {
152 | if (source.locator) {
153 | source.locator = new Locator(source.url);
154 | } else { //feature layer
155 | var featureLayer = null;
156 | if (source.flayerId) {
157 | featureLayer = this.map.getLayer(source.flayerId);
158 | }
159 | if (!featureLayer && source.url) {
160 | featureLayer = new FeatureLayer(source.url, {
161 | outFields: ["*"]
162 | });
163 | }
164 | source.featureLayer = featureLayer;
165 | }
166 | if (source.searchWithinMap) {
167 | source.searchExtent = this.map.extent;
168 | }
169 | this.sources.push(source);
170 | }));
171 |
172 | },
173 | _createConfiguredSources: function () {
174 | // Old configuration using layer/field picker
175 | array.forEach(this.configuredSearchLayers, lang.hitch(this, function (layer) {
176 | var mapLayer = this.map.getLayer(layer.id);
177 | if (mapLayer) {
178 | var source = {};
179 | source.featureLayer = mapLayer;
180 | if (layer.fields && layer.fields.length && layer.fields.length > 0) {
181 | source.searchFields = layer.fields;
182 | source.displayField = layer.fields[0];
183 | source.outFields = ["*"];
184 | this.sources.push(source);
185 | }
186 | }
187 | }));
188 | }
189 |
190 | });
191 | });
--------------------------------------------------------------------------------
/proxy/proxy.ashx:
--------------------------------------------------------------------------------
1 | <%@ WebHandler Language="C#" Class="proxy" %>
2 | /*
3 | This proxy page does not have any security checks. It is highly recommended
4 | that a user deploying this proxy page on their web server, add appropriate
5 | security checks, for example checking request path, username/password, target
6 | url, etc.
7 | */
8 | using System;
9 | using System.Drawing;
10 | using System.IO;
11 | using System.Web;
12 | using System.Collections.Generic;
13 | using System.Text;
14 | using System.Xml.Serialization;
15 | using System.Web.Caching;
16 |
17 | ///
18 | /// Forwards requests to an ArcGIS Server REST resource. Uses information in
19 | /// the proxy.config file to determine properties of the server.
20 | ///
21 | public class proxy : IHttpHandler {
22 |
23 | public void ProcessRequest (HttpContext context) {
24 |
25 | HttpResponse response = context.Response;
26 |
27 | // Get the URL requested by the client (take the entire querystring at once
28 | // to handle the case of the URL itself containing querystring parameters)
29 | string uri = context.Request.Url.Query.Substring(1);
30 |
31 | // Get token, if applicable, and append to the request
32 | string token = getTokenFromConfigFile(uri);
33 | if (!String.IsNullOrEmpty(token))
34 | {
35 | if (uri.Contains("?"))
36 | uri += "&token=" + token;
37 | else
38 | uri += "?token=" + token;
39 | }
40 |
41 | System.Net.HttpWebRequest req = (System.Net.HttpWebRequest)System.Net.HttpWebRequest.Create(uri);
42 | req.Method = context.Request.HttpMethod;
43 | req.ServicePoint.Expect100Continue = false;
44 |
45 | // Set body of request for POST requests
46 | if (context.Request.InputStream.Length > 0)
47 | {
48 | byte[] bytes = new byte[context.Request.InputStream.Length];
49 | context.Request.InputStream.Read(bytes, 0, (int)context.Request.InputStream.Length);
50 | req.ContentLength = bytes.Length;
51 |
52 | string ctype = context.Request.ContentType;
53 | if (String.IsNullOrEmpty(ctype)) {
54 | req.ContentType = "application/x-www-form-urlencoded";
55 | }
56 | else {
57 | req.ContentType = ctype;
58 | }
59 |
60 | using (Stream outputStream = req.GetRequestStream())
61 | {
62 | outputStream.Write(bytes, 0, bytes.Length);
63 | }
64 | }
65 |
66 | // Send the request to the server
67 | System.Net.WebResponse serverResponse = null;
68 | try
69 | {
70 | serverResponse = req.GetResponse();
71 | }
72 | catch (System.Net.WebException webExc)
73 | {
74 | response.StatusCode = 500;
75 | response.StatusDescription = webExc.Status.ToString();
76 | response.Write(webExc.Response);
77 | response.End();
78 | return;
79 | }
80 |
81 | // Set up the response to the client
82 | if (serverResponse != null) {
83 | response.ContentType = serverResponse.ContentType;
84 | using (Stream byteStream = serverResponse.GetResponseStream())
85 | {
86 |
87 | // Text response
88 | if (serverResponse.ContentType.Contains("text") ||
89 | serverResponse.ContentType.Contains("json"))
90 | {
91 | using (StreamReader sr = new StreamReader(byteStream))
92 | {
93 | string strResponse = sr.ReadToEnd();
94 | response.Write(strResponse);
95 | }
96 | }
97 | else
98 | {
99 | // Binary response (image, lyr file, other binary file)
100 | BinaryReader br = new BinaryReader(byteStream);
101 | byte[] outb = br.ReadBytes((int)serverResponse.ContentLength);
102 | br.Close();
103 |
104 | // Tell client not to cache the image since it's dynamic
105 | response.CacheControl = "no-cache";
106 |
107 | // Send the image to the client
108 | // (Note: if large images/files sent, could modify this to send in chunks)
109 | response.OutputStream.Write(outb, 0, outb.Length);
110 | }
111 |
112 | serverResponse.Close();
113 | }
114 | }
115 | response.End();
116 | }
117 |
118 | public bool IsReusable {
119 | get {
120 | return false;
121 | }
122 | }
123 |
124 | // Gets the token for a server URL from a configuration file
125 | // TODO: ?modify so can generate a new short-lived token from username/password in the config file
126 | private string getTokenFromConfigFile(string uri)
127 | {
128 | try
129 | {
130 | ProxyConfig config = ProxyConfig.GetCurrentConfig();
131 | if (config != null)
132 | return config.GetToken(uri);
133 | else
134 | throw new ApplicationException(
135 | "Proxy.config file does not exist at application root, or is not readable.");
136 | }
137 | catch (InvalidOperationException)
138 | {
139 | // Proxy is being used for an unsupported service (proxy.config has mustMatch="true")
140 | HttpResponse response = HttpContext.Current.Response;
141 | response.StatusCode = (int)System.Net.HttpStatusCode.Forbidden;
142 | response.End();
143 | }
144 | catch (Exception e)
145 | {
146 | if (e is ApplicationException)
147 | throw e;
148 |
149 | // just return an empty string at this point
150 | // -- may want to throw an exception, or add to a log file
151 | }
152 |
153 | return string.Empty;
154 | }
155 | }
156 |
157 | [XmlRoot("ProxyConfig")]
158 | public class ProxyConfig
159 | {
160 | #region Static Members
161 |
162 | private static object _lockobject = new object();
163 |
164 | public static ProxyConfig LoadProxyConfig(string fileName)
165 | {
166 | ProxyConfig config = null;
167 |
168 | lock (_lockobject)
169 | {
170 | if (System.IO.File.Exists(fileName))
171 | {
172 | XmlSerializer reader = new XmlSerializer(typeof(ProxyConfig));
173 | using (System.IO.StreamReader file = new System.IO.StreamReader(fileName))
174 | {
175 | config = (ProxyConfig)reader.Deserialize(file);
176 | }
177 | }
178 | }
179 |
180 | return config;
181 | }
182 |
183 | public static ProxyConfig GetCurrentConfig()
184 | {
185 | ProxyConfig config = HttpRuntime.Cache["proxyConfig"] as ProxyConfig;
186 | if (config == null)
187 | {
188 | string fileName = GetFilename(HttpContext.Current);
189 | config = LoadProxyConfig(fileName);
190 |
191 | if (config != null)
192 | {
193 | CacheDependency dep = new CacheDependency(fileName);
194 | HttpRuntime.Cache.Insert("proxyConfig", config, dep);
195 | }
196 | }
197 |
198 | return config;
199 | }
200 |
201 | public static string GetFilename(HttpContext context)
202 | {
203 | return context.Server.MapPath("~/proxy.config");
204 | }
205 | #endregion
206 |
207 | ServerUrl[] serverUrls;
208 | bool mustMatch;
209 |
210 | [XmlArray("serverUrls")]
211 | [XmlArrayItem("serverUrl")]
212 | public ServerUrl[] ServerUrls
213 | {
214 | get { return this.serverUrls; }
215 | set { this.serverUrls = value; }
216 | }
217 |
218 | [XmlAttribute("mustMatch")]
219 | public bool MustMatch
220 | {
221 | get { return mustMatch; }
222 | set { mustMatch = value; }
223 | }
224 |
225 | public string GetToken(string uri)
226 | {
227 | foreach (ServerUrl su in serverUrls)
228 | {
229 | if (su.MatchAll && uri.StartsWith(su.Url, StringComparison.InvariantCultureIgnoreCase))
230 | {
231 | return su.Token;
232 | }
233 | else
234 | {
235 | if (String.Compare(uri, su.Url, StringComparison.InvariantCultureIgnoreCase) == 0)
236 | return su.Token;
237 | }
238 | }
239 |
240 | if (mustMatch)
241 | throw new InvalidOperationException();
242 |
243 | return string.Empty;
244 | }
245 | }
246 |
247 | public class ServerUrl
248 | {
249 | string url;
250 | bool matchAll;
251 | string token;
252 |
253 | [XmlAttribute("url")]
254 | public string Url
255 | {
256 | get { return url; }
257 | set { url = value; }
258 | }
259 |
260 | [XmlAttribute("matchAll")]
261 | public bool MatchAll
262 | {
263 | get { return matchAll; }
264 | set { matchAll = value; }
265 | }
266 |
267 | [XmlAttribute("token")]
268 | public string Token
269 | {
270 | get { return token; }
271 | set { token = value; }
272 | }
273 | }
274 |
--------------------------------------------------------------------------------
/readme.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Public Gallery Template - Read Me
5 |
34 |
35 |
36 | This template provides a starting point for creating your Web application. This easily configurable template allows you to define options for displaying a group. This read-me file explains how to setup and configure the template to run on your web server. We have also provided a few tips on how to personalize the template by adding a company logo and customizing the content.
37 | Table of Contents
38 |
51 | Install the Web application
52 | These instructions assume that you have a Web server like Internet Information Services(IIS) installed and setup on your machine. If you are using another Web server, the general installation steps will be the same, but you will need to check your Web server's documentation for specific information on deploying and testing the application.
53 |
54 | - Copy the contents of the zip file into your web server's root directory. In IIS, the default location for the web server's root folder is
c:\inetpub\wwwroot.
55 | - If your application edits the features in a feature service, enables the elevation chart, contains secure services or web maps that aren't publicly shared or generates requests that exceed 2000 characters you may need to setup and use a proxy page. One example where you may exceed the URL length is by using complex polygons as an input to a task. Another example is by specifying a spatial reference using well-known text (wkt).
56 | View the Using the proxy page help topic for details on installing and configuring a proxy page. After setting up the proxy, set the proxyUrl option in index.html to point to your proxy.
57 | - Test the page using the following URL: http://localhost/[template name]/index.html, where [template name] is the name of the folder where you extracted the zip contents.
58 |
59 | Top
60 |
61 | Now let's configure the application to use a different group and modify configuration options.
62 |
63 | -
64 |
Every group on ArcGIS.com has a unique identifier (id). To find the group's id, navigate to ArcGIS.com, and find the group you want to display. If it is one of your groups, make sure it's shared with everyone (public).
65 | To find the group's id:
66 |
67 | - Option 1:
68 |
69 | - Use the sample ArcGIS Online Group ID Finder demo which searches for groups by ArcGIS Online username. You can get private group ID's by using the "Sign In" link on the demo tool to log into your account and display your private groups. ArcGIS Online Group ID Finder
70 |
71 |
72 | - Option 2:
73 |
74 | - Navigate to the group's page.
75 | - Right-click on the group's image to copy it's URL location or open it's location in a new tab/window.
76 |
77 |
78 | - View the URL and copy the id as highlighted in the URL. The section you need to copy is highlighted in the image below.
79 |
80 |
81 |
82 |
83 |
84 | - Open the "/config/options.js" file in a text editor. The "/config/options.js" file is located in the config folder in the root directory of this application.
85 | - To modify the group, replace the string for id with your group's id.
86 |
87 |
88 | "group":"4a6f9fdc83ce44b6985115e4bd73cacd"
89 |
90 |
92 | - By default, the application displays the ArcGIS.com group's title as the application's home heading, the group's summary as the application's home snippet and the group's description as the application's home side content. You can overwrite these by setting the following properties:
93 |
94 |
95 | "homeHeading":"This is a custom title for your home page",
96 | "homeSnippet":"This is a custom summary for home map",
97 | "homeSideContent":"This is a custom description for your home page",
98 |
99 |
101 | - By default, the application displays the ArcGIS.com map's title as the application's title and the map's summary as the application's subtitle. You can overwrite these by setting the following properties:
102 |
103 |
104 | "mapTitle":"This is a custom title for your map",
105 | "mapSnippet":"This is a custom subtitle",
106 | "mapItemDescription":"This is a custom description",
107 |
108 |
110 | - You can edit this file to set the following application properties:
111 |
112 | - appid: ID of application on ArcGIS.com containing your settings for this template.
113 | - theme: Color theme to use. Options are "blueTheme", "redTheme" or "greenTheme".
114 | - siteTitle: The name of your website.
115 | - siteBannerImage: URL for logo image. If empty, Site Title text is used in its place.
116 | - mapTitle: If not specified, the ArcGIS.com map's title is used.
117 | - mapSnippet: If not specified, the ArcGIS.com web map's summary is used
118 | - mapItemDescription: Displayed in the about section of the map page. Defaults to map description.
119 | - homeHeading: Heading displayed on the index page. Uses group title by default.
120 | - homeSnippet: Summary displayed on the index page. Uses group summary by default.
121 | - homeSideHeading: Heading displayed on the side-content on the index page.
122 | - homeSideContent: Displayed on the side of the index page. Defaults to group description.
123 | - footerHeading: Heading displayed in the footer.
124 | - footerDescription: Content displayed in the footer.
125 | - footerLogo: Image displayed in the footer. Defaults to group image.
126 | - footerLogoUrl: Link used for the footer image. Defaults to link to group page on ArcGIS.com
127 | - addThisProfileId: Account ID for AddThis.com. Defaults to generic.
128 | - defaultLayout: Default layout to use. "grid" or "list".
129 | - searchString: Peforms a default search on the group with the set string.
130 | - sortField: Order to display the group items. Valid fields are: title, modified, type, owner, avgRating, numRatings, numComments and numViews.
131 | - sortOrder: Order to sort the group: "asc" or "desc".
132 | - mapViewer: URL to open the gallery items to. "simple", "explorer", "explorer_present", "arcgis".
133 | - galleryItemsPerPage: Number of gallery items to show per page.
134 | - showProfileUrl: Show link to user profile . true or false.
135 | - showSocialButtons: Show social media buttons. true or false.
136 | - showFooter: Show footer. true or false.
137 | - showBasemapGallery: Show basemap gallery on map: true or false.
138 | - showGroupSearch: Show group search on index: true or false.
139 | - showGroupSort: Show sorting bar for group.
140 | - showMapSearch: Show map search on map: true or false.
141 | - showLayerToggle: Show layer toggle on legend: true or false.
142 | - showLayoutSwitch: Show layout switch on index: true or false.
143 | - showOverviewMap: Show overview on map: true or false.
144 | - showMoreInfo: Show more info link in about on map: true or false.
145 | - showPagination: Show pagination on index: true or false.
146 | - showExplorerButton: Show explorer button on map: true or false.
147 | - showArcGISOnlineButton: Show ArcGIS button on map: true or false.
148 | - showLicenseInfo: Show Use Constraints on map page.
149 | - showAttribution: Show sources on map page.
150 | - showComments: Show comments on map page.
151 | - showRatings: Show ratings of items in group and on map page.
152 | - showMobileButtons: Show map buttons to open in the mobile app or download the mobile app: true or false.
153 | - openGalleryItemsNewWindow: Open WebMaps in a new window: true or false.
154 | - bannerBackground: Background image displayed in the center of the page banner.
155 | - proxyUrl: Proxy URL.
156 | - sharingurl: Portal sharing URL.
157 | - mobilePortalUrl: Mobile Portal URL.
158 | - pointGraphic: Graphic displayed when locating addresses.
159 |
160 |
161 | - Save the file then test your application and note that it now displays your group and if specified your custom properties.
162 |
163 | Top
164 | Personalize the application
165 | In this section, you will see how to personalize the application by adding a logo, adding custom HTMl to the footer, creating an Addthis.com account and developing a custom theme.
166 | Top
167 | Add a logo to the application
168 | You can personalize your site by adding a custom logo to the application's header next to the map title.
169 |
170 | - First make sure your image is 75 pixels high. It can be any width up to 940 pixels.
171 | - Copy your custom logo to the images subdirectory.
172 | - Open "/config/options.js" in a text editor.
173 | - Find the property of code that has siteBannerImage and add your image's title and extension.
174 |
175 |
176 | "siteBannerImage":"images/yourNewLogo.png",
177 |
178 |
180 | - Run the application. The custom logo should appear to the top navigation of the application's header.
181 |
182 |
183 |
184 | Top
185 | Add custom HTML to the footer
186 | You can insert HTML into many of the config values to further customize the template. However, the HTML needs to be escaped in order to be used in the config JSON.
187 |
188 | - Create your custom HTML.
189 | - Copy your custom HTML from a text editor.
190 | - Escape the HTML by using either the JavaScript String Escape or JavaScript String encoding tools.
191 | - Open "/config/options.js" in a text editor.
192 | - Paste escaped HTML into the config value.
193 |
194 |
195 | "footerDescription":"<div class=\"footerSmall\"><a href=\"\/about-esri\/contact.html\">Contact Us<\/a> | <a rel=\"nofollow\" href=\"\/legal\/privacy.html\">Privacy<\/a> | <a rel=\"nofollow\" href=\"\/legal\/index.html\">Legal<\/a> | <a href=\"\/site\/sitemap.html\">Site Map<\/a><\/div>",
196 |
197 |
199 | - Run the application and the custom HTML should appear.
200 |
201 |
202 |
203 | Top
204 | Setup an AddThis account for analytics
205 | You can create an account for the sharing plugin to get real-time analytics, weekly email reports, alerts, and more.
206 |
207 | - Go to AddThis.com and navigate to the register page.
208 | - After registering, go to your account settings.
209 |
210 |
211 | - Navigate to the profile page under account settings
212 | - Copy your "Profile ID" from the page.
213 |
214 |
215 | - Open "/config/options.js" in a text editor.
216 | - Paste Addthis.com account ID into the config value.
217 |
218 |
219 | "addThisProfileId":"Account Id",
220 |
221 |
223 | - Run the application. The application will now be using your AddThis account.
224 |
225 | Top
226 | Create a new custom theme
227 | You can personalize your site by creating a unique color scheme. This requires knowledge of CSS.
228 |
229 | - Open css/themes.css in a text editor.
230 | - Scroll to the bottom where the custom theme classes are defined.
231 | - Change wherever it says ".custom" and name it what you would like to give your theme.
232 | - Fill in all the empty CSS styles with how you'd like the theme styled.
233 | - Save the file.
234 | - Open "/config/options.js" in a text editor.
235 | - Find the property of code that has "theme" and add the title of your theme.
236 |
237 |
238 | "theme":"yourtheme",
239 |
240 |
242 | - Use the CSS Generator to create CSS3 compatible styles such as rounded borders, shadows, and background gradients.
243 | - Run the application and the custom theme should appear.
244 |
245 | Top
246 | Configure the template to work with your ArcGIS Portal
247 | You can use this template with your organization's ArcGIS Portal by setting a few configuration options.
248 |
249 | - Open "/config/options.js" in a text editor.
250 | - Locate the options for "sharingurl" and "mobilePortalUrl".
251 |
252 |
253 | "sharingurl":"http://www.arcgis.com/",
254 | "mobilePortalUrl":"arcgis://www.arcgis.com/",
255 |
256 |
258 | - Change these settings to point to your portal's URL instead of using ArcGIS.com's URL.
259 |
260 |
261 | "sharingurl":"http://www.myorg.com/",
262 | "mobilePortalUrl":"arcgis://www.myorg.com/",
263 |
264 |
266 | - Save the file.
267 | - Run the application and the template should be using your portal.
268 |
269 | Top
270 |
271 |
--------------------------------------------------------------------------------
