ExperSHOP Administrative Actions

Home Contents

Please email any bug reports, comments or suggestions to ExperLog's Online Support

What are Actions ?

Actions are java classes that can be called by ExperShop to perform some tasks.

ExperSHOP comes with predefined actions: for example, the com.expershop.admin.ESAddToCart action adds an item to the shopping cart.

For more details, see the ExperShop actions documentation.

ExperSHOP Administrative actions

Administrative actions are actions that can be invoked from the administration servlet only (com.expershop.lite.ESAdminServlet). Trying to execute them from the ExperSHOP servlet will result in an "Access denied" error (for security reasons).

The following administrative actions are predefined:

Now we'll detail each action, with its input/output parameters.

com.expershop.admin.ESNewDepartment

Create a new shop department. The target database table is EDepartment, and must contain at least a DeptId and a Name fields.

Input parameters:

  • DeptId (MANDATORY) - The department reference (a unique ID)
  • Name (MANDATORY) - The department name
  • Any other field contained in the EDepartment database table: the field's name must exactly match the parameter name.

Output parameters:

Upon success: none.

Upon error:

  • MissingField - the name of the 1st mandatory field that is missing

com.expershop.admin.ESUpdateDepartment

Update an existing shop department. The target database table is EDepartment.

Input parameters:

  • DeptId (MANDATORY) - The department reference (a unique ID)
  • Any other field contained in the EDepartment database table: the field's name must exactly match the parameter name.

Output parameters: none

com.expershop.admin.ESDropDepartment

Delete an existing department. The target database table is EDepartment.

Input parameters:

  • DeptId (MANDATORY) - The department reference (a unique ID)

Output parameters: none

com.expershop.admin.ESNewProduct

Create a new shop product. The target database table is EProduct, and must contain at least a ProdId, a Name and a Price fields.

Input parameters:

  • ProdId (MANDATORY) - The product reference (a unique ID)
  • Name (MANDATORY) - The product name
  • Price (MANDATORY) - The product price
  • Any other field contained in the EProduct database table: the field's name must exactly match the parameter name.

Output parameters:

Upon success: none.

Upon error:

  • MissingField - the name of the 1st mandatory field that is missing

com.expershop.admin.ESUpdateProduct

Update an existing shop product. The target database table is EProduct.

Input parameters:

  • ProdId (MANDATORY) - The product reference (a unique ID)
  • Any other field contained in the EProduct database table: the field's name must exactly match the parameter name.

Output parameters: none

com.expershop.admin.ESDropProduct

Delete an existing product. The target database table is EProduct.

Input parameters:

  • ProdId (MANDATORY) - The product reference (a unique ID)

Output parameters: none

com.expershop.admin.ESDropCustomer

Delete an existing customer. The target database table is ECustomer.

Input parameters:

  • CustId (MANDATORY) - The customer reference (a unique ID)

Output parameters: none

com.expershop.admin.ESUpdateOrder

Update an existing shop order's status. The target database table is ECustOrder, and only the order status and payment status can be affected.

Input parameters:

  • OrdId (MANDATORY) - The order ID (a unique ID)
  • Status (OPTIONAL if PayStatus is present) - The order status (generally one of NEW, PROCESSED, CANCELED or TIMEOUT)
  • PayStatus (OPTIONAL if Status is present) - The order payment status (generally one of WAITING, PAID or UNKNOWN)

Output parameters: none

com.expershop.admin.ESDropOrder

Delete an existing shop order, including the order information header and the order items. The target database tables are ECustOrder and EProdOrder.

Input parameters:

  • OrdId (MANDATORY) - The order ID (a unique ID)

Output parameters: none

com.expershop.admin.ESRemoveCanceledOrders

Delete all orders in CANCELED status, including the order information header and the order items. The target database tables are ECustOrder and EProdOrder.

Input parameters: none

Output parameters: none

com.expershop.admin.ESRemoveProcessedOrders

Delete all orders in PROCESSED status, including the order information header and the order items. The target database tables are ECustOrder and EProdOrder.

Input parameters: none

Output parameters: none