Skip to main content

Configure a disconnected deployment for Custom Chart Builder

Available with Advanced license.

Available with ArcGIS Maritime license.

You can deploy Custom Chart Builder in a disconnected environment. This is necessary if there is no internet connection available or internet access is prohibited by your organization. Referenced sources must be replaced with locally available sources.

Note:

Registering the portal is required only for custom product types where the sign-in capability is needed to add data layers to your map.

Register your CCB app in portal

To add data from your portal, complete the following steps:

  1. Register your web app and get the app ID.

    Note:

    You can skip this step if your web app is configured for the Fixed Product type. For the Custom Product type, this is an optional setting. If you want to activate sign-in capability and add data from your ArcGIS organization account, this step is required.

  2. In File Explorer, browse to the ccbconfig.js file.

    If you are using Internet Information Server (IIS) the file is located at C:\inetpub\wwwroot\ccb\js.

  3. Open the ccbconfig.js file and update the appId value to the app ID of the web app you registered in step one.

  4. Click Save.

    The portal URL is updated for the app.

Update JavaScript files

If you registered the web app in your portal, complete the following steps below:

  1. Browse to the CCB folder in the web root folder.

    For example, browse to C:\inetpub\wwwroot\ccb if you are deploying the web app using Internet Information Server (IIS).

  2. In the widgets\AddData folder, open Widget.js.

  3. Add the portalUrl value by providing the URL of the organization to which you'll be sharing the app.

    For example, when providing the portal URL, if the machine hosting the web app is named portalserver with the domain domain.com and the web app is named arcgis, the URL would be https://portalserver.domain.com/arcgis.

  4. Click Save.

  5. In the widgets\LayerList folder, open Widget.js.

  6. In the appConfig section, update the portalUrl value to https://portalserver.domain.com/arcgis.

  7. Click Save.

  8. In the js folder, open SignInButton.js.

  9. Uncomment // portalUrl: "https://portalserver.domain.com/arcgis", and update the portalUrl value to the URL of your organization.

  10. Click Save.

    The portal URL is updated for the app.

Set ArcGIS API for JavaScript

Legacy:

ArcGIS API for JavaScript 3.31 is no longer available for download, however, it is available upon request.

To enable ArcGIS API for JavaScript in CCB, complete the following steps:

  1. Contact your distributor or the Maritime team to receive a copy of the API.

  2. Create an arcgis_js_api folder in the C:\inetpub\wwwroot\ccb\js folder if you are using IIS to deploy your web app.

  3. Copy the API library folder to C:\inetpub\wwwroot\ccb\js\arcgis_js_api\.

  4. Open the init.js file, located in the C:\inetpub\wwwroot\ccb\js\arcgis_js_api\library\3.31\3.31\ folder, in a text editor.

  5. Browse through the .js file and replace https://[HOSTNAME_AND_PATH_TO_JSAPI]dojo with https://gisserver.domain.com/ccb/js/arcgis_js_api/library/3.31/3.31/dojo.

  6. Click Save and close the init.js file.

  7. Open the dojo.js file, located in the C:\inetpub\wwwroot\ccb\js\arcgis_js_api\library\3.31\3.31\dojo\ folder, in a text editor.

  8. Browse through the .js file and replace https://[HOSTNAME_AND_PATH_TO_JSAPI]dojo with https://gisserver.domain.com/ccb/js/arcgis_js_api/library/3.31/3.31/dojo.

  9. Click Save and close the dojo.js file.

  10. Open the index.html file, located in the C:\inetpub\wwwroot\ccb folder, in a text editor and change the following style sheet paths:

    • Browse through the index.html file and replace //js.arcgis.com/3.31/dojo/resources/dojo.css with js/arcgis_js_api/library/3.31/3.31/dojo/resources/dojo.css.

    • Browse through the index.html file and replace //js.arcgis.com/3.31/dijit/themes/claro/claro.css with js/arcgis_js_api/library/3.31/3.31/dijit/themes/claro/claro.css.

    • Browse through the index.html file and replace https://js.arcgis.com/3.31/esri/css/esri.css with js/arcgis_js_api/library/3.31/3.31/esri/css/esri.css.

    • Browse through the index.html file and replace https://js.arcgis.com/3.31/ with js/arcgis_js_api/library/3.31/3.31/init.js.

  11. Click Save and close the index.html file.

Set Bootstrap

To set Bootstrap, complete the following steps:

  1. Download Bootstrap 5.3.2.

    The bootstrap.js and bootstrap.min.js files are in download path\bootstrap-5.3.2-dist\bootstrap-5.3.2-dist\js on your local machine upon extraction.

  2. Create a bootstrap folder at C:\inetpub\wwwroot\ccb\js.

  3. Copy the bootstrap.js and bootstrap.min.js files to the bootstrap folder you created.

  4. Browse to the index.html file at C:\inetpub\wwwroot\ccb.

  5. Change the path for bootstrap from https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.min.js to js/bootstrap/bootstrap.min.js.

  6. Click Save and close the index.html file.

Set jQuery

To set jQuery, complete the following steps:

  1. Create a jQuery folder in the C:\inetpub\wwwroot\ccb\js folder.

  2. Download and save the jquery-3.7.1 min file.

  3. Move the extracted files to the jQuery folder you created.

  4. Open the index.html file located in the C:\inetpub\wwwroot\ccb folder in a text editor.

  5. Change the jquery-3.7.1.min file path from https://ajax.googleapis.com/ajax/libs/jquery/3.7.1/jquery.min.js to js/jQuery/jquery-3.7.1.min.js.

  6. Click Save and close the index.html file.

Update basemaps

You must generate an offline basemap to use for use when working without an internet connection.

Learn more about generating an offline basemap

Once the URL is generated, you must set the basemap to the URL in the ccbconfig.js and ccbconfig_i18n.js files in the C:\inetpub\wwwroot\ccb\js\ folder.

basemap: "https://gisserver.domain.com/arcgis/rest/services/yourBaseMap/MapServer",

Note:

When publishing a basemap, choose the Using tiles from a cache option on the Caching tab to draw a map service.

Use a vector tile basemap

To use a vector tile basemap, complete the following steps:

  1. Open the ccbconfig.js and ccbconfig_i18n.js files in the C:\inetpub\wwwroot\ccb\js\ folder in a text editor.

  2. Set the basemap URL to the location of the JSON file that contains the stylesheet information for rendering the vector layer.

    For example:

    basemap: "https://gisserver.domain.com/sharing/rest/content/items/d35487945eca4d68a602a9ad02d1feea/resources/styles/root.json"

  3. Open the ccbMap.js file in the C:\inetpub\wwwroot\ccb\js\ folder.

  4. Add the VectorTile type to the EsriBaseMaps.basemapfromURL configuration, as follows:

    EsriBaseMaps.basemapFromURL = {
baseMapLayers: [{
url: basemap,
type: "VectorTile"
}],
title: "basemapFromURL"
}

  5. Save and close the ccbconfig.js, ccbconfig_i18n.js, and ccbMap.js files.

Update a locator service

The default locator service is configured to use ArcGIS Online and is not available for disconnected deployments. You must provide your own locator services in a disconnected deployment.

To update a locator service, complete the following steps:

  1. Open the ccbconfig.js and ccbconfig_i18n.js files in the C:\inetpub\wwwroot\ccb\js\ folder in a text editor.

  2. Change the geocodeServiceUrl from https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer with the custom locator service URL.

  3. Click Save and close the ccbconfig.js and ccbconfig_i18n.js files.