Skip to content

Developer SysAdmin Applet

The platform console behind the applet registry: where BigLedger registers an applet — its code, vendor, store, type and the address the shell loads it from — and maintains what the store shows for it. It is not something a customer opens and has no tenant-level route into it; what it maintains reaches you as the Applet Store listing, and to have an applet added to your catalogue or a listing corrected you ask your BigLedger contact.

Your job, and the screen for it

The jobScreen or tabRead
Get an applet added to your catalogue, or a store listing corrected — not here: customers cannot open this consoleAsk your BigLedger contact; the result shows in the Applet StoreOverview
Set up an access key for an integration — not here: this console holds no credentialsNot in this console — see AuthenticationOverview
Register a new applet (BigLedger staff) — a vendor and a store must exist firstVendor, then Applet; the store in Platform SysAdmin › Applet StoresA worked situation: GadgetSphere’s branch dashboard
Move an applet to a new build address — the save drops anything else in the loading block, such as a Developer-applet short code: note it and put it back; then open it in a tenant that already had itApplet › Details tab, Applet URLLifecycle and effects; What success looks like
Retire an applet — Delete does not delete: set Status to INACTIVE and remove it from its cataloguesDetails tab, Status; catalogues in Platform SysAdminLifecycle and effects

Overview

The Developer SysAdmin Applet is the platform console for the applet registry. It is where an applet is registered — its code, its vendor, its store, its type, the URL the shell loads it from — and where its store-facing detail is maintained: languages, images, edition and plugin pricing, which developers own it, and which tenants have installed it. Its Catalog tab also shows which catalogues the applet sits in, but placing it in one is done in Platform SysAdmin.

It is a platform applet: it does not belong to any tenant module, there is no tenant-level route into it, and it is not something a customer opens. Its tenant-facing counterpart is the Tenant Admin Applet, which governs one tenant’s users, roles and installed applets; this applet governs the registry those tenants draw from.

If you are a customer, you will never need this applet. What it maintains reaches you as the Applet Store: an applet’s name, icon, description, images and categories as the store shows them (the pricing kept here is shown by no store screen), and which applets your catalogue offers. To have an applet added to your catalogue, or a store listing corrected, ask your BigLedger contact.

It holds no credentials. An integration’s access key is not issued, listed or rotated here, and a key’s record names a user, not an applet. If you came here to set up a key for an integration, the page you want is Authentication.

A worked situation: GadgetSphere’s branch dashboard

GadgetSphere’s IT team has built a tablet dashboard that shows each of its 22 branches today’s finalised sales, on the platform library. Two different things now have to happen, and only one of them involves this console.

The data feed needs nothing from here. The dashboard’s server reads sales through the API with a credential issued to a user, as Authentication describes. When the team rotates that credential later, by issuing a new key, moving traffic to it and deleting the old one, nothing in this registry changes and nothing on these screens shows the key.

A tile inside BigLedger needs a registry record. If the team wants the dashboard to open from the launchpad like any other applet, BigLedger registers it here, and the order matters:

  1. A vendor and a store exist first. The form will not save without both. Vendors are created here under Vendor; stores are not created in this console at all but in Platform SysAdmin’s Applet Stores.
  2. The record is created with a code, a type, a Router Link, an Applet URL (the address of the built bundle) and a Custom Element Tag (the element name the bundle defines). The code must be unused, and it is fixed on the Edit screen from then on.
  3. Platform SysAdmin places it in GadgetSphere’s catalogue. Registering puts the applet in no catalogue and installs it for nobody.
  4. GadgetSphere’s administrator installs it and gives the branch managers a role in the Tenant Admin Applet.

Six months on, the team ships a new build of the dashboard at a new address. The change here is one field, the Applet URL, and it has two effects nobody is told about. They are under Lifecycle and effects.

Where it fits

DirectionWhatWhy
UpstreamVendor (here) and applet store (Platform SysAdmin)Both are required before an applet can be saved. A store cannot be created in this console.
DownstreamApplet Store and Applet CatalogEverything a tenant sees in the store — name, icon, description, images, categories — is the record maintained here. The pricing kept here is not among it: the store renders no price.
DownstreamTenant Admin AppletA tenant’s Catalogue and Applets menus list the applets registered here; an applet has to exist here first.
SiblingDeveloper appletThe older four-screen console over the same records. Choose this one for anything beyond registering: vendors, pricing, images, installations, and seeing which catalogues carry an applet.
Blast radiusEvery tenant that has the applet, or installs it laterA wrong Applet URL or tag is copied by every tenant that installs the applet afterwards, and may reach those that already have it (see Lifecycle and effects).
Pairs withAuthentication and the platform libraryA custom integration usually needs a credential and a backend; it needs this console only if it is also a tile in the shell.
AlongsideVendor and module recordsDecide who owns an applet and which module groups it.

Screens and menus

The console’s menus are Applet, Vendor, Modules, Categories and Developer:

  • Applet — each applet’s code (fixed once created), name, vendor, store, type, status and the help link the product opens for it, with its store detail: languages, images, edition and plugin pricing (which the store does not show), and which catalogues carry it (shown here, placed in Platform SysAdmin) and which tenants have it.
  • Vendor and Modules — who owns an applet, and which module an applet is grouped under.
  • Categories and Developer — store categories and developer records.

The figures on these screens, and what each one is

