Skip To Content

Configuring ArcGIS for Maritime: Server

Available with Production Mapping license.

ArcGIS for Maritime: Server uses a server object extension (SOE). You will need to add the SOE to a map service within your ArcGIS site to enable Maritime Chart Service functionality for the map service.

Note:

Important system requirements information needed before you set up your service:

  • Mapped network drives are not supported for your workspaceDirectories property setting. You must have your senc files on the physical server to support your internal memory mapping.
  • You will exceed a URL length of 2,048 characters when using display parameters in your GET request. POST is not necessarily supported in all third-party applications. If you are unable to support POST in your applications, it is recommended that you increase your allowable URL length by using a web.config.xml file.
  • You must run your map service in LOW Isolation.

Enabling Maritime Chart Service

Perform the following steps to enable Maritime Chart Service:

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

    If this location does not exist, verify that your ArcGIS Server site has been created. See Creating a new site.

  2. Copy the maritimechartservice folder from <ArcGIS Server Installation Directory>\MaritimeServer\Server<version> to the maritimeserver folder created in step 1.
  3. Log in as a server manager by launching http://gisserver.domain.com:6080/arcgis/manager.
  4. Click the Site tab.
  5. In the GIS Server pane, click Extensions.
  6. Click Add Extention.
  7. Click Browse and browse to <ArcGIS 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 will look for the maritimechartservice folder mentioned in step 2 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/S-63 datasets to your map service.

    For more information on loading S-57 datasets, see Managing data for unencrypted S-57 datasets or Managing data for S-63 encrypted datasets.

    Note:

    If you want to modify your default configuration settings, see Setting Maritime Chart Service properties.

  17. Note:

    If you have installed Maritime Chart Service in a cluster, you only need to enable it on one of the machines in the cluster. The configuration changes will be automatically applied to the other machines in the cluster.

    Tip:

    For more information on creating a Maritime Chart Service tile package using S-57/ S-63 datasets, see Creating a Maritime Chart Service tile package.

Copy productsondemand folder

ArcGIS for Maritime: Server allows you to deploy a web-based application to generate information map products in real time and allows you to create any product at any scale.

Copy the productsondemand folder from the PoD installation to the deployment location. The files in the installation location can be treated as a backup. And the files in the deployment location will be modified as needed. <ArcGIS Server installation drive>\arcgisserver\directories\ maritimeserver is a recommended location to copy the folder to since the PoD folder and maritime server folder will be under the same directory.

Perform the following steps to deploy Products on Demand (PoD) within your ArcGIS Server site.

Note:

To complete the following deployment steps for Products on Demand, you will need to have a map service with Maritime Chart Service enabled.

For more information see Enabling Maritime Chart Service.

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

    If this location does not exist, verify that your ArcGIS Server site has been created and Maritime Chart Serviceenabled.

    SeeCreating a new site or Enabling Maritime Chart Service.

  2. Copy the productsondemand folder from <ArcGIS Server Installation Directory>\MaritimeServer\Server<version> to the maritimeserver folder created in step 1.
  3. Configure the ArcGIS Server account.

Sharing and permissions

Share and add permissions to your <ArcGIS Server installation drive>\arcgisserver folder with the following steps to make sure your ArcGIS Server account user has Full Control permission on this folder.

Note:

PoD product export processing will write or modify necessary files under this folder.

  1. Right-click the arcgisserver folder and choose 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 your ArcGIS Server account user.
    Note:

    For more information, see Specifying the locale of the ArcGIS Server account. By default, this user is usually ArcGIS.

  8. Once the user is added, click OK to close the Select Users or Groups dialog box.
  9. Choose the newly added user in the Share Permissions tab and choose Full Control.
  10. Click OK.
  11. Click OK again to close the Advanced Sharing dialog box.
  12. Click Close.

Publishing service definition files

Publish the three service definition files to ArcGIS Server for PoD to calculate the AOI extent when you create an extent on the map to export a PDF chart.

  1. Log in as a server manager by launching http://gisserver.domain.com:6080/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 POD to organize your PoD-related services.

    See Publish a service definition to the server in Manager for additional details.

  2. Click Services > Manage Services, choose the POD 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. Click Browse and browse to the <ArcGIS Server Installation Directory>\MaritimeServer\Server<version> location.

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

  4. Choose Calculators.sd and click Open.
    Caution:

    Do not change the name of the service. Doing so will not allow the web application to work.

    By default, the service definition is published to the server folder specified in the service definition configuration. 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 PoD service definitions must be in the same folder to properly deploy Products on Demand. It is recommended that you create a folder to organize your PoD-related services. By default, POD is recommended.

  5. Click Next.

    You will need to specify properties for your new service. No additional capabilities need to be selected.

  6. Click Back or Next as necessary.
  7. Click Publish.
  8. Repeat steps 3 through 6 for ExtentLayer.sd and Gateway.sd.

    Your services are now running at http://gisserver.domain.com:6080/arcgis/rest/services/POD and can be accessed by users and clients on your network.

Updating your Utilities.py file

This process must be done after you have published your PoD service definition files. This will allow your Calculator and Gateway geoprocessing services to know where you deployed the productsondemand folder in the steps below:

  1. In Windows Explorer, browse to the Utilities.py file and edit it. The default location is <ArcGIS Server installation drive>\arcgisserver\directories\ maritimeserver \productsondemand\Tools.

    This is the shared_products_path where productsondemand will be deployed.

  2. You will need to update the following variables:
    • shared_products_path and output_directory—Update with your machine name, domain, and update the path if you did not use the recommended default settings.
    • output_url—Use of localhost is only for local testing. Otherwise, update with your machine name, domain, and update the path if you did not use the recommended default settings.
  3. Save your changes to Utilities.py and click Exit.
  4. Copy your updated Utilities.py file to your newly published Calculators and Gateway PoD services arcgisinput location.
  5. Browse to your arcgisinput location for POD. The default location is <ArcGIS Server installation drive>\arcgisserver\directories\arcgissystem\arcgisinput\POD.
    • Copy your updated Utilities.py file located in step 1 to <ArcGIS Server installation drive>\arcgisserver\directories\arcgissystem\arcgisinput\POD\Gateway.GPServer\extracted\v101\tools.
    • Copy your updated Utilities.py file located in step 1 to <ArcGIS Server installation drive>\arcgisserver\directories\arcgissystem\arcgisinput\POD\Calculators.GPServer\extracted\v101\tools
  6. In ArcGIS Server Manager, click Services > Manage Services.
  7. Click Folders > POD.
  8. Restart your Calculator and Gateway geoprocessing services.

Setting Maritime Chart Service URL in your layout templates

Products on Demand comes with layout templates that have been predefined with various surround elements and a Maritime Chart Service WMS layer. The default WMS Layer location is http://localhost:6080/arcgis/rest/services/SampleWorldCities/MapServer/exts/MaritimeChartService/WMSServer. If your map service with Maritime Chart Service enabled is different, you will need to modify your layout templates before finishing your deployment.

Note:

The Layer Properties within the layout template contain a parameter named DPI with a value of 300. This is required to produce chart products at a higher resolution for printing.

Updating geoenabled notes

Geoenabled notes allow you to generate textual notes for Products on Demand (PoD) 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 a single page of notes, a second page is generated, and so on.

Perform the following steps to customize geoenabled notes:

  1. Unzip Notes.gdb.zip under <ArcGIS Server installation drive>\arcgisserver\directories\maritimeserver\productsondemand\LayoutTemplates\Notes.gdb.
    Tip:

    Notes.gdb.zip exists in the Notes.gdb folder.

  2. Add multipart polygon features in the FeatureClassForNotes feature class that is in the Notes.gdb folder.
    Tip:
    1. Sample notes can be found in the FeatureClassForNotes_Sample feature class within the Notes.gdb folder.
    2. Multipart polygons allow you to have several geographic locations that share the same note text without redundancy.
  3. The fields in the FeatureClassForNotes feature class can be further edited.

NotesTitleColorminScalemaxScale

This is a mandatory field.

Note text or body of the paragraph.

This is an optional field.

The name of the note that will print above the note paragraph.

This is an optional field.

Red, Green, Blue (RGB) value of the note paragraph and title. Separate values with a single comma (,). The note will appear with black text if the field is empty, null, or has invalid values.

Note:

This field does not comply with CMYK.

This is an optional field.

Allows you to specify the largest scale chart on which the note will appear. For example, if a note should appear on charts between 1:40000 and 1:90000, you will type 40000 in the field.

This is an optional field.

Allows you to specify the smallest scale chart on which the note will appear. For example, if a note should appear on charts between 1:40000 and 1:90000, you will type 90000 in the field.

Customizing map document templates

Map elements

Products on Demand provides several map document templates for various page sizes and orientation. Each map document 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 data frames.

With the latest release of Maritime Chart Service, templates for page sizes A0 and ANSI E have common chart notes added to them. These common notes are based on charts produced by NOAA. 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 will now recognize the A0 and ANSI E templates that no longer have common notes.

By default, your layout template font is set to Arial.

For more information, see Map elements.

Managing elements

During product creation, the map elements are updated dynamically to reflect changes in the chart such as scale, geographic extent, and generation date. Products on Demand uses the names of elements to manage and identify which elements are to be modified by the automation script. Map element names should not be changed. If names are modified, 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.

Data frame

The area of interest (AOI) generated in the Products on Demand web application is obtained from the map document template's data frame. A calculator finds the bottom left corner of the data frame, then the left and bottom edge. Changing the data frame size will impact AOI size.

For more information, see What is a page layout?

Configuring the web application

Once you have published your services 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 Products on Demand web application.

  1. Browse to <ArcGIS Server Installation Directory>\MaritimeServer\Server<version>\WebApplications and copy the folder pod to C:\inetpub\wwwroot if using IIS to deploy your web application.
    Note:

    You can rename the pod folder to POD. This will be the name of the application you access over the web.

  2. Update your podconfig.js file located under pod\js with your newly published PoD service.
    • Update serviceURL to the location created in step 2 of Publishing service definition files. If defaults were used, the path is http://gisserver.domain.com:6080/arcgis/rest/services/POD.
    • It is recommended that you update your MCSURL path to the same map service used in your layout template. The default location is http://gisserver.domain.com:6080/arcgis/rest/services/SampleWorldCities/MapServer/exts/MaritimeChartService/MapServer.
      Note:

      MCSURL will only be used in the web application for viewing. The layout template WMS service will be used by the print service to create the chart export.

      Note:

      Your application will use the Esri Ocean basemap. You can choose another basemap by modifying the BasemapWithMCS variable.

  3. Save changes to your podconfig.js file.
  4. You are now ready to use Products on Demand by launching the application.

Troubleshooting the Maritime Server configuration

What if I don't see Maritime Chart Service data in my Products on Demand application?

Verify that the MCSURL set in step 2 of the Configuring web application section is accessible to the user accessing the application.

What if I don't see any Maritime Chart Service data in my Products on Demand export?

Verify that the S57 Layer in the layout template being accessed during Products on Demand export is accessible to the user accessing the Products on Demand application.

What if I observe an Unable to complete Operation error?

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

Related topics