This appendix gives the values for protocols, identifications, security specifications, and parameters used in the selfservice utility.
The appendix contains the following topics:
| Exchange Protocol Name |
|---|
|
AS2 |
|
MLLP |
|
ebMS2 |
|
ebMS1 |
|
RNIF20 |
|
RNIF11 |
|
AS1 |
|
Generic-File |
|
Generic-AQ |
|
Generic-FTP |
|
Generic-SFTP |
|
Generic-JMS |
|
Generic-HTTP |
|
Generic-Email |
Any of the following columns value can be used as Identification name in Self-Service. Name Identifier will be created by Self-Service using the Trading Partner name.
| 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 |
Any of the following columns value can be used as Identification name in Self-Service.
Table J-5 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 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 |
Table J-6 Exchange Protocols Parameter Values
| Exchange | Parameter Value Name | Domain | Required |
|---|---|---|---|
|
AS2 |
Receipt-Delivery-Option |
String, any URL |
No |
|
Signed-And-Compressed |
Boolean, false (default), true |
No |
|
|
MLLP |
ImmediateACK |
String, any of these values - None(default), Default, Simple, Custom |
No |
|
ImmediateACK-Custom-File |
Absolute File Path |
No |
|
|
ImmediateACK-mapAckControlID |
Boolean, false (default), true |
No |
|
|
ImmediateACK-MapImmTriggerEvt |
Boolean, false (default), true |
No |
|
|
DiscardHL7ACK |
String, any of these values -None (default), AA, AE, AR, CA, CE, CR |
No |
|
|
Start-Block-Char |
Hexadecimal, 0x0B(default) |
No |
|
|
End-Block-Char |
Hexadecimal, 0x1C(default) |
No |
|
|
Carriage-Return-Char |
Hexadecimal, 0x0D(default) |
No |
|
|
Identify-TP-by-delivery-channel |
Boolean, false (default), true |
No |
|
|
ebMS2.0 |
Duplicate-Elimination |
Boolean, false (default), true |
No |
|
messageOrderSemantics |
String |
No |
|
|
PersistDuration |
String |
No |
|
|
SendPartyTypeAndValue |
Boolean, false (default), true |
No |
|
|
ebMS1.0 |
Duplicate-Elimination |
Boolean, false (default), true |
No |
|
SendPartyTypeAndValue |
Boolean, false (default), true |
No |
|
|
AS1 |
Signed-And-Compressed |
Boolean, false (default), true |
No |
| Transport | Parameter Name Value | Domain | Required |
|---|---|---|---|
|
HTTP |
url |
String, any URL |
Yes |
|
user |
String |
No |
|
|
password |
String |
No |
|
|
additional_headers |
String |
No |
|
|
use_proxy |
Boolean, false (default), true |
No |
|
|
File |
polling_interval |
Integer, 5(default) |
No |
|
folder |
String |
Yes |
|
|
filename_format |
String |
No |
|
|
AQ |
sid |
String, orcl(default) |
No |
|
port |
Integer, 1521(default) |
No |
|
|
schema |
String |
No |
|
|
queue_name |
String |
No |
|
|
password |
String |
No |
|
|
host |
String |
No |
|
|
polling_interval |
Integer |
No |
|
|
recipient |
String |
No |
|
|
consumer |
String |
No |
|
|
datasource |
String, either |
No |
|
|
JMS |
queue_name |
String |
No |
|
jndi_connection_factory_location |
String |
No |
|
|
Is_topic |
Boolean, false (default), true |
No |
|
|
is_map_message |
String, Any of these values BYTES,TEXT,MAP |
No |
|
|
is_map_payload_alone |
Boolean, false (default), true |
No |
|
|
Subscriber_ID |
String |
No |
|
|
user |
String |
No |
|
|
password |
String |
No |
|
|
polling_interval |
Integer, 5(default) |
No |
|
|
FTP |
host |
String |
Yes |
|
polling_interval |
Integer, 5(default) |
No |
|
|
folder |
String |
Yes |
|
|
user |
String |
Yes |
|
|
password |
String |
No |
|
|
channel_mask |
String, None (default) |
No |
|
|
cipher_suites |
String |
No |
|
|
control_port |
Integer |
No |
|
|
data_port |
Integer |
No |
|
|
use_proxy |
Boolean, false (default), true |
No |
|
|
filename_format |
String |
No |
|
|
sourcefile_encoding |
String |
No |
|
|
SFTP |
host |
String |
Yes |
|
port |
Integer |
No |
|
|
polling_interval |
Integer, 5(default) |
No |
|
|
folder |
String |
Yes |
|
|
user |
String |
Yes |
|
|
password |
String |
No |
|
|
private_key |
String |
No |
|
|
pass_phrase |
String |
No |
|
|
use_proxy |
Boolean, false (default), true |
No |
|
|
filename_format |
String |
No |
|
|
TCP |
sockettype |
String, Either of Server, Client (default) |
No |
|
host |
String |
No |
|
|
port |
Integer |
No |
|
|
PermanentConnectionType |
Boolean, false (default), true |
No |
|
|
Sequencing |
Boolean, false (default), true |
No |
|
|
pollinterval |
Integer, 10(default) |
No |
|
|
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 |
This section conatins the following tables:
Table J-8 EDI_X12 Document Protocol Parameter Values
| Document | Parameter Value Name | Domain | Required |
|---|---|---|---|
|
Document Protocol Version |
InterchangeAuthorizationInfoQual |
String, 00(default) |
No |
|
InterchangeAuthorizationInfo |
String |
No |
|
|
InterchangeSecurityInfoQual |
String, 00(default) |
No |
|
|
InterchangeSecurityInfo |
String |
No |
|
|
InterchangeDate |
Date, #SystemDate(YYMMDD)#(default) |
No |
|
|
InterchangeTime |
Time, #SystemTime(HHMM)#(default) |
No |
|
|
InterchangeControlStandard_RepeatingSeparator |
String, U (default) |
No |
|
|
InterchangeControlVersion |
String, 00401(default) |
No |
|
|
InterchangeAckRequested |
String, 0(default) |
No |
|
|
InterchangeUsageIndicator |
String, P (default) |
No |
|
|
InterchangeECSFileBlob |
Absolute file path of ecs |
No |
|
|
GroupDate |
Date, #SystemDate(CCYYMMDD)# (default) |
No |
|
|
GroupTime |
Time, #SystemTime(HHMM)#(default) |
No |
|
|
GroupAgencyCode |
String, X (default) |
No |
|
|
GroupVersionNumber |
String |
No |
|
|
GroupECSFileBlob |
Absolute file path of ecs |
No |
|
|
SegmentDelimiter |
Hexadecimal, 0x7e(default) |
No |
|
|
ElementDelimiter |
Hexadecimal, 0x2a(default) |
No |
|
|
SubelementDelimiter |
Hexadecimal, 0x5c (default) |
No |
|
|
DecimalSeparator |
Hexadecimal, 0x2e (default) |
No |
|
|
ReplacementChar |
Hexadecimal, 0x7c (default) |
No |
|
|
RepeatingSeparator |
Hexadecimal, 0x5e (default) |
No |
|
|
Document Type |
GroupID |
String |
Yes |
|
TransactionID |
String |
Yes |
|
|
TransactionImplementationReference |
String |
No |
|
|
TransactionPurposeCode |
String |
No |
|
|
Document Definition |
TransactionECSFileBlob |
Absolute file path of ecs |
Yes |
|
DocumentRoutingID |
String |
No |
|
|
Common Parameter Values (see Table J-13, "Common Parameter Values") |
|||
Table J-9 EDI_EDIFACT Document Protocol Parameter Values
| Document | Parameter Value Name | Domain | Required |
|---|---|---|---|
|
Document Protocol Version |
UNACreation |
String, any of these values - always, never, delimiter-based |
No |
|
CharSet |
String, UNOB(default) |
No |
|
|
InterchangeControlVersion |
String, 1(default) |
No |
|
|
InterchangeServiceCodeList |
String |
No |
|
|
InterchangeCharacterEncoding |
String |
No |
|
|
InterchangeDate |
Date, #SystemDate(YYMMDD)# (default) |
No |
|
|
InterchangeTime |
Date, #SystemTime(HHMM)# (default) |
No |
|
|
InterchangeRecipientRefPassword |
String |
No |
|
|
InterchangeRecipientRefPasswordQual |
String |
No |
|
|
InterchangeApplicationRef |
String |
No |
|
|
InterchangeProcessingPriority |
String |
No |
|
|
InterchangeAgreementIdentifier |
String |
No |
|
|
InterchangeTestIndicator |
String |
No |
|
|
InterchangeECSFileBlob |
Absolute file path of ecs |
No |
|
|
FunctionalGroupCreation |
String |
No |
|
|
GroupDate |
Date, #SystemDate(YYMMDD)# (default) |
No |
|
|
GroupTime |
Time, #SystemTime(HHMM)# (default) |
No |
|
|
GroupAgencyCode |
String, UN (default) |
No |
|
|
GroupAssociationCode |
String |
No |
|
|
GroupApplicationPassword |
String |
No |
|
|
GroupECSFileBlob |
Absolute file path of ecs |
No |
|
|
SegmentDelimiter |
Hexadecimal, 0x27 (default) |
No |
|
|
ElementDelimiter |
Hexadecimal, 0x2b (default) |
No |
|
|
SubelementDelimiter |
Hexadecimal, 0x3a (default) |
No |
|
|
DecimalSeparator |
Hexadecimal, 0x2e (default) |
No |
|
|
ReleaseCharacter |
Hexadecimal, 0x3f (default) |
No |
|
|
ReplacementChar |
Hexadecimal, 0x7c (default) |
No |
|
|
RepeatingSeparator |
Hexadecimal, 0x2a (default) |
No |
|
|
Document Type |
GroupID |
String |
Yes |
|
TransactionControllingAgency |
String |
No |
|
|
TransactionAssociationAssignedCode |
String |
No |
|
|
TransactionCommonAccessRef |
String |
No |
|
|
Document Definition |
TransactionECSFileBlob |
Absolute file path of ecs |
Yes |
|
DocumentRoutingID |
String |
No |
|
|
FAAssocAssignedCode |
String |
No |
|
|
FAMessageVersionNumber |
String |
No |
|
|
FAMessageReleaseNumber |
String |
No |
|
|
RemoveFASegments |
String |
No |
|
|
Common Parameter Values (see Table J-13, "Common Parameter Values") |
|||
Table J-10 HL7 Document Protocol Parameter Values
| Document | Parameter Name Value | Domain | Required |
|---|---|---|---|
|
Document Protocol Version |
Security |
String |
No |
|
ProcessingID |
String, P (default) |
No |
|
|
AcceptacknowledgmentType |
String, AL (default) |
No |
|
|
AppacknowledgmentType |
String, AL (default) |
No |
|
|
CountryCode |
String, US (default) |
No |
|
|
CharacterSet |
String, ASCII (default) |
No |
|
|
BatchCreation |
Boolean, false (default), true |
No |
|
|
BatchECSFile |
Absolute file path of ecs |
No |
|
|
FileCreation |
Boolean, false (default), true |
N o |
|
|
FileECSFile |
Absolute file path of ecs |
No |
|
|
InternatCodeID |
String |
No |
|
|
InternatCodeText |
String |
No |
|
|
InternatCodeSystem |
String |
No |
|
|
InternatCodeAlternateID |
String |
No |
|
|
InternatCodeAlternateText |
String |
No |
|
|
InternatCodeAlternateSystem |
String |
No |
|
|
InternationalVersionID |
String |
No |
|
|
InternationalVersionIDText |
String |
No |
|
|
InternationalVersionIDSystem |
String |
No |
|
|
InternationalVersionIDAlternateID |
String |
N o |
|
|
InternationalVersionIDAlternateText |
String |
No |
|
|
InternationalVersionIDAlternateSystem |
String |
No |
|
|
ElementDelimiter |
Hexadecimal, 0x7c (default) |
No |
|
|
ReleaseCharacter |
Hexadecimal, 0x5c (default) |
No |
|
|
Repeating-Separator |
Hexadecimal, 0x7e (default) |
No |
|
|
SegmentDelimiter |
Hexadecimal, 0x0d (default) |
No |
|
|
SubcomponentDelimiter |
Hexadecimal, 0x26 (default) |
No |
|
|
SubelementDelimiter |
Hexadecimal, 0x5e (default) |
N o |
|
|
BatchSecurity |
String |
No |
|
|
FileSecurity |
String |
No |
|
|
FileDate |
Date, #SystemDateTime(CCYYMMDDHHMM)# (default) |
No |
|
|
BatchDate |
Date, #SystemDateTime(CCYYMMDDHHMM)# (default) |
No |
|
|
Document Type |
hl7-gen-Ack |
Boolean, false (default), true |
No |
|
hl7-mapAckControlID |
Boolean, false (default), true |
No |
|
|
hl7-acceptacknowledgment |
String, Any of these values - None, AL, ER, SU |
No |
|
|
Document Definition |
MessageECSFileBlob |
Absolute file path of ecs |
Yes |
|
DocumentRoutingID |
String |
No |
|
|
Common Parameter Values (see Table J-13, "Common Parameter Values") |
|||
Table J-11 RosettaNet Document Protocol Parameter Values
| Document | Parameter Value Name | Domain | Required |
|---|---|---|---|
|
Document Type |
FromRole |
String |
Yes |
|
ToRole |
String |
Yes |
|
|
ServiceHeader |
String |
Yes |
|
|
ToService |
String |
Yes |
|
|
BusinessTransaction |
String |
Yes |
|
|
ServiceHeader |
String |
Yes |
|
|
CollaborationTimeToPerform |
String |
Yes |
|
|
CollaborationName |
String |
Yes |
|
|
CollaborationCode |
String |
Yes |
|
|
Document Definition |
DocumentRoutingID |
String |
No |
|
DTDXSDNamespaceConversion |
String, any of these values - Both, Inbound, Outbound, None |
No |
|
|
Common Parameter Values (see Table J-13, "Common Parameter Values") |
|||
Table J-12 Custom Document Protocol Parameter Values
| Document | Parameter Value Name | Domain | Required |
|---|---|---|---|
|
Document Type |
ActionName |
String |
No |
|
Service |
String |
No |
|
|
ServiceType |
String |
No |
|
|
FromRole |
String |
No |
|
|
ToRole |
String |
No |
|
|
Document Definition |
IdentificationExpression |
String |
No |
|
IdentificationExpressionValue |
String |
No |
|
|
DTDXSDNamespaceConversion |
String, any of these values - None, Both, Inbound, Outbound |
No |
|
|
IdentificationStartPosition |
String |
No |
|
|
IdentificationEndPosition |
String |
No |
|
|
FlatIdentificationExpressionValue |
String |
No |
|
|
DocumentRoutingID |
String |
No |
|
|
Common Parameter Values (see Table J-13, "Common Parameter Values") |
|||
Table J-13 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 |