Collapse All Expand All

Screens allow users to create, edit, and view account, ticket and person information. There are three categories of screens within the Framework: System-Defined, Custom and User-Defined.

System-Defined screens are pre-built by Akcelerant to provide out-of-the-box functionality and do not require (or allow) any configuration.

Custom screens are coded by the customer, or by Akcelerant on behalf of the customer, and installed on the customer’s site.

User-Defined screens are created by administrators to customize the way information is portrayed to users in the Framework.

The Screens page within System Management provides a complete list of all screens within the Framework. From this page administrators are able to manage existing screens and define new screens that optimize usability and reduce service time.

By default, the Screens page groups and sorts all screens according to type and displays information about each screen within the following columns:

Column Name	Description
Name	Displays the name of the screen.
Type	Displays the type of the screen.
Description	If provided, displays details about the screen.
System	Displays a if the screen is system-defined.
Modified	Denotes who made the last modification.
Modified Date	Denotes the date and time of the last modification.

Listed below are the screen attributes and the actions that can be taken while managing screens in System Management:

• Screen Attributes
  • General
  • Panels
    • General
    • Fields
    • Edit Screens
    • Columns
    • Properties
  • Buttons
  • Account Types
  • Case Types
  • Areas
  • Security
• Creating a Screen
  • Adding a Panel
    • Adding Fields
    • Deleting Fields
    • Adding Columns
    • Deleting Columns
  • Editing a Panel
  • Deleting a Panel
  • Adding Screen Buttons
  • Deleting Screen Buttons
• Copying a Screen
• Editing a Screen
• Deleting a Screen

For an overview of screens in the Framework, view a demonstration on Configuring Screens.

Screen Attributes

All screens share common attributes that are defined when creating, copying, or editing a screen.

General

General attributes include the basic information pertaining to user-defined screens.

General attributes are located on the General tab:

Attribute	Description
Type	Denotes the type of screen being designed. For more information on screen types, see the Main Screens and Edit Screens sections of this guide.
Name	Enter a unique name for the user-defined screen.
Column	Enter the number of columns in which the panels display This value may not exceed four.
Description	Provide details about the purpose of the screen. The description is made available to administrators in the System Management > Screens page.
Instructions	Enter instructions for users to complete the screen. When instructions are configured for the screen, an appears within the screen header. Clicking this icon displays the instructions to the user. The instructions section may also include hyperlinks. By default, hyperlinks open within the Framework, however, hyperlinks can be configured to open in a new window. See Hyperlink Help below Hyperlink Help  To configure hyperlinks to open in a new window: Click the Source Edit button (last one on the right) in the Instructions toolbar. The text entered in the Instructions field displays in the HTML Code. Locate the code that launches the hyperlink. Enter the following line of code immediately after the URL:target=”_blank” Save modifications to Instructions.

Back to top ^ 

Panels

Panels are added to user-defined screens to organize screen data into logical groupings. Panels can be used not only to display information, but also to provide the ability to gather data in the Workspace, Workflow, or Case. Panels are categorized as System-Defined or User-Defined.

System-Defined panels provide pre-configured functionality that cannot be modified.

User-Defined panels have various configurable attributes, such as the title, the number of columns displayed, as well as the specific fields that appear within the panel.

For each panel configured in the screen, an overview of the panel's General attributes are displayed in a grid on the Panels tab. Administrators can also add, edit, and delete panels from the Panels tab.

Panel Types

The following attributes can be defined while adding, copying, and/or editing panels:

• General
• Fields
• Edit Screens
• Columns
• Properties

General

General panel attributes allow administrators to edit the appearance of the panel as well as provide instructions to users.

The General panel attributes are defined within the following fields on the General tab for each panel type:

Field Name	Description
Title	Enter the title assigned to the panel within the user-defined screen.
Label Width	Enter the maximum number of pixels the label width is not to exceed. The lower the number, the more area available for entries in the associated fields. Label Width defaults to 120 pixels and may not exceed 1000 pixels.
Columns	Enter the number of columns in which fields are organized. At least one column must be added, but no more than four columns can be added to a panel.
Collapse By Default	Select the check box if this panel is to be collapsed by default.
Group Name	If desired, enter the name of group that the panel is to be grouped in. All panels sharing the same Group Name are grouped into a tab layout. Users may select the tab to access the panel. Group Name is case sensitive. The location of the tab panel corresponds to the order of the panels in that group tab.
Column Span	Enter the number of columns a panel spans within a screen. The value of this field cannot exceed four. If a screen is configured to contain two columns and a panel is configured to span two columns, the panel will span the entire screen width. If a screen is configured to contain four columns and a panel is configured to span two columns, the panel will span half the screen width.
Instructions	Enter a Rich Text set of instructions to assist users complete the panel. The instructions section may also include hyperlinks. By default, hyperlinks open within the Framework, however, hyperlinks may be configured to open in a new window. For more information on configuring hyperlinks to open in a new window, see Hyperlink Help.

Back to panel attributes ^ 

Back to top ^ 

Fields

A field is a data element stored in the database which corresponds to a record type compatible with the selected panel type. Fields can be added to a panel, on the Fields tab, while configuring a screen to allow users to view and change data. For example, a contact panel on a person screen is configured to include a phone number field which allows users to view and change the phone number.

Field attributes provide administrators with the ability to configure the panel content and style by taking the following actions while adding a panel:

Button	Description
	Enables users to select the fields to be added to the panel from the Framework field list. Each field may only be added to a screen/panel once.
	Enables users to add spacer fields to the panel. Spacer fields help organize and align fields into logical groupings.
	Enables users to add text fields to the panel. Text fields help organize panels into logical groupings by serving as headings within a panel. Text fields display information in bold font.
	Enables users to add a blank line that spans the width of a panel. Line fields help organize fields into logical groupings.

The Field attributes are defined within the fields grid:  

Attribute	Description
Field	A read-only column that displays the field selected.
Label	Enter the title of the field to be displayed within the user-defined panel/screen.
Required	Select this check box if the field must be completed in order to continue. Required fields display a  to the left of the field label and must be completed in order to save the screen. Marking fields as Required enables institutions to enforce the input of a value occur and prevents blank records from being saved.
Recommended	Select this check box if the completion of a field is suggested. Recommended fields display a  to the left of the field label which indicates to the user that a value, if available, should be entered in the field before saving the screen. Although the screen can be saved if recommended fields are left blank, this functionality can be beneficial in ensuring all information is obtained.
Read-Only	Select this check box to restrict the user from editing the value contained within the field.
Col. Span	Enter the number of columns the field spans within a panel. The value of this field may not exceed four.
Label Style	Enter CSS code to determine how a label displays within the panel. For example, institutions can use CSS code to render text bold, italicized, or blue.
Value Style	Enter CSS code to determine how a value displays within the panel. For example, institutions can use CSS code to render text bold, italicized, or blue.
Text Lines	Enter the number of lines the field and its corresponding entry encompass.

 Click  to display guidelines for defining Label and Value Style.

Back to panel attributes ^ 

Back to top ^ 

Edit Screen

Edit Screens provide the ability to edit a record displayed in a grid panel, as well as to view additional detail information not displayed in the panel. This feature allows an institution to only display key information in a panel to reduce scrolling while but still provide the ability to view and edit all pertinent information on a record by double-clicking a grid record.

Edit Screen attributes allow an administrator to select the screen that opens when an end-user double-clicks a record within the grid panel to view more information, update information, or add a new record.

The below Edit Screen attributes are defined within the grid that displays in the Edit Screens tab:

Attribute	Description
Screen Type	A read-only attribute that displays the screen type available to be selected as the Edit Screen.
Screen	Select the Edit Screen that opens when an end-user adds or updates information within the panel. This drop-down only displays screens matching the screen type associated with the panel.

Back to panel attributes ^ 

Back to top ^ 

Columns

Column attributes enable administrators to customize the columns that appear within the grid panel.

The below Column attributes are defined within the Columns tab:

Attribute	Description
Field	A read-only attribute that displays the column selected.
Header	Enter the title of the column to be displayed within the user-defined panel/screen.
Width	Select the default pixel width of the column.
Value Style	Enter CSS code to format how data displays within the column. For assistance with defining Style attributes, see CSS Style Help below: CSS Style Help When creating screens, administrators are able to determine field and column style attributes by entering CSS code in the Label Style, Value Style and Style columns. The examples below have been provided to demonstrate the versatility of CSS within the Framework's screen designer: Style Code Bold Text font-weight: bold Italicized Text font-style: italic Underlined Text text-decoration: underline Colored Text color: <enter color name> For example, entering color: red produces red-colored text. When determining the text color, consider the background color. If using a dark background, it is advised that light text color is chosen. Colored Background background-color: <enter color name> For example, entering background-color: yellow produces a yellow background. When determining the background color, consider the text color. If using a dark background, it is advised that light text color is chosen. In addition to entering the color name (red), administrators are able to enter the HEX and RBG color code. For example: Color Name HEX RBG Red #FF0000 rgb(0,0,0) Blue #0000FF rgb(0,0,255) Yellow #FFFF00 rgb(255,255,0) Green #008000 rgb(0,128,0) White #FFFFFF rgb(255,255,255) Using a semi-colon ( ; ) administrators may string together multiple CSS values. For example, entering background-color: turquoise; font-weight: bold; color: red produces bold, red text with a turquoise background.

Back to panel attributes ^ 

Back to top ^ 

Properties

Property attributes only display when configuring Account, Case and Messages panels on Person screens. Property attributes for a panel are defined on the Properties tab.

For Account and Case panels, the properties tab allows administrators to assign Account types and Case Types to the panel. The panel only displays on the screen if the account in context is assigned to the panel type.

Attribute	Description
Available	Displays a list of all the Account Types configured in System Management > Account Types. Assign access to the panel by selecting the desired account type(s) from the list and moving the account type(s) to the Assigned Account Type list using the arrows that are displayed.
Assigned	Displays a list of all Account Types that have been assigned to the panel.

Attribute	Description
Available	Displays a list of all the Case Types configured in System Management > Case Types. Assign access to the panel by selecting the desired case type(s) from the list and moving the case type(s) to the Assigned Case Type list using the arrows that are displayed.
Assigned	Displays a list of all Case Types that have been assigned to the panel.

For Message panels, the properties tab allows administrators to assign rules to the panel. The rules assigned to the message panel execute when the screen is opened or refreshed. If the assigned rules result in displaying content, the content displays within the panel.

Attribute	Description
Available	Displays a list of all the Rules configured in System Management > Rules. Assign access to the panel by selecting the desired rule(s) from the list and moving the rule(s) to the Assigned list using the arrows that are displayed.
Assigned	Displays a list of all Rules that have been assigned to the panel.

Back to panel attributes ^

Back to top ^ 

Buttons

Buttons provide the ability to perform an action directly within a screen. Button attributes enable administrators to add and delete screen buttons, as well as customize the button label that appears within the screen.

The following Button attributes are defined on the Buttons tab:

Attribute	Description
Button	Displays the name of the Button. This attribute is read-only.
Label	Enter the button label to appear within the application. To add a custom label, click within the Label column of the corresponding button and add custom text.

Back to top ^ 

Account Types

Account Types allow administrators to assign screens to specific account types. The screen is only available if the account in context is an account type that is assigned to the screen.

The Account Type attribute is defined on the Account Type tab:

Attribute	Description
Available	Displays a list of all the Account Types configured in System Management > Account Types. Assign access to the panel by selecting the desired account type(s) from the list and moving the account type(s) to the Assigned Account Type list using the arrows that are displayed.
Assigned	Displays a list of all Account Types that have been assigned to the screen.

Back to top ^ 

Areas

The Areas attribute allows administrators to assign the areas in which a screen is available. If the screen is not assigned to an area, users will not be able to utilize the screen while working in that area.

The Area attribute is defined on the Areas tab:

Attribute	Description
Available	Displays a list of all the Areas configured in System Management > Areas. Assign access to the screen by selecting the desired area(s) from the list and moving the area(s) to the Assigned Areas list using the arrows that are displayed.
Assigned	Displays a list of all Areas that have been assigned to the screen.

Back to top ^ 

Case Types

Case types allow administrators to assign screens to be available within specific case types.

The Case Type attribute is defined on the Case Type tab:

Attribute	Description
Available	Displays a list of all the Case Types configured in System Management > Case Types. Assign access to the panel by selecting the desired case type(s) from the list and moving the case type(s) to the Assigned Case Type list using the arrows that are displayed.
Assigned	Displays a list of all Case Types that have been assigned to the screen.

Back to top ^ 

Security

Security attributes allow administrators to assign the user-defined screen to specific Framework Users and Security Groups.

Security attributes are located within the Security Tab:

Attribute	Description
Available	Displays a list of all Users configured in System Management > Users and all Security Groups created in System Management > Groups > Security Groups. Assign access to the screen by selecting the desired user(s) and group(s) from the list and moving the name(s) to the Assigned Users/Groups boxes using the arrows that display.
Assigned	Displays a list of the Users and Groups assigned access to the screen. Once the screen is saved, it is accessible to the assigned Users and Groups.

Back to top ^ 

Creating a Screen

The Create function enables administrators to define the structure of a user-defined screen. This function provides the ability to configure and customize all screen and panel attributes to meet an institution's needs.

To design a user-defined screen, navigate to System Management > Screens and click .

A Select Screen Type window appears.

The Screen types available within the selection window are both Main Screens and Edit Screens.

Main Screens

Edit Screens

Once a screen type is selected, the Edit Screen window appears for administrators to define the attributes of the screen. To define attributes, the below actions may be taken:

• Adding a Panel
  • Adding Fields
  • Deleting Fields
  • Managing Edit Screens
  • Adding Columns
  • Deleting Columns
• Editing a Panel
• Deleting a Panel
• Adding Buttons
• Deleting Buttons

Adding a Panel

• To add panels to a screen, select the Panels tab and click .

• 

• Clicking opens the Select Panel window. Select the desired Panel Type to be assigned to the screen and click OK.

  The panel types that display within the Select Panel window depend on the screen type selected. The example above displays the panels available to be added to a Person Screen. For more information on panel types and screen types that support them, please see the list of available Panel Types.

• After selecting a panel type, an Edit Panel window opens to configure panel attributes such as Fields and Columns:

• Adding Fields

  • To begin adding fields to the panel, click . The Field Selector window appears.

  • 

  • Navigate through the folders to locate the desired field, or enter the name of the field in the search box at the top of the Field Selector window. Assign a field to the panel by double-clicking a field or by selecting a field and clicking .

    Custom fields can only be added to user-defined screens.

    Workflow fields added to a panel only display when the screen is used as a workflow step.

  • Once all fields have been added, click to return to the Fields tab.

  • They populate in the grid on the fields tab.

    Specific fields may only be added to a screen or panel once. The exception to this rule is the Add Spacer/Text/Line fields.

  • The order in which the fields are displayed on the Fields tab (from top to bottom) is the order in which the fields appear in the panel. The order can be changed by clicking a field and dragging it to the position in the list that is desired to display on the panel.

  • By clicking , , and/or , these fields can be added to the panel.

  • Within the grid columns, define the Field Label, Required, Recommended, Read-Only, Col. Span, Label Style, Value Style and Text Line.

    If a screen is configured to collect identical information in two locations, such as when two different panels contain the same field, the field information within one panel will be overwritten when data entered within the other panel is updated and the screen is saved.

  Back to adding panel ^ 

  Back to top ^ 

