Deployable Assets and Configurations
Deployable assets and configurations for webMethods Integration Server
JSON Document Type Properties
| Configuration/Asset Type | Asset/Configuration |
|---|---|
| ACLs | Configuration |
| Groups | Configuration |
| Consumer Web service endpoint alias | Configuration |
| Extended Settings * | Configuration |
| Global Variables | Configuration |
| JMS aliases | Configuration |
| JNDI aliases | Configuration |
| Keystores | Configuration |
| Provider Web service endpoint alias | Configuration |
| Resources Settings * | Configuration |
| SMTP settings * | Configuration |
| Truststores | Configuration |
| Users | Configuration |
| webMethods messaging | Configuration |
| Flow Service | Asset |
| Java™ Service | Asset |
| Map Service | Asset |
| OData Service | Asset |
| Adapter Service | Asset |
| .NET Service | Asset |
| C Service | Asset |
| Adapter Notification | Asset |
| Document Type | Asset |
| Flat File Dictionary | Asset |
| Flat File Schema | Asset |
| JMS Trigger | Asset |
| REST API Descriptor | Asset |
| REST Resource | Asset |
| Schema | Asset |
| Specification | Asset |
| Web Service Descriptor | Asset |
| webMethods Messaging Trigger | Asset |
| XML Document Type | Asset |
| XSLT Service | Asset |
| JSON Document Type | Asset |
| * Restart Required |
You can view the JSON document type properties from the JSON schema section of the properties view. When you deploy a JSON document type from Integration Server, the constraints applied to the elements and attributes are preserved as part of the validation under the JSON schema section.
| Property | Description |
|---|---|
| Schema | Displays the version of the JSON Schema standard to which the schema conforms. |
| ID | Displays a URI for the schema, and the base URI that other URI references within the schema are resolved against. |
| Title | A title for a JSON document type or field represented by the JSON schema. |
| Description | Description of a JSON document type or field. |
| Read only | This property corresponds to the readOnly JSON schema annotation. It
indicates if the value (of the selected field or document) is managed by Integration Server. |
| Write only | This property corresponds to the writeOnly JSON schema annotation. It
determines if the selected field or document is retrieved from Integration Server. |
| Validations | Specifies the requirements for successful validation of JSON schema. Validation keywords differ based on the data type used in the JSON schema. |
Deployable assets and configurations for webMethods CloudStreams
You cannot deploy webMethods CloudStreams runtime assets such as database that you have created, verified, and tested to IBM® webMethods Cloud Container.
| Configuration/Asset Type | Asset/Configuration |
|---|---|
| CloudStreams Connector Services | Asset |
| CloudStreams Connection | Asset |
| OAuth token | Asset |
| Streaming | Asset |
| CloudStreams Provider Packages | Asset |
| Subscriber | Asset |
| * Restart Required |
Deployable configurations for Universal Messaging
| Configuration Type | Asset/Configuration |
|---|---|
| Channels | Transient |
| Simple | |
| Reliable | |
| Persistent | |
| Mixed | |
| Off-Heap | |
| Paged | |
| JNDI Connection Factories | Connection Factory > Shared Durable Type |
| TopicConnection Factory > Shared Durable Type | |
| Queue Connection Factory | |
| XA Connection Factory | |
| JNDI Destinations | Topic |
| Queue | |
| Queues | |
| Simple | |
| Reliable | |
| Persistent | |
| Mixed | |
| Off-Heap | |
| Paged | |
| * Restart Required |
Working with Trading Networks Built-In Services on IBM webMethods Cloud Container
IBM webMethods Cloud Container supports the following Trading Networks services. For complete details of service parameters of each of these Trading Networks services, see webMethods Trading Networks Built-In Services Reference.
| Trading Networks Folder Name | Supported Trading Networks Services |
|---|---|
| dictionary | wm.tn.dictionary:getContactTypes |
| wm.tn.dictionary:getFieldDefinitions | |
| wm.tn.dictionary:getFieldGroups | |
| wm.tn.dictionary:getIDTypes | |
| doc | wm.tn.doc.xml:bizdocToRecord |
| wm.tn.doc.xml:recordToBizdoc | |
| wm.tn.doc:changeStatus | |
| wm.tn.doc:createNewEnvelope | |
| wm.tn.doc:getContentPart | |
| wm.tn.doc:getDeliveryContent | |
| wm.tn.doc:getEvents | |
| wm.tn.doc:getSenderReceiver | |
| wm.tn.doc:persist | |
| wm.tn.doc:relateDocuments | |
| wm.tn.doc:resubmit | |
| wm.tn.doc:resubmits | |
| wm.tn.doc:setAttribute | |
| wm.tn.doc:sign | |
| wm.tn.doc:updateAttributes | |
| wm.tn.doc:updateComments | |
| wm.tn.doc:updateSystemAttributes | |
| wm.tn.doc:verify | |
| wm.tn.doc:view | |
| wm.tn.doc:viewAll | |
| wm.tn.doc:viewAs | |
| docattr | wm.tn.docattr:list |
| wm.tn.docattr:listTypesForAttribute | |
| doctype | wm.tn.doctype:list |
| wm.tn.doctype:view | |
| log | wm.tn:log |
| profile | wm.tn.profile:getExtendedFields |
| wm.tn.profile:getExternalID | |
| wm.tn.profile:getExternalIDs | |
| wm.tn.profile:getHostProfile | |
| wm.tn.profile:getInternalID | |
| wm.tn.profile:getInternalIDsForUser | |
| wm.tn.profile:getProfile | |
| wm.tn.profile:getProfileMappings | |
| wm.tn.profile:getProfileSummaries | |
| wm.tn.profile:getProfileSummary | |
| wm.tn.profile:getUserProfiles | |
| wm.tn.profile:getUserProfilesSummaries | |
| wm.tn.profile:getUsersForPartner | |
| queuing | wm.tn.queuing:getQueuedTask |
| wm.tn.queuing:getRegisteredQueues | |
| wm.tn.queuing:listQueuedTasks | |
| wm.tn.queuing:queueDocument | |
| wm.tn.queuing:updateQueuedTask | |
| rec | wm.tn.rec:ActivityLogEntry |
| wm.tn.rec:Address | |
| wm.tn.rec:BizDocAttribute | |
| wm.tn.rec:BizDocContentPart | |
| wm.tn.rec:BizDocContentPartCriteria | |
| wm.tn.rec:BizDocEnvelope | |
| wm.tn.rec:BizDocErrorSet | |
| wm.tn.rec:BizDocType | |
| wm.tn.rec:BizDocTypeSummary | |
| wm.tn.rec:Contact | |
| wm.tn.rec:Corporation | |
| wm.tn.rec:Delivery | |
| wm.tn.rec:DeliveryServiceOutput | |
| wm.tn.rec:ExternalID | |
| wm.tn.rec:Field | |
| wm.tn.rec:FieldMetaData | |
| wm.tn.rec:PreProcessingFlags | |
| wm.tn.rec:ProcessingService | |
| wm.tn.rec:Profile | |
| wm.tn.rec:ProfileSummary | |
| wm.tn.rec:ReliableProcessingService | |
| wm.tn.rec:ReliableServiceOutput | |
| wm.tn.rec:Task | |
| wm.tn.rec:TPA | |
| wm.tn.rec:TpaError | |
| reroute | wm.tn:reroute |
| route | wm.tn.route:containsRuleName |
| wm.tn.route:getAnyTask | |
| wm.tn.route:getFirstMatch | |
| wm.tn.route:getLastChangeID | |
| wm.tn.route:getRule | |
| wm.tn.route:list | |
| wm.tn.route:load | |
| wm.tn.route:mergeFlags | |
| wm.tn.route:preroute | |
| wm.tn.route:route | |
| wm.tn.route:routeBizdoc | |
| security | wm.tn.security:getSSLKeyAndChain |
| submit | wm.tn:submit |
| task | wm.tn.task:getAnyTask |
| wm.tn.task:getTaskStatus | |
| wm.tn.task:removeTask | |
| wm.tn.task:restartTask | |
| wm.tn.task:stopTask | |
| tpa | wm.tn.tpa:getTPA |
| util | wm.tn.util:longToSqlTimestamp |
| wm.tn.util:stringListToDateList | |
| wm.tn.util:stringListToDoubleList | |
| wm.tn.util:stringToDate | |
| wm.tn.util:stringToDouble |
The details of the service are listed as follows:
| Folder Name | Supported Services |
|---|---|
| submit | wm.tn: submitWithAttachments |
wm.tn: submitWithAttachments
Submits the document along with headers and attachments to webMethods B2B.
Input Parameters
| data | Document - Contains the input data to submit to webMethods B2B | |
| Parameter | Description | |
| contentType | String Content type of the data that is submitted. | |
| inputContent | Object Content that is submitted. | |
| readContentAs | String Format of the inputContent. Valid values are:- bytes inputContent is of byte array format.- string inputContent is of String format. | |
| encoding | String (Optional) Character set in which the document is encoded. | |
| TN_parms | Document (Optional) An Integration Server document (IData object) that you can use to provide parameters that govern how webMethods.io B2B recognizes and processes a document. | |
| attachments headers | Document (Optional) Headers you can include on your inputContent. | |
| Document List (Optional) Attachments to send along with inputContent. | ||
| Parameter | Description | |
| Name | String Content part name of the attachment. | |
| contentType | StringContent type of the attachment data that is submitted. | |
| inputContent | Object Content to be submitted. | |
| readContentAs | String Format of the inputContent. Valid values are:- bytes inputContent is of byte array format.- string inputContent is of String format. | |
| encoding | String (Optional) Character set in which the document is encoded. | |
| otherHeaders | Document (Optional) headers you can include on your attachment content. |
Output Parameters
| bizdoc | Document(Optional) The document that webMethods.io B2B receives (the content passed in the ‘data’ input) which is formatted as an Integration Server document (IData object). For the structure of bizdoc, see wm.tn.rec:BizDocEnvelope service in webMethods Trading Networks Built-In Services Reference. |
Working with EDI and EDIINT Built-In Services on IBM webMethods Cloud Container
IBM webMethods Cloud Container supports the following EDI and EDIINT services.
For complete details of service parameters of each of these EDI services, see the webMethods Module for EDI Built-In Services Reference document.
| IBM webMethods Cloud Container Package | Supported Services | Description |
|---|---|---|
| WmEDIforTNStub | wm.b2b.editn:bizdocToRecord | Returns an webMethods Integration Server document that represents the EDI document based on the input BizDocEnvelope. |
| wm.b2b.editn:ediPartnerIDToTNPartnerID | Retrieves the webMethods Trading Networks internal ID of the partner. | |
| wm.b2b.edi:generateX12TA1 | Generates an outbound functional acknowledgment (TA1) for an X12 interchange envelope. | |
| wm.b2b.editn:getICDetail | Accepts EDI data containing multiple EDI envelopes and extracts Interchange and Group header information from each of the envelopes. | |
| wm.b2b.editn:getTransactionSetDetail | Converts a TransactionInfoSet object to a transaction record. | |
| wm.b2b.editn:trackEDIdocs | Scans the input EDI data to add the interchange/group to the EDITRACKING table, which is a module-specific table in the Trading Networks database. | |
| wm.b2b.editn:validateEnvelope | Validates the EDI envelope and adds entries to the Trading Networks activity log for the validation errors encountered in the EDI envelope. | |
| wm.b2b.editn:validateTransaction | Validates the EDI document and adds entries to the Trading Networks activity log for the validation errors encountered in the EDI document. | |
| wm.b2b.editn:wrapData | Inserts a character string at a fixed length position to form fixed length data. This service is used to create wrap data to send to a mainframe system. | |
| wm.b2b.editn.crossRef:getEnvInfo | Obtains interchange sender/receiver pair information from the EDIEnvelope table, which is a module-specific table in the Trading Networks database. | |
| wm.b2b.editn.doc:listTransactionTypes | Returns a list of all Trading Networks document types for EDI transaction sets that exist on the server as well as the instance ID query associated with that Trading Networks document type, if one exists. | |
| wm.b2b.edi.eancom:generateAUTACK | Generate an AUTACK message manually. | |
| wm.b2b.edi.eancom:processAUTACK | To process an AUTACK message manually. | |
| wm.b2b.editn.TPA:getEDITPAData | Retrieves the EDITPA data for a specified sender and receiver. | |
| wm.b2b.edi.tradacoms.doc:getContentPart | Returns a Trading Networks bizDocEnvelope content part object that represents the requested content part. | |
| wm.b2b.edi.tradacoms.doc:getDocumentPartInfo | Returns information about the detail messages in a TRADACOMS file that is contained in a Trading Networks bizDocEnvelope. | |
| wm.b2b.edi.tradacoms.doc:getFFSchemaNames | Returns the names of the flat file schemas that can be used to parse the parts of a TRADACOMS file. | |
| wm.b2b.edi.tradacoms.doc:isFileEnvelope | Determines whether a BizDocEnvelope contains a TRADACOMS file document. | |
| wm.b2b.editn.util.reprocess:listInSequenceDoc | Retrieves a list of EDI documents that contained out-of-sequence control numbers when they were originally received, but now the control numbers are in sequence due to the arrival of other EDI documents. | |
| wm.b2b.editn.util.reprocess:listUnprocessDoc | Retrieves a list of EDI documents that were not processed due to a validation error. | |
| wm.b2b.editn.util.reprocess:nextInSequenceDoc | Determines whether another EDI document with an out-of-sequence control number exists and can be processed because the specified document has been processed. | |
| wm.b2b.editn.batch:getControlNumber | Gets the current control number from the EDIControlNumber table, which is a module-specific table in the Trading Networks database that Module for EDI uses to manage control numbers. | |
| wm.b2b.editn.util.reprocess:validateControlNumber | Determines whether the specified control number is the one expected for the specified sender/receiver pair. |
The details for the following services are listed.
| IBM webMethods Cloud Container Package | Supported Services | Description |
|---|---|---|
| WmEDIforTNStub | wm.b2b.editn:recordToBizDoc | Converts Integration Serverdocument to wm.tn.rec: BizDocEnvelope. |
| WmEDIINTStub | wm.EDIINT.doc:getDocFromMDN | Retrives the internal ID of the original EDIINT document when the internal ID of the MDN is given. |
| wm.EDIINT.doc:relatePayload | Relates two business documents. | |
| wm.EDIINT.doc:getRelatedDoc | Retrieves the related document based on the inputs you specify. |
wm.b2b.editn:recordToBizDoc
Converts Integration Server document to wm.tn.rec: BizDocEnvelope.
Input Parameters
| boundNode | Document Integration Server document containing EDI message. |
| EDIFFSName | String The fully-qualified flat file schema name that represents the corresponding EDI document. |
| Segment_terminator | String (Optional) The segment terminator character that the service append to the end of each record. |
| Field_separator | String (Optional) The field separator that the service insert between each field for each segment. |
| encoding | String (Optional) Character set in which the document is encoded. |
Output Parameters
| bizdoc | Document(Optional) The document that webMethods.io B2B receive (the content passed in the ‘data’ input) formatted as an Integration Server document (IData object). For the structure of bizdoc, see wm.tn.rec:BizDocEnvelope. |
wm.EDIINT.doc:getDocFromMDN
Retrieves the internal ID of the original EDIINT document when the internal ID of the MDN is given.
Input Parameters
| MDNDocInternalld | String. Internal ID of the MDN. |
Output Parameters
| EDIINTDocInternalld | String. Internal ID of the EDIINT document. |
wm.EDIINT.doc:relatePayload
Relates two business documents.
Input Parameters
| bizdoc | Object. The document must be an instance of
com.wm.app.tn.doc.BizDocEnvelope. |
| payloadBizdoc | Object. The document must be an instance of
com.wm.app.tn.doc.BizDocEnvelope. |
| envelopeDocuments | Document. List EDI envelope documents. |
| payloadType | String Type of payload. For relating EDI documents, the value should be EDI. |
| persistMultipleDocEnvelope | String. It is used only when payloadType value is ‘EDI’. Valid values are:- true. Relate bizdoc and payloadbizdoc.- false. Do not relate bizdoc and payloadbizdoc. |
Output Parameters
| EDIINTDocInternalID | String - Internal ID of the EDIINT document. |
wm.EDIINT.doc:getRelatedDoc
Retrieves the related document for the given inputs.
Input Parameters
| documentId | String. Message-ID of the document. |
| userStatusStartWith | String. User status of the related document that needs to be retrieved. |
| relationship | String. (Optional) Type of relationship. |
Output Parameters
| bizdoc | Object (Optional) The document must be an instance of
com.wm.app.tn.doc.BizDocEnvelope. |
| hasRelationship | Object - Indicates whether there exists a document for the given inputs. Valid values are:- true. If there is a related document for the given inputs.- false. If there is no related document for the given inputs. |
wm.EDIINT.util:decodeAS2ID
Decodes the input AS2 identifier by performing the following four operations:
- Remove trailing spaces
- Remove quotes
- Remove escape characters
- Validate the final updated AS2 identifier
Input Parameters
| id | String AS2 Identifier that requires decoding. |
Output Parameters
| newId | String Decoded AS2 Identifier. |
wm.EDIINT.util:isLastMDNSuccess
Verifies if the input EDIINT document has received a successful MDN.
Input Parameters
| originalbizdoc | Object EDIINT document. |
Output Parameters
| lastMDNSuccess | String Indicates whether the input EDIINT document has received a successful MDN back.- true. If EDIINT document has received a successful MDN.- false. If EDIINT document has not received any successful MDN. |
wm.EDIINT.util:parseURI
Creates a URL by parsing, validating, and extracting URI elements from the input ‘URIString’.
Input Parameters
| URIString | String URI from which the URI elements are extracted. |
Output Parameters
| protocol | String Protocol extracted from the URI. |
| user | String Username extracted and decoded from the URI. |
| pass | String Password extracted and decoded from the URI. |
| host | String Hostname extracted from the URI. |
| port | String Integer port extracted from the URI. |
| path | String Path extracted from the URI. |
| URL | String URL created from all the extracted URI elements. |
wm.EDIINT.rules:setProcessInfo
Changes user status and sets the message for specific transaction based on the bizdoc object.
Input Parameters
| thebizdoc | Object. The document must be an instance of
com.wm.app.tn.doc.BizDocEnvelope |
| newstatus | Picklist Valid options are: IGNORED , WARNING , ERROR, DONE, WAITMDN, SENDINGMDN, PAYLOAD |
| briefmessage | String Message will display in activity log. |
| fullmessage | String Complete message to display in activity log. |
| entryType | String Types of messages are: error, message and warning. |
| relatedDocId | String Document id of related document. |
| relatedConversationId | String Conversation id of related document. |
wm.EDIINT.util:CRLF
Generates an output carriage return and line feed.
Input Parameters
| CRLF | String Variable contains “\r\n” |
wm.EDIINT.util:checkJSSEConfig
Returns Integration Server property value of useJSSE.
Output Parameters
| useJSSE | StringValid values are:- true. Indicates JSSE is used.- false. Indicates JSSE is not used. |
wm.EDIINT.util:getProcessPayloadIfMDNNotSent
Returns value of EDIINT property wm.EDIINT.processPayloadIfMDNNotSent.
Output Parameters
| processPayload | StringValid values are:- true. Indicates payload will be processed.- false. Indicates payload will not be processed. |