Ikke mulig å slette eller kansellere påbegynte portalsigneringer

[erlendfg]

Hvis jeg lager et nytt portalsigneringsoppdrag for ett dokument og signerer som den første av to signatarer, så skal statusen være IN_PROGRESS slik jeg har forstått. Men hva om jeg ønsker å fjerne denne fra køen? Hverken sletting eller kansellering fungerer, så enten må det være noe feil eller så er det noe jeg ikke har forstått.

Ved kansellering: Vi får denne feilmeldingen, som i seg selv er litt motstridende. Koden vår er som følger:

private void cancelPortalJob(final PortalJobStatusChanged statusChange, final Long submissionId) {
    try {
        portalClient.cancel(statusChange);
    } catch (NotCancellableException e) {
        logger.warn("Error cancelling portal job for reference {} with status {}: {}",
                statusChange.getReference(),
                statusChange.getStatus(),
                e.getMessage());
    }
}

Denne gir:
Error cancelling portal job for reference 3183359 with status IN_PROGRESS: Unable to cancel job. This is most likely because the job has been completed. Only newly created and partially completed jobs can be cancelled, please verify the job's status

Så det går ikke an å kansellerer denne, selv om den bør være enten «newly created» eller «partially completed».

Så da forsøker jeg i stedet å slette denne, men disse har aldri – i hvert fall ikke som jeg kan se – en slette-url. Altså denne gir null:
statusChange.getDeleteDocumentsUrl().

Det er litt uheldig at køen kan vokse uten at vi får kontroll på slike dokumenter. Jeg oppgir for sikkerhets skyld kø-id og referanse-id i tilfelle det kan forklares:
Bruker (org.nr.): 971 035 854
Kø-id: tsd-nettskjema-dev
Referanse: 3183359

[runeflobakk]

Måtte grave litt i gammel moro her, og det er vel ikke til å komme bort fra at dette er mer komplisert enn det kanskje kunne vært. For å ta det litt stykkevis:

• jeg kan ikke se at vi faktisk noen gang sender med cancellationUrl ved status-polling, så hvis man forsøker å kansellere v.h.a. en PortalJobStatusChanged så vil dette alltid kaste en NotCancellableException. Dette finner klienten ut på egen hånd, og den statiske hardkodede feilmeldingen er også noe selvmotsigende som du påpeker.
• PortalJobStatusChanged.getDeleteDocumentsUrl() derimot kan bli satt, men denne får man kun så lenge alle undertegnere har signert.

Jeg er litt usikker på hvorfor PortalJobStatusChanged gir inntrykk av å kunne ha en kansellerings-URL. Det er mulig vi har sendt med dette tidligere, men at det har blitt fjernet på et tidspunkt. Også har det ikke blitt ryddet vekk i klientbiblioteket. Men man får med en kansellerings-URL i responsen man får når man lager signeringsjobben (PortalJobResponse), og denne skal kunne brukes, frem til da signeringsjobben er signert av alle. Da kan ikke jobben per se kanselleres lenger, men innholdet kan om ønskelig slettes, og statusChange.getDeleteDocumentsUrl() for en jobb som er ferdigsignert vil gi en faktisk URL man kan bruke til sletting. Her er det dessverre også en gotcha med at slette-URLen er ikke anvendbar før det har gått minst 24 timer etter siste signering, så om man ønsker å ha mulighet til selv slette dokumenter før de blir automatisk slettet, så må man ta vare på denne URL-en. Det er ideelt om man kun sletter dokumenter som har spesielle grunner til det, og lar dokumentet være tilgjengelig for nedlasting av undertegnere.

Ang. "fjerne denne fra køen", ved å bekrefte en PortalJobStatusChanged blir den fjernet fra polling-køen, og vil ikke bli gitt ut igjen. Nye hendelser for signeringsjobben vil gi nye PortalJobStatusChanged.

[erlendfg]

