Actions

This action allows you to add a row to a DataTable while in Create or Change mode. The only parameter is the name of the DataTable. Upon save, these new rows are passed to ClearProcess with a field called CRUD_TYPE whose value is set to “I”. Valid page components for this action are:

• ActionButton

Add the following to your component:

"onClick": {
  "name": "addRow",
  "name": "ITEMS"
}

By far the most used action in ClearWork, this allows you to call a Clear API using values from fields on the page and static values. Valid page components for this action are:

• Input – the onBlur property can be used to trigger this action.
• Tab – the onClick property can be used to trigger this action.
• ActionButton – the onClick property can be used to trigger this action.
• Page – the willMountActions property can be used to trigger this action.
• ModeSwitcher – the onSave and onCancel properties can be used to trigger this action.
• RpcForm – the submitActions property can be used to trigger this action.

Add the following to your component:

"onClick": {
  "action": "apiAction",
  "api": "GetAttachments",
  "dynamicParameters": {
    "CUSTOMER": [
      "payload",
      "GetCustomer",
      "HEADER",
      "KUNNR"
    ]
  },
  "parameters": {
    "TYPE": "KNA1"
  },
  "successActions": [
    {
      "action": "hideModal",
      "name": "searchCustomers"
    }
  ],
  "errorActions": [
    {
      "action": "showModal",
      "name": "errorMessages"
    }
  ]
}

Another variant of apiAction, this action allows you to call a ClearProcess API based on a file uploaded by the user. Valid page components for this action are:

• ActionButton

Add the following to your component:

"onClick": {
  "action": "apiFromFile",
  "api": "GetAttachments",
  "dynamicParameters": {
    "CUSTOMER": [
      "payload",
      "GetCustomer",
      "HEADER",
      "KUNNR"
    ]
  },
  "parameters": {
    "TYPE": "KNA1"
  },
  "successActions": [
    {
      "action": "hideModal",
      "name": "searchCustomers"
    }
  ],
  "errorActions": [
    {
      "action": "showModal",
      "name": "errorMessages"
    }
  ]
}

This allows you to call a ClearProcess API from within a ModeSwitcher using keys specified in the ModeSwitcher. Valid page components for this action are:

• ModeSwitcher – the onSave property can be used

Add the following to your component:

"onSave": {
  "action": "apiFromKeys",
  "api": "CreateSalesOrder",
  "successActions": [
    {
      "action": "changeMode",
      "parameters": {
        "mode": "display"
      }
    },
    {
      "name": "setIn",
       "parameters": {
         "value": {},
          "key": [
            "user_parameters"
          ]
       }
    }
  ],
  "errorActions": [
    {
      "action": "showModal",
      "name": "errorMessages"
    }
  ]
}

Another variant of apiAction, this action allows you to call a ClearProcess API based on a clicked hyperlink in a row of a DataTable. Valid page components for this action are:

• DataTable – you can add an ActionLink to a column and then assign an action to the onClick property of the ActionLink

Add the following to your component:

"component": {
  "name": "ActionLink",
  "onClick": [
    {
      "action": "apiFromRow",
      "api": "GetFileAttachment",
      "columns": [
        "ATTA_ID"
      ],
      "successActions": [
        {
          "action": "changeMode",
          "parameters": {
            "mode": "display"
          }
        },
        {
          "name": "setIn",
           "parameters": {
              "value": {},
              "key": [
                "user_parameters"
              ]
           }
        }
      ],
      "errorActions": [
        {
          "action": "showModal",
          "name": "errorMessages"
        }
      ]
    }
  ]
}

A variant of apiAction, this action allows you to call a ClearProcess API based on rows currently selected in a DataTable. Valid page components for this action are:

• ActionButton – use the onClick property.

Add the following to your component:

"onClick": [
  {
    "action": "apiFromSelected",
    "api": "ApprovePurchaseOrders",
    "name": "WORKLIST".
    "key": "TO_BE_APPROVED", 
    "successActions": [
      {
        "action": "changeMode",
        "parameters": {
          "mode": "display"
        }
      },
      {
        "name": "setIn",
         "parameters": {
            "value": {},
            "key": [
              "user_parameters"
            ]
         }
      }
    ],
    "errorActions": [
      {
        "action": "showModal",
        "name": "errorMessages"
      }
    ]
  }
]

This action allows you to change the state of a page from its current state to a new state. Valid states include create, edit, and display. Valid page components for this action are:

• ModeSwitcher – within the onSave and onCancel properties, use the successActions properties.
• ActionButton – use the onClick property.

Add the following to your component:

