Web Service UDRs(3.1)

Owned by Jenni Wallin
May 10, 2023
2 min read


When you save a Web Service (WS) profile, a number of UDR types are created and mapped according to specifications in the WSDL file. To see a structured list of these UDR types:

  1. Open the APL Code editor.
  2. Right-click on the text pad. Select UDR Assistance.
  3. Scroll down the UDR types list to the WS folder. 

The UDR types that are created when you save a WS profile are:

  • Abstract[port type name]WSCycle: This is created for every WS profile.

  • WSCycleUDR(s): This is generated for every WSDL operation.

A UDR type that may be created when you save a WS profile is:

  • UDR type: Describes the complex types that are defined in the XML Schema.

The UDR types that are stored in the WS folder by default are:

  • AbstractWSCycle: The type of the input UDR.

  • ws.QName: This UDR type matches a qname data type in an XML Schema. There can only be one ws.QName UDR type under ws.

  • XML Element: A wrapper type that is defined as "nillable" in the XML Schema.

The AbstractWSCycle UDRs and WSCycleUDR in the UDR folder structure are created and saved in a folder, created and named according to the following structure:

WS.[Directory Name].[WSProfile Name].cycles.[WSCycleUDR Names]

The UDR types related to the XML-schema are created and saved in a folder, created and named according to the following structure:

WS.[Directory Name].[WSProfile Name].[alias].[complexTypeUDRs]

The  alias  is replaced with the name of the Target Name space (tns). The name is set in the XML Schema part of the WSDL file. If the target name space has no name alias, the UDR is saved in the [WSProfile Name] folder.

Note!

When concatenating WSDL files, the aliases in the files can be identical, and if this occurs the structure is changed to avoid a name conflict. If the names include invalid characters, they are replaced with underscore characters.

The structure can be as follows:

WS.[Directory Name].[WSProfile Name].[WSDL Filename].[alias]

If the WSDL filename includes invalid name characters these are replaced with underscore characters in the  WSDL Filename.

Note!

If the WSDL file that you use to configure the WS profile includes a variable named "Thread", it is automatically changed to "thread". You must then rename the variable to “thread” in the APL code in the Analysis or Aggregation agent in your workflow. This prevents compilation issues when you try to compile your workflow.

This section contains the following sub-sections: