Administrator guide

For the person who installs, configures, and supports the product.

Requirements

ComponentRequirement
Fishbowl2026.10 or later
PluginILC CloudPages plugin
Custom fieldsOne for the area per box and one for the boxes per pallet, on Part or on Product. The Settings dialog can create them.
Unit of measureEach product sold by area uses a unit of measure in the unit the page is set to: square meters or square feet.
Access rightCreate Sales Order, for a user who adds lines

The page reads with SQL and writes through the Fishbowl API. It needs no other server component.

Installation

Installation is the same for every ILC catalog page. For the full steps, see https://ilcreports.com/how-to#install.

  1. Buy the page on ilcreports.com.
  2. Install the CloudPages plugin in Fishbowl.
  3. Configure CloudPages with the manifest URL from the purchase.
  4. Confirm that the purchased pages appear in the installation.
  5. Grant page access to the users who need it.

Verify. Open a saved sales order. Click Sell by Area in its toolbar. Click ? to run the guided tour. The tour changes nothing in Fishbowl.

To configure the page, see Settings.

Updates

Updates are the same for every ILC catalog page.

A customer gets the latest stable version of a page by default. To stay on a previous version, or to return to one, choose the version in the ilcreports.com portal.

Fishbowl keeps its own data through an update. The plugin data in Fishbowl holds the access rights, the module placement, and the page settings. This data also survives a page removal.

For what changed in each version, see the release notes.

Security

The page reads two access rights.

RightWhat it changes
Create Sales OrderA user without it meets a disabled Add product and a disabled Review and update. The page then only shows the order's lines.
AdministrationA user without it cannot open the Settings dialog. The page shows "Settings are open to an administrator only."

This check hides a control. It does not enforce access. The page asks the Fishbowl client whether the user holds the right, and the client answers from credentials it already has. Treat the result as visibility.

Two facts follow from how the client answers.

  1. A user named admin passes every right check. Do not test this page's gating with the admin account.
  2. If the Fishbowl subscription lapses, every right that is not a view right returns false. The admin account loses access too.

Who to grant access to. A user who can open the page can read the lines of the open sales order, every active product with its list price and its available stock, and the custom field names on Part and Product. A query through the bridge is not right-checked. Grant page access to the people who take orders for products sold by area: counter staff and inside sales.

Considerations

The page adds lines to a sales order. It never changes or deletes a line that is already on the order.

Every added line takes the sales order's own tax code and class, not the product's defaults. Its price is the one Fishbowl quotes for this customer at the line quantity, written on the line explicitly.

Create a custom field in the Settings dialog creates a Text custom field on Part or Product through the Fishbowl import. It creates nothing else, and it changes no existing field.

Data handling

Every query and API call the page makes:

OperationAgainstRight checked
Queryso, customer, taxrate, qbclass: the order number, customer, tax code, and classNone
Querysoitem, product, part, uom: the order's standard lines, with the two custom fieldsNone
Queryproduct, part, qtyinventorytotals, uomconversion: the active products and their available stock, when Add a product opensCreate Sales Order
Querycustomfield: the field lists in SettingsAdministration
API ProductPriceRqThe customer's price at the area typedCreate Sales Order
API AddSOItemRqOne call for each staged lineCreate Sales Order
Import ImportCustomFieldsOne field, from Create a custom fieldAdministration
Plugin data readSellByAreaPage, for the settingsNone
Plugin data writeSellByAreaPage, from the Settings dialogAdministration

The page sends one AddSOItemRq for each line. One line failing does not stop the others. Fishbowl reports a refusal inside its answer, not as an error: the page reads the status code, marks the line failed, and shows Fishbowl's message.

The custom field import reports success whether or not it created the field. The page reads the field list back, and reports a failure when the field is not there.

What leaves the Fishbowl client. The failed lines, when a user clicks Save the failures. That is a CSV file of the number, description, boxes, quantity, and reason for each failed line. The user chooses where to save it. Nothing else leaves the client, and the page sends nothing to ILC.

Settings

An administrator sets these in the Settings dialog, the gear. They apply to every user of the page. The page works before anybody changes a setting.

SettingDefaultWhat changes
Row heightMediumThe height of the grid rows: Compact, Small, Medium, or Large.
Unit of areaSquare metres (m²)The unit the page shows and writes. Square feet (ft²) is the other choice.
Area per boxPart field m2 Per BoxThe custom field that holds the area one box covers.
Boxes per palletPart field Boxes Per PalletThe custom field that holds the boxes in one pallet.

If Area per box is still on its default, a change of unit moves it with the unit: ft² reads Part field sqft Per Box, and m² reads m2 Per Box. A field an administrator chose stays as chosen.

A field that was chosen and later deleted or made inactive stays in the list, marked "missing". The page then counts every box as one unit of area.

The theme control in the page header switches light and dark for the user who clicks it. The page otherwise follows the theme of the Fishbowl client.

A badge in the page header reads Demo when the page reaches no Fishbowl. Connected to Fishbowl, the page shows no badge, because that is the normal state.

These values are fixed and no one can change them:

LimitValue
RoundingUp, to a whole box.
Line quantityBoxes times the area per box, to two decimal places, in the product's unit of measure.
Line noteTotal Cartons = and the box count.
Blank box sizeA blank or missing area per box counts as 1. A blank boxes per pallet counts as 1.
Lines shownStandard sales lines only. Other line types are not listed.
Products listedActive products whose part is an inventory part.
AvailableOn hand less allocated and not available, across every location, in the product's unit of measure.
Unit conversionNone. The page writes the number in the unit it is set to.
Window1100 by 700 pixels

Change where the page appears in the CloudPages plugin page Edit dialog:

PlacementDefault
PathApps:ILC Products
ModulesSales Order
Toolbar buttonSell by Area

Troubleshooting

The page says to open a sales order first

Add product and Review and update are disabled

Every product shows one unit of area per box

The line quantity is more than the user typed

The line quantity is in the wrong unit

A product is missing from Add a product

The price differs from the product's price

Available does not match the order's location

A line failed to write

Create a custom field reports a failure

Before a support request

When a line fails, click Save the failures in the Result window. The file names each failed line and Fishbowl's reason.

Collect: