SDK Innehållsspecifikation Meddelande

Dokumenttyp

Messaging

• UserMessage

• CollaborationInfo.action

Värde: busdox-docid-qns::urn:riv:infrastructure:messaging:MessageWithAttachments:3::messagePayload##3.0::tm-base-ext-sigenc

<Action>busdox-docid-qns::urn:riv:infrastructure:messaging:MessageWithAttachments:3::messagePayload##3.0::tm-base-ext-sigenc</Action>

Service (Process)

Messaging

• UserMessage

• CollaborationInfo.service

Type = urn:fdc:Digg.se:edelivery:process

Värde = bdx:noprocess

<Service type="urn:fdc:Digg.se:edelivery:process">bdx:noprocess</Service>

• Unik identifierare
  • ID

• Datum
  • CreationDateTime

Unik identifierare av meddelandet/nyttolast.

• ID: Unik identifierare. Ska vara samma som för nyttolasten
• CreationDateTime: Datum när XHE skapades. Kan vara samma som för nyttolasten.

<XHEVersionID>1.0</XHEVersionID>

<xha:Header>

<ID>862693f7-53d4-4d96-b35c-470055710092</ID>

<CreationDateTime>2019-08-15T17:52:58.1Z</CreationDateTime>

..

<xha:Header>

Innehållsvalidering - Kodning av kvitteringsmeddelande

Meddelanden kvitteras enligt Diggs specifikation meddelandekvittens, se R1.

Kvittenskod: REJECTED

Orsakskod: BV

Detaljkod: invariant

Detaljtext: In $path, Timestamp should match pattern "YYYY-MM-DD'T'hh:mm:ss.s'Z'" but was <value-of select="."/>.

• Avsändare
  • FromParty
• Mottagare
  • ToParty

FromParty.PartyIdentification

• Sändande deltagaroganisation (Organisations-id)

• SKA vara samma som AS4 originalSender
• SKA vara samma som MessageType.MessageHeaderType.SenderType

ToParty.PartyIdentification

• Mottagande användarroganisation (Organisations-id)

• SKA vara samma som AS4 finalRecipient
• SKA vara samma som MessageType.MessageHeaderType.RecipientType

<xha:FromParty>

<xha:PartyIdentification>

<ID schemeID="iso6523-actorid-upis">0203:habo.se</ID>

</xha:PartyIdentification>

</xha:FromParty>

<xha:ToParty>

<xha:PartyIdentification>

<ID schemeID="iso6523-actorid-upis">0203:arbetsformedlingen.se</ID>

</xha:PartyIdentification>

Meddelandets struktur

Payloads.Payload.DocumentTypeCode

• SKA motsvara rotelementet dvs “Q{urn:riv:infrastructure:messaging:MessageWithAttachments:3}messagePayload”

Payloads.Payload.ContentTypeCode

• SKA sättas till “application/xml“

<xha:Payloads>

<xha:Payload>

<DocumentTypeCode>Q{urn:riv:infrastructure:messaging:MessageWithAttachments:3}messagePayload</DocumentTypeCode>

<ContentTypeCode>application/xml</ContentTypeCode>

Funktionsadress (egen identifierare)

Payloads.Payload.HandlingServiceID

Nyttolastens funktionsadress, kan används för att underlätta meddelandehantering i meddelandetjänst/meddelandeväxel.

SDK Meddelande och Meddelandekvittens

OBS! Meddelandekvittens är ett separat meddelande som har en egen specifikation., se R1 Meddelandespecifikation: Meddelandekvittensavser.

• Mottagarens Id för att identifiera funktion/enheter.
  • SKA vara samma som attention.subOrganization.organizationId.extension

• SKA även sättas i XHE kuvert på kvittensmeddelandet för detta meddelande.

<xha:Payloads>

<xha:Payload>

<DocumentTypeCode>Q{urn:riv:infrastructure:messaging:MessageWithAttachments:3}messagePayload</DocumentTypeCode>

<ContentTypeCode>application/xml</ContentTypeCode>

<HandlingServiceID>sub-funktion-org-id</HandlingServiceID>

<InstanceEncryptionIndicator>true</InstanceEncryptionIndicator>

<xha:PayloadContent>

