B2B Integration : Trading Networks Built-In Services Reference : Profile Folder : Summary of Elements in this Folder : wm.tn.profile.create:newPrivateQueue
wm.tn.profile.create:newPrivateQueue
Creates a private queue for a trading partner.
Input Parameters
partnerID
String The internal ID of the partner that this private queue belongs to.
state
String Possible values are enabled, suspended, draining, and disabled. For explanations of delivery queue states, see webMethods Trading Networks Administrator’s Guide.
deliverySchedule
Document Defines how and when tasks on this private queue are executed to deliver documents. The document contains the following keys:
*svcName String Name of the registered scheduled delivery service. This is not the fully-qualified name of the service in the Integration Server namespace; it is the name used to register the delivery service, using wm.tn.delivery:registerService. This is the name that is displayed in the delivery settings for the service in My webMethods.
*svcInputs Document Input variables to the scheduled delivery service. The variables you will supply are defined by the delivery service. If you are using the Batch FTP delivery service, see wm.tn.transport:batchFtp.
*scheduleType String Possible values are once, repeat, and complex. For explanations of delivery queue schedules, see webMethods Trading Networks Administrator’s Guide.
*oneTimeSchedule Document Determines the date and time that the delivery service in svcName is invoked, when the value of scheduleType is once. If the value of scheduleType is once, oneTimeSchedule is required. This document contains the following keys:
*date is a String in the format yyyy:mm:dd.
*time is a String in the format hh:min:ss.
*repeatingSchedule Document Determines the interval at which the delivery service in svcName is invoked when the value of scheduleType is repeat. If scheduleType is repeat, repeatingSchedule is required.
*interval String that indicates a number of seconds.
*noOverlap String that indicates whether invocations of the delivery service may overlap. If the delivery service has not completed when it is invoked again, this setting determines whether to delay the invocation until the previous execution has completed. If noOverlap is true, Integration Server waits until the previous execution of the service has completed. If the value is false, it does not wait, making it possible for two separate threads of executions to deliver from the queue at the same time. The default is false.
complexSchedule
Document Determines when the delivery service in svcName will be invoked when scheduleType is complex. If scheduleType is complex, complexSchedule is required. This document contains the following keys:
*startDate String The date when the delivery service will be invoked first, in the format yyyy:mm:dd.
*startTime String The time when the delivery service will be invoked first, in the format hh:mm:ss. If you do not specify a value, the server uses 00:00:00 (midnight).
*endDate String The date when the invocation of the delivery service will cease, in the format yyyy:mm:dd.
*endTime String The time when the invocation of the delivery service will cease, in the format hh:mm:ss. If you do not specify a value, the server uses 00:00:00 (midnight).
*months String List The months that the delivery service will be invoked. Values are 1 through 12. If you do not specify a value, the service is invoked every month.
*daysOfMonth String List The days of the month that the delivery service will be invoked. Values are 1 through 31. If you do not specify a value, the service is invoked every day of the month.
*daysOfWeek String List The days of the week that the delivery service will be invoked. Values are 1 (Sunday) through 31 (Saturday). If you do not specify a value, the service is invoked every day of the week.
*hours String List The hours of the day that the delivery service will be invoked. Values are 0 through 23. If you do not specify a value, the service is invoked every hour.
*minutes String List The minutes within an hour that the delivery service will be invoked. Values are 0 through 59. If you do not specify a value, the service is invoked every minute.
Output Parameters
queue
Object The DeliveryQueue object created and saved to the database. For Java programmers, this is com.wm.app.tn.delivery.DeliveryQueue.
msgs
String List This service invokes wm.tn.queuing:registerQueue. If that service returned any warning messages, they display here.
Usage Notes
This service validates the supplied inputs, create a DeliveryQueue object, saves it to the Trading Networks database, and updates the partner's profile to refer to the new private queue.
*If the queue was saved in an enabled or draining state, the specified delivery service will be scheduled for execution. If the queue was saved in an enabled or suspended state, the queue will be available to receive new delivery tasks immediately.
*After a private queue has been created with this service, you can view, update, or delete it using My webMethods.
*You cannot create a private queue for Your Enterprise, the profile that represents the owner (or “hub”) of the trading network. Trading Networks does not deliver documents to Your Enterprise.
Copyright © 2016- 2017 Software AG, Darmstadt, Germany.
Product LogoContact Support   |   Community   |   Feedback