Setting up the Nautical product library in an ArcSDE environment

This workflow provides steps for creating and configuring a geodatabase to use as a product library and for importing the preconfigured XML workspace that contains all the necessary feature classes and tables that can be used in an enterprise ArcSDE environment to manage nautical data and products. The database administrator (DBA) needs to determine the appropriate database administration system (DBMS) and production environment for the data and products the agency will manage. The Nautical Solution provides a preconfigured product library XML workspace. It is highly recommended that you use it. If you don't want to use the preconfigured product library, you can follow the workflow to create and configure your own product library.

Two different procedures are used to create and set up an ArcSDE geodatabase for the product library. One is used for setting up the product library on an ArcSDE geodatabase for Microsoft SQL Server Express licensed for ArcGIS Desktop (instance of SQL Server Express). The other is used for setting up the product library on an ArcSDE geodatabase licensed for ArcGIS Server Enterprise. The steps in this workflow are for setting up the product library on an ArcSDE geodatabase for Microsoft SQL Server Express licensed for ArcGIS Desktop, but additional information and links are provided for setting up the product library on an ArcSDE geodatabase licensed for ArcGIS Server Enterprise.

Adding a database server

This section describes how to add a database server connection under the Database Servers node in the Catalog window. This is a connection to a Microsoft SQL Server Express instance set up to store geodatabases. You can skip this section if you are using Oracle, SQL Server Enterprise, or another ArcSDE geodatabase licensed for ArcGIS Server Enterprise to store the geodatabase you are using as the product library.

You will need to install SQL Server Express, if you have not already, and enable it to store geodatabases.

Steps:

1. Start ArcMap, open the Catalog window, then expand the Database Servers node in the Catalog tree.
2. Double-click Add Database Server.
3. On the Add Database Server dialog box, provide the name of the ArcSDE database server. This is in the form <server_name>\<instance_name>, where the server name is the name of the server on which SQL Server Express is installed and the instance name is the name of the SQL Server Express instance.

   For example, if a database server is named SOPHIE\SQLEXPRESS, SOPHIE is the server name and SQLEXPRESS is the instance name.

   If you are unsure of the name to use, contact the administrator of the database server for this information.

4. Click OK.

Creating the administrator database connection

If the product library is stored in an ArcSDE geodatabase licensed for ArcGIS Server Enterprise, you need to create an administrator database connection. If your product library is stored in SQL Server Express, you can skip this section, since you only need to add a database server connection (first section of this workflow).

If you want to create a database connection for SQL Server, go to Making a direct connection from ArcGIS Desktop to a geodatabase in SQL Server. If you want to create a database connection for Oracle, go to Making a direct connection from ArcGIS Desktop to a geodatabase in Oracle.

Creating an ArcSDE geodatabase

The server administrator needs to create a new geodatabase from Oracle, SQL Server, SQL Server Express, or another enterprise database management system (DBMS) that can be used as the product library. The steps in this section are for creating an ArcSDE geodatabase for Microsoft SQL Server Express licensed for ArcGIS Desktop (SQL Server Express geodatabase). If you want to create a geodatabase from Oracle, SQL Server, or another ArcSDE geodatabase licensed for ArcGIS Server Enterprise, see the following topics for information:

• A quick tour of setting up a geodatabase in DB2
• A quick tour of setting up a geodatabase in Informix
• A quick tour of setting up a geodatabase in Oracle
• A quick tour of setting up a geodatabase in PostgreSQL
• A quick tour of setting up a geodatabase in SQL Server

Recommendations for Oracle databases

It is recommended that you ensure that the following parameter values are used when creating an Oracle database:

Parameter name	Value
Configure with Database Enterprise Manager	Enabled
Shared memory management	AUTOMATIC
Character Sets	Unicode (AL32UTF8)
OPEN_CURSORS	2000–10000
SESSION_CACHED_CURSORS	50–150

Oracle parameters for product library

