Configure agency details for exporting exchange sets

Available with ArcGIS Maritime license.

The AgencyDetails.xml file supports multiple tasks in the ArcGIS Pro S-100 production infrastructure. For example, to use the cryptographic capabilities of the S-100 Exchange Set Editor tool, the agency details must be edited to include the paths to the certificates and manufacturer key. Additionally, when exporting an S-100 cell, elements from the Agency Details file are used to create the exchange catalog.

The AgencyDetails.xml file is populated with Esri’s producer code and information by default. The root element, AgencyDetails, contains the producerCode and description attributes. The producer code is a 4-character identifier associated with an agency.

The AgencyDetails element contains three child elements:

• Contact—The contact element contains information regarding the individual user, including their name, organization, phone, and address. This information is used to populate the corresponding metadata in the S-100 exchange set.
• DigitalSignature—The digitalSignature element is responsible for storing paths to certificate files and relating the organization to a digital signature. If the organization attribute value matches the organization specified in the S-100 exchange set contact element, this certificate will be added to the exchange set and the private key used to sign added files or existing signatures. The path attribute of the certificate and privateKey elements must be populated with the path to a valid certificate and key.

  Note:

  If your certificate is not issued by the International Hydrographic Organization (IHO), you must populate the ancestorCertificate attribute value. This value must be included for each intermediate certificate that exists. This value links the certificate to the root IHO certificate.

  

• Encryption—The encryption element stores the manufacturer ID and manufacturer key used to encrypt files deployed in an S-100 exchange set. The manufacturerID attribute value must be six ASCII alphanumeric characters. The manufacturerKey attribute value must be a path to a file containing a 32-hexadecimal ASCII character string. The manufacturerID attribute value must match the last six digits of the value stored in the USER_PERMIT.txt file. If the manufacturer key embedded in the specified USER_PERMIT.txt (during exchange set editing) matches the manufacturerID attribute value, the datasets will be encrypted using the M_KEY defined by the contents of the file path in the manufacturerKey attribute.

To configure agency details, complete the following steps:

Note:

Make sure that ArcGIS Pro is closed before you edit the AgencyDetails.xml file to help prevent any disruptions in the editing process.

1. Open File Explorer and browse to <ArcGIS Pro installation location>\ArcGIS\Pro\Resources\Maritime.
2. Open the AgencyDetails.xml file as administrator using your preferred XML editing program.

   The AgencyDetails element is populated with Esri’s information by default.

3. Replace Esri’s information with your organization’s producer code and description.

   

4. Provide the certificate path and the private key path.

   Beneath the contact element is the digitalSignature element. The digitalSignature element requires the path to a security certificate (a PEM or DER encoded file), and the path to the certificate’s private key (also PEM or DER encoded). To access these certificates, contact your agency’s IT administrator.

5. If necessary, provide the paths for any ancestor certificates.
6. To use the encryption capabilities of the S-100 Exchange Set Editor tool, populate the manufacturerID and manufacturerKey with the path of the manufacturer key file (M_KEY.txt).
7. Save the edits to the AgencyDetails.xml file, and start ArcGIS Pro.

Note:

The AgencyDetails element is repeatable. Multiple organizations may be included in a single AgencyDetails.xml file.

You can now encrypt and digitally sign exchange sets using the S-100 Exchange Set Editor tool.