Jeg er litt usikker på hvorfor PortalJobStatusChanged gir inntrykk av å kunne ha en kansellerings-URL. Det er mulig vi har sendt med dette tidligere, men at det har blitt fjernet på et tidspunkt. Også har det ikke blitt ryddet vekk i klientbiblioteket. Men man får med en kansellerings-URL i responsen man får når man lager signeringsjobben (PortalJobResponse), og denne skal kunne brukes, frem til da signeringsjobben er signert av alle. Da kan ikke jobben per se kanselleres lenger, men innholdet kan om ønskelig slettes, og statusChange.getDeleteDocumentsUrl() for en jobb som er ferdigsignert vil gi en faktisk URL man kan bruke til sletting. Her er det dessverre også en gotcha med at slette-URLen er ikke anvendbar før det har gått minst 24 timer etter siste signering, så om man ønsker å ha mulighet til selv slette dokumenter før de blir automatisk slettet, så må man ta vare på denne URL-en. Det er ideelt om man kun sletter dokumenter som har spesielle grunner til det, og lar dokumentet være tilgjengelig for nedlasting av undertegnere.

Det kan hende det er det vi må gjøre, altså å ta vare på slette-url-en ved opprettelse. Det er flere grunner til at vi ønsker å slette, eksemelvis hvis det gjøres omfattende testing i testmiljøet vårt og at selve skjemaet det testes mot slettes etter testing. Da har vi ikke lenger et skjema som signeringsdokumentene peker til, og da er det greit at det ryddes opp fra dokumentkøen.

Ang. "fjerne denne fra køen", ved å bekrefte en PortalJobStatusChanged blir den fjernet fra polling-køen, og vil ikke bli gitt ut igjen. Nye hendelser for signeringsjobben vil gi nye PortalJobStatusChanged.

Jeg er litt usikker på det blir litt grisete å bekrefte noe som egentlig aldri skulle ha blitt bekreftet.

Jeg tror altså vi må velge om å ikke gjøre noe (kanskje bare logge at vi ikke lenger har signeringsdokumenter som peker til et slettet dokument) eller at vi tar vare på slette-url-en ved oppretting.

Har dere dokumentert noe rundt endepunktet for sletting? Altså hva som skal sendes med for at dette endepunktet skal gi oss en 200 i respons. Eller er det ment at det manuelt skal «klikkes»/nås av en person?

[runeflobakk]

Jeg er litt usikker på det blir litt grisete å bekrefte noe som egentlig aldri skulle ha blitt bekreftet.

Dette er mer en bekreftelse i.f.m. med et integrasjonsmønster, at integrerende system har mottatt meldingen. Det er ikke ment å signalisere at man nødvendigvis gjør noe prosessering av statusoppdatteringen.

Det finnes ulike strategier for å håndtere disse meldingene. Man kan håndtere kun de oppdateringene man er interessert i (la oss si at man kun er interessert i at et oppdrag er ferdigssignert) synkront, og f.eks. laste ned signert dokument når det er tilgjengelig iflg mottatt statusoppdatering. Da bør man ignorere alle andre statusoppdateringer, men likevel bekrefte at man har fått de, ellers så vil Posten signering tolke det som at oppdateringen ikke har blitt mottatt etter litt tid, og legge det tilbake på kø.

Ideelt sett bør oppdateringene persisteres som "events" eller lignende, assosiert med signeringsoppdraget på deres side, også ev. oppdateringer man ikke ønsker å håndtere spesifikt, så har dere en slags logg over hendelser for oppdraget. Da har man også all informasjon tilgjengelig om man skulle trenge dette på et senere tidspunkt, selv om man ikke p.t. har laget noe systemstøtte for enkelte "oppdateringstyper".

Jeg tror altså vi må velge om å ikke gjøre noe (kanskje bare logge at vi ikke lenger har signeringsdokumenter som peker til et slettet dokument) eller at vi tar vare på slette-url-en ved oppretting.

Har dere dokumentert noe rundt endepunktet for sletting? Altså hva som skal sendes med for at dette endepunktet skal gi oss en 200 i respons. Eller er det ment at det manuelt skal «klikkes»/nås av en person?

Om dere vil ha mulighet for å slette dokumenter for et oppdrag i Posten signering, må dere ta vare på slette-url.

• https://signering-docs.readthedocs.io/en/latest/lagring.html#deleting-documents
• https://signering-docs.readthedocs.io/en/latest/client-integration/portal-flow.html#delete-documents