When using product library in the Nautical Solution, for each check-in process, it writes a sizable amount of data that includes the MDF and MXD files into the product library table space. It is highly recommended that you manage the growth of this table space. The size of the product library table space depends on the number of products and the frequency of changes to the product in the product library. Ideally, keep 6 GB of space for the initial size and increase it in 3 GB chunk data files. Set the AUTOEXTEND parameter of the table space to True to allow the table space to automatically extend the data file when it becomes full. If the product library table space is full, you may get errors while running nautical processes such as populate, apply changes, and check in products.

The steps below are for creating an ArcSDE geodatabase for Microsoft SQL Server Express licensed for ArcGIS Desktop (an instance of SQL Server Express).

Steps:

1. Log in as a server administrator, start ArcMap, then open the Catalog window.
2. In the Catalog tree, right-click the database server on which you want to create a new geodatabase.
3. Click New Geodatabase.
4. Type a name for the new geodatabase in the Geodatabase name text box.

   The name must begin with a letter, cannot contain spaces or special characters (such as *, &, !, %, ., +, or -), and have a maximum length of 31 characters when combined with your server name.

5. If you want to change the database file location, specify the new location in the Geodatabase file text box by clicking the ellipsis button (...) and browsing to the location.
6. Type the size of the new geodatabase in the Initial Size text box.
7. Choose MB or GB from the Units drop-down menu, or use the default size of 100 MB.

   Regardless of the initial size, the geodatabase grows as it needs to, up to 10 GB.

   Note:

   The initial size of the geodatabase cannot be smaller than that of the model database in the SQL Server Express instance. The model database is the system template for all new databases. The size of the model database determines the minimum size of any database created in that SQL Server Express instance. If you attempt to create a geodatabase smaller than this minimum size, database creation fails and the following error message is returned:

   Error creating this geodatabase
   CREATE DATABASE failed. 
   Primary file must be at least <size of model> to accommodate a copy 
   of the model database.

8. Click OK.

A progress bar displays while the database file and geodatabase schema are created. When complete, the new geodatabase appears on the Contents tab and in the Catalog tree.

Creating geodatabase users

You can choose to add users to a geodatabase stored in SQL Server through Microsoft SQL Server Management Studio Express.

Learn how to add users for an Oracle database

Learn how to add Windows-authenticated users or groups to a SQL Server database

Learn how to add database-authenticated users to a SQL Server database

The steps below are for creating users for the product library geodatabase in ArcCatalog on a database server (an instance of SQL Server Express) and SQL Server.

Steps:

1. Log in as a server administrator, start ArcMap, then open the Catalog window.
2. Right-click the database server to which you want to add a user or group.
3. Click Permissions.
4. Click Add user on the Permissions dialog box.
5. Specify the location where you want to search for the user or group.

   This can be the local machine or a domain.

6. Type the name of the user or group you want to add. You can click the Advanced button to do a more specific query to find the desired user.
7. Click Check Names to verify the login name is valid.
8. Click OK.

Granting geodatabase roles/permissions

A role needs to be assigned to the users that are going to be working with the product library so they can view or add components, information, and data to the product library. These permissions are at the geodatabase level, assigned separately from the product library permissions. The roles are assigned through ArcCatalog as permissions for users that are using a product library stored in SQL Server Express or SQL Server. For Oracle and any other ArcSDE geodatabase licensed for ArcGIS Server Enterprise, the role CKB_USERS must be created for the users to be recognized by the product library. This can be done by using the following statement:

CREATE ROLE CKB_USERS NOT IDENTIFIED

User names for the role are required for any users who are going to be working with the product library and need to read from or write to the product library tables and other components. The administrators are considered the owners of the data, so they already have this privilege.

Below are suggested user names and the permissions required for each level for Oracle (and SQL Server if using Microsoft SQL Server Management Studio Express).

For product library administrators, the following is suggested:

User type	Role	Oracle permissions	SQL Server permissions
Data owner	CONNECT	CREATE PROCEDURE CREATE SEQUENCE CREATE SESSION CREATE TRIGGER CREATE VIEW CREATE TABLE	CREATE TABLE CREATE VIEW CREATE PROCEDURE

Administrator permissions

For product library editors, the following is suggested:

User type	Role	Oracle permissions	SQL Server permissions
Data editor/Data viewer	CONNECT CKB_USERS	CREATE SESSION	CREATE TABLE

