Skip To Content

Enable Fixed Product type

Available with Standard or Advanced license.

Available with ArcGIS Maritime license.

Fixed and custom products are supported in Custom Chart Builder. These options are set in the web app Java configuration file, ccbconfig.js. You can choose which product type your CCB app displays: custom or fixed.

The Fixed Product option is for standardized cartographic outputs. The host organization defines the chart extent, scale, page size, and orientation available in the web app. You can choose a chart extent from a published feature server layer.

The Custom Product option allows you to create charts from anywhere. Charts are built in real time using the scale, page size, and orientation options in the app. You can add data from ArcGIS Online or your organization account, and the added data appears in the web map and the exported PDF. Custom Product is the default setting in the web application.

Note:

You must create areas of interest (AOIs) representing chart extents before enabling the Fixed Product option.

Publish areas of interest for a fixed product

A polygon feature class with areas of interest representing chart extents must be created. This fixed AOI polygon feature class is published as a map service to ArcGIS Server with the Feature Access capability enabled.

A fixed AOI polygon feature class must contain the following mandatory fields:

Field nameExplanationData type

chart_name

The name that appears inside the area of interest and that is used as the chart's title in the chart product.

String

orientation

The orientation of the sheet. Choose from the Portrait and Landscape options.

String

page_size

The following page sizes are available:

  • A0
  • A1
  • A2
  • A3
  • A4
  • C
  • D
  • E
  • Letter

String

scale

The scale of the chart product. For example, if the scale is 1:20,000, enter 20000.

Double

Note:

A sample fixed AOI polygon feature class is located at <ArcGIS Server installation drive>\arcgisserver\directories\maritimeserver\customchartbuilder\FixedProduct.zip. This geodatabase contains a feature class with the mandatory fields and attributes.

When extracting the .zip file, verify that the geodatabase is extracted to <ArcGIS Server installation drive>\arcgisserver\directories\maritimeserver\customchartbuilder\FixedProduct\FixedProduct.gdb. The geodatabase must be in the FixedProduct folder without a file extension.

Note:

Chart titles cannot contain any of the following special characters: #!%&+*?/<>|[].

Field names must be lowercase.

It's recommended that you configure the feature layer's label and symbol properties before publishing it to your service.

Learn how to label with a standard label engine and apply symbology to draw individual layers in a single category.

  1. Publish your fixed product service in ArcGIS Pro.
    1. In the General section, for Service Details, type FixedProductExtent in the Name text box.
    2. For Location, click the Folder drop-down arrow and choose CCB.
    3. Click Analyze and resolve any errors or warnings.
    4. Click Publish.
  2. Sign in to your portal as a server manager by launching https://gisserver.domain.com/arcgis/manager.
  3. Click Services > Manage Services and choose the CCB folder.
  4. Click Map Service on the FixedProductExtent page and browse to the Capabilities tab.
  5. Check the Feature Access capability check box.
  6. Click Save and Restart for the Map Service on the FixedProductExtent page.
Note:

If you configured the fixed AOI polygon feature class to use a hosted service in a data store, you must set the ExtentLayers URL value to your service URL in the ccbConfig.js file.

The following is the ExtentLayers function in the ccbConfig.js file:

ExtentLayers: [
//extent layer for Fixed product type needs to have Feature Access enabled
//get the field names from feature service layer, since the field names may get changed after publishing
{value: "Fixed", url: serviceURL + "/FixedProductExtent/FeatureServer", sublayer: 0, data0: "chart_name", data1: "page_size", data2:"orientation", data3:"scale", data4:"PanelNumber" }
],

Enable Fixed Product

To change the web app from Custom Product to Fixed Product, complete the following steps:

  1. Browse to your CCB deployment location and open the web app configuration file located at C:\inetpub\wwwroot\ccb\js\ccbconfig.js if Internet Information Server (IIS) is being used to deploy your web app.
  2. Locate productType:"Custom" and replace it with "Fixed".
  3. Optionally, set showDisplaySettingWidget to true for the Display Properties tab to appear in the web app.
  4. In the Display Settings pane, to hide or remove parameters from the app, set them to false in the DisplaySettingsControls property.