Portal Actions and Forms
On this page
The Settings App's Self Service Portal > Workflow page lists, for each class, the view form and the actions the Self Service Portal works with. The portal asks for create actions per class and for actions per record. This page and the class's workflow node edit the same workflow items. The action that self-registration runs is chosen on the Self-Registration page instead; see Self-Registration. For actions in general, see Actions.
Before you begin
- The Self Service Portal group of the Settings App is gated by an administrative right of its own. An account without that right does not see the group, unless it holds a right to a node inside it. See Permissions Reference.
- A class is listed only when your license covers it.
In the Settings App
The Self Service Portal workflow page
Open Self Service Portal > Workflow. The tree lists up to eight classes, skipping any that your license does not cover: Incidents, Approval Requests, Reservations, Service Requests, Library Items, Service Catalog Items, Computers and Hardware. Under each class, up to three groups appear:
- View Form - on every class. It holds one row only: the class's view form, or "<Double-click to add a new View Form>" when the class has none.
- Create Actions - only on Incidents and Reservations. Persons, the third class with portal create actions, has no node on this page; its action is chosen on the Self-Registration page.
- Actions - only on Incidents, Approval Requests, Reservations and Service Requests.
The Create Actions and Actions groups list their actions and always end with "<Double-click to add a new Create Action>" or "<Double-click to add a new Action>", whether or not the group already has an action. An action row reads "<item id>, <name>" in the Workflow Item column, beside an Enabled column.
What the portal offers
- Create actions. For a class, the portal gets every create action of the class that passes the role filter and the criteria filter. A portal action with no role grants is not restricted by role.
- Actions. For a record, the portal gets every action of the record's class, filtered against that record and sorted by the order set on this page. Nothing limits a class to one action. For Service Catalog Items, the portal uses its dedicated request action instead; see Service Catalog.
- Each entry carries the action's Caption and Hint. An action whose form has no instruction and no field or element is still offered, and runs without showing a form.
Work with the rows
IMPORTANT: Deleting an action row deletes the workflow action itself.
- Open - double-click a row or press Enter. A View Form row, including "<Double-click to add a new View Form>", opens the View Form window (see the next section). An action row, or the last row of a Create Actions or Actions group, opens the same window that the class's own workflow node opens. To create an action, double-click the last row of its group.
- Delete, or the Delete key, on a row - the Settings App asks "Are you sure you want to delete this item?". Deleting a view form leaves "<Double-click to add a new View Form>" in its place.
- Move Up and Move Down, or dragging an action onto another action of the same class and group, change the order of the actions. Both commands are unavailable while the quick filter holds a filter.
- Enable and Disable switch an action on or off.
The window that an action row of this page opens has these tabs: General, with Name, Description, Enabled and Caption; Form; Condition; Template, on create actions only; and Programming and Processes.
Edit a view form
- Open Self Service Portal > Workflow and expand the class's View Form group.
- Open its form row, or the "<Double-click to add a new View Form>" row to create a form.
- Edit the name, description, and Fields, then save the form.
A View Form row that holds a form opens that saved view form; the "<Double-click to add a new View Form>" row opens a new one. Some grid behavior below differs between the two.
The View Form window shows the class name as Object Class:, then Name:, the Description: box and the Fields group. It has no tabs. When you save, the Settings App refuses:
- a name that another form of the class already uses, compared without regard to case: "This Name is already in use. Please use a different one."
- a form without rows: "The Form must contain at least one field." A saved view form always has its CONTENT AREA row (see below), so this refusal comes up on a new view form.
In the Fields grid:
- New adds a Field, Text or Section row, and on a saved view form also a Column. The grid also offers Edit, Delete, Move Up and Move Down. The Mandatory and Read Only columns are hidden on a view form.
- Field opens the Form Field dialog, where you choose either an Object Field from the class's fields or a Virtual Field with its own name and type. A virtual field's name must be unique among the form's virtual fields, and for a Reference-type virtual field OK stays unavailable until you choose a lookup object. On a saved view form, OK is refused with an error when the chosen field is not available to the portal.
- Section opens the section dialog. A section can carry an optional visibility condition, shown as read-only generated SQL.
- Text opens the Text window: a Text box with Insert Placeholder..., a URL box whose button inserts a placeholder, and SSP Localization Key, which keeps only letters and digits, in upper case. A new Text row gets a generated key. The URL is not checked.
- Enter or a double-click edits a row, Ins adds a field, Ctrl+Alt+C copies the row's id, and Ctrl+Up and Ctrl+Down move the row. The shortcut menu adds Copy and Paste for Section and Text rows. Delete asks "Are you sure you want to delete the selected item?".
- The grid is one ordered list of rows. Moving or deleting a Section row moves or removes only that row; the fields under it stay where they are.
- A saved view form opens with a bold CONTENT AREA row at the top. It opens no editor, cannot be moved or deleted, and keeps every other row below it. New > Column, available while the form has no column row, adds a SIDE PANEL row, which moves and deletes like any other row. The grid of a new view form has neither row and no Column command.
Choose the self-registration action
On the Self-Registration page, the Workflow group holds one picker, Create new Person using Action:, which chooses one of the Person class's portal create actions.
- The picker is mandatory while Enable self-registration is selected, and unavailable with the rest of its group while it is cleared.
- The portal refuses a registration when the chosen action is missing or is not a portal create action.
- The form a customer sees when registering is the action's form with three mandatory fields in front of it, Login, Password and Confirm Password, and with every attachment area of the action's form removed.
- The action's Caption is always its Name, and it has no Condition tab.
- When registrations need authorization, the action does not run until the request is approved. Otherwise it runs at registration, and the Person it creates becomes the person of the new portal account.