Editor permissions

Learn more about user permission levels for Oracle

Learn more about user permission levels for SQL Server

The steps below are for granting roles/permissions on a database server (an instance of SQL Server Express) and SQL Server.

Steps:

1. Right-click the geodatabase for which you want to grant user permissions.
2. Click Administration and click Permissions.
3. Choose the desired user or group from the list on the Permissions dialog box.
4. Click the appropriate role:
   • None—No specific access to the geodatabase or the datasets in the geodatabase has been granted.
   • Read Only—The user can only view and select data.
   • Read/Write—The user can read, write to, and create new datasets in a geodatabase or can read and write to an existing dataset.
   • Admin—The user can perform administrative tasks in a specific geodatabase.
   • Server administrator—This user manages the database server.
5. Click Apply.

Configuring the database in ArcSDE

You need to configure the MAXBLOBSIZE and TCPKEEPALIVE parameters for the ArcSDE geodatabase used as the product library. The product library can be set up in a central or local geodatabase. A central geodatabase is usually an ArcSDE geodatabase with Oracle, SQL Server, SQL Server Express, or another enterprise DBMS installed. A local geodatabase is usually an ArcSDE geodatabase with SQL Server Express installed locally to house and manage the product library.

The DBMS used for the geodatabase should be configured before the product library is set up with the default geometry storage. See geodatabase storage in relational databases or geodatabase parameters for more information.

The MAXBLOBSIZE value is -1 by default. However, if you are using Oracle or another enterprise DBMS, make sure that this value is set to -1 and the TCPKEEPALIVE value is set to 1. This command should be used from the command prompt of a machine where ArcSDE is installed.

For example:

sdeconfig -o alter -v MAXBLOBSIZE=-1-i <service> -u sde -p <sde_password>

For more information, see the ArcSDE Administration Command Reference.

You can download a Portable Document Format (PDF) version of the book from the ESRI Support Center Web site (login required): ArcSDE Server documentation

Note:

The ArcSDE documentation refers to the parameter name as Property Name in the command line examples.

Use the steps below if you are using SQL Server Express or SQL Server to configure the MAXBLOBSIZE and TCPKEEPALIVE parameters.

Steps:

1. Open SQL Server Management Studio Express.
2. Click Connect on the Connect to Server dialog box that appears.
3. Expand Databases, the geodatabase you are using for the product library, and Tables.
4. Right-click the SDE_server_config table and click Edit Top 200 rows.
5. Find MAXBLOBSIZE in the prop_name field and change it to -1 in the num_prop_value field if it is another value.
6. Find TCPKEEPALIVE in the prop_name field and change it from 0 to 1 in the num_prop_value field.
   Caution:

   If you are using a local geodatabase and you modify the parameters while the Catalog window is open, you need to refresh (or disconnect and reconnect to) your SQL Server Express instance to confirm that the geodatabase has the new settings. You can right-click the database server and click Refresh.

Caution:

If you are using a local geodatabase and you modify the parameters while the Catalog window is open, you need to refresh (or disconnect and reconnect to) your SQL Server Express instance to confirm that the geodatabase has the new settings. You can right-click the database server and click Refresh.

7. Close SQL Server Management Studio Express.

Creating database connections for product library users

Database connections need to be created for the other product library users if the product library is stored in Oracle, SQL Server, or another ArcSDE geodatabase licensed through ArcGIS Server Enterprise. If your product library is stored in SQL Server Express, you can skip this section, since other users will only need to add a database server connection (first section of this workflow).

If you want to create a database connection for SQL Server, go to Making a direct connection from ArcGIS Desktop to a geodatabase in SQL Server. If you want to create a database connection for Oracle, go to Making a direct connection from ArcGIS Desktop to a geodatabase in Oracle.

Note:

For step 6, if using database authentication, type the user name of the product library user for which you want to create a database connection.

Importing the product library XML workspace

You can import a product library XML workspace into the geodatabase used as the product library that is preconfigured with the components necessary to start working on nautical products.

The XML workspace contains the standard product library tables. It is also preconfigured with a solution node (Nautical) and many class nodes (ENC, Chart, and so on) and has the unit conversion, Element, and VST tables. There are two preconfigured workspace XMLs available in the installation folder—one for ENC and Chart and the other for AML.

Steps:

1. Start ArcCatalog.
2. Expand:
   • Database Connections if using an Oracle, SQL Server, or another enterprise geodatabase
   • Database Servers if using a SQL Server Express geodatabase
3. Double-click the product library administrator connection geodatabase to connect to it.
4. Right-click the geodatabase you just connected to and click Import > XML Workspace Document.
5. Click the Data option if necessary.
6. If you are trying to set up the product library for ENC and Chart products, perform the following sub steps:
   1. Browse to the appropriate location:
      • On Windows XP, browse to <Installation location>\Documents and Settings\All Users\Application Data\ESRI\Production10.0\ProductLibraryFiles
      • On Windows Vista, Windows 7, and Windows Server 2008, browse to <Installation location>\Documents and Settings\All Users\AppData\Roaming\ESRI\Production10.0\ProductLibraryFiles
   2. Unzip the NAUTICAL_PRODUCT_LIBRARY_V10.0.0.0_GX.XML.ZIP file.
   3. open NAUTICAL_PRODUCT_LIBRARY_V10.0.0.0_GX.XML.

   The version information at the end of the file name represents the release the model was associated with. It is recommended that you always use the latest version. The first two values, 10, represent the major release value. The second value represents the minor release value. The third value represents the service pack value, and the fourth value represents a patch. For example, 93.0.1.0 represents 9.3 Service Pack 1.

   For AML products, the AML_PRODUCT_LIBRARY_V10000000_GX.XML.ZIP file should be used.

7. Click Next and click Finish.

   The XML will take a few minutes to import.

Caution:

If you are using Oracle or another DBMS, you need to set privileges on the product library tables and feature classes. To do this, follow the next process, Granting permissions to product library components. If you are using a SQL Server or SQL Server Express geodatabase, the product library tables and feature classes already have preconfigured permissions.

Granting privileges to product library components

Note:

You can skip these steps if you imported the product library XML workspace for the Nautical Solution into a SQL Server or SQL Server Express geodatabase. The product library tables and feature classes already have preconfigured privileges. However, if you used an Oracle geodatabase or another DBMS, you will need to assign privileges.

All the tables in the product library need to have read/write privileges assigned to them, except the PCAT_PERMISSION table. The PCAT_PERMISSION table only needs read privileges assigned to it.

All features imported with the product library XML workspace will also need privileges.

The permissions need to be assigned to the CKB_USERS role.

Both the administrator and other user accounts in the underlying database management system should have appropriate privileges and roles assigned to them. When you set up your connection to your spatial database, ensure that you are connecting as the appropriate user.

Steps:

1. Start ArcCatalog.
2. Expand one of the following:
   • Database Servers if using a SQL Server Express geodatabase
   • Database Connections if using an Oracle, SQL Server, or other enterprise geodatabase
3. Double-click the product library administrator connection geodatabase to connect to it.
4. Select all tables except PCAT_PERMISSION, right-click, then click Privileges.
5. Type CKB_USERS into the text box on the Privileges dialog box.
6. Check the check boxes next to SELECT, UPDATE, INSERT, and DELETE.
7. Click OK.
8. Select the PCAT_PERMISSION table, right-click, then click Privileges.
9. Type CKB_USERS into the text box on the Privileges dialog box.
10. Check the check box next to SELECT.
11. Click OK.
12. Select all feature classes, right-click, then click Privileges.
13. Type CKB_USERS into the text box in the Privileges dialog box.
14. Check the SELECT, UPDATE, INSERT, and DELETE check boxes.
15. Click OK.

Versioning within product library

You need to register product library components for versioning to allow them to be editable.

You need to register the product library feature classes and tables for versioning.

Steps:

1. Start ArcCatalog.
2. Expand one of the following:
   • Database Servers if using a SQL Server Express geodatabase
   • Database Connections if using an Oracle, SQL Server, or other enterprise geodatabase
3. Double-click the product library administrator connection geodatabase to connect to it.
4. Right-click each feature class in your product library and click Register as Versioned.

   Do not check the Register the selected objects with the option to move edits to base check box.

