Reference · for Engineers, Administrators
Forms
Design the forms people fill in on the shop floor. Drag fields onto the form, set when they show, try the form and publish it to the Apps page.
Forms is where the forms people fill in are designed: downtime reasons, quality checks, shift handovers or any record your plant keeps on paper today. It is in Organize > Forms. A form you publish appears for its roles in Monitor > Apps.
- New form creates a form, empty or from a sample form.
- The filters show all forms, the ones with Unpublished changes, the ones In use and the archived ones.
- Edit opens the form in the designer. The archive button next to it stops new records for the form.
The Choice lists tab next to Forms holds the lists many forms share.
Who can design and publish
| You want to | Your role needs |
|---|---|
| Create and edit forms | Full access to Forms, as the built-in Engineer role has |
| Publish a form, use an earlier version again or archive a form | Publish forms as well |
| Publish a form that writes to machines | Write to devices as well |
The designer is in the menu of the roles that may edit forms. Other roles fill forms in on the Apps page.
Create a form
- Open Organize > Forms and select New form.
- Type the name. The key the form's records are stored under is shown below it; it never changes.
- Choose Empty form, or one of the sample forms to start from a copy of it. The samples are ready-made MES templates: downtime with the reason tree, quality check, shift handover, work order start and finish, maintenance request, and the Machine panel operator screen. Their rules and scripts come with them.
- Select Create and open. The designer opens on the new form.
You can also describe the form to the AI Assistant; it proposes the whole form on one card and, once you approve, saves it as a draft here.
The designer
The designer takes the whole window. The arrow at the top left returns to the forms list.
- Add holds the components, grouped by what they are for. Outline shows the form as a tree.
- The form is drawn exactly as people will see it. The selected item has a frame, its type and buttons to move it up or down, duplicate it and remove it.
- The selected item's settings, in three tabs: Field, Layout and Logic. With nothing selected, the panel holds the form's own settings.
- Preview the form at phone, tablet or desktop width, and switch between Design and Try it.
- Publish makes the draft the version people fill in.
Add and arrange items
- Drag a component from Add onto the form. A blue line shows where it will go. Clicking a component adds it next to the selected item, or into the selected section.
- Drag an item on the form, or a line of the outline, to move it, also into another section, group or tab.
- Double-click a label, a section title, the form's title or its description to change it in place.
- A tab is added with the + next to the tabs, or from the tabs' settings.
| Shortcut | What it does |
|---|---|
| Ctrl+Z / ⌘Z | Undo |
| Ctrl+Shift+Z / ⌘⇧Z, Ctrl+Y | Redo |
| Ctrl+D / ⌘D | Duplicate the selected item |
| Ctrl+C, Ctrl+V / ⌘C, ⌘V | Copy the selected item and paste it after the selected item |
| Delete or Backspace | Remove the selected item |
| Alt+↑ / Alt+↓ | Move the selected item up or down |
| ↑ / ↓ | Select the previous or next item |
| Esc | Select the section, group or tab that holds the selected item |
| Ctrl+S / ⌘S | Save the draft now |
Texts in two languages
Every text a person reads (labels, help, options, the form's title) is kept in English and Turkish. The first box is your own language. The other language takes the same text until someone translates it; a translate mark shows the texts still to translate.
Width
On the Layout tab, choose how much of the row an item takes on a phone, a tablet and a desktop: a quarter, a third, half, two thirds, three quarters or the whole row. A width shown with an outline is taken from the smaller screen.
Show, require or lock under a condition
On the Logic tab, an item can show only, be required only or be locked only when other answers say so. Choose When… and build the condition from lines such as Change reason is Mould wear or Pieces checked is above 10, joined by and or or. Edit as formula writes the condition as an expression on the form's fields, for example fields.reason == 'other'. An item that shows only under a condition is dimmed on the form while you design.
Formulas
A condition written as a formula and a field that Starts with a Formula use the same editor:
- Type part of a field's label or name: the fields are offered by their label, and the one you choose is written as
fields.<name>. Aftercontext.,user.,live.orMath., what they hold is offered. Ctrl+Space lists everything; ↑ ↓ move in the list, Enter or Tab takes a suggestion. - Fields are coloured; a name the form does not have is underlined in red.
- Under the formula: what is wrong with it in plain words, the fields it reads, and Now:, its result with the answers typed in Try it. How to write shows the operators and short examples.
| Formula | What it gives |
|---|---|
fields.good + fields.scrap | The sum of two number fields |
Math.round(fields.temperature * 10) / 10 | A number rounded to one decimal |
fields.reason == 'other' | Yes when Other is chosen |
fields.pieces > 10 && fields.result == 'fail' | Yes when both hold |
context.deviceName | The name of the device the form is opened for |
live.Speed | The tag's value now (a tag one of the form's machine items reads) |
Checks on the answer
Number, text, long text and barcode fields can refuse an answer outside a limit: At least, At most, a number of characters, or a pattern. Add them under Checks on the answer on the Logic tab, each with an optional message in every language. The message shows next to the field when the check fails; without one, the field says the limit it missed, such as At most 500 pcs. The server checks the same limits when a record is submitted.
Machine values and writes
Live value, counter, trend and machine state items show a tag; setpoint and write button items write to one. Select the item and Choose a tag:
- The form's device: the form reads the tag from the device it is opened for. The tags of every device profile are listed by name, with the values of a device you choose under Values from. A tag that is not in a profile yet can be typed and used as it is. Such a tag needs a form opened for a device; the settings offer to switch the form to it.
- A place in the plant: the form always reads the tag of one device, whatever it is opened for. The devices you may see are shown in the UNS tree (enterprise, site, area and so on); open a device to see its tags. The search looks through places, devices and tags at once.
Every tag shows its unit, whether it can be written and its value now, with a green dot when the value is good. A setpoint or write button can only take a tag that can be written. The chosen tag shows in the settings with its place and value; selecting it opens the picker again. Choosing a tag fills in the item's unit when it has none. A write can ask to confirm and can wait a number of seconds before the same write is sent again.
The form's settings
With nothing selected (or after selecting the form's title), the settings hold:
| Setting | Meaning |
|---|---|
| Title, Description | What the Apps page and the form show. |
| Opened for | Nothing, a device, or a place in the plant. A form for a device asks for the device when it is opened. |
| Look | Standard, or Touch with large controls for gloves and tablets. |
| Can see records, Can fill it in | The roles that use the form. |
| Records need approval | A record counts once one of the Can approve roles approves it. |
| Analysis | How the Analysis tab of the Apps page sums up the form's records when it opens: the measure, its field and the grouping. Choose automatically lets Proxus pick: the records by the form's first choice. |
| Work order | Binds the form to work orders: the choice field that names the order, the step that starts, holds or finishes it, and the good and scrap quantities. Each record that counts moves the order on. |
The form's key, its SQL view (proxus_forms.v_<key>) and the number of stored fields are shown below them.
Electronic signatures
For records that must be signed, as 21 CFR Part 11 asks of electronic records in regulated plants, a form can ask for an electronic signature: from the person who sends a record, from the approver who approves or rejects it, or both. Turn them on under Electronic signature in the form's settings; signing a decision needs Records need approval on.
- Sign when sending: the person who fills in the form signs it.
- What signing means, in each language. It starts with a standard text ("I confirm that I filled in this record and that it is correct"); write your own where your procedures say so.
- Sign approvals and rejections: the approver signs the decision, with its own meaning for approving and for rejecting.
How a signature works:
- The signer types their Proxus password again for every signature; being signed in is not enough. People who sign in with Windows have no Proxus password: they set a signature PIN at their first signature (the password rules apply to it) and type it from then on.
- A wrong password or PIN counts like a failed sign-in: after as many attempts as the account lockout allows ([Security.Lockout]), the account is locked for the same time.
- The record keeps each signature: the signer's name, the time, what it meant and how they signed. The signature is computed over the record's values (and a rejection's reason), so it is tied to that record: if the values were changed afterwards, the record shows the signature as no longer matching. Records, their PDF and their history show the signatures.
- An administrator resets a forgotten PIN on Security > Users with Reset Form Signature PIN; the person sets a new one at their next signature. Setting and resetting a PIN is kept in its history.
- Kiosks and shared accounts do not suit signed forms: a signature names the account that signs. Give everyone who signs their own account.
- On the offline app a signed form is filled in without a connection and waits as Waiting for signature; the person signs and sends it when the hub can be reached.
Proxus provides the technical controls of electronic signatures (unique accounts, password checks, lockout, signature manifestation and linking, an audit trail of records). Your procedures (who may sign, training, account reviews, validation of your system) complete them.
Try the form
Try it turns the canvas into the form as people fill it in: type, choose, check. The panel on the right shows the values the record would store, by field name. Submit checks the answers as the Apps page does and shows what is missing; nothing is recorded.
Checks
The button left of Publish shows Ready or how many things there are to fix. Errors stop publishing; warnings, such as an empty section, do not. The list shows the problems item by item, those with errors first, the form's own settings at the top; select one to go to the item. Items with problems are also marked on the form and in the outline.
Operator screens
Under Arrangement in the form's settings, choose Screen to lay the form out as an operator panel instead of sections filled in from top to bottom. Each top-level item becomes a tile on a 12-column grid: drag it to move it, drag its edge or corner to resize it. The Layout tab of a tile sets its width and height (in columns and rows of 56 px) and its place by number. A new item goes to the first free place from the top. Items inside a section or group stay in it; the section is the tile. Form turns the screen back into sections; the tiles are kept for the next time.
- A tile, selected. Drag it to move it; drag its edge or corner to resize it.
- The tile's width and height, and its column and row.
- The phone preview: on a phone the tiles stand one under the other, row by row (then column).
Two tiles may not cover each other; the checks warn when they do. The Machine panel sample form is a screen to start from.
Process graphics
A Process graphic (in the palette's machine group) is a drawing of the line or machine whose symbols follow live values: a tank fills, a pipe flows, a valve opens, a pump, motor or fan runs, a light comes on, a value shows its number. On an operator screen it is a tile like any other; in a form it takes a row.
Select it and choose Edit the graphic in the settings. The drawing area opens over the designer:
- Choose a symbol on the left to place it. Drag a symbol to move it and a corner to resize it; the arrow keys nudge it (Shift: five steps) and Delete removes it.
- On the right, give it a caption in each language and choose its Tag with the same picker as the other machine items. A tank fills between Empty at and Full at; a value shows its number with Unit and Decimals; a light takes the color it shows when on. Pumps, motors, fans, valves, pipes and lights are on when the value is above 0 or true.
- Duplicate, To front and To back arrange the drawing; Drawing size sets its own units (800 × 450 by default). The drawing scales to the space the item gets.
Until a tag has a value its symbol is drawn muted, never in a made-up state; a value of bad quality gets a red dashed outline. A process graphic is about the machine now: a stored record does not show it. The checks name a symbol that shows no tag yet, one that is outside the drawing, and a tank whose Empty at is not below its Full at.
Rules
Rules make the form act on its own. Each rule says when it runs, only if what holds, and what it does. Select Rules in the designer's top bar (the number shows how many the form has). The Logic tab of an item lists the rules that watch or fill in that item, with a link to add one for it.
- When: what starts the rule.
- Only if: a condition on the answers, built from lines like the item conditions, or Always.
- Do: the actions, run in order.
- In a notification, select a value to insert it into the message.
| When | What the rule can do |
|---|---|
| The form opens (a new record only) | Set a value, run a script |
| A field changes (also when a rule sets it) | Set a value, run a script, write to the machine |
| A machine value changes (an item with a live value) | Set a value, run a script |
| At intervals (every 5 to 3600 seconds, while the form is open) | Set a value, run a script |
| The record is sent | Set a value, run a script, write to the machine, notify, open another form |
| The record is approved or rejected | Notify |
Set a value fills in a field with a fixed value or a formula, for example
Math.round((Date.parse(now()) - Date.parse(fields.startedAt)) / 60000)for the minutes since a start time.Run a script runs a few lines of JavaScript for what a formula cannot say: checks across fields, or values worked out from several others. A script reads
fields,context,user(withuser.language,troren, to write its messages in the person's language),liveandnow(), and changes the form only withform.set('field', value)andform.error('field', 'message'). The editor suggests the form's fields and says under the script what it reads, sets and checks, or what is wrong with it.// Scrap may not be more than the output. if (fields.scrap > fields.output) form.error('scrap', 'Scrap is more than the output.'); // Work the yield out from both. if (fields.output > 0) form.set('yield', Math.round((fields.output - (fields.scrap || 0)) / fields.output * 100));A message from a rule on The record is sent stops the record being sent, and the server checks it again whoever sends the record; a message from a change shows on the field until it changes. A script runs for 200 ms at most and reaches no files, network or other records; one that fails changes nothing, and Try it tells why.
Write to the machine writes through one of the form's setpoints or write buttons, with that item's limits and minimum interval, and adds the write to the record's history. A setpoint writes the value in its box unless the action gives a formula. A timer or a machine value never writes.
Notify sends a message through a notification channel once the record is stored. Write
{field}for an answer as stored,{field_text}for it as people read it, and{formTitle},{user},{deviceName},{decidedBy}and{reason}for the record. A name that is not a value stays as written.Open another form opens that form for the same device after the record is sent. In kiosk mode the tablet goes back to its own form once that one is sent.
Rules run from top to bottom. A rule that sets a field starts that field's change rules; after five rounds in a row the form stops, so a rule that feeds itself cannot loop. Try it runs the rules as people will see them and tells what a write or another form would do. The Downtime reason sample form comes with a rule that works out the duration when the machine runs again.
To start a pipeline from a record, use the pipeline trigger A form record is sent.
Publish and versions
The draft is saved a moment after every change, so closing the designer never loses work. Publish shows what publishing changes before it does:
- How many items the new version adds, changes and removes, and each of them with what changed about it (label, required, limits and checks, tag, width, moved, …). Select an item to go to it.
- A field that now stores another kind of value (for example a text field replaced by a number field under the same name) is marked: records already made keep what they stored, and the SQL view reads the column as the new kind.
- Who uses it: what the form is opened for, who can fill it in, see, approve and export records, with the settings this version changes marked.
- Records: the SQL view (
proxus_forms.v_<key>), the number of stored fields, how many records were sent with earlier versions (they keep their version) and how many drafts are being filled in (they continue with the new version; answers to removed fields are left out). - A short note for the version history.
New records use the newest version. If there are errors, the dialog lists them instead, each a way to its item.
Versions (the clock button) lists the published versions, newest first: when and by whom each was published, its note, what it added, changed and removed against the version before (What changed), and how many records were made with it. Look at shows a version as people saw it. Compare with the draft lists what the draft changes against that version. Use this version again publishes an earlier version as the newest one, and makes it the draft.
A form that is archived from the forms list takes no new records. Its records and its SQL view stay readable.
Records and exports
Records (next to Design and Try it) lists the form's records you may see.
- Records switches the designer to the form's records.
- Show all records, or only the submitted, approved, rejected or draft ones.
- From and To limit the records to the days they were submitted (or last saved).
- Excel and CSV download the records the filters select, at most 10,000: the record's own columns (status, device, who filled it in, when, who decided) and one column per field. Excel keeps numbers, dates and yes/no answers typed; CSV writes numbers with a dot and times as ISO 8601 so other systems can read them.
Select a record to open it, approve or reject it, or download it as a PDF, as on the Apps page. Every export and printout is noted in the record's history. Exporting a list needs Export, and to be among the form's roles that see its records.
Number answers as device tags
For a form filled in for a device, turn on Keep number answers as device tags in the form's settings, under Records. Each final record's number and yes/no answers then join the device's history as tags named after the form and the field: the Downtime reason form's Duration (field minutes) becomes downtime_reason_minutes. The Trend Workspace, dashboards and OEE calculations read them like any other tag, at the time the record was sent. A record counts once it is final: when it is sent, or when it is approved if the form asks for approval. A rejected record is never kept.
To copy records into a table of your own database instead, use a pipeline: see Write a row to a SQL table.
Choice lists
A choice list is kept once and used by many forms: downtime reasons, defect codes, shift teams. Change it in one place and every form that uses it follows. The lists are on the Choice lists tab of Organize > Forms. Items can have levels, such as Unplanned › Breakdown › Electrical, up to four deep.
New list asks for a name and starts empty or from the sample Downtime reasons list (planned and unplanned stops, three levels, in English and Turkish).
- The list's name. Its key (under the name) is what forms refer to and does not change.
- Add item adds an item at the end. Paste lines takes a list from a spreadsheet: one item per line, two spaces or a tab more to put a line under the line above.
- The item's text in each language. As with the form's own texts, the other language follows the first until you translate it.
- The stored value is what records keep. It is made from the text while the item is new, and must be unique in the whole list.
- Add an item under this one, move it up or down, move it a level up or under the item above, switch it off or remove it.
Save checks the list first: an empty or repeated value, a missing text or a fifth level stops it, and the item is marked. If someone else saved the list meanwhile, Discard loads their version. Forms read the saved list the next time they are opened; records already saved keep their values.
Switch off an item that is no longer used instead of removing it: it is no longer offered, and the records that chose it keep showing its text. A list that a form uses cannot be deleted.
Use a list in a form
- Tree choice shows a list level by level as large buttons, with the way back above them and a search across the levels for long lists, and stores one item. By default people go down to an item with nothing below it; switch off Only the last level to let them stop at a group, such as Breakdown.
- Single choice and Multiple choice can take their options from a Shared list instead of options written into the form. They offer the items at the bottom of the list, each with its path.
- The Work orders list is kept by Proxus: it offers the open work orders, as WO-1001 · Braket A12 · Pres 4. It is not on the Choice lists tab and cannot be edited there.
Records, the Excel and CSV exports and the PDF show a choice with its path, such as Unplanned › Material › No caps, in the reader's language.
Limits in this version
- Rules cannot call an API or write to another database. For that, start a pipeline from the record: see Start a pipeline from a form.
Was this page helpful?
Evaluating Proxus? See it on your own machines in a 30-minute technical session.