Service Addons

107 Aufrufe Markdown

Follow every add-on sold across this installation on a single list, so a suspension, a cancellation or a clean-up is finished in one pass instead of service by service.

Opening the Screen

Open Orders › Service Addons from the main menu: {admin}/services/addons. It is the panel-wide view of the records a service's Addons tab shows.

The menu entry counts the add-ons still at Pending Approval or In Progress, so you see there is work waiting before opening the screen.

Filter values travel in the address, so a saved link lands on an already narrowed list: {admin}/services/addons?filter[status]=waiting.

What Is on the Screen

Three bands: an options row, an advanced filter panel that stays closed until a filter carries a value, and the list. Below 768 pixels the options row folds behind Show Options.

The Options Row

Apply to Selected sits on the left and only appears when your role may operate on services. Its four choices are Activate, Suspend, Cancel and Delete. Picking one opens a confirmation window at once, then the selector clears. With no row ticked, nothing happens.

On the right sits Service Status, carrying every status the panel knows: Pending Approval, In Progress, Active, Completed, Suspended, Expired and Cancelled. Next to it, Advanced Filter opens the panel below and badges the number of advanced filters filled in.

The Advanced Filter Panel

The panel opens by itself when a filter is already in the address, so you can see why the list is short. The left box narrows by identity (Addon ID, Addon Name, Client, Service ID), the right one by billing (Billing Cycle, Start Date Range, End Date Range).

The date boxes open a calendar, and the symbol button beside each one switches the comparison: Equals, On or After, After, On or Before, Before, Exclude Date. Closing the panel clears every filter it holds and reloads the list.

The Add-on List

One row per add-on record, across every client and every service, sorted by status first so anything waiting floats to the top.

ColumnWhat it showsSorting
SelectionFeeds Apply to Selected; the header box takes the whole page.Not sortable
ClientName, company and, for staff allowed to open client records, a link to that record.Not sortable
ServiceThe parent service, linked, with its record number underneath.Not sortable
AddonAddon name, option name below it. A quantity above one shows as a small badge before the option.Not sortable
End DateThe add-on's own due date, or a dash when it carries none.Sortable
PriceTotal amount when one was calculated, otherwise the unit amount, cycle underneath.Sortable
StatusThe status badge of the add-on record.Sorted first by default
(actions)Row menu with View and, with the operation privilege, Delete.Not sortable

Rows needing attention carry a faint tint: red for Pending Approval, blue for In Progress, amber for Suspended. The search box matches the addon name, the option, the service name and the client's name or e-mail; the download icon beside it appears when your role may export tables.

The Addon Details Window

View in the row menu opens the Addon Details window, titled with the add-on's own record number. It is the window the service's Addons tab opens, with the same four cards (Client & Service, Addon Information, Date Details, Billing Details) and a Save Changes button that stays disabled until something changes. Saving closes it and reloads the list. Its walkthrough is in Addons of a Service.

Fields

The controls of the options row and the advanced filter panel.

Apply to Selected Shown only with the operation privilege. A choice opens a confirmation window at once, then the selector clears. Does nothing while no row is ticked.
Service Status Optional, empty by default, which means every status.
Addon ID Optional. The record number of the add-on itself, not of the service; an exact match.
Addon Name Optional. Partial match on the name stored on the record, the one the client sees.
Client Optional. Searches clients as you type; keeps only that client's add-ons.
Service ID Optional. Every add-on of one service; the number is printed under the service name.
Billing Cycle Optional, All by default. Lists the panel's billing cycles, One Time included.
Start Date Range Optional. Calendar range over the date the add-on started; a single date keeps that day. It narrows the list only while the list is served page by page from the server, which happens once the installation holds more than five hundred add-ons; in the ordinary view it leaves the list as it is.
End Date Range Optional. Same range control over the due date, the one for finding what is about to renew.

Tasks

Narrowing the List

  1. Pick a state in the Service Status selector on the options row, for instance Pending Approval.
  2. For anything finer, press Advanced Filter next to it and fill in what you need: client, service number, cycle or the end date range.
  3. The list narrows as you go and the counter under it reports how many rows are left; the badge on the button says how many boxes are filled in.

Activating, Suspending or Cancelling Several Add-ons

  1. Tick the rows in the first column, or use the box in the column header to take the whole page.
  2. Choose Activate, Suspend or Cancel in Apply to Selected. A confirmation window opens, naming the number of add-ons and what the action does.
  3. Decide on Apply via API there; it is offered, and ticked, when at least one selected add-on belongs to a service bound to a module.
  4. Suspending or cancelling more than one record also asks for your admin password, the same guard the delete window uses; activating never does.
  5. Press the confirm button in the window footer (Activate, Suspend or Cancel Addons). The list reloads, and the status badges and row tints follow the new state.

Deleting Add-ons

  1. For a single record open its row menu and choose Delete; for several, tick them and choose Delete in Apply to Selected.
  2. Read the two information boxes in the Delete Addon Confirmation window (Delete Addons Confirmation for several) and decide on Apply via API, ticked when a module is involved. More than one record also asks for your admin password.
  3. Press Delete in the window footer. The rows leave the list at once, and each deletion is recorded in the action log.

Opening a Single Add-on

  1. Open the row menu at the end of the row and choose View.
  2. Work in the Addon Details window: status and manage actions in Client & Service, product and option in Addon Information, dates and pricing below.
  3. Press Save Changes in the window footer. The window closes and the list reloads with the new values.

Taking the List out of the Panel

  1. Narrow the list first: what leaves the panel is the filtered set, not the page you are looking at.
  2. Press the download icon at the right of the search box line and pick a format. The file drops the tick box and the row menu, and adds the record number the list hides as its own column.

Things to Watch

A bulk action reports success even for rows it could not change

Each selected add-on is handled on its own, and a record that refuses to move is quietly skipped while the message still reports success. After the list reloads, check the Status column of the rows you picked.

Deleting is not the same as cancelling

Cancel leaves the record in place with a cancelled status, so the history stays readable. Delete removes it, and with Apply via API ticked the resource on the server too. Neither can be undone here.

Apply via API decides how far the change travels

Left ticked, the action is also sent to the server or external system behind the service. Unticked, only the record in this installation changes, which is what you want when the resource is already gone there.

Required Privileges

Opening the screen and the details window needs SERVICES_LOOK or SERVICES_OPERATION. Bulk actions, deleting and saving the window need SERVICES_OPERATION; without it the tick boxes, the bulk selector and the Delete entry are not printed and the screen is read-only.

War das hilfreich?

Vielen Dank für Ihre Rückmeldung!

Brauchen Sie weitere Hilfe?

Unser Support-Team ist rund um die Uhr für Sie da, wenn Sie oben nicht fündig werden.