Integration with 1Spatial Management Suite Worklist Service

In order to use the 1Edit Worklist page and integrate with the 1Spatial Management Suite (1SMS), 1Edit requires a configuration file defining the location of the 1SMS Worklist service.

If your administrator has bundled this file in the installation package then this does not need to be placed manually. You can check this by looking for a services.xml file in:

C:\Users\<current_username>\AppData\Local\Packages\1Spatial.1Edit_y9kp27q9aegam\LocalState\Config

     Note: You can also check by looking at the projects page to see if there is a Worklist button present; this button is only available when the services.xml file is in place.

     Note: 1SMS also requires a template file, Templates define the standard schema, styles, rules and topology setup. You must have created and deployed a template file in order to use the 1SMS worklist to download and open jobs.

Configuration file format

An .xml configuration file must be provided when connecting to 1SMS. and called services.xml, it must follow a specific structure. Examples of this structure can be found in the Example File Formatting section below.

ClosedExample File Formatting

When connecting to a secured 1SMS 2.3 environment you must include the version attribute and the <oauthserver> parameter (as in the example below):

     Note: When connecting to an unsecured 2.3 environment the <oauthserver> parameter can be omitted.

<services>

<SMSEnvironments>

<SMSEnvironment version="2.3">

<name>[NAME_EXAMPLE]</name>

<worklistroot>http://[server]:[port]/wf</worklistroot>

<oauthserver>http://[server]:[port]/1sms/mstoken</oauthserver>

</SMSEnvironment>

</SMSEnvironments>

</services>

When connecting to 3.0+ environment both the version and <oauthserver> parameter can be omitted:

<services>

<SMSEnvironments>

<SMSEnvironment>

<name>[LATEST NAME EXAMPLE]</name>

<worklistroot>http://[server]:[port]/1sms</worklistroot>

</SMSEnvironment>

</SMSEnvironments>

</services>

You can connect to multiple 1SMS environments by utilising the following structure:

<services>

<SMSEnvironments>

<SMSEnvironment version="2.3">

<name>[NAME_EXAMPLE]</name>

<worklistroot>http://[server]:[port]/wf</worklistroot>

<oauthserver>http://[server]:[port]/1sms/mstoken</oauthserver>

</SMSEnvironment>

<SMSEnvironment>

<name>[NAME_EXAMPLE2]</name>

<worklistroot>http://[server]:[port]1sms</worklistroot>

</SMSEnvironment>

</SMSEnvironments>

</services>

Distribution

To distribute this file automatically to all users and have it installed for all installations, it can be placed into the Config folder within the installation folder. When users install 1Edit, the config file will be automatically put in the right place.

     Note: If you update the Config or Template files after distribution, then the easiest way to distribute the new versions to all users is to replace the files within the 1Edit installation folder and distribute this folder to all users to re-install. 1Edit will not be updated if the version has not changed, but the new files will be deployed into the right location for each user.

Deploying the Config file

If the config file was not bundled with your installation, then it must be deployed.

  1. Launch 1Edit to create the correct folder structure.

  2. Drop the services.xml file into the following folder: C:\Users\<current_username>\AppData\Local\Packages\1Spatial.1Edit_y9kp27q9aegam\LocalState\Config

         Note: Ensure that ‘Hidden Items’ is checked in the Windows Explorer View tab, in order to see the AppData folder

  3. Restart 1Edit.