Message Start Event (form)

Overview

Issues a Web form (its URL) for awaiting entry. Starts a new Case automatically by receiving entry. The form can be embedded on any website using “iframe” HTML tag.

Configs: Common

  • mode_edit_outline Name
  • mode_edit_outline Note
Configs: Editing permission

  • Data Item
    • check_circle Editing permission
      • edit(Editable)
      • visibility_off(No display)
Configs: Page URL on Submit

  • mode_edit_outline Page URL on Submit
Configs: API Key

  • mode_edit_outline API Key
    • autorenew (Generate new key)

Notes

  • User-type/Organization-type Data Items do not appear in web forms
  • If [Page URL on Submit] has been set, it will be redirected to the specified URL after form submission
  • It is possible to set an IP address filter by each URL of the form
  • The URL of webforms to be published will be in the following syntax format
    • {Your domain}/System/Event/MessageStartForm/{App ID}/{Node number}/{key}/view
    • You can check the URL of web form in the property screen
    • The value specified in the [API key] tab will be inserted into {key}
      • Even though you can specify any character string for the API key, it is recommended to use a random character string that is automatically generated for security reasons
      • The API key can be set with single-byte alphanumeric characters, at most 100 in length
  • You can specify the language of the published form by adding a query parameter to the URL
    • locale=en for English, locale=ja for Japanese
    • Button names and input error messages will be displayed in the specified language
      • For form display items defined in the app, such as Data Item names, the language cannot be switched and is displayed as defined
      • Some button displays follow the language settings of your OS or browser
  • You can specify initial values for input fields when the form is displayed by adding query parameters to the URL
    • e.g.: title=test&q_var1=foobar (specify the [title] or the field name of the Data Items as the parameter name)
    • URL encoding (percent-encoding) is needed when setting non-ASCII characters
    • The details of parameter names and value format are the same as [Message Start Event (HTTP)]
  • There is a possibility that Case will not be started automatically due to the limit of the number of startups of the entire Workflow platform
  • There is a possibility that Case will not be started automatically due to the size limit of the data that can be received

See also

Discover more from Questetra Support

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

Continue reading