Docs Designing the system 2
Finding your way around
On this page
The shell. On the left, the navigator shows your favorites: the objects, screens, transactions and AI report layouts you starred (☆), in the order you starred them, on every device. Everything else shared with you is found by search: type a few letters of its name, or of what it is ("screen", "transaction"), and star it to keep it. Show all lists everything at once (objects by area, then screens, transactions and AI reports) until you leave the page; Show only favorites goes back. The same search box also finds records, by any of their values you may read (a number, a name, the title of what they refer to; never by an id, so a record is not found by part of the id it holds of another), each showing where it stands: its state, in its colour, and the first fields of its object's list (a tool's process and why it is down, a PM schedule's next date). A designer chooses those fields by the order of the list's columns. Your favorites are also the cards on the home page. Under Data are Query, AI Report (each for those who may use it) and Import / export; under Design the Designer, Approvals, Suites, People & departments and the Integration monitor (if you hold any role on the designer: a designer, a reviewer or an approver), and Sign-in administration, Database, Data retention and Data integrity for their administrators, privacy officers and reviewers. An installed suite may add pages of its own, under Data, Design or a heading of its own. On the right, every page you open becomes a tab, tinted by what it holds: a change request faint amber, a screen faint blue, a transaction faint green, an object's list or record faint violet (the open tab has a line of that colour along its top instead). A row of tabs never wraps or scrolls: the tabs that fit are drawn whole, the open one always among them, and the rest are under N more at its end. At most 12 stay open: opening one more closes the oldest. A group's header menu may put its pages in the top bar and hide the navigator behind a button, or not offer it (section 10, Menus); the navigator's edge can be dragged wider or narrower. Pointing at a cell of any list shows a button to copy what it holds.


