SpatialNET Administration Guide
SpatialNET Administration Guide
Release 6.1
Table of Contents
Overview and Requirements .................................................................................................... 7
Prerequisites ................................................................................................................................................... 7
Acronyms ........................................................................................................................................................ 7
Related documentation ................................................................................................................................... 7
4 of 69
SPATIALinfo Inc.
SPATIALinfo Inc.
5 of 69
Troubleshooting ................................................................................................................... 64
Cannot open a job because it is already open .................................................................................................64
Database shutdown causes batch queue to lock up .......................................................................................64
Reset queue where a session has crashed ......................................................................................................64
Missing symbol xxx appears beside symbols in spatialNET views ................................................................64
6 of 69
SPATIALinfo Inc.
Prerequisites
Users of this manual should be advanced users of Oracle Relational Database Management System
and Oracle Locator/Spatial. They also should be comfortable using basic Oracle administrative
commands and running SQL scripts.
Acronyms
Acronym
EAM
JMS
RDBMS
SDO
SQL
Description
Entity Abstraction Manager
Job Management System
Relational Database Management System
Spatial Data Object
Structured Query Language
Table 1: Acronyms
Related documentation
Document name
spatialNET release notes
Description
Provides installation and configuration information specific to the
accompanying spatialNET release. Details of functional enhancements,
fixed problems and known limitations are included in the document.
Describes supported platforms and system requirements.
Describes the use and configuration of the spatialNET Access Manager for
spatialNET licensing.
Describes the installation, activation, and use of the Server Access Manager
to manage product user licenses.
SPATIALinfo Inc.
7 of 69
The names that you plan to give to table spaces for spatialNET
Architecture
spatialNET uses an Oracle client installation on the PC, with Oracle Net connecting to the Oracle
Server.
The Oracle Client on the client PC (requires the Administrator or Run-Time installation. See
Install Oracle client).
8 of 69
SPATIALinfo Inc.
For up-to-date system requirements, see the document titled System Hardware and Third-party
Software Requirements.
The spatialNET database requires Oracle Locator, which is a standard component of Oracle
Standard Edition and Enterprise Edition. It does not require the Oracle Spatial option.
Log in to SQL*Plus with the following command, replacing <sys_password> with the
password of the system user:
sqlplus system/<sys_password>
2.
SPATIALinfo Inc.
9 of 69
NOTE: Replace <table space name> with the name of the table space. Replace <table space
filename> with the complete path, filename, and extension (DBF) for the table space.
Depending on the host platform environment and disk storage configuration, it may be helpful to
create table spaces for the following object types:
spatial indexes
external tables
Developer: spatialnet_developer
These roles must be created only once for any database instance.
Following the Oracle recommended principle of assigning the fewest privileges necessary, table 3
identifies the object and system privileges required for the spatialNET roles.
Oracle user role and
type
spatialnet_readaccess
Query-only
spatialnet_writeaccess
Designer
Object Grants
System Grants
Privileges
SELECT
CREATE SESSION
Examine network
CREATE SESSION
Examine network
Create/cancel jobs
Add entities and change
network information.
spatialnet_administrator
spatialnet_developer
READ,WRITE ON
CREATE TABLE
CREATE
PROCEDURE
CREATE SEQUENCE
CREATE VIEW
CREATE TYPE
CREATE SYNONYM
CREATE TRIGGER
CREATE SESSION
ALTER TABLE
CREATE ANY VIEW
10 of 69
SELECT
INSERT
UPDATE
DELETE
QUOTA UNLIMITED
SELECT
INSERT
UPDATE
DELETE
QUOTA UNLIMITED
SPATIALinfo Inc.
DIRECTORY
DATA_PUMP_DIR
QUOTA UNLIMITED
CREATE INDEXTYPE
CREATE
PROCEDURE
CREATE SEQUENCE
CREATE SESSION
CREATE SYNONYM
CREATE TABLE
CREATE TRIGGER
CREATE TYPE
SELECT ANY
DICTIONARY
ALTER SESSION
AUTOTRACE
NOTE: Replace < spatialNET Table space> with the default table space for the spatialNET schema.
Replace <Password> with the Oracle password for the spatialNET Oracle User.
SPATIALinfo Inc.
11 of 69
NOTE: Use the full Oracle client for the version of the Oracle server hosting spatialNET.
1.
2.
Open a Windows command window (cmd) and navigate to the sql\oraspatial directory in
the spatialNET installation directory.
The default location is
\Program Files\SPATIALinfo\SPATIALnet\sql\oraspatial
3.
Log in to SQL*Plus as the spatialNET schema owner using the command below:
sqlplus <spatialNET user>/<password>@<OracleService>
NOTE: Replace <spatialNET user> with the spatialNET schema owner username. Replace
<password> with the password for the spatialNET schema owner. Replace <OracleService>
with the connection string for the Oracle server hosting the SpatialNET schema. This string
is usually the tnsname entry that is configured in the tnsnames.ora file. See Set up
tnsnames.ora for new database connections.
4.
@spatialfm_tables.sql
@spatialfm_indices.sql
@spatialfm_views.sql
@create_jms_views.sql
@spatialnet_eam.sql
@create_jms_tables.sql
@spatialnet_jms.sql
@create_jms_triggers.sql
5.
Exit SQL*Plus and navigate to the sql\dictionaries directory in the spatialNET installation
directory.
6.
Log in to SQL*PLUS as the spatialNET schema owner. From the SQL> prompt, execute the
following scripts:
@all_ess.sql
@all_reco.sql
12 of 69
SPATIALinfo Inc.
2.
3.
Open a Windows command window (cmd) and navigate to the sql\oraspatial directory in
the spatialNET installation directory. The default location is:
\Program Files\SPATIALinfo\SPATIALnet\sql\oraspatial
4.
Log in to SQL*Plus as the spatialNET schema owner using the command below:
sqlplus <spatialNET user>/<password>@<OracleService>
NOTE: Replace <spatialNET user> with the spatialNET schema owner username. Replace
<password> with the password for the spatialNET schema owner. Replace <OracleService>
with the connection string for the Oracle server hosting the spatialNET schema.
5.
Follow the instructions below to create a master schema with the appropriate logs.
1.
Open a Windows command window (cmd) and navigate to the sql\oraspatial directory in
the spatialNET installation directory. The default location is:
\Program Files\SPATIALinfo\SPATIALnet\sql\oraspatial
2.
Log in to SQL*Plus as the spatialNET schema owner using the command below:
sqlplus <spatialNET user>/<password>@<OracleService>
NOTE: Replace <spatialNET user> with the spatialNET schema owner username. Replace
<password> with the password for the spatialNET schema owner. Replace <OracleService>
with the connection string for the Oracle server hosting the SpatialNET schema.
3.
SPATIALinfo Inc.
13 of 69
NOTE: Replace <Oracle schema> with the Oracle schema that owns the spatialNET objects
on that server.
2.
Using a Database Link (DB_Link), establish connectivity between the replicate schema (on
the server hosting the replicate site) and the spatialNET owner schema (on the server
hosting the master site).
3.
Open a Windows command window (cmd) and navigate to the sql\oraspatial directory in
the spatialNET installation directory. The default location is:
\Program Files\SPATIALinfo\SPATIALnet\sql\oraspatial
4.
Log in to SQL*Plus as the spatialNET schema owner using the command below:
sqlplus <replicate owner>/<password>@<OracleService>
Note: Replace <replicate owner> with the username for the replicate schema owner. Replace
<password> with the password for the replicate schema owner. Replace <OracleService>
with the connection string for Oracle server hosting the replicate schema.
5.
NOTE: Replace <DB_Link> with the database link that established connectivity to the
master Oracle server. Replace <Oracle schema> with the Oracle schema that owns the
spatialNET objects on that server.
NOTE: This user initially has an empty password. For security reasons, this password should be set
as soon as possible.
14 of 69
SPATIALinfo Inc.
Follow these steps to create the user admin for the application administrator.
1.
NOTE: Replace <spatialNET user> with the spatialNET schema owner username. Replace
<password> with the password for the spatialNET schema owner. Replace <OracleService>
with the connection string for the Oracle server hosting the SpatialNET schema.
3. From the SQL> prompt, execute the following script:
@spatialfm_scm_init.sql
3.
Open your copy of the script with a text editor, and edit it to load the coordinate systems
you want to be available.
4.
5.
SPATIALinfo Inc.
15 of 69
Navigate to the bin (or bin64) directory in the spatialNET installation directory. The default
location is
\Program Files\SPATIALinfo\SPATIALnet\bin
2.
3.
16 of 69
Description
Short description to identify the spatialNET schema
spatialfm
Select OracleSpatial from the drop down list
Not enabled for OracleSpatial
Not enterable for OracleSpatial
Connection string to Oracle. TNS name of the service or IP/OracleSID
SPATIALinfo Inc.
Schema
Username
4.
Select Encrypted to encrypt the password when distributing the configuration file. If you do
not encrypt the password, then the file can be read by a regular user.
5.
Click Save As. When prompted to choose a location, choose the dbms folder in the
spatialNET installation location. The default location is
\Program Files\SPATIALinfo\SPATIALnet\dbms
spatialNET-supplied scripts
Along with the scripts required to create the database, model-independent scripts are located in the
sql folder of the spatialNET installation folder.
The default location is:
\Program Files\SPATIALinfo\SPATIALnet\sql
Description
Creates the base tables for supporting spatialNET
Creates the necessary views on the base tables for supporting
spatialNET
Creates all indexes on tables supporting spatialNET and sets
the primary key constraints for these tables
Creates indexes for table columns that do not contain spatial
data
Creates indexes for table columns that contain spatial data
Creates views based on spatialNET tables
Creates the spatialnet_eam package
Creates special tables needed by the spatialnet_jms package
Creates the spatialnet_jms package
Creates database triggers to support between job locking of
changed entities.
Populates the SCM_USER and SCM_USER2 tables to create a
default admin user for a spatialNET installation
Description
oraspatial\spatialfm_master.sql
oraspatial\spatialfm_slave.sql
oraspatial\spatialfm_refresh_slave.sql
SPATIALinfo Inc.
17 of 69
oraspatial\spatialfm_drop_master.sql
oraspatial\spatialfm_drop_slave.sql
oraspatial\spatialfm_drop_indices.sql
oraspatial\spatialfm_drop_aspatial_indices.sql
oraspatial\spatialfm_drop_spatial_indices.sql
oraspatial\spatialfm_drop_tables.sql
oraspatial\spatialfm_drop_views.sql
Description
dictionaries\all_ess.sql
dictionaries\all_reco.sql
oraspatial\spatialfm_grant_tables.sql
Optional scripts
Path and filename
Description
oraspatial\orasp_get_mbr.sql
oraspatial\orasp_gather.sql
oraspatial\check_null_srid_spatial_me
tadata.sql
oraspatial\check_spatial_metadata.sql
oraspatial\get_all_srid.sql
oraspatial\get_srid.sql
18 of 69
SPATIALinfo Inc.
oraspatial\set_entity_status.sql
NOTE: This script only updates the service status column when
its value is null, so it will not adversely affect any table with existing
values.
oraspatial\valgeom.sql
Install Oracle Full Client. For up-to-date information about software versions, see the
document titled: System hardware and third-party software requirements 2Q 2012.
Install AutoCAD
Install spatialNET
Download the Oracle client (11G R2.111.7.20 or higher) from the following location:
http://www.oracle.com/technetwork/database/enterprise-edition/downloads/index.html
2.
Choose the appropriate operating system and click See All to access the Client download
options.
SPATIALinfo Inc.
19 of 69
3.
Download Oracle Client. (Do not download Standard Edition, Standard Edition One,
Enterprise Edition, or other special downloads).
4.
On the C: drive, create a folder titled Oracle. Oracle will be installed in this folder so that
anyone using the machine has access to Oracle.
5.
6.
7.
8.
In the Oracle Base field, enter the C:\Oracle directory created in step 4 as the installation
location.
9.
Open the tnsnames.ora file in plain text editor (such as Notepad or Wordpad).
2.
The relevant part of the file is shown below. Change the BOLD text in the sample below to
match your system, and then save the file. (Contact your IT administrator to obtain this
information.)
NOTE: If the file doesnt contain the code below, then copy and paste this code into the file,
making sure to edit the parts in bold.
ORA1 1G_ SER VER NA ME =
(D ESC RIP TIO N =
(AD DRE SS_ LI ST =
( ADD RES S = (PRO TOC OL = T CP )( HOST =
123. 456 .78 .91 0) (P ORT = 1 521 ))
)
(CO NNE CT_ DA TA =
( SER VIC E_ NA ME = or a11 g)
)
)
20 of 69
SPATIALinfo Inc.
IF YOU USE WINDOWS 7: Save the file first to a writeable location and then copy it back into
the Oracle location (C:\Oracle). Windows 7 security prohibits the creation of certain file types in
certain locations.
You can also create this file using the Oracle Net Configuration Assistant. See Manually create a
TNSNames file.
>
If this test fails, review the host name and service name in the tnsnames.ora file to ensure the Oracle
server is properly defined.
Open AutoCAD Map 3D and choose the workspace settings. Map Classic is recommended.
2.
Verify that AutoCAD Map 3D is running properly; then close the application.
Install spatialNET
After you have verified that AutoCAD is working properly on the client computer, you can install the
spatialNET application.
To install spatialNET:
1.
Obtain the spatialNET installation file from the SPATIALinfo Support Portal or from your
SPATIALinfo representative.
2.
3.
4.
SPATIALinfo Inc.
21 of 69
5.
Read the license agreement. Click I accept the agreement, and then click Next.
6.
In the User Information window, type the appropriate information and click Next.
7.
Select the installation location in the C:\Program Files folder, as shown below, and click
Next.
22 of 69
SPATIALinfo Inc.
8.
NOTE: The Start Menu icons for Desktop, Job Administrator and Batch Queue may not be
necessary for all users.
9.
Click Install.
SPATIALinfo Inc.
23 of 69
Launch spatialNET
Warning: AutoCAD must be opened at least once before spatialNET is opened the first time.
To launch spatialNET:
1.
Double-click the spatialNET icon on the desktop, or click the Windows Start button, then
click All Programs, spatialNET, and then spatialNET.
2.
In the Login dialog box, enter a user name and password for your database.
3.
Select the appropriate database to open from the Database drop-down list. The drop-down
list is generated from the .ini files in the dbms directory of your spatialNET installation
directory.
24 of 69
SPATIALinfo Inc.
4.
Click Logon.
5.
Click OK. When the Job Selection window appears, spatialNET has successfully connected
to your database.
2.
3.
4.
From the Advanced tab, click the Environment Variables button. The Environment
Variables window appears.
5.
Under the System Variables section, click Add (or New) to add a new variable.
SPATIALinfo Inc.
25 of 69
6.
7.
In the Variable value field, type the location that you want to save the log file.
NOTE: Windows 7 will not allow you to write to C:\Program Files, so you should choose a
location outside of that directory.
8.
Click OK to save the location. spatialNET logs will be stored in the location you chose.
26 of 69
SPATIALinfo Inc.
The error message shown above usually appears as a result of one of the following:
Oracle is installed in the user profile directory of the person who performed the installation.
2.
Review the path to see if there are any references to Oracle and the directory where it is
installed.
NOTE: Oracle should be installed in an Oracle file on the C: drive, and NOT in its default location.
Publish a job to make it visible to others using the database. You can continue to make
changes to the job.
Post a job when you are finished with it. Others using the database can see your work, and
you cannot make further changes to it after it has been posted.
NOTE: Depending on he settings for your security group, you may not be able to publish or post a
job. To change security group settings, see Edit a security group.
Publish a job
To publish a job:
1.
Run spatialNET Job Administrator and log on. The JMS Administration Tool window
appears.
2.
SPATIALinfo Inc.
27 of 69
3.
Click the job that you want to publish, then click the Publish button, and then click Queue
for Publish. The job goes to the batch queue for publishing. See spatialNET Batch Queue
Operation.
Warning: Do not choose the Publish option unless you are certain that no one else is logged in to the
database. Publishing while others are logged in to the database can seriously damage the database.
Colored entities
spatialNET can display entities in different colors to help you identify whether they have been
posted, published in another job, or added or edited in the current job and not published.
Post a job
To post a job:
1.
Run spatialNET Job Administrator and log on. The JMS Administrator Tool window appears.
2.
28 of 69
SPATIALinfo Inc.
3.
Click the job that you want to publish, then click Post, and then click Queue for Post. The
job goes to the batch queue for publishing. See spatialNET Batch Queue Operation.
Warning: Do not choose the Post option unless you are certain that no one else is logged in to the
database. Posting while others are logged in to the database can seriously damage the database.
NOTE: A job that has been posted to the spatial database is no longer available for editing by
spatialNET users.
SPATIALinfo Inc.
29 of 69
Expand the items in the list to reveal the source of the conflict, then select an item and
click the appropriate button to act on it.
Button
Save
Display
Edit
Delete
Verify
Reset
Close
Description
Saves the list, in its current state of expansion, as a text file.
Shows the Details or Map View menu options.
Details opens the Details panel for the selected entity.
Map View opens a map, centered on the selected entity.
Brings up a window that allows editing of the selected entity.
Deletes the record of the operation for the current job. Delete is only available after
selecting an item under the Operations performed on job heading.
Shows the Verify Publish, Verify Post and Verify Cancel menu options.
Choose these options to test whether the current job can be successfully published,
posted or cancelled (respectively). Verification results appear as a new list item in
the JMS Administration Results panel.
Allows you to clear the Open status of the selected job.
Closes the window.
Contents
License files
Database connection files
Icons (.ico)
Image files (.bmp, .jpg)
Native code extensions (.dll)
AutoCAD drawing templates (.dwt)
AutoCAD menu files (.mns)
Extension Scripts (.py)
AutoCAD symbols (.dwg)
Smart Text symbols (.smt)
30 of 69
SPATIALinfo Inc.
Subject to the type of jobs to be processed by the batch queue, all of the customization files must be
present.
From the JMS Administration Tool window, click the Batch Queue button. The All batch
queues window appears.
2.
Start a queue
You can start or stop a batch queue using the JMS Administration window. See The spatialNET JMS
Administration tool.
SPATIALinfo Inc.
31 of 69
From the JMS Administration Tool window, click the Batch Queue button. The All batch
queues window appears.
2.
Select a batch queue and click the Control button. The Queue Control window appears.
3.
Click Run Queue. (Or click Run Once to process a single job and then stop.)
4.
Enter the appropriate details and begin the queue. A progress window appears, showing the
status of the BQM.
To stop the queue, click the Stop button on the progress window. The batch manager will stop once
the current job is finished.
NOTE: These buttons are running scripts in the bin (or bin64) directory that can be customized if
required.
Button
Script
Run Queue
Reset Queue
Run Once
batch.bat
resetbatch.bat
singlerunbatch.bat
32 of 69
SPATIALinfo Inc.
Data Model
There are a number of database tables associated with managing the batch queues.
The JOB_ID and USER_ID columns hold information about the submitter of the batch job.
The COMMAND_ARGS holds the arguments to pass to the operating system command.
WARNING: If multiple queues are created, their first eight characters in the DESCRIPTION field
must not be the same. By default, the batch queue keys use the first eight characters of the
DESCRIPTION field as entered by the user.
SPATIALinfo Inc.
33 of 69
Process Flow
When the BQM is running, it loops around repeating the same process. The following figure is
simplified version of how the BQM operates:
To process BATCH_QUEUE_ENTRY:
1.
2.
Adjust the command (if it begins with *spatialnet") to reflect the actual installation
location of the spatialNET software on the batch server machine. This may be different to
the location it is installed on the client machine that submitted the batch request.
34 of 69
SPATIALinfo Inc.
3.
Adjust the command (if it begins with *spatialnet") to reflect the actual installation
location of the spatialNET software on the batch server machine. This may be different to
the location it is installed on the client machine that submitted the batch request.
4.
Load the details of the requested batch operation into a number of named edit buffers.
5.
Content
queue_current_entry
queue_current_command
queue_current_arguments
queue_current_logfile
Notifies the client session that it is running in batch mode and should not
display any modal dialogs, error messages, etc.
Notifies the client session of the location of the spatialNET installation.
Notifies the client session of the data dictionary to use
Notifies the client session of the database connection file to use
Notifies the client session of the user to connect as
Notifies the client session to divert all diagnostic output to the nominated
logfile
Security token
Suppress (modal) warning dialogs from the licensing engine.
SPATIALinfo Inc.
35 of 69
Security
The BQM connects to the database using the username and password specified in the database
connection file.
The BQM process requires user authentication to initiate its session. That authentication can come
from one of the following methods:
If the process is started manually, then the person who started it must enter
authentication details.
If design dictionary entry ACCEPT_OSLOGIN is set to Y and the batch manager user
is the same value as the Windows login-id. In this case, the password can be left blank.
NOTE: Leaving the password blank allows all users to log in without entering a
password if their spatialNET username matches their Windows login.
If the design dictionary entry BATCH_USERNAMES (a semicolon-separated list of
usernames) contains the Windows login-id, and the batch manager user is the same
value as the Windows login-id. If so, the password can be left blank. All other users will
still have to supply their passwords.
When the sub-process is launched, the sub-process spatialNET session must be established as the
user who submitted the job, not as the batch manager user.
The batch queue manager passes a /security=<token> command-line argument along with the
other arguments to the sub-process.
This token is a time-stamped one-way hashed signature that is used by the client software to
authenticate the spatialNET user connection. The hashes are valid for approximately five minutes.
The actual database user and password (passed to Oracle) are stored in encrypted form in the
database connection file. Thus, the sub-process can establish its database connection independently
of the spatialNET user authentication.
36 of 69
SPATIALinfo Inc.
The log file created for the sub-processes is called XXXXX-YYYYY.log where XXXXX is the key of
the BATCH_QUEUE row and YYYYY is the key of the BATCH_QUEUE_ENTRY row.
If a batch job fails to launch, or terminates with an error status, a message is added to the
SCM_USER_MESSAGES table, linked back to the SCM_USER row corresponding to the user that
submitted the job.
Purpose
snbatchmon.exe
snbatchmon.ini
snbatchmon.dll
Service executable
Configuration File
Message catalog for Windows Event Viewer
To install the service from the command line, type snbatchmon install
You can invoke snbatchmon interactively from the Command Prompt and receive an appropriate
usage message.
c:\> snbatchmon
usage: snbatchmon.exe <keyword>
where keyword is one of the following words:
install
query
start
pause
continue
stop
delete
SPATIALinfo Inc.
37 of 69
keyword
install
query
start
pause
continue
stop
delete
Action
Registers the binary with the Windows Service Manager.
Installs the message catalog with the Windows Event Viewer.
Displays the current state of the service, including several of the control values that can be
manipulated from the Windows Services panel.
Start the service, if it is not currently running.
All configured queues will be started.
Pause the service, if it is running.
All configured queues will be notified to stop processing; the service will be pause
pending until all queues terminate, then it will become paused.
Continue the service, if it is paused.
All configured queues will be restarted.
Stop the service, if it is running.
All configured queues will be notified to stop processing; the service will be stop pending
until all queues terminate, then it will become stopped.
Deregister the binary with the Windows Service Manager.
This command leaves the message catalog registered so that existing log messages remain
readable.
Service Name:
Binary:
Username:
Service Type:
Start Type:
Error Control:
State:
Type
DatabaseSpecifier
String
Verbose
Integer
38 of 69
Meaning
This parameter must be specified. It is the name of the spatialNET
database specifier file. This file contains details about the Oracle
service name, user details, and so on.
If this parameter is set to non-zero value, the batch monitor will
periodically output more diagnostic information to the event log.
Defaults to 0.
SPATIALinfo Inc.
Parameter
Type
InstallationDirectory
String
Executable
String
DataDictionary
String
SpatialnetUser
String
RetryTimeLimit
Integer
LaunchTimeLimit
Integer
PollTime
Integer
IdlePollTime
Integer
Meaning
If specified, it is the name of the directory that contains the
spatialNET installation.
Defaults to the directory containing snbatchmon.exe
If specified, it is the name of the main spatialNET executable.
Defaults to spatialnet.exe
If specified, it is the name of the spatialNET data dictionary to use.
Defaults to spatialfm
If specified, it is the name of the spatialNET user to connect as. This
user must be defined in the spatialNET system.
Defaults to the Windows username that the service is run as.
If specified, it is the time limit between retries of launching the
Batch Queue Manager. If the sub-process terminates within this
time, the service will issue an appropriate event log entry, and
terminate.
Specified in seconds, defaults to 60.
If specified, it is the amount of time that the service expects the
launch process to take. If launch exceeds this time, Windows may
terminate the service.
Specified in seconds, defaults to 60.
If specified, it is the amount of time that the service waits between
polling the active queues.
The service will generate an event log entry for each queue, each
time it polls the sub-process. This entry indicates the status
information provided by the Batch Queue Manager.
Specified in seconds, defaults to 300.
Similar to PollTime, but this is the time the service waits if there are
no queues currently running.
This parameter is only used when the monitor is paused.
Specified in seconds, defaults to 1800 (30 minutes).
For each configured queue, there must be a corresponding configuration section whose name starts
with the literal Queue. For example, Queue1, Queue2.
At service start time, the Service Monitor will scan the configuration and each Queue section that it
finds will result in an additional Batch Manager process being run. The parameters for each Queue
section are as follows:
Parameter
Type
Meaning
QueueName
String
SpatialnetUser
String
NOTE: Only one process at a time can be processing in a queue, and subsequent attempts to start a
batch processor will fail with an appropriate error message.
Most cases where the Batch Queue Manager terminates are unexpected. In most cases, the error
condition that caused the crash will still apply and the relaunched process will fail immediately.
SPATIALinfo Inc.
39 of 69
To catch this case, the RetryTimeLimit parameter is used. If the time between launch attempts
is less than this limit, the batch monitor will give up on that queue. If multiple queues are being run
by the same monitor, the monitor will continue to run until all queues have failed.
Configuration
Database
Spec
Database
2.
The service reads the configuration file and launches one or more sub-processes
(spatialnet.exe) to run as the Batch Queue Manager(s).
3.
Each Batch Queue Manager connects independently to Oracle and processes its entries in
the BATCH_QUEUE_ENTRY table in the database.
40 of 69
SPATIALinfo Inc.
If a Batch Queue Manager process terminates prematurely for any reason, the monitor will register
an event message, and then attempt to restart the process.
NOTE: If the process terminates prematurely within the time configured by RetryTimeLimit,
then an event message is recorded and the process is not restarted.
If all queues stop, the monitor will issue an event message and enter the paused state.
Meaning
Monitor starting up
Monitor terminated normally
Pause request while not running
Continue request while not paused
A batch queue manager has terminated and will not be restarted (since the termination
was a result of the monitor pausing/stopping)
A batch queue manager has terminated and will be restarted (since the termination was
unexpected)
Process status message
An unexpected runtime error has occurred.
See the Event message for more information
Configuration error. See the Event message for more information
Process runaway (two launch attempts within RetryTimeLimit seconds)
Monitor stopping since no active queues remain
Monitor pausing since no active queues remain
100 to 199: Information about issues that occur during operation, but do not indicate serious
problems.
200 to 299: Configuration errors, or operating system failures that cannot be recovered
from automatically.
200 through 399: Problems that may not automatically resolve themselves. These issues
should be monitored.
Launch Event Viewer. (In the Windows Start button search field, type event viewer,
then click Event Viewer in the results.
SPATIALinfo Inc.
41 of 69
2.
On the Event Viewer window, click the Action menu and select Create Custom View.
42 of 69
SPATIALinfo Inc.
4.
Enter the ID range of the events that you want to monitor. Events in the 200-399 range
should be monitored.
5.
Click OK, and then click OK again when the Save Filter window appears. The Event Viewer
window appears.
6.
In the Actions section of the window, click Attach Task to this Event.
SPATIALinfo Inc.
43 of 69
7.
Follow the on-screen instructions to have the Event Monitor email you when an event
occurs.
SDO_GEOMETRY
The Oracle data type for spatial information is SDO_GEOMETRY. This data type is defined by the
Oracle system owner of spatial data, MDSYS. Spatial data in Oracle has the following structure:
CREA TE TYP E s do _g eome try AS OB JE CT (
SD O_G TYP E
NUMB ER
, SD O_S RID
NUMB ER
, SD O_P OIN T
SDO_ POI NT_ TYP E
, SD O_E LEM _IN FO
SDO_ ELE M_I NFO _A RR AY
, SD O_O RDI NAT ES
SDO_ ORD INA TE_ AR RA Y);
CREA TE TYP E s do _p oint _ty pe AS OB JE CT (
X NUM BER
, Y NUM BER
, Z NUM BER );
CREA TE TYP E s do _e lem_ inf o_a rra y AS VAR RAY (1 048 57 6) of
NUMB ER;
CREA TE TYP E s do _o rdin ate _ar ray A S VARR AY (10 485 76 ) of
NUMB ER;
In addition to owning the definition for spatial data, MDSYS also owns the tables and packages
which provide the support for spatial data within an Oracle Server.
NOTE: You cannot use X and Y for a direct query from Oracle Spatial. Instead, you must
reference <tablename>.coordinates.sdo_point.X and you must define a table alias for the table name
(the table alias can be the same name as the table name). For example: FROM <tablename>
<tablename>,
Metadata configuration
Each spatial attribute defined in the data dictionary and included in a table must have a spatial index.
44 of 69
SPATIALinfo Inc.
Oracle Spatial requires an entry in the metadata view USER_SDO_GEOM_METADATA. This view is
based on the MDSYS table SDO_GEOM_METADATA_TABLE.
USER_SDO_GEOM_METADATA
(
TA BLE _NA ME
CO LUM N_N AME
DI MIN FO
SR ID
);
Each table with a spatial attribute requires an entry in this view for the creation of a spatial index.
The scripts to create the spatialNET tables will populate this metadata view with the information to
support the creation of the required indexes.
SRID
The SRID identifies the coordinate system of the SDO objects within a table column of
type SDO_GEOMETRY.
All SDO objects in a table column must reference the same coordinate system.
The SRID is a foreign key, which must be valid, and references a Coordinate Systems
registered in the MDSYS.CS_SRS table.
To use a coordinate system, spatialNET requires a corresponding entry in the
SPATIALNET_CS_SRS table.
GTYPE
spatialNET only supports the following 2D geometries
2001
2002
2003
Point
Line
Polygon
In a table with SDO data, all geometries must be of the same type.
SPATIALinfo Inc.
45 of 69
NOTE: Spatial indexes may be stored in a different table space from the spatial data.
TO DROP AN INDEX: use the following command: DROP INDEX <name> FORCE;
You can see details of the table spaces a spatial index uses from the user_sdo_index_metadata view
Maintain performance
Two tasks are needed to maintain database performance:
46 of 69
SPATIALinfo Inc.
FIRST-TIME ONLY: While the database is under load, execute the following procedure:
dbms_stats.gather_system_stats
NOTE: This procedure will let the database learn about the performance of the database
server hardware. The database will then use this information when optimizing queries.
2.
Edit orasp_gather.sql to include any column histograms you want gathered at your site.
See Optional scripts for the location of this script.
3.
Log in to the database using SQL*Plus as the user owning the tables.
4.
This command gets statistics for tables, indexes, and a column value histogram for journal (so
the database knows looking up zero is not useful).
Parameters
When rebuilding spatial indexes, make sure to include the parameters. Neglecting to include
parameters can result in removing the constraint on geometry type.
SPATIALinfo Inc.
47 of 69
Layer_gtype: Sets a constraint on the valid geometry types for the SDO objects
indexed (either Point, Line, or Polygon).
Work_table space: Directs Oracle to use a specific table space for the working tables it
creates during the generation of a spatial index
Table space: Sets the table space to hold spatial index tables
Row chaining
Some SDO objects may contain a large number of coordinates, resulting in the chaining of rows. This
chaining requires multiple direct reads to retrieve a single record.
OPTIMIZER_INDEX_CACHING
This setting allows an administrator to force the CBO to favor nested loops joins and IN-list iterators.
The higher the value of this parameter, the more likely that the optimizer will pick nested loops joins
over hash or sort-merge joins. A high value will also force the optimizer to pick indexes using IN-list
iterators over other indexes or full table scans.
Adjusting this setting is not required in Oracle 11
Default setting: 0 out of 100
Recommended setting: 0 out of 100
OPTIMIZER_INDEX_COST_ADJ
This setting allows an administrator to make the optimizer more or less prone to selecting a full table
scan over an index access path.
48 of 69
SPATIALinfo Inc.
The higher the value of this parameter, the more likely that the optimizer will choose a full table scan
over an index path.
Adjusting this setting is not required in Oracle 11
Default setting: 100 out of 100
Recommended Setting: 100 out of 100
QUERY_REWRITE_ENABLED
This parameter enables the optimizer to query materialized views instead of using the normal views.
Allowing Oracle to rewrite queries with a spatial component can result in inefficient processing when
querying spatial data.
Default setting: FALSE
Recommended Setting: FALSE
More information about QUERY_REWRITE_ENABLED
When base tables contain large amount of data, it is time-consuming to compute aggregates or joins
between tables. Oracle Database has the capacity to answer queries using materialized views,
because materialized views contain precomputed aggregates and joins.
For spatial data, this process can slow response time, because the process must go through a series
of checks before running the query.
When it is enabled, Query Rewrite operates on queries and sub-queries in the following types of SQL
statements and sub-queries:
SELECT
CREATE TABLE AS SELECT
INSERT INTO SELECT
UNION
UNION ALL
INTERSECT
MINUS
INSERT
DELETE
UPDATE
SPATIALinfo Inc.
49 of 69
Double-click the spatialNET Job Administrator icon on your desktop, or click the Start
button, then click All Programs, then spatialNET, then spatialNET Job Administrator.
2.
Enter the appropriate information, including the database that you want to work on.
3.
After logging in, see the appropriate section below for information about using the JMS
Administration Tool.
50 of 69
SPATIALinfo Inc.
The All users window allows you to create a new user, see details about a user, or edit or change a
user password.
From the JMS Administration tools All users window, click the New button. The User
Creation window appears.
2.
Enter all the required information and then click the Add button.
From the JMS Administration tools All users window, click a user name and then click the
Select button. The User Details window appears, allowing you to view the details.
SPATIALinfo Inc.
51 of 69
From the JMS Administration tools All users window, click a user name, then click Edit, and
then User. The User Modification window appears.
2.
Make the appropriate changes, and then click Apply to save the changes.
3.
52 of 69
SPATIALinfo Inc.
Change a password
If a user knows the password, but wants to change it, then follow the procedure below. If the user
has forgotten the password, then see Reset a password.
To change a password:
1.
From the JMS Administration tools All users window, select a user name, then click Edit,
and then Password. The Edit password window appears.
2.
Reset a password
If a user has forgotten that password, then use the procedure below to set the password to null. If
the user knows the password and wants to change it, see Change a password.
To reset a password:
1.
From the JMS Administration tools All users window, click a user name, then click Edit, and
then click Reset Password.
2.
Click Yes to confirm that you want to reset the password. The password is set to null.
Delete a user
The following procedure will delete a user from the spatialNET database. A user cannot be deleted if
there is a job associated with that user.
To delete a user:
1.
From the JMS Administration tools All users window, select a user name, and then click the
Delete button. The Entities being deleted window appears.
2.
NOTE: If a job is assigned to a user, you will receive an error message. You will be able to see a list
of jobs assigned to the user, so that you can assign them to other users. Once the jobs are no longer
assigned to a user, then you can delete that user.
NOTE: An Administrator user type is not necessarily a table owner or database administrator.
You can configure spatialNET so that certain menu options appear only for certain user types. For
example, only users with spatialNET administrator status have access to all of the commands
described in this chapter.
SPATIALinfo Inc.
53 of 69
To examine the availability of menu items for each of the available user types, please consult the
Configuration Specification document that came with your spatialNET configuration.
From the JMS Administration tools All users window, click the Security Groups button.
The All security groups window appears.
2.
54 of 69
SPATIALinfo Inc.
3.
Select the appropriate options for each tab of the security group, then click Add. The new
security group is created and added to the list in the All security groups window.
From the JMS Administration tools All users window, click the Security Groups button.
The All security groups window appears.
2.
SPATIALinfo Inc.
55 of 69
3.
Make appropriate changes to each tab the security group, then click Apply. The security
group will be updated.
From the JMS Administration tools All users window, click the Security Groups button.
The All security groups window appears.
2.
Click a security group from the list, then click Delete, and then click Confirm.
56 of 69
SPATIALinfo Inc.
NOTE: You cannot choose which entities to delete. All removed entities will be deleted.
To permanently delete removed entities:
1.
On the spatialNET JMS Administration window, click the Cleanup button, and then click
Cleanup posted removed entities.
Figure 37: The JMS Administration Tool with Cleanup posted removed entities highlighted
Optional: Click All removed to see a list of the removed entities. This list can take some
time to generate.
3.
SPATIALinfo Inc.
57 of 69
In the rare case that a job operations lock is not removed automatically, you can remove it yourself.
Warning: Only remove a lock when you are sure that the operation has completed. Running multiple
JMS administration operations at the same time can cause network corruption.
On the spatialNET JMS Administration window, click the Cleanup button, and then
click Cleanup JMS job operations lock.
Figure 39: The JMS Administration Tool window with Cleanup JMS job operations lock highlighted
On the spatialNET JMS Administration window, click the Debug button, and then click
Status panel. The spatialNET Current Selection window appears.
Debugging tools
There are several debugging tools available under the Debug menu on the JMS Administration Tool
window. Except for the Status option (see View information about the current selection), these
debugging tools should only be used under direction from a spatialNET support engineer.
58 of 69
SPATIALinfo Inc.
On the spatialNET JMS Administration panel, click the Dictionaries button, and then
click Job Definitions. The Job Definitions window appears displaying a list of job
definitions.
On the spatialNET JMS Administration panel, click the Dictionaries button, and then click
User Definitions. The User Definitions window appears.
On the spatialNET JMS Administration panel, click the Field Jobs button. The Find Field
Jobs window appears. From here, you can search for a field job.
Job administration
View all your current jobs
Click the My Jobs button from the spatialNET JMS Administration Tool panel to view a list of all jobs
currently logged to your name in the selected database.
SPATIALinfo Inc.
59 of 69
Find a job
To find a job:
1.
Click the Find job button on the spatialNET JMS Administration window.
2.
Figure 42: The Find Job window with the Description search field highlighted
3.
60 of 69
Click the search operator button to the left of the search field, and then click the
appropriate option.
SPATIALinfo Inc.
NOTE: The Find Job window lists up to 256 jobs at a time. To force the window to show more
matching jobs, click the Retrieve button.
Click the Find job button on the spatialNET JMS Administration window. The My Job
window appears.
2.
SPATIALinfo Inc.
61 of 69
3.
Enter all required details and click the Add button. Click on the Close button to close the
window.
Edit a job
Edit a job from the My jobs or the Find job window. The steps below use the Find job window.
To edit a job:
1.
Click the Find job button on the spatialNET JMS Administration window. The Find job
window appears.
2.
Search for the job using the search fields at the top of the window.
3.
Click a job in the list, then click the Edit button. The Job Modification window appears.
4.
Make appropriate changes, and then click Apply to save the changes.
5.
62 of 69
SPATIALinfo Inc.
Click the Find job button on the spatialNET JMS Administration window. The Find job
window appears.
2.
Search for the job using the search fields at the top of the window.
3.
Click a job in the list, then click the Details button. The Job Details window appears.
Reset a job
If a spatialNET design session crashes for any reason, the job that was open at the time will continue
to be identified as open. That job must be reset before it can be accessed again.
You can reset a job from the My jobs or the Find job window. The steps below use the Find job
window.
To reset a job:
1.
On the spatialNET JMS Administration window, click the Find job button. The Find job
window appears.
2.
Search for the job using the search fields at the top of the window.
3.
Click a job in the list, then click the Reset button. The job is reset and can be opened.
SPATIALinfo Inc.
63 of 69
Troubleshooting
Cannot open a job because it is already open
If a spatialNET design session crashes for any reason, the job will be still identified as open. The job
must be reset before it can be accessed again.
If the user has a Reset button available on the Job Selection window, then the user should
click that button. (An administrator can edit the users security group to enable the Reset
button. See Edit a security group.)
If the user has no Reset button, an administrator must reset the job. See: Reset a job.
64 of 69
SPATIALinfo Inc.
Table of Figures
Figure 1 : Client / server relationship for Oracle Spatial / Locator driver .............................................. 8
Figure 2: dbed2 utility...................................................................................................................... 16
Figure 3: The spatialNET installation Welcome page ....................................................................... 22
Figure 4: License agreement ........................................................................................................... 22
Figure 5: Select Destination Location .............................................................................................. 23
Figure 6: Select Components ........................................................................................................... 23
Figure 7: Ready to Install ................................................................................................................. 24
Figure 8: Login dialog box ............................................................................................................... 25
Figure 9: My Computer Properties with Advanced system settings highlighted ............................... 25
Figure 10: The Environment Variables window ................................................................................ 26
Figure 11: System variables ............................................................................................................. 26
Figure 12: Error message ................................................................................................................. 26
Figure 13: Administrator Command Prompt path .............................................................................27
Figure 14: The JMS admin tool with My jobs highlighted ................................................................. 28
Figure 15: The Queue for Publish option .......................................................................................... 28
Figure 16: The JMS admin tool with My jobs highlighted ................................................................. 29
Figure 17: The Queue for Post option............................................................................................... 29
Figure 18: JMS Administration Results window description of buttons ............................................ 30
Figure 19: The All batch queues window's Display menu ................................................................... 31
Figure 20: The Queue Control window ............................................................................................ 32
Figure 21: The data model ................................................................................................................ 33
Figure 22: BQM process flow ........................................................................................................... 34
Figure 23: The batch queue process ................................................................................................. 40
Figure 24: Search for Event Viewer .................................................................................................. 42
Figure 25: Create a custom view in the Even Viewer ........................................................................ 42
Figure 26: The Create Custom View window.................................................................................... 43
Figure 27: The Event Viewer with Attach Task highlighted .............................................................. 43
Figure 28: The JMS Administration Tool window ............................................................................. 50
Figure 29: The All users window .......................................................................................................51
Figure 30: User details ..................................................................................................................... 52
Figure 31: The User Modification window ........................................................................................ 52
Figure 32: The All security groups window ....................................................................................... 54
Figure 33: The Security Group Creation window .............................................................................. 55
Figure 34: The All security groups window ....................................................................................... 55
Figure 35: The Security group modification window ........................................................................ 56
Figure 36: All security groups delete ............................................................................................. 56
Figure 37: The JMS Administration Tool with Cleanup posted removed entities highlighted .............57
Figure 38: Cleanup of Posted Removed entities window ...................................................................57
Figure 39: The JMS Administration Tool window with Cleanup JMS job operations lock highlighted 58
Figure 40: The User Definitions window .......................................................................................... 59
Figure 41: The All jobs window ........................................................................................................ 60
Figure 42: The Find Job window with the Description search field highlighted ................................. 60
Figure 43: The Find Job window with search operators .................................................................... 61
SPATIALinfo Inc.
65 of 69
66 of 69
SPATIALinfo Inc.
2.
Click Configuration and Migration Tools and then click Net Configuration Assistant. The
Welcome window appears.
3.
Select Local Net Service Name configuration, and then click Next.
SPATIALinfo Inc.
67 of 69
4.
In the window that appears, select Add, and then click the Next button.
5.
In the Service Name field, type the global database name that was set up by the IT
administrator during the Oracle server install.
6.
7.
8.
68 of 69
Obtain the IP address of the server from an IT administrator and enter type it in the Host
Name field. Keep the standard port number of 1521, then click Next.
SPATIALinfo Inc.
9.
Select Yes, perform a test, and then click Next. The test will run.
10. If the test was successful, click Next, and continue to the next step. If the test was not
successful, use the Back button to verify the data entered to this point, then make the
necessary corrections and continue to the next step.
NOTE: If the failure is caused by the user name and password, click the Change Login button
and enter the SPATIALinfo database administrator user name and password.
11. Enter the Net Service Name created during the Oracle server installation, followed by the
server name. Example: servicename.companyname.net_fullservername
SPATIALinfo Inc.
69 of 69
Locate the tnsname.ora file on the computer and on the server at:
c:\oracle\product\11G\client_1\NETWORK\ADMIN
2.
70 of 69
SPATIALinfo Inc.