Best Practices for Managing Web Service Connections

Here are some best practices for managing web service connections during migration.

  • Create any SOAP or REST Web Service connections in the target environment with the same name as defined in the source environment.

  • Wherever possible, use REST Web Services instead of SOAP Web Services. Using REST Web Services reduces the web service connections' chances of getting changed or deleted after you import your migration set to the target environment.

  • Review and recreate web service references in the target environment during migration in preview mode.
  • Delete and create web service connections in the target environment using target environment URL and credentials during migration in preview mode.

    Here are the scenarios when you might need to delete and recreate web service connections in the target environment:

    Scenario After Migration Action Required

    New web services in the source environment to be migrated

    New web services are partially migrated to the target environment and you get a warning message

    Delete and create web service references

    Web services exist in both environments (with the same names, relative URLs, and security settings)

    Web services are migrated to the target environment

    No action required

    Web services exist in both environments (with same names, but different relative URLs and security settings)

    Web services are migrated to the target environment, but details don’t match

    For REST web services, delete and recreate web service references

    For SOAP web services, refresh web service references

    Additional web services exist only in the target environment

    Web services are deleted from the target environment after migration

    Create web service references again, if required