-
Task
-
Resolution: Unresolved
-
L3 - Default
-
None
-
None
-
Not defined
Context:
In SUPPORT-8115 a customer asked for a list of supported variable types. As these are not documented very prominently we should improve that by stating which types are supported at least on the VariablePlugin documentation https://docs.camunda.org/optimize/latest/technical-guide/plugins/variable-import/ .
As part of https://jira.camunda.com/browse/SUPPORT-8168, the customer couldn't filter on date variables that didn't match the expected Optimize format. This format expectation wasn't very clear from a user perspective. We plan normalised formats where possible in https://jira.camunda.com/browse/OPT-4014.
AT:
- supported variable types are listed in https://docs.camunda.org/optimize/latest/technical-guide/plugins/variable-import/
- We document the expected date variable string format(s) and our attempts to normalise them - although this is never guaranteed. For reference, we use https://github.com/sisyphsu/dateparser which covers quite a large range of convertible date formats (see README for examples).
- the block comments on fields of https://github.com/camunda/camunda-optimize/blob/master/plugins/plugin/src/main/java/org/camunda/optimize/plugin/importing/variable/PluginVariableDto.java are converted to proper javadoc comments (Hint: use /******** ******instead of /*)
- We should make it clearer that the variable ID should be a repeatable value and explain how versioning works to avoid the storage of "duplicate" variables
Hint:
Supported types are the primitive ones listed here https://docs.camunda.org/manual/latest/user-guide/process-engine/variables/#supported-variable-values except for the bytes and null type
This is the controller panel for Smart Panels app
[OPT-3956] Improve variable import documentation
| Assignee | New: Sebastian Bathke [ sebastian.bathke ] |
| Description |
Original:
Context:
In SUPPORT-8115 a customer asked for a list ofsupported variable types. As these are not documented very prominently we should improve that by stating which types are supported at least on the VariablePlugin documentation https://docs.camunda.org/optimize/latest/technical-guide/plugins/variable-import/ . AT: - supported variable types are listed in https://docs.camunda.org/optimize/latest/technical-guide/plugins/variable-import/ - the block comments on fields of https://github.com/camunda/camunda-optimize/blob/master/plugins/plugin/src/main/java/org/camunda/optimize/plugin/importing/variable/PluginVariableDto.java are converted to proper javadoc comments (Hint: use {{/**}} instead of {{/*}}) |
New:
Context:
In SUPPORT-8115 a customer asked for a list ofsupported variable types. As these are not documented very prominently we should improve that by stating which types are supported at least on the VariablePlugin documentation https://docs.camunda.org/optimize/latest/technical-guide/plugins/variable-import/ . AT: - supported variable types are listed in https://docs.camunda.org/optimize/latest/technical-guide/plugins/variable-import/ - the block comments on fields of https://github.com/camunda/camunda-optimize/blob/master/plugins/plugin/src/main/java/org/camunda/optimize/plugin/importing/variable/PluginVariableDto.java are converted to proper javadoc comments (Hint: use {{/****}} instead of {{/**}}) |
| Mentioned Roles |
| Mentioned Groups |
| Description |
Original:
Context:
In SUPPORT-8115 a customer asked for a list ofsupported variable types. As these are not documented very prominently we should improve that by stating which types are supported at least on the VariablePlugin documentation https://docs.camunda.org/optimize/latest/technical-guide/plugins/variable-import/ . AT: - supported variable types are listed in https://docs.camunda.org/optimize/latest/technical-guide/plugins/variable-import/ - the block comments on fields of https://github.com/camunda/camunda-optimize/blob/master/plugins/plugin/src/main/java/org/camunda/optimize/plugin/importing/variable/PluginVariableDto.java are converted to proper javadoc comments (Hint: use {{/****}} instead of {{/**}}) |
New:
Context:
In SUPPORT-8115 a customer asked for a list ofsupported variable types. As these are not documented very prominently we should improve that by stating which types are supported at least on the VariablePlugin documentation https://docs.camunda.org/optimize/latest/technical-guide/plugins/variable-import/ . AT: - supported variable types are listed in https://docs.camunda.org/optimize/latest/technical-guide/plugins/variable-import/ - the block comments on fields of https://github.com/camunda/camunda-optimize/blob/master/plugins/plugin/src/main/java/org/camunda/optimize/plugin/importing/variable/PluginVariableDto.java are converted to proper javadoc comments (Hint: use {{/***}} instead of {{/**}}) |
| Mentioned Roles |
| Mentioned Groups |
| Description |
Original:
Context:
In SUPPORT-8115 a customer asked for a list ofsupported variable types. As these are not documented very prominently we should improve that by stating which types are supported at least on the VariablePlugin documentation https://docs.camunda.org/optimize/latest/technical-guide/plugins/variable-import/ . AT: - supported variable types are listed in https://docs.camunda.org/optimize/latest/technical-guide/plugins/variable-import/ - the block comments on fields of https://github.com/camunda/camunda-optimize/blob/master/plugins/plugin/src/main/java/org/camunda/optimize/plugin/importing/variable/PluginVariableDto.java are converted to proper javadoc comments (Hint: use {{/***}} instead of {{/**}}) |
New:
Context:
In SUPPORT-8115 a customer asked for a list ofsupported variable types. As these are not documented very prominently we should improve that by stating which types are supported at least on the VariablePlugin documentation https://docs.camunda.org/optimize/latest/technical-guide/plugins/variable-import/ . AT: - supported variable types are listed in https://docs.camunda.org/optimize/latest/technical-guide/plugins/variable-import/ - the block comments on fields of https://github.com/camunda/camunda-optimize/blob/master/plugins/plugin/src/main/java/org/camunda/optimize/plugin/importing/variable/PluginVariableDto.java are converted to proper javadoc comments (Hint: use {{/***}} instead of {{/**}}) Hint: Supported types are the primitive ones listed here https://docs.camunda.org/manual/latest/user-guide/process-engine/variables/#supported-variable-values except for the bytes and null type |
| Mentioned Roles |
| Mentioned Groups |