HTTP Sender DSC

                      Browse Space
		    				

				
											View
											Attachments (0)
											Info
											Watchers
											Favourites
                                 Version 3 by Kendy Yus
 on Oct 22, 2008 12:43.
                                

                            
                                                                                    
                                
                                                                                << Changes from 2 to 3 
                                

                            
                                                    
                    
                    compared with
                    
                        
                            
                                

                                                                            Current by Lachlan Aldred
 on Apr 01, 2009 16:24.
                                    
                                

                                                            
                                                                                
                    
                    
                    
                

            
            
                Key

                This line was removed.
                This word was removed. This word was added.
                This line was added.
            
            

              
      Comment:
      

  

    


            Changes (20)
            View page history

                        
            
                    ...


h3. Component: com.avoka.livecycle.httpsender 8.0 



                    h2. HttpSender Service

                            HTTP Sender: Sends a HTTP request to a URL and returns respond.
                            HTTP Sender: Invokes an internet resource using HTTP.  This service is able to automatically submit HTML forms, and/or load the contents of Web-pages into the process data.  This sort of thing is very useful when trying to integrate a LiveCycle process with any traditional Web-Application.  Technically this service is able to perform an HTTP-Get or HTTP-Post on an internet resource.  It can take any number of parameters and the values can be pulled from the process data.   The response is passed back into the process data as a string.
                    



                            h3. Operation: send
                            h3. Operation Title: Send HTTP Request&nbsp;&nbsp;&nbsp;(send)
                    Send HTTP Request: Sends an HTTP request to
                                                                                                                                                        a
                                                                                                                                                        any
                                                                     URL
                    || Input Parameter || Type || Description ||
                                                                                                                                                        Editor ||
                    | URL | java.lang.String | The URL to connect to
                                                                                                                                                        |
                                                                                                                                                        |&nbsp;|
                    | HTTP Method | java.lang.String | The method used to send HTTP request. Either Get or Post.
                                                                                                                                                        |
                                                                                                                                                        |&nbsp;|
                    | Request Body | java.lang.String | Optional request body when choosing to use Post for HTTP Method.
                                                                                                                                                        |
                                                                                                                                                        |&nbsp;|
                    | Username | java.lang.String | Optional username for authentication
                                                                                                                                                        |
                                                                                                                                                        |&nbsp;|
                    | Password | java.lang.String | Optional password for authentication
                                                                                                                                                        |
                                                                                                                                                        |&nbsp;|
                    | Enable Proxy | boolean | Check to enable proxy to connect to the specified URL.
                                                                                                                                                        |
                                                                                                                                                        |&nbsp;|
                    | Proxy Server | java.lang.String | Proxy Server
                                                                                                                                                        |
                                                                                                                                                        |&nbsp;|
                    | Proxy Port | int | Proxy Port
                                                                                                                                                        |
                                                                                                                                                        |&nbsp;|
                    | Proxy Username | java.lang.String | Proxy username if proxy requires user authentication.
                                                                                                                                                        |
                                                                                                                                                        |&nbsp;|
                    | Proxy Password | java.lang.String | Proxy password if proxy requires user authentication.
                                                                                                                                                        |
                                                                                                                                                        |&nbsp;|
                    | Test | java.lang.String | Dummy Test parameter to test sending HTTP request by clicking on the "Test" button. Note: All parameters have to be specified literaly for testing.
                                                                                                                                                        |
                                                                                                                                                        |&nbsp;|
                     
                            


                    || Output Parameter || Type || Description ||
                    | HTML Response |  | The HTML response from sending request to the specified URL. Type: String |
                                                                                                                                                         
                    | Request Status |  | The request status code returned from sending request to the specified URL. Type: int |
                                                                                                                                                         
                    

                    ...
h5. 
{panel:borderStyle=solid}
For how to configure license information for this component service - HTTP Sender, please click on the following link:
[Avoka LiveCycle ES Component License Configuration]

Please send us any questions or comments on this documentation regarding HTTP Sender by clicking on the following link:
[Feedback|mailto:docfeedback@avoka.com?subject=DSC Documentation Feedback on Service: HTTP Sender]
{panel}


h3. Licence Configuration:

|| Parameter || Type || Description ||
| License Key | java.lang.String | The license key. If blank this Solution Component will assume evaluation mode and allow 100 invocations or 6 hours up-time. |
| License Organisation | java.lang.String | The license organization. If blank this Solution Component will assume evaluation mode and allow 100 invocations or 6 hours up-time. |
                                 Version 3 by Kendy Yus
 on Oct 22, 2008 12:43.
                                

                            
                                                                                    
                                
                                                                                << Changes from 2 to 3 
                                

                            
                                                    
                    
                    compared with
                    
                        
                            
                                

                                                                            Current by Lachlan Aldred
 on Apr 01, 2009 16:24.
                                    
                                

                                                            
                                                                                
                    
                    
                    
                

            
            
                Key

                This line was removed.
                This word was removed. This word was added.
                This line was added.
            
            

              
      Comment:
      

  

    


            Changes (20)
            View page history

                        
            
                    ...


h3. Component: com.avoka.livecycle.httpsender 8.0 



                    h2. HttpSender Service

                            HTTP Sender: Sends a HTTP request to a URL and returns respond.
                            HTTP Sender: Invokes an internet resource using HTTP.  This service is able to automatically submit HTML forms, and/or load the contents of Web-pages into the process data.  This sort of thing is very useful when trying to integrate a LiveCycle process with any traditional Web-Application.  Technically this service is able to perform an HTTP-Get or HTTP-Post on an internet resource.  It can take any number of parameters and the values can be pulled from the process data.   The response is passed back into the process data as a string.
                    



                            h3. Operation: send
                            h3. Operation Title: Send HTTP Request&nbsp;&nbsp;&nbsp;(send)
                    Send HTTP Request: Sends an HTTP request to
                                                                                                                                                        a
                                                                                                                                                        any
                                                                     URL
                    || Input Parameter || Type || Description ||
                                                                                                                                                        Editor ||
                    | URL | java.lang.String | The URL to connect to
                                                                                                                                                        |
                                                                                                                                                        |&nbsp;|
                    | HTTP Method | java.lang.String | The method used to send HTTP request. Either Get or Post.
                                                                                                                                                        |
                                                                                                                                                        |&nbsp;|
                    | Request Body | java.lang.String | Optional request body when choosing to use Post for HTTP Method.
                                                                                                                                                        |
                                                                                                                                                        |&nbsp;|
                    | Username | java.lang.String | Optional username for authentication
                                                                                                                                                        |
                                                                                                                                                        |&nbsp;|
                    | Password | java.lang.String | Optional password for authentication
                                                                                                                                                        |
                                                                                                                                                        |&nbsp;|
                    | Enable Proxy | boolean | Check to enable proxy to connect to the specified URL.
                                                                                                                                                        |
                                                                                                                                                        |&nbsp;|
                    | Proxy Server | java.lang.String | Proxy Server
                                                                                                                                                        |
                                                                                                                                                        |&nbsp;|
                    | Proxy Port | int | Proxy Port
                                                                                                                                                        |
                                                                                                                                                        |&nbsp;|
                    | Proxy Username | java.lang.String | Proxy username if proxy requires user authentication.
                                                                                                                                                        |
                                                                                                                                                        |&nbsp;|
                    | Proxy Password | java.lang.String | Proxy password if proxy requires user authentication.
                                                                                                                                                        |
                                                                                                                                                        |&nbsp;|
                    | Test | java.lang.String | Dummy Test parameter to test sending HTTP request by clicking on the "Test" button. Note: All parameters have to be specified literaly for testing.
                                                                                                                                                        |
                                                                                                                                                        |&nbsp;|
                     
                            


                    || Output Parameter || Type || Description ||
                    | HTML Response |  | The HTML response from sending request to the specified URL. Type: String |
                                                                                                                                                         
                    | Request Status |  | The request status code returned from sending request to the specified URL. Type: int |
                                                                                                                                                         
                    

                    ...
h5. 
{panel:borderStyle=solid}
For how to configure license information for this component service - HTTP Sender, please click on the following link:
[Avoka LiveCycle ES Component License Configuration]

Please send us any questions or comments on this documentation regarding HTTP Sender by clicking on the following link:
[Feedback|mailto:docfeedback@avoka.com?subject=DSC Documentation Feedback on Service: HTTP Sender]
{panel}


h3. Licence Configuration:

|| Parameter || Type || Description ||
| License Key | java.lang.String | The license key. If blank this Solution Component will assume evaluation mode and allow 100 invocations or 6 hours up-time. |
| License Organisation | java.lang.String | The license organization. If blank this Solution Component will assume evaluation mode and allow 100 invocations or 6 hours up-time. |
-                                Version 3 by Kendy Yus
 on Oct 22, 2008 12:43.
                                

                            
                                                                                    
                                
                                                                                << Changes from 2 to 3 
                                

                            
                                                    
                    
                    compared with
                    
                        
                            
                                

                                                                            Current by Lachlan Aldred
 on Apr 01, 2009 16:24.
+                Key

                This line was removed.
                This word was removed. This word was added.
                This line was added.
-                                Version 3 by Kendy Yus
 on Oct 22, 2008 12:43.
                                

                            
                                                                                    
                                
                                                                                << Changes from 2 to 3
+                                                                            Current by Lachlan Aldred
 on Apr 01, 2009 16:24.
 ...


h3. Component: com.avoka.livecycle.httpsender 8.0
 h2. HttpSender Service
-HTTP Sender: Sends a HTTP request to a URL and returns respond.
+HTTP Sender: Invokes an internet resource using HTTP.  This service is able to automatically submit HTML forms, and/or load the contents of Web-pages into the process data.  This sort of thing is very useful when trying to integrate a LiveCycle process with any traditional Web-Application.  Technically this service is able to perform an HTTP-Get or HTTP-Post on an internet resource.  It can take any number of parameters and the values can be pulled from the process data.   The response is passed back into the process data as a string.
-h3. Operation: send
+h3. Operation Title: Send HTTP Request&nbsp;&nbsp;&nbsp;(send)
 Send HTTP Request: Sends an HTTP request to
                                                                                                                                                        a
                                                                                                                                                        any
                                                                     URL
 || Input Parameter || Type || Description ||
                                                                                                                                                        Editor ||
 | URL | java.lang.String | The URL to connect to
                                                                                                                                                        |
                                                                                                                                                        |&nbsp;|
 | HTTP Method | java.lang.String | The method used to send HTTP request. Either Get or Post.
                                                                                                                                                        |
                                                                                                                                                        |&nbsp;|
 | Request Body | java.lang.String | Optional request body when choosing to use Post for HTTP Method.
                                                                                                                                                        |
                                                                                                                                                        |&nbsp;|
 | Username | java.lang.String | Optional username for authentication
                                                                                                                                                        |
                                                                                                                                                        |&nbsp;|
 | Password | java.lang.String | Optional password for authentication
                                                                                                                                                        |
                                                                                                                                                        |&nbsp;|
 | Enable Proxy | boolean | Check to enable proxy to connect to the specified URL.
                                                                                                                                                        |
                                                                                                                                                        |&nbsp;|
 | Proxy Server | java.lang.String | Proxy Server
                                                                                                                                                        |
                                                                                                                                                        |&nbsp;|
 | Proxy Port | int | Proxy Port
                                                                                                                                                        |
                                                                                                                                                        |&nbsp;|
 | Proxy Username | java.lang.String | Proxy username if proxy requires user authentication.
                                                                                                                                                        |
                                                                                                                                                        |&nbsp;|
 | Proxy Password | java.lang.String | Proxy password if proxy requires user authentication.
                                                                                                                                                        |
                                                                                                                                                        |&nbsp;|
 | Test | java.lang.String | Dummy Test parameter to test sending HTTP request by clicking on the "Test" button. Note: All parameters have to be specified literaly for testing.
                                                                                                                                                        |
                                                                                                                                                        |&nbsp;|
 || Output Parameter || Type || Description ||
 | HTML Response |  | The HTML response from sending request to the specified URL. Type: String |
 | Request Status |  | The request status code returned from sending request to the specified URL. Type: int |
 ...
h5. 
{panel:borderStyle=solid}
For how to configure license information for this component service - HTTP Sender, please click on the following link:
[Avoka LiveCycle ES Component License Configuration]

Please send us any questions or comments on this documentation regarding HTTP Sender by clicking on the following link:
[Feedback|mailto:docfeedback@avoka.com?subject=DSC Documentation Feedback on Service: HTTP Sender]
{panel}


h3. Licence Configuration:

|| Parameter || Type || Description ||
| License Key | java.lang.String | The license key. If blank this Solution Component will assume evaluation mode and allow 100 invocations or 6 hours up-time. |
| License Organisation | java.lang.String | The license organization. If blank this Solution Component will assume evaluation mode and allow 100 invocations or 6 hours up-time. |