Considerations for Renaming Endpoints

In Application Designer and System Designer, you can rename endpoints on applications, systems, and members of those systems, depending on the endpoint type. When you rename an endpoint, remember the following considerations:

  • You must choose a unique name for the endpoint. Endpoint names must not conflict with resource names or, if within a system, the names of system members.

  • Characters that are incompatible with the System Definition Model (SDM) are omitted from names. If the resulting name conflicts with another name or a reserved SDM name, an ordinal is appended to the name or incremented if one already exists. For more information about SDM, see Overview of the System Definition Model (SDM).

  • Renaming an endpoint on an application definition renames that endpoint on all uses of that definition in system definitions. Renaming an endpoint on a member of a system definition renames the endpoint on the application definition and all uses of that definition in other system definitions.

  • When you rename a provider endpoint, Visual Studio will not update the corresponding consumer endpoint unless there is a connection already between those endpoints on the application diagram.

  • You can rename endpoints on an application definition as needed prior to implementing that application. However, once you implement that application, renaming the endpoint affects associated project files in different ways, depending on the endpoint.

    For example, when you rename a .NET Web Service provider endpoint, remember the following considerations:

    • By default, the name of the endpoint is based on the WSDL service name. For example, when you first reverse-engineer a .NET Web Service endpoint, the endpoint name is based on the WSDL service name.

    • If the Web service class name is the same as the endpoint name, renaming the endpoint renames the Web service class name.

      Note

      Renaming the Web service class name renames the Web service class file name and the WSDL service name if they are the same as the Web service class name. Renaming the WSDL service name renames the .asmx file name and the WSDL binding name if they are the same as the WSDL service name.

      Therefore, if you change the endpoint name, it is possible for this change to propagate from the endpoint name to the class name, from the class name to the WSDL service name, from the WSDL service name to the .asmx file name, and then the WSDL binding name.

    • If renaming an implemented Web service provider endpoint causes the .asmx file name to change, then any associated Web references and underlying proxy classes are deleted, which causes the corresponding Web service consumer endpoints to become unimplemented. You will need to reimplement the consumer endpoints to generate new Web references. If you are using source code control, you might also need to check in any affected files before reimplementing. To reimplement a Web service consumer endpoint, right-click the endpoint and choose Implement.

  • If renaming an implemented Web service provider endpoint causes the Web service name to change, proxy classes associated with Web references to the Web service will no longer match the service name. As a result, the application might not compile. To resolve this condition, fix those places in code that reference old service names.

See Also

Tasks

How to: Rename Endpoints on Applications