HttpStart - Start by HTTP request
This is a start component for a flow triggered by HTTP request like from web browser.By using with WebLogin, an user authentication can be handled. For example, if a user doesn't login or a user doesn't have right permission, an exception occurs.
Stream Information
| Input | Format | NONE |
|---|---|---|
| Number of Inputs | 0 | |
| Description |
The input stream's format is not defined. The input stream data is passed directly to the output stream. |
|
| Output | Format | ParameterList,MIME |
| Description | Specifies ParameterList or MIME by how to acquire the parameters. For details, please refer to following topic "How to acquire parameters". |
Component Properties
| Name | Data Type | Mapping | Description | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| BeginTransaction | boolean | - |
Specifies when transactions executed in each components is submitted.
Icon changes according to this property.
|
|||||||||||||||||||||
| QueryEncoding | choice | - |
Specifies encoding when parsing HTML form parameters. Not used in a flow not parsing HTML form parameters.
|
|||||||||||||||||||||
| LoginCheck | boolean | In & Out |
Specifies if checking login status by using WebLogin component.
|
|||||||||||||||||||||
| RequiredRole by WebLogin | string | In & Out |
Specifies required roles. This is used when LoginCheck is set to true. Multiple roles can be set by separating with ",". |
|||||||||||||||||||||
| Cookie | category | In & Out |
Acquires a Cookie value from HTTP request. You can acquire a Cookie value if you set the Cookie name to Name field. This property is set as a stream variable automatically. You can acquire the value from a stream variable in the Mapper. |
|||||||||||||||||||||
| Header | category | In & Out |
Acquires header values of HTTP request. You can acquire a value of HTTP header if you set the header name to Name field. This property is set as a stream variable automatically. You can acquire the value from a stream variable in the Mapper. |
Transaction
| Commit | Do nothing |
|---|---|
| Rollback | Do nothing |
Exceptions
| Type | Parameter | Stream for error handling flow | Error Code | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Exception | None | This component's input stream | - | When failed to convert the parameter by a data type defined in field definitions. | |||||||||
| NotLogined | None | This component's input stream | - | When LoginCheck is set to true and not login | |||||||||
| NotAuthorized |
| This component's input stream | - | When LoginCheck is set to true and login user doen't have required roles. |
How to acquire parameters
Specifies a type of output stream by how to acquire data. If a flow only processes a simple GET request, you may use either.
| Output stream type | Data |
|---|---|
| ParameterList | HTML form parameters |
| MIME | Raw HTTP request |
Acquires HTML form parameters
If you want to acquire HTML form parameters, specify the value of name attribute of input in HTML form to a field name of ParameterList. Then, a flow acquires the values from HTTP request and it sets to ParameterList. If the field of ParameterList is a numeric type, the value is set to null when conversion is failed.
When the parameter with specified name is not found in the HTML form, the value is set to null. If the parameter is empty string, the value is set to empty value
Acquires multiple values
If a parameter in like a checkbox has multiple values, String[] should be used.
Acquires file data
If you want to acquire file data, the data itself can be acquired from the field of ParameterList. Typically, you should use Binary type. If you use String type, the data is encoded by QueryEncoding.
To get the filename, define the field name like "<Parameter Name>_filename".
Acquires URL parameters, when the output stream type is MIME
If the output stream type is MIME, the URL parameters are aquired form the public flow variables.
If the output stream type is ParameterList, these are aquired form the field of ParameterList.
Example
This example outputs into ParameterList decoded contents submitted by sample form via HTTP POST.
Sample form(HTML)
<html> <head> <title>Send report</title> <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> </head> <body> <h1>Send report</h1> <form method="post" ENCTYPE="multipart/form-data" action="http://localhost:21380/guest/sampleurl"> <input name="success_url" type="hidden" value=""> <input name="fail_url" type="hidden" value=""> Title:<br/><input type="text" size="64" name="title"/ ><br/> Contents:<br/><textarea rows="10" cols="50" name="body"></textarea><br/> Report to:<br/><input type="checkbox" name="addr" value="id01">Manager</input> <br/><input type="checkbox" name="addr" value="id02">Leader</input> <br/><input type="checkbox" name="addr" value="id03">Member</input><br/> Attachment:<br/><input name="fileupload" type="file" size="64"><br/> <br/> <input type="submit" value="Submit"> <input type="reset" value="Reset"> </form> </body> </html> |
Input stream(MIME)
Accept: image/gif, image/x-xbitmap, image/jpeg, image/pjpeg, application/x-shockwave-flash, application/vnd.ms-excel, application/vnd.ms-powerpoint, application/msword, */* Accept-Language: ja Content-Type: multipart/form-data; boundary=---------------------------7d62032549056e Accept-Encoding: gzip, deflate User-Agent: Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322; InfoPath.1) Host: localhost:21380 Content-Length: 4614 Connection: Keep-Alive Cache-Control: no-cache Cookie: ASTERIA_FLOWSERVICE=ae00969c-fafc-49ec-ae43-a0166b7c949a -----------------------------7d62032549056e Content-Disposition: form-data; name="success_url" -----------------------------7d62032549056e Content-Disposition: form-data; name="fail_url" -----------------------------7d62032549056e Content-Disposition: form-data; name="title" Title's string -----------------------------7d62032549056e Content-Disposition: form-data; name="body" Content's string -----------------------------7d62032549056e Content-Disposition: form-data; name="addr" id02 -----------------------------7d62032549056e Content-Disposition: form-data; name="addr" id03 -----------------------------7d62032549056e Content-Disposition: form-data; name="fileupload"; filename="C:\work\sample.xfp" Content-Type: application/octet-stream （Contents of attachment） -----------------------------7d62032549056e-- |
To acquire the values from ParameterList, please specify the following fields.
| Field Name | Data Type |
|---|---|
| success_url | String |
| fail_url | String |
| title | String |
| body | String |
| addr | String[] |
| fileupload | Binary |
| fileupload_filename | String |