Configure ArcGIS Maritime

Available with Standard or Advanced license.

Available with Production Mapping license.

Available with ArcGIS Maritime license.

ArcGIS Maritime uses a server object extension (SOE). Add the SOE to your ArcGIS Server Manager site to enable Maritime Chart Service functionality for a map service.

Review the following system requirement information before you set up your service:

• Mapped network drives are not recommended for the workspaceDirectories property setting due to potential performance issues. It is recommended that the .senc files be stored on the physical server.
• Maritime Chart Service can only be enabled on a dedicated instance type. Shared instance pools are not supported.
• You will exceed a URL length of 2,048 characters if you use display properties in your GET request. POST is not supported in all third-party apps. If your apps do not support POST, increase your allowable URL length using a web.config.xml file.
• To deploy Custom Chart Builder (CCB), you must use the web.config.xml file to increase your default URL length.
• It is recommended that you increase your map service's javaHeapSize value from the default 128 MB to 2048 MB or greater, depending on your system resources and the number of datasets in your service. The QueryDataSet operation and Custom Chart Builder (CCB) exports can exceed this default limit.
• At ArcGIS Enterprise 11.0, new map services with a dedicated instance pool will have the minimum and maximum number of instances per machine set to 0 by default. It is highly recommended that the minimum and maximum number of instances per machine be set to 1. This will ensure that when your map service with Maritime Chart Service (MCS) enabled is started, the cataloging process will automatically start. Without a minimum setting of 1, a request must be made to the one of the MCS endpoints to start the cataloging process and could cause delays in response time. The cataloging process entails MCS scanning the datasets folder and building the necessary .senc files.

  Learn more about configuring service instance settings

  Note:

  At ArcGIS Enterprise 10.9.1 and earlier, new map services with a dedicated instance pool had the minimum and maximum number of instances per machine set to 1 by default.

Enable Maritime Chart Service

Complete the following steps to enable Maritime Chart Service:

1. Create a folder named maritimeserver in the ArcGIS Server site at <ArcGIS Server installation drive>\arcgisserver\directories.

   Note:

   If this location doesn't exist, verify that your ArcGIS Server site has been created.

   Learn more about creating a site

2. Copy the maritimechartservice folder from <ArcGIS Maritime Server installation directory>\MaritimeServer\Server<version> to the <ArcGIS Server installation drive>\arcgisserver\directories\maritimeserver folder created in step 1.
3. Sign in to ArcGIS Server Manager.
4. Click the Site tab.
5. In the Server Configuration window, click Extensions.
6. Click Add Extension.
7. Click Browse and browse to <ArcGIS Maritime Server install directory>\MaritimeServer\Server<version>\Bin.
8. Click MaritimeServer.soe.
9. Click Add.

   MaritimeServer.soe is now successfully added.

10. Click the Services tab.
11. Click your map service.
12. In the Map Services pane, click Capabilities.
13. Check the Maritime Chart Service check box.
14. Verify all the properties.

    Note:

    The MaritimeServer.soe uses the maritimechartservice folder to automatically populate the Maritime Chart Service capabilities properties.

15. Click Save and Restart in ArcGIS Server Manager to restart the map service.

    Maritime Chart Service capabilities are now enabled.

16. You are now ready to load S-57 and S-63 datasets to your map service.

    Note:

    You can modify your default configuration settings.

Deploy Custom Chart Builder (CCB)

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.

Copy the customchartbuilder folder

Copy the customchartbuilder folder from the Custom Chart Builder (CCB) installation to the deployment location. The files in the installation location can be treated as a backup and the files in the deployment location are modified as needed. The recommended location to copy the customchartbuilder folder to is: <ArcGIS Server installation drive>\arcgisserver\directories\maritimeserver so that the CCB folder and Maritime server folder are under the same folder.

Note:

• To complete the steps, you must have a map service with Maritime Chart Service capability enabled.
• Custom Chart Builder (CCB) requires the installation of PDF Merge Support. Without this feature, PDF documents cannot be exported from the Custom Chart Builder (CCB) app.

Complete the following steps to deploy Custom Chart Builder (CCB) in your ArcGIS Server site:

1. If necessary, create a folder named maritimeserver in the ArcGIS Server site at <ArcGIS Server installation drive>\arcgisserver\directories

   Note:

   If this location doesn't exist, verify that your ArcGIS Server site has been created and that Maritime Chart Service is enabled.

2. Copy the customchartbuilder folder from <ArcGIS Maritime server installation drive>\MaritimeServer\Server<version> to the <ArcGIS Server installation drive>\arcgisserver\directories\maritimeserver.
3. Configure the ArcGIS Server account.

Configure sharing and permissions

Perform these steps to configure sharing for the <ArcGIS Server installation drive>\arcgisserver folder and to add Full Control permissions for the ArcGIS Server account:

Note:

CCB product export processing writes or modifies necessary files in this folder.

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

   Note:

   You can specify the locale of your ArcGIS Server account. By default, this user is usually ArcGIS.

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

Publish the service definition files

Publish the two service definition files to ArcGIS Server for CCB to calculate the Area of Interest (AOI) extent when you create an extent on the map to export a PDF chart.