What is this? The ? at the top left of a page or a panel opens its guide, on the left where the navigator was: what each thing on it is, and how to use it (a checkbox, radio buttons, a drop-down, a scan field, a table, a button). Point at an item of the guide and the thing it is about is outlined on the page. A record's and a transaction's guide is made from their design, so it always matches the form you see. Esc or × closes it.
Show details / Hide details. Beside a record's, a transaction's or a screen's title: Hide details leaves out a record's tabs (Details, Timeline, History, Why?) and the words under its fields (their help, why one is read only), so the page shows the fields alone; Show details brings them back. It holds as you move from page to page, and is not kept: the next time you open the app, pages open as your plant has chosen (People & departments → Theme).
Light or dark. In the top bar, beside live: as your device is set, light, or dark. Your choice follows you to every device. On a phone it is one button: tap it for the next. If your plant has chosen one for everyone (a shop floor's screens), there is no choice to make, and it is not shown.
The designer home (/_design) is a row of tabs, one per kind of design, described below under
What waits for you. On a design's row, Change opens (or reuses) a change request for it; open
change means one is already in progress. AI access issues the tokens that let an AI work as you
(section 14).
Roles in the designer. You may be a designer (you draft), a reviewer, and/or a department representative (you approve for your department). A reviewer who is not a designer reads and approves but does not draft.
The seeded people. In development, on the demo and in a test instance, you sign in by picking a seeded person. Dana and Iris (IT) design; Eli, Vera, Sam, Quinn, Ivan, Ines and Iris review; Sam and Quinn represent Production and Quality, Dana and Eli Engineering; IT approves in two steps, Ivan (Specialist) then Ines (Manager).
Signing in. The demo has no sign-in: you arrive as a designer, and press your name at the top right to be anyone else (you stay on the page you are on). In development, or a test instance with the picker on, you pick who you are at sign-in, and switch the same way from your name. Ready to switch to: those you picked lately in this browser, whoever has something waiting to review or sign, and everyone who reviews or approves; type a few letters of a name to find anyone else. At a plant you sign in the way it has set up: Sign in with its single sign-on, or your sign-in id and password (the plant directory's, or one of your own that IT gave you a link to set). The page may carry the plant's logo, title, a message and a notice over its own picture (People & departments → Sign-in), and a Language choice where the plant offers several. You can sign in only once People & departments has you, as active; if the page says you are not there, ask whoever keeps it. Five wrong passwords lock your sign-in id for 15 minutes. Many wrong tries from one station (30 in 10 minutes, unless IT set other numbers) hold that station for a while, whoever tries: the page says how many minutes to wait. To change a password of your own, press your name at the top right: you give your current one, then the new one twice (at least 12 characters, a few words you will remember), and anywhere else you were signed in, you are signed out. Forgotten it? Ask IT for a new link.
What a regulated plant adds (its IT turns each on; a development or demo instance has none of it):
- Your password expires. The password page says until when (every 90 days, say). Once it has expired, signing in asks for a new one first; a new one may not be one of your last few.
- A second factor. On the password page, Set up an authenticator app: add the key it shows to an authenticator app on your phone (or tap the link on the phone), keep the ten recovery codes somewhere safe apart from the phone, and type the code the app shows. From then on, signing in with your password asks for the app's code. Lost the phone? Type a recovery code instead (each works once), or ask a sign-in administrator to take the second factor off. Where the plant requires one, your next sign-in sets it up. Who signs in through single sign-on has their identity provider's instead.
- Idle sessions end. After a while with nothing done (30 minutes, say), you are signed out and the sign-in page says why. Leaving a page open does not count as doing something.
- A session that ended elsewhere. Signed out in another tab, ended by a sign-in administrator, or past its 12 hours, a page still open says Your session ended at the top, rather than that you have no access, and Sign in again brings you back to that page. What you typed is still on the page until you leave it.
- Signing asks your password. Approving a change, approving a record change, and running a transaction you sign each ask for your password at that moment, or Sign in again with single sign-on in a small window (it asks you to sign in there again, whatever it remembers, and then closes). The audit trail keeps your name and how you signed.
Sign-in administration (Design → Sign-in administration, for those People & departments makes sign-in administrators: the role administrator on Sign-in): what needs a look (sign-in ids locked in the last day, wrong passwords on many ids within minutes: someone may be trying common passwords), and a search for anyone, with their password and its age, second factor, a lock, sessions and last sign-in. Password link makes a one-time link to set a password, shown once for you to hand over; Reset second factor takes off a lost phone's (say why); Unlock lifts a lock; End sessions signs them out everywhere. Each is in the audit trail, by you. The same alerts reach your inbox.
Setup codes, for people with no mail or computer of their own. Once People & departments has the people (a file of a few thousand is fine), Setup codes for people with no password yet on the same page counts everyone who has no password here and has never signed in (choose a department, or everyone), and Make codes and download gives each of them five capital letters and downloads a CSV file (id, name, departments, code, expiry, the address to open) for printed slips or a mail merge. Hand each slip to its person, then delete the file: it holds the codes. Making codes again for the same people stops the earlier ones working. Setup code beside a person makes one person's code, shown once. On the sign-in page the person clicks I have a setup code, types their sign-in id, the code (any case) and their new password twice; the code works once, and after five wrong tries it stops working (ask for a new one).
Your name, top right, opens your menu: Language (where the plant offers more than one), Page size (every page drawn at 90 to 150 %, kept wherever you sign in), Your password and Sign out. On a development, test or demo instance (no passwords there) it also lists everyone else, with a search: click a name to be them, on the page you are on. The demo has no Sign out: be someone else instead.
Moving to the plant's directory. Where the plant also signs people in through its directory (Active Directory, LDAP), someone who was given a password here can move to it from Your password (their name, top right): type your password in the directory, click Switch to (the directory's name); if it accepts it, your password here is taken off and you sign in with the directory's from then on (anywhere else you were signed in, you are signed out). If it does not, nothing changes.
Trying single sign-on. npm run sso:sim starts a small identity provider for development and
training (never production): start OpenCore MES with OIDC_ISSUER=http://127.0.0.1:9095
OIDC_CLIENT_ID=opencore-mes PICKER=0 and sign in as any seeded person with its password (sso-sim);
--mfa makes it ask a code as well.
What waits for you, and what is in progress
Beside your name, at the top right, a bell counts what waits for you: changes you may review, the steps of changes you may sign, changes to records you may sign, and plans waiting for you (section 11). Click it for the list, in groups (Plans waiting for you, To sign, To review); each opens where you act on it, and Open Approvals shows everything waiting. It follows as others act.


Alerts from an installed suite come first in the same list, under Alerts, when a suite has something for you: each says what it is about and opens the page where it is dealt with (at most 20 a suite). The suite decides what to tell you and when it is dealt with: an alert leaves the list once the suite clears it. A suite whose alerts cannot be read is left out, never the rest of the list.
The Designer opens on In progress: the changes open now, yours first, one click from each.
Below, a tab per kind of design (Objects, Transactions, Screens, Flows, Report layouts, Menus, Queries,
From suites once an installed suite adds a kind of design, Services & connections, People & departments),
each with a search, its New, and a dot when something in it has an open change; then Test
sandbox (section 3) and Changes. Changes lists the open ones by default; Mine,
Emergencies, Setup & signed alone and All show the rest. The open tab is in the page's
address (/_design?tab=screens), so a link opens on it.
View beside a design opens it as it is live, read-only, in the same tabs a change has (an object's rules with their test cases): nothing is drafted and no change request is made, so look as much as you like. Relies on lists the objects it uses (Move in: the lot, the step, the equipment and its model); tick one to show it in the same view, then pick it in a window's list or press Split to see both side by side. The address keeps what you ticked, so the link opens the same view for someone else. Change it there starts a change when you mean to; if one is open already, it links to it.
Suites (the navigator's Design group, or search "suites", "packs", "samples") lists the installed suites, one line each, those with something to do first: the designs a suite brings (an assembly and test line: lots, wafers, routes, equipment, SPC), how many are new, how many differ from what is live, and the roles, groups and certifications they would give. The designer's home shows only a line linking there when a suite has something to do. Start a change from it opens one change request holding all of it; you edit it like any other, and it is reviewed and approved before anything goes live. Once it is live, Load its sample records creates the suite's sample data through the ordinary forms' checks, as you, so your roles decide what you may create; loading again adds nothing. Where an object's design makes a new record or an action wait for approval (section 4, Stewards), that sample is sent for approval instead, its reason saying it is a sample, and the note says how many wait.
Some designs of a suite work with another suite only (a capacity plan's service that takes its crews from the Shift Calendar): where that suite is not installed they are not offered, and the rest works without them. Install it later and the first suite's line offers them as new, in a change of their own.
About. About OpenCore MES, last in the navigator, says what your installation runs: its version and
build, the framework and Node.js versions, and every suite installed with its version (and its designs'
version). Quote it when you report a problem or record a validation. Where your plant has signed in to the suites
store, a suite with a newer version says so there and on its line under Suites ("Suite 0.1.2
available"): IT updates it when you choose (opencore-mes suite update <name>, then a restart). Nothing of yours is
lost by an update, a removal or a reinstall: your designs, records and the suite's own data stay, and a newer
design pack is offered as a change like any other.
Set-up guide. A suite that brings one shows Set-up guide on its line under Suites (a suite that brings no designs, such as one that only adds a page, has a line for its guide alone). The guide is the suite maker's: how a plant takes the suite into its own setup, step by step, each step saying who does it (IT, an administrator, a designer, a department): installing it, the groups and certifications to prepare, the change to take its designs through, the master data and opening balances to enter, how your own designs use what it adds, and going live. Commands have a copy button. Since a guide is shown only for a suite installed here, it says so at the top, with the version, and its install step is marked Done here and greyed: its commands are for another installation (test, training, production). Reading it changes nothing: every step that changes the plant goes through the ordinary forms, changes and approvals.
What an installed suite adds to your designs. A suite may add building blocks that you use like the platform's own, each shown where it is used:
- A design element of its own kind, on the Designer's From suites tab: started, edited (its Design tab is the suite's), reviewed and approved like a screen or a transaction. The suite checks it with the rest of the change, against what is live and against the services that run on its kinds of schedule, and may refuse a change in words: one that would rewrite what is already done (a day already gone), or leave a service's schedule naming something that is no longer there. Its words are in the Problems list, like any other problem, and the change cannot be submitted until they are put right.
- A kind of schedule: a service runs at times the suite works out (section 8, "Schedules from an installed suite").
- Something a service may ask of it: ticked under the service's what it may touch, then called from its script. A dry run and the script's test cases never act for real; they report what would have been asked.
- A transaction step: added from the Steps tab. A step that cannot be taken back (the suite says so) must be the last one, so it happens only once every other step has held.
- A screen block: added from the block list.
- Alerts for you, beside your name (above, "What waits for you").
If a suite is later removed, nothing of yours is deleted. Its elements stay listed, saying which suite they need; a service that asks the suite is refused in words; a transaction with its step does not run, and says why; its block says what it needs while the rest of the screen works; a schedule of its kind plans nothing and says which suite it needs. All of it works again once the suite is back.
The directory, and standing in for someone away
People in the navigator (/_people) is the plant's directory, for everyone signed in: type a few letters
of a name, a sign-in id or a department to find someone (nobody is listed until you do: a plant has thousands),
and open their card: their departments (the home one marked), groups, email, the steps they approve for, and
who signs for them while they are away. What it shows is People & departments' (above); it changes there.
At the top is you. Away for a week? Delegate my signing names a stand-in: someone from one of your departments (anyone active, if you belong to none), from when (now, unless you say) until when (or until you end it), and why. While it holds, your stand-in may sign wherever you do: a department's step, a group's, an approval flow's step, as the person a record names; their bell says as your stand-in, and their signature names you both, in the audit trail and on every page. Never for a change they asked for, wrote, reviewed or signed already, and never for one you did; and never at a department where they already approve another step (one person signs one step), so naming such a person is refused. One stand-in at a time; End it ends it early; your stand-in may decline the same way; a sign-in administrator may delegate for someone away unexpectedly. Each start and end is in the audit trail.