PS AdminGuide

Version 2013
ProSource
Administration Guide
Copyright © 1999-2015 Schlumberger. All rights reserved.
This work contains the confidential and proprietary trade secrets of
Schlumberger and may not be copied or stored in an information retrieval
system, transferred, used, distributed, translated, or retransmitted in any
form or by any means, electronic or mechanical, in whole or in part, without
the express written permission of the copyright owner.
Trademarks & Service Marks
"Schlumberger," the Schlumberger logotype, and other words or symbols
used to identify the products and services described herein are either
trademarks, trade names, or service marks of Schlumberger and its
licensors, or are the property of their respective owners. These marks may
not be copied, imitated or used, in whole or in part, without the express
prior written permission of Schlumberger. In addition, covers, page
headers, custom graphics, icons, and other design elements may be service
marks, trademarks, and/or trade dress of Schlumberger, and may not be
copied, imitated, or used, in whole or in part, without the express prior
written permission of Schlumberger. Other company, product, and service
names are the properties of their respective owners.
An asterisk (*) is used throughout this document to designate a mark of
Schlumberger.
Schlumberger Private - Customer Use

iv ProSource Administration Guide

Contents
1 Information Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Schlumberger Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2

About Schlumberger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Document Last Updated . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Online Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Typestyle Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Alert Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Related Publications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
Contacting Schlumberger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
2 Overview of ProSource Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Client Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2

