Signature item handling

Question

Signature item handling

Closed this issue a year ago · 15 comments

An item with the bind::oc:external value ‘signature’, will have one possible response. When this response is checked, it must:

Evaluate the form for errors as if the Complete button has been clicked. If there are errors, display the standard message blocking the user from completing the form
If the form is valid, make a call that the item has been checked

On the OC side this causes a dialog to appear, which can be cancelled, if that occurs OC may notify enketo the user is returning to the form, in this case when the user is returned to the form enketo unchecks the checkbox item. Ideally this should trigger any logic associated with that item.

Answer 1 · 2022-07-15T19:01:04.000Z

question type "acknowledge"? -> https://xlsform.org/en/#question-types - no a select_multiple with only 1 option

If I remember correctly, the rationale for using a form question (instead of UI around the form) is to be able to use form logic that refers to this question.

Can the user uncheck the box? - This scenario shouldn't be able to occur...

Answer 2 · 2022-07-15T19:33:25.000Z

Do not submit data if the oc:external value is "signature".

Answer 3 · 2022-07-15T19:37:01.000Z

Enketo checks whether it is a single-option select_multiple
Add validation in Enketo Validate -> moved to OpenClinica/enketo-oc#71
post message
receive 2 messages (and 1 timeout)
enable widget in default config
test in iframe

Work in master.

Answer 4 · 2022-07-15T19:44:02.000Z

If Enketo doesn't receive a 'receive and modal opened' message within a certain time, it should show something to the user and perhaps uncheck the question?

Another message if the user closes the modal without signing, do the same? - yes

Answer 5 · 2022-07-15T20:29:53.000Z

https://docs.google.com/spreadsheets/d/1JaTW9Yscf1pYTWttmJP0ez4VsSKM_eJtpD9wVRL6o-o/edit#gid=0

http://localhost:8005/single/fs/i/mAU2OYTj?ecid=a

http://localhost:8005/dev?iframe=http%3A%2F%2Flocalhost%3A8005%2Fsingle%2Ffs%2Fi%2FmAU2OYTj%3FparentWindowOrigin%3Dhttp%3A%2F%2Flocalhost%3A8005

Answer 6 · 2022-07-21T18:35:09.000Z

This is ready for testing in master.

Configuration:

a new widget was added to default-config.json. If you are not overwriting the widgets value in your Enketo installation you shouldn't have to do anything to enable this new widget

events:

{enketoEvent: 'signature-request'}: Enketo sends this to the parentWindow to trigger the signature dialog
{event: 'signature-request-received'}: OC sends back to Enketo to indicate the message was received and a dialog is shown
{event: 'signature-request-failed'}: OC sends back to Enketo to indicate that something went wrong (e.g. user clicked close on dialog)

Have a look at the two error messages here so they can be tweaked: c72476d#diff-47b07faa9b1b997bbcc969615c844fcd6bfe00b47523030fa082f8e08205584b

For reference this is what I used to test receiving and sending messages in the parentWindow:

window.addEventListener('message', receiveMessage, false);
    function receiveMessage(event){
      const data = JSON.parse(event.data);
      // TODO in real life, check origin! if (event.origin !== "http://enk.to:8080") return;
      console.log('data received from iframe', data);
      console.log('origin of message', event.origin);
      console.log('source of message', event.source);
      if (data.enketoEvent === 'signature-request'){
        document.querySelector( 'iframe' ).contentWindow.postMessage(
            JSON.stringify({
                event: 'signature-request-received'
            }),
            location.href
        );
      }
    }

Answer 7 · 2022-09-09T19:46:03.000Z

Hi Martijn,

Our developer has been working on this on our end and we are running into an issue where the error modal indicating no response was received after the signature item is checked displays 100% of the time. To aid in troubleshooting we were wondering if you could take a look and see if there's anything obviously wrong. Here is an image of the code in our UI to check for this:

Answer 8 · 2022-09-15T20:13:03.000Z

@malcjackson, I'm guessing there may be multiple iframes on the page you are developing. In that case document.querySelector('iframe') will only select the first iframe which may not be the one containing the Enketo Form.

If that's not the issue, can you confirm if you receive the signature-request message from the Enketo form?

Answer 9 · 2022-09-16T13:58:36.000Z

Thanks @MartijnR , the developer checked and has this response: "There are not multiple iframes on the page. I tried even giving a unique id to iframe, and then posting message "signature-request-received" to that iframe but that didn't work also"

Answer 10 · 2022-09-16T18:08:39.000Z

Thanks.

Can you confirm that you receive the signature-request message from the Enketo form?
Just to be sure, the message you are seeing in the modal is "Signature service is currently not available. The question has been unchecked.", right?
Is there an error message shown in the browser console, e.g. like "message received from untrusted source"?

Answer 11 · 2022-09-20T13:39:04.000Z

Thanks @MartijnR

We are receiving it
That is correct
There is an error in the console but it appears when the form is opened, before the item is checked. Nothing new appears in the console after the item is checked:

Here is the network tab after clicking the item, nothing sticks out here:

Answer 12 · 2022-09-21T20:22:32.000Z

Thank you!

I think the issue is with the second argument (targetOrigin) of postMessage (on the OC side). You could quickly confirm that by changing location.href to '*' (see https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage).

If that fixes it we need to change the unsafe '*' to the specific targetOrigin which should be the URL of the Enketo form. You may have to play around with that URL a bit (query params?, path?, fragment identifier?)

Answer 13 · 2022-11-02T19:27:53.000Z

look into why timeout is not cleared when signature-request-failed is received from OC

It seems better to explicitly clear it there, even though in reality 'signature-request-failed' would always be preceded by 'signature-request-received' and be cleared there.

I'll update this and will also update the logging for further dev troubleshooting on your end.

Answer 14 · 2023-02-08T20:56:14.000Z

@MartijnR @pbowen-oc in the case of {event: 'signature-request-failed'}, could we update this to not show a message, and simply uncheck the box?

Alternatively, is there an approach we can take on our end (e.g. make a different response) that would result in the box getting unchecked, but no additional dialog appearing?

Answer 15 · 2023-06-14T18:55:37.000Z

Looks good in testing