Dears,
I know the project is very large and demanding. But the level of the documentation could (or should) be higher.
It is frustrating for developers to experiment with object settings to achieve the desired results.
For example, I used my first widget for creating the report in the workflow. The documentation says:
Input:
ReportType string
ReportCode string
ButtonLabel string
ForcePDF integer
ForceCSV integer
Parameter-1
Parameter-2
...
Parameter-n
Output:
ReportURL string
ReportType can currently only take the 'custom' value ReportCode coincides with the report “Code” attribute in the schedule “Report” ForcePDF forces the output in PDF format ForceCSV forces the output in CSV format Parameter-1 ... Parameter-n they represent launch parameters provided by the report.
From the description is not clear following:
- what value insert to "Force..." input (1)
- what is the syntaxe for parameters input (only values, name=value, or "Name"=value...)
- what to do with the return value ReportURL (nothing...)
Why there exist some undocumented parameters? I know about this:
- ReadOnlyAttributes - string with list of read only attributes names, for example "userId,processId"
It is very similar with other features. If I could not look at Ready2Use project I would not be able to develop my project in CMDBuild.
I know it is very laborious to create and maintain high quality documentation. But the good documentation would help to wider using of CMDBuild and accelerate work of many developers.
Please, try to think about ways of creating better documentation for the future.
Many thanks in advance for all CMDBUild developers!
Jiří