ProSource Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
ProSource Transfer Manager (PTM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
IM Administration Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
Information Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
Connection Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
ProSource Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
Data Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
3 Server Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Start/Stop the ProSource Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2

Actions Requiring a ProSource Server Restart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5
Optimize the Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6
Set Server-Side Java Memory Allocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6
Set Client-Side Java Memory Allocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6
Monitor Server Memory/Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7
Manage the Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8
View and Customize the ProSource Startup Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8
View the Tomcat Server Startup Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-10
Create Subserver Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-10
Contents v

Manage ProSource Transfer Manager Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-11
License Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-12
Managing License Changes for ProSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-12
Managing License Changes for ProSource Enterprise . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13
Managing License Changes for ProSource Finder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13
Managing License Changes for ProSource Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-14
Managing License Changes for ProSource Seismic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-15
Establish Co-Located Client and Server (Standalone Mode) . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-16
Reconfiguring the ProSource Transfer Manager Mail Server Parameters . . . . . . . . . . . . . . . . . . 3-17
ProSource Server Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-18
Server Will Not Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-18
No Response From the Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-18
Too Many Java Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-18
4 Connection Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
Specify the Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
REXEC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
SSH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
‘External’ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Specifying the ProSource Server Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
Specifying the ProSource Transfer Manager Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
Manage Datastores and Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
Manage Database Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7
URL Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13
Configure Third-Party JDBC Compliant Database with ProSource . . . . . . . . . . . . . . . . . . . . 4-14
5 User and Security Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
Getting Started with the IM Administration Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3
ProSource-Specific Roles in the IM 
Administration Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4
ProSource-Specific Entitleables in the IM Administration Console . . . . . . . . . . . . . . . . . . . . . 5-5
6 Customize ProSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
Customize the ProSource Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2

Customize the ProSource Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3
Create Quality Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6
Configure the Index Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8
Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8
Third-Party Crawling Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-12
vi ProSource Administration Guide

Manage the Index Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-13
Configure Spatial Index Layer Coordinate System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-24
Configure eSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-25
Generate and Load eSearch Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-25
Configure for Launching eSearch Web in Context . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-27
Enable an E&P Entity from ProSource to Search an eSearch DataType . . . . . . . . . . . . . . . . 6-27
Manage Coordinate Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-29
Synchronized Coordinate System Catalogs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-29
Coordinate System Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-30
Add a Custom Coordinate System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-31
Grid based Transformations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-35
Create a Custom Coordinate System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-36
Create Custom Datum and Spheroids . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-36
Add a Coordinate System Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-39
Delete a Custom Coordinate System, Alias or Projection . . . . . . . . . . . . . . . . . . . . . . . . . . 6-42
View the Properties of Coordinate System Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-43
Create Access to Shapefiles in TreeView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-46
Create JDBC Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-48
Create Custom Well Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-54
Create Custom Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-57
Where Messages are Configured . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-57
Hierarchy of the Message Matching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-58
Add a Message Match . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-58
Add Specific Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-60
Additional References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-60
Launch External Applications or Plug-Ins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-62
Plug-ins That Can Be Configured . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-62
Where the Plug-ins Can Be Launched . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-62
How to Configure the Plug-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-63
Example Plug-In Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-67
Create Custom Behavior Using Trigger Plug-ins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-81
Add a Custom Equality Test Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-85
Register Excel Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-88
7 ProSource Topic Web Service Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
Methods in Topic Web Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
encrypt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
getDatastore
Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
Contents vii

getDatabase Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
getEligibleDatabases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
getTopics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7
getTopicAttribute
Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-8
getFilterOperators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-8
read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9
getBulkData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-15
Beans . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-18
User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-18
Prompt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-18
TopicRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-18
TopicDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19
ReadQSpecification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19
Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19
TopicResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19
Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-20
Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-20
AttributeMetadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-20
BulkDataRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-20
NameValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-21
BulkRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-22
NameValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-22
Session, License Management and Client Timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-23
8 OpenSpirit Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
Integrating OpenSpirit with ProSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2

Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Start OpenSpirit Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Configure ProSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3
Define OpenSpirit User for ProSource Server Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3
Start OpenSpirit User Server for ProSource User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4
Create OpenSpirit User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4
OpenSpirit Data Access Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-5
Modify OpenSpirit Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-6
9 ProSource Seabed Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1
Data Selection Rules Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2

DSR Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2
Administrator Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2
viii ProSource Administration Guide

Understanding the DSR Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2
Using the DSR Utility UI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-3
Using the DSR Utility Command Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-11
Creating Chase Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-13
Managing Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-17
Managing Seabed Databases and Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-18
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-19
10 Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1
ProSource Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2

ProSource Enterprise License Issue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-6
IM Administration Console Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-8
General Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-8
Startup Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-10
Tomcat Server Startup Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-12
LDAP Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-12
Unable to extract data from files stored in ProSource Logs workflows . . . . . . . . . . . . . . . . 10-14
Appendix A ProSource Server Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
ProSource Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
Appendix B Standard Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1
Contents ix

x ProSource Administration Guide

1 Information Resources
In This Section
Schlumberger Product Documentation ......................................................... 1-2

About Schlumberger ............................................................................. 1-2
Document Last Updated........................................................................ 1-2
Online Documentation .......................................................................... 1-2
Typestyle Conventions .......................................................................... 1-2
Alert Statements .................................................................................. 1-2
Related Publications.................................................................................... 1-4
Contacting Schlumberger ............................................................................ 1-6
Technical Support ................................................................................. 1-6
Information Resources 1-1

Schlumberger Product Documentation
About Schlumberger is the leading oilfield services provider, trusted to deliver superior
Schlumberger results and improved E&P performance for oil and gas companies around the world.
Through our well site operations and in our research and engineering facilities, we
develop products, services, and solutions that optimize customer performance in a
safe and environmentally sound manner.
Document Last February 2015

Updated
Online Documentation is provided in the following electronic formats on the Schlumberger

Documentation product media:
• Adobe® Acrobat® PDF files

• Online help
You must have Adobe® Reader® installed to read the PDF files. Adobe Reader
installation programs for common operating systems are available for a free
download from the Adobe Web site at www.adobe.com.
Typestyle The following conventions are observed throughout this guide:

Conventions
• Bold text is used to designate file and folder names, dialog titles, names of
buttons, icons, and menus, and terms that are objects of a user selection.
• Italic text is used for word emphasis, defined terms, and manual titles.
• Monospace text (Courier) is used to show literal text as you would enter it, or
as it would appear onscreen.
Alert Statements The alerting statements are Notes, Cautions, and Warnings. These statements are
formatted in the following style:
• • • • • •
Note: Information that is incidental to the main text flow, or to an important
point or tip provided in addition to the previous statement or instruction.
• • • • • •
Caution: Advises of machine or data error that could occur should the user fail
to take or avoid a specified action.
1-2 ProSource Administration Guide

• • • • • •
Warning: Requires immediate action by the user to prevent actual loss of data
or where an action is irreversible, or when physical damage to the
machine or devices is possible.

Related Publications
The following publications supplement this guide:
Document Description
ProSource* Release PS_ReleaseNotes.pdf
Notes Provides an overview of the release, new features, system
requirements, and last-minute product information.
Included on the ProSource installation kit DVD, and
accessible, after installation, from the Schlumberger
Information Management (IM) Start page.
ProSource Installation PS_InstallGuide.pdf
Guide Provides instructions for installing and upgrading Seabed,
the Information Management Administration (IM
Administration) Console, and ProSource products
Included with the ProSource kit installation CD, and after
installation, accessible from the SIS Launch Page.
Note:
To access the current version of this document, refer to
the SIS Support Portal (https://support.slb.com).
ProSource ViewLoader PS_ViewLoaderGuide.pdf
Guide Provides information on the use and concepts of
ViewLoader, the utility that feeds the ProSource dictionary
information into the Oracle database
accessible, after installation, from the IM Start page.
ProSource Online Help Provides detailed information on ProSource end-user
workflows
Accessible from the ProSource Help menu, Help buttons
on certain dialogs, and by right-clicking on features and
selecting Help from the menu.
ProSource Transfer  Provides context-sensitive information for ProSource
Manager Online Help Transfer Manager end-user workflows.
Accessible by clicking the Help button on the ProSource
Transfer Manager home page.
ProSource Data PS_EntitlementsGuide.pdf
Entitlements Guide Provides information about general entitlements concepts,
and configuring and using data entitlements in ProSource
products.

Document Description
ProSource Extension PS_ArcGIS_InstallGuide.pdf
for ArcGIS Installation Provides information about the ProSource Extension for
and User Guide ArcGIS installation and workflows.
Information Provides information on managing users and security, and

Management accessing Schlumberger Information Solutions products
Administration (IM Accessible from the IM Administration Console Help menu
Administration)
Console Online Help

Contacting Schlumberger
Contacting Schlumberger
Technical Support Schlumberger has sales and support offices around the world. For information on
contacting Schlumberger, please refer to the information below.
For Technical Support for SIS software:
• Schlumberger Support Portal:
http://support.software.slb.com/Pages/Overview.aspx
• Customer Care Center e-mail: [email protected]
• Phone Support:
- SIS Support (main)
http://support.prod.software.slb.com/pages/SupportContacts.aspx

2 Overview of ProSource Components
In This Chapter
Client Interfaces ......................................................................................... 2-2

System Requirements ................................................................................. 2-3
Servers ...................................................................................................... 2-4
Data Sources ............................................................................................. 2-5
Overview of ProSource Components 2-1

Client Interfaces
Client Interfaces
This section describes the client sides of ProSource, ProSource Transfer Manager,
and the Information Management (IM) Administration Console. The ProSource client
interface is accessed via a Web browser. Both ProSource Transfer Manager and the
IM Administration Console can be launched from ProSource, or independently of the
ProSource extension.
ProSource ProSource access technology allows information professionals to browse and

Interface manage information in multiple distributed repositories. The ProSource interface is
customized to display the multiple data types required by various disciplines across
an exploration and production (E&P) organization. ProSource integrates this
information into your workflow to maximize its deployment and value.
ProSource Transfer One of the industry’s biggest challenges is moving data between petroleum E&P
Manager (PTM) data sources in a managed environment. ProSource Transfer Manager is a flexible,
configurable solution for deploying and running data transfer modules. PTM has a
simple data-model independent framework. Java-coded plug-ins provide data-model
specifics and/or data transfer rules. The PTM framework provides XML import/export
of a wide range of XML schemas. It can handle multiple file formats by creating
components that can be plugged in.
IM Administration The IM Administration Console provides Administrators with a single set of tools for 
Console efficiently managing common administration tasks such as user management,
entitlements, and data access, across all Schlumberger Information Solutions (SIS)
IM extensions including Seabed, ProSource, and DecisionPoint.
The IM Administration Console allows the Administrator to:
• Manage Users and Security: You may create, edit, and delete users and roles;
assign objects (entitlements); and, reset passwords. Managing each option
depends on whether you are using an open LDAP or a corporate LDAP.
• Configuration: The configuration workflows allow you to configure the Seabed 
database through the Seabed Oracle Database Manager tool; select and display
server log files; and, configure parameters for server software components that
are deployed through the IM Administration Console. To configure these
parameters, you must be in safe-start mode on the server on which the IM
Administration Console is installed.
• Manage DecisionPoint: You may register projects for defined data sources for
use in DecisionPoint components.
• Manage ProSource: The Manage ProSource workflow allows the Administrator
to create new data source connections for various adaptors which ProSource can
access.
Access the IM Administration Console from the ProSource menu by selecting

Edit>Security to edit roles and entitlements or Edit>Users to edit users. These
actions send the IM Administration Console to the appropriate workflows. For
additional information, refer to the IM Administration Console Online Help.

System Requirements
System Requirements
• • • • • •
Note: ProSource 2013.1 supports the ALT32UTF8 internationalization character
set.
• • • • • •
Note: The Integrated Installer installs ProSource with all its extensions
(ProSource Enterprise, ProSource Logs, ProSource Seismic, ProSource
Results, ProSource Petrel Extension, ProSource Finder* and ProSource
Transfer Manager). For details on the administrative tasks, refer to the
Administration Guide of the respective extensions.
Information Your system must be compliant with the Information Management (IM) 2013.1
Management release. For a detailed list of IM 2013.1 release requirements, refer to ProSource
Installation Guide.
Connection Refer to ProSource Installation Guide for detailed list of version compatibilities.
Changes

Servers
Servers
This section discusses the ProSource server and its components. The server “layer”
consists of the server machine on which ProSource server software is installed (a
Red Hat Linux Enterprise Server release 6.2, Intel 64-bit machine) and the server on
which the IM Administrator is installed. Note that the IM Administrator must be
installed with either ProSource or DecisionPoint, depending upon which one is
installed first. Therefore, if ProSource is installed first, the IM Administrator will
reside on the same server as ProSource.
ProSource Seabed holds the metadata for the IM Administrator, including the user
and security settings for all Schlumberger Information Management extensions and
DecisionPoint configuration settings.
ProSource Server The ProSource server communicates with each federated data source configured in
ProSource (such as GeoFrame* and LogDB*), and sends the real-time data from
those repositories to the ProSource client interface. The ProSource metadata is
stored in Seabed*, and uses the FlexNet server for all license handling.
The following components are installed with ProSource:
• Tomcat Server: An HTTP server used for the ProSource and Transfer Manager
network protocols.
• ProSource Transfer Manager Framework: Components required for
transferring data via ProSource Transfer Manager.
• ViewLoader: The utility used to load ProSource metadata, and to alter or
customize the ProSource interface.
Software and Hardware For a detailed list of the software, hardware and configuration details required for
Requirements installing ProSource 2013.1, refer to ProSource Installation Guide.

Data Sources
Data Sources
Data sources are databases, data files or application data stores from which
ProSource retrieves information. When accessed from ProSource, you can enter,
compare, update, and transfer information to and between data sources, as
necessary. Some of these include:
• Seabed
• GeoFrame
• OpenWorks
• OpenSpirit
• eSearch
• Finder
• LogDB
• Spatial Index (ArcSDE)
• Shapefiles
Custom-defined data sources may include:
• Microsoft Excel spreadsheets
• CSV ASCII files
• CGM files (for maps)
• VRML files (for 3D views of Grid / Interpretation images)
• Related Information/Web Links (HTTP Get and Post)
• Data Transfer Manager
• Custom mechanism

Data Sources

3 Server Management
In This Chapter
Start/Stop the ProSource Server .................................................................. 3-2

Optimize the Server .................................................................................... 3-6
Monitor Server Memory/Processes ............................................................... 3-7
Manage the Log Files.................................................................................. 3-8
License Management .................................................................................3-12
Managing License Changes for ProSource..............................................3-12
Managing License Changes for ProSource Enterprise ..............................3-13
Managing License Changes for ProSource Finder....................................3-13
Managing License Changes for ProSource Logs ......................................3-14
Managing License Changes for ProSource Seismic..................................3-15
Establish Co-Located Client and Server (Standalone Mode)...........................3-16
Reconfiguring the ProSource Transfer Manager Mail Server Parameters .........3-17
ProSource Server Troubleshooting ..............................................................3-18
Server Management 3-1

Start/Stop the ProSource Server

Before starting the ProSource server or the Tomcat server, ensure that the
OpenLDAP service is running. It may have been installed with ProSource or
DecisionPoint, or it may be an external OpenLDAP or Active Directory installation.
ActiveMQ Daemon For internal communications, the ProSource server uses a service called “ActiveMQ
daemon” which runs on port number 61616. This process is required and should not
be shut down when the ProSource server is running. Settings for the daemon are
contained within a parameter file: activeMQ.properties. An example is given below:
THREAD_SLEEP_TIME=2000
MAX_ALLOWED_PROCESS=10
RESPONSE_TIMEOUT=100000
JACTIVEMQ_URL=tcp://localhost:61616
MAX_SLEEP_COUNT=3O
CPLUS_WRAPPER=CurveDataTransformation.csh
CACTIVEMQ_URL=failover:(tcp://localhost: 61616)
If you require to change the port number you can do so by editing the file as
follows:
 To change the port number used by the ActiveMQ daemon

1 Locate the file activeMQ.properties in:
{PSINSTALL}\ps_home\install\psl
2 Open the file in a text editor and locate the parameters:
JACTIVEMQ_URL and CACTIVEMQ_URL
3 Change the port numbers, save, and close the parameter file.
• • • • • •
Note: Please ensure that the port numbers specified for both parameters are
identical and not currently used by other services.
• • • • • •
Note: The parameter MAX_ALLOWED_PROCESS determines the amount of DLIS
files that can be processed concurrently. The number can be lowered to
improve performance or increased to carry out more simultaneous
requests.
ProSource Server Follow the procedure below to start and stop the ProSource server.
 To start and stop the ProSource server

1 Start the Tomcat server on which the IM Administration Console is installed.
2 Start the ProSource server using the following command:

./prosource-server.sh { console|stop|start|restart }
<servername>
• • • • • •
Note: When attempting to shutdown the Tomcat server, you may receive the
following warning message in the catalina.out logfile:

"SEVERE: The web application [/dtmgui] registered the JDBC driver
[oracle.jdbc.OracleDriver] but failed to unregister it when the web
application was stopped. To prevent a memory leak, the JDBC Driver has
been forcibly unregistered"

This warning appears only when a user runs a web application (e.g., PTM,
IM Admin), and then attempts to shutdown Tomcat server. You receive this
message because memory leak detection feature has been introduced in
the latest version of Tomcat.
Table 3-1 Server Script Options
Parameter/ Description
Option
console Starts the server and displays logging output to the console. 
This option may be useful when diagnosing server startup
problems, but it is not the normal mode of operation. 
In this mode, the Ctrl+C command can be used to kill the server.
start Starts the server as a background process.
Logging output is written to a file.
restart Starts a new server instance, and puts the current instance in
“quiesce” mode.
Quiesce mode means that current users can continue to use the
current instance, but it will not accept any new connections. The
current server instance will stop when the last user disconnects.
New users will be connected to the new server instance. This
option starts the new instance on the next free RMI port, as
governed by the “Server Initial RMI Port” and “Number of Alternate
Ports” parameters. These parameters are defined at installation
and are editable using IM Administration Console in safe-start
mode.
Note: The “Restart Server” option in the ProSource user interface
(available only to administrators) uses this option to restart the
server.
stop Stops the server.
servername (Optional) Default is “prosource-server”. The default configuration
file is $PS_HOME/local/conf/prosource-server.conf. If
another configuration file is used, then the servername is
mandatory.

Each time the ProSource server is started, it generates a log file. This log file can be
very useful in troubleshooting. For more information on the log file, refer to the
section “View and Customize the ProSource Startup Log” on page 3-8.

Actions Requiring a All of the following actions require a ProSource server restart:
ProSource Server
• Loading new views
Restart
• Loading a new topic
• Modifying question attributes
• Creating new Quality Admin attributes
 To stop the ProSource server

1 Stop the ProSource server using the following command:
./prosource-server.sh stop <servername>
2 Stop the Tomcat server, if necessary.
3 Stop the OpenLDAP service, if necessary. (This may have been installed with
ProSource or DecisionPoint, or it may have been an external OpenLDAP or
Active Directory installation.)

Optimize the Server
Optimize the Server
Set Server-Side Server-side Java memory allocation is set in the file $PS_HOME/conf/
Java Memory wrapper.conf:
Allocation
# Initial Java Heap Size (in MB)
wrapper.java.initmemory=128
# Maximum Java Heap Size (in MB)
wrapper.java.maxmemory=1024
Set Client-Side The guiOptions parameter ‘maximumMemory’ sets the Memory Meter to use the
Java Memory ‘maximumMemory’ value as its display limit (default value = 512 MB). Only the
Allocation memory meter uses this argument. You must also specify the maximum heap size
accordingly in the ProSource JNLP file ($PS_HOME/conf/prosource.xml):
JNLP: <j2se version="n.n" initial-heap-size="64m" max-heap-
size="512m"/>
Command Line: -Xms128m –Xmx512m

Monitor Server Memory/Processes
Monitor Server Memory/Processes

As processes are running, you can check the server memory allocation. This is useful
if a process seems to be hanging or is becoming memory intensive. Use the
following commands to check on the memory status:
• ps -ef or ps -ef | grep java - provides a more focused list.
• pstree (Linux) - Gives an overview of how processes are related, either grep for
Java, provide the key server process pids, or provide the whole process tree.
• top -b -n 10 (Linux) - Provides a sorted overview of resource usage for the
process.
• • • • • •
Note: The Java virtual machine uses system threads to implement Java threads.
Because Linux threads are implemented as a cloned process, each Java
thread shows up in the process table if you run the ps command. This is
normal Linux behavior.
The prosource-server.sh script should always be used to start and stop the
ProSource server.
This script runs a wrapper application that starts the actual server application in 
a separate child process. The wrapper application automatically restarts the server
in the event of a crash or if the server process is killed. Using the system “kill” 
command to stop the main process (wrapper) will not stop the actual server process
(the child server process would have to be killed as well). Using the kill command to
stop the actual server process will cause the wrapper process to restart the server.
Below are the Linux combined commands to identify the main processes of the
ProSource and Tomcat servers:
 To identify the main ProSource server process

• If there is at most one ProSource instance/process in the server:
ps -efH | grep wrapper | sed -n '2,2p'
• If there is more than one ProSource instances/processes in the server:
ps -efH | grep wrapper | grep | sed -n '2,2p'
 To identify the main Tomcat Web server process

• If there is at most one Tomcat instance/process in the server:
ps -efH | grep Bootstrap | sed -n '2,2p'
• If there is more than one Tomcat instances/processes in the server:
ps -efH | grep Bootstrap | grep | sed -n '2,2p'

Manage the Log Files

You can generate and/or monitor log files for several ProSource functionalities.
These log files can then be used to troubleshoot or optimize performance. This
section discusses the following types of log files:
“View and Customize the ProSource Startup Log” on page 3-8
“View the Tomcat Server Startup Log” on page 3-10
“Create Subserver Logs” on page 3-10
“Manage ProSource Transfer Manager Logs” on page 3-11
“Check Status of License Features” on page 3-12
View and When you start the ProSource server, a log file is generated in the directory
Customize the <prosource_extdir>/logs and named with the following syntax:
ProSource Startup <prosource_server_name>_[YYYYMMDD-hhmmss].log. This file is linked
Log with the log file <prosource_server_name>.log. Every start or restart of the
ProSource server creates a new log file. The old log files are preserved in the /logs
directory.
• • • • • •
Note: All log files are generated in a separate directory that is configured during
installation rather than under the ProSource_Home directory. This enables
you to lock and grant read-only access to the ProSource_Home directory,
thereby preventing it from being modified. To lock the ProSource_Home
directory, run the “prosource-read-only.sh” script from the
“$PS_HOME/bin/” directory.
The output generated to the ProSource server log is controlled by a logging package
called Log4j. You can control the output of the log file by editing the Log4j settings
in the $PS_HOME/conf/log4j-server.conf file.
 To edit the Log4j error handling

1 Back up the $PS_HOME/conf/log4j-server.conf file.
2 Edit the log4j-server.conf file to change the ProSource server log output.
3 Example edit:
The ProSource server log is set to information (INFO) mode by default. If you
would like to change the log output to DEBUG mode for troubleshooting
purposes, edit the log4j-server.conf file and change the following line:
Before edit:
log4j.rootCategory=WARN, DEB, ERR
After edit:
log4j.rootCategory=DEBUG, DEB, ERR

Log4j Formatting Log4j was created for Java by the Apache project. (More about Log4j can be found
at http://logging.apache.org/log4j/docs/index.html).
This package is extremely flexible, both in controlling the amount of output and the
format of the output. Some basic examples are shown below, but for additional
information see the Log4j documentation. Options include logging to sockets, JMS,
and Unix syslog daemons. The installed configuration file shows how to have some
logging go to a different output. If running in Java Console Mode, the server will
write error messages in addition to the standard errors. These errors can then be
redirected to a syslog daemon or a designated file.
The Pattern Layout is powerful in formatting the output. Examples:
|%-5p|%4r| %m %n - |DEBUG| 12| Message text
|%-5p|%4r| %37c [%t] %d{ISO8601} %n - |DEBUG| 12|
com.slb.im.federator.server.main.SomeClass [NameofThread]
2003-11-27 15:49:37,459
The most useful patterns are listed in Table 3-2.
Table 3-2 Log4j Patterns
Pattern Description
c Used to output the category of the logging event. The category
conversion specifier can be optionally followed by precision
specifier, that is a decimal constant in brackets. If a precision
specifier is given, then only the corresponding number of right
most components of the category name will be printed. By default,
the category name is printed in full. For example, for the category
name “a.b.c” the pattern %c{2} will output “b.c”.
d Used to output the date of the logging event. The date conversion
specifier may be followed by a date format specifier enclosed
between braces. For example, %d{HH:mm:ss,SSS} or %d{dd
MMM yyyy HH:mm:ss,SSS}. If no date format specifier is given,
then ISO8601 format is assumed.
m Used to output the extension-supplied message associated with the
logging event.
n Outputs the platform dependent line separator character or
characters. This conversion character offers practically the same
performance as using non-portable line separator strings such as
“\n”, or “\r\n”. Thus, it is the preferred way of specifying a line
separator.
p Used to output the priority of the logging event.
r Used to output the number of milliseconds elapsed from the start
of the extension until the creation of the logging event.
t Used to output the name of the thread that generated the logging
event.
% The sequence %% outputs a single percent sign.

View the Tomcat For troubleshooting purposes, such as Tomcat server startup errors, you can consult
Server Startup Log the Tomcat server log file at <prosource_extdir>/tomcat/logs/catalina.out.
The exact URL for the Information Management (IM) Release Start Page is written
to the Tomcat Server log when the Tomcat server is started. The following is the
syntax for the URL:
http://<IM_Admin_Console_Server_IP_Address>:<Tomcat_port>/
imadmin/suite/index.html
Create Subserver Sometimes the OpenWorks/GeoFrame subserver processes need to be checked or

Logs monitored. This could be necessary when there are problems starting the subserver
or problems during any of the CRUD operation on any OpenWorks/GeoFrame
project. Any reported issues with OpenWorks/GeoFrame access should be followed
by a detailed log analysis for that connection.
 To configure subserver logging

Create a file called .S3_EXEC in the Home directory of the user that is logging into 
OpenWorks/GeoFrame. Note that each Linux/Unix user that requires a log file needs
the .S3_EXEC script located in their Home directory. The .S3_EXEC file should
contain the content shown below.
The exec command writes a log file called <OpenWorks |
GeoFrame>.STDOUT.log to the /tmp directory of the server running the
OpenWorks/GeoFrame extension. You can comment out the exec command to write
to the server/transfer log.
set -a
SUB_MAXTRACE=1
OPTS="$OPTS -DSAC_WARN_PLUS" # more warnings from sub
accessor
OPTS="$OPTS -DSAC_DEBUG" # debug info from sub accessor
OPTS="$OPTS -DSAC_VERBOSE" # even more warnings from sub
accessor
OPTS="$OPTS -DSAC_MINIDEBUG" # log records returned from
sub accessor
OPTS="$OPTS -DSAC_TESTDEBUG" # log test results in sub
accessor
OPTS="$OPTS -DSAC_JNIDEBUG" # log test results in sub
accessor
OPTS="$OPTS -DSAC_ATTRDEBUG" # log access to attributes
OPTS="$OPTS -DSAC_PATHDEBUG" # log path information sent to
sub server
OPTS="$OPTS -DSAC_DEBUG_NOCALL"
OPTS="$OPTS -DSLG_DAC_SUB"
OPTS="$OPTS -DSLG_DAC_PRINT"
OPTS="$OPTS -DSLG_DAC_WARN"
#GeoFrame debug env variables

ADI_DEBUG=1000
APU_DEBUG=1000
#ProSource debug variables


GDI_DEBUG=Print
SLG_DEBUG_GFU=1
GF_DEBUG=Alot
ERR_LEVEL=0 # OpenWorks setting for max debug
LC_ALL=no
exec > /tmp/<OpenWorks | GeoFrame>.STDOUT.log.$$ 2>&1

chmod 777 /tmp/Openworks.STDOUT.log.$$
• • • • • •
Note: You can control the amount of output generated to the log files by adding
to or subtracting from the above example script. However, ensure, that
you monitor the size of the log files and do not exceed the server disk
space limitations.
Manage ProSource Each data transfer produces a log file. The content of the log file is decided by the
Transfer Manager level setting that is designated by the user while configuring the ProSource Transfer
Logs Manager. The default setting is WARN, which only provides information about a
limited number of events. In cases in which the transfer is returning errors, run the
transfer with the highest debug mode. Then, all of the files that are referenced from
the transfer monitor summary page can be submitted for analysis.

License Management
License Management
• • • • • •
Note: This section consolidates all the information about license management
changes for ProSource and all its extensions for easy reference.
Managing License
Changes for
ProSource
 Check Status of License Features

If you need to check the status of license features related to the ProSource server or
ProSource products, run the following command on the server on which FlexNet is
installed:
<flexnet_home>/bin/lmstat –a –c
<physical_path_to_your_license_file>
or
<flexnet_home>/bin/lmstat –a –c
<license_port_number>@<host_name_or_IP>
This command outputs the results in the same xterm from which the command is
run.
 Change FlexNet License Server Configuration for ProSource Stack

If you need to change the FlexNet license server configuration for the ProSource
stack, follow these procedures:
1 Start IM Administration Console in safe-start mode.
cd $PS_HOME/TomcatHome/webapps/imadmin/safe-start-
imadmin.sh
2 Go to Enterprise > LicenseManagement and edit the License Path to
specify the relevant license server location (porthost).
3 Launch./dbadmin on $SDS_HOME/bin
4 Log into the interface and navigate to Tools > Options > FlexNet License
Locations, and edit this entry as above.
5 Change the variable LM_LICENSE_FILE to point to the new license location in
the following file:
$SDS_HOME/.seabed
6 For the Data Copy/Update utility, you must change the LM_LICENSE_FILE
variable in the $PS_HOME/ext_app/psx/Seabed_Utilities/.seabed
file on the ProSource server.
7 If the Seabed Database license server changes, then you must change the
licensing information in the Seabed Oracle Database Manager application and
restart your Oracle instance. For additional information, refer to the Seabed
Oracle Database Manager Guide.

License Management
8 Restart the Tomcat and ProSource servers.
Parallel Processes May Require Same License Features

Some ProSource workflows and operations, particularly those accessing data stores,
require the same license features. For example, it is necessary for the ProSource
user to connect to a datastore like GeoFrame in order to configure a Search Index
job. Connecting to the GeoFrame project will check out the corresponding ProSource
datastore license. When the Search Index job runs, it too will connect to the
GeoFrame project, and it will also check out a ProSource datastore license.
If the Search Index job is scheduled, and it runs before the user disconnects from
the datastore project, two ProSource datastore licenses will be required. If
insufficient licenses are available, the Search Index job will not run, and it will not
issue any warnings or errors. Ensure that you have a sufficient number of pertinent
license features for your workflows, and/or do not run processes in parallel that
require the same feature.
Managing License The ProSource Enterprise workflow has licenses related to ProSource and Seabed
Changes for components. If the license server changes for any of the applications, then you must
ProSource update the license information in the following places:
Enterprise
• If the ProSource/ProSource Enterprise or Seabed Database license server
changes, refer to “Change FlexNet License Server Configuration for ProSource
Stack” on page 3-12.
• ProSource Enterprise uses the Seabed license for Loaders and Exporters (General
ASCII, UKOOA, and LAS). If you want to change the license for these utilities, you
must change the LM_LICENSE_FILE variable in the $PS_HOME/ext_app/
psx/Seabed_Utilities/.seabed file on the ProSource server. Restart the
Tomcat server.
• If you use the Spreadsheet Loader (SSL) from the Seabed Utilities installed on
your ProSource Enterprise client, it uses the Seabed license. If you want to
change the license, you must change the LM_LICENSE_FILE Windows
environment variable on your ProSource Enterprise client machine. If the SSL
license is unreachable from your PC, you may need to add the license server ip-
address to your C:\%SYSTEMROOT%\system32\drivers\etc\hosts file.
• If the GeoFrame or OpenWorks license server changes, you must change the
licensing information in the scripts available in $PS_HOME/scripts. There is a
script corresponding to every GeoFrame or OpenWorks setup (e.g.,
env_GF44_LNX.sh or env_OW2003_12_SOL.sh).
For troubleshooting information about licensing, refer to “ProSource Enterprise
License Issue” on page 10-6.
Managing License If the license server changes for any of the applications, then you must update the
Changes for license information as described in the following steps. You must update license
ProSource Finder information when the following scenarios occur:
• The license server for ProSource or ProSource Finder License is modified.
• The license server for Finder is modified. These modifications can include Finder
license server changes required to launch Finder Loader Control Center, Carto

License Management
Calculator, Deviation Survey Processing, Forms and Reports, or changes required

to launch SSL and SmartDoc.
 To Update License Information if the ProSource or ProSource Finder

License is Modified
Refer to “Change FlexNet License Server Configuration for ProSource Stack” on page
3-12 for more information.
 To Update License Information if the Finder License is Modified

1 If the Finder License server changes, make the following changes for Finder
extproc:
a. Login to the Finder server and shut down the Finder license server using
$FINDER_HOME/bin/stop_la_daemon.
b. Login to the Oracle server for the Finder database and modify the
LM_LICENSE_FILE variable to the new license server in the ENVS section
of the listener.ora file for the Finder database.
c. Go to the home directory of the Oracle OS user for Finder database and
delete .flexlmrc file if it exists.
d. Restart the Oracle listener for the Finder database.
2 If the Finder License server changes are required for launching Finder Loader
Control Center, Carto Calculator, Deviation Survey Processing, Forms and
Reports:
a. Login to the Finder server and edit LM_LICENSE_FILE variable in the
$FINDER_HOME/.finder file.
b. Go to the home directory of all OS users used for launching Finder
applications and delete .flexlmrc file if it exists.
3 If the Finder License server changes are required for launching SSL and
SmartDoc, the finder_lm_license_file parameter of the URL variable must
be changed for each Finder datastore.
a. Login to ProSource as an administrator (sis_admin).
b. In TreeView, navigate to ProSource Admin> Database.
c. Edit the finder_lm_license_file=<lm_license> attribute of the URL
variable for the FINDER datastore.
d. Restart the ProSource server.
Managing License The ProSource Logs workflow has licenses related to ProSource and Seabed
Changes for components. If the license server changes for any of the applications, then you must
ProSource Logs update the license information in the following places:
• If the ProSource/ProSource Logs or Seabed Database license server changes,
refer to “Change FlexNet License Server Configuration for ProSource Stack” on
page 3-12.
• If the license server for DLIS Loader or Edited DLIS/LIS/LAS Export changes,
change the value of LM_LICENSE_FILE variable in $PS_HOME/ext_app/psl/
bin/logs_env.csh.

License Management
ProSource Logs uses the Seabed license for LAS Loader. If you want to change the
license for LAS Loader, you must change the LM_LICENSE_FILE variable in the 
$PS_HOME/ext_app/psx/Seabed_Utilities/.seabed file on the
ProSource server. Restart the Tomcat server.
Managing License ProSource Seismic has licenses related to ProSource and Seabed components. If the
Changes for license server changes for any of the applications, then you must update the license
ProSource Seismic information in the following places:
• If the ProSource/ProSource Seismic or Seabed Database license server changes,
refer to “Change FlexNet License Server Configuration for ProSource Stack” on
page 3-12.
• Change the variable LM_LICENSE_FILE to point to the new license location in
the following files:
$SEISMAN_HOME/scripts/seismic_manager.dat
• Restart the ProSource and Tomcat server.

Establish Co-Located Client and Server (Standalone Mode)
Establish Co-Located Client and Server (Standalone Mode)

Although rarely implemented, the ProSource server and client can be run on a
standalone Linux- or UNIX-based computer. This deployment, which does not need
an already-running server, Java WebStart, or even a network connection, is typically
used on a demo machine.
 To implement a co-located ProSource environment

1 Open the $PS_HOME/local/conf/prosource-server.conf file and perform the
following:
a. Add the COLOCATED_MODE parameter and set the value to TRUE.
COLOCATED_MODE = TRUE
b. Add the GUI_OPTIONS parameter and set the values to match the GUI
options that are set in the $PS_HOME/conf/prosource.xml file.
c. Example:
GUI_OPTIONS = maximumMemory 128 showFormChildCount no
showTreeChildCount yes showNoDataWarningDialog no lookAndFeel
com.incors.plaf.kunststoff.KunststoffLookAndFeel
2 Start the ProSource server. The ProSource program is launched directly on the
computer without the need of a Web interface. When you exit ProSource, the
server also shuts down.
• • • • • •
Note: A co-located environment can also work on Windows platforms, but the
required batch file is not available with the ProSource installation. Check
with your local Schlumberger representative for an appropriate version of
this file.

Reconfiguring the ProSource Transfer Manager Mail Server Parameters
Reconfiguring the ProSource Transfer Manager Mail Server

Parameters
The ProSource Transfer Manager sends e-mail notifications, if the user chooses to do
so, whenever a transfer job is complete. If the e-mail settings (such as the mail
server URL or the administrator’s e-mail address) must be changed, perform the
following steps:
 To Change the Administrator’s E-mail Address

1 Go to the $PS_HOME/TomcatHome/webapps/dtmgui/WEB-INF/web.xml
file.
2 Change the following parameters:
• MailHostName - The name of the outgoing mail server (e.g.,
smtp.mail.xyz.com)
• AdministratorName - The administrator’s name, which will appear in the
‘Site Maintained by’ footer of all pages
• AdministratorEmail - The administrator’s e-mail address
3 Restart the ProSource server and the ProSource Tomcat server.

ProSource Server Troubleshooting
ProSource Server Troubleshooting
Server Will Not If the ProSource server is not starting, take the following actions:
Start
1. Check the ProSource server parameters in the IM Administration Console (safe-
start mode) and make sure all parameter settings are correct:
a. Start the IM Administration Console in safe-start mode ($PS_HOME/
TomcatHome/webapps/imadmin/safe-start-imadmin.sh).
b. Double-click the FederatorConfigurationManagement component
group to open this component group’s list of parameters and values.
c. Edit the parameter values, if necessary.
d. Click OK to save the changes.
e. Exit the IM Administration Console.
2. Check the ProSource server parameters in the $PS_HOME/local/conf/
prosource-server.conf file. Edit the parameter values, if necessary:
• SERVER_ROOT_DIR
• SUBSERVER_ROOT_DIR
• JAVA_HOME
• LD_LIBRARY_PATH
• SERVERNAME - This parameter and the parameter RMI bind name in the
IM Administration Console (safe-start mode) should reflect one another. If
you change this value, ensure that you also change the value in the IM
Administration Console>FederatorConfigurationManagement
component group (see Step 1. page 18).
3. Consult the server log, which is located in the <prosource_extdir>/logs
directory and named with the following syntax: 
<prosource_server_name>_[YYYYMMDD-hhmmss].log. 
Check for indications of particular settings that are incorrect, in particular
conflicts with current running processes.
4. Check the licenses.
No Response From If there is no reply from the server (Example: client receives the message “Failed to
the Server connect to QbmServer”), it is likely that the server is not running properly. This could
be due to depleted resources (memory, file handles, or disk space). Check the server
log file for any indication of why the process is not starting. For more information on
log files, refer to “Manage the Log Files” on page 3-8.
Too Many Java On Linux ProSource server, you may notice that when you start the Tomcat Web
Processes server, several Java processes begin running on the server. Then, once ProSource is
started, the Java processes increase (up to 78 processes).
Linux servers show a process for each running Java thread. For details on how to
examine only the main ProSource and Tomcat Web server processes, refer to
“Monitor Server Memory/Processes” on page 3-7.

4 Connection Management
In This Chapter
Introduction ............................................................................................... 4-2

Specify the Protocol .................................................................................... 4-3
Manage Datastores and Databases .............................................................. 4-6
Connection Management 4-1

Introduction
Introduction
The connections a ProSource Administrator maintains or creates are for the
datastores configured in ProSource and for other ProSource servers. The datastores
include GeoFrame, OpenWorks, LogDB, etc. The links to your federated repositories
are created using the configuration options in the IM Administration Console. This
section explains how to add or alter these links.
• • • • • •
Note: When referring to “connection management”, we are not referring to the
tool “Connection Manager”, which can be launched from the ProSource
interface.

Specify the Protocol

The ProSource server and the ProSource Transfer Manager GUI create local and
remote processes when switching hosts or user context for access to GeoFrame,
OpenWorks, or SeisWorks projects. The protocol used to create processes can be
configured as REXEC, Secure Shell (SSH), or external script.
The ProSource server creates a process on the host associated with a data source
(such as GeoFrame or OpenWorks). The ProSource installer specifies the SSH
protocol when adding a data source (although this can be changed using the IM
Administration Console to edit the data source connection settings). As such, the
default configuration requires that SSH be enabled on the hosts associated with the
GeoFrame, OpenWorks, and SeisWorks databases.
The ProSource Transfer Manager GUI creates processes (usually on the Tomcat Web
server host) in order to run the ProSource Transfer Manager extension as the
current ProSource User (rather than as the Tomcat Server User). The ProSource
Transfer Manager GUI is configured by default to try SSH, then REXEC, then external
script, in that order. The available protocol is then used for the duration of the Web
server process. As such, the default configuration requires that SSH or REXEC be
enabled on the Tomcat server host.
• • • • • •
Note: This guide provides a brief overview of the REXEC, SSH, and External
protocols. Your System Administrator should determine the best protocol
method to use based on your company’s security guidelines.
REXEC By default, REXEC is enabled on a Unix type server but can be disabled. It is
considered insecure because account names and passwords are passed in clear text.
Although this solution is permissible by most corporate security guidelines, it may
not be preferred by System Administrators.
SSH SSH provides secure (encrypted) password-based login when creating local and
remote processes. The SSH daemon (SSHD) must be installed and running on the
host on which the process is created. For more information, consult your System
Administrator.
• • • • • •
Note: You can connect to a non-default ssh port by appending :port_num to
the host name. The example below would connect via ssh on port 2222
rather than on the default of 22:
host=noodle:2222 protocol=ssh
dir=prosource/is6b0a_202/bsl_install tokens=GF 44 url=TEST
‘External’ ‘External’ uses a script that you can use to control how processes are created. With
this method, each process can be configured to your specific environment.

Specifying the Since the default protocol that Prosource uses for database connections is SSH, this
ProSource Server section explains how to configure ProSource to use SSH or External.
Protocol
 To configure ProSource to use SSH

1 Enable SSH on the host on which the processes will be created (database host).
2 In the ProSource Admin, go to the Database question (tree).
3 Select the database you wish to edit, then click the Edit icon in the
ProSource toolbar, or right-click the database line item and click Edit.
4 In the URL attribute—following the new URL convention—specify protocol =
SSH. For more details on the URL convention, refer to “To specify the database
URL” on page 4-12.
 To configure ProSource to use an external script

1 Create a script that specifies how processes should be created, for example, by
using SSH public keys (Contact InTouch Support for example scripts). Name the
script exec.sh and place the script in the $PS_HOME/bin/ directory.
• • • • • •
Note: Once you perform steps 2, 3, and 4 below, the ProSource server will
search for the exec.sh script. Therefore, the script must be the above the
specified name and in the specified location.
2 In the ProSource Admin, go to the Database question (tree).
3 Select the database you wish to edit, then click the Edit icon in the
ProSource toolbar, or right-click the database line item and click Edit.
4 In the URL field—following the new URL convention—specify protocol =
External. For more details on the URL convention, refer to “To specify the
database URL” on page 4-12.
Specifying the This section explains how to configure ProSource Transfer Manager to use REXEC or 
ProSource Transfer External. There is another option for the ProSource Transfer Manager protocol called
Manager Protocol Default. If you set the ProSource Transfer Manager protocol to Default, ProSource
Transfer Manager will try (in this order) the SSH, REXEC, then the External protocol.

• • • • • •
Note: ProSource Transfer Manager uses the Tomcat server to create remote
processes; however, the user authentication also uses the protocol that is
specified in the Database URL field. Therefore, if you wish to use a single
protocol for ProSource Transfer Manager transfers, you must use the
following steps, then specify the protocol within the Database URL field.
For steps on how to specify the protocol within the database URL field,
refer to “To specify the database URL” on page 4-12.
 To configure ProSource Transfer Manager to use REXEC or Default

1 Add the following parameter in the “$PS_HOME/TomcatHome/webapps/
dtmgui/WEB-INF/web.xml” file:
<param-name>RemoteProtocol</param-name>
<param-value>[REXEC | DEFAULT]</param-value>
 To configure ProSource Transfer Manager to use an external script
• • • • • •
Note: If you do not want to use SSH or REXEC, configure ProSource Transfer
Manager to use an external script.
1 Create a script that specifies how processes should be created, for example, by
using SSH public keys (Contact InTouch Support for example scripts). Name the
script “exec.sh” and place the script in the “<prosource_home/bin/”
directory.
• • • • • •
Note: Once you perform step 2, the ProSource server will search for the
“exec.sh” script. Therefore, the script must be the above specified name
and in the specified location.
2 Add the following parameter in the $PS_HOME/TomcatHome/webapps/

dtmgui/WEB-INF/web.xml file:
<param-name>RemoteProtocol</param-name>
<param-value>EXTERNAL</param-value>
3 Add Java system property REMOTE_EXEC_SCRIPT to the CATALINA_OPTS in

the script $PS_HOME/TomcatHome/bin/startup.sh:
CATALINA_OPTS=" -server -Xmx1024m -
DREMOTE_EXEC_SCRIPT=<myscript>"
Where <myscript> is your script location and name created in the first step.

Manage Datastores and Databases

ProSource has all of the required metadata for datastore records. The following
table shows the datastore records available in ProSource:
Table 4-1 Datastore Records
Datastore Name Datastore Type

DICTIONARY DICTIONARY
FEDERATED_SERVICE FEDERATED_SERVICE
GEOFRAME GEOFRAME
LOGDB LOGDB
OPENWORKS2003 OPENWORKS
OPENWORKS5000 OPENWORKS
SDE SDE
SEABED SEABED
SEABED_ADMIN SEABED_ADMIN
SEISWORKS3D SEISWORKS3D
SHAPEFILE SHAPEFILE
SW2003 SEISWORKS
JDBC JDBC
OPENSPIRIT OPENSPIRIT
ESEARCH ESEARCH
To add a new subserver, the only required addition is a new database record. 
The management tasks explained in the section include:
• • • • • •
Note: The following operations are now supported through the configuration
utility present in IM Administration Console under the
ProSource>Connections tab and should be performed using the IM
Administration Console only. However, this section remains since you can
perform the operations from the ProSource Admin node as well.
However, it is advisable to configure using the IM Administration
Console.

For more details, refer to “Manage ProSource>Manage Connections”
section in the IM Administration Console Online Help.
• “To create a database record” on page 4-7

• “To specify the database URL” on page 4-12
• “To delete a database record” on page 4-12

Manage Database A new database record needs to be created if, for instance, you need ProSource to
Records connect to a new repository such as a new GeoFrame instance. The database record
holds all of the parameters required for ProSource to connect to the database.
 To create a database record
1 Select ProSource Admin>Database>Create New in ProSource.

2 Enter the correct attributes for each type of database based on the following
charts.
3 Restart the ProSource client and server for the changes to take effect.
Table 4-2 GeoFrame Database Attributes
Attribute Correct Value

Datastore GEOFRAME
Name
Database Combination of version, TWO_TASK and the platform
Name (Example: GF45-Sol-gf45sol)
Two Task TWO_TASK
Driver com.slb.im.federator.server.dataaccess.geoframe.GeoFrameSubSe
rverImpl
URL host=x <hostname=x > <protocol=x > dir=x token=x
<version=x > URL=Geo-Frame Oracle SID
Note: Keywords in brackets are optional.
Example:
host=134.32.71.75 hostname=SCAIMD75 dir=/imd/bsl/source/
is6b0a_212/bsl_install tokens=GF411 version=GeoFrame4.4
url=GST0D0.CMZGFD0
Type n/a
Seq Name n/a
Class Name com.slb.im.federator.server.dataaccess.sub.SubServerDatabase

Table 4-3 OpenSpirit 3.2.3 Parameters

Datastore OPENSPIRIT (case-sensitive)
Name
Database Free form name selected by user - something useful that helps
Name identify the datastore (Example: OPENSPIRIT-GF44CMZ)
Two Task Required text, but not relevant to OpenSpirit. 
Suggestion: Use a hyphen (-).
Driver Required text - must be oracle.jdbc.OracleDriver
URL Required text - Name of datastore ending in suffix ‘_OSC’ (case 
sensitive). Contact your OpenSpirit Administrator for this
information or get the name from the native OpenSpirit client.
Note: OpenSpirit requires separate data stores to be configured
for well models, interpretation data, and Charisma (seismic) data.
Datastores already configured with the OpenSpirit server can be
viewed using the OpenSpirit data store configuration tool
ospconfig, found under \$osp_home/bin/ where
\$osp_home is the installation directory of the OpenSpirit server.
Type Required text - must be ‘OPENSPIRIT’ (case sensitive)
Created date No action is needed. This will be generated automatically.
Created by No action is needed. This will be generated automatically.
Seq Name Required text - but not relevant to OpenSpirit. 
Suggestion: Use ‘seq’.
Class Name Required text - Must be
com.slb.im.federator.server.dataaccess.coral.CoralOpenSpiritData
base
Table 4-4 OpenWorks Database Attributes

Datastore OPENWORKS2003
Name
Name (Example: OW-Sol-ow2003so)
Two Task TWO_TASK
Driver com.slb.im.federator.server.dataaccess.owdk.OWSubServerImpl


<version=x >
URL=OpenWorks Oracle SID:TNS_ADMIN:OpenWorks home 
directory
Example:
host=134.32.71.72,134.32.71.75
hostName=SCAIMD72,SCAIMD75 token=OW2003_12 dir=/imd/
bsl/source/is6b0a_212/bsl_install url=ow200312:/imd/app/
oracle/network/admin
Type n/a
Seq Name n/a
Class Name com.slb.im.federator.dataaccess.sub.SubServerDatabase

Table 4-5 OpenWorks 5000 Database Attributes

Datastore OPENWORKS5000
Name
Name (Example: OW5000-Lnx-owr5032)
Two Task TWO_TASK
Driver com.slb.im.federator.server.dataaccess.owdk.OWSubServerImpl
<version=x >
URL=OpenWorks Oracle SID:TNS_ADMIN:OpenWorks home 
directory
Example:
host=134.32.71.72,134.32.71.75
hostName=SCAIMD72,SCAIMD75 token=OW5000_12 dir=/imd/
bsl/source/is6b0a_212/bsl_install url=ow200312:/imd/app/
oracle/network/admin
Type n/a
Seq Name n/a
Table 4-6 SeisWorks 2D Database Attributes

Datastore SW2003
Name
Name (Example: SW2003.12-Sol-2D-OW2003SO)
Two Task TWO_TASK
Driver com.slb.im.federator.server.dataaccess.owdk.SWSubServerImpl
<version=x >
URL=2:OpenWorks Oracle SID:TNS_ADMIN:OpenWorks home 
directory:directory containing plist.dat file
Type n/a
Seq Name n/a

Table 4-7 SeisWorks 3D Database Attributes

Datastore SEISWORKS3D
Name
Name (Example: SW2003.12-Sol-3D-OW2003SO)
Two Task TWO_TASK
Driver com.slb.im.federator.server.dataaccess.owdk.SWSubServerImpl
<version=x >
URL=3:OpenWorks Oracle SID:TNS_ADMIN:OpenWorks home 
directory:directory containing plist.dat file
Type n/a
Seq Name n/a
Table 4-8 ArcSDE/SDE Database Attributes

Datastore SDE
Name
Database Name of the Database
Name (Example: SDE-spdb)
Two Task TWO_TASK
Driver Oracle.jdbc.OracleDriver
URL sdeHost=IP Address of the SDE Host
sdePort=SDE Port Number
sdeProject=SPDB project account name
Type SDE
Seq Name seq
Class Name n/a
Table 4-9 JDBC Database Attributes

Datastore JDBC
Name
Database <name_of_jdbc_db>
Name


Two Task <two_task_of_jdbc_db>
Driver oracle.jdbc.OracleDriver
URL jdbc:oracle:thin:@<ip_address>:<oracle_port>:<jdbc_db_name
>
Type sql
Seq Name seq
Class Name n/a
• • • • • •
Note: For information on generating metadata for JDBC databases, refer to
“Create JDBC Metadata” on page 6-48.
Table 4-10 eSearch Database Attributes

Datastore ESearch
Name
Database ESearch
Name
Two Task ES32SPOU
Driver oracle.jdbc.OracleDriver
URL url=“192.23.8.97:3031”customer=DataCentre Customer”
“client=EP Technical Record”
Type ESearch
Seq Name N/A
Class Name N/A
 To specify the database URL

Within the URL attribute, you can control custom settings, such as which version
and protocol to use.
 To delete a database record

1 Open the question ProSource Admin>Database and perform a search on all 
of the records.
2 Highlight the database that you would like to delete, then click the Delete
Row icon on the toolbar. The row information is then removed.
3 Click the Save icon.

4 Restart the ProSource client and server.

URL Syntax The URL syntax accepts space-separated keyword/value pairs. Keywords and values
are separated by an equal sign ('='). Supported keywords in the URL field are as
follows.
Table 4-11 URL Keywords
Keyword Value
host host IP address(es) - to use when creating remote process.
hostname host name(s) - optional; value(s) to display in Database Connection
dialog instead of host(s).
protocol (optional) protocol(s) for the corresponding host(s): SSH (default),
REXEC, or EXTERNAL (see “Specify the Protocol” on page 4-3 for
details of each type).
dir directory(s) on remote host(s) containing startup script.
token product-specific portion of script name to execute.
version (optional) value(s) to display in Database Connection dialog
instead of token(s).
url values for GeoFrame or OpenWorks/SeisWorks - see URL definition for
semicolon format - same.
Validation- (optional). If added, ProSource validates that the user has access to
Table this table during the login process. This can be used to prevent the
user from logging in with a valid Oracle account, which does not have
access to the required schema. As an example, for Finder projects, the
following keyword is added by default: “ValidationTable=WELL_HDR”.
Notes about the keyword syntax:

• When there is a mismatch in a number of values on different keywords, the last
value will be repeated the necessary number of times.
• When more than one value is defined for the version and host, those prompts in
the Database Connection dialog become selectable.
• For ProSource, if the protocol is not specified in the URL, SSH is used by default.
• It is possible to use host names as the host parameter value, but the host name
must be valid when creating the remote process.
• It is possible to have more than one token/version. This can be used when an
Oracle instance supports more than one GeoFrame or OpenWorks version.
• The StartSubServer script uses the token to create the product-specific portion of
the GeoFrame or OpenWorks/SeisWorks environment script to execute: For
example, the “token=GF44” executes script “env_GF44_<SOL or LNX>.sh”.
Scripts reflecting the supported version are located in the directory
“$PS_HOME/scripts”.
Example URL The following shows the syntax for the URL field:
host=134.32.71.72,134.32.71.72 protocols=ssh,rexec
hostnames=SCAIMD72_SSH,SCAIMD72_REXEC dir=prosource/

is6b0a_202/bsl_install tokens=GF44 version=,,OldGF

url=GST0D0.CMZGFD0
In the above example, if host name SCAIMD72_REXEC is selected in the
Database Connection dialog, the subserver process will be created on host
134.32.71.72 using protocol REXEC and will execute script prosource/
is6b0a_202/bsl_install/env_GF44_<SOL or LNX>.sh.
Configure Third- This section explains how to configure a third-party JDBC compliant database with
Party JDBC ProSource.
Compliant
Database with
ProSource
• • • • • •
Note: Only JDBC-compliant Oracle databases are supported.
 To configure a third-party JDBC compliant database with ProSource

1 Log onto the ProSource client as a user with admin privileges.
2 Open the ProSource Admin>Database>Create question.
3 Insert the configuration values of the JDBC database and save the record.
4 Restart the ProSource server and client.
5 Launch the ProSource client.
6 Connect with the newly configured JDBC database using the question: 
ProSource Admin>Generate Metadata>JDBC Metadata
• • • • • •
Note: You can configure more than one JDBC database with ProSource. Make
sure that database names are unique.

5 User and Security Management
In This Chapter
Introduction ............................................................................................... 5-2

Getting Started with the IM Administration Console....................................... 5-3
User and Security Management 5-1

Introduction
Introduction
All user and security management is configured using the IM Administration
Console.
The IM Administration Console provides Administrators with a single set of tools to
efficiently manage common administration tasks such as user management,
entitlements, and data access across all Schlumberger Information Solutions (SIS)
IM extensions such as Seabed, ProSource, and DecisionPoint.
The IM Administration Console allows the Administrator to do the following:
• Manage Users and Security - Create, edit, and delete Users and Roles, assign
Objects (entitlements), and reset passwords (each option is dependent on
whether you are using an OpenLDAP or a Corporate LDAP).
Users can be granted access to standard ProSource workflows and features by
adding the user to a predefined role. Users can also be granted access to plug-in
applications to create, read, update, and delete “capabilities” used to access
datastores. As delivered, ProSource adds read capabilities for standard datastores
(OpenWorks, GeoFrame, Finder) to the SIS_Public role. Entitleables (Entitleable
Objects in IM Administration Console) in the SIS_Public role are accessible to all
users. When a user logs into ProSource, the ProSource server retrieves and
caches the user's entitlements for the duration of the user's sessions.
• • • • • •
Note: A user has multiple sessions (connections to the server) when using the
ProSource extension and the PTM User Interface simultaneously. If a Role, 
plug-in application, or capability entitlement is revoked (explicitly or by
expiration), the change does not take effect until the user logs out (all
sessions) and then logs into ProSource.
• • • • • •
Note: If you are configured against a corporate LDAP directory and you want to
configure to an OpenLDAP directory instead, you must configure and start
the UserManagement service to turn on the Create, Edit, and Delete User
workflows. Ensure that the password and manager account for your LDAP
installation are correct in the UserManagement component. Refer to
“Access Manage Servers” in IM Administration Console Online Help.

If you are configured against an OpenLDAP directory and you want to
configure against a corporate LDAP directory, you must stop the
UserManagement service to disable the Create, Edit, and Delete User
workflows.
• Manage ProSource - Manage the ProSource server parameters.

For more information on administration tasks, refer to “Manage ProSource”
section in IM Administration Console Online Help.

Getting Started with the IM Administration Console

This section explains how to start the IM Administration Console and the initial
configuration required after installing ProSource.
 To launch the IM Administration Console from the ProSource menu

1 After installing ProSource, start Tomcat and the ProSource servers. Login to
ProSource using the sis_admin account since there is no user account yet
created.
2 From the ProSource menu, select Edit>Security (edit roles and entitlements)
or Edit>Users (edit Users) to launch the IM Administration Console to the
respective workflow.
• Linux clients: You may be prompted to install the JRE on your machine.
Whether you are prompted is based upon the JRE version currently installed
on your machine. If you are not prompted, download the JRE version
specified earlier in this document from http://www.java.com, install it
manually, and then relaunch the IM Administration Console.
• Windows clients: If the JRE has been previously installed, do not
download a JRE version later than the version required for this release. If the
JRE is not installed, accept the prompt to download JRE.
When launching the IM Administration Console from ProSource, the user
credentials used to log in to ProSource are automatically used to log in to the
IM Administration Console.
 To launch the IM Administration Console from the IM Release Start

Page
1 Open the IM Release Start Page. Example URL:
http://<IM_Admin_Console_Server_IP_Address>:<Tomcat_port>/
imadmin/suite/index.html
2 Click Administration Console.

ProSource-Specific The following Roles are created in the security management system by the
Roles in the IM  ProSource installer:
Administration
Table 5-1 Default Roles in the IM Administration Console Specific to
Console
ProSource
Default Roles Description

qc_admin Users that are granted this role will be able to manage the
Quality Attributes. For more information on creating Quality
Attributes, refer to “Create Quality Attributes” on page 6-6.
connection_ admin Users granted this role can make connections public (available
to all users of the ProSource installation).
dtmgui_admin Users that are granted the dtmgui_admin role will be able to
access Transfer Manager, run all ProSource Transfer Manager
transfers, view all transfer information for all users, and view
additional logging information.
dtmgui_user Users that are granted the dtmgui_user role will be able to
access ProSource Transfer Manager, run all transfers, and view
transfer information for that user.
Table 5-2 Common Roles in the IM Administration Console
Common Roles Description

sis_public Users that are created are automatically granted this role.
Refer to note below regarding the sis_public role.
administrator A user who has been granted the administrator role has all
entitlements.
In the IM Administration Console, these roles can be viewed or modified by clicking 

Users and Security>Roles in the left menu bar.
• • • • • •
Note: The sis_public role is assigned to all newly created users by default and
cannot be removed. ProSource adds Read capabilities for datastore
adaptors bundled with ProSource to the sis_public role.
• • • • • •
Note: To restrict a user's access to all objects, you must remove the restricted
access objects from the sis_public role.

ProSource-Specific The dictionary defines different capabilities for all data types in the various data
Entitleables in the sources. The following are four capabilities for each topic (tree node) in ProSource,
IM Administration each representing an action that members of a Role can perform on a given topic:
Console
• Read (search, view)
• Create (new)
• Update (modify existing)
• Delete (remove)
Plug-in applications can be entitled to roles and users. Refer to the ProSource Data
Entitlements Guide for detailed information on roles and users.
In the IM Administration Console, plug-in applications can be viewed (but not
modified) by clicking Users and Security> Objects> Applications.
 To begin the User and Role management

The following workflow serves as an overview of the first steps that should be done
within the IM Administration Console. For specific information on how each step is
done and for further information on the general concepts of the IM Administration
Console, refer to the IM Administration Console Online Help, which can be launched
from the IM Administration Console menu under Help>Help Contents. Within the
Help, refer to “Getting Started”.
1 Create new Users and assign Users to Roles.
• • • • • •
Note: The Administrator Role is given access to all areas and functionalities of
ProSource.
• • • • • •
Note: An error will display, if you try to create users with the same name as the
Project Name.
2 The sis_admin account should only be used upon initial setup. Therefore, at
this point, log out of the IM Administration Console and log back on as the new
Administrator User or User with the Administrator Role.
• • • • • •
Note: Do not lock the SIS_Admin account after ProSource installation, as it is
used while starting up the ProSource server and for various administration
workflows.
3 Create the Roles that will be granted certain Capabilities, or, if you are in an
open LDAP, first create the Users and Groups, then create the Roles with
granted Capabilities.

• • • • • •
Note: An example workflow to create a Role for Finder Users is provided in the
IM Administration Console Online Help under Getting
Started>Example Role Workflow for ProSource.

6 Customize ProSource
In This Chapter
Customize the ProSource Tree ..................................................................... 6-2

Customize the ProSource Interface .............................................................. 6-3
Create Quality Attributes ............................................................................. 6-6
Configure the Index Search......................................................................... 6-8
Configure Spatial Index Layer Coordinate System ........................................6-24
Configure eSearch .....................................................................................6-25
Manage Coordinate Systems ......................................................................6-29
Create a Custom Coordinate System ...........................................................6-36
Create Access to Shapefiles in TreeView ......................................................6-46
Create JDBC Metadata ...............................................................................6-48
Create Custom Well Symbols ......................................................................6-54
Create Custom Error Messages ...................................................................6-57
Launch External Applications or Plug-Ins .....................................................6-62
Add a Custom Equality Test Option .............................................................6-85
Register Excel Templates............................................................................6-88
Customize ProSource 6-1

Customize the ProSource Tree
Customize the ProSource Tree

The default ProSource tree structure (as shown in TreeView) can be customized to
reflect client-specific workflows. The customizations can be done with respect to the
information available and the information’s layout and format. The tree structure
customizations are maintained and created using a utility called ViewLoader.
ViewLoader is a command line utility that is installed with ProSource. For more
information on customizing ProSource using ViewLoader, refer to the ProSource
ViewLoader Guide, accessible from the IM Start Page.

Customize the ProSource Interface

The ProSource interface can be customized to have a certain default background
layer for all GisView displays. These customizations can be set as default
preferences either for the current user or for all ProSource users.
Most customizations can be set and maintained through the ProSource interface by
selecting Edit>Preferences from the ProSource menu. This launches the Edit
Preferences window.
Fig. 6-1 Edit Preferences Window
When logged on to ProSource as an Administrator, you can select the option Store
settings as the default public preferences.
The options through the Edit Preferences window are maintained in the file
$PS_HOME/conf/prosource.xml. You can set additional preferences by

modifying the prosource.xml file. Table 6-1 shows the values in the prosource.xml
file as well as their corresponding GUI locations (if applicable).
Table 6-1 Interface Parameters in the Configuration File
Corresponding
Parameter Edit Preferences Description Valid Value
Window Location
@@RMI_REGISTRY Not available (Do not edit) n/a
through GUI Placeholder for
actual registry
host/port,
replaced by the
server when
serving the jnlp
file to the clients.
@@SERVERNAME Not available (Do not edit) n/a
through GUI Placeholder for
actual server
name, replaced by
the server when
serving the jnlp
file to the clients.
maximumMemory Not available The maximum Max memory
through GUI amount of in MB
memory to be (Example:
used by the JVM 512)
on the client
addBackgroundLayer GisView tab > Add Adds a yes | no
background layer background
when GisView is ArcIMS service to
created the GISView
showFormChildCount FormView tab > Show the number yes | no

Show tabs with of children from
children records the current node
showTreeChildCount Tree tab > Show Show the number yes | no
Related of children found
Information row for the current
count in question tree node
tree
showNoDataWarningDialog Tree tab > Show a Show a warning yes | no
warning dialog if dialog if there are
no data is found no children found
for the current
tree node

Corresponding
Parameter Edit Preferences Description Valid Value
Window Location
lookAndFeel Not available Java look and feel pointer to
through GUI that is used by the kunstoff file
extension
backgroundImage Not available Path to the n/a
through GUI background image
that is displayed
on the ProSource
desktop
If you are using a proxy server and would like to view or add a background layer to
the GisView map, add the following proxy specific variables in the file $PS_HOME/
conf/prosource.xml:
Table 6-2 Interface Parameters in the Configuration File for a Proxy Server
Parameter Description
proxyServer Proxy server IP address
proxyPort Proxy server Port Number
proxyDomain Proxy server domain value
proxyUser (optional) Proxy username
proxyPasswordEncrypted (optional) Encrypted proxy password
proxyPassword (optional) Plain text proxy password
proxyHttps (optional) Add this keyword if the proxy uses https

Create Quality Attributes

In the context of a data quality control process, ProSource provides the option to
attach pre-defined Quality Attributes to a specific topic or set of topics in the
database. The Quality Attribute values can be set by users at your site and reviewed
at any time during the data's life cycle. The data being verified can be in any data
source accessible from ProSource. Quality Attributes are stored in a separate
database from data to which they are applied. To apply Quality Attributes, data must
have a natural key.
An example of when you would assign Quality Attributes, is when the data being
loaded needs to be verified by a geologist to ensure that it was loaded correctly. You
would create a Quality Attribute for the topic in ProSource, and then the geologist
(with rights to assign Quality Attribute values) would update the Quality Attribute for
each row to verify whether the data is “Good” or “Bad”. Once the data has been
verified, users can then query that topic for which the Quality Attribute is “Good”
and use only those records in their workflows. Furthermore, you can then create
Select Lists to transfer only the “Good” data to different data sources.
 To create and assign a Quality Attribute to a question

Pre-requisite: Must be a member of the QC_Admin role. For further information on 
assigning Users to Roles, refer to the Information Management Administration (IM
Administration) Console Online Help.
1 Create the attribute.
a. In TreeView, navigate to Federated Services>Quality
Admin>Attribute Name>Create Attribute Name .
b. Enter an Attribute name, and select an Attribute type from the picklist.
Attribute types are predefined and cannot be edited in ProSource.
• • • • • •
Note: The name for the new attribute should be a unique name. Do not use the
same name as an existing attribute. You must assign the Picklist attribute
type to the new attribute in order to be able to select the external object
name and attribute name from a picklist. If you assign a different attribute
type to the attribute, the picklists will be blank.
c. Click Save to create the new Attribute Name.

2 Link the Quality Attribute to a topic.
Admin>Attribute Use>Create Attribute Use .
b. Enter an External object type name or choose one from the picklist. The
External object type name is the topic that will be assigned the Quality
Attribute created in Step 1. Note that the object must have a natural key.

• • • • • •
Note: To find out the topic name for a particular question in ProSource, navigate
to the question in TreeView, right-click on the question name, and select
Dictionary>Show Topic Information (must have read access to the
Dictionary). Use the Topic name shown in TableView for the External
object type name attribute.
c. Select an Attribute name from the picklist, typically the Attribute name
created in Step 1.
d. Enter Y (yes) or N (no) in the mandatory field. Entering “Y” forces users to
set the Quality Attribute for that topic if users try to manage the quality
attribute.
e. Click Save to link the Quality Attribute to the specified topic.
3 If the Quality Attribute type is a picklist, create the options for the picklist.
Admin>Reference Value>Create Reference Value .
b. For each picklist option, add a table row. For example, if you have one
Quality Attribute titled QC1 and you want the picklist options to be “Good’
and “Bad” (signifying good and bad data), create two Reference Value rows,
as in the following example:
Fig. 6-2 Example: Two Reference Values for One Picklist
c. Click Save to save the new Quality Attribute picklist values.

4 Restart the ProSource server.
Once the Quality Attribute has been created for a question, any ProSource user
assigned to the QC_Admin Role can then update the Quality Attribute
information for the question. Roles should be defined to ensure that only
authorized persons update the Quality Attribute information. For information on
how a user updates and uses Quality Attribute values, refer to the ProSource
Online Help.

Configure the Index Search

The Index Search allows you to perform both attribute-based searches (Example:
search_keyword=oil) as well as spatial searches (within 5 KM of selected objects on
the map) on the index.
Once you execute a search, you can view the search results in TreeView,
TableView, or FormView. You can also view the data directly on the map (for
spatial data) without having to connect to the original database to query for the
spatial data.
The advantage of the Index Search is that it works off a structured index of your
data, which makes it extremely fast (similar to internet search engines). In addition,
it does not depend on a connection to your database at the time you perform the
query. This eliminates the connection bottleneck when querying across multiple data
sources.
Prerequisites • The Index Search feature requires the eims_ds_index license.

• Ensure that the parameters related to the Index Search feature, which are
managed in the IM Administration Console safe-start mode, are configured
correctly.
 To check the Index Search configuration

1 Open the IM Administration Console in safe-start mode.
a. Log onto the server on which Seabed and the IM Administration Console
were initially installed, and browse to the IM Administration Console Install
directory. This directory and path is specific to your installation.
b. Execute the safe-start script for your environment:

Windows: safe-start-imadmin.bat
Linux: safe-start-imadmin.sh
c. The IM Administration Console launches in safe-start mode.
2 Click the ProSource tab to see a list of component groups related to
ProSource configuration.
3 Double-click IndexManager to open the Server Configuration dialog box for
the IndexManager Component Group (Figure 6-3).

Fig. 6-3 Server Configuration for IndexManager
4 Edit the parameters, if necessary:

• Index Directory - (Default value is “../search_index”.) The directory,
relative to the ProSource installation directory, contains the Index database.
The database is created when the first Index job is run from ProSource.
• • • • • •
Note: The path should be relative to the ProSource installation directory 
(or absolute). Do not use $PSHOME in the path name.
• • • • • •
Note: Changing this directory after populating the index will result in 
creation of a new database which will not contain items in the database
associated with the old directory.
• Make cache attributes searchable – (Default value is “true”). This

parameter is available for the purpose of allowing an Administrator to build
other extensions on top of the index. ProSource will store the value of any
attribute selected to cache when the index is configured. Third-party
applications will then have access to the cached value in the index. Currently,
ProSource only uses the cached attributes for shapes.
• Cache shape with attributes – (Default value is “false”). ProSource
automatically caches shapes in its own spatial index schema. If this option is
set to “true”, shapes will also be cached together with the other cached
attributes, in addition to being available for spatial search. Unless you are

using a third-party application (which needs the shape information) built on

top of the index, this parameter should always be set to false.
• Enable Web Search – (Default value is “false”). This parameter enables
ProSource to search for data on external webpages (Example:
www.google.com).
• • • • • •
Note: Enter Web Search Base URL below if you set web search to true.
• Web Search Base URL – (Example: www.google.com) The Index Manager

uses this parameter to access its corresponding webpage while searching for
data.
• Max Number of Active Jobs – (Default value is “3”) The value of this
parameter determines the maximum number of parallel jobs. For example,
you can limit the number of concurrent jobs to 6. As a result, if a user
submits 100 jobs, the parallel execution is restricted to 6. This reduces the
risk of a ProSource server crash, a licence shortage, or both.
• Max Number of Active Jobs per Datastore (optional) – (By default, the
value of this parameter is not set, in which case there is no constraint for
each datastore.) This parameter specifies the number of concurrent index
jobs for each datastore type. An index job can fail if it runs when a native
datastore license is unavailable. Use this parameter to restrict the number of
concurrent jobs for a datastore type when the native datastore licenses are
limited in number. Use the datastore type names listed in Table 4-1 on page
4-6 or query for datastore types in ProSource using the ProSource Admin
> Datastore node.
• • • • • •
Note: Use a semi-colon to delimit values, for example:
“OPENWORKS2003=3;GEOFRAME=4;FINDER=5".
The total number of concurrent jobs is always constrained by parameter “Max

Number of Active Jobs”.
• Unsupported Datastores for indexing – (Default value is
“ENTITLEMENT;FEDERATED_SERVICE;INDEX;DICTIONARY”). This
parameter lists the datastores that are not supported for indexing in
ProSource. You can modify this list depending on whether a datastore
contains data that requires indexing.
• Max Resolution in Meters for Shape – (Default value is “50”). This
parameter compresses or samples the shape data. An algorithm uses this
parameter to determine the resolution of the sampled shape data. As an
example, for a maximum resolution of 100 meters, the algorithm could pick
two points at a distance of 100 meters though there could be 100 points in
the original shape data. Compression ratio in this case is 99%.
• Enable coordinate system verification (optional) – (Default value is
“false”). This parameter enables verification of the project coordinate system
for the indexed job before the job is submitted to run. The project coordinate
system is verified if the indexed data store includes a shape attribute and the
coordinate system of the datastore is defined in another component known

as ProjectCoordinateSystem. For further information on the

ProjectCoordinateSystem Component Group, refer to page 11 .
• • • • • •
Warning: The spatial data or shape attribute cannot be indexed if the alias of
the project coordinate system is either defined incorrectly or not
defined at all.
5 Click OK.
6 Start the IndexManager Component Group, if necessary, by clicking Start in
the IM Administration Console toolbar.
7 Double-click ProjectCoordinateSystem to open the Server Configuration
dialog box for the ProjectCoordinateSystem Component Group (Figure 6-
4).
Fig. 6-4 Server Configuration for ProjectCoordinateSystem
8 Edit the parameter, if necessary:

• Coordinate System Metadata for Other Datastores (optional) – (By
default, the value of this parameter is not set.) This parameter allows users
to define the metadata for a component. This helps to retrieve the
coordinate system from the projects of additional datastores. Users can
specify the coordinate system metadata for one or more datastores. The
datastores supported are GeoFrame, OpenWorks2003, SeisWorks 2D,
SeisWorks 3D, Finder, ProSource Petrel 2007, and ProSource Petrel 2008. The
syntax of the value is similar to the metadata for GeoFrame.
• • • • • •
Note: The syntax of the value comprises a slash that delimits metadata in each
triple <datastore/topic/attribute>, and a semicolon that delimits metadata
in each triple. For example, Datastore_Others="GEOFRAME/GFProject/
coordinate_system;GEOFRAME/GFSeis_2D_Line/
coordinate_system;OPENWORKS2003/gdi_2003_project/
coordinate_system".

9 Click OK.
10 Start the ProjectCoordinateSystem Component Group, if necessary, by
clicking Start in the IM Administration Console toolbar.
11 If you edited any parameters, restart the ProSource server for the new settings
to take effect. If you started the IndexManager Component Group or the
ProjectCoordinateSystem Component Group, restart the Tomcat Web server.
Third-Party The Index Search is designed so that third-party crawling can be performed into the
Crawling same index. This allows for companies to use free open source tools such as Nutch
Integration from Apache organization (http://lucene.apache.org/nutch/) to crawl Web sites and
document repositories. The users can then search these data sources at the same
time they search databases indexed by ProSource.
ProSource can be used for the searching, but it is also possible to build Web pages
that will search the index and return the result on a Web page. You can either build
custom pages, or use the Search page that comes with tools such as ‘Nutch’.
If you intend to use the ProSource Client for searching, you do not need to perform
any special configuration. Simply, run the third-party tools to index data into the
same index (lucene directory) as the ProSource index. You will find the lucene
directory as a subdirectory of the ProSource Search Index directory, which is
configured for the Search Index component in the IM Administration Console.
When using the ProSource Client to present the result of third-party searches, it will
be useful to use the ProSource field names when populating your index. The default
values are “content” (for the main search field - include all searchable values in
here), “url” (for item lookup), “title”, and “summary”. These values can be
customized, if required. If you use these names, the ProSource Client will be able to
present the URL and summary to the user. If you use different names (without
notifying ProSource), ProSource will not know which values to present to the user.
If you intend to search the ProSource Index from a Web page, you need to turn on
a switch for the Search Index component which makes ProSource generate a URL
and a title for each item it indexes. This URL can then be used to look up the details
of a search hit (the user can click the URL to see all the cached attributes for the
selected item).
You can enable this URL generation by configuring the Search Index component
setting “enable_web_search” to true (default is false). You can then specify a base
URL under which the page is to be hosted. This optional setting is specified with the
“WEB_SEARCH_URL” parameter. Specify the base of the URL, and terminate it with
a “/”. In this case, you need to implement the URL handler as well. This is useful if
you have specific requirements on how you want to process the result. Your Web
page can then use the Lucene API to look up the URL and get the details for the hit.
The names of the external attributes in the ProSource Search Index (“title”, “url”)
have been chosen so that they will align with what Nutch uses. Normally, you are
not required to modify these attributes, but if you would like to customize these
attributes, you can do so by setting the server properties “IndexUrlAttribute”,
“IndexSubjectAttribute”, “IndexSummaryAttribute”, and “IndexContentAttribute” to
the desired values. If you would like to inspect the content of the Search Index, a
good and free OpenSource tool is “Luke” (http://www.getopt.org/luke/).

• • • • • •
Note: If you modify any of these attributes you will need to regenerate the index 
in order for the changes to take effect. This also applies to the
“enable_web_search” and “WEB_SEARCH_URL” settings.
Manage the Index To make data available in the Index Search, schedule the corresponding ProSource
Search topic to be “indexed” at regular intervals.
• • • • • •
Note: Two servers cannot access the same index at the same time. Doing so will
cause an error message to display. If this situation occurs, confirm that all
users are disconnected from the servers, shut down all servers, and then
delete the .lock file from the index directory.
 To add a topic to the index

1 Right-click a subnode in TreeView, and select Add Indexing.
• • • • • •
Note: You can also add a topic to the index by selecting Edit>Search Index
Configuration on the menu bar, and then clicking Add.
The Add Topic(s) to Search Index dialog box appears (Figure 6-5).
Fig. 6-5 Add Topic(s) to Search Index Dialog Box

2 Select a Datastore and at least one Topic to index.

At the top of the list of topics is a search field. Enter a search string into this
field, and all topics that contain that search string are conveniently listed below.
You can select multiple topics to index by using Shift + click to select a string
of topics, or using Ctrl + click to select individual topics.
3 Click Indexed Attributes or keep the default indexed attributes.
The Indexed Attributes dialog box appears.
The purpose of Indexed Attributes is that they will be “searchable”. This means
that, if you do not select an attribute as an Indexed Attribute, you will not be
able to search on the value of this attribute.
Fig. 6-6 Indexed Attributes Dialog Box
4 Select the attributes you want to index, and then click OK.
5 Click Cached Attributes or keep the default cashed attributes.
The Cached Attributes dialog box appears (Figure 6-7).
• • • • • •
Note: Cached Attributes are mostly used by spatial features. You can cache
shapes and be able to display them directly on GisView without having to
re-query the source database. You can also cache grid images.

• • • • • •
Note: Also, if you want to build your own application on top of the index by
caching the data in the index, you will have access to it without having to
go back to the source database.
• • • • • •
Note: You can create multiple index jobs on any topic, but data for that topic will
only be stored in the index once and will be from the most recently run
job. Also, when you delete a job, the associated data is also deleted. For
example, if you have 3 jobs for the same topic, and you remove one of
them, the indexed data for that topic will be removed until one of the
remaining jobs runs. However, the presence of the other 2 jobs in the
Index Manager gives the impression that data from those jobs are
available. By deleting one of the jobs, the data is gone until the next job
runs.
Fig. 6-7 Cached Attributes Dialog Box
6 Select the attributes you want to keep in the dictionary, and then click OK.
7 Click Connection or keep the default detected connection.
The Database Connection dialog box appears.

Fig. 6-8 Database Connection Dialog Box
8 Make your database connection changes, and then click Connect.

9 Enter the date for executing the indexing for the first time, or select it using the 
calendar.
10 Enter the subsequent number of days for executing the index after the first
time. The default is 7. This means that the index will be executed seven days
after the date you specified the index to execute for the first time.
11 Click OK.
The Index Search is registered in the Search Index Configuration window.
Fig. 6-9 Search Index Configuration Window

 To edit a scheduled entry

1 From the ProSource menu, select Edit>Search Index Configuration.
The Search Index Configuration window appears (Figure 6-9).
2 Select the index job you want to modify, and then click Edit.
The Edit Schedule Indexing Job dialog box appears.
Fig. 6-10 Edit Schedule Indexing Job Dialog Box
3 Modify when to execute the indexing, and then click OK.
 To search an index
There are two methods to perform a search. Use either of the following methods:
Method 1
1 Enter your search keyword in the navigator field, as illustrated in Figure 6-11, 
and then press Enter.

Fig. 6-11 Searching a Keyword on ProSource
Method 2
1 Click the Search Index icon on the ProSource tree.
The Search Index appears on the left pane.
• • • • • •
Note: You must have at least one search constraint to use the Search Index. Do
not use the question icon to retrieve all indexes within a constraint.

Fig. 6-12 Search Index Pane
2 Select the parameters for each attribute you would like to perform the search
on.
3 Select the type of View that you would like to display the results.
4 Click Search.
The search results appear on the right pane, displaying the results data in the
view type you selected (Tree, Table, Form). The search results allow you to drill
down to the original data and view the data directly on the map (for spatial
data) without having to connect back to the original database to query the
spatial data.

Fig. 6-13 Index Search Results
5 Select the spatial filter check box at the bottom of the search results window to
view an area of interest, as illustrated in Figure 6-13 above.
The Area of Interest dialog box appears.

Fig. 6-14 Spatial Area of Interest
6 Specify your area of interest and click OK.

The spatial area of interest appears on the right pane.

Fig. 6-15 Spatial Area of Interest
7 Click Back if you need to go back to the ProSource tree.
• • • • • •
Note: Every Index Search result appears on the ProSource tree for easy access.
 To delete an index
1 In the ProSource menu, select Edit>Search Index Configuration.
2 Select the index job(s) you want to remove, and then click Delete.
The following message opens, confirming whether you want to proceed with
the removal.

3 Click Yes to continue.

The index job is now removed.
 To view an index log

1 In the ProSource menu, select Edit>Search Index Configuration.
2 Select an index job, and click Run Now.
The following message appears, stating that the index job has been executed.
3 Click OK.
4 Click Show Log.
The log file appears in your Web browser.

Configure Spatial Index Layer Coordinate System
Configure Spatial Index Layer Coordinate System
During the configuration of Spatial Index using

ProSource>Connections>Spatial index tab from IM Admin, the configuration
sets the default coordinate system for the SDE layers to WGS 1984. The
configuration creates the following eight layers:
• spdb_wells
• spdb_well_deviation_surveys
• spdb_study
• spdb_projects
• spdb_grids
• spdb_2d_seismic
• spdb_3d_seismic
• spdb_polygons
To change the default coordinate system for the above layers, set the ArcSDE
environment and use the following ArcSDE command:
sdelayer -o alter -l <table>,<column> -G <projection_id> -u
<spdb_user> -p <password> -i <sde_service_name> -N
<default_projection_id>
The following example shows syntax that changes the coordinate system of layer
spdb_wells:
sdelayer -o alter -l spdb_wellbore_dev_surveys,wellbore_path
-G 4267 -u spdb_sol_com_3 -p spdb_sol_com_3 -i esri_sde1 -N
4326

Configure eSearch
Configure eSearch
eSearch is a powerful data management tool. It allows you to quickly and accurately
store, search, and order physical E&P data assets in corporate-wide, multi-site,
multi-repository environments. It employs easy-to-use interfaces with configurable
relational data structures for records management. eSearch facilitates SIS
Information Management suite integration.
• • • • • •
Note: eSearch data can be stored as case sensitive or in upper case (always),
depending on the option that is used when the table structure for loading
data is created. If the case sensitive option is not checked as “ON” when
the Datatype attribute is created, all the data that is loaded into that
attribute will be stored in upper case. In this scenario, when a user
searches using the eSearch adaptor, the item may or may not be found if
the attribute case in GeoFrame, OpenWorks, or Finder does not match the
case with the corresponding element Datatype in eSearch was created.
Generate and Load Before you begin, ensure that you have:
eSearch Metadata
• Write access to the ProSource installation directory on the server
• Write access to the ProSource topic ProSource Admin>Generate
Metadata>eSearch Metadata
• “esearch_api” feature in the license file being used by the eSearch installation
When the ProSource installation is completed, the Administrator must generate and
load the metadata for the eSearch DataTypes that are to be made accessible from
ProSource. To be able to generate the Metadata, you need to login with an eSearch
user who has privileges to access eSearch Metadata or data types.
1 Log onto the ProSource client as a user with administrative privileges.
2 In TreeView, expand ProSource Admin>Generate Metadata, click on
Search icon for, and select eSearch Metadata.
The Generate Metadata screen opens.

Configure eSearch
Fig. 6-16 eSearch Metadata Screen
3 Select the Project and Datatype for which you want to generate metadata,
then select the appropriate Definition attribute, and click Search.
The results display in TreeView.
4 Select the Definition attribute.
5 On the TableView toolbar, right-click the Edit icon, and select Text Editor.
In the Text Editor, edit the metadata generated by default, if any changes are
needed.
6 Restart the ProSource server after defining the eSearch Metadata to see the
modifications.
• • • • • •
Note: Once you have created the new eSearch datatype, you or your ProSource
Administrator must assign access permissions to allow users to access the
datatype.

Configure eSearch
• • • • • •
Note: For further information on assigning capabilities to objects, refer to the
Information Management (IM) Administration Console Online Help.
Configure for It is a mandatory pre-requisite to configure eSearch to enable direct context

Launching eSearch searches based on data type records queried in ProSource. Information on this can
Web in Context be found in Chapter 3 and Appendix F of the “eSearch Web Application User Guide”.
If you wish to look up specific values in specific eSearch data type fields (attributes)
from ProSource, then each of the fields to be used in this way need to be registered
in the My Settings screen within eSearch.
Each required field within each data type is given a unique link name which is used
to identify it from ProSource. This link name is searchable from ProSource. For
example, if there is a data type Borehole in eSearch that has UWI as one of its
attributes, you can select a Link Name such as PSUWI and it will refer back to that
attribute.
Enable an E&P To enable a ProSource entity to search an eSearch attribute referred to by Link
Entity from Name, you must modify the ViewLoader file for the corresponding topic, and
ProSource to apply the USAGE rule below to the corresponding attribute in the topic.
Search an eSearch
USAGE=’eSearchMapLayerAttribute=LinkName’
DataType
Example:
DataStore=GeoFrame;
create VIEW gfwell IMPLEMENTS Well DATASTORE GEOFRAME
HOME=’id’
{
:
:
ATTRIBUTE uwi :PATH=UWI TYPE=’String’
NATURAL;
:
:
}
save view gfwell;
create TOPIC GFWell VIEW=gfwell
{
:
:
ATTRIBUTE uwi:USAGE=’eSearchMapLayerAttribute=PSUWI’;
:
:
}
 To enable an E&P entity to search an eSearch attribute

1 Load the changed ViewLoader file using $PS_HOME/bin/viewloader.sh

Configure eSearch
• • • • • •
Note: It is not mandatory to load a specific dictionary modification via the
ViewLoader script. You can alternatively modify the topic definition in
ProSource using ProSource Admin Tree>Topic or right-click
Dictionary>Show ViewLoader information (for a specific question).
2 Log onto the ProSource client as a user with administrative privileges.

3 Open ProSource Admin>Plugin Configuration>Applications, and search
for the application with the ID eSearch_Web_In_Context.
4 Locate the application in TableView, click on the application (highlight), 
and then click the Edit icon in the TableView toolbar.
5 In the TOPIC, add the topic that was manipulated above.
This attribute contains a comma-separated topic list.
6 After editing, click Save in the toolbar.
7 Restart the ProSource server after all the changed ViewLoader files have
completed loading and the corresponding topics have been updated on the
topic list.
8 Restart the client to view the new eSearch application in the Sent To menus
for the topics that have been updated.
Setting eSearch To allow a normal user to set the eSearch Preferences, follow these steps:
Preferences
1 Launch IM Administration Console in the safe-start mode.
2 Change the Allow eSearch Preference Setting parameter of the
FederatorConfigurationManager to “true”, and click OK.
3 Restart the Tomcat and ProSource servers.
4 Go to IM Admin and assign the Esearch_Pref_Tab and
Esearch_Web_in_Context objects to that normal user.
Modifying eSearch Web To configure another eSearch Web Server or modify eSearch Web Server
Server Parameters parameters, follow these steps:
1 Launch IM Administration Console in the safe-start mode.
2 Go to ProSource>FederatorConfigurationManagement and modify the
eSearch Web Server Host and eSearch Web Server Port parameters as
required.
3 Click OK.
4 Restart the Tomcat and ProSource servers to apply the settings.

Manage Coordinate Systems

ProSource uses the Esri ArcSDE coordinate system list based on the European
Petroleum Survey Group (EPSG) to identify coordinate systems. Projects from data
sources such as OpenWorks and GeoFrame may use a different dataset to identify
coordinate systems, such as Mentor or Blue Marble. In this case, you will need to
create a mapping from the other coordinate system to the equivalent Esri coordinate
system so that the projects from these data sources display correctly in a ProSource
GIS map (GisView).
This section explains how to ensure ProSource has the required coordinate system
information for the projects in your data sources.
• • • • • •
Note: A user must have the Administrator role in order to manage coordinate
systems.
Synchronized When a custom coordinate system or coordinate system transform is created, edited
Coordinate System or deleted in ProSource, the definition is saved in all the required catalogs for
Catalogs ProSource, Seabed and ArcSDE. This keeps coordinate systems definitions
synchronized across IM workflows.
The coordinate system catalogs updated by ProSource are as follows:
• ProSource internal catalog used for coordinate system definitions (ProSource uses
the ArcSDE library to perform conversions).
• Map catalog used by the ProSource GIS Viewer to identify custom coordinate
systems.
To synchronize the map catalog, ProSource adds a custom coordinate system or
transform to the GeodeticDB.txt file in the slb_mo20_geodetic_db.jar file in
the ProSource/jars directory. The previous version of the jar is saved with a
date stamp.
• • • • • •
Note: Users must restart the ProSource client to use a new or updated custom
coordinate system or to transform it in the GIS View as in sending data
aliased to the new system to the GIS View or when selecting the system in
the GIS View.
• Seabed catalog in existing data dictionaries used by the ProSource Seabed

products. Only data dictionaries in the shared Seabed Catalog Oracle instance are
updated. Data dictionaries created later are also updated at the time of their
creation.(Seabed dictionaries in other Oracle instances are not updated).
• ArcSDE standard definition files (projcs, geogcs, etc.) are output to the directory
defined by ProSource CRS Manager parameter SDEHOME. This enables third-
party products to use custom coordinate systems defined in ProSource.
In the IM Administration Console Safe Start mode, under ProSource tab>
Component Group Name>CrsManager, change the value of SDEHOME
parameter.

Coordinate System In essence, if the coordinate system for your project has a direct mapping to an Esri
Management coordinate system, you will simply need to create the coordinate system alias in
ProSource that provides a mapping for the two coordinate systems. If there is no
direct mapping, or if the project uses a custom coordinate system, you will then
need to create the custom coordinate system in ProSource and then provide an alias
for the custom coordinate system. In addition, if your project uses a custom
transformation, the custom transformation needs to be created and identified in
ProSource as well.
The following diagram is an overview of the steps necessary to ensure ProSource
has all of the information associated with the coordinate system that your project
uses.
This section takes you through the steps in the above diagram for managing the
coordinate system mappings. Included in this section are the following topics:
• “Add a Custom Coordinate System” on page 6-31
• “Add a Transformation” on page 6-37
• “Add a Coordinate System Alias” on page 6-39
• “Edit a Custom Coordinate System, Alias or Projection” on page 6-41
• “Delete a Custom Coordinate System, Alias or Projection” on page 6-42
• “View the Properties of Coordinate System Objects” on page 6-43

Add a Custom Note: After creating a new coordinate system using the client interface, it is
Coordinate System necessary to restart the ProSource client in order to have the new CRS definition
available in Edit > Preferences > Projection and in GisView > Projection.
(Tip: Confirm that all users are logged off the server before shutting it down.)
If ProSource does not recognize the coordinate system that your project uses, you
will receive errors similar to the following:
“Could not determine which datum shift function to use when converting from
'Unknown - Clarke 1880' to 'GEODETIC-CL80__CL80'. Check your configuration for a
datum shift definition to WGS84.”
or
“Read project information (map) failed. See RowStatus for details.” The RowStatus
will show a message such as, “Coordinate system not found for European 1950,
Norway & Finland.”
Proceed with the following workflow to correct these errors.
Pre-Step 1: Get Details At this point, you need to add a coordinate in ProSource. Refer to
of Your Coordinate Edit>Coordinate System>View in “View the Properties of Coordinate System
System Objects” on page 6-43 to see the values you will need to provide, depending on
whether the coordinate system is a geographic or projected coordinate system, and
depending on the projection for your projected coordinate system. Make note of
your coordinate system values before proceeding to the next step.
Pre-Step 2: Try to Find If you are unsure what the Esri match is for your coordinate system, consult your
an Esri Code Match for geodesist who can provide the mapping.
Your Coordinate
System First try to find an Esri match for your coordinate system within ProSource. You can
view all coordinate systems in ProSource by selecting Edit>Coordinate
Systems>View. Refer to “View the Properties of Coordinate System Objects” on
page 6-43, which explains the view options. If you find a match for your coordinate
system, consider using the Well Known Text for the next step of creating a
coordinate system alias.
Alternatively, go to the EPSG http://www.epsg.org/ website and download the EPSG
code database. Within the database, try to find an Esri code match for your
coordinate system.
If you were able to find an Esri code match you do not have to add a custom
coordinate system in ProSource; you simply need to add a coordinate system alias.
Find instructions on how to add an alias on “Add a Coordinate System Alias” on page
6-39. If you did not find a match, follow the directions in the next section to add a
custom coordinate system in ProSource.

Adding the Custom If you were unable to find an Esri code match for your coordinate system, you will
Coordinate System need to add the coordinate system to ProSource, as explained within this section.
 To add a geographic coordinate system

1 From the ProSource menu, select Edit>Coordinate System>Add.
The Coordinate System Add dialog screen opens.
Fig. 6-17 Add a Geographic Coordinate System Dialog Screen
2 Select Geographic. (Figure 6-17 shows the geographic coordinate system

options.)
3 Enter the following geographic coordinate system values:
Definition Name - If you want to copy an existing coordinate system for the
purpose of just altering specific values, click Name to retrieve a list of all
existing coordinate systems (including previously created custom coordinate
systems). Select (highlight) the coordinate system you wish to copy, and then
click OK. In the Coordinate System Add dialog, all of the values for that
coordinate system are populated. You can then edit specific values to create
the new coordinate system.
a. To create a completely new coordinate system, enter the name of the
coordinate system to add.

Code - This code is unique to ProSource and is automatically assigned. The

code will be in the Esri range for that coordinate system type.

Area and Tree Node - Area refers to the geographic area to which the
coordinate system belongs.The Tree Node represents the same information
in tree view. It indicates the node in the coordinate system tree (displayed
by geographic region), in which you want the new coordinate system to be
located.
In the Tree Node field, enter the location in which you want the coordinate
system to open. To create a new, custom location within the tree, type the
new tree location. The syntax is: <top tree node>/<2nd level tree node>.

Datum Name - Name of the datum to be used for the coordinate system.
The datum name changes according to the Coordinate System you
selected. Different Datum Names automatically populate the spheroid
values with default values for that datum.

Spheriod Name - Read-only name for the datum.

Semi-major Axis and Inverse Flattening - Change these values as
needed.

If the values of the Semi-major Axis and Inverse Flattening change,
and you click Save, the custom Datum is created and the Datum Name
gets reset. The same name is set to the Spheriod Name appear. The
information for the datum and the spheriod remain the same in View, Edit,
and in Well-Known Text.

Prime Meridian Name - Select the prime meridian for the coordinate
system.

Angle Unit Name - Select the angle unit for the coordinate system.

If the values of the Area, Prime Meridian, and Angle Unit are changed,
and you click Save, the same Datum Name and Spheriod Name appear.
The information for the datum and the spheriod remain the same in View,
Edit, and in Well-Known Text.

Target - To view the target, and in order to view its default transformation, 
click the Target picklist to open a list of available targets from which to
choose. Select the target you would like to use and click OK.
b. If you do not see the target you would like to use, save the new geographic
coordinate system, and then create a custom transformation in ProSource.
For further details, refer to “Add a Transformation” on page 6-37.

Well Known Text - Click Well Known Text if you would like to compare
the well known text of the new coordinate system with one already created.

Transformations (button) - To see which transformations are defined for
the current coordinate system, click Transformation. If you do not see the
transformation you need, add the transformation in ProSource. 
For further details, refer to “Add a Transformation” on page 6-37.
4 Once you have finished entering the coordinate system values, click Save.

5 Either click Close to exit the Coordinate System Add dialog box, or add
another coordinate system object.
 To add a projected coordinate system

The Coordinate System Add dialog appears.
2 Select Projected.
3 Enter the following values:
• Definition Name – If you want to copy an existing coordinate system for
the purpose of just altering specific values, click Name to retrieve a list of all
existing coordinate systems (including previously created custom coordinate
systems). Select (to highlight) the coordinate system you wish to copy, and
then click OK. In the Coordinate System Add dialog, all of the values for
that coordinate system are populated. You can then edit specific values to
create the new coordinate system.
a. To create a completely new coordinate system, type in the Name of the
coordinate system to add.

Code – This code is unique to ProSource and is automatically assigned. 
The code will be in the Esri range for that coordinate system type.

Area and Tree Node – Area refers to the geographic area to which the
in tree view. It indicates the node in the coordinate system tree (displayed
by geographic region), in which you want the new coordinate system to be
located.In the Tree Node field, enter the location in which you would like
the coordinate system to display. To create a new location within the tree,
type the new tree location. The syntax is: <top tree node>/<2nd level tree
node>.

Geographic Coordinate System Name – Click the picklist to select the
geographic coordinate system that you would like to use. 

Projection Name and Parameters – Select the Project Name from the
drop-down list, which automatically retrieves the associated parameters for
you to enter.

Linear Unit Name – Select the Linear Unit for the coordinate system.

Target – To view the target and in order to view its default transformation,
click the Target picklist which opens a list of available targets to choose
from. Select the target you would like to use, and click OK.
b. If you do not see the target you would like to use, save the new geographic
For further details, refer to “Add a Transformation” on page 6-37.

Well Known Text – Click Well Known Text if you would like to compare
the well known text of the new coordinate system with one already created.

Transformations (button) – To see which transformations are defined
for the current coordinate system, click Transformation. If you do not see

the transformation you need, add the transformation in ProSource. 

For further details, refer to “Add a Transformation” on page 6-37.
4 Once you have finished entering the coordinate system values, click Save.
Grid based To enable grid based transformations in the ProSource client:

Transformations
1 Copy the grid files present in the $PS_HOME/local/conf/pedata folder to a
newly created folder (e.g, D:\Test\pedata) in the local machine.
The grid files must be present on the client machine while performing
coordinate conversion such as sending data to the GIS view.
2 Declare an environment variable PEDATAHOME, which will point to the
D:\Test\pedata folder.
To enable grid based transformations in the ProSource server:

1 Open the $PS_HOME/local/conf/prosource-server.conf file in an
editor and uncomment the variable PEDATAHOME. Do not change the value of
PEDATAHOME.
This variable must be enabled when performing coordinate conversion in the
server such as data transfers.

Create a Custom Coordinate System
Create Custom Use this section to create custom Datum and Spheroids.
Datum and
Spheroids
Create a Custom Datum
 To create a custom datum

1 On the ProSource menu screen, click Edit>Coordinate System>Add, and
select the Geographic radio button.
The Coordinate System Add screen opens.
2 Enter the name of the Geographic Coordinate System (GCS) appropriate for the
required custom Datum name, and click Save.
• The value of the semi-major axis or Inverse Flattening is changed
accordingly.
• The custom datum is created, and the Datum name and the Spheroid name
are both set to the same name. For example, if crs=ACCRA_G2, then both
Datum= and Spheriod=ACCRA_G2-F.
The next time you create a GCS, the custom datum name displays with the standard
datum names on the drop-down menu. When you select the datum you have
created, the corresponding spheriod, semi-major axis, and inverse flattening values
display.
Create only a Custom

Spheriod
 To create only a custom spheriod

2 Enter the name of the GCS with the same name as that of the custom Spheriod
required.
For example, if Spheroid=CAM, then the GCS name is CAM.
3 Enter the semi-major axis and inverse flattening values, and click Save.
Both the Spheriod and the Datum names now display as CAM-A.
Create a Custom Datum

and a Custom Spheriod
 To create a custom datum and a custom spheriod


2 Enter the name of the GCS with the same name as that of the custom Datum
required.
For example, if Datum=CAM, then the GCS name is CAM.
3 Enter the semi-major axis and inverse flattening values.
Both the Datum name and the Spheriod name now display as CAM-H, 
and the Spheriod name becomes editable.
4 Enter the custom Spheriod name (for example, RAC), and click Save.
A GCS is created with a custom Datum named (CAM-H) and a custom
Spheriod 
named (RAC).
 To enter a GCS name other than that of the datum

1 In the Name TextArea, specify the name for the new GCS.
2 Select the datum name (CAM-H) from the Datum drop-down menu, and click
Save.
When the CAM-H datum name is selected, the spheriod name and the spheroid
values are automatically populated.
Add a Transformation Esri supports several transformations to convert from one geographic coordinate
system to another. When displaying project data in GisView, the default
transformation used by ProSource is WGS_1984. That is, any repository-side
coordinate system is instantly converted to WGS_1984 or the default map
coordinate system for ProSource (set by selecting Edit>Preferences>Projection
tab>Default Map Coordinate System) for display purposes.
When the coordinate system of a project in Finder, GeoFrame, OpenWorks, or any
federated data source is based on a coordinate system that does not have a
transformation defined in ProSource, ProSource returns an error message similar to
“Could not determine which datum shift function to use when converting from
'Unknown - Clarke 1880' to 'GEODETIC-CL80_CL80'. Check your configuration for a
datum shift definition to WGS84.” This error means that you need to add the
transformation for that coordinate system.
 To add a transformation

Fig. 6-18 Adding a Transformation Dialog Box
2 Select Transformation to enter the new transformation values, as shown in

Figure 6-18.
3 Enter the following transformation values:
• Definition Name - The Definition Name is a read-only field and is updated
when the From and To coordinate systems are selected.
• Definition Code - This code is unique to ProSource and is automatically
assigned. The code will be in the Esri range for transformations.
• Area and Tree Node - Area refers to the geographic area to which the
in tree view. It indicates the node in the coordinate system tree (displayed by
geographic region), in which you want the new coordinate system to be
located.

In the Tree Node field, enter the location for in which you want the
coordinate system to open. To create a new location within the tree, type the
new tree location. The syntax is: <top tree node>/<2nd level tree node>.
• From and To - Click the picklist to choose the From (source) and the To
(target) coordinate systems.

• Method Name - Select the Method Name from the drop-down list. Once
selected, the parameter options are automatically updated for that method
type.
• Parameters - Enter the values for the transformation.
• Well Known Text - Click Well Known Text if you would like to compare
the well known text of the new transformation with one already created.
4 Once you have finished entering the transformation values, click Save.
another 
coordinate system object.
Add a Coordinate If you were able to find a matching Esri coordinate system or if you have already 
System Alias created the custom coordinate system, you are now ready to add the coordinate
system alias.
An alias maps the custom coordinate system or a coordinate system from a different 
dataset - such as Mentor or Blue Marble - to the Esri coordinate system name.
 To add a coordinate system alias

1 In the ProSource menu, select Edit>Coordinate System>Add.

Fig. 6-19 Adding a Coordinate System Alias Dialog Box
2 Select Alias. The alias options are shown as in Figure 6-19.

3 Enter the following alias options:
• Alias - Enter the name of the coordinate system in the repository, or data
source, or that you know is a custom coordinate system name that needs to
be defined in ProSource.

If you receive an error such as “Read project information (map) failed. See 
RowStatus for details”, the RowStatus will show a message such as
“Coordinate system not found for European 1950, Norway & Finland.” This
indicates that the “European 1950, Norway & Finland” coordinate system is
not recognized by ProSource (that it is not a standard Esri coordinate
system), and that you must create an alias for the coordinate system with
the name “European 1950, Norway & Finland” which will map to either a
standard Esri coordinate system or a custom coordinate system that you
have added in ProSource.
• Area and Tree Node - Area refers to the geographic area to which the
in tree view. It indicates the node in the coordinate system tree (displayed by
geographic region), in which you want the new coordinate system to be
located.


In the Tree Node field, enter the location in which you want the coordinate
system to open. To create a new location within the tree, type the new tree
location. The syntax is: <top tree node>/<2nd level tree node>.
• Coordinate System - Select the corresponding Esri coordinate system
name. If you do not find the coordinate system you would like to use, it
means that you need to create a custom coordinate system. 
For details, refer to “Add a Custom Coordinate System” on page 6-31.
• Comment - Enter a comment that will help you with future reference as to
why you created the alias.
• Target - To view the target, and in order to view its default transformation,
click the Target picklist that opens a list of available targets from which to
choose. Select the target you would like to use, and then click OK.

If you do not see the target you would like to use, save the new geographic
For details, refer to “Add a Transformation” on page 6-37.
• Well Known Text - Click Well Known Text if you would like to compare
the well known text of the new alias with one already created.

Transformations - To see which transformations are defined for the
current coordinate system, click Transformation. If you do not see the
transformation you need, add the transformation in ProSource. 
For details, refer to “Add a Transformation” on page 6-37.
4 Once you have finished entering the Alias values, click Save.
Edit a Custom This section explains how to edit a coordinate system, alias, or projection once it has
Coordinate System, been added in ProSource.
Alias or Projection
 To edit a custom coordinate system, alias, or projection

1 From the ProSource menu, select Edit>Coordinate Systems>Edit.
The Coordinate Systems Edit dialog box opens, as shown in Figure 6-20.

Fig. 6-20 Coordinate System Edit Dialog Box
All coordinate systems, aliases, and transformations that have been added in
ProSource are listed.
2 Select the item you would like to edit and click Edit. The Edit dialog
appropriate for the type of item you selected appears.
3 Change the values you would like to edit, and then click OK.
4 Either click Close to exit the Coordinate System Edit dialog box, or select
another item to edit and continue the process.
Delete a Custom This section explains how to delete a coordinate system, alias, or projection once it
Coordinate System, has been added in ProSource.
Alias or Projection
 To delete a custom coordinate system, alias, or projection

1 From the ProSource menu, select Edit>Coordinate Systems>Delete.
The Coordinate Systems Edit dialog box appears (Figure 6-21).

All coordinate systems, aliases, and transformations that have been added in
ProSource are listed.
2 Select the item you would like to delete, and then click Delete.
• • • • • •
Caution: Once you click Delete, you cannot undo the deletion. Ensure that you
have selected the correct item prior to clicking Delete.
3 ProSource confirms that the item has been deleted. Click OK.
4 Either click Close to exit the Coordinate System Delete dialog box, or select
another item to delete and continue the process.
View the Properties This section explains how to view the properties for an existing coordinate system,
of Coordinate alias, or projection or one that has been added in ProSource.
System Objects
 To view the properties of coordinate system objects (original and

those added to ProSource)
1 From the ProSource menu, select Edit>Coordinate Systems>View.
The Coordinate Systems View dialog box appears (Figure 6-22).

2 Select the type of coordinate system object that you would like to view:
• Geographic - Lists all geographic coordinate systems configured with
ProSource (original and those that have been added)
• Projected - Lists all projected coordinate systems configured with
ProSource 
(original systems and those that have been added)
• Transformation - Lists all transformations configured with ProSource
(original transformations and those that have been added)
• Custom - Those listed show all aliases, coordinate systems, and
transformations added to ProSource by the ProSource Administrator. Note
that these are also available in the list of their respective types (by choosing
Geographic, Projected, etc. from the Type drop-down list), but are not
shown in their respective trees (viewed according to geographic region). For
example, if you add a new geographic coordinate system, you can find that
coordinate system on the List tab, but if you click the Tree tab, you will not
see the custom coordinate system. To see the added geographic coordinate
system on the Tree tab, select Custom from the Type drop-down list, and
then click the Tree tab.
• Alias - Lists all aliases configured with ProSource (original aliases and those
that have been added).
3 To quickly find a coordinate system object:
• In the Name field, enter the name for which you are searching. This
automatically takes you to that name in the list.

• Find the coordinate system, alias, or transformation according to its code by

clicking the Code header, which sorts the list according to the code number.
Clicking once sorts the codes in ascending order; clicking twice sorts the
codes in descending order.
• • • • • •
Note: Those coordinate systems ranging in the 200,000 code or higher are
custom coordinate systems, aliases, or transformations created in
ProSource.
• Select an Area to refine the list based upon a spatial search.

• Click the Tree tab, and find the coordinate system based upon its
geographical location.
4 View the properties of the coordinate system object by either double-clicking
the name, or by clicking Properties. You can then see all of the information
associated with it and view its well known text. In fact, you may want to use
the well known text as a starting point for creating a new coordinate system,
alias, or transformation, since you are able to dynamically generate the well
known text during the process of adding a new one. You can then compare the
existing well known text to the new.
5 Once you are finished viewing the properties, click Close.

Create Access to Shapefiles in TreeView

ProSource provides the ability to generate shapefiles from GIS data objects in
GisView, store them within a ProSource directory, and then have those shapefiles
accessible from TreeView. Similarly, shapefiles from external sources can also be
imported into ProSource and accessed via TreeView. For reference, sample
shapefiles have been configured in ProSource that can be accessed from TreeView
under Shapefiles>Shapes>Samples.
To access certain shapefiles from TreeView, you need to have the following rights:
• Write access to the ProSource installation directory on the server
• Write access to the ProSource topic ProSource Admin>Generate
Metadata>Any Shape
 To access certain shapefiles from TreeView

1 Copy the shapefile set (containing the .dbf,.prj,.shp and .shx files) into
the ProSource server directory $PS_HOME/shapefiles. The shapefile is
immediately accessible in the ProSource topic
Shapefiles>Shapes>Any Shape.
• • • • • •
Note: When importing external shapefiles to generate metadata in ProSource,
make sure that the name of the shapefile does not begin with a number
(example - 123_shapes). In the name begins with a number, following
error will be returned: “* Loading meta failed: Unexpected
token: (context:
com.slb.im.federator.server.viewmanager.ViewParser.new
ViewDef- (ViewParser.java:126)”
At this point, the shapefile format is not suitable for any action other than a
basic overview or map representation since all of the shapefile attributes are
condensed into a single attribute value. The following steps explain how to
define each attribute and how to create a directory structure (or a new
ProSource question and topic) for the shapefile.
2 Send the data in the ProSource topic ProSource Admin>Generate
Metadata>Any Shape to TableView.
3 Locate the shapefile in TableView, click the shapefile (to highlight), and then
click the Edit icon in the TableView toolbar.
4 Select the Definition attribute, right-click, and select Text Editor.
5 In the Text Editor, edit the CREATE QUESTION TOPIC section to specify
the 
directory (question and topic) in which you want the shapefile stored. For
example, if you have a shapefile titled b_majorcities2, the default will look
like the following:
CREATE QUESTION TOPIC='b_majorcities2' '#110#Read b_majorcities2'
CAPABILITY='b_majorcities2 READ' REF='Shapefiles'.'#110#Shapes//
b_majorcities2';

If you want the shapefile stored under Shapefiles>Shapes>North

America>Major Cities, edit the above to look like the following:
CREATE QUESTION TOPIC='b_majorcities2' '#110#Read b_majorcities2'
CAPABILITY='b_majorcities2 READ' REF='Shapefiles'.'#110#Shapes//North
America/Major Cities';
• • • • • •
Note: The syntax for CREATE QUESTION TOPIC follows the ViewLoader
syntax for creating questions and topics. For further help on the
ViewLoader syntax, refer to “Create Question” in the ProSource
ViewLoader Guide.
6 After editing, click Save in the FormView toolbar.

7 Restart the ProSource server and client to see the new question and topic (or
directory) in TreeView.
• • • • • •
Note: Once you have created the new shapefile directory, be sure to assign the
access permissions (or have your ProSource Administrator assign
permissions) in order for users to access the shapefile. For further
information on assigning capabilities to objects, refer to the Information
Management Administration Console (IM Administration Console) Online
Help.

Create JDBC Metadata

The JDBC Generate Metadata question allows you to generate JDBC metadata from
within ProSource.
• • • • • •
Note: The eims_ds_jdbc license is required for non-Finder (i.e., general JDBC
data access).
ProSource provides the ability to generate JDBC metadata and then access this
metadata from TreeView. The same workflow is available for Finder using the
Finder Metadata question.
• • • • • •
Note: Only Oracle, JDBC compliant databases are supported.
• • • • • •
Note: For information on configuring a third-party JDBC database, refer to 
“Configure Third-Party JDBC Compliant Database with ProSource” on page
4-14.
Write access to the ProSource topic ProSource Admin>Generate

Metadata>JDBC Metadata
 To Generate Metadata
1 Expand ProSource Admin>Generate Metadata in TreeView and click the
Search icon for JDBC Metadata.
Fig. 6-23 Database Connection Dialog Box

2 Select a Project and enter your Credentials.

3 Click Connect.
• • • • • •
Note: In the case of Finder, connect with project account credentials. 
If you are connected with Analyst account credentials, only analyst tables
will be available for generating metadata.
The JDBC Metadata Search screen opens.
Fig. 6-24 JDBC Metadata Search Window
4 Select the Table name for which you want to generate data.
5 Select the Definition and Definition xref attributes.
The Definition xref option is used to generate metadata for cross references,
such as picklists and related information links.
• • • • • •
Note: When saving cross references, you need to ensure that the referenced
topics exist first. Otherwise, the save operation will fail.

6 Click Search.
The results appear in TableView.
7 Select the Definition attribute and click Edit in the TableView toolbar.
The Definition window appears.
Fig. 6-25 Editing Definitions
8 Edit the attributes, if necessary, and click Save in the FormView toolbar.
• • • • • •
Note: If you need to modify the attributes, you may want to modify the question
name, location and order.
9 Restart the ProSource server and client to see the new question and topic in
TreeView.
10 Query the ProSource Admin>Topic for the topic details. In this example, we
are querying for the Topic attributes because we added new attributes.

Fig. 6-26 Re-querying Topic Attribute
11 Verify that the new topic has been created correctly. This step is optional.
• • • • • •
Note: If the question appears in TreeView, your topic has been created
correctly.

Fig. 6-27 Verifying Topic is Created
12 Send the topic ProSource Admin>Topic>Topic Attributes to TableView

and open the topic's Topic Attributes attribute in Text Editor.

Fig. 6-28 Topic Attributes in TableView
• • • • • •
Note: Once you have generated the JDBC metadata, be sure to assign the
access permissions in order for users to access this metadata. For
information on assigning capabilities to objects, refer to the IM
Administration Console Online Help.
• • • • • •
Note: For information on valid date formats for attributes, refer to http://
docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html.

Create Custom Well Symbols

In GisView you can map values to a symbol. This is typically used to display wells
with a given status and a given well symbol. By default, Finder, GeoFrame, and
OpenWorks well topics are mapped to symbols in the ProSource Symbols TrueType
font.
 To configure custom well symbols

1 Install client fonts (if necessary).
ProSource automatically downloads the required fonts from the server to the
client machine using the “unsignedresources.jar” file. However, if you want to
use your own font file, you can add the font to the $PS_HOME/jars/
unsignedresources.jar file. If you need more information about installing the
fonts, see “Install Well Symbols and North Arrow Fonts” on page 6-22 of the
ProSource Installation Guide.
• • • • • •
Important: If you use custom font for well symbol, you will need to use font
with unicode encoding as font with symbol encoding cannot be
displayed in ProSource.
2 Add the well symbols mapping.

Classifications can either be configured through the ProSource Admin or
through SQL.
Option 1: Configure through the ProSource interface
a. In TreeView, navigate to ProSource Admin>Well Symbol
Mappings>Create New .
b. The Create Well Symbols Mapping form appears.
c. Enter the well symbol mapping values. Table 6-3 explains the attribute
options.
Table 6-3 Well Symbol Mappings Attributes
Attribute Description
Id This is a unique Id for this symbol mapping. You can check
existing IDs by querying ProSource>Well Symbol
Mappings>Search.
Classification name This is the name of this set of classifications (to be put in the 
attribute usage rule in which the classification should be
used).
Attribute value This is the attribute value for which you want to specify a
symbol (Example: “OIL”). This value must be a single column.

Symbol Index The symbol (index) to which this value should be mapped. 
This is a decimal value for the character in the font. Open the
font in a font viewer utility to get the symbol codes. A good,
free font viewing utility for Windows is X-Fonter (http://
Users.pandora.be/eclypse/xfonter.html). Most operating
systems include a default font viewer. Example: In Windows,
it is charmap.exe.
Font name The font to which the symbol belongs. This is not the file
name of the font. To get the font name, open the font in a
font viewing utility such as Windows charmap.exe. If your font
viewer gives the font family, use that; otherwise, use the font
name.
Symbol size The default symbol size.
Foreground color The font color in RGB values.
Background color/ Not used.
Line Color
d. Click Save.
Option 2 - Configure with SQL
Example of how to map a value to a given symbol in the classifications table
using SQL:
insert into CLASSIFICATIONS (ID, CLASSIFICATION_NAME,
ATTRIBUTE_VALUE, SYMBOL_INDEX, FONT_NAME, SYMBOL_SIZE,
FOREGROUND_COLOR, BACKGROUND_COLOR, LINE_COLOR)
: values ('OW_1', 'OpenWorksWellStatus', 'A DRY (NO
SHOWS)', 58, 'ProSource Symbols', 0.6, '0,0,0',
'255,255,255', '0,0,0');
3 Configure ViewLoader
Having configured the CLASSIFICATIONS table, add a reference to your topic
that it should use the classifications mapping you created. Do this by adding a
reference to the classification name’s usage rule of the attribute that should
“drive” the well symbol mapping.
Set the usage rule to: “Classification=CLASSIFICATION_NAME”, where
CLASSIFICATION_NAME is the name of the classification from the 
CLASSIFICATIONS table. If you have multiple classifications for a given topic 
(driven by different attributes), also indicate the priority in the variable name. 
Example:
ATTRIBUTE 'crstatus': PATH=crstatus
USAGE='Classification1=FinderWellStatus' ;
ATTRIBUTE 'well_type': PATH=well_type
USAGE='Classification2=FinderWellType' ;
In this example, if the user has selected the well status attribute in the query,
the well status attribute will determine which symbol is used. If the user does
not select the well status attribute, the well type is used (if it was selected).

• • • • • •
Note: The well symbols will not work if usage rule for an attribute has
parameters other than “Classification=CLASSIFICATION_NAME”. For such
attributes, specifying additional usage rules will not allow the well symbols
to appear. 

Example:

If for an attribute 'crstatus' the viewloader is configured as
USAGE='Classification1=FinderWellStatus MaxLength=64';
then the well symbols will not work.

It works for the below scenario
USAGE='Classification1=FinderWellStatus’;
4 Restart the ProSource server and client to see the new well symbols.

Create Custom Error Messages

In a scenario with federated data sources, the error reporting is difficult to control
and it can be very hard to match to the error situation from the point of view of the
ProSource user. The underlying data source reports the error, at best, in context to
some relevant IDs and names in the data source. The errors often do not convey the
proper message to the user. From within ProSource, it is not possible to control the
underlying data source, but it is possible to control the messages reported to the
user. For any ambiguous errors returned from the Oracle database, such as foreign
key violations, you can create a custom message that is returned to the end-user
which is more relevant to the underlying problem.
The ProSource solution is driven by a set of message matches or rules in the
dictionary for matching error messages as they are returned from the underlying
data source. If the message matches your defined rule, the message is then
changed to a different message, that you receive. You can then organize the rules in
a hierarchy to obtain faster processing and advanced matching.
Where Messages Messages are configured in TreeView by navigating to ProSource

are Configured Admin>Message Matches.
Fig. 6-29 Message Matches Section


The first time you access the Message Matches section, as shown in Figure 6-29,
you will see a set of messages that are already configured. These are standard
Oracle error messages that provide examples of how to create your own custom
messages.
Hierarchy of the Matches with no parent are tested first in order of the ID attribute. If a match has
Message Matching children, the children are processed in order of their ID. This cycle continues until all
children have been evaluated. If there are no children for the ID, the parent match is
used for formatting the message and that becomes the message that displays to the
user. The following diagram shows an example of this hierarchy.
ORA-001
ORA-001-001 ORA-001-005
ORA-001-005-001 ORA-001-005-002
In the diagram example, if the user generates error “ORA-001-005-002”, ProSource

will first evaluate “ORA-001” then “ORA-001-005” then “ORA-001-005-002”.
Realizing that “ORA-001-005-002” has no children, the user will receive the message
“Invalid Study Type” rather than receiving the Oracle message of “.*STUDY_FK04.*”.
Add a Message All messages reported from the database are formatted using the message matches. 
Match This functionality is always active but depends on which matches are available in the 
database. The matches are loaded to memory when the server or transfer starts and
are evaluated for each message.
 To customize an error message

1 Evaluate the current error text.
As an example, the error could be as shown in Figure 6-30 when a user tries to
create a Well Entire (map) and receives the following error message.
Fig. 6-30 Error Message

The row status shows the following:
Fig. 6-31 Row Status Error
Therefore, we now want to change the Row Status from “*FAIL: error adding
object to project (Instance exists, cannot insert)” to a more action driven
message that directs the user on how to fix the problem.
2 Add a new Error Match.
3 In ProSource, navigate to ProSource Admin>Message Matches>Create
New .
The Create Message Match form displays.
4 Create a new message match using the following attributes:
Table 6-4 Message Match Attributes
Id Id of the match. Matches are ordered based on this ID. An ID
representing the hierarchy is useful (Example: ‘ora-003-005’). The ID
labeling and hierarchy are determined by the ProSource
Administrator.
Parent Id ID of the parent match. If the parent matches, all child matches are
tried in order. If none match, the parent is used.
Topic Topic name to match. To specify any topic, enter an asterisk (*).
Match Matching regular expression. For more information on creating
expressions, refer to: http://java.sun.com/docs/books/tutorial/extra/
regex/.
Format Replacement expression. Use “$n” to refer back to () in a match.
Format class Full name of specific class for formatting messages. This is only
invoked if regexp matched.
Format class Options to the format_class. Format depends on the format_class.
options
Description Comment or description on the match. Note that this attribute value
is not displayed to users.
In this example, create the message match as shown in Figure 6-32.

Fig. 6-32 Message Match Attributes
In this example, the Message Match states that the error can be received from
any Topic (*) as long as the error matches “* error adding object to project.*”.
The asterisks on each side indicate that as long as the error contains the
specified text, display the message “The data object you are trying to create
already exists in the project. Please check.”
5 Verify the new message.
After you have created the Message Match, the new error text will display in 
the Row Status. In this example, the new Row Status reads the following:
Fig. 6-33 New Row Status Message
Add Specific Rules Specific rules can be configured if the message from the database does not contain
enough information to give meaningful feedback to the end users. These specific
rules can then be configured provide extra checking and reporting for a particular
case. For example, the following class can format the error message by evaluating
the data and the error message together:
com.slb.im.federator.server.messagematcher.MessageFormatterA
ttributeWidths
The parameter (format class option) needed for this class is the attribute width. For
example, if the given option is attr=12, it will then verify that the attribute named
attr has length <= 12.
Additional The following links provide additional information on configuring message matches:
References
Regexp Tutorial: http://java.sun.com/docs/books/tutorial/extra/regex/index.html

Regexp Reference: http://java.sun.com/j2se/1.5.0.06/docs/api/java/util/regex/

Pattern.html

Launch External Applications or Plug-Ins

ProSource provides the capability of launching frequently used applications, Web
pages, or reports from within the ProSource interface. Configuring access to these
applications or plug-ins involves adding a plug-in that uses a Java Processor. The
Processors are designed specifically for the type of plug-in that you would like to
launch, such as an Excel Processor to launch customized Excel reports.
In addition, you can also configure custom scripts and triggers as plug-ins, such as a 
pre-create trigger that automatically populates certain fields with pre-defined values
when users create new entries.
This section explains the options available and how to configure the plug-ins. The
following topics are included in this section:
• “Plug-ins That Can Be Configured” on page 6-62
• “Where the Plug-ins Can Be Launched” on page 6-62
• “How to Configure the Plug-in” on page 6-63
• “Example Plug-In Configurations” on page 6-67
• “Create Custom Behavior Using Trigger Plug-ins” on page 6-81
Plug-ins That Can Plug-ins can be configured to pass data from ProSource to other applications in
Be Configured various formats. Some formats include:
• 3rd-party applications that you frequently use, such as GeoFrame or OpenWorks
• Customized Microsoft Excel spreadsheets or CSV ASCII files of data accessed from
ProSource
• Shapefiles, ArcXML (for maps)
• VRML files (for 3D views of Grid/Interpretation images)
• A Web link
• A URL
• Custom mechanisms: You can also write your own Java processor, and then
register this code in ProSource to add a different type of plug-in. The base class
and utility methods for data access allow you to write the necessary code. You
can either run your entire utility within the ProSource Java Virtual Machine (JVM)
or launch your application as you wish from your Java code.
Where the Plug-ins You can configure the extension or plug-in to be launched from several locations in
Can Be Launched ProSource, including:
• The main ProSource menu
• A particular viewer’s menu
• The Send To menu (accessed when you right-click or MB3 objects)
• Various trigger points such as a pre-insert trigger (explained in section “Create
Custom Behavior Using Trigger Plug-ins” on page 6-81).
• A tree node in TreeView

• • • • • •
Note: Plug-ins should only be added to the main ProSource menu. (Example: the
Tools menu) if the plug-in is not intended to process data provided by
ProSource (Example: using CommandLineProcessor). If you require a
plug-in to process data selected in ProSource, use another entry point.
(Examples: a viewer menu such as TableView or the Send to menu).
The Processors are designed to act upon the data that is selected in the result set,
such as the data selected in TableView. If you want the extension that is to be
launched to act upon all rows in TableView, first select all rows by using the
keyboard combination of CTRL + A, and then select the desired extension in which
you plan to launch the data.
One exception to this is when an extension is launched from the Result Set Node 
(Example: TreeView). In this case, it is assumed that the user wants to launch an
extension to act upon all rows in the result set. If the extension is launched from a
leaf node (a data item) it is assumed that only this single item should be included in
the launch.
How to Configure This section explains the basic process for configuring all plug-ins. Following this
the Plug-in section are specific examples of how to configure certain types of plug-ins (example
values you would provide).
You can either add a plug-in using the ProSource interface or add the plug-in
through SQL.
 To add a plug-in using the ProSource interface

1 Log on to ProSource as an Administrator.
2 In TreeView, select ProSource Admin>Plug-in
Configuration>Applications.
Fig. 6-34 Database Connection

3 Enter your credentials, and then click Connect.
4 Click the Create a new item icon corresponding to the Applications tree
node.
The Applications Create form opens in RowView.
5 Enter the attribute values for the new plug-in. Table 6-5 explains the options
available.
Table 6-5 Application or Plug-in Attribute Descriptions
Id Enter a unique string to identify the entry.
Tip: By adding “Plug-in” to the beginning of the ID, at a later date
you will be able to easily identify all plug-ins that have been added
as customizations to ProSource.
Display name Enter a unique name for the plug-in (as it will appear in the GUI).
Use the picklist only for examples, as you want to provide a
unique name that is not already used in another area of
ProSource.
Display  Use the picklist to specify where you would like users to access
location the plug-in. For example, if you would like for the plug-in to be
accessed from the Send To menu (accessible when users right-
click MB3 objects), select that option.
Display order (optional) Enter the location in which the extension is to be
displayed in the menu. 1 = first entry in menu, 2 = second entry
in menu, and so on.
Display tooltip (optional) Enter the text you want displayed as a pop-up when a
user’s mouse hovers over the option for more than two seconds.
Display icon (optional) File name of GIF or JPG icon to display in the GUI for
this plug-in. The file must be in the CLASSPATH. If this value is not
entered, no icon is displayed.
GUI Viewer (optional) Enter a view such as TableView or GisView if you would
like to restrict the plug-in so that it is only an option for the user
when they are in that particular view. If no value is entered, the
plug-in will be available when the user is in all view types.

Topic (optional) Enter a topic, which is the Dictionary-specific name for
the tree node name, if you would like to restrict the plug-in so that
it is only an option for the user when they are in that particular
topic. If no value is entered, the plug-in will be available when the
user is in all topics.
This field supports wildcards ‘*’. 
For example, entering Well* enables the plug-in only when
viewing topics starting with “Well”.
Enter multiple topics by separating the topic names with a comma 
(no spaces). Example: topic1,topic2
Tip: To find out the topic name for a tree node, right-click a node
in TreeView, and then select Dictionary>Show Topic
Information. The Topic name is the value to enter in this field.
Datastore (optional) Use the picklist to choose a datastore (data source)
name type, such as FINDER or GEOFRAME, if you would like to restrict
the plug-in so that it is only an option for the user when they are
in that particular datastore. If no value is entered, the plug-in will
be available when the user is in all datastores.
This field supports wildcards “*”. 
For example, entering OPENWORKS* enables the plug-in when
viewing data for all OpenWorks extensions.
Enter multiple datastores by separating the datastore names with
a comma (no spaces). Example: datastore1,datastore2
Processor Use the picklist to choose the Java-based processor that will
name handle launching the plug-in. Commonly used processors are
explained further in this section.
Note: The Processor picklist options are not all inclusive, as the
picklist shows only those processors that have been previously
used for a plug-in. If you would like to use a processor that is not
listed in the picklist, simply enter the processor name in this field.
Note: It is also possible to write your own Java code that will plug
into ProSource. For information on this, contact the Schlumberger
Rapid Response Team (RRT).
Processor (optional) Enter extra parameters to be passed to the processor.
properties Enter quotes around the value if the value contains spaces;
otherwise, the quotes are not necessary. Separate the parameters
with a space.
Note: The picklist shows all previously entered parameters for all
processor types and is not specific for the type of processor that
was selected. Parameter options for commonly used processors
are explained further in this section.
6 Once you have entered the values for the new plug-in, click Save.
7 Grant permissions for access to the new plug-in.
a. When you click Save to save the new plug-in, ProSource asks “Would you
like to entitle users to your new plug-in application?”. Select Yes. The
Information Management (IM) Administration Console launches. Within the

IM Administration Console, define the users or groups whom you would like
to have access to the new plug-in. This is a mandatory step since, initially,
the Administrator who created the plug-in is the only user able to view the
new plug-in option.
b. The IM Administration Console opens to the Applications tab of the Objects
workflow. Locate and select (to highlight) your new plug-in on the list (the
Extension name is the ID you entered, and the Description is the Display
name you entered).
c. Grant permissions to the new plug-in by clicking Users, Groups, or Roles,
depending on the type of access you would like to provide. If you would like
to provide all users access to the new plug-in, click Roles to open the
Roles for Object window. Click Add to open the Add Role to Objects
window. Select the SIS_Public role, and then click OK. Enter the
entitlement options, and then click OK. You are then returned to the Roles
for Objects window, and the SIS_Public role should be listed. Click Close
to close out of the Roles for Objects window.
d. Once you have set the permissions, select File>Exit to exit the IM
Administration Console.
• • • • • •
Note: For further information on how to use the IM Administration 
Console, such as how to set up users, groups, and roles and how to assign
permissions, refer to the IM Administration Console Online Help by 
selecting Help>Help Contents.
8 Re-launch the ProSource client and sever to view and use the new plug-in.
 To add a plug-in using SQL

Rather than using the ProSource interface, you can add a plug-in by adding the
same values as in the Applications Create form, only through SQL.
1 In SQL, connect to the Seabed instance that stores the ProSource metadata.
2 Enter the following SQL statement:
INSERT INTO PLUGIN_APPLICATIONS ( Id, Display_name,
Display_location, Display_order, Display_tooltip,
Display_icon, Gui_viewer, Topic, Datastore_name,
Processor_name, Processor_prop)
VALUES
( <Id>, <Display_name>, <Display_location>,
<Display_order>, <Display_tooltip>, <Display_icon>,
<Gui_viewer>, <Topic>, <Datastore_name>, <Processor_name>,
<Processor_prop>);
COMMIT;
Example:
INSERT INTO PLUGIN_APPLICATIONS ( Id, Display_name,
Display_location, Display_order, Display_tooltip,
Display_icon, Gui_viewer, Topic, Datastore_name,
Processor_name, Processor_prop)

VALUES
( 'Petrel Well Header', 'Petrel Well Header', 'Send To',
10.5, 'Create flat file in Petrel Well Header format' ,
NULL, NULL, 'Finder_Well_Location', 'FINDER',
'com.slb.im.federator.qbm.launchmanager.ExcelLaunchProcess
or' , 'format=csv 
separator=tab saveOnly=yes useHeaderQuotes=no
useValueQuotes=no includeSourceInfo=no
forceNumberLocaleUS=yes
attributes=uwi,well_name,x_tophole,y_tophole,crstatus
uwi=Uwi well_name=WellName x_tophole=X-Coord y_tophole=Y-
Coord crstatus=Symbol');
COMMIT;
3 Grant permissions for access to the new plug-in. For more information, see
Step 7 page 65.
4 Re-launch the ProSource client (you do not have to re-launch the ProSource
server) in order to view and use the new plug-in.
Example Plug-In This section provides examples values for adding the following plug-in types:
Configurations
• “Example: Launch an External Extension” on page 6-67
• “Example: Launch a Web Page” on page 6-69
• “Example: Launch a URL” on page 6-71
• “Example: Launch a Custom Excel Report” on page 6-72
• “Example: Launch a CGM Command” on page 6-78
• “Example: Launch a Server-side Script with Context and Log-in Parameters” on
page 6-78
• “Example: Create a Custom Processor” on page 6-81
For each example, follow the steps as explained in the previous section “How to
Configure the Plug-in” on page 6-63, and use the example values below as guidance
when creating your plug-in.
Example: Launch an To launch an external application from within ProSource, such as Petrel or
External Extension GeoFrame, use the Command Line Processor. This section shows example values to
add a plug-in that uses the Command Line Launch Processor to launch Petrel from
the ProSource Extensions menu.
Enter the following values for the new plug-in on the Applications Create form.(For a
description of each attribute, refer to Table 6-5 on page 6-64):
• Id - Plug-in: Petrel
• Display name - Launch Petrel
• Display location - Extensions
• Display order - 2
• Display tooltip - Launch the Petrel extension
• Display icon - (Leave blank)

• GUI viewer - (Leave blank so that this option is available when the user is in all
views.)
• Topic - (Leave blank so that this option is available when the user is accessing all
topics.)
• Datastore name - (Leave blank so that this option is available when the user is
accessing topics.)
• Processor name - 
com.slb.im.federator.qbm.launchmanager.CommandLineLaunchProc
essor
• Processor prop(erties) - 
“Command=C:\Program Files\Schlumberger\Petrel 2005\Petrel 2005.exe”
• • • • • •
Note: The quotes are mandatory if the command value contains a space.
Table 6-6 shows the set of keywords available for the Command Line Processor.:
Table 6-6 Command Line Processor Parameter Options
Keyword Description
Command (mandatory) Enter the path to the executable file on the client
machine.
Note: You can specify platform-specific commands by appending the
operating system name returned by the Java method
System.getProperty(“os.name”). Example:
command-Windows_2000=d:\launch.bat command-SunOS=/app/
launch.csh
Parameters (optional) Enter any extra parameters appropriate for the chosen
command.
noWindow (optional) If this is set, the extension is launched with the start /B
option on Windows to avoid displaying a startup window. Note that
this does not work for most types of extensions; most extensions
need a startup window.
When you complete the configuration (save the new plug-in and provide user
access through the IM Administration Console), Petrel can then be launched
from the Extensions menu, as shown in Figure 6-35:

Fig. 6-35 New Plug-in to Launch Petrel
Example: Launch a Web To launch a Web page or any third party application from within ProSource, use the
Page URL Launch Processor. 
This section shows an example of how to add a plug-in that uses the URL Launch
Processor to launch a URL from the Send To menu. The Send To menu option is
titled “Show Well Documents”. The URL points to a documentation system which can
display scanned documents, given the UWI value. ProSource supports two formats
for the URL including:
• www.mydocumentsystem.com/<uwi>.html - For this format, specify the UWI
directly in the URL quoted with percent (%) signs. For instance,
www.mydocumentsystem/%UWI%.com specifies that ‘UWI’ is the attribute name
you want to be populated in the target’s UWI. If you are in TableView, and you
select a well in which UWI=123456, and then you select Send To>Show Well
Documents, ProSource will launch the following URL:
www.mydocumentsystem.com/123456.html.
• www.mydocumentsystem.com?uwi=<uwi> - For this format, list the attributes in
the Attributes keyword, as specified in Table 6-7 on page 6-70. Using this format,
ProSource will launch the following URL: www.mydocumentsystem.com/
?uwi=123456. This format assumes that the documentation system can
parse the parameters passed in, while the first example format simply
looks up a document directly.
Enter the following values for the new plug-in on the Applications Create form. (For
a description of each attribute, refer to Table 6-5 on page 6-64):
• Id - Plug-in: Show Well Documents
• User -Database User name
• Pwd -Database User password
• DBURL - database connection url in format of <HOST:PORT:DATABASE NAME>
• Database - name of database
• Display name - Show Well Documents
• Project - name of project

• Display location - Send To

• Display tooltip - View the record’s well document
• GUI viewer - TableView
• Topic - Finder_Well_Location
• Datastore name - FINDER
• Processor name -
com.slb.im.federator.qbm.launchmanager.UrlLaunchProcessorBase
• Processor properties - URL=http://www.mydocumentsystem.com
Attributes=uwi
Table 6-7 shows the set of keywords available for the URL Processor.
Table 6-7 HTTP Get or HTTP Post Processor Options
Keyword Description
URL (mandatory) Enter the website address to launch.
Method If the method is set to “post”, a temporary HTML page is generated
with all the parameters specified and the URL is launched using this file
as a parameter. Enter the path to the executable file on the client
machine.
Options Any optional parameters to add to the HTML link.
Attributes A comma-separated list of attributes to send to the URL. Example:
“uwi,well_name,status”. Use to return all the selected attributes.
Generate =yes (Advanced). If this is set to “yes”, then a server ticket is
Ticket generated and the ticketID is sent to the URL (for the Web page to get
a connection to the server).
passCreden If the value is set to ‘Y’ or ‘y’, credentials can be passed.
tials
NoPwd If the value is set to ‘Y’ or ‘y’, password will not be sent to target
application. If the value is not set or set as ‘other’, password will be
sent to target application.
encrypt If the value is set to ‘Y’ or ‘y’, password will be encrypted and new
parameter will be added to list of other HTML, containing name of
encrypted parameter.
i.e. <input type="hidden" name="enc_params" value="Pwd">
separatorC If the value is not set, all selected value will be against keys i.e.
harForMulti key1=value1 and key1=value2.
Value If the value is set to a comma (,), all multiple values will be separated
by this character for a given key i.e. key1=value1,value2.
HTTP Get limits the amount of data passed as parameters to 2048 KB. 
Use HTTP Post, if you need to support larger amounts.

You can use the HTTP Post method to do more advanced URL launching. ProSource
creates a temporary HTML file that contains all selected data, as well as the
following parameters:
• Client IP address (variable name: _SYSTEM_CLIENT_IP_ADDRESS)
• ProSource User name (variable name: _SYSTEM_CLIENT_User_NAME)
• Selected topic name (variable name: SYSTEM TOPIC_NAME)
• Capability key (variable name: SYSTEM CAPABILITY_KEY)
• Datastore type (variable name: SYSTEM DATA_STORE_TYPE)
• Datastore name (variable name: SYSTEM DATA_STORE _NAME)
• Database name (variable name: SYSTEM DATABASE_NAME)
• Dictionary name (variable name: SYSTEM DICTIONARY_NAME)
• Selected attributes as comma separated list (variable name: SYSTEM
ATTRIBUTES)
• • • • • •
Note: The attribute names are used as variable names for the actual data.
Example: Launch a URL To launch a URL from within ProSource, use the URL Launch Processor and register
topic specific plug-ins in the main TableView. This section shows an example of how
to add a plug-in that uses the URL Launch Processor to launch a URL from the
ProSource menu. The ProSource menu option is titled “View Related Documents”.
 To launch a URL from within ProSource

1 Log in to the ProSource database using SQL Plus as a user that has an
Administrative role in the IM Administration Console.
2 Enter the following values for the new plug-in on the Applications Create form.
(For a description of each attribute, refer to Table 6-5 on page 6-64):
- Id: ViewRelatedDocuments
- Display name: View Related Documents
- Display location: TableView Popup
- Display order: 99
- Datastore name: FINDER
- Topic: Finder_Well_Nodes
- Processor name:
com.slb.im.federator.qbm.launchmanager.UrlLaunchProcessorBase
- Display tooltip: Launch a URL to view related documents Display icon: null
- Processor prop: url=http://www.myurl.com/%uwi%.html
• • • • • •
Note: In this field, you can specify any attribute value to pass to the URL link. In
this example, we specified uwi as the type of attribute to pass.

3 Grant the permissions to public for the new plug-in.

4 Restart the ProSource client.
5 In TreeView, navigate to Finder>Well Data>Wells>Locations and
execute a query.
- If the attribute value is a URL, double-click the URL to launch the browser.
- If the attribute value is not a URL, right-click the attribute on the Tableview
and select View Related Documents from the menu.
- The browser opens and inserts the selected UWI attribute data into the URL 
(i.e., http://www.myurl.com/150.asp?redirect=404&) in which 150 is the
selected attribute data in the Uwi column in your query results.
Example: Launch a You can configure ProSource to export data selected in a viewer, such as TableView, 
Custom Excel Report to a file recognized by Microsoft Excel, such as an XLS, a CSV, or a TXT file. In
addition, you can specify additional properties for the exported file, such as the
exact attributes you would like exported. This section shows an example of how to
add a plug-in that saves the selected data to a CSV file. In this example, the plug-in
option is confined to a specific topic and datastore type, since the plug-in’s output
relies on the data selected by the user.
• • • • • •
Note: You can also create custom Excel templates so that when users export
data to an Excel report, the report has pre-defined formats and/or
formulas. For more information on registering custom Excel templates with
ProSource, refer to “Register Excel Templates” on page 6-88.
Enter the following values for the new plug-in on the Applications Create form. (For
a description of each attribute, refer to Table 6-5 on page 6-64):
• Id: Plug-in - Petrel Well Header
• Display name: Petrel Well Header
• Display location: Send To
• Display order: 10.5
• Display tooltip: Create flat file in Petrel Well Header format
• Display icon: (Leave blank)
• Gui viewer: (Leave blank)
• Topic: Finder_Well_Location
• Datastore name: FINDER
• Processor name:
com.slb.im.federator.qbm.launchmanager.ExcelLaunchProcessor
• Processor prop: format=csv separator=tab saveOnly=yes
useHeaderQuotes=no useValueQuotes=no includeSourceInfo=no
attributes=uwi,well_name,x_tophole,y_tophole,crstatus
uwi=Uwi well_name=WellName x_tophole=X-Coord y_tophole=Y-
Coord crstatus=Symbol

If you need to include depth, first be sure to form the query correctly (use KB as a
query constraint for elevation_ref). In this case, you would enter the following
information into the Processor properties value:
Processor prop: format=csv separator=tab saveOnly=yes
useHeaderQuotes=no useValueQuotes=no includeSourceInfo=no
attributes=uwi,well_name,x_tophole,y_tophole,elevation,drill
ers_td,crstatus uwi=Uwi well_name=WellName x_tophole=X-Coord
y_tophole=Y-Coord elevation=KB drillers_td=BottomDepth
crstatus=Symbol
• • • • • •
Note: The keywords above are shown in blue for ease of mapping them to their
descriptions in Table 6-8 on page 6-74.
When you complete the configuration (save the new plug-in and provide user
access through the IM Administration Console), the Petrel Well Header report
can then be launched from the Send To menu when viewing data in the
Finder>Wellbores topic, as shown in Figure 6-36:
Fig. 6-36 New Plug-in to Save the Petrel Well Header Report

Selecting the Petrel Well Header option opens the Save Data File dialog box. You can
then enter a name for the report, and open the report in a text file that looks similar
to Figure 6-37:
Fig. 6-37 Example Report Opened as a Text File
Table 6-27 shows the set of keywords available for the Excel Processor:
Table 6-8 Excel Processor Keywords
Keyword Description
Format Control the output file type
The Excel launch processor can output data in an Excel or flat
file format. Accepted values are:
• CSV (comma separated value fields - flat file ASCII format)
• TXT (same as CSV, except you get a .txt extension by
default)
• XLS (Excel spreadsheet file)
separator Control which column separator to use (flat file only)
By default, ProSource uses semicolons to separate the
columns in a flat file. You can control this by specifying any
type of a seperator:
separator=tab (separate the columns with the tab)
or
separator=- (separate the columns with a dash “-”)
Command or Launch the associated extension or save to a file
saveOnly ProSource can optionally launch a utility once the output file
has been created. You control this with the following keyword:
“command=my executable name”
If your executable name contains spaces, make sure to use
quotes.
If you do not want to launch an executable, use the
“saveOnly=yes” keyword. It will invoke a file selection box
instead of generating a file name for you.

Keyword Description
useHeaderQuotes, Control whether to quote values (flat file only)
useValueQuotes By default, ProSource uses quotes for the values in the flat
and file. 
useSpaceQuotes You can control this with the keywords:
• useHeaderQuotes=no (do not use quotes for header
values)
• useValueQuotes=no (do not use quotes for row values)
• useSpaceQuotes=yes (only use a quote if the value
contains a space - Example: “my well name”)
includeSourceInfo Specify whether to include the header
By default, the Excel or CSV file will include two context lines
with the date and the question name. You can choose not to
include these two lines by specifying:
includeSourceInfo=no
forceNumberLocal Force U.S. Number locale (flat file only)
eUS Some loaders (Example: Petrel import) require U.S. number
standards, such as using a period “.”instead of a comma “,” to
denote the use of decimals. By default, ProSource uses the
locale set on the client machine, but US locale can be forced
for export by including the following keyword in the processor
properties:

Keyword Description
Attributes Specify the attributes for export
The Excel processor can be configured to export specific
attributes, rather than export all attributes in the current
viewer, such as all attributes displayed in TableView. As an
example, if you specify the attributes value of:
attributes=uwi,well_name,x_tophole
Only those three attributes are generated in the report,
regardless of which attributes the user included in the query
or selected in TableView.
The report generates the attributes in the exact order in which
they are specified.
Separate the attribute values with a comma.
(no keyword Rename the attribute names for column titles
required) Occasionally, the exported file will be used to import the data
into another extension. The other extension might require a
specific name for a given attribute (Example: well name in
Petrel must be WellName). You can map the attribute names
to any other attribute name by simply appending the attribute
mapping to the end of the processor properties in the format
of “<attribute name in ProSource>=<attribute name in other
extension>”.
An example for a file that will be used to import Petrel Well
Header information is:
well_name=WellName uwi=Uwi x_tophole=X-Coord
y_tophole=Y-Coord elevation=KB
drillers_td=BottomDepth crstatus=Symbol
Example: Create If the data for a report comes from several tables in Seabed involving complex joins,
Formatted Advanced it may not be feasible to develop a ProSource view and topic to retrieve this data.
Excel Reports ProSource/Seabed extensions provide an alternative mechanism to develop such
reports. Using this mechanism, ProSource/Seabed extensions provide several
formatted reports on the well log data stored in the Seabed database. These reports
can be extended and customized at every installation to suit the need.
 To Create and Configure an Advanced Microsoft Excel Report

1 Create and load the ProSource view for a new report.
a. Create a viewloader script for this new report. As a guide, use the
viewloader scripts for the sample reports packaged with the ProSource
Installer. The sample reports can be found in $PS_HOME/install/psl/
viewloader directory and start with "report_". You can put the new
script in the same directory. Make sure that you provide a unique name for
the view and topic.
b. Load the view using the Viewloader, by executing the following command
from the ProSource server machine.
$PS_HOME/bin/viewloader.sh <prosource home>/install/psl/
viewloader/<viewloader_script_for_your_new_report>

2 Create a report definition.

a. On the ProSource server, locate the report definition file 
$PS_HOME/conf/tahiti/report_def.xml
b. The file contains entries of the following format. Each ReportDef entry
corresponds to a single report.
<ReportDef>
<name> </name>
<topic> </topic>
<SqlSelect> </SqlSelect>
<SqlFrom> </SqlFrom>
<SqlWhere> </SqlWhere>
</ReportDef>
Each of the XML tag definitions are explained below:
-ReportDef - The tag enclosing a report definition entry
-Name -The name of the report
-Topic - The ProSource topic name used inside the viewloader script run from
Step 1.b.
-SqlSelect - The SELECT clause in the SQL query used to retrieve data for this
report
For example, if the query is “select w.id, w.name from well w”, then the
value entered in this tag would be “w.id, w.name”.
Make sure that column names used in the query matches the topic
attributes present in the viewloader script that is run from Step 1.b.
-SqlFrom - The FROM clause in the SQL query used to retrieve data for this
report. For example, if the query is “select w.id, w.name from well w”, then
the value entered in this tag would be “well w”.
-SqlWhere - The WHERE clause in the SQL query used to retrieve data for
this report. For example, if the query is “select w.id, w.name from well w
where 
w.id = 100”, then the value entered in this tag would be “w.id = 100”.
3 Create, register and package an Excel template for use with the newly created
report.
For more information on creating, registering and packaging a template, refer
to the section “Register Excel Templates” on page 6-88.
• • • • • •
Note: To make any new report available to all users, choose the deployment
using the jar file option.
4 Stop and restart the ProSource server.

5 Use the IM Admin Console to entitle the newly created capability to the users
who will have access to the new report.
6 Restart the ProSource Client and the new Report node will appear under Logs -
> Reports tree.

Example: Launch a CGM Complete the following steps to launch a CGM command.
Command
 To launch a CGM command

The CGM Command Line Launch processor name you need to register in the plug-in
applications table is:
com.slb.im.federator.qbm.launchmanager.CGMLaunchProcessor
The CGM Command Line Launch processor can be configured with the following
options:
Table 6-9 CGM Command Line Launch Processor Options
Option Description
showFileDialog =yes. Set this option to open a file dialog for users to specify a
filename for the CGM file being saved. If this option is not set,
the command=<> option is used instead.
command Enter the path to the executable file on the client machine. This
executable is launched to act upon the CGM file. If no command
is specified, the operating system file association is used to
launch the default extension.
parameters These parameters are passed after the filename.
noWindow If this option is set, the extension is launched with the start /B
option on Windows to avoid displaying a startup window. This
does not work for all types of extensions. Your extension might
need the startup window.
Example: Launch a Create a script to be launched, make it available on the server file system, and then
Server-side Script with register a ServerScriptLaunchProcessor in the plug-in applications table. Here is how
Context and Log-in this server-side launching framework works:
Parameters
1 A new JavaServer Page (JSP) is configured and running on a server somewhere 
(the same server as ProSource Transfer Manager). This is a standard (does not
require customization) JSP, which we provide. You can customize this page, but
it is not required. This JSP page can be used to launch a number of different
server-side scripts.
2 Write a server-side script (which can then launch your extension) and put this
somewhere so it is available from the JSP page in Step 1.
3 Register your script in the PLUGIN_APPLICATIONS table, such as for any other
plug-in. Use the processor ServerScriptLaunchProcessor. In this entry, specify
the URL and whether your script needs a Finder select list as input. You can
also specify any potential parameters you might need (such as the project
password) and the prompt to use when querying the user. The JSP page will
then query for all missing parameters. See below for a sample entry.
4 When the user selects some data and chooses Send To>My Finder app,
ProSource saves a Finder select list (if requested), packs up all the information
that is needed, and passes it on to the JSP page. The Finder select list is
marked as temporary with an expiration date of today + 1 day.
5 The JSP page then:
a. Prompts the user for any missing information.

b. Creates a log file.

c. Outputs all parameters as environment variables.
d. Launches your script, the name of which was passed in from ProSource. It is
100% dynamic; nothing is hard coded.
6 Your script should then read the parameters it needs from the environment
variables and launch the extension. Any information that should be returned to
the user should go to the log file.
The JSP page will tail the log file. Note that one of the variables you can
capture is the IP address of the client machine. This means that you can set the
display, and launch Motif apps as well, assuming the user has an X server
running on his/her machine, and that xhost+ has been set. You could even use
it to launch Finder from ProSource, such as under the Extensions menu. You
could even define a “Finder” menu in ProSource with all the Finder tools
available from the main Finder menu. The following table shows the
environment variables you can access to from your script:
Table 6-10 Filter Attribute Settings
_SYSTEM_LOG_FILE This is the log file into which you should output
data.
_SYSTEM_SEL_FILE This is a file that contains the selected data. 
(Note: This is in addition to optional Finder
select lists.)
_SYSTEM_CLIENT_IP_ADDRESS This is the IP address of the client machine.
_SYSTEM_CLIENT_USER_NAME This is the user name used to log into
ProSource.
_SYSTEM_TOPIC_NAME This is the topic from which the data is selected.
_SYSTEM_CAPABILITY_KEY This is the key of the capability with which the
data was retrieved.
_SYSTEM_DATA_STORE_TYPE This is the type of data source from which the
data came. 
(Example: FINDER)
_SYSTEM_DATA_MODEL_NAME This is the data model from which the data
came.
(Example: FINDER)
_SYSTEM_DATABASE_NAME This is the database from which the data came.
(Example: SPIDER)
_SYSTEM_DICTIONARY_NAME This is the Dictionary name. 
(Example:
jdbc:Oracle:thin:@134.32.71.72:1521:seabed)
_SYSTEM_ATTRIBUTES These are the attributes you can find in the
selection file. 
(Example: uwi,primary_source,record_changed)
Login Option 1:

Use this logon only if you specified the “supplyLogin=yes” parameter in the
processor properties.
_SYSTEM_DATABASE_USER - This is the user account used to login
to the project. Example: install
_SYSTEM_DATABASE_PASSWORD - This is the password used to login
to the project. Example: install
This login request option is not 100% secure because the user name and password
are stored in a temporary HTML file on the client machine. This HTML file will reside
on the client machine until you exit ProSource. For a more secure password
retrieval, you should choose the second login option. (Note: The second option
requires you to retype your password.)
Login Option 2:
This login option requests the JSP page to query the user for any data. This is done
by adding prompts to the processor properties (in the plugin applications entry). For
example, if you add:
prompts=PROJECT_PASSWORD,FILTERING_PARAMETER
PROJECT_PASSWORD=Project Password FILTERING_PARAMETER=Please
enter the filtering parameter
The JSP page will query the user like this:
Project Password:
Please enter the filtering parameter:
The two values the user enters will then be outputted to environment variables
PROJECT_PASSWORD and FILTERING_PARAMETER before your script is called.
If your variable ends with “passwords”, the type in the JSP page will also be set to
password (the typed text is hidden).
The following shows a complete example of a plug-in application entry:
INSERT INTO PLUGIN_APPLICATIONS ( ID, DISPLAY_NAME,
DISPLAY_LOCATION, DISPLAY_ORDER, GUI_VIEWER, TOPIC,
PROCESSOR_NAME, PROCESSOR_PROP, DISPLAY_TOOLTIP,
DISPLAY_ICON ) VALUES (
'ScriptTest', 'ScriptTest', 'Send To', 10, null, null,
'com.slb.im.federator.qbm.launchmanager.ServerScriptLaunchPr
ocessor'
, 'url=http://134.32.71.73:8529/servertools/jsp/Wrapper.jsp
scriptName=test.csh method=post supplyLogin=yes title=
post supplyLogin=yes title=<title for jsp page>
prompts=project_password,something_else
project_password=Project Password something_else=Please
enter something here finderSelectList=yes
FinderSelectListType=WELLS',
'Launch a server script on the server.', null);
INSERT INTO PLUGIN_APPLICATIONS_GROUP ( PERMISSION_ID,
APPLICATION_ID, GROUP_S ) VALUES (
'ScriptTest','ScriptTest', (select group_s from slg_group
where name='public'));
COMMIT;

The keyword FinderSelectListType in the example above must be either:

“WELLS”, “SEISMIC”, “SEISMIC_3D_SURVEY”, “GRAPHIC_OBJECT”, or any custom
GEMS type (Example: DOCUMENTS, PIPELINE, etc.).
• • • • • •
Note: In order for the Finder select list Save function to work, a predefined set 
of select list topics must be available. These topics will also enable the
user to edit Finder select lists from ProSource.
Example: Create a To implement your own Launch capability, you will use the
Custom Processor LaunchProcessorInterface.
This interface contains one method – execute – that is called with the appropriate 
parameters when the user launches the extension:
public class MyLaunchProcessor implements
LaunchProcessorInterface
{
: /**
: * Execute launch action. This method is called when the
User
: * activates the launch. i.e. by pressing Send to -> My App
: *
: * @param LaunchParameters – Parameter class with
parameters
: * for this launch
: *
: */
: public void execute(LaunchProcessorParameters parameters);
}
1 Implement the interface.
2 Compile your Java class.
3 Refer to this class file in the ProSource Plug-in Applications node: 
ProSource Admin>Plugin Configuration>Plugin Applications.
4 Restart the client for the new settings to take effect.
Create Custom You can add custom behavior to the create, save, read, and update actions that
Behavior Using users perform in ProSource. The custom behavior is defined using triggers. These
Trigger Plug-ins triggers are added in the same fashion as adding an application plug-in. Each type
of trigger uses a different processor:
• Pre-Create:
Processor:
com.slb.im.federator.qbm.launchmanager.PreCreateExecuteQuestionTrigger
This trigger is activated when the user clicks Create New .

Example usage: You want to pre-populate some attributes in the Create New
form.
• Pre-Save:

This trigger is activated when the user presses Save before the values are sent
to the server and stored in the database. You can use this trigger to validate
data or to change data in some way before it is saved.
• Post-Save:
Processor:
com.slb.im.federator.qbm.launchmanager.PostSavePluginApplicationTrigger
This trigger is activated when the result from the save operation comes back
from the database. You can use this trigger to chain workflows, such as to ask
if the user wants to create a child object after successfully creating a parent
object.
• Post-Read:
This trigger is activated when data from a search or read operation returns
from the server. You can use this trigger to activate special formatting such as
QA algorithms.
Example: Pre-populate The following workflow activates the pre-create trigger for the UWI attribute on the
an Attribute Finder>Wellbores node, which is the Finder_Well_Location topic. When the user
clicks Create New Wellbore and FormView opens to enter the new Wellbore’s
value, the UWI attribute will be pre-populated with the next sequence value.
 To add the trigger through the ProSource interface

Add a plug-in, as explained in section “How to Configure the Plug-in” on page 6-63. 
In the Applications Create form, enter the following values for the pre-create trigger:
• Id: Plug-in - Pre-populate UWI
• Display name: SequencerPreCreateTrigger
• Display location: PreCreateTrigger
• Display order: 0
• Display tooltip: (Leave blank)
• Display icon: (Leave blank)
• Gui viewer: (Leave blank)
• Topic: Finder_Well_Location
• Datastore name: FINDER
• Processor name:
• Processor prop: dataModel=FINDER topic=finder_sequences “question=Next
Value” sourceAttribute1=nextval targetAttribute1=uwi “filter=Next
Value:sequence_name:=:ESI.GRAPHIC_OBJECT_SEQ”
 To add the trigger using SQL

1 Log into the ProSource database, using SQL Plus, as the user who has the
Administrative role in the IM Administration Console.
2 Add a plug-in application definition for the trigger:
DELETE FROM plugin_applications

WHERE id = 'SequencerPreCreateTrigger';
INSERT INTO plugin_applications (ID, DISPLAY_NAME,
DISPLAY_LOCATION, DISPLAY_ORDER, GUI_VIEWER, TOPIC,
PROCESSOR_NAME, PROCESSOR_PROP, DISPLAY_TOOLTIP)
VALUES (
'SequencerPreCreateTrigger', 'SequencerPreCreateTrigger',
'PreCreateTrigger', 0, null, 'Finder_Well_Location',
'com.slb.im.federator.qbm.launchmanager.PreCreateExecuteQu
estionTrigger', 'dataModel=FINDER topic=finder_sequences
"question=Next Value" sourceAttribute1=nextval
targetAttribute1=uwi "filter=Next
Value:sequence_name:=:ESI.GRAPHIC_OBJECT_SEQ"', null);
3 Grant the User(s) or Role(s) access to the SequencerPreCreateTrigger extension
object in the Information Management Administration (IM Administration)
Console. For details on how to grant access, refer to the IM Administration
Console Online Help.
4 Restart the ProSource server and client.
5 In TreeView, navigate to the topic Finder>Well
Data>Wells>Locations>Create New (the Finder_Well_Location
question).
6 In the Create New Item form, ensure that the UWI attribute is pre-populated.
Example: Pre-populate Use the following workflow if you would like to assign constant values to any column 
Fields in ProSource while creating new rows.
 To assign constant values to columns in ProSource

1 Create a table with the constant values you want to assign to columns. 
In the case of Finder, you can use the tables in the codes account.
For instance, to assign a constant value to the FACILITY_TYPE column in the 
FACILITY table, codes.R_FACILITY can be used.
2 Create a view, topic, and question (with read capability) for this table.
3 Create a Plug-in Application from ProSource with the following:
Display Location: PreCreateTrigger
Topic: Name of the topic for which you want to set a constant value
Processor Name: 
Processor Prop: The format of this should be as described in the example
below: 
dataModel=FINDER topic=F93_Codes_R_Facility_t
"question=Read R_Facility"
sourceAttribute1=type targetAttribute1=facility_type
"filter=Read
R_Facility:type:=:PERFORATION_SET"

This is interpreted as: use the “type” attribute in the

topic F93_Codes_R_Facility_t and question "Read
R_Facility" in the Finder datastore. Filter the data in
this question by setting the value of
type='PERFORATION_SET' and assign the results to the
attribute “facility_type” of your topic.
In PL/SQL terms this will be:
SELECT type INTO facility_type FROM r_facility WHERE
type='PERFORATION_SET'
4 From the IM Administration Console, grant your role privilege to this extension 
by clicking Roles>Objects>Add and selecting your Plugin.
Example: Enforce If you would like to enforce certain formatting on string attributes, you can use the 
Formatting on String PrefixFormat, PostfixFormat, and PadToMinLength keywords for the pre-create
Attributes trigger. For example, follow the steps below if you would like to enforce that your
Finder well location UWI's always start with “WB” and are followed by a minimum of
six characters. ProSource will then automatically add the “WB” prefix when a user
enters a UWI, and pad the entry with “0” if less than six characters have been
entered.
 To set a formatting prefix for an attribute using the pre-create trigger

1 Follow the exact steps as the previous workflow, only in addition, execute the
following SQL commands between Steps 1 and 2.
In SQL Plus, update the usage_type in table slg_attribute for the topic and
attribute that you want to define the trigger:
UPDATE slg_attribute
SET usage_type= PrefixFormat=WB
PadToMinLength=6
PadCharacter=0
WHERE topic_s = (SELECT topic_s
FROM slg_topic
WHERE topic_name=’Finder_Well_Location’)
AND attribute_name='uwi';
COMMIT;
2 In the Create New Item form, ensure that the UWI attribute is in the form of
“WB<value_ User_enters>”.

Add a Custom Equality Test Option

The Compare tool provides several comparison options, or Equality Tests. These
Equality Test options vary depending on the type of attribute selected. Figure 6-38
shows the standard Equality Test options for string attributes (For complete details
on the standard set of Equality Test options, refer to the ProSource Online Help,
accessible from the Help menu).
Fig. 6-38 Compare View Content Wizard Showing Equality Test Options
You can customize the Equality Test options, such as defaulting the Parameters
value each time a specific Equality Test option is selected, and adding your own
algorithms. This way, the Administrator can add complex rules and mappings
between difference name spaces that will then be available to users in a simple
manner.
 To default the Parameters field each time a specific Equality Test

option is selected
This example creates a new Equality Test option for the Replace Strings comparison
operator that will be called “KB Compare”. When the user selects this option, the
Parameters value defaults to create a mapping between “KellyBushing” and “KB”.
To add a custom equality test option, add a plug-in in the same manner as other
types of plug-ins are added, as explained in section “How to Configure the Plug-in”
on page 6-63 (shows how to add a plug-in, details the options available, and
explains how to provide access to the new plug-in). Then use the example values
below for pre-create trigger values to enter in the Applications Create form. For
complete details on the attribute options, refer to Table 6-5 on page 6-64.
• Id - KBMappingComparator
• Display name - KB Compare
• Display location - ComparatorHandler

• Display tooltip - Defaults the replace string Parameters value to “KB=KB_CODE
KellyBushing=KB_CODE”.
• GUI viewer - (Leave blank)
• Topic - finder_well_location
• Datastore name - FINDER, PETREL
• Processor name -
com.slb.sis.prosource.compare.impl.ComparatorHandlerReplaceS
trings
• Processor (properties) - type=string caseInsensitive=yes
useSearchCode=yes “parameter=KB=KB_CODE
KellyBushing=KB_CODE” “parameterDescription=Space separated list
of character sequences to replace. List the longest sequences first. Example:
KB=KB_CODE KellyBushing=KB_CODE. Can be used for mapping between two 
datastores.”
The custom Equality Test option then opens as shown in Figure 6-39.
Fig. 6-39 Compare View Content Wizard Showing the Custom Equality Test
Options

Note that defaulting the Parameters value is also useful for ignoring pre-defined
strings (using the Ignore Strings option).
 To use your own algorithm as an Equality Test option

You can implement your own comparison algorithm by performing the following
steps:
1 Extend the ValueComparator Java interface.
2 Include your implementation in unsignedresources.jar (extract it, add your
file(s) and rejar it).
3 Register your implementation in the ProSource plug-in applications with the
location CompatorHandler.

Register Excel Templates

You can customize ProSource to use advanced reports in Excel. You do this by
creating a report template in Excel and then registering the template with a given
ProSource topic as a plug-in. You can then select to display the report under a
separate “Report” menu, or you can include it in the Send To menu.
ProSource professional report templates are compatible with DecisionPoint. This
means that, if you create a DecisionPoint Excel template, you can use the same
report template from ProSource, provided you register it with the same attribute
order that it has in DecisionPoint, and that you register it for a topic that contains
the same attributes.
• • • • • •
Note: This procedure will only work when the report template is saved in Excel
97-2003 worksheet (*.xls) format in Microsoft® Excel® 2007 and will not
work in Microsoft® Excel® 2007 (*.xlsx) format.
 To create a template
1 Open ProSource and display the data for which you want to create the
template.
2 Right-click the data and select Send To>Excel to send the data to Excel.
• • • • • •
Note: The number of rows selected determine the number of data points that
will appear on your chart.

The Excel file appears (Figure 6-40).
Fig. 6-40 Excel Template
3 Insert an additional sheet in Excel in which you define your report (charts, etc.) 
by referring to the data in the first sheet (which you exported from ProSource).
Make sure you insert the new sheet after the data sheet, as illustrated in
Figure 6-41.
Fig. 6-41 Inserting a Worksheet

4 Select the Source Information sheet (Figure 6-40), and then right click and
Delete to remove the Source Information sheet that ProSource created.
• • • • • •
Note: The Source Information sheet includes a URL that you can click to display
a Search Panel which allows you to conveniently query data on the source
topic.
5 Select the attributes column from your first worksheet, as shown in Figure 6-
42.
Fig. 6-42 Selecting Attributes
On the Insert tab, in the Charts group, do one of the following:

a. Click the chart type and then click a chart subtype that you want to use.
b. To see all available chart types, click a chart type, and then click All Chart
Types to display the Insert Chart dialog box. Click the arrows to scroll
through all available chart types and chart subtypes, and then click the ones
that you want to use. The chart is placed on the worksheet.

Fig. 6-43 Chart in Excel Spreadsheet
6 When you click on the chart, the Chart Tools become available and the
Design, Layout and Format tabs are displayed.
Use the Design tab to display the data series by row or by column, make
changes to the source data of the chart, change the location of the chart,
change the chart type, save a chart as a template, or select predefined layout
and formatting options.
Use the Layout tab to change the display of chart elements such as chart titles
and data labels, use drawing tools, or add text boxes and pictures to the chart.
Use the Format tab to add fill colors, change line styles, or apply special
effects
7 To move the chart to the new worksheet, click anywhere on the chart. Click on
the Design tab, and then in the Location group, click Move Chart. Click
Object in, and then select the worksheet in which you want to place the chart,
from the list.

Fig. 6-44 Move Chart to new Worksheet
8 On the Layout tab, in the Labels group, click Legend and select the type of
placement of legend.
9 On the Layout tab, in the Labels group, click Chart Title to select the
positioning of title and enter the suitable chart title.
10 The template report appears in the new worksheet.
Fig. 6-45 Template Report

11 Select all the data in the first sheet.

On the Home tab, in the Editing group, click the arrow next to the Clear
button and click Clear All to delete all the data.
12 On the Home tab, in the Cells group, click Format. Under Visibility, click
Hide & Unhide, and then click Hide Sheet to hide the first sheet.
• • • • • •
Note: The data sheet that you are hiding needs to be the first sheet in the Excel
spreadsheet.
13 Save your Excel template file with the desired name.

In order to use the template you just created, you need to register it. For more
information, refer to the following section.
• • • • • •
Note: If a template is using macros, a security dialog box will appear beneath
the Microsoft Office ribbon saying “Security Warning Macros have been
disabled”. When the notification appears, click Options>Enable this
content>OK.
 To register a template
1 Create a plug-in application entry for the new report, and specify the Excel
template in the Processor properties such as “template=MyExcelTemplate1.xls”.
If you are referring to a template on the local disk, you need to specify the full
path, such as “template=c:\templatedir\MyExcelTemplate1.xls”. Otherwise, you
only specify the file name (“template=MyExcelTemplate1.xls”).
You can put your report in the main TableView menu, in the Send To cascade
menu, or in a new cascade menu (Example: Reports). Use the standard plug-in
application features to do this. For additional information, refer to “Example:
Launch a Custom Excel Report” on page 6-72.
Example for the LOCAL file option
DISPLAY_LOCATION, DISPLAY_ORDER, DISPLAY_TOOLTIP,
DISPLAY_ICON, GUI_VIEWER, TOPIC, DATASTORE_NAME,
PROCESSOR_NAME, PROCESSOR_PROP ) VALUES (
'ExcelTemplateTest', 'Excel Graph Test', 'Send To', 10.1,
'Create Excel spreadsheet and activate viewer with a
template' , 'ExportToExcelAction.gif', NULL,
'Finder_Well_Location', NULL,
or' , 'template=c:/TemplateTest.xls
attributes=uwi,well_name,field,primary_source,elevation,el
evation_ref,
drillers_td,crstatus'); COMMIT;
Example for the jar file option

• • • • • •
Note: The difference in the jar file option is that the template name is not
prefixed with a directory.

DISPLAY_LOCATION, DISPLAY_ORDER, DISPLAY_TOOLTIP,
DISPLAY_ICON, GUI_VIEWER, TOPIC, DATASTORE_NAME,
PROCESSOR_NAME, PROCESSOR_PROP ) VALUES (
'ExcelTemplateTest', 'Excel Graph Test', 'Send To', 10.1,
'Create Excel spreadsheet and activate viewer with a
template' , 'ExportToExcelAction.gif', NULL,
'Finder_Well_Location', NULL,
or' , 'template=TemplateTest.xls
attributes=uwi,well_name,field,primary_source,elevation,el
evation_ref,
drillers_td,crstatus'); COMMIT;
2 This step is optional, but highly recommended. In order for your report to work
properly, it will need the same attributes as the original Send To you performed.
You can either make the users enforce this, which won’t be user-friendly, or you
can ensure that the same attributes will be used by including the attributes
keyword in the processor properties for your plug-in. You do this by listing the
attribute names in the desired order, such as:
attributes=uwi,well_name,x_tophole,y_tophole,elevation,
drillers_td,crstatus
The complete processor properties will then be:
"template=MyExcelTemplate1.xls
attributes=uwi,well_name,x_tophole,y_tophole,elevation,
drillers_td,crstatus"
• • • • • •
Note: Packaging a template requires you to use a jar command. This is not
present by default in a ProSource installation. If you have Java installed on
your Linux machine, set the Java home path in the PATH environment
variable in order to use the jar command. If Java is not installed on your
Linux machine, you can package a template by using the commands unzip
or zip.
3 Use the IM Administration Console and grant your users access the new plug-in 
application.
4 Restart the ProSource client.
You are now ready to use the template.
 To package a template
The template can either be packaged locally on each machine, or, for more
configuration, and ease of deployment for multiple users, in the
unsignedresources.jar.

In order to package the template locally on the client machine, refer to the full path
name in the processor properties (see step 3 below), such as
“template=c:\templatedir\MyExcelTemplate1.xls”.
To package the template in the unsignedresources.jar, use the following steps:
1 Locate the unsignedresources.jar file in your installation. It is in the
PSHOME/jars directory.
2 Extract the unsignedresources.jar file to another location. Use Winzip or
the command “jar xf unsignedresources”; where “jar” is from your Java
installation.
3 Put your Excel template in the directory com/slb/im/federator/qbm/
unsignedresources from the extracted jar file.
4 Recreate the unsignedresources.jar file by executing “jar cf
unsignedresources.jar com”. When you do this, you need to be in the directory
below the com directory that was extracted in step 1.
5 Make a backup of the unsignedresources.jar file in your installation and
replace it with the one you just created.
6 Restart the ProSource server and delete the Java WebStart cache on each client
machine.


7 ProSource Topic Web Service Usage
In This Chapter
Introduction ............................................................................................... 7-2

Methods in Topic Web Service ..................................................................... 7-3
encrypt ................................................................................................ 7-3
getDatastore Names ............................................................................. 7-4
getDatabase Names.............................................................................. 7-5
getEligibleDatabases............................................................................. 7-6
getTopics ............................................................................................. 7-7
getTopicAttribute Names ....................................................................... 7-8
getFilterOperators ................................................................................ 7-8
read .................................................................................................... 7-9
getBulkData ........................................................................................7-15
Beans ......................................................................................................7-18
User ...................................................................................................7-18
Prompt ...............................................................................................7-18
TopicDetails ........................................................................................7-19
ReadQSpecification ..............................................................................7-19
Filter ..................................................................................................7-19
TopicResponse ....................................................................................7-19
Records ..............................................................................................7-20
Record................................................................................................7-20
BulkRequest........................................................................................7-22
NameValue .........................................................................................7-22
Session, License Management and Client Timeout........................................7-23
ProSource Topic Web Service Usage 7-1

Introduction
Introduction
This chapter provides usage guidelines for the ProSource Topic or Data Access Web
Service. This web service provides a way for other applications to build utilities that
can query the data available via the ProSource interface without explicitly using the
ProSource interface. Key features are as follows:
• A way to query any ProSource node is provided, irrespective of whether it was
available out-of-the-box with ProSource or custom developed. This includes any
bulk or spatial data that the node might contain.
• Returns data similar to what is seen via the TableView in ProSource
• Support is provided for selection of attributes to return.
• Support is provided for filtering data based on attribute values.
• The service uses the same user authentication and entitlement mechanism as the
ProSource client.
• A standard web service SOAP API (see below) is provided.
If the user makes an incorrect request, the response will contain an error message.
For example, if the user name contains an invalid password, the response will be as
follows:
<soapenv:Fault>
<faultcode>soapenv:Server</faultcode>
<faultstring>Unable to login user and the reason is
[Reason: Password is null or empty] </faultstring>
<detail/>
</soapenv:Fault>
The ProSource Topic Web Service provides access to ProSource nodes (topics/
questions) using a SOAP API. It is developed using the Axis 2 Implementation of the
SOAP API. Currently, it supports only read capability for all ProSource nodes.
You can connect to the ProSource Topic Web service’s endpoint at the following URL:
http://<HOST NAME OF PS SERVER>:<HTTP PORT>/psws/services/
Topic?wsdl
For example, http://slb-host:8080/psws/services/Topic?wsdl
where, slb-host is the host name where ProSource server is running.

Methods in Topic Web Service

The following section describe the various methods available via this web service. It
contains a brief description of the method, the input parameters expected by the
method, and the values it returns. Examples are included for all methods to illustrate
how they should be used.
All methods (except encrypt), check for an existing HTTP session for the user. If it
does not exist, a new user session is created.
• • • • • •
Note: This web service is a licensed component, and all methods except encrypt
use a license. Please contact your Schlumberger representative for more
information on acquiring a license.
encrypt This method is used to encrypt any string. It should be used to encrypt ProSource or
other data store passwords, before using them in all other methods. This method
does not check any license.
Table 7-1 encrypt Parameters
Name DataType Description

Secret java.lang.String Input string to be encrypted
Table 7-2 encrypt Returns
DataTyp Description
java.lang.String Encrypted string
Example of SOAP UI Web Service Client:

The following example is used to encrypt the string “atradio”.
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/
soap/envelope/" xmlns:top="http://topic.ps.sis.slb.com">
<soapenv:Header/>
<soapenv:Body>
<top:encrypt>
<top:secret>atardio</top:secret>
</top:encrypt>
</soapenv:Body>
</soapenv:Envelope>
Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/
soap/envelope/">
<soapenv:Body>
<ns:encryptResponse xmlns:ns="http://topic.ps.sis.slb.com">
<ns:return>P4sWMHCP/iCxIzTVoCjRRA==</ns:return>

</ns:encryptResponse>
</soapenv:Body>
</soapenv:Envelope>
getDatastore This method can be used to get a list of data stores that the user has access to.
Names
Table 7-3 getDatastoreNames Parameters

userInfo User A user bean instance containing the user name
and password details
Table 7-4 getDatastoreNames Returns
DataType Description
java.lang.String [] Datastore names array.

The following example can be used to get the list of data stores that the user
“atardio” has access to. Please note that the password for this user is encrypted
using the encrypt method.
Request
…..
<top:getDatastoreNames>
<top:userInfo>
<xsd:name>atardio</xsd:name>
<xsd:password>P4sWMHCP/iCxIzTVoCjRRA==</
xsd:password>
</top:userInfo>
</top:getDatastoreNames>
…..
Response
…..
<ns:getDatastoreNamesResponse xmlns:ns="http://
topic.ps.sis.slb.com">
<ns:return>ENTITLEMENT</ns:return>
<ns:return>GEOFRAME</ns:return>
<ns:return>LOGS</ns:return>
</ns:getDatastoreNamesResponse>
…..

getDatabase This method takes user credentials (user name and password) and a data store
Names name as input and returns a list databases that are available to the user.
Table 7-5 getDatabaseNames Parameters

datastoreNa java.lang.String Datastore name
me
Table 7-6 getDatabaseNames Returns
java.lang.String [] String array containing the database names for
the input user and datastore

The example below illustrates a way of querying the list of LOGS (used by ProSource
Logs) databases available to the user “atardio”.
Request
…..
<top:getDatabaseNames>
<top:userInfo>
<xsd:password>P4sWMHCP/iCxIzTVoCjRRA==</
xsd:password>
</top:userInfo>
<top:datastoreName>LOGS</top:datastoreName>
</top:getDatabaseNames>
…..
Response
…..
<ns:getDatabaseNamesResponse xmlns:ns="http://
<ns:return>PSDB05B</ns:return>
<ns:return>PSDB04D</ns:return>
</ns:getDatabaseNamesResponse>
…..

getEligibleDatabases This method can be used to get a list of database names applicable to a particular
topic. The topic name should be prefixed with the datastore (for example,
ENTERPRISE.Well_Summary_DOV)
Table 7-7 getEligibleDatabases Parameters

topicName java.lang.String Topic name
Table 7-8 getEligibleDatabases Returns
java.lang.String [] String array containing the database names for
the input user and topic name.
Example of SOAP UI Web Service Client

This example can be used to get the list of databases applicable to PSL_Logging_Job
node in ProSource Logs.
Request
…..
<top:getEligibleDatabases>
<top:userInfo>
<xsd:password>P4sWMHCP/iCxIzTVoCjRRA==</xsd:password>
</top:userInfo>
<top:topicName>LOGS.PSL_Logging_Job</top:topicName>
</top:getEligibleDatabases>
…..
Response
…..
<ns:getEligibleDatabasesResponse xmlns:ns="http://
<ns:return>PSDB05B</ns:return>
<ns:return>PSDB04D</ns:return>
</ns:getEligibleDatabasesResponse>
…..

getTopics This method can be used to get a list of ProSource topics that belong to a particular
data store.
Table 7-9 getTopics Parameters

datastoreNa java.lang.String Datastore name
me
Table 7-10 getTopics Returns
java.lang.String [] String array containing the topic names for the
input user and dataStore.

The following example can be used to query all ProSource Logs topics (nodes)
available to the user “atardio”.
Request
…..
<top:getTopics>
<top:userInfo>
</top:userInfo>
</top:getTopics>
…..
Response
…..
<ns:getTopicsResponse xmlns:ns="http://topic.ps.sis.slb.com">
<ns:return>PSL_Remarks_Logging_Parameter</ns:return>
<ns:return>PSL_Log_Channel_Set</ns:return>
<ns:return>PSL_Log_Tool_Parameter</ns:return>
</ns:getTopicsResponse>
…..

getTopicAttribute This method can be used to list all the attributes that are part of a topic in
Names ProSource.
Table 7-11 getTopicAttributeNames Parameters

userInfo User A user bean instance containing the user
name and password details
datastoreName java.lang.String Datastore name
topicName String Topic name
Table 7-12 GetTopicAttributeNames Returns
java.lang.String [] String array containing the topic names for the
input user and dataStore

This example can be used to list all the attributes belonging to the PSL_Logging_Job
node in the LOGS datastore.
Request
…..
<top:getTopicAttributeNames>
<top:userInfo>
</top:userInfo>
<top:topicName>PSL_Logging_Job</top:topicName>
</top:getTopicAttributeNames>
…..
Response
…..
<ns:getTopicAttributeNamesResponse xmlns:ns="http://
<ns:return>Job_Invoice_Num</ns:return>
<ns:return>Logging_Activity_Type</ns:return>
<ns:return>Logging_Job_Reason</ns:return>
<ns:return>Remarks</ns:return>
</ns:getTopicAttributeNamesResponse>
…..
getFilterOperators This method can be used to return a list of filter criteria that can be applied on
various attributes. Please note that it lists all possible filter options but some of them

will not be applicable to certain types of attributes. For example “<=” is applicable
to numeric and date attributes and not to strings.
Table 7-13 getFilterOperators Returns
java.lang.String [] String array containing operators

Request
…..
<top:getFilterOperators>
</top:getFilterOperators>
…..
Response
…..
<ns:getFilterOperatorsResponse xmlns:ns="http://
<ns:return>=</ns:return>
<ns:return>NONE</ns:return>
<ns:return>></ns:return>
<ns:return><</ns:return>
<ns:return>!=</ns:return>
<ns:return>NOT LIKE</ns:return>
<ns:return>IN</ns:return>
<ns:return><=</ns:return>
<ns:return>BETWEEN</ns:return>
<ns:return>LIKE</ns:return>
</ns:getFilterOperatorsResponse>
read This method is used to read a question on ProSource and to return the response to
the web server client. It uses custom data types for the request (“ The parameters
datastoreName and jdbcUrl are not required for the Topic Web service execution and
hence are optional.”) and response (“TopicResponse”). You can browse through
beans section for the detailed structure of these custom beans.

Table 7-14 execute parameters.

request TopicRequest Contains the detailed information about the
request topic e.g. topic names, attributes, filter
constraints for topic records etc.
pageSize int Returns the maximum number of rows per page
expected from the response.
rowNum int Returns the starting index of the record from
where next records should be returned in the
request.
Table 7-15 execute returns
TopicResponse Contains the status of topic request, failure
reason, records and their unit information

The following example can be used to query specific attributes from the
PSL_Borehole_Summary topic in the ProSource Logs tree. It also filters records by
Name.
Request
<top:read>
<top:request>
<xsd:prompt>
<xsd1:name>User</xsd1:name>
<xsd1:password>P4sWMHCP/iCxIzTVoCjRRA==</xsd1:password>
<xsd1:databaseName>ABCD</xsd1:databaseName>
<xsd1:datastoreName />
<xsd1:jdbcUrl />
<xsd1:projectName>Project</xsd1:projectName>
</xsd:prompt>
<xsd:readDetails>
<xsd:constraintChoices>
<xsd:attributeName>Name</xsd:attributeName>
<xsd:constraint>XXX</xsd:constraint>
<xsd:operator>=</xsd:operator>
</xsd:constraintChoices>
<xsd:selectedAttributeNames>UBHI</xsd:selectedAttributeNames>
<xsd:selectedAttributeNames>Name</xsd:selectedAttributeNames>
<xsd:selectedAttributeNames>Remarks</
xsd:selectedAttributeNames>
<xsd:selectedAttributeNames>Version</
<xsd:selectedAttributeNames>Source</
</xsd:readDetails>

<xsd:topicDetails>
<xsd:dataStoreName>LOGS</xsd:dataStoreName>
<xsd:topicName>PSL_Borehole_Summary</xsd:topicName>
</xsd:topicDetails>
<xsd:userInfo>
<xsd1:name>User</xsd1:name>
<xsd1:password>P4sWMHCP/iCxIzTVoCjRRA==</xsd1:password>
</xsd:userInfo>
</top:request>
<top:pageSize>10</top:pageSize>
<top:rowNum>1</top:rowNum>
</top:read>
Response
<ns:return xsi:type="ax218:TopicResponse">
<ax218:errorMsg xsi:nil="true"/>
<ax218:executionState>SUCCESS</ax218:executionState>
<ax218:result xsi:type="ax218:Records">
<ax218:attributeMetadata
xsi:type="ax218:AttributeMetadata">
<ax218:attributeDetails xsi:type="ax219:NameValue">
<ax219:name>DataType</ax219:name>
<ax219:value>Long</ax219:value>
</ax218:attributeDetails>
<ax218:attributeName>Shape_Ref_Id</ax218:attributeName>
</ax218:attributeMetadata>
<ax219:value>String</ax219:value>
<ax218:attributeName>Source</ax218:attributeName>
<ax218:attributeName>Name</ax218:attributeName>
<ax218:attributeName>UBHI</ax218:attributeName>

<ax218:attributeName>$HOME</ax218:attributeName>
<ax218:attributeName>Version</ax218:attributeName>
<ax218:record xsi:type="ax218:Record">
<ax218:attributeData xsi:type="ax219:NameValue">
<ax219:name>UBHI</ax219:name>
<ax219:value>YYYYYYYYYYYYY</ax219:value>
</ax218:attributeData>
<ax219:name>Name</ax219:name>
<ax219:value>XXX</ax219:value>
<ax219:name>Source</ax219:name>
<ax219:value>VENDOR</ax219:value>
<ax219:name>Remarks</ax219:name>
<ax219:value/>
<ax219:name>Version</ax219:name>
<ax219:value>1</ax219:value>
<ax218:index>1</ax218:index>
</ax218:record>
</ax218:result>
<ax218:topicDetails xsi:type="ax218:TopicDetails">
<ax218:dataStoreName>LOGS</ax218:dataStoreName>
<ax218:topicName>PSL_Borehole_Summary</ax218:topicName>
</ax218:topicDetails>
</ns:return>
Connecting to other All the examples above were specific to a ProSource Seabed based repository (Logs,
Data sources like Enterprise, Seismic, Results). In order to connect to data sources other than
GeoFrame and Seabed, you need to specify additional connection parameters. The following
OpenWorks examples describe how these parameters can be specified as part of the Prompt
bean in “ The parameters datastoreName and jdbcUrl are not required for the Topic
Web service execution and hence are optional.”.
Request

…..
<top:request>
<xsd:prompt>
<xsd1:name>gf2012</xsd1:name>
<xsd1:password>40pavwygJvqwmDFFh4SgUQ==</xsd1:password>
<xsd1:databaseName>gf2012-Lnx-ILXGF2012</
xsd1:databaseName>
<xsd1:datastoreName>GEOFRAME</xsd1:datastoreName>
<xsd1:jdbcUrl>jdbc:oracle:thin:@gf2012-Lnx-
ILXGF2012:gf2012</xsd1:jdbcUrl>
<xsd1:projectName>GF2012</xsd1:projectName>
<xsd1:extendedAttributes>
<xsd1:name>Unix User Name</xsd1:name>
<xsd1:value>gf2012</xsd1:value>
</xsd1:extendedAttributes>
<xsd1:name>Password</xsd1:name>
<xsd1:value>40pavwygJvqwmDFFh4SgUQ==</xsd1:value>
<xsd1:name>Project Name</xsd1:name>
<xsd1:value>cloudpin</xsd1:value>
</xsd:prompt>
<xsd:readDetails>
</xsd:readDetails>
<xsd:topicDetails>
<xsd:dataStoreName>GEOFRAME</xsd:dataStoreName>
<xsd:topicName>GFArea_Of_Interest</xsd:topicName>
</xsd:topicDetails>
<xsd:userInfo>
<xsd1:name>sis_admin</xsd1:name>
<xsd1:password>4MJKuO1riSJ+4FR+LOMk3Q==</xsd1:password>
</xsd:userInfo>
</top:request>
Response:
<ns:executeResponse xmlns:ns="http://topic.ps.sis.slb.com">
<ns:return xsi:type="ax215:TopicResponse"
xmlns:ax215="http://beans.topic.ps.sis.slb.com/xsd"
xmlns:ax213="http://bean.webservice.ps.sis.slb.com/xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
xsi:type="ax215:AttributeMetadata"/>

<ax215:attributeData xsi:type="ax215:Attribute">
<ax215:name>database</ax215:name>
<ax215:value>GeoFrame4</ax215:value>
<ax215:attributeData xsi:type="ax215:Attribute">
<ax215:name>project_name</ax215:name>
<ax215:value>cloudpin</ax215:value>
</ax215:record>
</ax215:result>
<ax215:dataStoreName>GEOFRAME</
ax215:dataStoreName>
<ax215:topicName>GFArea_Of_Interest</
ax215:topicName>
</ns:return>
</ns:executeResponse>
Parameters needed to Table 7-16 GeoFrame Connection parameters

pass for GeoFrame
connection Value
Name Description
(Examples)
Unix User Gf2012 The Unix user name for connecting to
name GeoFrame
Password 40pavwygJvqwm Unix password in AES encrypted format
DFFh4SgUQ==
Project Name cloudpin The project name to be connected
Project WqcGWjzKDMHE The project password in AES encrypted format
Password ytbJQ5hSSg==
Parameters needed to Table 7-17 OpenWorks Connection parameters

pass for OpenWorks
connection Value
Name Description
(Examples)
Unix User ow_test The Unix user name for connecting to
name OpenWorks 500
Password 40pavwygJvqwm Unix password in AES encrypted format
DFFh4SgUQ==
Project Name TMP_Flounder The project name to be connected with

getBulkData This method can be used to query data stored in the Bulk_Array in ProSource
Seabed. Please refer to the Seabed Data Model documentation for more information
about the data types stored in this format. It also uses a complex data type
(“BulkRequest”) as an input.
Table 7-18 getBulkData Parameters

request BulkRequest It contains the Bulk Array Id for which bulk
data has to be retrieved. It also contains
information about Prompt and User
details.
pageSize int It contains the number of rows returned
for a request.
rowNum int It contains the start row number.
Table 7-19 getBulkData Returns
TopicResponse Contains the bulk data records in Attribute
Name/ Value format. The Attribute details such
as Unit and Datatype would be specified in
Attribute Metadata. It also contains the status
and reason for failure, if any.

Request
<top:getBulkData>
<top:request>
<xsd:bulkArrayId>276707</xsd:bulkArrayId>
<xsd:prompt>
<xsd1:password>4MJKuO1riSJ+4FR+LOMk3Q==</
xsd1:password>
<xsd1:databaseName>PSDB07A</xsd1:databaseName>
<xsd1:datastoreName>ENTERPRISE</
xsd1:datastoreName>
<xsd1:jdbcUrl>jdbc:oracle:thin://
163.183.194.246:1521/psdb07a</xsd1:jdbcUrl>
<xsd1:projectName>MAIN_PROJECT</xsd1:projectName>
</xsd:prompt>
<xsd:user>
<xsd1:password>4MJKuO1riSJ+4FR+LOMk3Q==</
xsd1:password>
</xsd:user>
</top:request>
<top:pageSize>100</top:pageSize>

<top:rowNum>1</top:rowNum>
</top:getBulkData>
Response
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/
soap-envelope">
<soapenv:Body>
<ns:getBulkDataResponse xmlns:ns="http://
<ns:return xsi:type="ax215:TopicResponse"
xmlns:ax215="http://beans.topic.ps.sis.slb.com/xsd" >
<ax215:attributeDetails
xsi:type="ax213:NameValue">
<ax213:name>Unit</ax213:name>
<ax213:value>MM</ax213:value>
<ax215:attributeDetails
xsi:type="ax213:NameValue">
<ax213:value>Double</ax213:value>
<ax215:attributeName>CALI</ax215:attributeName>
<ax213:name>Bulk_Array_Id</ax213:name>
<ax213:name>DEPT</ax213:name>
<ax213:value>233.0</ax213:value>
<ax213:name>CALI</ax213:name>
<ax213:value>-999.25</ax213:value>
</ax215:record>

</ax215:record>
</ax215:record>
</ax215:result>
<ax215:dataStoreName>ENTERPRISE</
ax215:dataStoreName>
<ax215:topicName>Generic_Bulk_Data</ax215:topicName>
</ns:return>
</ns:getBulkDataResponse>
</soapenv:Body></soapenv:Envelope>

Beans
Beans
This section lists the beans and their descriptions.
User This bean is used for ProSource login credentials. It includes the ProSource User
name and Password.
Table 7-20 User Content Model

name java.lang.String User name
password java.lang.String Encrypted password
Prompt This bean is used for Database connection login credentials.

Table 7-21 Prompt Content Model

name java.lang.String User name
password java.lang.String Encrypted password
databaseName java.lang.String Database name
datastoreName java.lang.String DataStore name
jdbcUrl java.lang.String JDBC URL
projectName java.lang.String Project name in ProSource
ExtendedAttrValues java.util.List username and password pairs for
database connectivity to OpenWorks,
GeoFrame, UNIX etc.
• • • • • •
Note: The parameters datastoreName and jdbcUrl are not required for the
Topic Web service execution and hence are optional.
TopicRequest This bean is used as an input argument for the read method. It consists of the
following beans to express the specifications for the question execution on the
ProSource server.
Table 7-22 TopicRequest Content Model

prompt Prompt Prompt details
topicDetails TopicDetails Topic details

Beans

userInfo User User information for authentication
readDetails ReadQSpecification Specification to search question values
TopicDetails Table 7-23 TopicDetails Content Model

dataStoreName java.lang.String Datastore name
topicName java.lang.String Topic name
ReadQSpecification ReadQSpecification contains the columns list whose values should be present in the
response of the question execution. It also contains the filter information to be
applied while executing the question.
Table 7-24 ReadQSpecification Content Model

constraintChoices Filter [] List of constraints to be applied while
executing question
selectedAttribute java.lang.String [] Column names to be present in response
Names
Filter Table 7-25 Filter Content Model

attributeName java.lang.String Attribute name on which filter will be
applied.
constraint java.lang.String Value of attribute to be used as constraint
operator java.lang.String Operator to be used in filter condition
TopicResponse Table 7-26 TopicResponse Content Model

errorMsg java.lang.String Error message (if any) during question
execution.
executionState java.lang.String Response status of the question execution.

Beans

result Records Records if the question execution is
successful
topicDetails TopicDetails Topic details
Records Table 7-27 Records Content Model

record Record[] Records array
attributeMetadata AttributeMetadata[] Attribute Metadata array
Record Table 7-28 Record Content Model

attributeData NameValue[] This holds attribute name and its
value. The attribute name
corresponds to the attribute Name
from AttributeMetaData.
index int Index of this attribute in record array.
AttributeMetadata Table 7-29 AttributeMetadata Content Model

attributeName java.lang.String Name of the attribute or column. This
corresponds to the attribute Name in
attributeData from Record.
attributeDetails NameValue[] Attribute details is in the form of Name/
Value pairs. For example, Name = Unit
and Value = Deg.
BulkDataRequest Table 7-30 BulkDataRequest Content Model

bulkArrayId long Bulk Array Id for the data to be retrieved.
prompt Prompt Dimension of the attribute (e.g. depth).
user User User information for authentication.

Beans
NameValue Table 7-31 NameValue Content Model

name java.lang.String Name of the attribute.
value java.lang.String Value of the attribute.
Key constants for Table 7-32 AttributeMetadata Key Constants

Attribute details in
AttributeMetaData Name Description
Unit Displays unit of the column
UnitDimension Displays dimension of the Unit
Value Constants for Table 7-33 AttributeMetadata Value Constants

DataType returned in
AttributeMetadata
Name Description
Shape WKT (well known text)
String java.lang.String
Integer java.lang.Integer
Float java.lang.Float
Date java.sql.Data and java.util.Date
TimeStamp java.sql.TimeStamp
Long java.lang.Long
Double java.lang.Double
ByteArray byte[]
IntegerArray int[]
LongArray long[]
FloatArray float[]
DoubleArray double[]
StringArray String[]
Map Map

Beans
BulkRequest This bean is used as an input argument for the getBulkData method. It consists of
the following beans to express the specifications for the question execution on the
ProSource server.
Table 7-34 BulkRequest Content Model

bulkArrayId long Bulk Array Id for the data to be
retrieved.
prompt Prompt Prompt details
user User User information for authentication
NameValue Table 7-35 NameValue Content Model

name java.lang.String Key of the object
value java.lang.String Value of the object

Session, License Management and Client Timeout

License management is carried out to ensure that only authorized users are able to
read the Web Service methods. All methods (except encrypt) check if there is an
existing HTTP session. If not, a new HTTP session is created for the user and checks
out the eims_ws_data_access license.
Session management is carried out to improve the performance of the Web Service.
Hence, a Web Service client must maintain an active session to make multiple, serial
Web Service calls. The Web Service maintains the session for 60 minutes from the
last request of the web service client. If the client is inactive for more than 60
minutes, the Web Service invalidates the session and releases the
eims_ws_data_access license.
The following is the example for a Java Web Service client code to maintain a
session.
…..
TopicStub service = new TopicStub();

service._getServiceClient().getOptions().setManageSessi
on(true)
………
A Web Service client must use the same TopicStub instance to take benefit of
session management.
Whenever a request sent to the server requires heavy processing, the web service
client terminates the http connection with the “Request Timed Out” message. For
example, if a client initiates a topic request with a thousand rows of data, but
requires only the last set of rows, there will be a delayed response because of the
high level of data processing involved. Therefore, to increase the client connection
wait time, use the snippet in Java web service client code displayed below.
TopicStub service = new TopicStub();
service._getServiceClient().getOptions().setTimeOutInM
illiSeconds(10 * 60 * 1000); //10 mins


8 OpenSpirit Integration
In This Chapter
Integrating OpenSpirit with ProSource ......................................................... 8-2

Prerequisites ........................................................................................ 8-2
Start OpenSpirit Server ......................................................................... 8-2
Configure ProSource ............................................................................. 8-3
Define OpenSpirit User for ProSource Server Account.............................. 8-3
Start OpenSpirit User Server for ProSource User ..................................... 8-4
Create OpenSpirit User ......................................................................... 8-4
OpenSpirit Data Access Prerequisites ..................................................... 8-5
Modify OpenSpirit Parameters................................................................ 8-6
OpenSpirit Integration 8-1

Integrating OpenSpirit with ProSource

The ProSource OpenSpirit feature allows users to access data in OpenSpirit
datastores. Data selection events can be sent to an OpenSpirit session, allowing
data selected in ProSource to be detected by other OpenSpirit-enabled extensions.
Prerequisites The following prerequisites must be met in order to use the OpenSpirit integration 
with ProSource:
• ProSource license feature eims_ds_openspirit is required.
• OpenSpirit 3.2.3 Server (master) installation must be accessible from the
ProSource server installation directory.
• ProSource users must be registered with OpenSpirit. ProSource users enter their
Unix account credentials when connecting to an OpenSpirit datastore in
ProSource.
• Datastores must be configured with OpenSpirit, and OpenSpirit users must be
granted access to projects in the configured datastores.
• • • • • •
Note: If the OpenSpirit server (Master) is installed on a different host than the
configured datastore, then an OpenSpirit client (satellite) installation must
be made on the same platform (Operating System) as the datastore, and
the data server must be started on that host. For more details, refer to the
OpenSpirit User Guide.
• • • • • •
Note: If the ProSource server administrator account is the same as the 
OpenSpirit server administrator account, then you may not create an alias 
to this account because the OpenSpirit server administrator account is
shielded from any user alias. To create an alias to the ProSource server
administrator account, this account must be different from the OpenSpirit
server administrator account.
Start OpenSpirit Before you begin, make sure that OpenSpirit is installed and configured (master
Server installation) and that you have the appropriate OpenSpirit licenses. The OpenSpirit
server may be installed on either Solaris or Linux, but it must be accessible from the
ProSource installation directory. For details on how to start and stop OpenSpirit
servers, refer to the OpenSpirit Administrator documentation. For your convenience,
the OpenSpirit 3.2.3 procedure is described in this section.
 To start OpenSpirit server

1 Log in as an OpenSpirit Administrator on the host on which the OpenSpirit
server is installed.
2 Execute the $osp_home/bin/runOSServices.sh status script.

• If the OpenSpirit server is running, stop it by executing $osp_home/bin/

runOSServices.sh stop
• If the OpenSpirit server is not running, start it by executing $osp_home/
bin/runOSServices.sh start
3 Verify that the OpenSpirit server has started by executing the $osp_home/
bin/runOSServices.sh status script.
Configure You must configure the ProSource OpenSpirit adapter parameters required to
ProSource connect to OpenSpirit.
• • • • • •
Note: The following operation is now supported through the Configuration Utility
present in IM Administration Console under ProSource>Connections
tab and should be performed using IM Administration Console only.
However, this section is still left here since users can perform the below
operation as well. But it is advisable to configure using IM Administration
Console.
 To configure ProSource
• • • • • •
Note: Configuring ProSource is optional if the correct information was entered 
for the OpenSpirit Adaptor parameters using the configuration options in
the IM Administration Console.
1 Launch the IMAdmin script in safe-start mode 

($ps_home/TomcatHome/webapps/imadmin/safe-start-
imadmin.sh).
• • • • • •
Note: JAVA_HOME and DISPLAY environment variables need to be set.
2 Navigate to the OpenSpiritComponents component on the OpenSpirit tab.

3 Enter the values for the OpenSpirit host, NIS server name, port, and the
OpenSpirit server administrator username and password.
5 Connect and verify that the data appears under the OpenSpirit tree.
Define OpenSpirit There is no need to start the OpenSpirit user server as it is started automatically
User for ProSource when a user accesses OpenSpirit for the first time. Note that this will consume an
Server Account OpenSpirit license.
The OpenSpirit User Manager tool can be used to create OpenSpirit users. You can
use the runUserServer.sh script in the OSP_HOME/bin directory to start, stop,
and get the status of a user server, but it must be run from a user's account.

For information on how to create an OpenSpirit user, refer to the OpenSpirit User
Guide found at the OpenSpirit Web site. For your convenience, the procedure for
OpenSpirit 3.2.3 is described in this section.
Start OpenSpirit OpenSpirit users must manage their own user server since the user server is started
User Server for and stopped from the user’s Unix account. The following are possible ways users can
ProSource User manage their user server for access to OpenSpirit data in ProSource. This
information is not provided in the ProSource Online Help as the procedure may be
site-specific.
• OpenSpirit Launcher extension available and installed on the user's desktop
(Windows), or accessible from the user's Unix account (OpenSpirit master or
satellite installation). The OpenSpirit Launcher allows users to register or alias
themselves OpenSpirit users, and to start/stop their user servers.
• Use the runUserServer.sh script in the OpenSpirit Home directory to start and
stop the user server. Users must be logged into their Unix accounts to use these
scripts. Users must be registered as OpenSpirit users. The OpenSpirit
administrator can register users with the OpenSpirit user manager tool.
• OpenSpirit>UserServerStatus checks to see whether or not the user
server is running. If it is not, The OpenSpirit data accessor starts it.
If users started their user servers from within ProSource, the user is prompted to
stop the user server when exiting ProSource. This releases an OpenSpirit license
as well as any native datastore licenses used by OpenSpirit data servers started
on behalf of the user.
These options are implemented by the following ProSource plug-in applications:
• OpenSpiritEventLauncher
• OpenSpiritExit
By default, these plug-in applications (entitleables) are available only to users with
Administrator roles. Use the IM Administration Console to make these plug-in
applications available to users who do not have Administrator roles.
For example, create a new role (i.e., OpenSpiritUserServer), add these entitleables
to the role, and grant users access to the role, or simply add the entitleables to the
SIS_Public role.
Create OpenSpirit The following procedure can be used by the OpenSpirit administrator to create an
User OpenSpirit user.
Before you begin, ensure that the OpenSpirit server has been installed and is
running. For details on how to create a new user, refer to the OpenSpirit
Administrator documentation. For your convenience, the OpenSpirit 3.2.3 procedure
is described in this section.
 To create OpenSpirit user

1 Log in to the OpenSpirit server as an OpenSpirit administrator.
2 Invoke the command prompt and cd to the $osp_home/bin/.
3 Start the ospdesktop utility.

4 Click Tools>User Manager.

5 Create a new OpenSpirit user.
6 Exit the utility.
7 Relaunch the ospdesktop utility.
8 Click Tools>User Manager.
The user you created appears on the list.
OpenSpirit Data The following prerequisites are required before users can access data. These
Access prerequisites can be performed after installing ProSource, but must be in place
Prerequisites before the ProSource server is started.
1 Datastores (GeoFrame, OpenWorks 2003, Finder, etc.) with projects must be
configured with OpenSpirit.
2 Users must be registered with OpenSpirit.
3 Users must be granted access to their projects (GeoFrame 4.4 or 4.5 projects,
etc.).
4 The ProSource server will use the OpenSpirit manager account to access
OpenSpirit. The ProSource installer will prompt for this information.
5 The ProSource user must be a registered OpenSpirit user.
• • • • • •
Note: For more information on these pre-installation tasks, please refer to the
“OpenSpirit Integration” section in the “ProSource Installation Guide.”
6 When the ProSource user connects to an OpenSpirit datastore, ProSource

automatically starts an OpenSpirit executor (formerly known as the user server)
process for the specified OpenSpirit user. (The OpenSpirit user is the Unix
username entered into the ProSource database connection dialog.) The
executor process is started on Unix/Linux, if it is not already running.
• • • • • •
Note: ProSource cannot start a user’s OpenSpirit executor process on Windows
for access to Petra and Kingdom datastores. The user must start the
executor process on Windows using the OpenSpirit Launcher application
or the OpenSpirit executor.bat file.
• • • • • •
Note: The OpenSpirit executor starts OpenSpirit data servers on behalf of the
user. The executor process consumes an OpenSpirit runtime license. The
data servers started by the executor consume native datastore licenses.
The user’s executor process should be stopped when not in use to free
these licenses.

• • • • • •
Note: When ProSource has started an executor for the current ProSource user,
ProSource will prompt to stop the executor when the user exits ProSource.
You should answer “no” to this question if you plan to continue using other
OpenSpirit-enabled applications as that OpenSpirit user. Stopping the
executor will cause OpenSpirit to stop the executor process on both Unix/
Linux, and also the executor process on Windows, if running.
• • • • • •
Note: There is one executor process (on Unix/Linux and Windows) for each
OpenSpirit user.
Modify OpenSpirit Follow the steps below to connect to a new OpenSpirit server:
Parameters
1 Launch IM Administration Console in safe-start mode using the script
$PS_HOME/TomcatHome/webapps/imadmin/safe-start-imadmin.sh
• • • • • •
Note: JAVA_HOME and DISPLAY environment variables need to be set.
2 Navigate to the OpenSpiritComponents group on the OpenSpirit tab.

3 Enter proper values for OpenSpirit Server Host, OpenSpirit Server Port,
Username, Password and NIS Server Name.
• • • • • •
Note: The Username should be that of a valid OpenSpirit user. The password
should correspond to the user.
4 Update the file $PS_HOME\local\conf\prosource-server.conf with

the location where OpenSpirit satellite installation is present.
5 Configure the database properly in the OpenSpirit satellite client with correct
admin password and project passwords for various projects.
6 Update the database url in the ProSource Admin>Database tree node as
specified in the OpenSpirit client. The database url is case sensitive.
7 Restart both the Tomcat and ProSource servers.

9 ProSource Seabed Integration
In This Chapter
Data Selection Rules Utility.......................................................................... 9-2

DSR Categories .................................................................................... 9-2
Administrator Role ................................................................................ 9-2
Understanding the DSR Utility ............................................................... 9-2
Using the DSR Utility UI ........................................................................ 9-3
Using the DSR Utility Command Line.....................................................9-11
Creating Chase Rules ...........................................................................9-13
Managing Files ..........................................................................................9-17
Managing Seabed Databases and Projects...................................................9-18
ProSource Seabed Integration 9-1

Data Selection Rules Utility

The Data Selection Rules (DSR) utility is used to construct data selection rules, also
called chase rule, required by the Data Copy/Update (DCU) utility and hierarchical
entitlements.
The DSR utility allows you to:
• Load chase rules provided in an ASCII file.
• Analyze the loaded chase rules.
• Delete chase rules.
For additional information, see “Creating Chase Rules” on page 9-13.
DSR Categories The Data Selection Rules are categorized using the namespace column (also called
as category in DSR Utility User Interface), as follows:
• Data Copy/Update - these types of rules can be used by Data/Copy Update only
• Entitlements - these types of rules can be used by hierarchical entitlements only
• Default - these types of rules can be used by Data/Copy Update as well as
hierarchical entitlements
• Empty Namespace - these type of rules can also be used by both Data Copy/
Update and hierarchical entitlements
Administrator Role Only users that have been assigned Administrator role can use the DSR utility. The
following error message displays if a user tries to use the DSR utility without the
correct administrator privileges:
Admin privileges required to perform the task: please contact your system
administrator
• • • • • •
Note: This error message displays only if the DSR Utility is accessed from the
ProSource Transfer Manager home page. For non-Administrator users, the
DSR utility will not be available from the ProSource client UI.
Understanding the Before using the DCU utility or hierarchical entitlements, you need to perform the
DSR Utility following tasks with the DSR utility:
1. Define chase rules
Chase rules define the data that is to be moved from the source project when you
run DCU. When you specify seed data (that is, a select list), the chase rules are used
to determine other related data to be transferred. In the context of hierarchical
entitlements, chase rules define an entitlement hierarchy which allows the
entitlements on an entity to be inherited by its related and/or child entities. The
chase rules are defined in the Seabed data dictionary, and only need to be defined
once. Multiple chase rules can be grouped into sets that are called workflows or data
selection rules.

2. Load/Analyze chase procedures

For each data selection rule, the chase rules must be loaded and then analyzed in
the data dictionary which contains the source projects for DCU and hierarchical
entitlements.
• • • • • •
Note: ProSource installation provides sample data selection rules that can be
accessed from the ProSource menu by selecting
Extensions>Utilities>Data Copy/Update>Sample Data Selection
Workflows. The files containing these rules are stored in $PS_HOME/
TomcatHome/webapps/dtmgui/work/users/
DATA_COPY_UPDATE/dsr. Another copy of these files is stored in
$PS_HOME/ext_app/pse/Sample_DSR. The Site Administrator must
define and load their own data selection rules based on their
requirements.
Using the DSR This section provides instructions for using the DSR Utility.
Utility UI
 To use the DSR GUI utility

1 Login to the ProSource server.
2 Navigate to Extensions>Utilities>Data Selection Rules>Load/Analyze.
The Login window displays.

Fig. 9-1 Login window
3 Enter the following information:

• Database
• User Name
• Password
4 Click Proceed.
The Load/Analyze window displays.

Fig. 9-2 Data Selection Rules Utility - Load/Analyze
5 Specify the following information:

• From File - Select an existing uploaded file or upload a new file containing
the rules that need to be loaded. Sample DSR files are loaded during
installation and can be chosen from this drop-down menu.
• To Data Dictionary - choose the data dictionary from the drop-down menu.
• Data Selection Rule - type a name for the data selection rule. The rule name
should be unique. If the rule name already exists in the data dictionary, the
following error message displays:
Data Selection rule <data selection rule name> already exists in Data
Dictionary <data dictionary name>. Please provide a different name for Data
Selection Rule
• Category - choose a category from the drop-down menu. Categories include
Default, Data Copy/Update, and Entitlements.
6 If the rules file to be loaded is not available in the system, you must upload the
file to the ProSource server. To upload a file, do the following:
a. Click Upload File next to From File drop-down list. The File Upload
window opens.
b. Click Browse to select the file to be uploaded.

c. Check Make this file visible to all (public) if you want others to be able
to see the file on the server. Leave the box unchecked if you want the file to
be private.
d. Check Overwrite the file if it exists already if you want the file that
you are uploading to replace the file on the server. If you do not want to
replace the file on the server, leave the box unchecked.
• • • • • •
Note: If this file already exists on the server and you leave this box unchecked,
you will receive an error message.
e. After specifying the file, click Upload This File. The file is uploaded and
control returns to the Load/Analyze page with the uploaded file appearing in
the From File drop-down list.
7 Click Proceed. The Transfer Options window displays.
Fig. 9-3 Transfer Options window
8 Confirm or change the following parameters:

a. (Optional) Enter user comments relative to the this job. This provides you a
way to identify these jobs later when you view the Completed Jobs.
b. (Optional) Select the e-mail check box and enter an e-mail address to send
an e-mail upon completion of the job.
9 Click one of the following options:
• Run this transfer now - The process will begin and the execution progress log
will display in the Task Monitoring window.
To track the status of job refer to “Monitor, Validate, and Merge Loader Jobs”
section in ProSource Enterprise UserGuide.
Fig. 9-4 Task Monitoring Page window
• Run this transfer later - clicking this option displays the Transfer
Scheduling Selection Page window that allows you to specify a time for
the transfer.
• On the I want this transfer to run <day> at <time> line, set the
day and time that you want the loading job to run.
• If you want to set up a recurring batch job for this transfer, check the box
on the In addition, I also want this transfer to be set up as a
recurring task (batch job), every <interval> <unit> from the
first run line and set the batch interval and unit.

Fig. 9-5 Transfer Scheduling Selection Page window
• Click Complete Setup.
 To delete DSRs
1 Login to the ProSource server
2 Navigate to Extensions>Utilities> Data Selection Rules>Delete. The
Login window displays.

Fig. 9-6 Login window
3 Enter the following information:

• Database
• User Name
• Password
4 Click Proceed. The Delete window displays.

Fig. 9-7 Delete window
5 Specify the following information:

• From Data Dictionary - choose the data dictionary where the rule is located,
from the drop-down menu.
• Select Data Selection Rule - choose the rule to be deleted from the drop-
down menu.
• Click Proceed. The Transfer Options window displays.
6 Confirm or change the following parameters:
a. (Optional) Enter user comments relative to the this job. This provides you a
way to identify these jobs later when you view the Completed Jobs.
b. (Optional) Select the e-mail check box and enter an e-mail address to send
an e-mail upon completion of the job.
7 Click one of the following options:
• Run this transfer now - The process will begin and the execution progress log
will display in the Task Monitoring window.
To track the status of job refer to “Monitor, Validate, and Merge Loader Jobs”
section in ProSource Enterprise UserGuide.
• Run this transfer later - clicking this option displays the Transfer
Scheduling Selection Page window that allows you to specify a time for
the transfer.

• On the I want this transfer to run <day> at <time> line, set the
day and time that you want the loading job to run.
• If you want to set up a recurring batch job for this transfer, check the box
on the In addition, I also want this transfer to be set up as a
recurring task (batch job), every <interval> <unit> from the
first run line and set the batch interval and unit.
• Click Complete Setup.
Using the DSR The DSR utility is also provided as a command line utility.
Utility Command
Line
 To use the DSR utility from a command line

1 Login to the ProSource server.
2 At the command prompt, go to the $SDS_HOME directory:
cd $PS_HOME/ext_app/psx/Seabed_Utilities <Enter>
3 Set the $SDS_HOME environment variable to:
setenv SDS_HOME $PS_HOME/ext_app/psx/Seabed_Utilities
<Enter>
4 Source the correct environment:
source sdt_env.csh <Enter>
5 Go to the bin directory:
cd bin <Enter>
6 Display the usage of the DSR utility:
./dsr_util <Enter>
You will see a result similar to this:
{cdc2}431: ./dsr_util
USAGE:
[-host host] [-port port] [-inst inst] [-db Oracle|sqlserver] 
[-user username] [-password password] {-delete true|false} 
[-ld true|false] [-analyze true|false] [-all true|false]
where:
-host - Host machine name where the instance resides.
Should be specified for all the options if any one is "true".
-port - The oracle port number. Should be specified for all
the options if any one is "true".
-inst - Name of the oracle instance. Should be specified
for all the options if any one is "true".
-db - Database type (Oracle or Sql Server). Should be
specified for all the options if any one is "true".

-user - Seabed admin username. Should be specified.

For example, "SIS_ADMIN" for Oracle and "sa" for SQL Server.
-password - Seabed admin password. Should be specified.
-delete - A standalone option for deleting workflow. If
specified as "true", all the procedures in a project related
to the workflow will be dropped. Default value is "false".If
true, specify the following parameters along with the option:
-ddu ddname - The DD name
-wf workflow - Workflow to be deleted.
-ld - Should be specified as "true" if chase rule is to
be loaded, default value is "false". If true, specify the
following parameters along with the option:
-lr loadRule - Chase rule file to be loaded
-analyze - Should be specified as "true" if analyze procedure
is to be executed, default value is "false". If true specify
the following parameters along with the option:
-wf workflow - Workflow or DSR name to be specified when
analyze procedure is to be executed, default value is
"Default"
-ns namespace - Namespace for the specified workflow,
default is "Default"
-all - If true, all the parameters should be specified and all
options will be executed. Default is "false". If the previous
two options are all specified as "true", this option need not
be specified.
You can perform the following tasks using the DSR utility. These tasks must be
performed in the same order as presented, but can each be run independently or all
in one pass.
1 Load data selection rules into Seabed
2 Analyze data selection rules
To load data selection rules into Seabed

To load the data selection rules, modify the utility’s parameters with special notice of
those bolded:
${SDS_HOME}/bin/dsr_util [-host host] [-port port] [-inst
inst] 
[-db Oracle|sqlserver] [-user username] [-password password] 
[-ld true|false] -ddu [Seabed Dictionary Name] -lr [Path to
Chase Rule file]
For example:
${SDS_HOME}/bin/dsr_util -host cdc2 -port 1521 -inst cdc2psx5 
-db Oracle -user sis_admin -password sis_admin -ld true 
-ddu dd_cdc2psx5 -lr ./data/sample_dsr_borehole.txt

To analyze data selection rules

To analyze the data selection rules, modify the utility’s parameters with special
notice of those bolded:
inst] 
[-analyze true|false] -ddu [Seabed Dictionary Name] -wf
[Workflow or DSR Name] -ns [namespace: The valid values are
"Data Copy/Update", "Entitlements" and "Default"]
For example:
-db Oracle -user sis_admin -password sis_admin -analyze true 
-ddu dd_cdc2psx5 -wf borehole_wf -ns Entitlements
To load/analyze in one pass
To perform Load/Analyze in one pass, modify the utility’s parameters with special
notice of those bolded:
${SDS_HOME}/bin/dsr_util[-host host] [-port port] [-inst inst]
[-all true|false] -lr [Path to Chase Rule file] -ddu [Seabed
Dictionary Name]-wf [Workflow Name] -ns [namespace: The valid
values are "Data Copy/Update", "Entitlements" and "Default"]
For example:
-db Oracle -user sis_admin -password sis_admin -all true 
-lr ./data/sample_dsr_checkshot_survey.txt -ddu dd_cdc2psx5 
-wf checkshot_all -ns Entitlements
Each DSR needs to be loaded/analyzed only once in each data dictionary.
To delete data selection rules
To delete data selection rules, modify the utility’s parameters with special notice of
those bolded:
inst] 
[-delete true|false] -ddu [Seabed Dictionary Name] -wf
[Workflow Name]
For example:
-db Oracle -user sis_admin -password sis_admin -delete true 
-ddu dd_cdc2psx5 -wf checkshot_all
Creating Chase Use the following section to create chase rules

Rules
Chase rules define the data that is to be moved from the source project when you
invoke Data Copy/Update. When you specify seed data (that is, a select list), the
chase rules are used to determine any other related data that needs to be
transferred.

A simple chase rule consists of an Entity, Direction, and Link in the form of Entity >
Link or Entity < Link:
Entity: An entity is the representation in a data model of a distinguishable business 
concept (such as a person, object, or event). For example, the ‘Well’ entity is a
logical container for data about physical wells. Entities most often translate to
physical tables from where the data is to be moved.
Direction: Direction specifies whether the link should be followed from the entity in
the forward direction (child entity to parent entity), or to the entity in the backward
direction (parent entity to child entity).
Link: A link is a relationship between two entities and is usually implemented as
foreign key constraints in the database. Each link has a name that identifies the link,
and is a relationship between an entity (the child entity) and its parent entity (also
referred to as the domain of the link).
For example, the entity ‘Well’ has a link called ‘Field’, which is the relationship
between Well and Field (that is, the field in which the well is located). The actual
domain of a link is specified by the data model.
As another example,Conv_Core_Acquisition.Borehole link refers to the parent
entity Borehole, but the Conv_Core_Acquisition.Core_Bit_Used link refers to
Core_Bit. Therefore, links in chase rules identify the parent entity where related
data is located.
The following illustrates these attributes:
Well < Field
Borehole < Well
…
The first token ‘Well’ specifies the Entity. The second token ‘<’ specifies a one
character Direction: ‘<’ or ‘>’. The third and final token ‘Field’ specifies the Link (and
indirectly the parent entity Field). Often, the name of the link is the same as the
domain or parent entity in the link.
Therefore, the assertion “given a well record, get the field that the well belongs to”
is specified using the rule: Well > Field and the assertion “given a field record, get
all wells that are in that field” is specified using the rule: Well < Field.
Details of entity names, link names, and the parent entity that a link refers to can be
found in the Seabed Data Model Web Report. Select an entity to get details of that
entity. The “Refers To” section lists all the links (relationships) from that entity to
parent entities. The “Referenced By” section lists all links (relationships) where the
selected entity is the parent.
Including all instances A workflow may require all instances of a given entity be selected. This is indicated
of an entity in the specification file by appending a plus (+) sign to the name of the entity, as
illustrated below:
Activity_Template +
Company +
Coordinate_System +
…
Specifying when all instances of an entity type should be included allows improved
efficiency in the chasing procedures, because there is no need to execute a
conditional rule.

Ignoring an entity type The Seabed data model allows abstract references. For example, the link
Activity_Entity_Invl.Involved_Entity refers to Entity, so the parent could be
one of a number of Seabed entities. The chasing engine in this case will attempt to
chase from Activity_Entity_Invl to entities that may not be required in a given
workflow. To avoid this, specify the types of entities that can be safely ignored
during chasing.
An entity to be ignored during chasing is indicated in the specification file by
appending a minus (-) sign to the name of the entity, as illustrated below:
Acquisition_2D -
Acquisition_3D -
Act_Tmpl_BA_Role -
…
Narrowing Narrowing can also be used to reduce the scope of a rule in case of abstract links.
When using the same example as before:
Activity_Entity_Invl > Involved_Entity
The parent entity in this rule is Entity because the Involved_Entity is an abstract link
to Entity To use this rule to chase to specific entities (and not all entities that are a
specialization of Entity), narrowing can be specified as follows:
Activity_Entity_Invl > Involved_Entity=Well
This rule reduces the scope from Entity to Well, that is, we want the rule to pick only
related well records.
Examples The following examples further highlight the chase rule mechanism:
“Given a set of wells, I wish to transfer all associated deviation surveys.”
This involves finding the relationship path between wells and deviation surveys,
because wells are not directly related to deviation surveys. The Well entity is related
to the Borehole entity, which in turn is related to Deviation_Surveys. The link
names for these relationships can be obtained from the Seabed Data Model Web
Report. Therefore, the chase rules would be:
Borehole < Well (given a well, select all its boreholes)
Deviation_Survey < Borehole (given a borehole, select all deviation surveys
associated with the borehole)
Deviation_Survey has a mandatory relationship to Coordinate_System, which
should be included to transfer data successfully. To specify this, include the following
chase rule:
Deviation_Survey > Coordinate_System
• “Given a set of wells, I wish to transfer ALL other associated data.”
This involves finding all entities related to the Well entity. To include entities that are
details of the well, refer to the “Referenced By” section in the Seabed Data Model
Web Report for the Well entity. This section lists all the links from well to child
entities.
The following chase rules (one for each child entity) can be used to get a well's
associated child records:
Activity_Facility_Invl < Site_Well
Activity_Program < Well
Borehole < Well

DWSAP_Factor_Set < Well

Facility_Composition < Part_Well
Field < Discovery_Well
Obligation_Component < Well
Production_Entity < Well
Study_Well < Well
Water_Demand_Rgn_Facility < Well
Well_AFE < Well
Well_BA_Involvement < Well
Well_Comm_Interface_X < Well
Wellhead_Protection_Area < Well
Relationships from the Well entity to its parent entities can be found in the “Refers
To” section in the Seabed Data Model Web Report for the Well entity.
The following relationships exist: Address, Drill_Slot, Field,
Permanent_Coord_System, Surface_Location, and Well_Structure. The
chase rules to include these would be:
Well > Address 
(include the Address record that represents the physical address of the well)
Well > Drill_Slot 
(include the drill slot through which the well was drilled)
Well > Field 
(include the Field in which the well is located)
Well > Permanent_Coord_System 
(include the Coordinate System record that is the permanent coordinate system for
the well)
Well > Surface_Location 
(include the Position record that represents the well's surface location)
Well > Well_Structure 
(include the well's wellsite structure)
Note that additional chase rules may be required. If entities included in the above
chase rules have mandatory relationships, or relationships that are required for
merge, additional chase rules may be required to include those relationships.

Managing Files
Managing Files
The Manage Files feature is used to manage the control, data, and select list files
that are uploaded/generated on the ProSource server by Loader, Exporter, Data
Copy/Update, DSR utility, and Data Transfer operations. For more information about
the Manage Files workflow, see the “Manage Files” section in the ProSource Online
Help.
Administrators (users assigned to the dtmgui_admin role) can use the Manage
Files workflow to manage their own files, as well as those of other users, including
the public files.
• • • • • •
Note: The delete action removes the files from the ProSource server, and the
files cannot be recovered after they have been deleted. Should recovery
be needed, the administrator can make regular back-ups of the
$PS_HOME/TomcatHome/webapps/dtmgui/work/users
directory.

Managing Seabed Databases and Projects
Managing Seabed Databases and Projects

To know about creating/configuring projects and dictionaries, refer to the section
“Managing Seabed Databases and Projects” in IM Administration Console Online
Help.
For information on extending the Seabed data model, refer to “Extending the
Seabed Data Model” in Seabed Extensibility Guide.

10 Troubleshooting
In This Chapter
ProSource Troubleshooting.........................................................................10-2
ProSource Enterprise License Issue.......................................................10-6
IM Administration Console Troubleshooting .................................................10-8
General Issues ....................................................................................10-8
Startup Issues ................................................................................... 10-10
Tomcat Server Startup Issues ............................................................. 10-12
LDAP Issues...................................................................................... 10-12
Unable to extract data from files stored in ProSource Logs workflows.......... 10-14
Troubleshooting 10-1

ProSource Troubleshooting
This section explains how to fix the following issues that you may encounter in the
server management or use of ProSource:
• “Terminating Subserver Processes” on page 10-2
• “OpenSpirit Post-installation Checks” on page 10-2
• “OpenSpirit user server fails to start from OpenSpirit client on Windows XP” on
page 10-3
• “Cannot use Oracle strings when creating links using the SQLExpressionHandler”
on page 10-3
• “RMIREGISTRY Client/Server Communication Failing” on page 10-3
• “Hanging Process or Low Memory” on page 10-3
• “Cannot See GeoFrame or OpenWorks Projects” on page 10-4
• “Cannot Add a North Arrow in Layout View” on page 10-4
• “Slow Rendering Performance in GisView” on page 10-4
• “Receiving Datum Shift Errors” on page 10-5
• “Issues while restarting ProSource Server from ProSource UI” on page 10-5
• “ProSource Server Fails to Start on a Linux Machine With Several CPUs” on page
10-5
• “Transformation NAD_1927_CGQ77_ to_WGS_1984_3 fails when using
Coordinate System Manager” on page 10-5”
• “Using com.slb.im.federator.server.dataaccess.sql.Reader accessor &IN SQL
operator in complex/abstract views does not work” on page 10-6
 Terminating Subserver Processes

ProSource has a mechanism to terminate the subserver processes in case their
communication with the server breaks. This is controlled through the following
parameters:
• Subserver Tick Interval - The server sends a tick to the subserver every
'Subserver Tick Interval' seconds.
• Subserver Tick Timeout - If the subserver doesn't receive another tick for
'Subserver Tick Timeout' seconds, it terminates.
• Subserver Connection Timeout - The subserver connection times out in
'Subserver Connection Timeout' seconds, if no interaction occurs.
These parameters are in the “FederatorConfigurationManagement” component and
can be configured using the IM Administration Console safe-start mode.
• • • • • •
Note: The ProSource server must be restarted for the changes to take effect.
 OpenSpirit Post-installation Checks

Once OpenSpirit server has been installed and configured with datastores, it may be
helpful to perform the following checks:

1 Check whether OpenSpirit server is running. You may do this by executing

`$osp_home/bin/runOSServices.sh status'.
2 Check whether your version of the Operating System is valid for access to a
particular datastore. This information is stored in the $osp_home/bin/etc/
common_funcs.sh file.
3 Check the datastore project access rights for users accessing data.
4 Launch the OpenSpirit client Data Selector tool and confirm that you can access
the project data for a configured datastore (the user server must be running for
this). If you can access data, then the datastore has been properly configured
with OpenSpirit.
 OpenSpirit user server fails to start from OpenSpirit client on Windows

XP
It has been observed that on Windows XP, in order to enable OpenSpirit client to
communicate with the OpenSpirit server and start the user server, java.exe and
javaw.exe processes may have to be added to the exception list of the Windows XP
firewall. For more information, refer to the OpenSpirit documentation or contact
OpenSpirit Support.
 Cannot use Oracle strings when creating links using the

SQLExpressionHandler
When you create links that use the SqlExpressionHandler, you cannot include Oracle
strings in the definition. In the following examples, ViewLoader displays a syntax
error when single quotes or double quotations are used around the expression.
ATTR_EXPR: 'line_name' '='
'substr('\${topo_line_name}',instr('\${topo_line_name}','@')+
1)' SqlExpressionHandler;
ATTR_EXPR: 'line_name' '='
"substr('\${topo_line_name}',instr('\${topo_line_name}','@')+
1)" SqlExpressionHandler;
Solution
To create links that contain Oracle strings using the SQLExpressionHandler, you must
first load the expression without any quotes, then use SQL to update the expression
in the data dictionary.
 RMIREGISTRY Client/Server Communication Failing

The RMIREGISTRY seems to use the “hostname” to determine the IP address sent
to the client for communication with the server. In certain scenarios, the reported
name is not enough for the client to continue communication with the server.
Solution
Verify the server settings for the “hostname” and update (add) the following to the
file “local/conf/wrapper.conf ”:
wrapper.java.additional.5=-Djava.rmi.server.hostname=
 Hanging Process or Low Memory

If a process seems to be hanging or is becoming memory intensive, you can use the
following commands to check on the memory status:

• ps -ef - or ps -ef | grep java—to get a more focused list.

• pstree (Linux)—Gives an overview of how processes are related, either grep for
java, provide the key server process pids or provide the whole thing.
• top -b -n 10 (Linux)—Provides a sorted overview of resource usage for the
processes.
 Cannot See GeoFrame or OpenWorks Projects

After entering credentials, you may not see a listing of GeoFrame or OpenWorks
projects via the drop-down icon.
Solution
After entering your credentials, click Get List. ProSource authenticates the users
against the Oracle server to retrieve the list of projects to which you have access.
Once the project list is retrieved, select the project using the drop-down icon. This
project list is available for that ProSource session, but future ProSource sessions will
require a new search.
 Cannot Add a North Arrow in Layout View
In order to use the Layout View “Add North Arrow” functionality, you first need to
install the north arrow font from Esri on the machine on which you are running the
ProSource client.
This font file esri_40.ttf can be found in $PS_HOME/install/
client_resources.zip. If you are running the ProSource client on Windows, extract
the font file esri_40.ttf from the zip and copy them to the Control Panel>Fonts
folder.
 Slow Rendering Performance in GisView

You may get better GisView rendering performance by installing the optional native
libraries used by Esri MapObjects.
To install the Esri libraries:
1 Extract the files in $PS_HOME/install/client_resources.zip.
2 From the extracted files, there is a /lib directory. If you are running the
ProSource client on Windows, either add the /lib directory to your PATH
environment variable path or copy the files in /lib to an existing directory in
your PATH environment variable:
a. On your desktop, right-click My Computer and select Properties.
b. The System Properties dialog box appears.
c. Select the Advanced tab and click Environment Variables.
d. In the System Variables section, select the Path variable.
e. Click Edit to view all of the configured paths.
f. Either add the /lib directory to the Variable Value or copy the /lib directory
contents to a configured path.
g. If you added the /lib directory, restart your computer for the changes to
take effect.

 Receiving Datum Shift Errors

When the coordinate system of a project in Finder, GeoFrame, OpenWorks, or any
federated repository is based on a specific datum that does not have a datum shift
defined in ProSource, the system returns messages such as “Could not determine
which datum shift function to use when converting from 'Unknown - Clarke 1880' to
'GEODETIC-CL80__CL80' in the dictionary. Check your dictionary configuration (the
datum_shifts table) for a datum shift definition to WGS84.”
These errors signify that you need to add the datum shift for that coordinate
system. For specific instructions on adding datum shifts, refer to “Create Custom
Datum and Spheroids” on page 6-36.
 Issues while restarting ProSource Server from ProSource UI

If you observe the error message "ERROR - PATH: Undefined variable"
when you restart the ProSource Server from ProSource client UI, then restart the
ProSource server again from the ProSource server machine.
 ProSource Server Fails to Start on a Linux Machine With Several CPUs

The ProSource server does not start and the following java error is generated in the
server log:
An unexpected error has been detected by HotSpot Virtual
Machine:
SIGSEGV (0xb) at pc=0xb6f2f108, pid=10101, tid=2374081456
Java VM: Java HotSpot(TM) Server VM (1.5.0.06-b07 mixed
mode)
Problematic frame:
V [libjvm.so+0x426108]
Solution
Increase the java heap size used by the ProSource server Java Virtual Machine
(JVM).
Edit the $PS_HOME/conf/wrapper.conf file and increase the
wrapper.java.maxmemory setting by 128 MB then try to start the ProSource
server again. Example:
# Maximum Java Heap Size (in MB)
wrapper.java.maxmemory=512
If the server does not start normally, try adding more memory until the problem is
remedied.
 Transformation NAD_1927_CGQ77_ to_WGS_1984_3 fails when using

Coordinate System Manager
An error message “Failed to convert the point: Can’t find bundle
for base name PeHome, locale en_US and java exception was
present in the server log” is displayed, when you try to transform
NAD_1927_CGQ77_to_WGS_1984_3 using Carto Calculator for the following data:
• Coordinate system source: GCS_WGS_1984: 4326
• Coordinate system target: GCS_NAD_1927: 4609
• Transformation Method: NAD_1927_CGQ77_to_WGS_1984_3:1691

Solution
The Transformation NAD_1927_CGQ77_to_WGS_1984_3 (code 1691) is a grid file
transformation. It is based on the Canada-Quebec grid file CGQ77-98.gsb and is not
included with the software out-of-box. The appropriate agency must be contacted to
purchase the required GSB (Golden Software Boundary) files prior to using these
transformations. Once purchased, install at
$PS_HOME\local\conf\pedata\ntv2. Create a folder with the country name in
lower case letters and install the file in the folder of that country. Declare an
environment variable PEDATAHOME, which will point to the
$PS_HOME\local\conf\pedata folder.
Refer to the following link from Esri for more information:
http://support.esri.com/
index.cfm?fa=knowledgebase.techarticles.articleShow&d=18317
 Using com.slb.im.federator.server.dataaccess.sql.Reader accessor &IN

SQL operator in complex/abstract views does not work
When using the com.slb.im.federator.server.dataaccess.sql.Reader
processor the IN clause fails to create the appropriate clause in the generated SQL
command.
Similarly, using the
com.slb.im.federator.server.dataaccess.ReadAccessorImpl
processor, the IN clause works and this particular processor cannot be used to
create outer joins.
You cannot create a topic that have outer joins and have an IN clause in the
constraints list.
ProSource After changing the license server, the applications continue to check out licenses
Enterprise License from the old server.
Issue
FlexNet caches the previously used LM_LICENSE_FILE values in the registry on
your PC and in the .flexmrc file on the Unix/Linux machines.
 Solution to the Check-out Issue:

If you are running Windows, follow this procedure:
• • • • • •
Note: It is advisable to backup the registry before making any changes to it.
Verify that the FLEXlm registry contains an entry that matches the
LM_LICENSE_FILE value. For instance, on Windows XP using regedit:
1 Click Start, then click Run.
2 Type regedit, and click OK.
3 In the HKEY_LOCAL_MACHINE on the My Computer Tree view, double-click 
SOFTWARE and then double-click FLEXlm License Manager.
If there is no entry for FLEXlm License Manager, or if the correct value is found,
you do not need to add anything.

If the value shown in the data view does not contain the correct license server 
information, double-click the string that is displayed. This will open the String 
Editor. In the String Editor, enter the value so that it is consistent with the
LM_LICENSE_FILE environment variable.
 If You are Using a Unix or Linux Machine:

1 Go to the home directory of the OS user that started the ProSource server.
2 Open the .flexlmrc file and check the license setting.
3 If the license setting is incorrect, delete the .flexlmrc file.
Issues related to Data Copy/Update, DSR and Manage FilesIssue:

After a long interruption, the browser session times out while a user is on one of the
Data Copy/Update or DSR Utility parameter pages.
 To increase the browser session timeout:

1 Open the $PS_HOME/TomcatHome/webapps/dtmgui/WEB-INF/
web.xml file.
2 Change the session-timeout property. The value is expressed in minutes, for 
example, the default could be 60 or 90 minutes.
3 Save and close.
4 Restart the Tomcat server.
Issue: Data Copy/Update, DSR utility, or Manage Files User Interface fails to start
from the ProSource menu.
 Solution is to use Java Application V1.6 Regardless of the Java Plug-in Version:
1 Close the browser.
2 Select Start>Settings>Control Panel>Java from your Windows menu.
The Java Control Panel dialog appears.
3 Click the Java tab and click View under Java Application Runtime Settings.
The JNLP Runtime Settings dialog opens.
4 In the available list of JREs on the User tab, select the JRE that has the version
required for this release and clear all other versions.
5 Click OK and close the application.
6 Restart the browser and the ProSource client.

IM Administration Console Troubleshooting

This section explains how to fix issues that you may encounter in the connection and 
administration of the IM Administration Console.
General Issues When using the IM Administration Console, you may encounter the following issues:
• “All ProSource Users are granted read access to all objects by default” on page
10-8
• “The IM Administration Console session times out” on page 10-8
• “Cannot log in after session time out” on page 10-8
• “Accessible objects for DecisionPoint or ProSource do not display” on page 10-9
• “After installation of DecisionPoint or ProSource, the data sources do not display
in the IM Administration Console” on page 10-9
• “Server logs do not display” on page 10-9
• “Data source connection not visible” on page 10-10
 All ProSource Users are granted read access to all objects by default
All users are assigned to the sis_public role by default. Within ProSource, the
sis_public role is granted Read access to all objects (or all tree nodes).
Solution
To restrict a user's access to all objects, you must remove objects to which you wish
to restrict access from the sis_public role. You cannot remove the sis_public role
from a user.
 The IM Administration Console session times out

After you have logged in to and used the IM Administration Console, you receive an
error message that the session has timed out and you will have to log in again.
Solution
By default, the RMI session timeout is set to 60 minutes. This session timeout only
applies to certain components on the server (Tahiti Services). Therefore, if you are
using functions that do not use these services, your session will not be updated and
may time out.
You may also receive a timeout error if the Tomcat server is restarted while you are
using the IM Administration Console.
In either situation, you must log in again to resume your work.
 Cannot log in after session time out

When a session has timed out, you are prompted to log in again, but you are unable
to log in with the correct username and password.
Solution
This situation normally happens when you leave the IM Administration Console open
for a long time, and your Tomcat server has been shut down, or a newer version of

the IM Administration Console is deployed. If this occurs, close the IM

Administration Console and launch it again. You should be able to log in.
This situation may also occur if your user account is removed from Administrator
role. Verify that your account is still assigned Administrator role.
 Accessible objects for DecisionPoint or ProSource do not display

After DecisionPoint or ProSource are deployed, the objects from these applications
do not display in the IM Administration Console.
Solution
This error may occur if DecisionPoint or ProSource is not deployed properly (for
example, the application is not registered properly in the Enterprise Repository
(Seabed)). Make sure that the DecisionPoint or ProSource application URL is
registered in the database. This URL is located in the
sis_catalog.component_param_ table.
 After installation of DecisionPoint or ProSource, the data sources do

not display in the IM Administration Console
Solution
The IM Administration Console retrieves data source types and data source
connections only from the Enterprise Repository (Seabed). If DecisionPoint or
ProSource data sources are not imported into the Enterprise Repository during
installation, these data sources will not be visible in the IM Administration Console.
In this case, you will need to create the data sources in the IM Administration
Console manually.
 Server logs do not display

When the Server Logs icon is selected, all the log files are empty.
Solution
By default, all the server logs are disabled to improve server performance.
To enable the server logs, go to the Tomcat server <tomcat_home>/webapps/
imadmin/WEB-INF/classes/logs directory, open the log configuration files, and
change the log level from FATAL to one of the following:
• ERROR: Logs server error messages
• WARN: Logs server warning messages, as well as error messages
• INFO: Logs normal server output, as well as warning and error messages
• DEBUG: Logs all levels of log messages.
• • • • • •
Note: The INFO and DEBUG log levels may significantly degrade the server
performance.
You will need to restart the Tomcat server for these changes to take effect.

 Data source connection not visible

When the IM Administration Console is installed with only DecisionPoint and data
source connections are created using the IM Administration Console, if ProSource is
installed later, the data source connection is not visible.
Solution
The Administrator will need to synchronize the data source connections to make
them available within both applications.
Click the Sync Connections icon within the Manage Data Source workflow to
synchronize the connections between both applications.
Startup Issues This section explains how to fix the following problems that you may encounter
when starting, or launching, the IM Administration Console:
• “Cannot launch the IM Administration Console from application (RMI port in use
error)” on page 10-10
• “IM Administration Console fails to launch (UNIX Port Error)” on page 10-10
• “The IM Administration Console fails to launch” on page 10-10
• “IM Administration Console client not downloaded properly” on page 10-11
• “Could not log in to the IM Administration Console” on page 10-11
 Cannot launch the IM Administration Console from application (RMI

port in use error)
When the Administrator launches the IM Administration Console from an application,
the IM Administration Console Fails to launch and triggers the “RMI Port in Use”
error.
Solution
Connect to the Seabed instance for your application. In the sis_catalog, change the
RMI port value in the COMPONENT_PARAM table to a different value.
 IM Administration Console fails to launch (UNIX Port Error)

The IM Administration Console may fail to launch if the Administrator entered the
wrong port value for the UNIX installation.
Solution
For a UNIX installation, make sure that the value of the port is greater than 1024.
Values lower than 1024 are reserved for use by the UNIX root.
 The IM Administration Console fails to launch

Solution
Display the Java Console to view the error message. To display the Java Console,
select Settings>Control Panel>Java and select the Advanced tab. Expand the
Java Console tree node, and select Show Java Console. Fix the error and try to
launch the IM Administration Console.

One problem that might occur is that your <JRE_HOME>/bin directory is not on the
PATH environment variable. Usually, this error occurs when you installed Oracle on
your machine. Oracle installer puts its own JRE in front of other JRE paths. Make
sure that the proper version of the JRE is shown before Oracle's JRE.
 IM Administration Console client not downloaded properly

The IM Administration Console is not downloaded properly when it is launched for
the first time.
Solution
When the IM Administration Console is launched for the first time, the latest IM
Administration Console will be downloaded to your local computer and executed
automatically.
The IM Administration Console cannot be downloaded properly if one of the
following errors exists:
• You do not have enough disk space under your home directory. — The IM
Administration Console requires about 15 MB disk space under your home
directory. Confirm that adequate disk space is available before launching the IM
• You do not have the read/write permission on your home directory. — Grant read/
write permissions to your home directory and try to download the IM
Administration Console again.
• The Tomcat server runs out of memory. — The Tomcat server JVM requires at
least 128 MB memory. Even if your server has adequate memory, it may be
running too many server applications, resulting in insufficient memory to run the
Tomcat JVM. If this error occurs, stop some of the server applications and make
sure there is enough memory to run the Tomcat JVM.
 Could not log in to the IM Administration Console

If you could not log in to the IM Administration Console, even though you entered
the correct username and password, one of the following error messages may be
displayed:
• Invalid username/password. Please try again.
• Not an administrator, permission denied.
• Connection to RMI server is refused. Please check that RMI registry is started
properly on the server.
Solution
• Invalid username/password. Please try again. — Make sure you entered the right
username and password. The password is case sensitive. Also make sure that
your password does not contain any special characters such as: ', ", /, or @.
These special characters are only used if your server is configured to authenticate
against an external authenticate source. If your password contains a special
character, change the password in the external authenticate source and log in
again.
• Not an administrator, permission denied. — Only Users that have been assigned
to the Administrator role can log in to the IM Administration Console. Make sure
you have been assigned to the Administrator role before you log in.

• Connection to RMI server is refused. — Confirm that the RMI registry has started
properly on the server. If the Tomcat server has not started up properly, or is still
starting, start up your Tomcat server or wait until your Tomcat server is started.
Tomcat Server This section explains how to fix the following problem that you may encounter when
Startup Issues starting the Tomcat Server:
“Tomcat server does not start up properly” on page 10-12
 Tomcat server does not start up properly

After the IM Administration Console is installed, the Tomcat server does not start up 
immediately.
Solution
To ensure that the Tomcat server starts up properly:
1 Check the messages logged on the console.
• Windows: Server Log messages are displayed directly in the IM
• Linux: Log files are stored in <tomcat_home>/logs/catalina.out.
2 Make sure that there are no Java exceptions and that the following message is
registered:
IMAdminServer RMI Location: <RMI Server:RMI Port/TahitiRMIEndPoint>
If this message does not display, the Tomcat server will not start up properly. In
this case, a detailed error message will also display in the log file.
3 Fix the errors displayed in the log file and restart the Tomcat server. The
following error messages may display:
• Server components are not configured properly: In this case, a Java
exception will be logged in the console indicating which component is not
configured properly. Start the IM Administration Console in safe-start mode,
fix the configuration for the component, and restart the Tomcat server.
• The Tomcat server cannot bind to the specified TCP ports: The Tomcat server
requires two ports: a startup port and a shutdown port. These two ports are
specified during the installation process.
• If the startup port is already in use, stop the application that uses this port,
or re-install the IM Administration Console and select a different port.
• If the shutdown port is in use, modify the configuration file server.xml under
<tomcat_home>/conf and change the shutdown port parameter to another
port that is not in use.
• The IM Administration Console Server could not bind to the specified RMI
registry server or port. Start the IM Administration Console in safe-start
mode, select the IM Admin tab, select RMIComponent, and change the port.
Restart Tomcat.
LDAP Issues This section explains how to fix the following issues that are associated with the use
of LDAP in conjunction with the IM Administration Console:

• “Error message received when retrieving users after installing IM Administration

Console” on page 10-13
• “GroupOfNames or GroupOfUniqueNames not supported in IM Administration
Console” on page 10-13
• “Unable to connect or bind to LDAP” on page 10-13
• “ProSource Server will not Start” on page 10-13
 Error message received when retrieving users after installing IM

Administration Console
If you receive an error message when trying to access Users after installation of the
IM Administration Console, it indicates that, during the installation process, the
location of the OpenLDAP directory was entered but the installation did not prompt
for the LDAP credentials for the OpenLDAP installation. Therefore, the proper LDAP
credentials were not entered in the Authentication Component Group.
Solution
If you receive an error retrieving Users after installation of the IM Administration
Console, ensure that the LDAP credentials in the Authentication component group
are correct. The Authentication Component group is accessed through the Manage
Servers workflow in safe-start mode.
 GroupOfNames or GroupOfUniqueNames not supported in IM

Administration Console
The IM Administration Console does not support the LDAP groupOfNames or
groupOfUniqueNames object class for authentication when the IM Administration
Console is accessed from DecisionPoint in a Plumtree environment.
Solution
Use caution when you configure Plumtree against the existing LDAP directory for the
IM Administration Console. When you set up User Base DN in the IM Administration
Console, make sure you include all the Users defined under the Group Base DN. If a
User exists outside the Group Base DN in LDAP, the IM Administration Console will
not authenticate and validate the User.
 Unable to connect or bind to LDAP

This error can occur if the complete domain name or IP address of the LDAP server
is not provided during installation (and both machines are not on the same sub net),
or if the LDAP configuration is changed through the Manage Server workflow in the
Authentication Component group window.
Solution
Access the Manage Server workflow in safe-start mode and update the
Authentication Component LDAP parameters to include the full domain name or IP
address of the LDAP directory.
 ProSource Server will not Start

Initialization failure of subsidiary components can prevent the ProSource server from 
starting. The ProSource server checks to see if a component server, such as
OpenSpirit, is running. If it is not running, the ProSource server is not able to
connect with it, the ProSource server does not start, and an alert message is
generated.

Solution
Confirm that proper start-up of the component server has occurred. When the
component server is running, restart the ProSource server.
Unable to extract This problem indicates that you may not have the service “ActiveMQ Daemon”
data from files running. This is a required process used by the ProSource server for internal
stored in ProSource communications and should not be shut down when the ProSource server is
Logs workflows running.
Solution
Restart the ProSource server and ensure that the service ActiveMQ Daemon is
running.

A ProSource Server Configuration
Parameters
Introduction The “$PS_HOME/local/conf/prosource-server.conf” file is no longer used

to configure ProSource parameters. Most parameters are now configured using the
IM Administration Console.
ProSource The parameters in Table A-1 are set in the config file as they are used as
Parameters environment variables by ProSource scripts.
Table A-1 ProSource Parameters Configured in the Configuration File
Parameter Description Syntax

JAVA_HOME Location of java JAVA_HOME=[path]
installation
LD_LIBRARY_PATH Location of shared $SUBSERVER_ROOT_DIR/lib
libraries. Default is
usually OK.
SERVERNAME Name of the server used SERVERNAME=[servername]
when registering with
the RMI registry
SERVER_ROOT_DIR Installation directory of SERVER_ROOT_DIR=[path]
server No trailing slash
SUBSERVER_ROOT_ DIR Installation directory of SUBSERVER_ROOT_DIR=
server, normally [path]
<prosource_home>,
except when running the
subserver on a different
machine
OSP_HOME Installation directory of OSP_HOME=[path]
OpenSpirit master
installation
ProSource Server Configuration Parameters A-1

The parameters in Table A-2 can now be configured using the IM Administration
Console.
Table A-2 ProSource Parameters Configured in the IM Administration
Console
Parameter Description Syntax

COLOCATED_MODE Set to TRUE to have [TRUE|FALSE]
ProSource run with the
server and client running
in one process.
FederatedService.Driver SQL driver Installation default, same
as dictionary, is OK.
FederatedService.Password Federated index Installation default, same
password as dictionary, is OK.
FederatedService.Url URL of the index service Installation default, same
as dictionary, is OK.
FederatedService.UserName User name of federated Installation default, same
index User as dictionary, is OK.
JAVA_HOME Location of java [path]
installation
LD_LIBRARY_PATH Location of shared $SUBSERVER_ROOT_DIR
libraries. Default is /lib
usually OK.
LoginManager Class to handle User [classname]
authentication. Options
for LDAP and Oracle
exist.
ORACLE_HOME Resets ORACLE_HOME. ""
Shouldn't need change.
PEOBJEDITHOME Path to User-defined $PS_HOME/local/conf
coordinate system
(persistent object
definitions with the SDE
Projection Engine).
PEDATAHOME Path to files necessary $PS_HOME/local/conf/
for grid-based pedata
geographic
transformations
ProSource Home-Directory Installation directory of [path]
server. No trailing slash.
Federator Sub-Server Home Installation directory of [path]
Directory server, normally
<prosource_home>,
except when running the
subserver on a different
machine.
A-2 ProSource Administration Guide

B Standard Scripts
You can find the scripts used by ProSource to set the environment and create the
connections for GeoFrame, OpenWorks, and SeisWorks subservers in the
$PS_HOME/scripts folder.
These scripts can be customized as the ProSource Administrator requires. When
troubleshooting, refer to these standard scripts.
Standard Scripts B-1

B-2 ProSource Administration Guide

PS AdminGuide

Uploaded by

Copyright:

Available Formats

PS AdminGuide

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

PS AdminGuide

Uploaded by

Copyright:

Available Formats

Version 2013

Schlumberger Private - Customer Use

Schlumberger Private - Customer Use

Schlumberger Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2

2 Overview of ProSource Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

Client Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2

3 Server Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Start/Stop the ProSource Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2

Schlumberger Private - Customer Use

4 Connection Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

5 User and Security Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

6 Customize ProSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

Customize the ProSource Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2

vi ProSource Administration Guide

Schlumberger Private - Customer Use

7 ProSource Topic Web Service Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1

Schlumberger Private - Customer Use

8 OpenSpirit Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1

Integrating OpenSpirit with ProSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2

9 ProSource Seabed Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1

Data Selection Rules Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2

viii ProSource Administration Guide

Schlumberger Private - Customer Use

ProSource Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2

Appendix A ProSource Server Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1

Appendix B Standard Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1

Schlumberger Private - Customer Use

Schlumberger Private - Customer Use

Schlumberger Product Documentation ......................................................... 1-2

Information Resources 1-1

Schlumberger Product Documentation

Document Last February 2015

Online Documentation is provided in the following electronic formats on the Schlumberger

• Adobe® Acrobat® PDF files

Typestyle The following conventions are observed throughout this guide:

1-2 ProSource Administration Guide

Schlumberger Private - Customer Use

Information Resources 1-3

1-4 ProSource Administration Guide

Schlumberger Private - Customer Use

Information Provides information on managing users and security, and

Information Resources 1-5

1-6 ProSource Administration Guide

Schlumberger Private - Customer Use

Client Interfaces ......................................................................................... 2-2

Overview of ProSource Components 2-1

Schlumberger Private - Customer Use

ProSource ProSource access technology allows information professionals to browse and

Access the IM Administration Console from the ProSource menu by selecting

2-2 ProSource Administration Guide

Schlumberger Private - Customer Use

Overview of ProSource Components 2-3

Schlumberger Private - Customer Use

2-4 ProSource Administration Guide

Schlumberger Private - Customer Use

Overview of ProSource Components 2-5

Schlumberger Private - Customer Use

2-6 ProSource Administration Guide

Schlumberger Private - Customer Use

Start/Stop the ProSource Server .................................................................. 3-2