M Self Service Utility Protocols, Identifications, Security Specifications, and Parameters
This appendix gives the values for protocols, identifications, security specifications, and parameters used in the selfservice
utility.
The appendix includes the following sections:
M.1 Protocols
Document protocols, exchange protocols, and transport protocols are listed here.
Document Protocols
-
EDI_X12
-
EDI_EDIFACT
-
HL7
-
RosettaNet
-
Custom
Exchange Protocols
-
AS2
-
MLLP
-
ebMS2
-
ebMS1
-
RNIF20
-
RNIF11
-
AS1
-
Generic-File
-
Generic-AQ
-
Generic-FTP
-
Generic-SFTP
-
Generic-JMS
-
Generic-HTTP
-
Generic-Email
Transport Protocols
-
HTTP
-
File
-
AQ
-
JMS
-
FTP
-
SFTP
-
AS1
-
TCP
-
Email
M.2 Identifications
Any of the these values can be used as Identification name in Self-Service. Name Identifier will be created by Self-Service using the Trading Partner name.
Table M-1 Identifications
Identification Name | Identification ID |
---|---|
Generic Identifier |
Generic |
DUNS |
DUNS |
ebMS Identifier |
ebMS |
AS2 Identifier |
AS2 |
MLLP ID |
MLLP |
AS1 Identifier |
AS1 |
EDI Interchange ID |
InterchangeID |
EDI Interchange ID Qualifier |
InterchangeIDQualifier |
EDI Group ID |
GroupID |
EDI Interchange Internal ID |
InterchangeInternalID |
EDI Interchange Internal Sub ID |
InterchangeInternalSubID |
EDI Group ID Qualifier |
GroupIDQualifier |
HL7 Message Application ID |
Message-ApplicationID |
HL7 Message Application Universal ID |
Message-ApplicationUniversalID |
HL7 Message Application Universal ID Type |
Message-ApplicationUniversalIDType |
HL7 Message Facility ID |
Message-FacilityID |
HL7 Message Facility Universal ID |
Message-FacilityUniversalID |
HL7 Message Facility Universal ID Type |
Message-FacilityUniversalIDType |
HL7 Batch Application ID |
Batch-ApplicationID |
HL7 Batch Application Universal ID |
Batch-ApplicationUniversalID |
HL7 Batch Application Universal ID Type |
Batch-ApplicationUniversalIDType |
HL7 Batch Facility ID |
Batch-FacilityID |
HL7 Batch Facility Universal ID |
Batch-FacilityUniversalID |
HL7 Batch Facility Universal ID Type |
Batch-FacilityUniversalIDType |
HL7 File Application ID |
File-ApplicationID |
HL7 File Application Universal ID |
File-ApplicationUniversalID |
HL7 File Application Universal ID Type |
File-ApplicationUniversalIDType |
HL7 File Facility ID |
File-FacilityID |
HL7 File Facility Universal ID |
File-FacilityUniversalID |
HL7 File Facility Universal ID Type |
File-FacilityUniversalIDType |
M.3 Security Specifications
Any of these values can be used as Identification name in Self-Service.
Table M-2 Security Specifications
Security Specifications Name | Security Specifications ID |
---|---|
SMIME 3.0 with MD5 - RSA |
SMIME-3_0-MD5-RSA |
SMIME 3.0 with SHA1 - RSA |
SMIME-3_0-SHA-RSA |
SMIME 3.0 with SHA256 - RSA |
SMIME-3_0-SHA256-RSA |
SMIME 2.0 with MD5 - RSA |
SMIME-2_0-MD5-RSA |
SMIME 2.0 with SHA1 - RSA |
SMIME-2_0-SHA-RSA |
XMLDSIG with SHA1 - DSA |
XMLDSIG-1_0-SHA-DSA |
XMLDSIG with SHA1 - RSA |
XMLDSIG-1_0-SHA-RSA |
SMIME 3.0 with DES |
SMIME-3_0-DES |
SMIME 3.0 With 3DES |
SMIME-3_0-3DES |
SMIME 3.0 with RC2-40 |
SMIME-3_0-RC2-40 |
SMIME 3.0 with RC2-64 |
SMIME-3_0-RC2-64 |
SMIME 3.0 with RC2-128 |
SMIME-3_0-RC2-128 |
SMIME 2.0 with DES |
SMIME-2_0-DES |
SMIME 2.0 With 3DES |
SMIME-2_0-3DES |
SMIME 2.0 with RC2-40 |
SMIME-2_0-RC2-40 |
SMIME 2.0 with RC2-64 |
SMIME-2_0-RC2-64 |
SMIME 2.0 with RC2-128 |
SMIME-2_0-RC2-128 |
XMLENC with 3DES - RSA-v1.5 |
XMLENC-1_0-3DES-RSA-V1_5 |
XMLENC with AES-128 - RSA-OAEP |
XMLENC-1_0-AES128-RSA-OAEP |
XMLENC with AES-192 - RSA-OAEP |
XMLENC-1_0-AES192-RSA-OAEP |
XMLENC with AES-256 - RSA-OAEP |
XMLENC-1_0-AES256-RSA-OAEP |
M.4 Exchange Protocols Parameter Values
This table lists the valid exchange protocol parameter values.
Table M-3 Exchange Protocols Parameter Values
Exchange | Parameter Value Name | Domain | Required |
---|---|---|---|
AS2 |
Receipt-Delivery-Option |
String, any URL |
No |
AS2 |
Signed-And-Compressed |
Boolean, false (default), true |
No |
MLLP |
ImmediateACK |
String, any of these values - None (default), Default, Simple, Custom |
No |
MLLP |
ImmediateACK-Custom-File |
Absolute File Path |
No |
MLLP |
ImmediateACK-mapAckControlID |
Boolean, false (default), true |
No |
MLLP |
ImmediateACK-MapImmTriggerEvt |
Boolean, false (default), true |
No |
MLLP |
DiscardHL7ACK |
String, any of these values -None (default), AA, AE, AR, CA, CE, CR |
No |
MLLP |
Start-Block-Char |
Hexadecimal, 0x0B(default) |
No |
MLLP |
End-Block-Char |
Hexadecimal, 0x1C(default) |
No |
MLLP |
Carriage-Return-Char |
Hexadecimal, 0x0D(default) |
No |
MLLP |
Identify-TP-by-delivery-channel |
Boolean, false (default), true |
No |
ebMS2.0 |
Duplicate-Elimination |
Boolean, false (default), true |
No |
ebMS2.0 |
messageOrderSemantics |
String |
No |
ebMS2.0 |
PersistDuration |
String |
No |
ebMS2.0 |
SendPartyTypeAndValue |
Boolean, false (default), true |
No |
ebMS1.0 |
Duplicate-Elimination |
Boolean, false (default), true |
No |
ebMS1.0 |
SendPartyTypeAndValue |
Boolean, false (default), true |
No |
AS1 |
Signed-And-Compressed |
Boolean, false (default), true |
No |
M.5 Transport Protocols Parameter Values
This table lists the valid transport protocol parameter values.
Table M-4 Transport protocols parameter Values
Transport | Parameter Name Value | Domain | Required |
---|---|---|---|
HTTP |
url |
String, any URL |
Yes |
HTTP |
user |
String |
No |
HTTP |
password |
String |
No |
HTTP |
additional_headers |
String |
No |
HTTP |
use_proxy |
Boolean, false (default), true |
No |
File |
polling_interval |
Integer, 5(default) |
No |
File |
folder |
String |
Yes |
File |
filename_format |
String |
No |
AQ |
sid |
String, orcl (default) |
No |
AQ |
port |
Integer, 1521(default) |
No |
AQ |
schema |
String |
No |
AQ |
queue_name |
String |
No |
AQ |
password |
String |
No |
AQ |
host |
String |
No |
AQ |
polling_interval |
Integer |
No |
AQ |
recipient |
String |
No |
AQ |
consumer |
String |
No |
AQ |
datasource |
String, either |
No |
JMS |
queue_name |
String |
No |
JMS |
jndi_connection_factory_location |
String |
No |
JMS |
is_topic |
Boolean, false (default), true |
No |
JMS |
is_map_message |
String, Any of these values BYTES,TEXT,MAP |
No |
JMS |
is_map_payload_alone |
Boolean, false (default), true |
No |
JMS |
Subscriber_ID |
String |
No |
JMS |
user |
String |
No |
JMS |
password |
String |
No |
JMS |
polling_interval |
Integer, 5(default) |
No |
FTP |
host |
String |
Yes |
FTP |
polling_interval |
Integer, 5(default) |
No |
FTP |
folder |
String |
Yes |
FTP |
user |
String |
Yes |
FTP |
password |
String |
No |
FTP |
channel_mask |
String, None (default) |
No |
FTP |
cipher_suites |
String |
No |
FTP |
control_port |
Integer |
No |
FTP |
data_port |
Integer |
No |
FTP |
use_proxy |
Boolean, false (default), true |
No |
FTP |
filename_format |
String |
No |
FTP |
sourcefile_encoding |
String |
No |
SFTP |
host |
String |
Yes |
SFTP |
port |
Integer |
No |
SFTP |
polling_interval |
Integer, 5(default) |
No |
SFTP |
folder |
String |
Yes |
SFTP |
user |
String |
Yes |
SFTP |
password |
String |
No |
SFTP |
private_key |
String |
No |
SFTP |
pass_phrase |
String |
No |
SFTP |
use_proxy |
Boolean, false (default), true |
No |
SFTP |
filename_format |
String |
No |
TCP |
sockettype |
String, Either of Server, Client (default) |
No |
TCP |
host |
String |
No |
TCP |
port |
Integer |
No |
TCP |
PermanentConnectionType |
Boolean, false (default), true |
No |
TCP |
Sequencing |
Boolean, false (default), true |
No |
TCP |
pollinterval |
Integer, 10(default) |
No |
TCP |
timeout |
Integer, 300(default) |
No |
|
host |
String |
Yes |
|
password |
String |
No |
|
user |
String |
No |
|
polling_interval |
Integer |
No |
|
content-type |
String |
No |
|
send_as_attachment |
String |
No |
|
folder |
String |
No |
|
email-id |
String |
Yes |
|
subject |
String |
No |
|
server |
String, either of IMAP (default), PoP3 |
Yes |
M.6 Document Protocol Parameter Values
The valid document protocol parameter values are listed.
This section contains the following tables:
-
Table M-5 EDI_X12 Document Protocol Parameter Values
-
Table M-6 EDI_EDIFACT Document Protocol Parameter Values
-
Table M-7 HL7 Document Protocol Parameter Values
-
Table M-8 RosettaNet Document Protocol Parameter Values
-
Table M-9 Custom Document Protocol Parameter Values
-
Table M-10 Common Parameter Values
-
Table M-11 AgrDocType Parameter Values
Table M-5 EDI_X12 Document Protocol Parameter Values
Document | Parameter Value Name | Domain | Required |
---|---|---|---|
Protocol Version |
InterchangeAuthorizationInfoQual |
String, 00(default) |
No |
Protocol Version |
InterchangeAuthorizationInfo |
String |
No |
Protocol Version |
InterchangeSecurityInfoQual |
String, 00(default) |
No |
Protocol Version |
InterchangeSecurityInfo |
String |
No |
Protocol Version |
InterchangeDate |
Date, #SystemDate(YYMMDD)#(default) |
No |
Protocol Version |
InterchangeTime |
Time, #SystemTime(HHMM)#(default) |
No |
Protocol Version |
InterchangeControlStandard_RepeatingSeparator |
String, U (default) |
No |
Protocol Version |
InterchangeControlVersion |
String, 00401(default) |
No |
Protocol Version |
InterchangeAckRequested |
String, 0(default) |
No |
Protocol Version |
InterchangeUsageIndicator |
String, P (default) |
No |
Protocol Version |
InterchangeECSFileBlob |
Absolute file path of ecs |
No |
Protocol Version |
GroupDate |
Date, #SystemDate(CCYYMMDD)# (default) |
No |
Protocol Version |
GroupTime |
Time, #SystemTime(HHMM)#(default) |
No |
Protocol Version |
GroupAgencyCode |
String, X (default) |
No |
Protocol Version |
GroupVersionNumber |
String |
No |
Protocol Version |
GroupECSFileBlob |
Absolute file path of ecs |
No |
Protocol Version |
SegmentDelimiter |
Hexadecimal, 0x7e(default) |
No |
Protocol Version |
ElementDelimiter |
Hexadecimal, 0x2a(default) |
No |
Protocol Version |
SubelementDelimiter |
Hexadecimal, 0x5c (default) |
No |
Protocol Version |
DecimalSeparator |
Hexadecimal, 0x2e (default) |
No |
Protocol Version |
ReplacementChar |
Hexadecimal, 0x7c (default) |
No |
Protocol Version |
RepeatingSeparator |
Hexadecimal, 0x5e (default) |
No |
Type |
GroupID |
String |
Yes |
Type |
TransactionID |
String |
Yes |
Type |
TransactionImplementationReference |
String |
No |
Type |
TransactionPurposeCode |
String |
No |
Definition |
TransactionECSFileBlob |
Absolute file path of ecs |
Yes |
Definition |
DocumentRoutingID |
String |
No |
Definition |
Common Parameter Values (see Table M-10) |
String |
No |
Table M-6 EDI_EDIFACT Document Protocol Parameter Values
Document | Parameter Value Name | Domain | Required |
---|---|---|---|
Protocol Version |
UNACreation |
String, any of these values - always, never, delimiter-based |
No |
Protocol Version |
CharSet |
String, UNOB(default) |
No |
Protocol Version |
InterchangeControlVersion |
String, 1(default) |
No |
Protocol Version |
InterchangeServiceCodeList |
String |
No |
Protocol Version |
InterchangeCharacterEncoding |
String |
No |
Protocol Version |
InterchangeDate |
Date, #SystemDate(YYMMDD)# (default) |
No |
Protocol Version |
InterchangeTime |
Date, #SystemTime(HHMM)# (default) |
No |
Protocol Version |
InterchangeRecipientRefPassword |
String |
No |
Protocol Version |
InterchangeRecipientRefPasswordQual |
String |
No |
Protocol Version |
InterchangeApplicationRef |
String |
No |
Protocol Version |
InterchangeProcessingPriority |
String |
No |
Protocol Version |
InterchangeAgreementIdentifier |
String |
No |
Protocol Version |
InterchangeTestIndicator |
String |
No |
Protocol Version |
InterchangeECSFileBlob |
Absolute file path of ecs |
No |
Protocol Version |
FunctionalGroupCreation |
String |
No |
Protocol Version |
GroupDate |
Date, #SystemDate(YYMMDD)# (default) |
No |
Protocol Version |
GroupTime |
Time, #SystemTime(HHMM)# (default) |
No |
Protocol Version |
GroupAgencyCode |
String, UN (default) |
No |
Protocol Version |
GroupAssociationCode |
String |
No |
Protocol Version |
GroupApplicationPassword |
String |
No |
Protocol Version |
GroupECSFileBlob |
Absolute file path of ecs |
No |
Protocol Version |
SegmentDelimiter |
Hexadecimal, 0x27 (default) |
No |
Protocol Version |
ElementDelimiter |
Hexadecimal, 0x2b (default) |
No |
Protocol Version |
SubelementDelimiter |
Hexadecimal, 0x3a (default) |
No |
Protocol Version |
DecimalSeparator |
Hexadecimal, 0x2e (default) |
No |
Protocol Version |
ReleaseCharacter |
Hexadecimal, 0x3f (default) |
No |
Protocol Version |
ReplacementChar |
Hexadecimal, 0x7c (default) |
No |
Protocol Version |
RepeatingSeparator |
Hexadecimal, 0x2a (default) |
No |
Type |
GroupID |
String |
Yes |
Type |
TransactionControllingAgency |
String |
No |
Type |
TransactionAssociationAssignedCode |
String |
No |
Type |
TransactionCommonAccessRef |
String |
No |
Definition |
TransactionECSFileBlob |
Absolute file path of ecs |
Yes |
Definition |
DocumentRoutingID |
String |
No |
Definition |
FAAssocAssignedCode |
String |
No |
Definition |
FAMessageVersionNumber |
String |
No |
Definition |
FAMessageReleaseNumber |
String |
No |
Definition |
RemoveFASegments |
String |
No |
Definition |
Common Parameter Values (see Table M-10) |
String |
No |
Table M-7 HL7 Document Protocol Parameter Values
Document | Parameter Name Value | Domain | Required |
---|---|---|---|
Protocol Version |
Security |
String |
No |
Protocol Version |
ProcessingID |
String, P (default) |
No |
Protocol Version |
AcceptacknowledgmentType |
String, AL (default) |
No |
Protocol Version |
AppacknowledgmentType |
String, AL (default) |
No |
Protocol Version |
CountryCode |
String, US (default) |
No |
Protocol Version |
CharacterSet |
String, ASCII (default) |
No |
Protocol Version |
BatchCreation |
Boolean, false (default), true |
No |
Protocol Version |
BatchECSFile |
Absolute file path of ecs |
No |
Protocol Version |
FileCreation |
Boolean, false (default), true |
N o |
Protocol Version |
FileECSFile |
Absolute file path of ecs |
No |
Protocol Version |
InternatCodeID |
String |
No |
Protocol Version |
InternatCodeText |
String |
No |
Protocol Version |
InternatCodeSystem |
String |
No |
Protocol Version |
InternatCodeAlternateID |
String |
No |
Protocol Version |
InternatCodeAlternateText |
String |
No |
Protocol Version |
InternatCodeAlternateSystem |
String |
No |
Protocol Version |
InternationalVersionID |
String |
No |
Protocol Version |
InternationalVersionIDText |
String |
No |
Protocol Version |
InternationalVersionIDSystem |
String |
No |
Protocol Version |
InternationalVersionIDAlternateID |
String |
N o |
Protocol Version |
InternationalVersionIDAlternateText |
String |
No |
Protocol Version |
InternationalVersionIDAlternateSystem |
String |
No |
Protocol Version |
ElementDelimiter |
Hexadecimal, 0x7c (default) |
No |
Protocol Version |
ReleaseCharacter |
Hexadecimal, 0x5c (default) |
No |
Protocol Version |
Repeating-Separator |
Hexadecimal, 0x7e (default) |
No |
Protocol Version |
SegmentDelimiter |
Hexadecimal, 0x0d (default) |
No |
Protocol Version |
SubcomponentDelimiter |
Hexadecimal, 0x26 (default) |
No |
Protocol Version |
SubelementDelimiter |
Hexadecimal, 0x5e (default) |
N o |
Protocol Version |
BatchSecurity |
String |
No |
Protocol Version |
FileSecurity |
String |
No |
Protocol Version |
FileDate |
Date, #SystemDateTime(CCYYMMDDHHMM)# (default) |
No |
Protocol Version |
BatchDate |
Date, #SystemDateTime(CCYYMMDDHHMM)# (default) |
No |
Type |
hl7-gen-Ack |
Boolean, false (default), true |
No |
Type |
hl7-mapAckControlID |
Boolean, false (default), true |
No |
Type |
hl7-acceptacknowledgment |
String, Any of these values - None, AL, ER, SU |
No |
Definition |
MessageECSFileBlob |
Absolute file path of ecs |
Yes |
Definition |
DocumentRoutingID |
String |
No |
Definition |
Common Parameter Values (see Table M-10) |
String |
No |
Table M-8 RosettaNet Document Protocol Parameter Values
Document | Parameter Value Name | Domain | Required |
---|---|---|---|
Type |
FromRole |
String |
Yes |
Type |
ToRole |
String |
Yes |
Type |
ServiceHeader |
String |
Yes |
Type |
ToService |
String |
Yes |
Type |
BusinessTransaction |
String |
Yes |
Type |
ServiceHeader |
String |
Yes |
Type |
CollaborationTimeToPerform |
String |
Yes |
Type |
CollaborationName |
String |
Yes |
Type |
CollaborationCode |
String |
Yes |
Definition |
DocumentRoutingID |
String |
No |
Definition |
DTDXSDNamespaceConversion |
String, any of these values - Both, Inbound, Outbound, None |
No |
Definition |
Common Parameter Values (see Table M-10) |
String |
No |
Table M-9 Custom Document Protocol Parameter Values
Document | Parameter Value Name | Domain | Required |
---|---|---|---|
Type |
ActionName |
String |
No |
Type |
Service |
String |
No |
Type |
ServiceType |
String |
No |
Type |
FromRole |
String |
No |
Type |
ToRole |
String |
No |
Definition |
IdentificationExpression |
String |
No |
Definition |
IdentificationExpressionValue |
String |
No |
Definition |
DTDXSDNamespaceConversion |
String, any of these values - None, Both, Inbound, Outbound |
No |
Definition |
IdentificationStartPosition |
String |
No |
Definition |
IdentificationEndPosition |
String |
No |
Definition |
FlatIdentificationExpressionValue |
String |
No |
Definition |
DocumentRoutingID |
String |
No |
Definition |
Common Parameter Values (see Table M-10) |
String |
No |
Table M-10 Common Parameter Values
Parameter Value Name | Domain | Required |
---|---|---|
XPathName1 |
String, XPathName1 (default) |
No |
XPathExpression1 |
String |
No |
XPathName2 |
String, XPathName2 (default) |
No |
XPathExpression2 |
String |
No |
XPathName3 |
String, XpathName3 (default) |
No |
XPathExpression3 |
String |
No |
CorrelationFromXPathName |
String, CorrelationFromXPathName (default) |
No |
CorrelationFromXPathXPR |
String |
No |
CorrelationToXPathName |
String, CorrelationToXPathName (default) |
No |
CorrelationToXPathXPR |
String |
No |
Table M-11 AgrDocType Parameter Values
Parameter Value Name | Domain | Required | Applicable Documents |
---|---|---|---|
validate |
boolean |
No |
X12, EDIFACT, HL7, RosettaNet, Custom |
translate |
boolean |
No |
X12, EDIFACT, HL7 |
fa |
boolean |
No |
X12, EDIFACT, HL7 |