Innehållsvalidering - Kodning av kvitteringsmeddelande

Meddelanden kvitteras enligt Diggs specifikation meddelandekvittens, se R1.

Kvittenskod: REJECTED

Orsakskod: BV

Detaljkod: not-found

Detaljtext: Wrong or unknown

xha:HandlingServiceID

../message

(MessageType)

MessageType

messageHeader

MessageHeaderType

Bärare av metadata

1..1

messageBody

MessageBodyType

Bärare av innehåll (text, bilaga)

1..1

../messageHeader

(MessageHeaderType)

creationDateTime

dateTime

Tidsstämpel för när meddelandet skapades.

Tidszon UTC skall användas.

T.ex. 2018-09-12T15:06:00Z.

Innehållsvalidering - Kodning av kvitteringsmeddelande #1.

Meddelanden kvitteras enligt Diggs specifikation meddelandekvittens, se R1.

Kvittenskod: REJECTED

Orsakskod: SV

Detaljkod: structure

Detaljtext: cvc-datatype-valid.1.2.1: '3 Sept. 2019' is not a valid value for 'dateTime'

Innehållsvalidering - Kodning av kvitteringsmeddelande #2

Meddelanden kvitteras enligt Diggs specifikation meddelandekvittens, se R1.

Kvittenskod: REJECTED

Orsakskod: BV

Detaljkod: invariant

Detaljtext: In $path, Timestamp should match pattern "YYYY-MM-DD'T'hh:mm:ss.s'Z'" but was '2019-09-03T12:04:13.123' | at path {path till element}

1..1

messageId

String

Unik identifierare (UUID) av meddelande.

• Meddelande-id (messageid) SKA vara samma som XHE.ID

Ska följa RFC4122. Se https://tools.ietf.org/html/rfc4122 Länk till annan webbplats.

Innehållsvalidering - Kodning av kvitteringsmeddelande

Meddelanden kvitteras enligt Diggs specifikation meddelandekvittens, se R1.

Kvittenskod: REJECTED

Orsakskod: BV

Detaljkod: invariant

Detaljtext: In ns:RefToMessageId, 'teststring..' is not a valid UUID. | at path {path till element}

1..1

conversationId

String

Skapas av sändande system. Unik identifierare (UUID).

Notera att även AS4 eb:CollaborationInfo.ConversationId SKA sättas till samma värde som ConversationId.

“ConversationId” används för att koppla meddelanden i en konversation. Ett “ConversationId“ kan återanvändas i meddelandeutbyte mellan olika mottagare. T.ex. om sändaren vill skicka samma meddelande till flera mottagare.

Vid ny konversation/nytt meddelande:

• Samma värde används som för messageId eller ett nytt id skapas

Besvara meddelade:

• ConversationId sätts till samma värde som i meddelandet som besvaras (ConversationId återanvänds).

Komplettera meddelande

• ConversationId sätts till samma värde som i meddelandet som kompletteras (ConversationId återanvänds).

Innehållsvalidering - Kodning av kvitteringsmeddelande #1

Meddelanden kvitteras enligt Diggs specifikation meddelandekvittens, se R1.

Kvittenskod: REJECTED

Orsakskod: BV

Detaljkod: invariant

Detaljtext: In ns:messageHeader, conversationId must be set. If this is a new message, use the same UUID as messageId to start new conversation

Innehållsvalidering - Kodning av kvitteringsmeddelande #2

Meddelanden kvitteras enligt Diggs specifikation meddelandekvittens, se R1.

Kvittenskod: REJECTED

Orsakskod: BV

Detaljkod: invariant

Detaljtext: In ns:RefToMessageId, 'teststring..' is not a valid UUID.

Meddelandeklient (MK) skall hantera värdet.

1..1

refToMessageId

String

Används inte för meddelanden som inte är svar på annat meddelande.

RefToMessageId sätts av sändande system när ett meddelande besvaras.

RefToMessageId ska sättas till messageId för meddelandet som besvaras/kompletteras.

Ger stöd för att se ordningsföljd i konversationstrådar, samt att koppla samman meddelandekvittenser med meddelandet.

• Om ett värde skickas skall det valideras och hanteras i klient.
• Meddelandeklient (MK) skall hantera ordningsföljd mellan meddelanden baserat på värdet.

