These are methods for gathering reporting information from Storefront.
Retrieve ledger entries from Storefront deployment.
Method
SINILedgerEntry[] GetLedgerEntries(string operatorID,
string orderID,
DateTime startTimestamp,
DateTime endTimestamp)
Parameters
■ operatorID — Internal identity ID of the operator, or null to get all operators
■ orderID — Internal order identifier, or null to get all orders.
■ startTimestamp — Start time for the search.
■ endTimestamp — End time for the search.
Returns
An array of SINILedgerEntry objects corresponding to the requested ledger entries, oldest first.
Retrieve log entries from Storefront deployment.
Method
SINILogEntry[] GetLogEntries(string userID,
string orderID,
string documentID,
DateTime startTimestamp,
DateTime endTimestamp)
Parameters
■ userID — Internal user identifier to search for, or null to get all users.
■ orderID — Internal order identifier to search for, or null to get all orders.
■ documentID — Internal document identifier to search for, or null to get all documents.
■ startTimestamp — Start time for the search.
■ endTimestamp — End time for the search.
Returns
An array of SINILogEntry objects corresponding to the requested log entries, oldest first.
Return a doubly-indexed array of strings corresponding to the Data Grid for a particular display on the Storefront Administrator pages.
Method
public string[][] GetReport(string reportName,
bool isArchived,
string filterName,
string[] columnNames)
Parameters
■ reportName — Name of the report, which is normally associated with a data grid on a Storefront Administrator page; these are:
reportName | Administrator Page |
|---|---|
AdminAccounts | Admin Accounts |
Events | Logs (“Events” tab) |
Items | Orders (“Show Items” tab) |
ItemsApprovalQueue | Approval Queue |
ItemsFinance | Finance |
ItemsPrepQueue | Prep Queue |
ItemsProductionQueue | Production Queue |
ItemsShippingQueue | Shipping Queue |
Ledger | Ledger |
Orders | Orders (“Show Orders” tab) |
OrdersApprovalQueue | Approval Queue |
OrdersFinance | Finance |
OrdersPrepQueue | Prep Queue |
OrdersProductionQueue | Production Queue |
OrdersShippingQueue | Shipping Queue |
Sessions | Logs (“Sessions” tab) |
UserAccounts | User Accounts |
■ isArchived — true if requesting archived items, false if requesting the non-archived ones.
■ filterName — One of the named filters (including custom filters added by an admin), for example “Completed Orders With Balance Due”. The rows in the report are the ones matching that filter. In case of a name conflict, the filter in AdminFilters.xml wins.
■ columnNames — Columns to appear in the table, for example “Order Status”. See the “Choose Column” link of the Storefront Administrator site page corresponding to the report.
Returns
A doubly-indexed array of strings with the requested values, or null if it fails.
Return a doubly-indexed array of strings corresponding to the Data Grid for a particular display on the Storefront Administrator pages. This includes arguments limiting the total number of items returned, and for where to start in the totality of items, as could be used to implement paging.
Method
public string[][] GetReport2(string reportName,
bool isArchived,
string filterName,
string[] columnNames,
int start,
int count)
Parameters
■ reportName — Name of the report, which is normally associated with a data grid on a Storefront Administrator page; these are:
reportName | Administrator Page |
|---|---|
AdminAccounts | Admin Accounts |
Events | Logs (“Events” tab) |
Items | Orders (“Show Items” tab of Table View) |
ItemsApprovalQueue | Approval Queue |
ItemsFinance | Finance |
ItemsPrepQueue | Prep Queue |
ItemsProductionQueue | Production Queue |
ItemsShippingQueue | Shipping Queue |
Ledger | Ledger |
Orders | Orders (“Show Orders” tab of Table View) |
OrdersApprovalQueue | Approval Queue |
OrdersFinance | Finance |
OrdersPrepQueue | Prep Queue |
OrdersProductionQueue | Production Queue |
OrdersShippingQueue | Shipping Queue |
Sessions | Logs (“Sessions” tab) |
UserAccounts | User Accounts |
■ isArchived — true if requesting archived items, false if requesting the non-archived ones.
■ filterName — One of the named filters (including custom filters added by an admin), for example “Completed Orders With Balance Due”. The rows in the report are the ones matching that filter. In case of a name conflict, the filter in AdminFilters.xml wins.
■ columnNames — Columns to appear in the table, for example “Order Status”. See the “Choose Column” link of the Storefront Administrator site page corresponding to the report.
■ start — Index of where to start in the totality of items, with zero referring to the first item. This is ignored if the count argument is zero.
■ count — Maximum number of items to be returned. If zero, then we revert to the behavior of GetReport, returning up to the GlobalData value MaxCustomViewRows (default 5000).
Returns
A doubly-indexed array of strings with the requested values, or null if it fails.
Since version 9.6.4
Returns the number of items corresponding to the Data Grid for a particular display on the Storefront Administrator pages. This can be used when determining useful values for start and count in the GetReport2 request, above.
Method
public int GetReportCount(string reportName,
bool isArchived,
string filterName)
Parameters
■ reportName — Same as the value in GetReport2, above.
■ isArchived — true if requesting archived items, false if requesting the non-archived ones.
■ filterName — Same as the value in GetReport2, above.
Returns
The totality of archived or non-archived items matching the given reportName and filterName.