Once an agreement has been reached, we will provide you with the following material:
- A sample project that just requires you to change the application settings and be up and running in minutes.
- A license file which is required for use of the library.
- Access to the Myget.org private Nuget feed for EBSconnect. This will allow you to quickly update the library for changes/fixes and allow your projects to handle the dependencies without any trouble. We HIGHLY suggest using this route for consuming the library. If you require the library in another form, take a look here.
- An email containing your license's public key (one of the required settings).
Getting started with EBSconnect is simple, please see the outline of steps below:
1) In your project, right-click and select the option "Manage NuGet Packages"
2) If you don't already have the feed added to your list of feeds, you'll need to click the "Settings" button on the bottom left of the "Manage NuGet Packages" window BEFORE we can install the package this way.
3) Click the add (+) button to add a new package source then enter the information provided when you completed your Myget.org invitation from us.
4) Make sure you click the "Update" button and that the source is enabled (checked) before clicking the "OK" button.
5) You should now see the feed and the package. You can install the package by clicking the "Install" button.
6) When the package is installed, you will notice it managing and installing (if necessary) the dependencies and the library itself. It will also add the required application configuration settings to your app.config or web.config.
(Note: At the moment, due to a limitation of config file transformations, any updates of the library will overwrite the settings in the app.config or web.config. It's useful to have that file open in Visual Studio before updating the library so that you can easy dis-allow any changes to the file. This will be corrected when possible.)
7) After the package installation, you will see the default values added to your configuration file. You will need to complete these before you can use the library. Please see the section "Required Configuration Settings" for more information about each setting.
8) Once you've completed your configuration and changed the values in the sample code, you should be able to complete your first (of many!) service calls without ripping your hair out.
Required Configuration SettingsThe following settings are required to be in your app.config or web.config (depending on the type of project). If you install the library by using the Nuget private feed, then these settings are added to your project automatically.
EBSConnect.PrivateKeySecret should be set to a value of your choosing. This value is used when generating the self-signed certificate.
EBSConnect.MCEDT.SoftwareConformanceKey should be set to your conformance key for MCEDT.
EBSConnect.MCEDT.ServiceURL should be set to the MCEDT service endpoint, but it needs to be changed in your situation to be the conformance URL of "https://ws.conf.ebs.health.gov.on.ca:1443/EDTService/EDTService". In production, this URL becomes "https://ws.ebs.health.gov.on.ca:1443/EDTService/EDTService". Note also, this is the now mandatory TLS 1.2 endpoint as of December 9th, 2016.
EBSConnect.MCEDT.ServiceUserID should be set to the ServiceUserID given to you in your MCEDT conformance document.
EBSConnect.HCV.SoftwareConformanceKey should be set to your conformance key for HCV.
EBSConnect.HCV.ServiceURL should should be set to the MCEDT service endpoint, but it needs to be changed in your situation to be the conformance URL of "https://ws.conf.ebs.health.gov.on.ca:1444/HCVService/HCValidationService". In production, this URL becomes "https://ws.ebs.health.gov.on.ca:1444/HCVService/HCValidationService". Note also, this is the now mandatory TLS 1.2 endpoint as of December 9th, 2016.
EBSConnect.HCV.ServiceUserID should be set to the ServiceUserID given to you in your HCV conformance document.
EBSConnect.License.PublicKey should be set to the value mentioned in your on-boarding email that was sent to you this morning.
The EBSConnect.HCV.Mode and EBSConnect.MCEDT.Mode - Keys use values of either "IDP" or "MSA". Currently the MOHLTC has only opened HCV to MSA communication.
EBSConnect.PersistedCertificatePassword - If using MSA, this must be set to the password used to secure the certificate. If using IDP, this can be set if using an external certificate but can also be set to set a password on the generated certificate.
EBSConnect.MCEDT.SecurityProtocol and EBSConnect.HCV.SecurityProtocol now must both be set to "Tls12" as of December 9th, 2016 due to a change in their security requirements. In projects targeting .NET 4.6+, no value is required as TLS 1.2 is the default.