IO10217: PLUG-IN CONFIG - "ARGUMENTS" FIELD DOES NOT PARSE DOUBLE QUOTES PROPERLY.

APAR status

• Closed as program error.

Error description

• Description from dBD:
  
  The basic problem with the customer's configuration is that the
  arguments are included in the 'Command' field, which makes it
  difficult to distinguish the command (the .exe) from the
  arguments.
  
  Probably the best solution is to put the arguments in the
  separate 'Arguments' field, which would then make it clear that
  they are arguments and not part of the command string itself. I
  tried doing that with DM83FP9 with a simple .cmd file that
  takes 2 arguments, where the arguments are enclosed in double
  quotes (") like the customer's configuration.  This was not
  parsed correctly.
  
  Please open an APAR for this and send me the APAR number so I
  can open the CMVC defect.  Although I think the customer's
  plug-in should not include  the arguments in the "Command"
  field, it currently does not work to put the arguments in the
  "Arguments" field. The APAR will be used to both fix this
  handling and properly document that the command string go in
  the "Command" field and the command's arguments go in the
  "Arguments" field.
  
  ADDITION TO THE PROBLEM DESCRIPTION
  -----------------------------------
  in addition to the above, if the following conditions are both
  true:
  - Windows 8.3 filename generation is disabled
  - path to the control settings file, contains spaces
  then, DM using the space as the delimiter in the path, will be
  unable to find the control settings file causing the plugin
  execution to fail.
  
  For example:
  "C:\DOCUMENTS AND SETTINGS\ADMINISTRATOR\LOCALS AND
  SETTINGS\Temp\00CB92611A30.ini"
  
  will be read by DM as
  - C:\Documents
  - AND
  - Settings\Administrators\locals
  - AND
  - Settings\temp\00CB92611A30.ini
  causing it to fail to find the control settings file.
  

Local fix

• Workaround:
  
  Failure case:
  
  Plug-in configuration "Command" field:
  
  plugins\PMR01372Plugin.cmd "HOSSQLTEST1" "Document Manager"
  
  gets turned into:
  
  "plugins\PMR01372Plugin.cmd "HOSSQLTEST1" "Document Manager"" "
  C:\DOCUME~1\ADMINI~1\LOCALS~1\Temp\00C60DD71A30.ini"
  
  This fails because the entire string up to and including the
  word 'Document' prior to the control .ini file string is treated
  as the command to be executed, i.e.,
  
  "plugins\PMR01372Plugin.cmd "HOSSQLTEST1" "Document
  
  and is not found. Here's the result of copying and pasting that
  string at the Windows command line:
  
  C:\Documents and
  Settings\Administrator\Desktop>"plugins\PMR01372Plugin.cmd
  "HOSSQLTEST1" "Document Manager""
  
  '"plugins\PMR01372Plugin.cmd "HOSSQLTEST1" "Document' is not
  recognized as an internal or external command,
  
  operable program or batch file.
  
  Here's the workaround:
  
  Plug-in configuration "Command" field:
  
  plugins\PMR01372Plugin.cmd " HOSSQLTEST1 " 'Document Manager'
  
  which gets turned into:
  
  "plugins\PMR01372Plugin.cmd " HOSSQLTEST1 " 'Document Manager'"
  " C:\DOCUME~1\ADMINI~1\LOCALS~1\Temp\00CB92611A30.ini"
  
  This works because
  
  1) the command part (i.e., the .cmd file) has matching quotes
  (the trailing space within the quotes is ignored)
  
  "plugins\PMR01372Plugin.cmd "
  
  2) argument 2 is without quotes and because it has no embedded
  white space, it's ok:
  
  HOSSQLTEST1
  
  3) argument 3 has matching quotes:
  
  " 'Document Manager'"
  
  4) the appended control ini file has no quotes and no embedded
  white space:
  
  C:\DOCUME~1\ADMINI~1\LOCALS~1\Temp\00CB92611A30.ini
  
  
  
  The above explains the failure and one possible workaround.
  
  In general, the workarounds follow these rules:
  
  -- the command path (for the .exe, .bat, .cmd, etc.) needs one
  trailing double quote (")
  
  -- all following arguments except for the final argument need to
  be enclosed in matching quotes if there is any embedded white
  space in the argument.
  
  If no embedded white space, no quotes are needed.
  
  -- the final argument needs one preceding quote, regardless of
  whether or not it has embedded white space
  
  Here's are some examples of successful workarounds (entries to
  plug-in config "Command" field) using the above rules:
  
  C:\Program Files\ibm\DB2 Document
  Manager\plugins\PMR01372Plugin.cmd" WORKAROUND2 "Workaround 2 -
  arg with embedded spaces
  
  C:\Program Files\ibm\DB2 Document
  Manager\plugins\PMR01372Plugin.cmd" "WORKAROUND2 arg 1 with
  embedded white space" "ARG2NOEMBSPACE
  
  LOCAL FIX FOR INVALID CONTROL SETTINGS FILE PATH ISSUE: NONE
  because the path and file name are internally generated.
  

Problem summary

• Plug-in arguments that were configured in Designer were not
  always parsed correctly.
  

Problem conclusion

• The fix is available in DB2 Document Manager v8.3 Fix Pack 12.
  

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

  DOCMGR DESKTOP

• Fixed component ID

  5724H9000

Applicable component levels

• R830 PSY

     UP