Innehållsvalidering - Kodning av kvitteringsmeddelande

Meddelanden kvitteras enligt Diggs specifikation meddelandekvittens, se R1.

Kvittenskod: REJECTED

Orsakskod: BV

Detaljkod: invariant

Detaljtext: In ns:RefToMessageId, 'teststring..' is not a valid UUID.

0..1

label

String

Meddelandets rubrik. Max 256 tecken.

• Meddelandeklient(MK) skall hantera meddelandets rubrik

Innehållsvalidering - Kodning av kvitteringsmeddelande

Meddelanden kvitteras enligt Diggs specifikation meddelandekvittens, se R1.

Observera att innehåll i sträng EJ får returneras i “Detaljtext“.

Kvittenskod: REJECTED

Orsakskod: BV

Detaljkod: structure

Detaljtext: In tns:messageHeader/tns:label, string length {antal tecken} exceeded maxlength 256 at {path to element}

1..1

confidentiality

Boolean

Kommunicerar sändande organisations sekretessbedömning. Syftet med markeringen är att upplysa mottagande organisation om att meddelandet innehåller sekretessbelagd information och/eller känsliga personuppgifter.

Meddelandeklient(MK) skall hantera och synliggöra fältet.

• True - omfattas av sekretess
• False - omfattas ej av sekretess

1..1

generatingSystem

IIType

Identifierare för systemet som skapade/genererade meddelandet. Id kan användas för felsökning/support.

Regelverk IIType:

• root = kodverk för identifierare
  • Identifierare är oreglerad
• extension = id.

recipient

recipientType

Bärare av metadata för mottagande organisation

sender

senderType

Bärare av metadata för sändande organisation

../recipient
(RecipientType)

recipientId

IIType

Mottagande organisation (organisations-id).

• Tillämpas enligt specifikation.
  Identifierare av organisation SKA vara samma värde som
  • AS4 header:
    • Messaging
      • UserMessage
        • MessagePropertie
          • finalRecipien
            • XHE:
              ToParty.PartyIdentification

Regelverk IIType:

• root = kodverk för identifierare
  • Använd: iso6523-actorid-upis
• extension = “0203:” + organisations-id i form av domännamn.
  • Ex: 0203:http://inera.se
• Värdet i extension SKA valideras programmatiskt i meddelandetjänst för att säkerställa korrekt adressering. Täcks inte av schema/schematron.

Innehållsvalidering - Kodning av kvitteringsmeddelande #1

Meddelanden kvitteras enligt Diggs specifikation meddelandekvittens, se R1.

Kvittenskod: REJECTED

Orsakskod: BV

Detaljkod: security

Detaljtext: recipientId is not identical to value in XHE envelope.

Innehållsvalidering - Kodning av kvitteringsmeddelande #2

Meddelanden kvitteras enligt Diggs specifikation meddelandekvittens, se R1.

Kvittenskod: REJECTED

Orsakskod: BV

Detaljkod: invariant

Detaljtext: In ns:root, value should be set to ‘iso6523-actorid-upis' but was 'teststring’.

1..1

label

String

Tillämpas enligt specifikation. Organisationens namn. Max 256 tecken.

• Mappas mot adressbokens attribut för organisationsnamn (organizations "name")
• Om ett värde skickas skall Meddelandeklient (MK) hantera värdet.

Innehållsvalidering - Kodning av kvitteringsmeddelande

Meddelanden kvitteras enligt Diggs specifikation meddelandekvittens, se R1.

Kvittenskod: REJECTED

Orsakskod: SV

Detaljkod: structure

Detaljtext: cvc-maxLength-valid: Value 'teststring..' with length = '468' is not facet-valid with respect to maxLength '256' for type '#AnonType_labelMessageHeaderType'. string to long.

0..1

attention

attentionDataType

Bärare av metadata för funktionsadress och refererad person. Se avsnitt "3.3.2.3 AttentionDataType" för detaljerad information.

1..1

../sender
(SenderType)

senderId

IIType

Sändande organisation.

Tillämpas enligt specifikation.

• Identifierare av organisation SKA vara samma värde som
  • o AS4 header:
    • Messaging
      • UserMessage
        • MessagePropertie
          • originalSend
  • XHE
    • FromParty.PartyIdentification
