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:
Protocols
Document protocols, exchange protocols, and transport protocols are listed here.
Document Protocols
-
OAG
-
UCCNET
-
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
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 |
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 |
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 |
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 |
Document Protocol Parameter Values
The valid document protocol parameter values are listed.
This section contains the following tables:
Table M-5 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-7) |
String |
No |
Table M-6 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-7) |
String |
No |
Table M-7 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-8 AgrDocType Parameter Values
| Parameter Value Name | Domain | Required | Applicable Documents |
|---|---|---|---|
|
validate |
boolean |
No |
Depends on document protocol |
|
translate |
boolean |
No |
X12, EDIFACT, HL7 |
|
fa |
boolean |
No |
X12, EDIFACT, HL7 |