Screen and columnRead fromWhat to know
Applet listing, orderThe platform record’s last-saved time, newest firstThe applet you saved last is on the first row.
Applet listing, Date Modified; Details, Created Date / Updated DateThe times the server stamps on create and on every saveShown as YYYY-MM-DD HH:MM:ss, where the middle MM is the month, not the minutes. Trust the date and the hour.
Applet listing, Rank and No. of DevelopersNothingAlways blank.
Applet listing, column filtersThe page already loadedA header filter narrows only the rows on screen. Use the search box to search the whole registry.
Details, Created By / Updated ByDepends on the menu you came fromOpened from Applet, always Data not available…. Opened from a vendor’s Applets tab, the same applet shows e-mail addresses, because that tab looks up the people the server recorded on create and on each save.
Catalog tab, No. of UsersA live figure: the user installs under that catalogue link, counted each time the tab loadsShows 0 if the count call fails, which looks the same as a real zero.
Installations tab, Installed DateThe install record’s last-saved timeIt moves whenever the install record is saved again, so it can be later than the real install. A user with no e-mail sign-in shows a blank User Email.
Events tabA fixed sample rowThe same row on every applet. It is not an event log. The Client-Side Permission tab’s list is a sample row too.

Configuration

There is nothing for a customer to configure: only BigLedger platform staff can open this applet, and it has no settings a tenant can reach.

Fields

The forms are used by BigLedger staff only. What reaches customers is what they produce: the applet’s name, icon, description and images as the Applet Store shows them. Four fields on the applet’s Details tab earn a note because their effect is not on the screen:

FieldWhat the screen does not tell you
Applet CodeMust be unused when you create the applet, and read-only on Edit. The screen enforces that; the server’s own update check refuses only a blank or duplicate code.
Router Link, Applet URL, Custom Element TagSaved together as one loading block, and replaced as a whole on every Edit save (see below).
StatusOffers ACTIVE and INACTIVE only. INACTIVE is not shown to take an applet out of a catalogue (see below).
TypeOne of ten fixed types, such as ROOT-ADMIN or TNT-USER. The server refuses anything else.

Lifecycle and effects

Everything here is the platform’s applet registry. Nothing posts a journal, moves stock or creates a document in any tenant. Its code cannot be changed from the Edit screen once it has been created (the screen keeps it read-only; the API’s own update check refuses only a blank or duplicate code).

Create sends the form to the server, which stamps the record’s created and modified times, checks that the code is unused and the type is one of the ten, and stores it. The applet is then known to the platform, in no catalogue and installed for nobody.

Edit, then Save reads the record again, writes the form’s values over it and saves the whole record back. Two consequences follow, and they matter on the day the GadgetSphere dashboard moves to a new build:

  • The loading block is rebuilt from the three fields on the form. Anything else that record held in that block is dropped without a warning, such as the two-character short code the Developer applet writes. Before you save, check whether the applet came from the Developer applet. If it did, note what it carries there and put it back after the save.
  • The change is made to the platform record only. When a tenant first installs an applet, that tenant’s database takes its own copy of the record. Nothing in the backend we read refreshes that copy after a later Edit here. We have not established which of the two copies the shell reads to find the bundle. So after moving an applet to a new address, open it in a tenant that already had it, not only in a fresh one.

Delete does not delete. The Delete button on the Details tab sends a request the server has no route for, so it ends in an error toast and the applet stays exactly as it was. The tab for retiring an applet is hidden. To stop using an applet, set Status to INACTIVE and save. Then also remove it from its catalogues in Platform SysAdmin. The route that lists a public catalogue’s applets does not check the applet’s own status, so INACTIVE on its own is not shown to hide it.

Neither step reaches people who already installed it: the Applet Store’s Private tab lists an INACTIVE applet, and the platform keeps issuing applet tokens for it to every login that has it installed until the row is DELETED. So also have each of them uninstall it in the Applet Store, which stops new applet tokens for their login.

What success looks like

A thirty-second check after you register or change an applet here:

  1. The listing. Your applet is on the first row. Its Date Modified matches today’s date and the current hour. Ignore the minutes.
  2. The Details tab. Router Link, Applet URL and Custom Element Tag read exactly as you typed them. If the record came from the Developer applet, its short code is still there.
  3. A tenant that already had the applet. Open it from the launchpad. It loads the build you expect, not the old one.
  4. The Catalog tab. It lists the catalogue you meant, with the tenant and a user count you recognise. For GadgetSphere, that is its catalogue with the branch managers who were given the role.

If step 3 fails while a fresh tenant works, the old tenant is still using its own copy of the record. Raise it with the platform team rather than editing again.

Related applets

  • Tenant Admin Applet — the tenant-side counterpart. It reads the registry this applet writes.
  • Applet Store and Applet Catalog — the customer-facing view of the same records.
  • Platform SysAdmin — places the applets registered here into catalogues and stores, and installs them for users. Stores are created there, not here.
  • Developer applet — the older registration console over the same records. A save here can drop what it wrote.
  • Scheduler — the other console in this section, and an unrelated one. A scheduled job is a row in the tenant’s own database. Nothing registered here switches a job on or off.

Troubleshooting

SymptomCauseFix
An applet’s store listing is wrong or out of dateThe listing is maintained here, by BigLedgerTell your BigLedger contact what is wrong
An applet you expect is missing from the storeIt is not registered, not active, or not in your catalogueAsk your BigLedger contact
Delete shows an error and the applet is still listedThe Delete button calls a route the server does not haveSet Status to INACTIVE, then remove the applet from its catalogues in Platform SysAdmin
An applet set to INACTIVE still appears in a catalogueThe catalogue route does not check the applet’s statusRemove the applet from the catalogue in Platform SysAdmin
After a new Applet URL, one tenant still loads the old buildThat tenant may be using the copy it took at first installReport the tenant and the applet to the platform team
An applet registered with the Developer applet lost its short code after a save hereThe Edit save rebuilds the loading block from three fieldsPut the short code back from the Developer applet
Every Date Modified this month shows the same minutes, such as :10 all through OctoberThe display puts the month where the minutes belongRead the date and hour only

Related documentation

Last updated on