• Kontroll av avsändare (gäller vid tillämpning av organisatonsidentifierare iso6523:0203)
  • SKA vara samma toppdomän i “PartyInfo.From.PartyId” och “MessageProperties Property name="originalSender”
  • SKA kontrollera mot SMP att originalSender är registrerad i federationen (ParticipantIdentifier)

Regelverk IIType:

• root = kodverk för identifierare
  • Använd: iso6523-actorid-upis
• extension = “0203:” + organisations-id i form av domännamn.
  • Ex: 0203:http://inera.se

Validering:

• Värdet i extension SKA valideras programmatiskt i meddelandetjänst för att säkerställa korrekt adressering. Täcks inte av schema/schematron.
• Meddelandets XHE signatur SKA valideras mot Diggs SMP (CertPub) tjänst.
  • Signaturen SKA motsvara Organisations-id registrerad i Certifikatspubliceringstjänst (CertPub) tjänst.

Innehållsvalidering - Kodning av kvitteringsmeddelande #1

Meddelanden kvitteras enligt Diggs specifikation meddelandekvittens, se R1.

Kodning av kvitteringsmeddelande där senderId inte validerats OK:

Kvittenskod: REJECTED

Orsakskod: BV

Detaljkod: invariant

Detaljtext: Wrong or unknown sender-id

Innehållsvalidering - Kodning av kvitteringsmeddelande #2

Meddelanden kvitteras enligt Diggs specifikation meddelandekvittens, se R1.

Kodning av kvitteringsmeddelande där Meddelandets XHE signatur inte validerats OK:

Kvittenskod: REJECTED

Orsakskod: SIG

Detaljkod: security

Detaljtext: Sender signature not validated

Innehållsvalidering - Kodning av kvitteringsmeddelande #3

Kodning av kvitteringsmeddelande där schematronvalidering returnerar error:

Kvittenskod: REJECTED

Orsakskod: BV

Detaljkod: invariant

Detaljtext: In ns:root should be set to 'iso6523-actorid-upis' but was 'Icke godkänt kodverk'. | {path till element} 1..1

1..1

label

String

Tillämpas enligt specifikation. Max 256 tecken

• Mappas mot adressbokens attribut för organisationsnamn (t.ex.organizationalUnitName)
• Om ett värde skickas skall Meddelandeklient(MK) hantera värdet.

Innehållsvalidering - Kodning av kvitteringsmeddelande

Meddelanden kvitteras enligt Diggs specifikation meddelandekvittens, se R1.

Kvittenskod: REJECTED

Orsakskod: SV

Detaljkod: structure

Detaljtext: cvc-maxLength-valid: Value 'teststring..' with length = '468' is not facet-valid with respect to maxLength '256' for type '#AnonType_labelMessageHeaderType'. string to long.

0..1

attention

attentionDataType

Bärare av metadata för funktionsadress och refererad person. Se avsnitt "4.3.2.3 AttentionDataType" för detaljerad information. 1..1

1..1

../messageBody

(MessageBodyType)

./Documents

DigitalDocumentType

Bärare av textmeddelande och bilaga.

1..*

../contentText

(ContentAsText)

characterSequence

1..1

Fritext (UTF-8).

Text kan formateras med följande MarkDown koder enligt RFC 7763.

Headers:

# H1

## H2

### H3

#### H4

##### H5

###### H6

Strong/bold

**xyz**

__xyz__

Italic:

*xyz*

_xyz_

Bullet:

* xyz

Number:

1.

2.

*Two or more line breaks*

This is the first line

This is the second line

---

*Two or more spaces, and then type return*

This is the first line

This is the second line

Grafiskt gränssnitt i meddelandeklient (verksamhetssystem), tjänst skall rendera ovanstående MarkDown-koder.

Om ett värde skickas skall Meddelandeklient (MK) hantera värdet.

1..1

../ContentFiles (ContentAsBase64Type)

Bifogas flera element skall dessa hanteras enligt valfri sortering.

fileName

String

Bilagans filnamn. Filnamnet bör visas i meddelandetjänsten.

1..1

contentType

String

Typ av bilaga som överförs/bifogas. MIME-typ för bifogad fil skall anges.

