PI18145: DOCUMENT THE USE OF PROPERTIES IN THE COMMAND CREATECOMPONENT

IBM UrbanCode Deploy 6.1

APAR status

• Closed as program error.

Error description

• The documentation of the CLI command createComponent should
  specify that the properties parameter does not refer to custom
  properties, but only to the properties of the Source Config
  Plugins.
  
  
  Try to create a Component from the Command line as follows:
  
  
  udclient -weburl https://hostname:port -password xxxx -username
  xxxx createComponent -t
  {
    "name": "Component name/ID",
    "description": "description goes here",
    "templateId": "ID of a template to use (optional)",
    "templateName": "Name of a template to use (optional - ignored
  if templateId given)",
    "templateVersion": "Version number of the template specified
  (optional)",
    "importAutomatically": "Boolean",
    "useVfs": "Boolean",
    "sourceConfigPlugin": "the name of the source config plugin to
  use",
    "defaultVersionType": "The default type to create versions
  with. Allowed Values are FULL and INCREMENTAL.",
    "cleanupDaysToKeep": "Number of days to keep versions.
  (optional - ignore to inherit system settings)",
    "cleanupCountToKeep": "Number of most recent versions to keep.
  (optional - ignore to inherit system settings)",
    "properties": {
      "name": "value (Optional - repeat as necessary)"
    }
  }
  
  Additionally, these properties must be prefixed with the SOurce
  Control Plugin type, as in the following examples:
  
  
  Example1:
  
  This example will create a component with the mandatory
  properties for the Maven Source Config Type:
  
  {"name":"MyComponentName","description":"UseMaven","importAutoma
  tically":"false","useVfs":"false","sourceConfigPlugin":"Maven","
  properties":{"MavenComponentProperties/artifactId":"MyArtifact",
  "MavenComponentProperties/groupId":"MyGroup","MavenComponentProp
  erties/extension":"ext","MavenComponentProperties/repoUrl":"http
  :\/\/myserver.com"}}
  
  Note: if this Component need sto refer to a Component template,
  then the Component template must also use the Maven Source
  Config Type.
  
  
  Example2:
  
  {"name":"MyComponentName2","importAutomatically":"true","useVfs"
  :"true","sourceConfigPlugin":"File System (Versioned)"
  , "defaultVersionType":"FULL",
  "properties":{"FileSystemVersionedComponentProperties/basePath":
  "/tmp/vfs2"}}
  
  The easiset way to determine the valid names of these properties
  is to export a component that used the desired Source Config
  type, and inspect the generated JSON file.
  

Local fix

Problem summary

• ****************************************************************
  * USERS AFFECTED:                                              *
  * Any                                                          *
  ****************************************************************
  * PROBLEM DESCRIPTION:                                         *
  * The documentation of the CLI command createComponent should  *
  * specify that the properties parameter does not refer to      *
  * custom                                                       *
  * properties, but only to the properties of the Source Config  *
  * Plugins.                                                     *
  ****************************************************************
  * RECOMMENDATION:                                              *
  ****************************************************************
  

Problem conclusion

• Documentation updated
  

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

  UC DEPLOY

• Fixed component ID

  5725M5400

Applicable component levels

• R610 PSN

     UP

• R610 PSY

     UP