Available with Standard or Advanced license.
Available with Production Mapping license.
Available with Maritime Charting license.
ArcGIS Maritime allows you to deploy a web-based app to generate information map products on the fly and create any product at any scale.
Copy customchartbuilder folder
Copy the customchartbuilder folder from the CCB installation to the deployment location. The files in the CCB installation location can be treated as a backup, and the files in the deployment location will be 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 folders will be under the same folder.
Perform the following steps to deploy Custom Chart Builder (CCB) within your ArcGIS Server site.
Note:
To complete the steps, you must have a map service with Maritime Chart Service enabled.
- If necessary, create a folder named maritimeserver in the ArcGIS Server site at <ArcGIS Server installation drive>\arcgisserver\directories.
- Copy the customchartbuilder folder from <ArcGIS Server Installation Directory>\MaritimeServer\Server<version> to the <ArcGIS Server installation drive>\arcgisserver\directories\maritimeserver folder created in step 1.
- 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.
- Right-click the arcgisserver folder and click Properties.
- Click the Sharing tab.
- Click Advanced Sharing.
- Check the Share this folder check box.
- Click Permissions.
- Click Add on the Share Permissions tab.
- Add the ArcGIS Server account.
Note:
You can specify the locale of your ArcGIS Server account. By default, this user is usually ArcGIS.
- Once the ArcGIS Server account has been added, click OK to close the Select Users or Groups dialog box.
- Choose the newly added ArcGIS Server account in the Group or user names section on the Share Permissions tab and click the Allow check box next to Full Control.
- Click OK.
- Click OK again to close the Advanced Sharing dialog box.
- Click Close.
- Click OK again 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 AOI extent when you create an extent on the map to export a PDF chart.
- Sign in as a server manager by launching https://gisserver.domain.com/arcgis/manager.
Note:
Publish the service definition files using ArcGIS Server Manager. To streamline deployment, it is recommended that you create a folder within ArcGIS Server Manager named CCB to organize your CCB-related services.
- Click Services > Manage Services, choose the CCB folder, and click Publish Service.
- 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.
- Select 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. If you want to change the folder where the service definition will be 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 your CCB-related services. CCB is the recommended folder name.
- Click Next.
You will need to specify properties for your new service. No additional capabilities are required to be selected.
- Optionally, check Existing and choose CCB from the drop-down arrow.
- Click Back or click Next as necessary.
- Click Publish.
- Repeat steps 3 through 6 for ExportWebmap.sd.
Update the Utilities.py file
You must complete this process after you have published your CCB service definition files. This makes your Calculators and ExportWebmap geoprocessing services use the updated Utilities.py file:
- In Windows Explorer, browse to the Utilities.py file and edit it.
The default location is <ArcGIS Server installation drive>\arcgisserver\directories\maritimeserver\customchartbuilder\Tools.
- 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—Use of localhost is only for local testing. Otherwise, update the variable with your machine name and domain and update the folder path if you did not use the recommended default settings.
- Save the changes to Utilities.py, and click File > Exit.
- Copy your updated Utilities.py file to your newly published Calculators and ExportWebmap CCB services' arcgisinput location.
- Browse to your arcgisinput location for CCB.
The default location is <ArcGIS Server installation drive>\arcgisserver\directories\arcgissystem\arcgisinput\CCB.
- Copy your updated Utilities.py file located in step 1 to <Installation Location>\arcgisserver\directories\arcgissystem\arcgisinput\CCB\Calculators.GPServer\extracted\p20\tools.
- Copy your updated Utilities.py file located in step 1 to <Installation Location>\arcgisserver\directories\arcgissystem\arcgisinput\CCB\ExportWebmap.GPServer\extracted\p20\tools.
- In ArcGIS Server Manager, click Services > Manage Services.
- Click Folders > CCB.
- 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 enabled, Maritime Chart Service references rules in the CustomSymbolMap.XML, Scalable Vector Graphic (SVG) symbols and Lua scripts to provide a paper chart-like view 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 within Maritime Chart Service can:
- Reference SVG files to override point symbols or simple/complex line patterns
- Override symbol instructions such as color, fill pattern or transparency
- Access to view groups or display properties
- Provide instruction 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 multipart polygon feature class, where each record has a text field that contains the note. When a new product area of interest is inserted, the area of interest is intersected with the geoenabled notes polygon layer, and a separate A4 sheet is appended to the GeoPDF 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:
- Unzip the Notes.gdb.zip file located in the <ArcGIS Server installation drive>\arcgisserver\directories\maritimeserver\customchartbuilder\LayoutTemplates folder.
Tip:
A sample notes geodatabase exists in the Notes.gdb.zip file.
- Add multipart polygon features to the FeatureClassForNotes feature class in Notes.gdb.
Tip:
- Sample notes can be found in the FeatureClassForNotes_Sample feature class in Notes.gdb.
- Multipart polygons allow you to have several geographic locations that share the same note text without any redundancy.
- Optionally, edit the following fields in the FeatureClassForNotes feature class:
| Notes | Title | Color | minScale | maxScale |
|---|---|---|---|---|
This is a mandatory field. Add note text or body of the paragraph. | This is an optional field. Add the name of the note that will print above the note paragraph. | This is an optional field. Set 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. | This is an optional field. Specify the largest scale chart on which the note appears. For example, if a note should appear on charts between 1:40000 and 1:90000, type 40000 in the field. | This is an optional field. Specify the smallest scale chart on which the note appears. For example, if a note should appear on charts 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. Layout elements can also be map frames.
With the latest release of Maritime Chart Service, 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 on the Properties dialog box.
Map frame
The area of interest (AOI) generated in the CCB web app is obtained from the layout template's map frames. A calculator finds the bottom left corner of the data frame and then the left and bottom edge. Changing the map frame size impacts AOI size.
Configuring the web app
Once you have published your service definition files, updated your layout templates, published a map service with Maritime Chart Service enabled, and updated your Utilities.py file, you are ready to configure and deploy your CCB web app.
- 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.
- Register your web app and get the App ID.
Note:
At 10.8.1 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 enable sign-in capability and need to add data from your organization's account, this step is required.
- Update your ccbconfig.js file located under ccb\js.
- Update the serviceURL 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.
- Update MCSURL to the map service with Maritime Chart Service enabled.
If you enabled Maritime Chart Service for SampleWorldCities, the path is https://gisserver.domain.com/arcgis/rest/services/SampleWorldCities/MapServer/exts/MaritimeChartService/MapServer.
Note:
Your app uses the Esri Ocean basemap. You can choose another basemap by modifying the basemap variable.
- If necessary, update appID with the App ID you created in step 2. This allows you to sign in to ArcGIS Online or your portal account. This applies only to the Custom Product type.
- Update the serviceURL with the location of the service you created in step 2 of Publish the service definition files.
- Save the changes to your ccbconfig.js file.
You are now ready to use CCB by launching the app.
Register the web app through your portal
If you registered the web app through your portal, complete these postregistration steps:
- 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).
- In the widgets\AddData folder, open Widget.js.
- Update the portalUrl variable to https://portalserver.domain.com/arcgis.
- Click Save.
- In the widgets\LayerList folder, open Widget.js.
- In the appConfig section, update the portalUrl to https://portalserver.domain.com/arcgis.
- Click Save.
- In the js folder, open SignInButton.js.
- Uncomment // portalUrl: "https://portalserver.domain.com/arcgis", and update the portalUrl.
- Click Save.
Troubleshoot Maritime Server configuration issues
Use the following frequently asked questions to troubleshoot configuration issues:
What if I don't see Maritime Chart Service data in my Custom Chart Builder (CCB) app?
Verify that the MCSURL set in step 3 of the Configure the web app section is accessible to the user accessing the app.
What if I observe an Unable to complete Operation error?
Add Configure ArcGIS Server Account to the installation directory if you see the error Unable to complete Operation. Error Executing tool. CalculateExtent.
What if my Maritime Chart Service does not display or disappears after changing my display properties?
Check if you have exceeded the server URL length of 2,048 characters when using display parameters, and if so, increase the allowable URL length in the web.config.xml file.
What if I observe a possible error due to failure of enabling HTTPS on the web server?
Check if any dataset you are trying to export is using HTTPS, and if so, create the appropriate certificate in the server which hosts the dataset. For example, if you are accessing datasets outside the organization, create CA-signed certificate. If you are accessing datasets within the organization, create a domain certificate. Refer to enabled HTTPS on your web server for more information.