• Alla deltagarorganisationer ska stödja filtypen PDF.
  • Rekommendation för arkivbeständig PDF-format är
    • PDF-A1
    • PDF-A2
• Utöver PDF ansvarar deltagarorganisationen själv för vilka ytterligare filtyper som ska kunna skickas och tas emot.

Filtyper som inte stöds av mottagaren skall kvitteras (REJECTED) enligt följande.

Innehållsvalidering - Kodning av kvitteringsmeddelande

Meddelanden kvitteras enligt Diggs specifikation meddelandekvittens, se R1.

Kvittenskod: REJECTED

Orsakskod: BV

Detaljkod: not-supported

Detaljtext: In contentType, The value 'PNG' is not allowed. | at {path to element}

1..1

content

String

Base64-kodad bilaga (UTF-8). Den binära informationen skall kodas med base64 enligt RFC 4648

Meddelandet inklusive bifogade filer får ej överstiga 30 MB.

Innehållsvalidering - Kodning av kvitteringsmeddelande

Meddelanden kvitteras enligt Diggs specifikation meddelandekvittens, se R1.

Kvittenskod: REJECTED

Orsakskod: BV

Detaljkod: too-long

Detaljtext: Message size to large.

1.1

Meddelandet mottaget och validerat utan avvikelser

ACCEPTED

-

-

Meddelandet mottaget, kvitterat och validerat utan avvikelser.

Meddelandekuvertets struktur och i förekommande fall innehåll kodverksregler etc.

REJECTED

SV

structure

Meddelandet är strukturellt (xsd) felaktigt eller är korrupt.

• Felaktig datatyper etc

Kontroll mot skadlig kod i nyttolast.

REJECTED

BV

forbidden

Felkod REJECTED skall genereras av mottagaren i de fall det är möjligt. En incident behöver skapas om skadlig kod upptäcks.

Skalskydd i form av antivirussystem kan förhindra filhantering genom t.ex. att sätta meddelande i "karantän".

Storleksvalidering (storlek)

REJECTED

BV

too-long

Storleksöverträdelse över fastställd storlek (f.n. > 30mb för hela meddelandet) skall generera ett stoppande fel (REJECTED)

Logisk schemavalidering (schematron)

REJECTED

BV

invariant

Logiska regler eller kodverk följs ej (schematron)

• T.ex. typning är felaktig eller saknas.

MessageId är ej unikt

REJECTED

BV

duplicate

multiple-matches

refToMessageId finns ej

ACCEPTED

-

-

Meddelandet kvitteras med ACCEPTED.

Filtyp (SDK Innehållsspecifikation - contentAsBase64)

REJECTED

BV

Not-supported

Meddelandet skall ej kvitteras, felkod REJECTED. Filtypen stöds ej.

Funktionsadress finns ej

REJECTED

BV

Not-found

Funktionsadress finns ej eller är felaktig.

referens till meddelande (refToMessageId) som är markerat som REJECTED.

REJECTED

BV

not-supported

Meddelandet kan ej levereras och kvitteras pga att meddelandet är marketat som felaktigt (t.ex. pga sändarens time-out).

Felaktig avsändare - Sändarens XHE signatur

REJECTED

SIG

security

Avsändarinformation (organisations-id) är felaktig eller matchar ej XHE-signatur.

Felaktig avsändare - Angiven avsändare felaktig

REJECTED

BV

security

Avsändarinformation är felaktig eller matchar ej.

• Kvittens returneras med detaljer om originalSender inte matchar med avsändande accesspunkts konfiguration.
• Vid scenariot att avsändande organisation inte finns registrerad i SMP bör inte kvittens skickas eftersom kvittensen inte kommer levereras till accesspunkt.

Okrypterat meddelande

REJECTED

SIG

security

Meddelandet skall ej kvitteras, felkod REJECTED. Meddelande är ej krypterat enligt tillämpad transportmodell

R1

Meddelandespecifikation: Meddelandekvittens

R2

Kuverteringsprofil XHE

R3

Transportprofil AS4

R4

Certifikatspublicering - REST-bindning till SMP

R5

Kodlistor – Tekniska specifikationer

R6

SDK Specifikation Validering, felhantering och kvittens