{"id":5923,"date":"2017-12-12T23:52:52","date_gmt":"2017-12-12T23:52:52","guid":{"rendered":"https:\/\/alt2.minisoft.com\/support\/?p=5923"},"modified":"2020-07-01T16:23:48","modified_gmt":"2020-07-01T23:23:48","slug":"web-service-post-call-to-wake-up-a-sleeping-queue-part-2","status":"publish","type":"post","link":"https:\/\/c002.minisoft.com\/support\/web-service-post-call-to-wake-up-a-sleeping-queue-part-2\/","title":{"rendered":"Web Service POST call to \u201cWake Up\u201d a \u201cSleeping\u201d Queue: Part 2"},"content":{"rendered":"

Web Service Call Options:<\/strong><\/p>\n

In the previous post<\/a>, the Director was configured and an explanation for what a sleeping queue is was given. In this post, the options that a web service call has will be explored. Version 10 of eFORMz has the ability to call a web service to post data to a queue<\/a>. To process a web service call, eFORMz will need a URL. A sample URL could be:<\/p>\n

https:\/\/localhost:8000\/servlet\/com.minisoft.AppServer.AppServer?APP=com.minisoft.eformz.eFORMzApp&director&Host=localhost&Port=9996&User=minisoft&Password=password&ConfigurationName=accessible.cfg&QueueName=Accessible&NameTemplate=data_.dat<\/pre>\n
Below are all the options available for a web request call URL.<\/p>\n\n\n\n\n\n
base URL<\/td>\nhttps:\/\/localhost:8000\/servlet\/com.minisoft.AppServer.AppServer<\/a><\/td>\n<\/tr>\n
Parameter to AppServer<\/td>\n?APP=com.minisoft.eformz.eFORMzApp<\/td>\n<\/tr>\n
Decide how to process<\/td>\n\n\n\n\n\n\n\n
Service Type<\/td>\n&director<\/td>\n<\/tr>\n
Service Type<\/td>\n&output<\/td>\n<\/tr>\n
<\/td>\n&config=configuration file\u00a0 name<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n<\/tr>\n
Parameters for DirectorService<\/td>\n\n\n\n\n\n\n\n\n\n\n\n
Service Type<\/td>\n&director<\/td>\n<\/tr>\n
which host<\/td>\n&Host=localhost
\n&Port=9996<\/td>\n<\/tr>\n
Authentication for director<\/td>\n&User=minisoft
\n&Password=password<\/td>\n<\/tr>\n
Toolkit file *
\nMust be started with -ac parameter<\/td>\n		&ConfigurationName=accessible.cfg<\/td>\n<\/tr>\n
Queue name in toolkit file<\/td>\n&QueueName=Accessible<\/td>\n<\/tr>\n
File name for POSTed data<\/td>\n&NameTemplate=data_.xml<\/td>\n<\/tr>\n
Wake a sleeping queue<\/td>\n&ProcessData=true<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n<\/tr>\n
Parameters for OutputService<\/td>\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Service Type<\/td>\n&output<\/td>\n<\/tr>\n
Project Name<\/td>\n&project<\/td>\n<\/tr>\n
Project Key<\/td>\n&projectkey<\/td>\n<\/tr>\n
Output Format<\/td>\n&format<\/td>\n<\/tr>\n
Pages<\/td>\n&pages<\/td>\n<\/tr>\n
Start Page<\/td>\n&startpage<\/td>\n<\/tr>\n
End Page<\/td>\n&endpage<\/td>\n<\/tr>\n
Other parameters<\/td>\n*<\/td>\n<\/tr>\n
Data File Name<\/td>\n&datafile<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n<\/tr>\n
Service Type can be<\/td>\n\n\n\n\n\n\n
Director<\/td>\ndirector<\/td>\n<\/tr>\n
Output<\/td>\noutput<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n<\/tr>\n
Parameters<\/td>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
&project<\/td>\nm_ProjectName<\/td>\nString<\/td>\n<\/tr>\n
&projectkey<\/td>\nm_ProjectKey<\/td>\nString<\/td>\n<\/tr>\n
&format<\/td>\nm_OutputFormat<\/td>\nString<\/td>\n<\/tr>\n
&datafile<\/td>\nm_DataFileName<\/td>\nString<\/td>\n<\/tr>\n
&pages<\/td>\nm_OutputPages<\/td>\nPageRangeSelection<\/td>\n<\/tr>\n
&startpage<\/td>\nm_StartPage<\/td>\nInt (1)<\/td>\n<\/tr>\n
&endpage<\/td>\nm_EndPage<\/td>\nInt (999999)<\/td>\n<\/tr>\n
&Host<\/td>\n<\/td>\n<\/td>\n<\/tr>\n
&Port<\/td>\n<\/td>\n<\/td>\n<\/tr>\n
&User<\/td>\n<\/td>\n<\/td>\n<\/tr>\n
&Password<\/td>\n<\/td>\n<\/td>\n<\/tr>\n
&ConfigurationName<\/td>\n<\/td>\n<\/td>\n<\/tr>\n
&QueueName<\/td>\n<\/td>\n<\/td>\n<\/tr>\n
&NameTemplate<\/td>\n<\/td>\n<\/td>\n<\/tr>\n
&ProcessData<\/td>\n<\/td>\nBoolean<\/td>\n<\/tr>\n
&Sync<\/td>\n<\/td>\nBoolean<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n<\/tr>\n
PageRangeSelection can be<\/td>\nall( “All pages” ),
\ncurrent( “Current pages” ),
\nrangeFromStart( “Page Range (from start)” ),
\nrangeFromEnd(“Page Range (from end)” ),
\nobsolete0( “Page Range (from end )” )<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
There are many options that the URL can have. Here are some of the following:<\/p>\n
If &ProcessData=true<\/code> is added, the web service will wake up the queue monitor (if it is sleeping)\u00a0to process anything in the queue immediately. Any data sent as content will be put in a file in the named queue. The Director has to be running the named configuration and it has to be accessible to web services.<\/p>\n
Any content type can be used except text\/plain<\/code>. Specifying the content type isn’t necessary. If you use text\/plain<\/code> it tries to parse it for parameters and if you use text\/xml<\/code> it tries to parse it for a Service Configuration xml file.<\/p>\n
NOTE: A posted file text\/xml<\/code> that is not a ServiceConfiguration<\/code> will be handled as a posted data file. A posted file text\/xml<\/code> that is a ServiceConfiguration<\/code> will skip the URL parameters.<\/p>\n","protected":false},"excerpt":{"rendered":"
Web Service Call Options: In the previous post, the Director was configured and an explanation for what a sleeping queue is was given. In this post, the options that a web service call has will be explored. Version 10 of eFORMz has the ability to call a web service to post data to a queue. […]<\/p>\n","protected":false},"author":15,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[349,346,325,341,348,347],"_links":{"self":[{"href":"https:\/\/c002.minisoft.com\/support\/wp-json\/wp\/v2\/posts\/5923"}],"collection":[{"href":"https:\/\/c002.minisoft.com\/support\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/c002.minisoft.com\/support\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/c002.minisoft.com\/support\/wp-json\/wp\/v2\/users\/15"}],"replies":[{"embeddable":true,"href":"https:\/\/c002.minisoft.com\/support\/wp-json\/wp\/v2\/comments?post=5923"}],"version-history":[{"count":4,"href":"https:\/\/c002.minisoft.com\/support\/wp-json\/wp\/v2\/posts\/5923\/revisions"}],"predecessor-version":[{"id":8179,"href":"https:\/\/c002.minisoft.com\/support\/wp-json\/wp\/v2\/posts\/5923\/revisions\/8179"}],"wp:attachment":[{"href":"https:\/\/c002.minisoft.com\/support\/wp-json\/wp\/v2\/media?parent=5923"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/c002.minisoft.com\/support\/wp-json\/wp\/v2\/categories?post=5923"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/c002.minisoft.com\/support\/wp-json\/wp\/v2\/tags?post=5923"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}