1. Sign in to ArcGIS Server Manager.

   Note:

   Publish the service definition files using ArcGIS Server Manager. To streamline deployment, it is recommended that you create a folder in ArcGIS Server Manager named CCB to organize CCB-related services.

2. Click Services > Manage Services, choose the CCB folder, and click Publish Service.
3. Click Choose File to browse to the service definition you want to publish, or type the path to the file.

   The default location is <ArcGIS Server installation drive>\arcgisserver\directories\maritimeserver\customchartbuilder\ServiceDefinitionFiles.

4. Choose Calculators.sd and click Open.

   Caution:

   Do not change the name of the service. The web app does not work if you do so.

   The service definition is published to the server folder specified in the service definition configuration by default. To change the folder where the service definition is published, choose a folder from the drop-down list or click New.

   Note:

   All CCB service definitions must be in the same folder to properly deploy CCB. It is recommended that you create a folder to organize CCB-related services. The recommended folder name is CCB.

5. Click Next.

   You need to specify properties for your new service. No additional capabilities are required.

6. Optionally, check Existing and choose CCB from the drop-down arrow.
7. Click Back or click Next as necessary.
8. Click Publish.
9. Repeat these steps for ExportWebmap.sd.

Update the Utilities.py file

You must complete this process after you have published your CCB service definition files. This ensures that your Calculators and ExportWebmap geoprocessing services use the updated Utilities.py file:

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

   The default location is <ArcGIS Server installation drive>\arcgisserver\directories\maritimeserver\customchartbuilder\Tools.

2. Update the following variables:
   • shared_products_path and output_directory—Update the variables with your machine name, domain, and folder path if you did not use the recommended default settings.
   • output_url—Update the variable with your machine name and domain and update the folder path if you did not use the recommended default settings. Localhost can only be used for local testing.
3. Save the changes to Utilities.py, and close the file.
4. Copy your updated Utilities.py file to the arcgisinput location of your newly published Calculators and ExportWebmap CCB services.
5. Browse to your arcgisinput location for CCB.

   The default location is <ArcGIS Server installation drive>\arcgisserver\directories\arcgissystem\arcgisinput\CCB.

   • Copy the updated Utilities.py file to <Installation location>\arcgisserver\directories\arcgissystem\arcgisinput\CCB\Calculators.GPServer\extracted\p30\tools.
   • Copy the updated Utilities.py file to <Installation location>\arcgisserver\directories\arcgissystem\arcgisinput\CCB\ExportWebmap.GPServer\extracted\p30\tools.
6. In ArcGIS Server Manager, click Services > Manage Services.
7. Click Folders > CCB.
8. Restart your Calculators and ExportWebmap geoprocessing services.

Enable custom symbology

The ServerConfiguration.xml file provides a true/false switch 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, 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 your 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 multipart 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.

Perform the following steps to customize geoenabled notes:

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. Add multipart polygon features to the FeatureClassForNotes feature class in the Notes.gdb folder.
   1. Optionally, add features to the FeatureClassForNotes or FeatureClassForNotes_Line feature class.

   Tip:

   • Sample notes can be found 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 mandatory 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 comply with CYMK.
   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, and 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 your setup and replace them with the previous versions of those templates now renamed with a _withoutnotes suffix.

Tip:

Rename your A0 and ANSI E templates, for example, with a _withnotes suffix in their name. Remove the _withoutnotes from your 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 which elements are 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, then the left and bottom edge. Changing the map frame size impacts AOI size.

Configure the web app

Once you have published your service definition files, updated your layout templates, published a map service with Maritime Chart Service available, and updated your Utilities.py file, you are ready to configure and deploy your CCB web app.

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

   Note:

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

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

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

3. Update your ccbconfig.js file located under ccb\js.
   1. Update the serviceURL parameter with the location of the service you created in step 2 of Publish the service definition files.

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

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

      If the Maritime Chart Service capability is activated 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. Choose another basemap by modifying the basemap variable.

   3. If necessary, update the appID parameter with the App ID you created in step 2. This allows you to sign in to the ArcGIS organizational account. This only applies to the Custom Product type.
4. Save the changes to your ccbconfig.js file.

You are now ready to use CCB by launching the app.

Portal postregistration

If you registered the web app through your portal, complete these post-registration steps:

1. Browse to the CCB folder in your web root folder. For example, browse to C:\inetpub\wwwroot\ccb if you are deploying your web app using Internet Information Server (IIS).
2. In the widgets\AddData folder, open Widget.js.
3. Update the portalUrl variable to 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 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 parameter.
10. Click Save.

Troubleshoot the Maritime server extension configuration

Use the following frequently asked questions to troubleshoot configuration issues:

The Maritime Chart Service data is not available in my Custom Chart Builder (CCB) app

Verify that the MCSURL set in step 3 of Configure the web app is accessible to the user accessing the app.

I received an Unable to complete Operation error

Add Configure ArcGIS Server Account to the installation directory if the error Unable to complete Operation. Error Executing tool. CalculateExtent. occurs.

My Maritime Chart Service does not display or disappears after changing my display properties

Determine whether you exceeded the server URL length of 2,048 characters when using display parameters. If so, increase the allowable URL length in the web.config.xml file.

What if I observe an error due to failure of enabling HTTPS on the web server?

Verify you have enabled HTTPS on your web server.