Proxy

The latest proxy would need to be obtained when:

• The integration is consuming SDK using .Net. (Recommended)

• And the integration intends to consume a newer endpoint.

Most third party integration developers would only be able to target a production SDK server. As of 2020 MU2, these developers would no longer be able to generate the proxy independently. These developers should now instead contact integration services to obtain the proxy. The proxy can be provided in various .Net languages. In special cases, a Wsdl could be provided.

Preloading the metadata in the web browser will prevent timeouts (If any) when generating the proxy.

If the full SDK is installed and SSL is turned on then enter the URL: https://<MyServer>/<virtual directory>/EpicSDK.svc.  If SSL is turned off, then enter the URL: http://<MyServer>/<virtual directory>/EpicSDK.svc

If using the SDK Core Service then instead use: https://<MyServer>/<virtual directory>/ EpicSDKCore.svc or http://<MyServer>/<virtual directory>/EpicSDKCore.svc

Note
If you receive any error messages or if SSL is invalid, check that the user has security rights to access the Epic SDK file path.

In some cases, it may be possible and necessary to generate the proxy independently. Enable metadata publishing before attempting to generate the proxy. Refer to the Enabling Metadata Publishing instructions. As stated previously, although there are many other strategies and technologies possible, only two will be provided. The Microsoft utility svcutil.exe or dotnet-svcutil can be used to generate the proxy.

i) To use svcutil.exe, follow these steps:

1. From a command-prompt, run “ C:\Program Files\Microsoft SDKs\Windows\vX.X\bin\svcutil.exe"  https://<MyServer>/<virtual directory>/EpicSDK.svc /language:vb

   If using the SDK Core Service then instead run https://<MyServer>/<virtual directory>/EpicSDKCore.svc /language:vb

2. If you would like to consume all arrays as collection, please add /ct:System.Collections.Generic.List`1 to the above run statement. Refer to the MSDN for a complete list of svcutil options.

3. If you would like to generate asynchronous method, please add /async to the statement. This tool generates only synchronous methods by default.

4. Rename output.config as app.config and add it with the .VB file to your project.

ii) To use dotnet-svcutil follow these steps. Please note that this tool does not support the language parameter yet. Only a cSharp file (.CS) can be generated from this tool.

1. To install the tool, from a command prompt: run "dotnet tool install --global dotnet-svcutil".

2. From a command prompt, run "dotnet-svcutil  https://<MyServer>/<virtual directory>/EpicSDK.svc

   If you are using the SDK Core Service then instead run "https://<MyServer>/<virtual directory>/EpicSDKCore.svc ".

3. If you would like to consume all arrays as collection, please add “-ct System.Collections.Generic.List`1” to the end of the above run statement.  Refer to the MSDN for a complete list of dotnet-svcutil options.

4. If you would like to generate synchronous method, please add --sync to the statement. This tool generates only asynchronous methods by default.

5. Add the .CS file that was created in the above step to your project.

As the SDK increases in size, the proxy generation process will take longer. Opening your web service in browser will avoid potential timeout issues by Internet Information Services. Alternatively, you may wish to implement a post reboot batch script to make the first call to the web service when a new proxy file is needed. This simple fix will warm up the application and reduce the time spent generating a proxy.

For more information about the svcutil or dontnet-svcutil, please refer to Microsoft’s documentation:

http://msdn.microsoft.com/en-us/library/aa347733.aspx

https://docs.microsoft.com/en-us/dotnet/core/additional-tools/dotnet-svcutil-guide?tabs=dotnetsvcutil2x