• Deleting Fields

  • Once fields have been added to a panel, administrators are able to remove them by selecting the field in the Fields tab and clicking .

• Managing Edit Screens

  • If the panel is a grid, an edit screen is required. Navigate to the Edit Screens tab and define the Edit Screen attributes. To add an Edit Screen to the panel, click within the Screen column and select the desired screen. The screen name populates within the Screen column.

  • 

  Back to adding panel ^ 

  Back to top ^ 

• If columns can be configured to appear in the panel, navigate to the Columns tab to define column attributes and add or delete columns.

• Adding Columns

  • To add columns to the panel, click within the Columns tab.

  • A Select Columns screen appears. Select the fields that are to be added to the column by selecting the field and clicking , or double-clicking on the field.

    

  • Once all fields and columns have been selected, click . After closing, administrators are taken back to the Columns tab. This tab populates the selected columns and fields.

  • The order in which the columns appear in the grid determines their order of appearance in the panel. Click a column and drag it to the desired location in the sequence.

  • Define Column Header, Width, and Value Style attributes within the grid columns.

  Back to adding panel ^ 

  Back to top ^ 

• Deleting Columns

• Once columns have been added to a panel, administrators can remove them by highlighting a column and clicking .

• Upon completion of all panel attributes within the Edit Panel window, click in the screen configuration window to return to the Panels tab.
• After returning to the Panels tab, administrators are able to define additional panels to be added to the screen or define other screen attributes to finish completing the screen.
• When the Buttons tab is enabled, navigate to the Buttons tab to define button attributes and add or delete buttons.

  Back to adding panel ^ 

  Back to top ^ 

Editing Panels

After a panel has been created, administrators are able to revisit the screen and edit the panels of previously created user-defined screen.

• To begin editing a panel, select the desired panel within the grid on the Panels tab and click .
• Make the desired modifications to the panel attributes and click to save the modifications and return to the Panels tab.

• Panel modifications are not saved until the screen in which the panel exists is saved.

Back to top ^ 

Deleting Panels

Administrators are able to delete panels from existing or in-progress user-defined screens.

• To delete a panel, select the panel within the grid on the Panels tab and click .
• When finished, click Save and Close to finalize the screen modifications.

• When deleting panels, the Framework does not display a confirmation message. When delete is selected, the panel is deleted.

Back to top ^ 

Adding a Button

When the Buttons tab is enabled, use this tab to manage screen buttons and their attributes.

• To add a button to a screen navigate to the Buttons tab and click . A Select Button window appears.
• Select the desired button and click .
• Once all buttons have been added, click .
• Define the attributes of the Button in the Buttons tab grid.

Back to top ^ 

Deleting a Button

• Once a button has been added to a screen, administrators are able to remove them by selecting the button and clicking

Back to top ^ 

Copying a Screen

The Copy function enables administrators to duplicate the structure of an existing user-defined screen. The existing screen can be used as a base for creating a new screen. After copying a screen, users are able to add, modify or delete screen attributes and then save it with a different name in order to create a new user-defined screen.

• To copy an existing user-defined screen, select the desired screen within the grid on the Screens page and click .
• Once the screen name has been changed and the attributes updated, click to retain the changes and finalize the creation of a new screen.

Editing a Screen

The Edit function enables administrators to revisit an existing user-defined screen and modify the existing logic/structure to enhance usability.

• To edit an existing user-defined screen, select the desired screen and click .
• Once the desired updates have been made to the screen attributes, click to finalize the screen modifications.

Back to top ^ 

Deleting a Screen

The Delete function enables administrators to remove an existing user-defined screen and all of its existing logic to enhance usability.

• To delete an existing screen, select the desired screen and click .
• A Confirmation Message appears. Click Yes to delete the user-defined screen. Click No to retain the user-defined screen.

Back to top ^ 

 

 

---

©2015 Akcelerant Software LLC. All Rights Reserved.