Deploy Custom Chart Builder (CCB)

Available with Standard or Advanced license.

Available with Production Mapping license.

Available with ArcGIS Maritime license.

The Maritime server extension allows you to deploy a web-based app to generate information map products in real time and allows you to create any product at any scale. To deploy Custom Chart Builder (CCB) you must have a map service with the Maritime Chart Service capability enabled and deployed.

Note:

Custom Chart Builder (CCB) requires the installation of PDF Merge Support. Without this feature, PDF documents cannot be exported from the CCB app.

Copy the customchartbuilder folder

Copy the customchartbuilder folder from the Maritime server installation location and paste it to the deployment location. The files in the installation location can be treated as a backup; the files in the deployment location can be modified as needed. It is recommended that you store the customchartbuilder folder in the same location as the maritimechartservice folder. The default location is C:\arcgisserver\directories\maritimeserver.

To deploy Custom Chart Builder (CCB) in an ArcGIS Server site, complete the following steps:

1. Create a folder named maritimeserver in the ArcGIS Server directories folder if necessary.

   The default location is C:\arcgisserver\directories. If this location doesn't exist, verify that the ArcGIS Server site has been created and that Maritime Chart Service is enabled.

2. Copy the customchartbuilder folder from the Maritime server installation location and paste it to the maritimeserver folder.

   The default location for the customchartbuilder folder is C:\Program Files\ArcGIS\MaritimeServer\Server<version>\.

Once the customchartbuilder folder is added to the maritimeserver folder, the CCB files can be referenced by ArcGIS Server. You must also configure sharing and permissions so that the CCB app has write access to the files.

Configure sharing and permissions

CCB export processing writes or modifies files in the arcgisserver folder, which requires full control by the ArcGIS Server account. To configure sharing for the arcgisserver folder and to add full control permissions for the ArcGIS Server account, complete the following steps:

1. Locate the arcgisserver folder.

   The default location is C:\arcgisserver.

2. Right-click the arcgisserver folder and click Properties.
3. Click the Sharing tab.
4. Click Advanced Sharing.
5. Check the Share this folder check box.
6. Click Permissions.
7. Click Add... on the Share Permissions tab.
8. Add the ArcGIS Server account.

   Note:

   The ArcGIS Server account default name is arcgis. Alternatively, you can use the local or domain account used to configure ArcGIS Server.

9. Once the ArcGIS Server account has been added, click OK.
10. Choose the newly added ArcGIS Server account in the Group or user names window on the Share Permissions tab.
11. Check the Allow check box next to Full Control.
12. Click OK.
13. Click OK to close the Advanced Sharing dialog box.
14. Click Close if necessary.
15. Close the Properties dialog box.

Update the toolConfig.json file and Registry Key

The JSON file stores file paths that support parameters in the Calculators and ExportWebMap service definition files. Administrator permissions are required to add the toolConfig.json file path to the Registry Key.

Note:

Any existing services must be re-added any time the Registry Key is edited.

Update the toolConfig.json file

To update the toolConfig.json file, complete the following steps:

1. In File Explorer, browse to the toolConfig.json file and open it in a text editor.

   The default location is C:\arcgisserver\directories\maritimeserver\customchartbuilder\Tools.

2. Update the following variables:
   • shared_products_path and output_directory—Update the variables with the machine name and domain. Update the folder path if you did not use the default settings.
   • output_url—Update the variables with the machine name and domain. Update the folder path if you did not use the default settings.

     Note:

     Localhost can only be used for local testing.

3. Save the changes to toolConfig.json and close the file.

After the toolCongfig.json file is updated, it must be added to the Registry Key.

Add the toolConfig.json file to the Registry Key

To add the toolCongfig.json file to the Registry Key, complete the following steps:

1. Click the Windows Start menu and type Registry Editor.
2. Click Registry Editor.
3. Click Yes to allow Registry Editor to make changes.
4. Browse to Computer\HKEY_LOCAL_MACHINE\SOFTWARE\EsriProduction\Server<version>\Maritime.
5. Right-click the Maritime folder, point to New, and click String Value.
6. For the string name, type ccbToolConfig.
7. Double-click the string to edit it.
8. In the Value data text box, provide the file path as follows: C:\arcgisserver\directories\maritimeserver\customchartbuilder\Tools\toolConfig.json.

Publish the service definition files

Publish the service definition files, Calculators.sd and ExportWebmap.sd, to ArcGIS Server for CCB to calculate the area of interest (AOI) extent and export the chart.

To streamline deployment, it is recommended that you create a server folder named CCB to organize CCB-related services.

To publish the service definition files, complete the following steps:

1. Sign in to ArcGIS Server Manager.
2. Click Services > Manage Services.
3. Click Add Folder .

   The Add Folder dialog box appears.

4. Name the folder CCB and click Create.

   A folder named CCB is created under the Site (root) folder. This folder will be used to store service definition files.

5. Click Publish Service.
6. On the Publish Service dialog box, click Choose File, and browse to the ServiceDefinitionFiles folder.

   The default location for the folder is C:\arcgisserver\directories\maritimeserver\customchartbuilder\ServiceDefinitionFiles.

7. Choose Calculators.sd and click Open.

   Caution:

   Do not change the name of the service. The web app does not work if a different name is used.

8. Click Next.

   You must specify the properties for the service. No additional capabilities are required.

9. Choose the Existing option and ensure that CCB is selected from the drop-down list.

   Note:

   All CCB service definitions must be in the same folder to deploy CCB.

10. Click Next.
11. Click Publish.
12. Repeat these steps for the ExportWebmap.sd service definition file.

Enable custom symbology

