Receive Task (HTTP)

Receive Task (HTTP)

Holds a token and listens for HTTP requests at a specific URL. Receiving an HTTP request, the token advances. Capable of receiving values in parameters and overwriting business data.

Configs: Common
  • Step Name
  • Note
Configs: Editing permission
  • Data Item
    • Editing permission
      • (Editable)
      • (No display)
Configs: General
  • mode_edit_outline API key
  • Deadline
    • arrow_drop_down
      • No deadline
      • After [Token Arrival/Process Start Time]
        • expand_all (select number 1-9999)
          • arrow_drop_down [Minute(s)/Hour(s)/Day(s)/Month(s)]
      • [00:00 of (Date-type)/(Datetime-type)]
        • expand_all (select number 1-9999)
          • arrow_drop_down [(blank: Cancel designation)/Minute(s)/Hour(s)/Day(s)/Month(s)]
    • toggle_off Expression (Display the setting contents in EL expressions)
Reception Parameter, IP address filtering (Opens in new tab)
App
  • App name
Name
  • Step name
Node Number
  • number
URL
  • https://{YOUR_DOMAIN}/System/ReceiveTask/HttpPost/{APP_ID}/{NODE_NUMBER}/receive?key={API_KEY}
  • ${var[applicationRoot]}System/ReceiveTask/HttpPost/{APP_ID}/{NODE_NUMBER}/receive?key={API_KEY}
Allowed Hosts/Networks
  • (Overview of related IP Address Filtering)
Reception Parameter
    • Reception Parameter Name / Detail / required / About Parameter Value / Fixed Value
Receive Availability Check API
  • https://{YOUR DOMAIN}/System/ReceiveTask/HttpPost/{APP ID}/{NODE NUMBER}/receive/check?processInstanceId={PROCESS ID}
Auto-Processing Log
  • view_column (Column)
    • drag_handledelete Date and Time (Default)
    • drag_handledelete Process ID (Default)
    • drag_handledelete Version (Default)
    • drag_handledelete Type (Default)
    • Add
      • (Add All)
      • Log ID
      • App ID
      • App Name
      • Node Number
      • Step Name
      • User ID
      • User Name
(Logs list)
    • Date and Time / Process ID / Version / Type
  • (Display control)
    • (View)
      • 10, 20, 50, 100, 200, 500, 1000
    • Page

Capture

Notes

  • You can check and copy the receiving URL to clipboard in the property screen
  • You can check the Reception Parameter and IP filtering Details in the other page after clicking the button in the property screen
  • Even though it is possible to leave the API key blank, please set the API key with halfwidth alphanumeric characters, at most 100 in length to tighten the security
  • Numeric-type Data Items in which an arithmetic expression has been set cannot be set to Editable
  • Please make requests with POST (application/x-www-form-urlencoded or multipart/form-data)
  • If successfully processed, the HTTP response code 200 is returned
    • The response body is “empty” (text/plain)
  • If processing fails, an HTTP response code other than 200 is returned
    • In this case, the token remains here, and the listening state of this step continues
    • An HTTP response code of 400 and an error message in XML format (text/xml) are returned in the following cases
      • The received data does not include content for the required settings in the process data item that will store the data, and does not meet the minimum/maximum number of characters and input validation conditions of the item
      • Invalid values for parameters such as App ID
      • The token has not yet reached this step and the API is not ready to receive requests
      • R2212: XML Format of Error Responses for Receiving HTTP Requests
    • HTTP response codes in the 400s are returned, but the response body is not specified in the following cases
      • The received HTTP request has exceeded the data size limit that can be received via HTTP communication
      • The HTTP request format (method/Content-Type) is not the required format
  • By specifying a parameter in the HTTP request, you can update the value of Data Items without finishing the Step
    • Parameter Name: saveOnly, Value: true
    • When data is received via an HTTP request with saveOnly=true added, no mandatory checks are performed (same behavior as “Save and Quit” in Task Operating)
    • The token stays at the Step
      • To advance the token, send a request with saveOnly=false, or request without saveOnly parameter
  • Capable of setting a deadline
    • Deadline times are displayed in Process Details and Lists and can be specified as a filter condition
    • If you specify anything other than “No Deadline”, the default will be set to “1 day after” the target time such as “Token Arrival”
    • When specifying a Date-type Data Item, set it to “1 day after 00:00 of (Date-type)(24 hours later)”
      • This will behave the same as in version 16.1 and earlier, that is “If assigned to Deadline, it will work at 23:59 of the day on the relevant day”
      • If you select “Blank” in the “After days” dropdown, the operation will start at 00:00 on the specified date
    • If the calculated deadline falls on or after 2101-01-01, it will be forced to change to 2100-12-31
    • When you turn on [toggle_off Expression], the settings will be expressed in EL expressions
      • Advanced settings are also possible by editing the EL expression
        • Example:processInstanceStartDatetime.addMonths(1).getFirstTimeInMonth() (00:00 on the first day of the month following the Process Start time)
    • Capable of advancing the token when the deadline is reached
  • This modeling element is the successor to the [Catching Message Intermediate Event (HTTP)]
    • The URL used in the [Catching Message Intermediate Event (HTTP)] can still be used for the time being
    • Old URL format: /System/Event/IntermediateMessage/{APP ID}/{NODE NUMBER}/receive
    • If an old URL is accessed, a warning message will be recorded in the [Process Log]
      • Please substitute the destination URL in the communication settings of the request sender with the receiving URL of the [Receive Task (HTTP)]
      • Scheduled to be discontinued on the version 19.0 (April 2027)

See also

Scroll to Top

Discover more from Questetra Support

Subscribe now to keep reading and get access to the full archive.

Continue reading