ABSTRACT
SDK setup to create workspace to work in and setup your integration development environment.
TABLE OF CONTENTS
2. Setup
3. Rename
Pre-Development
Get Visual Studio if you don’t have it as most of what this guide helps is done within visual studio and may be different compared to any other method.
Setup
Project Workspace
With all the parts of the SDK extracted and visual studio downloaded we can set up the project workspace.
1: Open Visual Studio and make a new project.
2: Select to make a project solution of type class library (.net framework) C#.
3: Fill out the project's information.
4: A solution will be created for you with a test project in place.
5: Delete the test project by either (left-click and pressing delete/right-click and selecting “remove” from the menu) on the project name.
6: Now begin to add the projects from the SDK to this solution by right-click on the solution name and choosing “Add-->Existing Project”.
7: Add each project from the SDK by clicking on and opening their respective .csproj file.
.csproj file for Template
.csproj file for utility
Once all the files are added it should look like this:
Package Dependencies
1: Next click on “Projects-->Manage NuGet Packages”.
2: In here we can easily download any package dependencies for each project.
In this example the integrationDevelopmentUtility “Dependencies-->Packages” need installation.
Version is important to ensure the version of the SDK you have works properly ensure to install the listed version in the packages list or if specified.
SOME SPECIFIED PARTS
Current Versions Needed
NewtonSoft.Json – v13.0.1
RestSharp – v106.13.0
In here we are trying to ensure there are no warnings for our project dependencies shown by a yellow triangle.
From here when expanded out you can also see what version is needed if SDK is most up to date version.
Do this for each Project (Template,Utility) Dependency Packages.
Project Dependencies
1: The next dependency is the project dependencies...in the SDK the abstract is the project that the other two are dependent on as shown below with the integrationDevelopment Utility.
2: Remove the instances of your abstract as a project or as a project dependency in your solution Right-click on the integration. Abstract and delete.
3: Manage NuGet Packages for each project and install IPaaS.Integration.SDK.
As one final piece in the setup.
1: Go to “IntegrationDevelopmentUtility--->appsettings.json”.
2: Input your IPaaS.com portal account login info.
Rename
As part of creating your integration here we will make it so that your integration is unique.
1: In your project workspace created Right-Click on your integration template project.
2: Rename the template project to your own unique integration name.
NOTE: your package dependencies for the template at this point may show that there is a problem but will still compile if you would like to fix this simply reinstall all of the dependencies.
3: With this your project itself is now different we will now input other information within the
project-->Interface(Folder)-->MetaData.cs(File).
4: In this file change the name of the new integration.
5: Change the Integration File name.
6: ctrl+F the Integration Namespace.
7: In the pop up search window ensure that you are working in the current project and enter your naming convention and click replace all (Red).
8: Once all occurrences are changed right-click on the project name.
9: Build/Rebuild Project to make sure all namespaces have been changed with a successful compile.
