Skip to content

Commit

Permalink
Update ProviderTemplate readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jumpinjackie committed Feb 4, 2017
1 parent 69595ee commit fc4b08b
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions ProviderTemplate/readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ This tool was created for the following reasons:
2. It is redundant to keep and maintain the local provider source for each specific version of MapGuide.
3. Be able to have a tailor-made LocalNative provider for your specific version of MapGuide without having to wait for an official Maestro release.

This tool will only work for MapGuide Open Source 2.2 and newer.

How to use this tool?
---------------------

Expand All @@ -21,10 +23,8 @@ DO NOT ALTER THIS DIRECTORY STRUCTURE! The tool currently assumes this directory

Run the tool and fill in the following options

- The .net Framework 4.0 directory (the path to csc.exe)
- The MapGuide .net assemblies directory (the path to mapviewernet/bin of your MGOS/AIMS installation)
- The MapGuide version (x.y.z). This is used to name the final provider assembly
- Assembly type. Basically this tells us what we're referencing. Either the 5 OSGeo assemblies (2.2 and newer) or MapGuideDotNetApi.dll (2.1 and older)

Once you have filled in the required options, click build and wait a few moments. Assuming you extracted the Maestro SDK to C:\MaestroSDK:

Expand All @@ -34,12 +34,12 @@ Once you have filled in the required options, click build and wait a few moments
Copy the built provider assembly and the MapGuide assemblies under the aforementioned directories out to your application's directory. Edit the ConnectionProviders.xml file
and register this provider assembly. Your application can now create connections for this particular provider.

Please note that it is not currently possible to a MaestroAPI application to be able to create LocalNative connections of different
Please note that it is not currently possible to a MaestroAPI application to be able to create LocalNative connections of different
versions of MapGuide from within the same application session. For example, if you create a LocalNative connection with C:\foo\webconfig.ini
and then create a LocalNative connection with C:\bar\webconfig.ini, that connection and subsequent connections after will always be initialized
with settings from C:\foo\webconfig.ini

This is an uncommon use-case (actually more common with Maestro proper, due to its multi-connection support) since most of the time
This is an uncommon use-case (actually more common with Maestro proper, due to its multi-connection support) since most of the time
your application will most likely be working against a specific version of MapGuide, but it is something to keep in mind.

Testing your LocalNative provider
Expand All @@ -53,6 +53,6 @@ To test your LocalNative provider, do the following:
1. Build the LocalNative provider using this tool
2. Copy the LocalNative provider and supporting binaries to the test runner directory
3. Edit ConnectionProviders.xml and include your LocalNative provider
4. Run MaestroAPITestRunner.exe (if you built a LocalNative provider from 64-bit assemblies, run MaestroAPITestRunner64.exe). If the test
runner reports 0 test failures, your LocalNative provider has passed basic validation of our test suite. If there are any test failures,
4. Run MaestroAPITestRunner.exe (if you built a LocalNative provider from 64-bit assemblies, run MaestroAPITestRunner64.exe). If the test
runner reports 0 test failures, your LocalNative provider has passed basic validation of our test suite. If there are any test failures,
please report such issues on Trac and indicate the version of MapGuide you built your LocalNative provider from

0 comments on commit fc4b08b

Please sign in to comment.