Overview

This action allows you to open a URL. Typically the URL is returned as the result of a ClearProcess API call and thus openUrl appears in the successActions. Valid page components for this action are:

  • ActionButton – use the onClick property.

Properties

PropertyDescription
nameSet this to “openUrl” to use this action.
urlThe URL to be opened. This refers to a location in the Redux data store.
newTabSet this to true if you want the URL opened in another browser tab.

Example

Add the following to your component:

"onClick": [
  {
    "action": "apiAction",
    "api": "OfficeDepotSetup",
    "successActions": [
      {
        "name": "openUrl",
        "parameters": {
          "url": [
            "app",
            "payload",
            "OfficeDepotSetup",
            "xml",
            "cXML",
            "Response",
            "PunchOutSetupResponse",
            "StartPage",
            "URL"
          ],
          "newTab": false
        }
      }
    ]
  }
]