Keyform Studio User Guide

Keyform Studio builds OnBase HTML forms, Unity Scripts, read-only SQL reports and WorkView solution designs, and grades existing Unity Scripts, from a visual editor and plain-English descriptions. This guide covers signing in, finding your way around and the settings; each tab also has its own training guide.

Signing in

Accounts are by invitation: your administrator creates your account and you finish setting it up from an email.

First sign-in

1. Open the email titled You're invited to Keyform Studio and select Set up my account. The link works once and expires after 72 hours.
2. Choose a password of at least 12 characters. Common and previously leaked passwords are refused.
3. Install an authenticator app on your phone if you don't have one, such as Microsoft Authenticator or Google Authenticator.
4. Scan the QR code shown on screen with the app, then type the 6-digit code it shows.
5. Save your 10 recovery codes somewhere safe, such as a password manager. Each code works once if you lose your phone.
6. Accept the terms of use. Keyform Studio opens on the Build tab.

Signing in after that

1. Go to your Keyform Studio address and enter your email and password.
2. Enter the 6-digit code from your authenticator app.
3. Tick Don't ask for a code on this computer for 30 days only on a computer you alone use.

You're signed out after 60 minutes without activity, and after 12 hours in any case. Your work is saved as you go, so nothing is lost.

The screen

Everything sits under one navy bar: the tabs on the left, your connection and the theme switch on the right.

Most tabs share one layout: a list on the left (fields, scripts, queries or question types), your work in the middle, and the result on the right (properties, C# code or SQL). On a narrow window the three parts stack.

The tabs at a glance

Build and Preview make a form, HTML hands it to OnBase, Scripts writes Unity Scripts, SQL writes reports, WorkView plans WorkView solutions, and Optimizer grades the Unity Scripts you already have.

Connections

A connection decides which Document Types, keyword types, WorkView classes and users appear in the pickers. Add one in Settings → Connections → Add OnBase connection, which lists every type with what it needs. To switch, select a connection, then Use this connection.

What each type gives you

Where a type can't run a query or store a document, Keyform says so: copy the query into your SQL tool, and use the training connection to try a form.

• Nothing you build depends on the connection staying the same. A form bound to Vendor Name keeps that binding when you switch; the checks tell you if the new connection has no keyword by that name.
• In training mode, submitting a form creates a pretend document, and running a query shows made-up results. Nothing is sent to any OnBase system.
• The training settings let you hide the banner, turn the pretend loading delay on or off, restore the sample form, add the sample scripts and clear the pretend documents.

OnBase export file (.expk)

1. In OnBase Studio, export the Document Types and WorkView applications you build forms and scripts for, the same way you make any configuration export.
2. In Keyform, select Add OnBase connection → OnBase export file (.expk) → Add.
3. Choose the .expk file. Keyform reads it and shows what it found, for example *33 Document Types, 140 keyword types, 35 WorkView classes, 45 user groups*.
4. Select Use this connection.

The file is read in your browser and isn't uploaded anywhere, not even to your Keyform account. Keyform keeps only the names, in this browser on this computer, so on another computer you import the file again. After OnBase changes, export again and choose the new file to replace the names. Deleting the connection removes them.

CSV files

1. Run the queries below against your OnBase database in SQL Server Management Studio, or ask someone with read access to. They read names only, never documents.
2. Save each result as a CSV file with column headings: right-click the results grid → Save Results As, and turn on Tools → Options → Query Results → SQL Server → Results to Grid → Include column headers when copying or saving the results.
3. In Keyform, select Add OnBase connection → CSV files → Add, and choose all the files at once. Keyform tells each file apart by its headings.
4. Select Use this connection.

Document Types and keyword types (required: document_type, keyword_type, data_type; the rest are optional)

SELECT dt.itemtypenum AS document_type_id, RTRIM(dt.itemtypename) AS document_type,
       RTRIM(g.itemtypegroupname) AS document_type_group,
       kt.keytypenum AS keyword_type_id, RTRIM(kt.keytype) AS keyword_type,
       kt.datatype AS data_type, kt.keytypelen AS length
FROM hsi.doctype dt
LEFT JOIN hsi.itemtypegroup g ON g.itemtypegroupnum = dt.itemtypegroupnum
LEFT JOIN hsi.itemtypexkeyword x ON x.itemtypenum = dt.itemtypenum
LEFT JOIN hsi.keytypetable kt ON kt.keytypenum = x.keytypenum
ORDER BY dt.itemtypename, x.seqnum;

WorkView attributes (application, class, attribute, data_type)

SELECT RTRIM(a.rmapplicationname) AS application, c.classid AS class_id,
       RTRIM(COALESCE(NULLIF(c.classdisplayname, ''), c.classname)) AS class,
       RTRIM(t.attributename) AS attribute, t.datatype AS data_type
FROM hsi.rmapplication a
JOIN hsi.rmapplicationclasses ac ON ac.rmapplicationid = a.rmapplicationid
JOIN hsi.rmclass c ON c.classid = ac.classid
JOIN hsi.rmclassattributes ca ON ca.classid = c.classid
JOIN hsi.rmattribute t ON t.attributeid = ca.attributeid
ORDER BY a.rmapplicationname, c.classname, ca.sequenceid;

User groups (optional; user_group)

SELECT RTRIM(usergroupname) AS user_group FROM hsi.usergroup ORDER BY 1;

The data_type column can hold OnBase's type codes, as these queries return, or words such as Alphanumeric, Date or Currency. Table and column names can differ slightly between OnBase versions: if a query fails, check them with Settings → SQL → Check the names against your database, which can read a saved result file and corrects close matches for you. Like an export, the names are read in your browser, kept only on this computer, and replaced when you import newer files.

Hyland REST API (preview)

This type signs you in through your Hyland Identity Provider and reads Document Types and keyword types from Hyland's REST API, with your own OnBase rights. It's a preview: it follows Hyland's Document API conventions and hasn't yet been tested against every OnBase version. WorkView lists aren't available this way.

Your OnBase team sets it up once:

1. In the Hyland Identity Provider, register a client for Keyform Studio:
   • grant type authorization code with PKCE, as a public client with no secret;
   • redirect URI: your Keyform address followed by /idp-callback.html, for example https://keyform.example.com/idp-callback.html. Keyform shows the exact value, with a Copy button;
   • scopes openid and evolution;
   • your Keyform address as an allowed CORS origin.
2. Allow your Keyform address (CORS) on the Hyland API server as well.
3. Give people the API server URL, the Identity Provider URL, the client ID and, if your Identity Provider uses one, the tenant.

Then each person:

1. Selects Add OnBase connection → Hyland REST API (preview) → Add, fills in those values and selects Save.
2. Selects Sign in with OnBase and signs in in the pop-up. Allow pop-ups for the Keyform site if the browser blocks it.
3. Selects Test connection, then Use this connection.

A sign-in lasts for the browser session, about an hour; Keyform asks you to sign in again when it expires. It works from your organization's network or VPN.

Editor back end (Unity API)

IT installs the Keyform Studio editor back end on your OnBase server once, following the setup guide that comes with it, and gives you its address. Then:

1. Select Add OnBase connection → Editor back end (Unity API) → Add.
2. Enter a name, choose the Environment, and paste the address into Editor back end URL, for example https://onbase-server.yourcompany.local/keyform-backend.
3. Select Save, then Test connection. It says which OnBase user you're connected as and how many Document Types you can see.
4. Select Use this connection.

You're signed in with your Windows account, so the lists show only what your own OnBase account can see. It works from your organization's network or VPN.

For the Keyform site administrator

The REST API and editor back end types call your OnBase servers straight from the browser, and browsers only allow servers your Keyform site lists. In private/config.php on the Keyform server, list each one's address, scheme and host only:

'onbase_hosts' => ['https://onbase-server.yourcompany.local'],

Export file and CSV connections don't need this.

Saving and sharing work

Your work saves itself to your account about a second after each change; there is no Save button. Sign in on another computer and it's all there.

• Forms appear on the Build tab. The current form opens when you sign in.
• Scripts are listed on the left of the Scripts tab; select one to open it, or New script to start another.
• Queries are listed under Saved queries on the SQL tab.
• WorkView designs are listed on the left of the WorkView tab.
• Script reviews are listed under Saved reviews on the Optimizer tab.
• Earlier versions. Each form, script and query keeps its last 20 saves. Use Restore an earlier version on the item if you need to undo a lot at once.

Sharing a form with a colleague

1. On the HTML tab, select Copy design file.
2. Send the copied text to your colleague by email or chat.
3. They paste it into Open a design file on their HTML tab and select Open. It replaces the form they had open, so they should finish theirs first.

Scripts and queries are shared by copying the C# or SQL they produce, and WorkView designs with Copy design.

The AI assistant

On the Scripts, SQL and WorkView tabs you can describe what you want in plain English and the assistant drafts it: script steps, the right query, or a WorkView design. On the Optimizer tab it can rewrite a script in full. By default it is the offline assistant, which runs in your browser and sends nothing anywhere.

The offline assistant

• It understands common phrasings, listed under What it understands (Scripts) and Questions it understands (SQL). Write one instruction per sentence.
• It tells you which drafted steps need checking and which sentences it couldn't use.
• It never invents keyword or table names: it matches what you write against the names in your connection.

Choosing a provider

Choose the assistant in Settings → AI assistant. Whichever you pick, Keyform checks every answer before using it, and falls back to telling you what went wrong rather than changing your work.

Claude with your own API key

1. Create a key in the Claude Console (console.anthropic.com) under API keys. Use is billed to your Anthropic account per request, separately from a Claude Pro or Max plan.
2. In Settings → AI assistant, choose Claude (your own API key) and paste the key. Keyform shows only its last four characters from then on.
3. Choose a model: Claude Opus 5.5 gives the best results, Sonnet 5.5 is faster and costs less, Haiku 5.5 is the fastest and cheapest.
4. Select Test assistant.

The key is saved only in that browser on that computer. It is never saved to your Keyform account or sent to the Keyform server, so you'll paste it again on another computer. Don't save it on a shared computer; select Forget key to remove it.

Microsoft 365 Copilot with your work account

This option uses Microsoft's Copilot Chat API, which Microsoft labels preview. It needs a work account with a Microsoft 365 Copilot license; personal Microsoft accounts can't use it.

1. Ask IT to register the app (steps below) and send you the Tenant and Application (client) ID.
2. In Settings → AI assistant, choose Microsoft 365 Copilot (work sign-in) and enter both.
3. Select Sign in with Microsoft and sign in with your work account in the pop-up. Allow pop-ups for the Keyform site if your browser blocks it.
4. Select Test assistant.

Copilot answers with your account's access, and web search is turned off for Keyform's requests. Sign out removes the sign-in from that browser.

Setting up Copilot: steps for IT

Do this once for your organization, in the Microsoft Entra admin center. No client secret is needed: Keyform signs people in from the browser as a single-page application.

1. Go to Identity → Applications → App registrations → New registration.
2. Name it, for example Keyform Studio Copilot, and choose Accounts in this organizational directory only.
3. Under Redirect URI, choose Single-page application (SPA) and enter your Keyform address followed by /auth-redirect.html, for example https://keyform.yourcompany.com/auth-redirect.html. Settings shows the exact value, with a Copy button. It must match exactly.
4. Select Register, then copy the Application (client) ID and Directory (tenant) ID.
5. Open API permissions → Add a permission → Microsoft Graph → Delegated permissions, and add all seven that the Copilot Chat API requires: Sites.Read.All, Mail.Read, People.Read.All, OnlineMeetingTranscript.Read.All, Chat.Read, ChannelMessage.Read.All and ExternalItem.Read.All.
6. Select Grant admin consent for your organization.
7. Make sure the people who will use it have a Microsoft 365 Copilot license.

The permissions are read-only, and Copilot only sees what each signed-in person can already see. Microsoft requires all seven for the Chat API even though Keyform's requests don't ask Copilot to search mail, chats or files.

Your part

Whatever drafts it, you are the reviewer. Read every step or query before you copy it, and test scripts in a Test system first. The Scripts tab asks you to confirm you've read a script before Copy C# works.

Settings reference

Settings has five pages, listed on its left. Changes save as you make them.

Some pages are only for administrators, depending on how your company set up Keyform Studio.

Good practice

Keyform Studio writes the first draft; you and your OnBase Test system confirm it works.

• Test before production. Import forms and compile scripts in a Test or development OnBase system first.
• Clear the checks. Each tab lists problems and warnings. Fix the problems; read every warning and decide.
• Read before you copy. Every script and query shows what it does in plain English at the top. Make sure it matches what you meant.
• SQL is read-only, and should stay that way. Keyform Studio only writes SELECT queries. Run them against a reporting copy of the database where you have one, and never change OnBase data with SQL.
• Check names once per system. Use Settings → SQL → Check the names against your database and Script API names when you first connect a new OnBase system or version.
• Keep design files. Store each form's design file with its HTML, for example in source control, so you can reopen and change it later.
• Treat names as confidential. Document Type and keyword names can reveal how your business works. Share exports and screenshots only with people who should see them.

Your account

Manage your password and two-factor sign-in from Settings → Your account.

Troubleshooting