The ServerConfiguration.xml file contains a CustomSymbology Boolean to enable or disable display of custom symbology that overrides the default S-52 presentation library. When available, Maritime Chart Service references rules in the CustomSymbolMap.xml file, Scalable Vector Graphic (SVG) symbols, and Lua scripts to provide a paper chart-like display of the S-57 data.

After setting custom symbology to True, you must rebuild the .senc files for the symbols to appear in the service.

Lua in Maritime Chart Service can do the following:

• Reference .svg files to override point symbols or line patterns (simple and complex)
• Override symbol instructions such as color, fill pattern, or transparency
• Access view groups or display properties
• Provide instructions to modify a text group's font name, size, weight, color, and offset

Update geoenabled notes

Geoenabled notes allow you to generate textual notes for CCB outputs based on the geographic location of the product.

The notes are stored in a point, line, or polygon feature class, where each record has a text box that contains the note. When a new product area of interest is inserted, the area of interest is intersected with the geoenabled notes layers, and a separate A4 sheet is appended to the export. If there is more than one page of notes, a second page is generated, and so on.

To customize geoenabled notes, complete the following steps:

1. Unzip the Notes.zip file in the <ArcGIS Server directory location>\arcgisserver\directories\maritimeserver\customchartbuilder\LayoutTemplates directory.

   Tip:

   A sample notes geodatabase exists in the Notes.zip file.

2. In ArcGIS Pro, add multipart polygon features to the FeatureClassForNotes feature class in the Notes.gdb folder.

   Optionally, add features to the FeatureClassForNotes or FeatureClassForNotes_Line feature class.

   Tip:

   • Sample notes are available in the FeatureClassForNotes_Sample feature class in the Notes.gdb folder.
   • Multipart polygons allow you to have several geographic locations that share the same note text without redundancy.
3. Optionally, edit the following fields in the FeatureClassForNotes feature class:

   Notes	This is a required field. Add note text or the body of the paragraph.
   Title	This is an optional field. Add the name of the note that prints above the note paragraph.
   Color	This is an optional field. Set the Red, Green, Blue (RGB) value of the note paragraph and title. Separate values with a single comma. The note appears with black text if the field is empty, null, or has invalid values. Note: This field does not accept CMYK color values.
   minScale	This is an optional field. Specify the smallest chart scale on which the note appears. For example, if a note appears on a chart between 1:40000 and 1:90000, type 40000 in the field.
   maxScale	This is an optional field. Specify the largest chart scale on which the note appears. For example, if a note appears on a chart between 1:40000 and 1:90000, type 90000 in the field.

Customize layout templates

You can customize the layout templates as described below.

Map elements

Custom Chart Builder (CCB) provides several layout templates for various page sizes and orientations. Each layout contains map elements such as scale bars, north arrows, legends, logos, text, or other graphics that are created for specific purposes in the chart. Map frames are also layout elements.

Tip:

Use the center anchor point in the map frame to minimize movement and prevent the grid border from overlapping surrounding elements. The map frame expands 13 millimeters on each side during the export map process.

Templates for page sizes A0 and ANSI E have common chart notes added to them. You can modify these notes to fit your local needs. If you do not want to create A0 or ANSI E sized charts with notes, you can remove those templates from the setup and replace them with the previous versions of those templates renamed with the _withoutnotes suffix.

Tip:

Rename the A0 and ANSI E templates, for example, with the _withnotes suffix in their name. Remove _withoutnotes from the backup A0 and ANSI E templates. The system recognizes the A0 and ANSI E templates that no longer have common notes.

By default, the layout template font is Arial.

Manage elements

During product creation, the map elements are updated dynamically to reflect changes in the chart, such as scale, geographic extent, and generation date. CCB uses the names of elements to manage and identify the elements to be modified by the automation script. Do not change map element names. If you modify the names, the element cannot be managed using the automation script. If necessary, you can access the name by clicking Element Name on the Size and Position tab of the Properties dialog box.

Map frame

The AOI generated in the CCB web app is obtained from the layout template's map frames. A calculator finds the lower left corner of the data frame and the left and bottom edge. Changing the map frame size impacts AOI size.

Configure the web app

Once you have published the service definition files, updated the layout templates, published a map service with Maritime Chart Service available, and updated the toolconfig.json file, you can configure and deploy the CCB web app.

1. Browse to <ArcGIS Server installation directory>\MaritimeServer\Server<version>\webapplications and copy the CCB folder to C:\inetpub\wwwroot if you're using Internet Information Server (IIS) to deploy the web app.

   Note:

   You can rename the CCB folder. This is the name of the app you access over the web.

2. Register the web app and get the app ID.

   You can skip this step if the 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 need to add data from your organization's account, this step is required.

3. If you registered the web app through your portal, complete the postregistration steps.
4. Update the ccbconfig.js file located at C:\inetpub\wwwroot\ccb\js.
   1. Update the serviceURL value with the location of the service you created in step 2 of Publish the service definition files.

      If the recommended default values were used, the path is https://gisserver.domain.com/arcgis/rest/services/CCB.

   2. Update the MCSURL value to the map service with Maritime Chart Service enabled.

      If the Maritime Chart Service capability is enabled for SampleWorldCities, the path is https://gisserver.domain.com/arcgis/rest/services/SampleWorldCities/MapServer/exts/MaritimeChartService/MapServer.

      Note:

      The app uses the Esri Ocean basemap by default. To use another basemap, modify the basemap variable.

   3. Update the ccbconfig.js file with the app ID that you created in step 2 if necessary.

      This allows you to sign in to the ArcGIS organizational account. This only applies to the Custom Product type.

5. Save the changes to the ccbconfig.js file.

You can launch the app to use CCB.

Update the portal URL

If you registered the web app through your portal, complete the following postregistration steps:

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 your app.