5. Click OK.
6. Right-click each table in your product library and click Register as Versioned.

   If you are using the Nautical Solution, do not register the following tables as versioned:

   • ELM_CATEGORIES
   • ELM_ELEMENTS
   • ELM_PRODUCTS
   • ELM_SOLUTIONS
   • PLTS_UCE_CONVERSIONS
   • PLTS_UCE_MAPPINGS
   • PLTS_UCE_ROUNDINGRULES
   Tip:

   If you do not have the four ELM_ tables, you can add them to your product library now or wait for them to be generated when you store a database element in an element table.

   Do not check the Register the selected objects with the option to move edits to base check box.

7. Click OK.

Defining and upgrading the geodatabase as a product library

After the geodatabase has been created, various tables and feature classes that are part of the product library need to be added to it. This process can be completed in ArcMap.

If you are an administrator, you need to define the Product Library Workspace to be able to connect to it in ArcMap and create the series. Other users can then create products from the series you create.

Steps:

1. Start ArcMap.
2. On the menu bar, click Customize > Production > Product Library.
   Tip:

   If the Product Library command is not enabled, you may need to enable the Production Mapping extension by clicking Customize > Extensions and checking the check box for Production Mapping.

   Tip:

   You can also open the window by clicking the Product Library button on the Production Cartography toolbar.

3. If necessary, click Data Management.
4. Click the cell next to Workspace in the Product Library section and click the ellipsis (...) that appears.

   The Please browse to the location of the Product Library Workspace dialog box appears.

5. Navigate to the product library database.
6. Click Open.

   The Upgrade Workspace dialog box appears.

7. Click OK to upgrade the geodatabase you want to use as the product library.

   The Upgrade Product Library dialog box appears with the progress of the upgrade.
8. Click OK.

Creating a series

The preconfigured product library contains the solution and three product classes, but you need to create a series to be able to create products.

You need to create at least one series in the product library (in ArcMap) for users to be able to start creating products.

Steps:

1. If necessary, open the Product Library window by clicking Customize > Production > Product Library on the main menu.

   A tree view of the product library appears.
2. Right-click the product class to which you want to add a map or chart series and click New Series.
   Tip:

   If you are using field configuration table settings and batch jobs in NIS geodatabase, you need to create a new series in NIS product class in the preconfigured product library.

   The New Series dialog box appears.

3. Click the cell next to Name.
4. Double-click the existing text and type a name for the map or chart series in the text box.
5. Click the cell next to Alias.
6. Type the name you want displayed in the tree view for the map or chart series.
7. Click the cell next to Description.
8. Type a description for the map or chart series in the text box.
9. Click the cell next to Visible.
10. Click the drop-down arrow and choose an option to indicate whether the map or chart series is going to be visible in the product library tree view.

    The default value is False.

    If you are using the Nautical Solution, choose True.

11. Click OK to close the dialog box.

Administering geodatabase user permissions through product library

There are different types of geodatabase users such as Data creator and Data editor users. The Data creator user has full access to the product library and the contents within it. To restrict access of the product library to only certain users, your organization needs to create Data editor users and administer permissions through product library. Data editor users do not have create table privileges and cannot create a product class.

You should add Check Out/Check In user permissions to the Data editor users to be able to create and manage products.

Tip:

If you are using field configuration table settings and batch jobs in the NIS geodatabase, you have to assign Edit permissions to the operating system domain users on the series in NIS product class.

Steps:

1. Navigate to the series level of the product class for which you want to assign permissions.
2. Right-click the series name and click Permissions.

   The Permissions dialog box appears.
3. Click the Permissions drop-down arrow and choose Check Out/Check In permissions for each user.
   Tip:

   You can assign permissions to all users at once by clicking the gray cell to the left of First Name, right-clicking anywhere, clicking Permission, then choosing Check Out/Check In.

4. Click OK.

At the completion of this workflow, you should have created and configured a geodatabase to use as a product library and imported the preconfigured XML workspace that contains all the necessary feature classes and tables that can be used in an enterprise environment to manage nautical data and products.