JR57839: RECURSIVE PARAMETER IS GENERATED FOR AN ENUM PROPERTY IN A SWAGGER DEFINITION

bpm.8570.cf2017.06.delta.repository

APAR status

• Closed as program error.

Error description

• A business object of the Selection type is not generated when
  you're trying to discover an external service in the web Process
  Designer by using a Swagger definition file that defines an
  object with a nested enum property.
  
  PRODUCTS AFFECTED:
  IBM Business Process Manager (BPM) Advanced
  IBM BPM Standard
  IBM BPM Express
  

Local fix

• Modify the Swagger file so that there are no nested enum types
  defined more than one level deep. Then rediscover the external
  service.
  
  For example, if you have the following YAML definition for a
  type that defines the enum property nested two levels deep
  (conditions property)
  
  definitions:
    SavedSearchDefinition:
      type: object
      properties:
        conditions:
            type: array
            items:
              type: object
              properties:
                field:
                  type: string
                operator:
                  type: string
                  enum:
                    - Equals
                    - NotEquals
                    - StartsWith
                    - Contains
                    - GreaterThan
                    - LessThan
                    - FullTextSearch
  
  change it to explicitly declare the Anonymous type:
  
  definitions:
    SavedSearchDefinition:
      type: object
      properties:
        conditions:
          type: array
          items:
            type: object
            $ref: '#/definitions/Condition'
    Condition:
      type: object
      properties:
        field:
          type: string
        operator:
          type: string
          enum:
            - Equals
            - NotEquals
            - StartsWith
            - Contains
            - GreaterThan
            - LessThan
            - FullTextSearch
  

Problem summary

• The problem occurs during an intermediate step of JSON to XSD
  conversion. An enum property nested two or more levels deep
  (object > anonymous type > anonymous enum) is not extracted as a
  top-level element in the XSD and, therefore, is not discovered
  as a Selection business object. As a result, the type of the
  property that uses the enum is incorrectly set to the business
  object from the parent Anonymous type instead.
  

Problem conclusion

• A fix will be included in IBM BPM V8.5.7 cumulative fix 2017.06
  that correctly generates the business object parameter and its
  type.
  

Temporary fix

Comments

APAR Information

• APAR is sysrouted FROM one or more of the following:

• APAR is sysrouted TO one or more of the following:

Fix information

• Fixed component name

  BPM ADVANCED

• Fixed component ID

  5725C9400

Applicable component levels

• R857 PSY

     UP