{
  "actionName": "changeMode",
  "parameters": {
    "mode": "display"
  }
}

This action allows you to clear the values of components in a page. The valid components that can be cleared are inputs, datePickers, timePickers, textAreas dataTables, and checkboxes. Valid page components for this action are:

• ModeSwitcher – use the onCreate property.
• ActionButton – use the onClick property.
• Input – use the onBlur property.

Add the following to your component:

{
  "actionName": "clear",
  "inputs": [
    "CUSTOMER",
    "SHIP_TO"
  ],
  "textAreas": [
    "SHIPPING_NOTES"
  ],
  "datePickers": [
    "REQUESTED_DELIVERY"
  ],
  "timePickers": [
    "DELIVERY_TIME"
  ],
  "dataTables": [
    "ITEMS",
    "PARTIES"
  ]
}

This action allows you to clear all data in a page. Valid page components for this action are:

• ModeSwitcher – use the onCreate property.
• ActionButton – use the onClick property.

Add the following to your component:

{
  "actionName": "clearAll"
}

This action allows you to download the layout of a DataTable as a CSV template. You can use this template to fill data in the CSV file and then upload data back into the DataTable. Valid page components for this action are:

• ActionButton – use the onClick property.

Add the following to your component:

"onClick": {
  "action": "downloadCSVTemplate",
  "name": "ITEMS"
}

This action allows you to download the selected rows of a DataTable to Excel. If no rows are selected, the entire contents of the DataTable are downloaded. Valid page components for this action are:

• ActionButton – use the onClick property.

Add the following to your component:

"onClick": {
  "action": "downloadSelectedAsCSV", 
  "name": "ITEMS"
}

• ActionButton – use the onClick property.

Add the following to your component:

"onClick": {
  "actionName": "duplicateSelected", 
  "name": "ITEMS"
}

• ActionButton – use the onClick property.

Add the following to your component:

"onClick": {
  "actionName": "extractSelected", 
  "name": "ITEMS", 
  "to": "ITEMS_TO_BE_PAID"
}

• ActionButton – use the onClick property.

Add the following to your component:

"onClick": {
  "actionName": "hideModal", 
  "name": "payItems"
}

• ActionButton – use the onClick property.

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
        }
      }
    ]
  }
]

This allows you to refresh the ClearWork page in your browser. This is the equivalent of clicking your browser’s refresh button or pressing the F5 button (PC) or Command+R (Mac). This is useful when you’ve made many changes to a record that you would like to discard and retrieve the original record. Valid page components for this action are:

• ModeSwitcher – the onCancel propertied can be used.
• ActionButton – the onClick property can be used.

Add the following to your component:

"onCancel": [
  {
    "action": "reloadPage"
  }
]

This allows you to scroll to the top automatically if your page is very long. Valid page components for this action are:

• ModeSwitcher – the onCreate and onCancel propertied can be used.
• ActionButton – the onClick property can be used.

Add the following to your component:

"onClick": [
  {
    "action": "scrollToTop"
  }
]

This allows you to initialize data in the Redux data store. This is useful when you want to clear out previous search results or any time you want a prior ClearProcess API call’s results to be erased. Valid page components for this action are:

• ModeSwitcher – the onCreate and onCancel propertied can be used.
• ActionButton – the onClick property can be used.
• RpcForm – the submitActions property can be used.

Add the following to your component:

"onCreate": {
  "name": "setIn",
  "parameters": {
     "value": {},
     "key": [
       "user_parameters"
     ]
  }
}

• ActionButton – use the onClick property.
• Input – use the onSearch or onBlur properties.

Add the following to your component:

"onSearch": {
  "action": "showModal", 
  "name": "customerSearch"
}

• ActionButton – use the onClick property.

Add the following to your component:

"onClick": {
  "action": "toggleAll", 
  "name": "ITEMS"
}

• ActionButton – use the onClick property.
• Input – use the onBlur property.

Add the following to your component:

{
  "action": "updateDefaultValue",
  "column": "PLANT",
  "name": "ITEMS"
}

• ActionButton – use the onClick property.
• Page – use the willMountActions property.
• ModeSwitcher – use the onCreate property.

Add the following to your component:

{
  "action": "updateDefaultFields",
  "source": [
    "payload",
    "GetCustomerDefaults",
    "DEFAULTS"
  ],
  "fields": [
    "PLANT", 
    "CURRENCY"
  ]
}

• ActionButton – use the onClick property.
• Input – use the onBlur property.

Add the following to your component:

{
  "action": "updateDefaultValue",
  "column": "PLANT",
  "name": "ITEMS"
}