Trading Networks 10.3 | Administering and Monitoring B2B Transactions | Trading Networks Built-In Services Reference | Route Folder | Summary of Elements in this Folder | wm.tn.route:create
 
wm.tn.route:create
Creates a processing rule object.
Input Parameters
name
String Name of the processing rule.
description
String (optional) Description of the processing rule.
disabled
String (optional) Status of the processing rule. Valid values are:
*true - Processing rule is disabled.
*false - Processing rule is not disabled.
senderId
String The internal partner ID of the sender of the document. Valid values are Any, Unknown, and My Enterprise.
receiverId
String The internal partner ID of the receiver of the document. Valid values are Any, Unknown, and My Enterprise.
docTypeId
String Document type identifier for the resulting document. To determine the document type identifier of a document type, invoke the wm.tn.doctype:list service. The wm.tn.doctype:list service lists the names and IDs of all your document types.
userStatus
String (optional) User status of the transaction.
hasErrors
String (optional) Whether a transaction has errors. Valid values are:
*yes - Transaction has errors.
*no - Transaction does not have errors.
*don't care - Use the setting specified in the document type for the transaction.
verify
String (optional) Whether to verify the signature of the transaction. Valid values are:
*yes - Transaction should be verified.
*no - Transaction should not be verified.
*don't care - Use the setting specified in the document type for the transaction.
validate
String (optional) Whether to validate the structure of the transaction. Valid values are:
*yes - Transaction should be validated.
*no - Transaction should not be validated.
*don't care - Use the setting specified in the document type for the transaction.
persist
String (optional) Whether to save the transaction to the database. Valid values are:
*yes - Transaction should be saved to the database.
*no - Transaction should not be saved to the database.
*only if unique - Transaction should be saved only if unique.
*don't care - Use the setting specified in the document type for the transaction.
persistOption?
String (optional) The data that Trading Networks has to save. Valid values are:
*content, attributes, and activity log - Trading Networks saves all data associated with the transaction; that is, Trading Networks saves the document content, the values extracted for the custom attributes, and the activity log entries.
*content only - Trading Networks saves only the document content. Trading Networks does not save the values of any extracted custom attributes or the related activity log entries.
*attributes only - Trading Networks saves only the values it extracts for the custom attributes. Trading Networks does not save the document content or the related activity log entries.
*activity log only - Trading Networks saves only the activity log entries. Trading Networks does not save the document content or the values of any extracted custom attributes.
*content and attributes - Trading Networks saves the document content and the values of all extracted custom attributes. Trading Networks does not save the related activity log entries.
*content and activity log - Trading Networks saves the document content and the activity log entries. Trading Networks does not save the values of extracted custom attributes.
*attributes and activity log - Trading Networks saves the values of all extracted custom attributes and the activity log entries. Trading Networks does not save the document content.
*don't care - Trading Networks refers to the settings specified in the processing rule to determine the data to save.
*persist none Trading Networks saves no data associated with the transaction.
unique
String (optional) Whether to check the uniqueness of a transaction.
Valid values are:
*DocumentID only - The document is checked for uniqueness. To determine if the document is unique, Trading Networks determines whether another document with the same document ID exists in the database. (The document ID is a user-defined, external identifier for the document.)
*DocumentID and sender - The document is checked for uniqueness. To determine if the document is unique, Trading Networks determines whether another document with the same document ID and sender exists in the database.
*DocumentID, sender and receiver - The document is checked for uniqueness. To determine if the document is unique, Trading Networks determines whether another document with the same document ID, sender, and receiver exists in the database.
*DocumentID, sender and document type - The document is checked for uniqueness. To determine if the document is unique, Trading Networks determines whether another document with the same document ID, sender, and TN document type exists in the database.
*don't care - Use the setting specified in the TN document type for the document being processed.
alertPartner
String (optional) The partner to whom Trading Networks should send the email alert. Valid values are B2B, SENDER, and RECEIVER.
alertContactType
String (optional) The contact type of the partner to whom Trading Networks sends the email alert. Valid values are Administrative and Technical. You can create additional ones with the wm.tn.dictionary:addContactType service.
alertSubject
String (optional) Subject of the email alert.
alertMessage
String (optional) Message sent in the email alert.
responseMessage
String (optional) Response message received in response to the email alert.
responseType
String (optional) Content type of the response message. Valid values are text/plain and text/xml.
newUserStatus
String (optional) New user status of the transaction.
serviceName
String (optional) Name of the service that Trading Networks will execute as a part of post processing action defined in a processing rule.
serviceInput
String (optional) Inputs to the service.
serviceType
String (optional) Type of the service. Valid values are sync, async, and reliable.
deliverUsing
String (optional) The delivery protocol that the partner prefers you to use while sending documents. Valid values are:
*Preferred protocol
*Primary HTTP
*Primary HTTPS
*Primary Email
*Primary FTP
*Secondary HTTP
*Secondary HTTPS
*Secondary Email
*Secondary FTP
*Queue for Polling
*Queue for Delivery
deliveryQueue
String (optional) Registered scheduled delivery queue. Valid value is Receiver's queue.
attribConditions
String (optional) Attribute criteria to use to match processing rule.
attribute
String Internal ID of the custom attribute.
operation
String Operation to use in matching processing rules. Valid values are:
*IS NULL
*IS NOT NULL
*=
*<>
*>=
*<=
*>
*<
*CONTAINS
*BEFORE
*AFTER
*INCLUDES
value
String (optional) Value to check while matching processing rules.
Output Parameters
rule
Object Processing rule created.