Integrating with ProClaim
The Weave/ProClaim integration provides a two-way link between Weave and ProClaim. That is ProClaim can call out to Weave to display information and Weave can call out to ProClaim to display information.
For additional information about using the newer Weave Hub integration please see this page Weave Hub - Third-party Application Integration.
Client Workstation
The link between Weave and ProClaim requires the installation of components on each client computer that will be communicating between Weave and ProClaim.
The following sections outline the installation and configuration of these components.
The latest version of the ProClaim integration requires Weave Hub to be installed on the client PC, see this page for information on installing Weave Hub.
Once Weave Hub is installed on each client PC you need to install the ProClaim add-in for Weave Hub to add support for ProClaim to Weave Hub.
The Proclaim Weave Hub add-in is installed via a .msi file and only provides the option to change the installation directory, which defaults to C:\Program Files\Cohga\WeaveHub\Proclaim\
. The installer also creates some registry entries, to register the add-in with Weave Hub.
In addition to the Weave Hub add-in, the installer also installs and registers a COM object that can be used by Proclaim to communicate with Weave. The name of the COM object is WeaveHubProclaim.MapAutomation
and must be registered within Proclaim as the component to call when communicating with a GIS, which is outlined at the bottom of this page. Like the Pathway and Trim integrations, the COM object just sends messages to Weave Hub which will then forward them on to the browser.
Server
Configuration
Server
For Weave to communicate with ProClaim a number of parameters need to be specified, which can be set separately for different instances of ProClaim.
Firstly the proclaim namespace must be added to the config.xml file header (or a separate proclaim.xml file can be created and included into config.xml)
<?xml version="1.0" encoding="UTF-8"?> <config xmlns="urn:com.cohga.server.config#1.0" xmlns:proclaim="urn:com.cohga.proclaim#1.0"> ... </config>
then the proclaim configuration must be setup to provide the connection information required for ProClaim and to tell Weave what entities to allow the transfer for.
<?xml version="1.0" encoding="UTF-8"?> <config xmlns="urn:com.cohga.server.config#1.0" xmlns:proclaim="urn:com.cohga.proclaim#1.0"> <proclaim:config id="production"> <datasourcename>DSN</datasourcename> <server>Server</server> <database>Database</database> <username>Username</username> <password>ENCSEMPKCCSFQTJBFMPABFJEBZJAKFCXGME</password> <from>Weave</from> <to>ProClaim</to> <entity id="property"/> <entity id="street"/> </proclaim:config> </config>
In the above example the password has been encrypted using encrypt
osgi command.
Name | Description |
---|---|
datasourcename | The ODBC datasource (not an Weave data source) used to connect to the ProClaim database, possibly ‘ProClaim’ or ‘Protege’. |
server | The server that contains the ProClaim database, site specific machine name. |
database | The name of the ProClaim database, possibly ‘ProClaim’ or ‘Protege’. |
from | The ProClaim source application id, possibly 'Weave' or 'WEAVE'. |
to | The ProClaim destination application id. |
username | The username to connect to the database. |
password | The password to connect to the database. |
entity | Each entity tag is a link between Weave and ProClaim |
The 'entity' tags setup sources for data to send to ProClaim and targets for data sent from ProClaim.
When setting up a linkage in ProClaim to go from Weave to ProClaim the source entity should be set to the 'id' attribute of the entity tag.
When setting up a linkage in ProClaim to go from ProClaim to Weave the destination entity should be set to the 'id' attribute of the entity tag.
Client
Once the server has been configured the ProClaim action can be added to a toolbar in the client configuration. Note the change to "proclaim2" below, it was previously just "proclaim".
<item action="com.cohga.proclaim2.Send" version="production"/>
You need to include the version to let the Weave to ProClaim link know which connection config to use. The version should match the id of a proclaim:config
tag.
Filtering identifiers
If you need to filter the values before sending them to ProClaim, because ProClaim uses different identifiers for the entity than Weave does, then you can specify a filter when seting up the entities in the config details and add the definition for the filter. Note the addition of the new xmlns:filter="urn:com.cohga.selection.filter#1.0"
namespace.
<?xml version="1.0" encoding="UTF-8"?> <config xmlns="urn:com.cohga.server.config#1.0" xmlns:proclaim="urn:com.cohga.proclaim#1.0" xmlns:filter="urn:com.cohga.selection.filter#1.0"> <proclaim:config id="production"> <datasourcename>proclaim</datasourcename> <server>SQLSERVER2008\SQLEXPRESS</server> <database>ProProd</database> <username>proclaim</username> <password>ENCSEMPKCCSFQTJBFMPABFJEBZJAKFCXGME</password> <from>WEAVE</from> <to>CES</to> <entity id="property" filter="proclaim.production.property"/> <entity id="street"/> </proclaim:config> <filter:db id="proclaim.production.property"> <datasource>proclaim</datasource> <table>GEMS_LINK</table> <keycolumn>PID</keycolumn> <!-- column used in spatial database --> <idcolumn>PRUPI</idcolumn> <!-- column required for proclaim --> </filter:db> </config>
ProClaim
When registering the Weave application with ProClaim the Automation Component for Weave is WeaveHubProclaim
and the Automation Class is MapAutomation
.
There are two properties for the Weave application that should be set:
- AppWindowName
- The title of the browser window (matches the start of the actual window title) to locate a running Weave instance.
- URL
- The URL to start Weave if it is not already running, that is if an Internet Explorer window matching the AppWindowName isn't found
Only Direct Relation criteria type are currently supported.