softcannery / camunda-formio-accelerator

Camunda Platform Accelerator for Form.io
https://www.softcannery.com/camunda-platform-acc-for-formio
Other
5 stars 3 forks source link

Incomplete README and Wiki/Getting Started leaves me with questions #145

Open julrichkieffer opened 1 week ago

julrichkieffer commented 1 week ago

Is your feature request related to a problem? Please describe. Questions not answered in the current documentation:

<< Assume, because it's true, that I have 0 (zero) Java knowledge, but am familiar with Docker, Camunda, Form.io, BPMN, DMN separately >>

Deployment of custom models and forms:

  1. Must the .formio and .bpmn (and .dmn) files all gave the same name as in the example?
  2. Conversely, I have a N244.formio and jk-formio-camunda.bpmn generated through the Modeller, but the Deploy Process page doesn't do anything once these files are selected. Is there an error? Is the deployment allowed (ie security passed) given I haven't logged in anywhere? How long should I wait for something to happen?
  3. Trying Camunda Modeller's (rocket) deployment, a http://localhost:8080/engine-rest endpoint is default. I remove the :8080 part to match the documentation, but validation continues to fail. Testing via the browser, nothing happens. Is the rest endpoint enabled? Is it mapped through NginX? Is it allowed, given I haven't logged in?
  4. Installing the releases/deployment plugin, and using the kermit/password credentials, the engine-rest endpoint still fails validation. How can I deploy without using the UI, eg using the file system or CD approach (multi-repo)?

Getting the latest .formio for a task / event in the Modeller:

  1. When does the formio Modeller plugin save set of .formio files across a .bpmn map?
  2. How can I force it to overwrite the specific .formio for a given event or task node?
  3. Sometimes the Form editor doesn't allow the component name or API id to be edited. I reload the whole Modeller as workaround
  4. How does one rename the .formio, data store, and have these "sync" between the Form editor and event / task properties?

Form.IO features configuration:

  1. How does one enable PDF forms?
  2. How does one enable multi-step (Wizard) forms, and dynamically skip steps using field values (if field.value = X then goto page3 else goto page2)
  3. I notice the form editor has a "browse" button. How can one edit a .formio file without going through the event / task's Edit button (bypass the disabled features, UI navigation, limited components, ID fields freezing)? Conversely, if I use Form.IO's full features (as in "bring my own form, created elsewhere"), and "browse" to select into a event / task, will all of the .formio work after deployment, or only what the Modeller plugin currently supports?

Using submissions in the process:

<< Of course I haven't gotten past a deployment, so this is rather thinking ahead based on what's already observed...>>

  1. One of the properties is variable which I assume will be the name of the process variable generated upon a submission and/or start event. I assume this variable will be populated with the JSON of the submission. How does one parse this JSON to extract a specific field value for eXclusive gateway branching, for example?
  2. Is FEEL, Groovy, JavaScript, Spin all enabled in the docker image? Is there a FormIO-aware submission accessor available? Will PDF, multi-step, multiple forms across a .bpmn, and form submissions (simple, pdf, and multi-step) from loop tasks or called sub-processes all access consistently?

Security:

Currently the Docker Compose doesn't require any login. This isn't realistic:

  1. How do I get access to the Camunda Task List, and other web apps?
  2. How do I enable / return Camunda's multi-tenant and multi-user login?
  3. How to I enable SSO or OpenId login via a 3rd provider eg Keycloack or Auth0?
  4. How to I disable the custom / over-simplified UI?
  5. How does the custom / over-simplified UI support X roles can start process A, Y roles do some tasks, z roles do others?

Describe the solution you'd like Detailed documentation. I would happily update and create documentation as answers come. In the meantime, I'm stuck / blocked.

proth1 commented 1 week ago

Hi julrichkieffer,

It is a little difficult to understand all your questions but I am happy to try and answer those that I can help with. I am wondering if it will be more productive to take each question and move it into the Discussions area and then any specific issue that does need to be handled as an Issue we make put here in the Issues section of the repo.

Starting with the first question:

Must the .formio and .bpmn (and .dmn) files all have the same name as in the example?

Which example are you referring to?

In general, depending on how you are developing your forms, this may influence how best to name your .formio files.

We use the Form.io Cloud Service to create forms. We then create and manage a collection of forms using the Stage which we then use the Accelerator's Modeler plug in, to down the Stage as a single JSON file. We then link forms in the single JSON file to each User Task as required. In my opinion, I find it to be a good practice to have the .formio file name be the same as the .bpmn file, but the .formio file is not required to be the same name as the .bpmn file.

I expect there is a good use case for creating the form.io file per User Task which is what it sounds like you are doing.

Whatever value you set for the formio.file property in the extension properties must be the file that you specify in the "Include additional files" when deploying the bpmn file from the Modeler.

regarding .dmn I don't think there is any relationship between the name of a .dmn file and the use of the Camunda Accelerator for Form.io.

julrichkieffer commented 1 week ago

Hi Paul

Answered: files can be named separately. Extension properties are used to set / "link" .formio files as deployed together.

What example?: the illustration (image) of an open dialog showing files similarly named.

Split questions into discussions?: OK. Grouped questions and context may be lost, but I seek the answers. I expected documentation may arise, for example the form-per-task or form-from-staged-download(?) approach, which would have divergent recipes to the same ends. 🤷

On Mon, 1 Jul 2024, 15:26 Paul Roth, @.***> wrote:

Hi julrichkieffer https://github.com/julrichkieffer,

It is a little difficult to understand all your questions but I am happy to try and answer those that I can help with. I am wondering if it will be more productive to take each question and move it into the Discussions area and then any specific issue that does need to be handled as an Issue we make put here in the Issues section of the repo.

Starting with the first question:

Must the .formio and .bpmn (and .dmn) files all have the same name as in the example?

Which example are you referring to?

In general, depending on how you are developing your forms, this may influence how best to name your .formio files.

We use the Form.io Cloud Service to create forms. We then create and manage a collection of forms using the Stage which we then use the Accelerator's Modeler plug in, to down the Stage as a single JSON file. We then link forms in the single JSON file to each User Task as required. In my opinion, I find it to be a good practice to have the .formio file name be the same as the .bpmn file, but the .formio file is not required to be the same name as the .bpmn file.

I expect there is a good use case for creating the form.io file per User Task which is what it sounds like you are doing.

Whatever value you set for the formio.file property in the extension properties must be the file that you specify in the "Include additional files" when deploying the bpmn file from the Modeler.

regarding .dmn I don't think there is any relationship between the name of a .dmn file and the use of the Camunda Accelerator for Form.io.

— Reply to this email directly, view it on GitHub https://github.com/softcannery/camunda-formio-accelerator/issues/145#issuecomment-2200307957, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAG2SZEIQD7ALDOWCODL7GLZKFRJ5AVCNFSM6AAAAABKAO36BGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDEMBQGMYDOOJVG4 . You are receiving this because you authored the thread.Message ID: @.***>

proth1 commented 1 day ago

@julrichkieffer, I apologize that I don't understand what you are saying in the prior response.