Training Guide: WorkView Solutions
This guide shows you how to turn a short problem statement, such as "we need to track vendor contracts and their renewals", into a WorkView design. It walks through checking and adjusting the design, then following its build steps in OnBase Studio. Allow about 45 minutes.
You don't need an OnBase connection to follow the guide. To build the solution you'll need OnBase Studio and rights to create WorkView applications in a Test system.
Chapter 1: What the WorkView tab does
Planning a WorkView solution means answering the same questions every time:
- what to track;
- how records relate;
- what stages they move through;
- who works on them;
- what should happen automatically.
The WorkView tab answers them for you as a first draft, and writes the result up as a build plan.
From a description to a build plan
- You describe the problem in a few plain sentences.
- If your description names one of the common shapes (contracts, requests, cases, incidents, assets, vendor onboarding, employee onboarding or inspections), the assistant starts from that pattern. Otherwise it builds the design from your own words, around the main thing you track: certifications, permit applications, board meetings, and so on.
- Either way, it uses your words for names, related classes, fields, status values, reviewers, amount thresholds, reminders, deadlines and documents.
- You check and adjust the design. Then you follow the ordered build steps in OnBase Studio.
What a design contains
| Part | What it is |
|---|---|
| Application | The WorkView application, with a name and purpose |
| Classes | The kinds of records, such as Contract and Vendor, each with its attributes |
| Relationships | Which class links to which, shown as a diagram |
| Filters | The lists people work from, such as Open contracts |
| Actions | The buttons on a record, such as Change status or Route to Legal review |
| Notifications | Who is told what, and when |
| Documents | Which OnBase Document Types attach to which class |
| Security | Which user groups can view, edit or delete each class |
| Build steps | An ordered checklist for building all of it in OnBase Studio |
What it doesn't do
- It doesn't build anything in OnBase. You build the solution yourself in OnBase Studio, following the steps.
- It doesn't read your OnBase system. Check class, Document Type and user group names against what already exists.
- WorkView menus and features differ between OnBase versions. Review the design with your WorkView administrator before you build.
Chapter 2: Find your way around
Open the WorkView tab. It has the same three-part layout as the Scripts and SQL tabs.
| Area | What's there |
|---|---|
| Left | Saved designs, with New design. Below them, Start from an example: one sample description for each pattern. |
| Middle | Describe the problem and Draft design at the top. Then the design itself: name and purpose, Check before building, the classes, filters, actions, notifications, documents and security. |
| Right | The relationship diagram, Download ACE file, Download build kit and Copy design, the Build steps, and a note on the screen layout for each class. |
Everything in the middle can be edited. The diagram, screens and build steps on the right update as you type.
Chapter 3: Draft your first design
- Under Start from an example, select Contract management. A new design opens with its sample description already in Describe the problem.
- Read the description. It names vendors and contracts, the fields to track, four stages, a $50,000 Legal review and a 60-day reminder.
- Select Draft design. If the design already has classes, the button asks Replace this design?; select it again within a few seconds to confirm.
- The assistant reports which pattern it used and how many classes it drafted.
What it drafted
| Part | Result |
|---|---|
| Classes | Contract, Vendor and Contract Review |
| Relationships | Each contract links to one vendor; each contract review links to one contract |
| Status values | Draft, Legal Review, Active, Expired, taken from your description |
| Rule | Route to Legal review: if Contract Value is greater than 50000, set Status to "Legal Review" |
| Reminder | 60-day end date reminder to the contract owner |
| Documents | Signed Contract documents attach to each contract |
| Groups | Contract Managers, Legal, Administrators and Read Only |
Write a good description
The assistant reads plain sentences. It finds more when you say:
| Say | For example | It adds |
|---|---|---|
| What you track | "We need to track vendor contracts." | The main class and the pattern |
| How records relate | "Each vendor can have several contracts." | A second class and a link between them |
| The fields | "Track the contract number, value, start date and owner." | Attributes, with a likely type for each |
| The stages | "Contracts go through Draft, Legal Review, Active and Expired." or "New -> Triaged -> Closed" | Status values, a status filter and actions |
| Who reviews | "Legal reviews any contract over $50,000." | A review status, a rule, a Unity Script action and a notification |
| Reminders | "Send a reminder 60 days before a contract expires." | A date filter and a reminder notification |
| Deadlines | "Requests should be decided within 3 business days." | A due date, an overdue filter and a notification |
| Assignment | "Requests are assigned to a technician." | An assignee attribute, My open filter and Assign action |
| Documents | "Attach the signed contract PDF." | A Document Type link and an Attach document action |
Write one idea per sentence. A description of four to eight sentences usually gives the best draft.
Give an exact specification instead
If you already know exactly what to build, write it as a specification: the application name, each class, and its attributes with their type and length. The assistant then builds exactly that, with nothing added: no Status, filters, actions, notifications or groups. It does this with every assistant, offline or AI.
Application called [Office Locations]
class [Locations] attributes [Location Name] (alphanumeric 200, required) [Street Address] (alphanumeric 100) [City] (alphanumeric 50) [State] (alphanumeric 2) [Zip Code] (alphanumeric 10)
- Square brackets are optional:
Application called Office Locations. Class Locations with attributes Location Name (alphanumeric 200), Street Address (alphanumeric 100).works too, as doesPhone - alphanumeric 20. - Start each class with the word class. A design can have several.
- Types it understands: alphanumeric (or text, string), long text, integer (or number), decimal, currency, date, date and time, yes/no (or boolean), formatted text, and
link to <class>for a relationship. - A number after alphanumeric or decimal is the length or the decimal places. Add
requiredto make an attribute required. - An attribute with no type becomes alphanumeric with the usual length, and Check before building says so.
The message reads Built exactly what you specified. Check the names, types and lengths, then select Download ACE file.
Chapter 4: Check before building
Check before building is the first card under the name and purpose. It has two lists.
Assumptions are what the assistant decided for you, for example:
- which pattern it started from;
- where the status values came from;
- which Document Type it chose.
Read each one. If one is wrong, change the design or reword your description and draft again.
Questions to confirm are what it couldn't know, for example:
- who may delete records;
- whether an amount exactly on the threshold also goes to review;
- which existing OnBase groups match its group names.
Take these to the business owner before you build.
Chapter 5: Adjust classes and attributes
Each class has a card with its name, a short description and a table of attributes.
Attribute types
| Type | Use it for |
|---|---|
| Text | Names, numbers that aren't amounts, and pick lists such as Status. Called Alphanumeric in Studio. |
| Long text | Notes and comments. Called Text in Studio. |
| Whole number, Decimal | Counts and measurements |
| Currency | Money |
| Date, Date and time | Due dates, start and end dates |
| Yes/No | A single checkbox |
| Link to record | A link to another class; this is how relationships are made |
| Formatted text | Text with formatting |
Change the design
- Rename a class in its Class name box, or an attribute by typing over its name. A renamed class updates in every class picker when you leave the field.
- Change Type to change the data type. Choose Link to record, then pick the class it links to under Values or link.
- Set Length for Text attributes (the most characters it holds) and for Decimal ones (the decimal places). Left blank, the box shows the usual length in grey, for example 150 for names and 100 for other text. The ACE file and build steps use it.
- For a pick list, type the values under Values or link, separated by commas. They become a data set in the build steps.
- Tick Req. for attributes every record must have.
- Select Add attribute or Add class to add more. Select × to remove an attribute, or Delete on the class card to remove a class.
Try it: on Contract, add an attribute Department of type Text with the values Finance, IT, Operations. A data set for it appears in the build steps.
Chapter 6: Filters, actions and notifications
Filters
Each filter has a name, a class and a description of what it shows. The drafted ones cover the usual needs:
- open records;
- records in each review stage;
- records due soon or overdue;
- My open records, when work is assigned.
Rename them to the words your team uses.
Actions
Each action has a Kind:
| Kind | What it becomes in OnBase |
|---|---|
| Create a record | A button that opens a new record of the class |
| Change status | A button or task that sets Status |
| Assign | A button that sets the assignee |
| Add a related record | A button that creates a linked record, such as a contract review |
| Run a Unity Script | A button that runs a WorkView Unity Script you write on the Scripts tab |
| Send a notification | A button that sends a notification |
| Attach a document | A button that opens document import for the record |
Notifications
Each notification says when it is sent and who gets it. Check the recipients against real users or groups.
Chapter 7: Build the scripts
Rules such as "Legal reviews any contract over $50,000" need a Unity Script. The drafted action Route to Legal review has the kind Run a Unity Script, and its description is the rule in a form the Scripts tab understands.
- In Actions, select Build in Scripts on the Route to Legal review row.
- The Scripts tab opens with a new WorkView script. Its class is Contract Management / Contract (design), and its description is the rule.
- The assistant drafts the steps. The C# on the right checks Contract Value and sets Status to "Legal Review".
- Check the steps and the code. Copy the C# into OnBase Studio once the class exists there.
Design classes appear in the Scripts tab's WorkView class picker with (design) after the name, so you can write scripts before the classes exist in OnBase. After you build the classes, switch the script to the real class from your connection to check the attribute names.
The Scripts training guide explains script steps in detail.
Chapter 8: Security and documents
Security
The security table has one row per user group and one column per class. Each cell is one of:
- No access;
- View;
- View, create, edit;
- Full, including delete.
The draft gives:
- Administrators full access;
- Read Only view access;
- the working groups the access their role needs.
Rename groups to match your OnBase user groups, or select Add group.
Documents
Each row links a Document Type to a class and names the folder it appears in on the record. Use an existing Document Type where you can. Ask your OnBase administrator before creating a new one.
Chapter 9: Follow the build steps
The Build steps on the right are in the order to build. Each step lists exactly what to create, using the names in your design.
| Step | What you do in OnBase Studio |
|---|---|
| Create the application | Create the WorkView application with its name and purpose |
| Create the data sets | One data set per pick list, such as Status |
| Create the classes | In the order listed, so linked classes exist before the classes that link to them |
| Add the attributes and relationships | Each attribute with its type, then the links |
| Lay out the screens | The fields, lists and buttons for each class, as listed in the screen notes on the right |
| Create the filters and filter bar | Each filter and the bar that shows them |
| Create the actions | Each button, then write and attach the Unity Scripts |
| Connect documents and notifications | The Document Type folders and each notification |
| Set up security | The user group rights from the security table |
| Test, then move to production | Sample records through every status, each filter and action, and a sign-in as each group |
Let Studio build it: the ACE file
Select Download ACE file to save the design as an Application Creation Excelerator (ACE) workbook. OnBase Studio reads it and creates the application, classes, attributes, data sets, filters and a view for you.
- Keep the file name as it is: it becomes the application's name. Each sheet becomes a class.
- In OnBase Studio, connected to your Test system, select the WorkView ribbon.
- In the Maintenance group, select Application Creation Excelerator › Import ACE Application.
- Browse to the file, check the application name, and select Next.
- Check the classes, decide whether Studio should also create a filter and a view for each class, and select Next.
- Add the user groups that should get the application, then select Next and Finish.
ACE only creates new applications; it can't change one that already exists. It doesn't set:
- required fields;
- filter conditions;
- actions or notifications;
- document links;
- each group's rights on each class.
Finish those from the build kit. If a note appears under the buttons, such as a class name being shortened to fit a sheet name, read it before you import.
Download the build kit
Select Download build kit to save the design as an Excel workbook. Build from it, and tick each row off as you go.
| Sheet | What's on it |
|---|---|
| Overview | Name, purpose, problem statement, assumptions and questions to confirm |
| Build checklist | Every build step in order, with Done and Notes columns |
| Classes, Attributes, Relationships | Each class and attribute with its system name, type, required flag and link |
| Data sets | One row per pick list value, in order |
| Screens, Filters, Actions, Notifications, Documents | What to create for each, with a Done column |
| Security | The rights for each user group on each class |
Each sheet has a frozen heading row and filters, so you can sort by class or show only the rows not yet done.
Share the design
Select Copy design to copy the whole design as text: classes, attributes, filters, actions, notifications, documents, security and build steps. Paste it into a document or ticket for review.
Saving
Designs save automatically with your other work. Select one under Saved designs to open it. To remove it, select Delete design, under the name and purpose.
Chapter 10: Practice
Try these on your own. For each one:
- Select New design and type the description.
- Select Draft design.
- Read Check before building, and fix anything that doesn't fit.
Exercise 1: Maintenance requests
Our facilities team gets maintenance requests from staff. Requests are assigned to a technician. Requests go Submitted -> Assigned -> In Progress -> Completed. Managers approve requests over $2,500. Requests should be completed within 5 business days.
You should get:
- a request class;
- an assignee;
- a Managers Review status;
- a rule for amounts over 2500;
- an overdue filter and notification.
Exercise 2: IT incidents
We need to track IT incidents. Each incident has a priority, reported by, and assigned technician. Incidents go New -> Triaged -> In Progress -> Resolved -> Closed. Managers review incidents over 3 days old. Attach screenshots.
Check that:
- the status values match the description;
- the "3 days old" sentence didn't become an amount rule;
- the groups include Managers and Technicians.
Exercise 3: Your own process
Pick a process your team tracks today in a spreadsheet or by email. Describe it in five sentences, draft it, and take the questions to the business owner.
Troubleshooting
| Problem | Fix |
|---|---|
| The wrong main class or pattern was picked | Say what you track in the first sentence: "We track training certifications." A common pattern is used only when you name its subject, such as contract, request, case, incident, asset, vendor, new hire or inspection. |
| A field is missing | Name it in a sentence such as "Track the parcel number, project type and estimated cost" or "Each certification has an expiration date and the training provider." |
| A class name is odd | Rename it on its card. Links and pickers update when you leave the field. |
| The status values aren't mine | List them in one sentence: "go through A, B and C" or "A -> B -> C". |
| No rule for an amount | Name the reviewer and the amount in one sentence: "Finance approves requests over $25,000." |
| A field is missing | Add it with Add attribute, or name it in a "Track …" sentence and draft again. |
| Build in Scripts isn't shown | Only actions with the kind Run a Unity Script have it. Change the action's kind. |
| Draft design replaced my changes | Drafting replaces the whole design. Use New design to keep the old one, or make your changes after drafting. |