How do I complete the on-boarding process after an error interrupts the on-boarding wizard for Visual Studio?

If you receive a prompt indicating that the wizard has to exit when it is on the Content Generation page, you can take steps to manually complete the on-boarding process:
  • If the error was a build error, you can try to resolve the build error.

  • If the error was a deployment error, then the package can be deployed manually at a later time.

Resolving build errors

Some typical causes of build errors:
  • If you are attempting to on-board more than one class with the same name from different libraries.

  • If you are attempting to on-board a library and you did not include a needed dependent library.

Take the following steps to resolve build errors. The wizard works with the projects in the following order:
  1. Transport project

  2. Service project

  3. Proxy project

  4. Client project

It is best to handle the build errors in this same order.

Transport project

Verify that references for the libraries being on-boarded are already added to the project. Any missing references they must be added to the project for the build to be successful.

Manually build the project and resolve any build errors.

Service project

Verify that references for the libraries being on-boarded and the Transport project are already added to the project. Any missing references they must be added to the project for the build to be successful.

Manually build the project and resolve any build errors.

Once the project has been built the service project must be deployed. To deploy the service:
  1. Locate the service project in the solution.

    It should be the project with its name suffixed with the word Service. For example, GridUtilService.

  2. Right click the service project.

  3. Select Platform Symphony > Application Details from the context menu.

    The Platform Symphony Application Details dialog is displayed.

  4. Verify that all dependent files are visible in the Files included in package list.

  5. Click Create and Deploy Service Package and wait for confirmation of a successful deployment.

Proxy project

Verify that references for the libraries being on-boarded and the Transport Project are already added to the project. Any missing references they must be added to the project for the build to be successful.

Manually build the project and resolve any build errors.

A README can be found in the same location as the proxy project in a file named Readme.html.

Client project

Verify that references for the libraries being on-boarded and the Proxy project are already added to the project. Any missing references they must be added to the project for the build to be successful.

Manually build the project and resolve any build errors.

Additionally, if the failure occurred before the client code was updated by the wizard, you should update any code that is referring to the objects in the libraries being on-boarded to use the implementation residing in the Proxy instead of the original logic.

For example, if you have an object Calculator that originally resided in a namespace called Utils, and the namespace of the generated Proxy was GridUtils, then once you have added a using GridUtils; statement before the updated code, you should change code that resembles the following:

     Calcualtor obj = new Calculator();

into

GridUtils.Calculator obj = new GridUtils.Calculator();

Note:

These fully qualified names are only required if you still need to have direct access to a subset of the classes in your original libraries while still accessing the proxy of the classes that were being on-boarded from the same libraries. If you do not need access to any of the classes in the libraries being on-boarded, then you can also replace the "using Utils;" statement in our code with the "using GridUtils;" instead with no need to fully qualify access to the generated classes in the proxy.

Resolving deployment errors

Some typical causes of deployment errors:
  • The cluster is temporarily unavailable.

  • The consumer specified for the application is not a leaf-level consumer.

Take the following steps to resolve deployment errors related to the Service Project:
  1. Locate the service project in the solution.

    It should be the project with its name suffixed with the word Service. For example: GridUtilService.

  2. Right click the service project.

  3. Select Platform Symphony > Application Details from the context menu.

    The Platform Symphony Application Details dialog is displayed.

  4. Verify that all dependent files are visible in the Files included in package list.

  5. Click Create and Deploy Service Package and wait for confirmation of a successful deployment.