Civic Platform Administrator Guide Xxxxxx 9.3.0

User Manual:

Open the PDF directly: View PDF PDF.
Page Count: 1115

DownloadCivic Platform Administrator Guide Xxxxxx 9.3.0
Open PDF In BrowserView PDF
Version 9.3.0

Accela Civic Platform®

Administrator Guide

Accela Civic Platform Administrator Guide
© 2018 Accela, Inc. All rights reserved.
Accela, the Accela logo, the Accela logo with “Government Software” notation, Accela Automation, Accela
Asset Management, Accela Citizen Access, Accela Mobile Citizen Access, Accela ERS, Accela GIS, Accela
IVR, Accela Land Management, Accela Licensing, Accela Mobile Office, Accela Public Health and Safety,
Accela Service Request, Accela Wireless, Kiva DMS, Kiva Development Management System, 'PERMITS'
Plus, SiteSynch, Tidemark Advantage, Civic Platform, Civic Cloud, Civic Hero, E-Boardroom,
EnvisionConnect, Envista, GEOTMS, IQM2, Mediatraq, Minutetraq, PublicStuff, Trusted To Do More,
VelocityHall, Vantage360, and other Accela logos, devices, product names, and service names are
trademarks or service marks of Accela, Inc. Brava! Viewer is a trademark of Informative Graphics
Corporation. Windows is a registered trademark of Microsoft Corporation. Acrobat is a trademark of Adobe
Systems Incorporated. Portions copyright 2009 Ching-Lan 'digdog' Huang and digdog software. All other
company names, product names, and designs mentioned herein are held by their respective owners.

Version 9.3.0
February 2018
Corporate Headquarters
2633 Camino Ramon
Suite 500
Bishop Ranch 3
San Ramon, CA 94583
Tel: (888) 722-2352
Fax: (925) 659-3201

www.accela.com

| Contents | iii

Contents
Getting Started.............................................................................................13
Important 9.0.0+ Security Information – Action Required................................................................. 14
Loading Your License Keys.............................................................................................................. 16
Navigating to the Setup Portlet......................................................................................................... 18

Part 1: Configuring the User View.............................................................. 57
Transitioning to the New User Interface........................................................................................... 58
Setting the Civic Platform User Interface............................................................................... 58
Configuring Page Links on the Launchpad............................................................................ 61
Optimizing Form Designs....................................................................................................... 63
Configuring the Record Detail Menu......................................................................................66
Utilizing the Task Dashboard................................................................................................. 67
Branding Civic Platform for Your Agency......................................................................................... 69
Customizing Display Text....................................................................................................... 69
Adding Logos to Records.......................................................................................................70
Associating a Logo with an Agency in Citizen Access.......................................................... 71
Displaying a Logo or Grade Card.......................................................................................... 72
Applying a Logo to Ad Hoc Reports...................................................................................... 74
Configuring the Spell Checker and Agency Dictionary.......................................................... 74
Setting Up Your Console and Home Page.......................................................................................79
Configuring the Civic Platform console.................................................................................. 79
Adding a Main Link................................................................................................................ 82
Setting your Home Page........................................................................................................ 85
Adding Additional Consoles....................................................................................................85
Customizing Text.................................................................................................................... 87
Customizing Menus, Tabs, and Drop-down Lists............................................................................. 88
Overview................................................................................................................................. 88
Working with Menus and Tabs...............................................................................................90
Creating Template Menus for Modules................................................................................ 105
Creating Template Menus for User Groups......................................................................... 107
Creating User Flow Diagrams.............................................................................................. 109
Creating Shared Drop-down Lists........................................................................................ 112
Configuring Record Detail Tabs........................................................................................... 114
Defining the Create New Menu............................................................................................123
Customizing Go To Menus...................................................................................................124
Creating Custom Portlets...............................................................................................................125

| Contents | iv

Working with Link Portlets....................................................................................................125
Working with the Portlets Portlet..........................................................................................126
Filtering the Display of Data........................................................................................................... 128
Creating a Data Filter........................................................................................................... 128
Assigning a Data Filter......................................................................................................... 134
Data Filter Enabled Portlets................................................................................................. 135
QuickQueries........................................................................................................................ 136
Managing Global QuickQueries............................................................................................137
Managing User Defined QuickQueries.................................................................................145
QuickQuery Enabled Portlets............................................................................................... 147
Designing Forms for Portlets.......................................................................................................... 149
Working with Forms..............................................................................................................149
Working with Lists................................................................................................................ 159
Working with Customized Views.......................................................................................... 162
Creating Dynamic Text Labels............................................................................................. 164

Part 2: Setting Up Agencies, Organizations, and People.......................... 166
Configuring Organizations, Departments, and Users......................................................................167
Working with Organizations..................................................................................................167
Establishing User Groups.....................................................................................................172
Managing Users....................................................................................................................173
Managing Contacts, Licensed Professionals, and Public Users..................................................... 187
Establishing People Templates............................................................................................ 187
Managing Licensed Professionals........................................................................................ 193
Managing Contacts............................................................................................................... 196
Creating a Public User Account........................................................................................... 202
Searching for a Public User Account................................................................................... 205
Managing Accounts for Registered Agencies...................................................................... 207
Editing a Public User Account..............................................................................................213
Associating Addresses, Parcels, and Owners with Public User Accounts........................... 213
Changing a Public User Password...................................................................................... 216
Managing Licenses Associated with Public User Accounts................................................. 217
Setting Up Cross-Agency Operations............................................................................................. 219
Enabling Multiple Agency Administration............................................................................. 219
Delegate User Management.................................................................................................219
Multi-Agency Service Management...................................................................................... 224
Record Creation Across Agencies....................................................................................... 231
Sharing APO and Contacts Across Agencies...................................................................... 233
Viewing Information Across Agencies.................................................................................. 237
Customizing Regional Settings....................................................................................................... 239

| Contents | v

Defining Regional Settings for a Country or Region............................................................ 239
Viewing or Editing Regional Settings for a Country or Region.............................................241
Deleting Regional Settings for a Country or Region............................................................ 242
Configuring Global Search.............................................................................................................. 243

Part 3: Configuring Agency Business Objects...........................................245
Creating and Configuring Records..................................................................................................246
Accessing Record Type Administration................................................................................246
Creating New Record Types................................................................................................ 246
Working with Record Types................................................................................................. 259
Creating Record Type Filters............................................................................................... 262
Working with Address Type Groups.................................................................................... 264
Working with Application Status Groups.............................................................................. 268
Working with Intake Form Configuration Groups................................................................. 269
Working with Virtual Folder Groups..................................................................................... 276
Associating Record Types....................................................................................................279
Setting Default Clone Options.............................................................................................. 281
Managing Documents for Attachments................................................................................ 282
Large File Upload in Civic Platform..................................................................................... 290
Configuring Third Party Plan Review Integration................................................................. 291
Creating Custom Fields...................................................................................................................297
Working with Custom Fields Groups and Subgroups.......................................................... 297
Auto Filling Custom Fields with GIS Data............................................................................304
Designing Custom Fields Layouts for Citizen Access..........................................................305
Working with Custom Fields Groups....................................................................................307
Custom Fields Lookup Tables..............................................................................................321
Designing Application Intake Forms................................................................................................326
Understanding the Form Layout Editors.............................................................................. 326
Designing a Form Layout..................................................................................................... 327
Creating Custom Fields Drill-Downs.................................................................................... 333
Setting Up Security Policies............................................................................................................343
Adding Record Type Security.............................................................................................. 343
Adding or Editing Workflow Task Security........................................................................... 344
Adding or Editing Inspection Type Security......................................................................... 344
Adding or Editing an Inspection Default Value Policy.......................................................... 344
Adding or Editing Inspection Type and Status Security....................................................... 347
Adding or Editing Condition Type Security.......................................................................... 348
Setting Permissions for Custom Fields Groups and Custom Lists Groups.......................... 348
Adding or Editing Asset Type Security................................................................................ 349
Adding or Editing EDMS Type Security............................................................................... 349

| Contents | vi

Adding or Editing Contact Type Security............................................................................. 351
Managing Recipients in Administration Portlets................................................................... 354
Configuring Session Time Out............................................................................................. 357
Defining Sequences, Masks, and Autonumbering.......................................................................... 359
Accessing the Sequence Generator.....................................................................................359
Setting Up Number Sequences and Masks......................................................................... 359
Managing Sequence Intervals and Last Number Used........................................................363
Understanding Recommended Mask Formats..................................................................... 364
Designing Workflows....................................................................................................................... 377
Deciding Which Tool to Use................................................................................................ 377
Workflow Redesign for Civic Platform's New User Interface............................................... 378
Working with Workflow Designer..........................................................................................386
Creating Workflows...............................................................................................................387
Working with the Classic Workflow Tool.............................................................................. 400
Creating Task Statuses........................................................................................................ 410
Configuring Agency-defined Fields for Workflows................................................................411
Tracking In-possession Time for a Record.......................................................................... 418
Configuring Automatic Email Messages...............................................................................422
Managing Automatically Printed Reports............................................................................. 425
Assignments, Skillsets, and Workloads................................................................................427
Setting up an Automatic Assignment................................................................................... 427
Making Workflow Task Assignments....................................................................................430
Managing Activities............................................................................................................... 433
Using Expression Builder................................................................................................................ 435
Supported Environments...................................................................................................... 435
Sample Use Cases...............................................................................................................436
Creating Expressions............................................................................................................437
Searching for an Expression................................................................................................ 444
Expression Builder Scenarios...............................................................................................445
Setting Up Conditions.................................................................................................................... 457
Managing Condition Groups and Conditions....................................................................... 457
Establishing Condition Types............................................................................................... 463
Creating a Condition Template............................................................................................ 465
Applying Condition Audit Logs............................................................................................. 466
Assigning Conditions............................................................................................................ 468
Maintaining Condition Statuses............................................................................................ 474
Configuring Reference Conditions........................................................................................476
Configuring Record-Related Activities.............................................................................................478
Working with Activity-Specific Information Group Codes..................................................... 478

| Contents | vii

Working with Activity-Specific Information Subgroups......................................................... 481
Working with Activity Types................................................................................................. 484
Configuring Standard Comments.................................................................................................... 487
Managing Standard Comment Groups.................................................................................487
Managing Standard Comment Types...................................................................................495
Managing Standard Comments............................................................................................498
Enforcement Violation Comments........................................................................................ 501
Configuring Global Search.............................................................................................................. 504

Part 4: Managing Agency Communications and Events........................... 506
Working with Communication Manager.......................................................................................... 507
Prerequisites......................................................................................................................... 507
Configuring General Settings............................................................................................... 507
Configuring Account Settings............................................................................................... 512
Viewing the 360-Degree Communications List.................................................................... 515
Viewing Communications Associated with Records.............................................................516
Manually Sending Emails and Text Messages.................................................................... 518
Managing Alerts.................................................................................................................... 521
Managing Alert Rules........................................................................................................... 526
Announcements.................................................................................................................... 533
Notification Templates.......................................................................................................... 537
Variables............................................................................................................................... 547
Customizing the Content of Agency Communications......................................................... 565
Setting Up Calendars...................................................................................................................... 575
Configuring Calendars.......................................................................................................... 575
Working with Calendars........................................................................................................575
Setting Up and Maintaining Calendars.................................................................................584
Setting Up and Maintaining Meeting Types......................................................................... 592
Setting Up and Maintaining Supervisors.............................................................................. 603
Scenarios.............................................................................................................................. 610
Managing Calendar Items though the Calendar Portlet....................................................... 620
Social Media Integrations................................................................................................................ 622
Example Use Cases............................................................................................................. 622
Setting Up the Facebook Integration................................................................................... 622
Setting Up the Twitter Integration........................................................................................ 631
Configuring Social Media Permissions and Comments....................................................... 635

Part 5: Automated Data Processing..........................................................637
Processing Sets...............................................................................................................................638
Configuring Basic Set Functionality......................................................................................638
Locating Records in a Set....................................................................................................639

| Contents | viii

Exporting a Set Member List to CSV...................................................................................639
Extending Set Functionality.................................................................................................. 639
Creating Records from a Parcel Set.................................................................................... 641
Generating Reports for Sets................................................................................................ 641
Enabling Random Audits of Sets......................................................................................... 641
Configuring Set of Sets Functionality................................................................................... 642
Configuring Set Types.......................................................................................................... 642
Setting Up Random Audits..............................................................................................................648
Setting Record Type Audit Frequency................................................................................. 648
Configuring Reports for Random Audit Sets........................................................................649
Configuring Audit Logs.................................................................................................................... 653
Configuring the Inspection Detail Audit Log.........................................................................653
Configuring the Record Status History.................................................................................654
Configuring the Record List Audit Log................................................................................. 656
Configuring the Receipt Print Audit Portlet.......................................................................... 657
Processing Batch Jobs....................................................................................................................658
Working with Batch Jobs......................................................................................................658
Manually Executing a Batch Job..........................................................................................695
Terminating a Batch Job...................................................................................................... 695
Viewing the Batch Job Log.................................................................................................. 697
Importing and Exporting Settings.................................................................................................... 698
Transferring Settings............................................................................................................ 698
Exporting Data to CSV......................................................................................................... 699

Part 6: Reporting and Analytics................................................................ 700
Standard Reports............................................................................................................................ 701
Report Manager...............................................................................................................................702
Setting Up Report Services..................................................................................................702
Organizing Reports............................................................................................................... 707
Setting Up a Report............................................................................................................. 712
Additional Report Options.....................................................................................................736
SmartCharts..................................................................................................................................... 766
Creating a SmartChart..........................................................................................................766
Searching for a SmartChart................................................................................................. 768
Editing a SmartChart............................................................................................................ 768
Deleting a SmartChart.......................................................................................................... 769
Managing SmartChart Permissions...................................................................................... 770
Managing SmartChart Queries.............................................................................................771

Part 7: Accounting..................................................................................... 774
Setting Up Fees.............................................................................................................................. 775

| Contents | ix

Understanding Fees and Citizen Access............................................................................. 775
Managing Fee Schedules.....................................................................................................775
Understanding Fee Items..................................................................................................... 781
Setting Up a Flat Fee Item.................................................................................................. 786
Working with Point of Sale Fee Items..................................................................................787
Creating Fees with Fee Calculation and Custom Fields Data............................................. 787
Adjusting Fees Based on Agency Valuation........................................................................ 793
Adjusting Fees based on Occupancy Versioning.................................................................795
Working with Occupancy Groups......................................................................................... 799
Prioritizing Fees Using Pay Allocation................................................................................. 808
Enabling Fee Estimation.......................................................................................................808
Purging Partial Application Fees.......................................................................................... 809
Fee Formulas.................................................................................................................................. 810
CONSTANT Formula............................................................................................................ 810
FEE_MULTIPLIER Formula..................................................................................................811
FIXED_FEE_BY_RANGE Formula.......................................................................................812
FIXED_FEE_BY_RANGE_ENHANCED Formula................................................................ 812
FIXED_FEE_BY_RANGE_MULTIPLIER Formula............................................................... 813
ICBO_BLDG_PERMIT Formula............................................................................................814
ICBO_STYLE Formula..........................................................................................................817
ICBO_STYLE_ENHANCED Formula................................................................................... 818
LINEAR_MIN_MAX_RANGE_PARAM Formula................................................................... 820
LINEAR_MIN_MAX_VALUATION Formula.......................................................................... 820
LINEAR_WITH_MIN_MAX Formula..................................................................................... 822
LINEAR_WITH_MIN_MAX_ENHANCED Formula............................................................... 822
MIN_FEE_ADD_ON Formula............................................................................................... 824
MIN_FEE_ADD_ON_FEESCHEDULE Formula...................................................................824
PENALTY Formula............................................................................................................... 825
SG-LINEAR_WITH_MIN_MAX Formula...............................................................................826
SG-PERCENTAGE Formula.................................................................................................827
Invoices and Payment Periods....................................................................................................... 829
Managing Payment Periods................................................................................................. 829
Configuring Invoicing Options...............................................................................................830
Trust Accounts.................................................................................................................................831
Configuring Trust Account Functionality...............................................................................831
Managing Trust Account Transactions.................................................................................841
Viewing and Printing Trust Account Reports....................................................................... 843
Module Merchant Accounts.............................................................................................................845
Configuring Module Merchant Accounts.............................................................................. 845

| Contents | x

Processing Payments By Module.........................................................................................846
Usage Scenarios with Module Merchant Accounts..............................................................847
Point of Sale....................................................................................................................................849
Point of Sale Prerequisites..............................................................................................................850
Configuring the Point of Sale............................................................................................... 850
Payment Processing........................................................................................................................853
Introducing Accela CivicPay................................................................................................. 853
Configuring the Payment Processing Console.....................................................................853
Enabling Automatic Payment Allocation...............................................................................854
Configuring Online Payment Processing..............................................................................854
Setting Up Payment Functionality Online.............................................................................855
Time Accounting Tracker................................................................................................................ 856
Managing Time Accounting Groups..................................................................................... 856
Managing Time Accounting Types....................................................................................... 861
Managing Time Accounting User Profiles............................................................................ 869
Configuring Access to Inspections and Workflow................................................................ 877
Locking Time Accounting for Another User......................................................................... 878

Part 8: Land Management.........................................................................879
Managing Property: Addresses, Parcels, and Owners................................................................... 880
Configuring APO Functionality............................................................................................. 880
Working with Reference Data.............................................................................................. 887
Maintaining APO Templates.................................................................................................891
Structures and Establishments........................................................................................................900
Configuring Structures and Establishments......................................................................... 900
Managing Structure and Establishment Types.....................................................................901
Inspections....................................................................................................................................... 906
Managing Inspection Groups................................................................................................906
Establishing Inspection Types.............................................................................................. 909
Setting Up an Inspector Profile............................................................................................ 914
Managing Inspection Scheduling..........................................................................................919
Working with Inspection Result Groups............................................................................... 929
Working with Inspection Grade Groups............................................................................... 931
Managing Checklist Groups................................................................................................. 933
Establishing Checklists......................................................................................................... 935
Assigning Inspection Categories.......................................................................................... 945
Configuring Inspection Route Sheets...................................................................................946
Managing Inspection Flows and Milestones........................................................................ 948
Right of Way Management............................................................................................................. 955

Part 9: Asset Management........................................................................959

| Contents | xi

Attributes and Templates................................................................................................................ 960
Working with Attributes.........................................................................................................960
Working with Templates....................................................................................................... 965
Working with Attribute Tables.............................................................................................. 972
Managing Associated Attributes........................................................................................... 974
Asset Types.....................................................................................................................................977
Creating an Asset Type........................................................................................................977
Assigning an Asset ID Mask................................................................................................ 978
Searching for Asset Types................................................................................................... 979
Editing an Asset Type.......................................................................................................... 980
Deleting an Asset Type........................................................................................................ 981
Requiring the Asset Size Field.............................................................................................981
Associating an Asset Type with Work Order Types.............................................................982
Synchronizing Assets with GIS............................................................................................ 984
Viewing Rating Types under Asset Type............................................................................. 994
Creating Usage Types..........................................................................................................995
Working with Asset Class Types..........................................................................................998
Asset Condition Assessments.......................................................................................................1001
Creating a Condition Assessment Type.............................................................................1001
Editing a Condition Assessment Type............................................................................... 1002
Searching for a Condition Assessment Type..................................................................... 1003
Deactivating a Condition Assessment Type.......................................................................1004
Working with Condition Assessment Attributes..................................................................1004
Working with Observation Attributes.................................................................................. 1008
Viewing Calculated Rating Types.......................................................................................1011
Working with Asset Ratings............................................................................................... 1011
Setting Up a Parts Inventory.........................................................................................................1021
Adding a New Part Inventory............................................................................................. 1021
Editing a Part Inventory......................................................................................................1022
Searching a Part Inventory.................................................................................................1024
Deleting from a Part Inventory........................................................................................... 1025
Managing Part Locations....................................................................................................1026
Managing Part Contacts..................................................................................................... 1028
Configuring Work Order Templates.............................................................................................. 1032
Managing Work Order Templates...................................................................................... 1032
Managing Work Order Tasks............................................................................................. 1045
Managing Cost Groups.......................................................................................................1054
Managing Work Order Costing...........................................................................................1056
Attaching Assets to Records.........................................................................................................1063

Overview of the Assets Common Component................................................................... 1063

Part 10: Licensing....................................................................................1067
Education, Continuing Education, and Examinations for Licensing.............................................. 1068
Managing Education........................................................................................................... 1068
Managing Continuing Education.........................................................................................1074
Managing Examinations......................................................................................................1080
License Renewal........................................................................................................................... 1087
Managing the License Renewal Lifecycle.......................................................................... 1087
Managing Expired Licenses and Insurance Lapses...........................................................1090
Enabling Supervisor Override for Expired Licenses...........................................................1092
Establishing Renewal Information...................................................................................... 1094
Managing Application Types.............................................................................................. 1098

Part 11: System Diagnostics................................................................... 1103
Accela GIS Integration Diagnostics...............................................................................................1104
Troubleshooting the Connection with legacy Accela GIS.................................................. 1104
Troubleshooting Data Linkage............................................................................................1105
Creating a Trace Log......................................................................................................... 1106

Important 9.0.0+ Security Information – Action Required........................1108
TLS Compliance...................................................................................... 1110

| Getting Started | 13

Getting Started
Before you begin using Civic Platform you must load your product license keys. Then you can begin
configuring your Civic Platform environment to best suit the unique needs of your agency, via the Setup
portlet.
The Setup portlet enables you to access a wide range of Administration portlets, where you configure your
Civic Platform implementation.
Click a topic title below for full details.
Related Information
Important 9.0.0+ Security Information – Action Required
Loading Your License Keys
Navigating to the Setup Portlet

| Getting Started | 14

Important 9.0.0+ Security Information – Action Required
Starting with version 9.0.0, Civic Platform applications implement SHA-2 password encryption to comply
with the Federal Information Security Management Act (FISMA) information security requirements.
Civic Platform applications have replaced SHA-1 password encryption with SHA-2 encryption (specifically,
SHA-512+SALT hash functions) for FISMA compliance. When logging in Civic Platform, the user's
password is automatically converted to the SHA-2 encryption.
The following Civic Platform applications use the SHA-2 password encryption:
•

Civic Platform back-office application

•

Citizen Access

•

Silverlight and JavaScript GIS

•

Accela mobile apps using the Automation REST API

•

Apps using Construct V4 API
Note: Accela Mobile Office does not currently support SHA-2 password encryption.

Disabling SHA-1 on Accela-hosted Civic Platform environments
At a post-9.0.0 to-be-announced date, Accela-hosted environments will officially migrate to SHA-2
encryption. At that point, Accela will disable SHA-1 encryption so that only SHA-2 passwords are used
across Civic Platform applications on the Accela-hosted environments.
Accela Customer Support will send out advanced notifications about the SHA-2 migration, and will ask all
Civic Platform users to log into their Civic Platform applications before SHA-1 is disabled.
All users must log into their Civic Platform applications before Accela disables SHA-1. If users do not log
into their Civic Platform applications before Accela disables SHA-1, their passwords will continue to use the
SHA-1 password encryption and they will be permanently locked out of Civic Platform.
When Accela Customer Support has officially announced the SHA-2 migration date, it is absolutely
important and mandatory for all Civic Platform 9.0.0+ users on an Accela-hosted environment to login
before Accela disables SHA-1.

Disabling SHA-1 on self-hosted Civic Platform environments
The following information describes how to disable the SHA-1 password encryption on a self-hosted Civic
Platform environment. Note that this information only applies to self-hosted (or "on-premise") customers
who intend to completely migrate their Civic Platform environment from SHA-1 to SHA-2 password
encryption.
If your self-hosted agency decides to disable SHA-1 encryption and only use the SHA-2 password
encryption with Civic Platform, the following needs to happen after upgrading Civic Platform from a release
prior to 9.0.0:
1. Plan the SHA-2 migration date.
The self-hosted agency must determine a SHA-2 migration date that gives enough time for all Civic
Platform users to log in Civic Platform 9.0.0+ (including Civic Platform, Citizen Access, and GIS
applications and administration sites, Accela mobile apps, and any app using Construct APIs). Send out
advanced notifications and reminders to ensure all Civic Platform users have logged in Civic Platform in
a timely manner.
2. All users MUST log into their Civic Platform 9.0.0+ application.

| Getting Started | 15

When users log into a Civic Platform 9.0.0+ application, their passwords are automatically converted to
SHA-2 encryption.
All users must log into their Civic Platform 9.0.0+ applications before you disable SHA-1 on your Civic
Platform environment. If users do not log into their Civic Platform 9.0.0+ applications before you disable
SHA-1, their passwords will continue to use the SHA-1 password encryption and they will be permanently
locked out of Civic Platform.
If your agency plans to disable SHA-1, it is absolutely important and mandatory for all Civic
Platform 9.0.0+ users on your self-hosted environment to login before you disable SHA-1.

3. Disable SHA-1 encryption.
To disable the SHA-1 encryption for the following Civic Platform applications:
•

Civic Platform and Citizen Access:
1. Connect to the Civic Platform database.
2. Execute the following SQL:
UPDATE R1SERVER_CONSTANT SET REC_STATUS = 'A' WHERE SERV_PROV_CODE =
'STANDARDDATA' AND CONSTANT_NAME = 'DISABLE_SHA_1'

•

Civic Platform Silverlight GIS:
1. Navigate to the inetpub\wwroot\\data\GlobalConfigs directory on the IIS server.
2. Edit the GlobalSettings.xml file.
3. Set the DisableSHA1 key to True. For example:


(Note that by default, DisableSHA1 is set to False.)
4. Save your changes.

•

Civic Platform JavaScript GIS:
1. Connect to the JavaScript GIS database.
2. Execute the following SQL:
UPDATE GLOBALSETTING SET DISABLESHA1='True'

| Getting Started | 16

Loading Your License Keys
Civic Platform requires license keys to access core product functionality. Accela Customer Support
provides the license key for each agency. The license key entitles the agency to a fixed number of licenses
for one or more of Accela's solutions, including:
•

Civic Platform - Asset

•

Civic Platform - Land

•

Civic Platform - License and Case Management

•

Civic Platform - Service Request

Your license entitles you to a fixed number of users for each solution. You can distribute these licenses
across the modules that comprise a particular solution, in any way that meets the requirements of your
agency. You can assign a single named user account to use one or more modules in a solution, but not a
module from another solution.
Your license can entitle you to one or more of the following add-on products that enhance core Civic
Platform functionality:
•

Citizen Access

•

GIS

•

IVR

•

Mobile Office

Use Case Example
You have five users in your agency and your agency uses three modules (Building, Planning, and
Enforcement) for your Land Management solution. You need five user licenses and you can assign these
five user accounts to any combination of the three modules. For example, you can assign all five users to
each of the modules, and you can also assign two users to the Planning module and three users to both
the Building and Enforcement modules.
To load a product license
1. Contact Accela Customer Support to obtain your product license key.
•

For online assistance, go to the Accela Success Community: https://accela.force.com/success.

•

For phone assistance, call (888) 7-ACCELA, extension 5, or (888) 722-2352, extension 5. Accela
Customer Support representatives are available by phone Monday through Friday, 4:00 AM - 6:00
PM, Pacific Time.

2. Access the Setup Portlet (Navigating to the Setup Portlet).
3. Go to System Tools > Product License.
Civic Platform displays the License Details portlet.

| Getting Started | 17

4. Click Import.
5. Click Browse.
6. Locate and select your license key file.
7. Click Submit.
8. Restart the IIS server.

| Getting Started | 18

Navigating to the Setup Portlet
The Setup portlet enables you to access the Administration portlets, where you configure your Civic
Platform implementation to best suit the unique needs of your agency.
To access the Setup portlet
1. Log in to Civic Platform.
2. Civic Platform displays your personalized home page. The layout of your home page depends on how
you have configured your console (Setting Up Your Console and Home Page).
3. Navigate to Civic Platform Aministration.
Civic Platform displays the Setup portlet.

4. Click an arrow next to a menu to expand the menu and view its available options.

| Getting Started | 19

5. Click the Administration page you want to work with.

Accessing Classic Administration
Civic Platform provides the “Classic” Administration interface for performing a variety of administrative
functions.
To access Classic Administration
1. Create a main link for Classic Administration (Setting Up Your Console and Home Page).
2. Click the main link for Classic Administration.
Civic Platform displays the Classic Administration page.
3. Click the Admin Tools tab to access administrative functions; click the Daily tab to access daily user
functions.

Accessing Record Type Administration
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Aministration > AA Admin.
Civic Platform displays the Administration page.

Accessing the Form Layout Editors
To access a form layout editor
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click one of the following links to open the form layout editor you want to work with.
•

Agency Profile > APO Form Layout Editor

•

Agency Profile > Custom Fields Form Layout Editor

•

Agency Profile > Form Portlet Designer

•

Assets > Form Layout Editor

| Getting Started | 20

•

Structures and Establishments > Form Layout Editor

•

Workflow & Activity > TSI Form Layout Editor
Civic Platform displays the form layout editor

Accessing the Address Type Group Portlet
To access the Address Type Group portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Agency Profile > Address Type Group.
Civic Platform displays the portlet.

Accessing the Console Configuration Portlet
To access the Console Configuration portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Agency Profile > Console Configuration.
Civic Platform displays the portlet.

| Getting Started | 21

Accessing the Content Customize Portlet
To access the Content Customize portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Agency Profile > Content Customize.
Civic Platform displays the portlet.

Accessing the Create New Objects Portlet
To access the Create New Objects portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).

| Getting Started | 22

2. Click Agency Profile > Create New Objects.
Civic Platform displays the portlet.

Accessing the Form Portlet Designer
To access the Form Portlet Designer
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Agency Profile > Form Portlet Designer.
Civic Platform displays the portlet.

Accessing the Link Portlets Portlet
To access the Link Portlets portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Agency Profile > Link Portlets.
Civic Platform displays the portlet.

| Getting Started | 23

Accessing the Logo Portlet
To access the Logo portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Agency Profile > Logo.
Civic Platform displays the portlet.

Accessing Menu Navigation
To access the Menu Navigation portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Agency Profile > Menu Navigation.
Civic Platform displays the portlet.

Accessing the My Navigation Portlet
To access the My Navigation portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Agency Profile > My Navigation.
Civic Platform displays the portlet.

| Getting Started | 24

Accessing the Portlets Portlet
To access the Portlets portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Agency Profile > Portlet.
Civic Platform displays the portlet.

Accessing the Regional Settings Portlet
To access the Regional Settings portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Agency Profile > Regional Settings.
Civic Platform displays the portlet.

| Getting Started | 25

Accessing the Service Portlet
To access the Service portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Agency Profile > Service.
Civic Platform displays the portlet.

Accessing the Comment Group Maintenance Portlet
To access the Comment Group Maintenance portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Agency Profile > Standard Comments.
Civic Platform displays the portlet.

| Getting Started | 26

Accessing the Text Settings Portlet
To access the Text Settings portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Agency Profile > Text Settings.
Civic Platform displays the portlet.

Accessing the Custom Fields Lookup Tables Portlet
To access the Custom Fields Lookup Tables portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Application > Custom Fields Lookup Tables.
Civic Platform displays the portlet.

| Getting Started | 27

Accessing the Custom Fields Security Portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Application > Custom Fields Security.
Civic Platform displays the portlet.

Accessing the Expression Builder Portlet
To access the Expression Builder portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Application > Expression Builder.
Civic Platform displays the portlet.

Accessing the License Verification Maintenance Portlet
To access the License Verification Maintenance portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Application > License Verification.
Civic Platform displays the portlet.

| Getting Started | 28

Accessing the Record Type Security Portlet
To access the Record Type Security portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Application > Record Type Security.
Civic Platform displays the portlet.

Accessing the Shared Drop-down List Portlet
To access the Shared Drop-down List portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Application > Shared Drop-Down List.
Civic Platform displays the portlet.

Accessing the Asset Attributes Portlet
To access the Assets Attribute portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Assets > Attribute.
Civic Platform displays the portlet.

| Getting Started | 29

Accessing the Attribute Table Portlet
To access the Attribute Table portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Assets > Attribute Table.
Civic Platform displays the portlet.

Accessing the Attribute Template Portlet
To access the Attribute Template portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Assets > Attribute Template.
Civic Platform displays the portlet.

| Getting Started | 30

Accessing the Condition Assessment Portlet
To access the Condition Assessment portlet
1. Access the Setup portlet (Accessing the Condition Assessment Portlet).
2. Click Assets > Condition Assessment.
Civic Platform displays the portlet.

Accessing the Rating Type Portlet
To access the Rating Type portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Assets > Rating Type.
Civic Platform displays the portlet.

Accessing the Asset Security Portlet
To access the asset security administration portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Assets > Security.
Civic Platform displays the portlet.

Accessing the Asset Type Administration Portlet
To access the Asset Type administration portlet

| Getting Started | 31

1. Access the Setup portlet (Accessing the Asset Type Administration Portlet).
2. Click Assets > Type.
Civic Platform displays the portlet.

Accessing the GIS Attribute Mapping Portlet
To access the GIS Attribute Mapping portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Parcels > GIS Attribute Mapping.
Civic Platform displays the portlet.

Accessing the Calendar Administration Portlet
To access the calendar administration portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).

| Getting Started | 32

2. Click Calendars > Calendar.
Civic Platform displays the portlet.

Accessing the Conditions Maintenance Portlet
To access the condition maintenance portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Conditions > Condition.
Civic Platform displays the portlet.

Accessing the Contact Type Setting Portlet
To access the contact type setting portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Contact > Contact Type Setting.
Civic Platform displays the portlet.

| Getting Started | 33

Accessing the Contact Identity Settings Portlet
To access the contact identity settings portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Contact > Identity Settings.
Civic Platform displays the portlet.

Accessing the Continuing Education Maintenance Portlet
To access the Continuing Education Maintenance portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click License Certifications > Continuing Education.
Civic Platform displays the portlet.

Accessing the Education Maintenance Portlet
To access the Education Maintenance portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click License Certifications > Education.
Civic Platform displays the portlet.

| Getting Started | 34

Accessing the Examination Maintenance Portlet
To access the Examination Maintenance portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click License Certifications > Examination.
Civic Platform displays the portlet.

Accessing the Data Filter Portlet
To access the Data Filter portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Data Filter & Query > Data Filter.
Civic Platform displays the portlet.

Accessing the Global QuickQueries Portlet
To access the Global QuickQueries portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Data Filter & Query > Global QuickQueries.
Civic Platform displays the portlet.

| Getting Started | 35

Accessing the My QuickQueries Portlet
To access the My QuickQueries portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Data Filter & Query > My QuickQueries.
Civic Platform displays the portlet.

Accessing the Custom Fields Drill-Down Portlet
To access the Custom Fields Drill-Down portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Drill Down > Custom Fields Drill-Down.
Civic Platform displays the portlet.

Accessing the Inspection Type Security Portlet
To access the inspection type security portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Inspection > Inspection Type Security.
Civic Platform displays the portlet.

| Getting Started | 36

Accessing the Part Contact Portlet
To access the Part Contact portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Part > Part Contact.
Civic Platform displays the portlet.

Accessing the Part Location Portlet
To access the Part Location portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Part > Part Location.
Civic Platform displays the portlet.

Accessing the Report Manager Portlet
To access the report manager portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Report > Report Manager.
Civic Platform displays the portlet.

| Getting Started | 37

Accessing the SmartChart Queries Portlet
To access the SmartChart Queries portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Report > SmartChart Queries.
Civic Platform displays the portlet.

Accessing the SmartChart Portlet
To access the SmartChart portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Report > SmartCharts.
Civic Platform displays the portlet.

| Getting Started | 38

Accessing the Structures and Establishments Attribute Portlet
To access the Structures and Establishments Attribute portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Structures and Establishments > Attribute.
Civic Platform displays the portlet.

Accessing the Structures and Establishments Attribute Template Portlet
To access the structures and establishments Attribute Template portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Structures and Establishments > Attribute Template.
Civic Platform displays the portlet.

| Getting Started | 39

Accessing the Structures and Establishments Types Portlet
To access the Structures & Establishment Types portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Structures and Establishments > Type.
Civic Platform displays the portlet.

Accessing the Alert Portlet
To access the Alert portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Communication Manager > Alert.
Civic Platform displays the portlet.

Accessing the Audit Log Portlet
To access the Audit Log portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click System Tools > Audit Log.
Civic Platform displays the portlet.

| Getting Started | 40

Accessing the Batch Jobs Portlet
To access the Batch Jobs portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click System Tools > Batch Engine.
Civic Platform displays the portlet.

Accessing the Delegate User Portlet
To access the Delegate User portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click System Tools > Delegate User.
Civic Platform displays the portlet.

| Getting Started | 41

Accessing the Export Portlet
To access the Export
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click System Tools > Export.
Civic Platform displays the portlet.

Accessing the the legacy Accela GIS Integration Diagnostics Portlet
To access the legacy Accela GIS Integration Diagnostics portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click System Tools > GIS Integration Diagnostics.
Civic Platform displays the portlet.

| Getting Started | 42

Accessing the Import Portlet
To access the Import portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click System Tools > Import.
Civic Platform displays the portlet.

Accessing the Announcement Portlet
To access the Announcement portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Communication Manager > Announcement.
Civic Platform displays the portlet.

Accessing the Notification Template Portlet
To access the Notification Template portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Communication Manager > Notification Templates.
Civic Platform displays the portlet.

Accessing the License Details Portlet
To access the License Details portlet

| Getting Started | 43

1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click System Tools > Product License.
Civic Platform displays the portlet.

Accessing the Public User Portlet
To access the Public User portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click System Tools > Public User.
Civic Platform displays the portlet.

| Getting Started | 44

Accessing the Receipt Print Audit Portlet
To access the Receipt Print Audit portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Finance > Receipt Print Audit.
Civic Platform displays the portlet.

Accessing the Alert Rule Portlet
To access the Alert Rule portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Communication Manager > Alert Rule.
Civic Platform displays the portlet.

| Getting Started | 45

Accessing the Sequence Definition Portlet
To access the Sequence Definition Portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click System Tools > Sequence Generator.
Civic Platform displays the portlet.

Accessing the Occupancy Administration Portlet
To access the Occupancy Administration portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Valuation Calculator > Occupancy.
Civic Platform displays the portlet.

| Getting Started | 46

Accessing the Activity Specific Info Portlet
To access the Activity Specific Info portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Workflow & Activity > Activity Specific Info.
Civic Platform displays the portlet.

Accessing the Activity Type Portlet
To access the Activity Type portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Workflow & Activity > Activity Type.
Civic Platform displays the portlet.

| Getting Started | 47

Accessing the Assign Task Portlet
To access the Assign Task portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Workflow & Activity > Assign Task.
Civic Platform displays the portlet.

Accessing the Skillset Portlet
To access the Skillset portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Workflow & Activity > Skillset.
Civic Platform displays the portlet.

Accessing the Workflow Security Portlet
To access the workflow security portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Workflow & Activity > Workflow Security.
Civic Platform displays the portlet.

| Getting Started | 48

Accessing the Workload Portlet
To access the Workload portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Workflow & Activity > Workload.
Civic Platform displays the portlet.

Accessing the Cost Group Portlet
To access the Cost Group portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Work Orders > Cost Group.
Civic Platform displays the portlet.

Accessing the Cost Item Portlet
To access the Cost Item portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Work Orders > Cost Item.
Civic Platform displays the portlet.

| Getting Started | 49

Accessing the Work Order Task Portlet
To access the Work Order Task portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Work Orders > Work Order Task.
Civic Platform displays the portlet.

Accessing the Work Order Template Portlet
To access the Work Order Template portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Work Orders > Work Order Template.
Civic Platform displays the portlet.

Accessing the Time Accounting Group Portlet
To access the Time Accounting Group portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Time Accounting > Group.

| Getting Started | 50

Civic Platform displays the portlet.

Accessing the Time Accounting Types Maintenance Portlet
To access the Time Accounting Types Maintenance portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Time Accounting > Type Maintenance.
Civic Platform displays the portlet.

Accessing the Time Accounting Profiles Portlet
To access the Time Accounting Profiles portlet
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Click Time Accounting > User Profiles.
Civic Platform displays the portlet.

| Getting Started | 51

Accessing the Building Permits Portlet
To access the Building Permits portlet
1. Create a main link for the Building Permits portlet (Setting Up Your Console and Home Page).
2. Click the main link for the Building Permits portlet.
Civic Platform displays the portlet

Accessing the Trust Account Portlet
To access the Trust Account portlet
1. Create a main link for the Trust Account portlet (Setting Up Your Console and Home Page).
2. Click the main link for the Trust Account portlet.
Civic Platform displays the portlet

| Getting Started | 52

Accessing the Addresses, Parcels, or Owners Portlets
To access the Addresses portlet, the Parcels portlet, or the Owners portlet
1. Create a main link for the Addresses portlet, the Parcels portlet, or the Owners portlet (Setting Up Your
Console and Home Page).
2. Click the main link you created in .
Civic Platform displays the Addresses portlet, the Parcels portlet, or the Owners portlet. The Addresses
portlet is illustrated in this example.

Accessing the Professionals Portlet
To access the Professionals portlet

| Getting Started | 53

1. Add a main link for the Professionals portlet (Setting Up Your Console and Home Page).
2. Click the main link for the Professionals portlet.
Civic Platform displays the portlet

Classic and V360 Portlets
Table 1: Civic Platform Portlets

Portlet Name

Description

Classic Administration

The original administration page released in version 1 of
the product

Accela Ad hoc Report

V360 Ad hoc Report Portlet

Accela Custom Portlet

Accela Custom Portlet

Accela Custom Reports

Accela Custom Reports

Accela News

Accela News

Activities

V360 Activities Portlet

Addresses

V360 Addresses Portlet

Administration

V360 Administration Portlet

Alerts

V360 Alerts Portlet

ARW Reports

Accela Report Writer Portlet

Asset Condition Assessment

Asset Condition Assessment Portlet

Assets

V360 Asset Management Portlet

Assets Common Component

Provides access to assets across all solutions; not
limited to Asset Management solution. Available in Land
Management, Licensing and Case Management, and
Service Request solutions.

Batch Jobs

V360 Batch Jobs Portlet

Building Permits

V360 Building Permits Portlet

Bulletin Board

V360 Bulletin Board Portlet

Calendar

V360 User Calendar Portlet

Call Center News

News In Queue: Call Center News from
ReaderBoards.com

Cases

V360 Cases Portlet

Cashier Session

V360 Cashier Session Portlet

Citizen User Organization

Citizen User Organization

Citizen User Profile

Citizen User Profile

Classic System Permits

V360 Classic System Permits Portlet

| Getting Started | 54

Portlet Name

Description

CNET News

CNET News

Communication Manager

Communication Manager Portlet

Contacts

V360 Contacts Portlet

Credit Card/Check Transactions

Credit Card/Check Transactions Portlet

Development

V360 Development Portlet

Enforce

V360 Enforce Portlet

Enforcement

V360 Enforcement Portlet

ESPN News

ESPN Sports Headlines

Establish Genealogy

V360 Establish Genealogy Portlet

eWeek News

eWeek - News

FAQ

V360 FAQ Portlet (1)

FAQ

V360 FAQ Portlet (2)

FAQ

V360 FAQ Portlet

Fire

V360 Fire Portlet

Flow Diagram

V360 Permit Flow Diagram Portlet

Flow Diagram

V360 Service Request Flow Diagram Portlet

GIS

GIS

Health

V360 Health Portlet

Inspection Route Sheet

Inspection Route Sheet Portlet

Inspections

V360 Inspections Portlet

IntelliScript

V360 IntelliScript Portlet

Invoices

V360 Invoice Portlet

Jetspeed

Jetspeed is a multi-device portal system with simple
syndication capabilities

Kiva Classic

V360 Kiva Classic Portlet

Licenses

V360 Licenses Portlet

Model Maintenance

V360 Model Maintenance Portlet

My Navigation

V360 My Building Navigation Portlet

My Navigation

V360 My Enforcement Navigation Portlet

My Navigation

V360 My Fire Navigation Portlet

My Navigation

V360 My Health Navigation Portlet

My Navigation

V360 My Planning Navigation Portlet

My Navigation

V360 My Service Request Navigation Portlet

My Navigation

V360 My Work Orders Navigation Portlet

My Navigation

V360 My Navigation Portlet

My Permits

V360 My Building Permits Portlet

My Tasks

V360 My Tasks Portlet

New Flow Diagram

V360 Building Flow Diagram Portlet

News

Yahoo! News Top Stories

| Getting Started | 55

Portlet Name

Description

NLC Calendar

National League of Cities Calendar

NY Times Opinion

New York Times Opinion Page

Organization

Organization

Outlook Calendar

Outlook Calendar Portlet

Outlook Inbox

Outlook Inbox Portlet

Owners

V360 Owners Portlet

Parcels

V360 Parcels Portlet

Part Inventory

Part Inventory Portlet

Payment Processing

V360 Payment Processing Portlet

PCMag Reviews

PC Magazine Product Reviews

Permits

V360 Permits Portlet

Planning

V360 Planning Portlet

PM Schedules

PM Schedule Portlet

Point of Sale

Point of Sale

Political News

Yahoo! Political News

Preference

V360 Preference Management Portlet

Professionals

V360 Professionals Portlet

Public Building Permits

V360 Public Building Permits Portlet

Public Service Requests

V360 Public Service Requests Portlet

Public Works

V360 Public Works Portlet

PublicUser

PublicUser

Quicklinks

V360 Quicklinks Portlets (20)

Record

V360 General Record Portlet

Report Manager

V360 Report Manager Portlet

Reports

V360 Reports Portlet (5)

Service Requests

V360 Service Requests Portlet

Set Classic

V360 Set Classic Portlet

Set

V360 Set Portlet

Setup

V360 Setup Portlet

SmartCharts 2.0

V360 SmartCharts 2.0 Portlet

SmartCharts

V360 Narrow SmartCharts Portlet

SmartCharts

V360 Wide SmartCharts Portlet

Structures & Establishments

V360 Structures & Establishments Portlet

Task Management

V360 Task Management Portlet

Tech News

Yahoo! News Technology

Time Accounting

V360 Time Accounting Portlet

Trust Account

Trust Account

Turbine

Turbine is a java web application development framework

US News

Yahoo! News Top US Stories

| Getting Started | 56

Portlet Name

Description

User Info

V360 User Info Portlet

Weather

Current weather conditions for a city

Work Orders

V360 Work Orders Portlet

| Part 1: Configuring the User View | 57

Part 1: Configuring the User View
Civic Platform provides functions to customize the user interface.
Related Information
Transitioning to the New User Interface
Branding Civic Platform for Your Agency
Setting Up Your Console and Home Page
Customizing Menus, Tabs, and Drop-down Lists
Creating Custom Portlets
Filtering the Display of Data
Designing Forms for Portlets

| Part 1: Configuring the User View | 58

Transitioning to the New User Interface
Civic Platform 8.0 introduced a facelift to streamline the user interface and enhance the user experience.
The following topics describe how to transition from the legacy V360 UI to the new UI:
•

Setting the Civic Platform User Interface

•

Configuring Page Links on the Launchpad

•

Optimizing Form Designs

•

Configuring the Record Detail Menu

•

Utilizing the Task Dashboard

The "Getting to Know the New User Interface" chapter in the Civic Platform User's Guide is an essential
resource for users when transitioning to the new UI. It provides detailed how-to information, plus tips
and techniques to help users quickly adapt to the new look and feel. To enhance user satisfaction and
decrease support calls, consider sending your users a copy of "Getting to Know the New User Interface"
when you make the switch to the new UI.

Setting the Civic Platform User Interface
You can choose whether your agency users see the legacy V360 UI or the new UI by default. You can
also set the user interface by module so that some departments can be migrated to the new HTML user
interface while disabling the choice to move back to the V360 user interface. The implementation of this
feature uses the Standard Choice ENABLE_80_UI.
To set the Civic Platform user interface:
1. Go to the Classic Administration page. (Accessing Classic Administration).
2. Navigate to Agency Profile > Standard Choices.
3. Configure the Standard Choice ENABLE_80_UI, and set the Standard Choice Value and Value
Description using the following guidelines:
Standard Choice Value

Value Description

Description

YES

Sets the new HTML user interface as the
default UI for all users, and enables the
Switch UI link to allow users to switch
between the HTML and V360 user
interfaces.

NO

Sets the legacy V360 user interface as the
default UI for all users, and does not allow
users to switch between the HTML and
V360 user interfaces.

YES_V360

, , 
Example:
Building, Licensing

Sets the legacy V360 user interface as the
UI for users in the specified modules.
Users belonging to the listed module(s)
can only switch to the new UI if the same
module is also listed in the YES_HTML
value description.

| Part 1: Configuring the User View | 59

Standard Choice Value

Value Description

Description

YES_HTML

, , 

Sets the latest HTML user interface as the
UI for users in the specified modules.

Example:

Users belonging to the listed module(s)
can only switch to the legacy V360 UI
if the same module is also listed in the
YES_V360 value description.

Building, Planning

Note: Users who do not belong to any of the listed modules for YES_V360 and YES_HTML will
only see the legacy V360 UI. The YES_V360 and YES_HTML settings override the YES setting.
That is, if you configure all YES, YES_V360, and YES_HTML values, the YES setting will be
ignored.

UI Switch Configuration Scenario
Let's assume your agency has the following requirements:
•

Planning Department (Planning Module) can only view V360 user interface.

•

Building Department (Building Module) can only view the New UI.

•

License Department (License Module) can switch between V360 user interface and the New UI.

The users and their default modules may be as follows.
•

Sue has permission to access Planning and Building Modules, her default module is Planning.

•

Mary has permission to access Building and Licensing Modules, her default module is Building.

•

Bob has permission to access Licensing Module, his default module is Licensing.

•

Fred is in the Code Enforcement Department, default module is Code Enforcement.

Therefore, the Standard Choice setting for ENABLE_80_UI would be as follows.
Standard Choice Value

Value Description

YES_V360

Planning, License

YES_HTML

Building, License

If a user's default module is not explicitly listed in the YES_V360 and YES_HTML standard choice values,
then by default it will be the V360 UI only. As the above settings indicate, Fred would access the V360 UI
only.
The Civic Platform back-office UI switch
If a user has permissions to switch UI (via ENABLE_80_UI configuration), the user can switch from the
legacy V360 UI to the new UI using the Switch New UI link at the top right corner of the V360 UI, as
shown below.

| Part 1: Configuring the User View | 60

When a user clicks the Switch New UI link, Civic Platform switches from the V360 UI to the new UI:

If a user has permissions to switch UI (via ENABLE_80_UI configuration), the user can switch from the
new UI to the V360 UI using the Switch to V360 option on the Settings menu, as shown below:

| Part 1: Configuring the User View | 61

Related Information
•

Civic Platform User's Guide > Getting to Know the New User Interface

Configuring Page Links on the Launchpad
The new UI has transformed the {Console} > {Pages} > {Portlets} presentation hierarchy into a simple set
of navigable pages. The new UI no longer uses portlets; instead the V360 portlets now display as pages.
The launchpad on the new UI provides navigation links that allow users to quickly go to the different pages
within Civic Platform.

The launchpad has three main areas:
•

Your Pages which shows the pages the user has access to, including Favorites and All Pages

•

Recent list of records opened by the user

•

Reference data such as Address, Parcels, Owners, and others

| Part 1: Configuring the User View | 62

The All Pages section of the launchpad shows a categorized list of all pages the logged-in user has
access to. It is a consolidated list of pages that correspond to portlets that have been configured on all
pages across all V360 consoles. In general, a configured portlet that the user can access on any console
shows as a page link under All Pages.

For example, if the Activities, My Tasks, and Task Management portlets are configured on different
pages of the V360 Planning and Building consoles, and the user has access to these portlets, they will
show as page links on the launchpad. The following example shows the Activities, My Tasks, and Task
Management page links on the launchpad, including other pages corresponding to V360 portlets the user
has access to:

To remove a page link from the list of all pages, remove the portlet from all pages across all V360 consoles
via Administration > Console Configuration.
Note: The order and categorization of pages under All Pages currently cannot be customized.
Related Information
•

Civic Platform User's Guide > Getting to Know the 8.0 User Interface

| Part 1: Configuring the User View | 63

Optimizing Form Designs
Civic Platform's new UI inherits existing form designs used with the legacy V360 UI. Now that forms are
displayed as pages and no longer wrapped within portlets, a page opens up more space for a form view.
To take advantage of the additional real estate on the page, a form view can be redesigned. Redesigning a
form view can reduce or even eliminate the need to scroll.
The following example shows a Custom Fields form that can be re-organized to utilize all of the white
space available on the right side of the page:

Similarly, existing V360 list view designs are inherited by the new UI. Now that lists are no longer wrapped
in portlets, there is more vertical real estate available to display list items. The following example shows a
record list view in the new UI with additional white space at the bottom:

| Part 1: Configuring the User View | 64

The empty space can be optimized by increasing the default number of rows displayed. To adjust the list
view settings:
1. From a list, click Menu > Edit View:

2. On the list view editor, set the Contract to the number of rows to be displayed by default, and the
Expand field to the number of rows to be displayed when the user chooses Menu > Expand List.
The Contract and Expand settings on the list view editor:

| Part 1: Configuring the User View | 65

The page now displays more rows and less white space:

You can also adjust the DEFAULT_LIST_ROWS standard choice to increase the result row display from a
Global Search. The recommendation is 25-30 rows.
Some considerations related to form design:
•

Not all forms need to be re-designed. Consider a phased approach to form re-design.

•

The new UI and the V360 UI share the same form design. If your agency is planning to use the Switch
New UI, a form that is redesigned in the new UI may no longer be optimized for V360 usage.

| Part 1: Configuring the User View | 66

•

As some users might have gotten comfortable with the V360 field layouts, an exercise to educate the
users on the benefits of the new form layouts will help during the transition phase.

Related Information
•

Civic Platform User's Guide > Getting to Know the 8.0 User Interface

Configuring the Record Detail Menu
Civic Platform's new UI simplifies record detail navigation by replacing the My Navigation, Go To Menu,
and horizontal tabs in the V360 UI with a vertical tab that lists the record detail objects. Here's a sample of
a record page with the vertical navigation tab on the new UI:

The menu item configuration and order of the vertical tab is defined in Administration > Agency Profile
> Menu Navigation. An existing V360 Menu Navigation configuration shows as the default vertical menu
items on the new UI.
To customize the menu items on the vertical navigation tab for a user group on the new UI:
1. Review the menu items on My Navigation and Go To Menus that are used by the user group in V360.
This is an opportunity to analyze the most important and most commonly used pages, and remove any
duplicate or unused pages.
2. Go to Administration > Agency Profile > Menu Navigation.

| Part 1: Configuring the User View | 67

3. On the menu navigation tree, open the appropriate agency, module, and user group, and define the
consolidated set of menu items.
The following example shows the menu items defined in the Menu Navigation:
Related Information
•

Civic Platform User's Guide > Getting to Know the 8.0 User Interface

Utilizing the Task Dashboard
Civic Platform's new user interface is task centric. The first page that opens when a user logs into the new
UI is the Task Dashboard. This dashboard displays a consolidated list of the user's “My Tasks”, including
Workflow Tasks, Inspections, Document Review Tasks, Meetings and Activities. The default view shows
the Tasks assigned to the user. Tasks can be viewed as task cards or as a list. The following example
shows sample task cards:

From the Task Dashboard, the Filter menu shows a consolidated list of filters that are inherited
from existing Quick Queries or Saved Searches that are configured in the V360 My Tasks and Task
Management portlet. For example:

| Part 1: Configuring the User View | 68

If your agency does not currently use the V360 My Task portlets, consider creating Filters (Quick Queries)
that will provide a list of workflow tasks available to track a record status, and those responsible for
completion and specific due dates.
Activities can also be used to assign tasks related to a record outside of workflow, inspections, etc. For
those agencies that do not currently use Activities, this is a great opportunity to get record specific to-do
lists out of your email and post-it notes and into the platform.
In the following example, the permit tech has been assigned to call the contractor about a bounced check
and resend the Permit to the permit holder (note that these activities show as tasks on the Task Dashboard
example above):
Related Information
•

Civic Platform User's Guide > Getting to Know the 8.0 User Interface

| Part 1: Configuring the User View | 69

Branding Civic Platform for Your Agency
You can apply your agency’s brand to your Civic Platform implementation in a variety of ways.
You can customize the text that displays throughout your implementation; you can apply your agency’s
logo to a variety of items throughout Civic Platform; and you can set up an agency dictionary that works
with the spell checker to ensure that your agency-specific nomenclature is used properly.
Click a topic title below for full details.
Related Information
Customizing Display Text
Applying Logos to Items
Associating a Logo with an Agency
Displaying a Logo or Grade Card
Applying a Logo to Ad Hoc Reports
Configuring the Spell Checker and Agency Dictionary

Customizing Display Text
There are certain display text settings throughout Civic Platform you can customize. For example, you
can replace the default text settings to reinforce the terminology used by your agency, as well as make
instructions and other messages clear to users. Text settings appear in error messages, in dialog boxes,
and in other areas throughout the interface.
To add or edit a text setting
1. Access the Text Settings portlet (Accessing the Text Settings Portlet).
2. Click New.
Civic Platform displays a blank form in the secondary portlet.

3. Add or edit display text.
Note: Civic Platform automatically populates the grayed out fields.

a. Click the Select Display Text icon below the field.
b. Click the text setting in the Default Value column that you want to add.
c. Accept or modify the text, in the Display Text field, that you want to display in the interface.

| Part 1: Configuring the User View | 70

To use a specific parameter for a text setting, enter the parameter name surrounded by the “$$”
signs. The parameter value then displays throughout the interface.
Note: Civic Platform does not display the Module field or Type field if you select the “Format—Phone
Number” or “Format—Postal Code” categories.

4. Click Submit.

Adding Logos to Records
You can display images on records to help users easily:
•

Confirm that they are working with the right record type

•

Identify that they are working with the appropriate agency in super agency (multiple agency)
environments

Figure 1: An easily identifyable building permit record type

Associating a Logo with a Custom Fields Subgroup
You must associate an image with a Custom Fields Subgroup as a means of branding the agency,
enabling users to easily recognize the source of information.
To associate a logo with a Custom Fields Subgroup
1. Access the Logo portlet (Accessing the Logo Portlet).
2. Choose one of the following options:
•

To create a new agency logo association click New.

| Part 1: Configuring the User View | 71

•

To edit an existing agency logo association select the agency from the Logo list.

3. Complete or update the Logo fields as described in Logo Field Descriptions.
4. Click Save.
Table 2: Logo Field Descriptions

Agency

Select the agency name. Agency is a required field.

Description

Provide a brief description of the image used as the Agency Logo.

File Name

Click Browse to search and select the image you want to associate with the agency.

Logo Type

Select the Custom Fields Subgroup Name.

Logo URL

Provide the image URL in this field when the image you want to use as the logo resides
on the web.

Associating a Logo with an Agency in Citizen Access
If your agency has associations with other agencies, you can create a Custom Fields Subgroup
representing each agency and associate the city, county, or state logo with it. Creating Custom Fields
Subgroups is particularly useful if your agency uses Citizen Access for multi-service administration. During
the record creation process, the public user views fees allocated to a permit application from the state
and city in which they live. An image displays next to the agency to indicate the agency where the fee
originates, as shown on Associating a Logo with a Custom Fields Subgroup. The agency logos display on
the Fee page, Custom Fields Subgroup, and on the Payment Page in Citizen Access.

Figure 2: Agency Logo on Fee Detail page in Citizen Access

| Part 1: Configuring the User View | 72

To associate a logo with an Agency
1. Configure the Standard Choice below. This defines the agency logo type (Custom Fields Subgroup)
used in Citizen Access to retrieve the agency log.
a. Access the Classic Administration page (Accessing Classic Administration).
b. Navigate to Agency Profile > Standard Choices.
c. Configure the Standard Choice MULTI_SERVICE_SETTINGS as described below:
Standard Choices Value

AGENCY_LOGO_TYPE

Value Desc.

LOGO_TYPE_CATEGORY

Civic Platform maps this logo type with the MULTI_SERVICE_SETTINGS Standard Choices Value
AGENCY_LOGO_TYPE.
2. Access the Logo portlet (Accessing the Logo Portlet).
3. Choose one of the following options:
•

To create a new Agency Logo association click New.

•

To edit an existing agency logo association click the name of the agency in the Logo list.

4. Complete or update the Logo fields as described in Table 2: Logo Field Descriptions.
5. Click Save.
Table 3: Logo Field Descriptions

Agency

Select the agency name. Agency is a required field.

Description

Provide a brief description of the graphic used as the agency logo.

File Name

Click Browse to search and select the image you want associated with the agency.

Logo Type

Select the Custom Fields Subgroup Name.

Logo URL

If the image you want to use as the logo is on a website provide the image URL in this
field.

Displaying a Logo or Grade Card
You can add your agency logo to the User Information portlet. You can also add a grade card to the
Food Facility Inspection Details page in Citizen Access to indicate the inspection results for the licensed
food facilities. You can change the logo or grade card at any time, or remove it from the portlet. If your
jurisdiction covers multiple agencies, you can assign a unique logo for each agency.
Topics
•

Adding a Logo or Grade Card

•

Removing a Logo or Grade Card

•

Changing a Logo or Grade Card

| Part 1: Configuring the User View | 73

Adding a Logo or Grade Card
You can upload a logo image for each agency in your jurisdiction. Civic Platform displays the logo in
the User Information portlet. You can also upload a grade card image for the food facility to indicate the
inspection result in Citizen Access.
To upload a logo or grade card image
1. Access the Logo portlet (Accessing the Logo Portlet).
2. Click New.
Civic Platform displays the Logo form portlet.
3. Complete the fields as necessary.
For descriptions of the fields, see Table 4: Image Fields and Options.
4. Click Submit.
Table 4: Image Fields and Options

File Name

Enter the file path and name of the logo image you want to display. To browse to the
file, click Browse.

Logo Type

To upload logo image, select USERINFOLOGO from the drop-down list. To upload
grade card image, select the value such as Grade A, Grade B, Grade C, or Closure.
You define the values that populate in this list in the LOGO_TYPE_CATEGORY
Standard Choice.

Description

Enter a description of the logo or grade card image.

Agency

Used only for uploading logo image. Select the agency where you want the logo to
display from the Agency drop-down list.

Removing a Logo or Grade Card
Civic Platform allows you to remove an image, a logo or a grade card, you added previously to the User
Information portlet or Food Facility Inspection Details page in Citizen Access. You can remove the image if
you added the wrong file, or if you no longer want to display it.
To remove a logo or grade card image
1. Access the Logo portlet (Accessing the Logo Portlet).
2. Select the image you want to remove.
3. Click Delete.
Civic Platform displays a delete confirmation message.
4. Click OK.

Changing a Logo or Grade Card
You can change the logo image that displays in the User Information portlet or displays as the grade card
image in the Food Facility Inspection Details page of Citizen Access. You can change the image that
displays if you added the wrong file, or if your agency logo changes. To change an image, you must first
remove the image and then add a new one.
To change a logo or grade card image
1. Access the Logo portlet (Accessing the Logo Portlet).
2. Select the image you want to change.

| Part 1: Configuring the User View | 74

3. Click Delete.
Civic Platform displays a delete confirmation message.
4. Click OK.
Civic Platform removes the selected image.
5. Click New.
Civic Platform displays the Logo form portlet.
6. Complete the fields as necessary.
For descriptions of the fields, see Table 4: Image Fields and Options.
7. Click Submit.

Applying a Logo to Ad Hoc Reports
When a user wants to add an agency’s logo to an ad hoc report, Civic Platform looks for a logo with the
logo type AGENCY_LOGO and uses it automatically for the report.
To apply a logo to an ad hoc report
1. Configure the Standard Choice LOGO_TYPE_CATEGORY to include the Standard Choices Value
AGENCY_LOGO.
a. Access the Classic Administration page (Accessing Classic Administration).
b. Navigate to Agency Profile > Standard Choices.
c. Configure the Standard Choice LOGO_TYPE_CATEGORY to include the following:
Standard Choices Value

AGENCY_LOGO

Value Desc.

A brief description to identify the logo file.

2. Access the Logo portlet (V360 Admin > Agency Profile > Logo) and add the logo you want to use:
a. Click New.
b. Click Browse to locate and select the logo file you want to use.
c. Select Logo Type = AGENCY_LOGO.
d. Select an agency from the Agency drop-down list.
e. Click Save.
The logo displays on ad hoc reports.

Configuring the Spell Checker and Agency Dictionary
You have the option to enable a spell checker utility for scrolling text fields in both Civic Platform and
Citizen Access. The spell checker allows the user to identify and correct the spelling of any text that the

| Part 1: Configuring the User View | 75

user enters. For example, an inspector can check the spelling of the comments he enters when resulting
an inspection as illustrated in Figure 3: Inspection Result Comment with Spell Checker

Figure 3: Inspection Result Comment with Spell Checker

Figure 4: Citizen Access License Request Comment with Spell Checker
Civic Platform uses a standard dictionary for all spell checking. In addition, agencies can create custom
dictionaries to incorporate industry- and agency-specific nomenclature. You can then make the custom
dictionary available to users in Civic Platform, Citizen Access, and Mobile Office. When there is a custom
dictionary available, Civic Platform uses both the standard dictionary and the custom dictionary for
checking spelling. See Creating Custom Dictionaries for Your Agency.
Note:
Civic Platform supports custom dictionaries for the English language only.

To enable spell checking
1. Access the Standard Choices Search form. (See “Editing Standard Choices in the Setup Admin” in the
Civic Platform Configuration Reference).
2. Use the search utility to locate either or both of the following standard choices:
ACA_SPELL_CHECKER_ENABLED (use to enable spell checking in Citizen Access).
SPELL_CHECKER_ENABLED (use to enable spell checking in Civic Platform and Mobile Office).
3. Enable either or both of the spell checker standard choices to set up the spell checker.

| Part 1: Configuring the User View | 76

Creating Custom Dictionaries for Your Agency
Administrators can create custom dictionaries at an agency level. A Custom Dictionary portlet is available
to review and manage custom dictionary entries. It is accessible in the Setup portlet in the Agency Profile
menu. You must enable FID 0354-Custom Dictionary to configure the Custom Dictionary portlet.
When there is a custom dictionary available, Civic Platform uses both the standard dictionary and the
custom dictionary when checking spelling.
Note:
Civic Platform supports custom dictionaries for the English language only.

After you configure a custom dictionary, and you sync it with Mobile Office, users must restart Mobile Office
for the changes to take effect.
•

Searching for an Existing Custom Dictionary Entry

•

Adding a Custom Dictionary Entry

•

Deleting an Entry

Searching for an Existing Custom Dictionary Entry
If you need to modify or remove a dictionary entry, you can search for existing words in your custom
dictionary.
To search for an existing custom dictionary word
1. Access the Setup portlet.
2. Select Dictionary from the Agency Profile menu.
A dictionary administration portlet displays.

3. Click Search.
The Search form displays.

4. Enter search criteria as needed, then click Submit.
The search results display.

| Part 1: Configuring the User View | 77

Adding a Custom Dictionary Entry
You can add as many words to your custom dictionary as you need.
To add a new word to the custom dictionary
1. Access the Setup portlet.
2. Select Dictionary from the Agency Profile menu.
A dictionary administration portlet displays.
3. Click New.
A Custom Entry form displays.

4. Complete the fields as described.
Word

Enter the word you want to add to the custom dictionary as you want it to appear
(for example, enter the word in title case or in uppercase). If you enter a word that
already exists in the standard dictionary but your entry is in a different case, Civic
Platform presents both options to the user in the Suggested list.

Description

Optional: Enter a brief description of the word in this field.

5. Click Submit.
Civic Platform adds the new entry to the custom dictionary in Civic Platform, Citizen Access, and Mobile
Office.

Deleting an Entry
You can delete words from your custom dictionary as needed.
To delete a word from your custom dictionary
1. Launch the Custom Dictionary portlet.

| Part 1: Configuring the User View | 78

2. Use the search functionality to locate the term you want to delete. (see Searching for an Existing
Custom Dictionary Entry).
3. Click Delete.
Civic Platform deletes the term.

| Part 1: Configuring the User View | 79

Setting Up Your Console and Home Page
This section provides instructions on how to customize your console and home page, including configuring
the console layout and skin, defining the main links and portlets in the console, and customizing the text
that displays to users throughout the system.
Click a topic title below for full details.
Related Information
Configuring the Civic Platform console
Adding a Main Link
Setting your Home Page
Adding Additional Consoles
Customizing Text

Configuring the Civic Platform console
This section provides instructions on how to set up your console, including defining your home page, and
customizing the main links that enable users to access portlets.
Topics
•

Customizing a Console

•

Searching for a Console Configuration

•

Editing a Console Configuration

•

Managing Console Permissions

•

Setting your Home Page

Customizing a Console
Use the Console Editor to specify the names of the main links that display on your console, the order in
which they display, and how many main links you want to display. Main links might include Civic Platform
Administration, V360 Admin, Building, Inspection, Home, and Report Manager, for example. Then, for each
main link, you define which portlets open on your console and where. For example, inspectors might want
to associate the Calendar and Inspection portlets in the large portlet area, and the Bulletin Board portlet in
the smaller side portlet area for the Inspections main link. Some portlets allow for further customization. For
more information on customizing portlets, see Customizing Menus, Tabs, and Drop-down Lists .
Topics
•

Navigating the Console Editor

•

Configuring the Console Layout and Skin

Navigating the Console Editor
The Console Editor is a configuration tool that enables you to add or modify the main links and portlets
that display on your user interface. Use the Console Editor to create a unique user interface containing the

| Part 1: Configuring the User View | 80

main links and portlets related to your day-to-day activities. For an example of the Console Editor and its
associated parts, see Figure 5: Console Editor.

Figure 5: Console Editor
A

Layout menu. The console layout menu. Use this drop-down menu to modify portlet layouts.

B

Name label. The column label indicating the name and order of the main links on the console.

C

Add Portlet button. This button activates when you select a main link. Click this button to associate a portlet
with a main link.

D

Add Reference button. Administrators or users with administrative rights can click this button to add a
reference to another user’s console.

E

Add Page button. Click this button to add a main link to the console. To associate a portlet with a main link,
click Add Portlet.

F

Edit Properties button. Click this button to modify the name and description of a main link.

G

Skin menu. If your agency uses skins (colorful displays of console elements) you can use this drop-down
menu to select and activate the skin.

H

Action. Use the action buttons to remove and reposition the main link display.

Configuring the Console Layout and Skin
You can select the layout and skin to apply in your console. The layout defines the appearance and
placement of the main links in your console. The skin is the visual representation style of console
elements.

Choosing Simple Skin or Standard Skin for the Agency
Civic Platform provides both a standard skin and a simple skin, which is the default. Compared with the
standard skin, the simple skin presents streamlined look for pages and buttons, and better organizes
information in the console. The simple skin enables users to expand and collapse the record list portlet to
maximize the size of their workspace.
You can choose to enable a skin type in the Standard Choice UI_SKIN. The enabled skin type applies to
the whole agency.
The figures below present a comparison between the simple skin and the standard skin interfaces.

| Part 1: Configuring the User View | 81

Figure 6: Console Display with Simple Skin

Figure 7: Console Display with Standard Skin

Setting the Layout and Skin for the Console
You can use the console editor to set the layout and skin used specially for a console.
To set the layout and skin for a console
1. Click Console Options in the upper-right corner of the console.

| Part 1: Configuring the User View | 82

Civic Platform displays the Console Editor.

2. Select the layout from the Layout drop-down, and the skin from the Skin drop-down.
There are two layout options, V360 PA Tab Page, and V360 Tab Page. The V360 PA Tab Page layout
displays the main links in one row, which extends the page width of the console. With the V360 Tab
Page layout, the main links display in several rows, which provides a fixed-width page view, with no
need to scroll to see main links.
You can configure skin details in the super agency administration site.
Note:
If you apply the simple skin to the agency (see Choosing Simple Skin or Standard Skin for the Agency),
the skin you select here is not applicable. If you apply the standard skin to the agency, the skin selected
here takes effect in Classic Administration and Console Editor.

3. Click Save and Apply.
Civic Platform saves the settings.

Adding a Main Link
Main links display along the top of your home page and provide users with easy access to portlets.
Use the Console Editor to add, remove, or customize a main link.
You must be an administrator or a user with the proper permissions to access the Console Editor.
To add a main link
1. Click Console Options in the upper-right corner of the console.
Civic Platform displays the Console Editor.
2. To add a new main link, click Add Page in the Console Editor.
Civic Platform displays the Add Main Link page.

| Part 1: Configuring the User View | 83

3. Enter the name of the main link you want to add and click Apply.
Civic Platform displays the main link at the end of the main link list.
4. In the Console Editor, scroll to the end of the list of main links, and click the name of the main link you
just added.
5. Click Add Portlet.
Civic Platform displays a list of available portlets.

6. Locate the portlet you want to associate with the main link using the alphabetical links at the bottom of
the page or the category and parent filters at the top of the page.
7. Click Add next to each portlet you want to associate with the main link, then click Apply.
Civic Platform displays the main link details page.
8. Click Apply and then Click Save and Apply.

Repositioning or Removing a Main Link
Civic Platform allows you to customize your console by determining the names of main links and the order
in which they display. Use the Action button on the Customize page to remove or reposition main links.
To reposition or remove a main link
1. Click Console Options in the upper-right corner of the console.
Civic Platform displays the Console Editor.
2. In the Action column, reposition or remove a main link using the action buttons. These buttons are:
Move Up. Moves the main link up one position in the Console Editor. Modifies the console display by
shifting the main link to the right.

| Part 1: Configuring the User View | 84

Move Down. Moves the main link down one position in the Console Editor. Modifies the console
display by shifting the main link to the right.
Remove. Removes the main link and its associated portlets.

3. Click Save and Apply.
Civic Platform saves the changes and returns to the home page.

Repositioning or Removing a Portlet
You can customize the portlets associated with a main link by modifying the portlet position or removing
it. To accomplish these tasks, you must first navigate to the Console Editor. After you access the Console
Editor, use the action buttons to arrange the portlets.
To reposition or remove a portlet
1. Click Console Options in the upper-right corner of the console.
Civic Platform displays the Console Editor.
2. Click the main link that contains the portlet you want to reposition or remove.
Civic Platform displays the main link details page.

3. Reposition or remove a portlet using the buttons. These buttons are:
Move Up. Moves the selected portlet one position up.
Move Down. Moves the selected portlet one position down.
Move Right. Moves the portlet to the right panel.
Move Left. Moves the portlet to the left panel.
Remove. Removes the portlet from the main link.

4. When you complete the process of repositioning and removing portlets, click Apply.
Civic Platform saves your changes and displays the Console Editor.

| Part 1: Configuring the User View | 85

Setting your Home Page
A home page is the first page you view after logging into Civic Platform or the page that displays after
clicking the Home button on the console toolbar. To customize your home page, you must create a main
link and add the portlets you want associated with it. Then you must ensure that the main link you want to
use for the home page is in the first position.

Adding Additional Consoles
You can customize multiple consoles to fit the needs of different types of users and departments. This
can include creating a custom console that limits what some users have access to, and creating a more
advanced console with expanded access for other users.
To add a customized console
1. Access the Console Configuration portlet (Accessing the Console Configuration Portlet).
2. Click New.
3. Enter the console name and console description.
4. Click Customize.
For more information about how to customize your console, see Editing a Console Configuration.
5. Click Submit.
Civic Platform adds the customized console.

Searching for a Console Configuration
To search for console configuration
1. Access the Console Configuration portlet (Accessing the Console Configuration Portlet).
2. Click Search.
3. Enter the console name or console description, or both.
4. Click Submit.
Civic Platform displays the console configuration that match your search criteria.

Editing a Console Configuration
Administrators can create a standard console and assign it to a user group or module. The Console
Configuration portlet is where you organize the various console configurations. You can modify the name
and customize the color of portlets throughout Civic Platform. The color you choose for Civic Platform
displays as the background color for the portlet selected. Blue is the default color scheme. Your other
choices are: red, green, yellow, black, taupe.
To edit a console configuration
1. Access the Console Configuration portlet (Accessing the Console Configuration Portlet).
2. Select a console name from the list to modify the Console Name or Console Description.

| Part 1: Configuring the User View | 86

Civic Platform displays the Console details.

3. You can change the layout and choose a skin for your console.
a. Click Console Options.
Civic Platform displays the Console Editor.
b. If you want to change any console elements, see Customizing a Console for details.
c. Click Save and Apply.
Civic Platform returns you to the Console Configuration portlet.
4. To assign specific users to this console, click Recipient tab and follow the instructions in Managing
Console Permissions.

Managing Console Permissions
After creating a customized console, decide which agency, module, user group, and user has access to the
customized console.
If your login account has access permissions to multiple consoles, Civic Platform provides a console name
link (for example, My Console) in the right corner of the Agency Bar. You can click a console name link
to open a drop-down menu of all available consoles, and then click a console name to switch between
consoles. See Figure 8: Switching between Consoles .

Figure 8: Switching between Consoles
Go to the Recipient tab in the Console Configuration portlet (Accessing the Console Configuration Portlet)
to manage the agencies, modules, user groups, and users assigned to the customized console. For more
information, see Setting Up Security Policies.

| Part 1: Configuring the User View | 87

Customizing Text
There are certain display text settings throughout Civic Platform you can customize. For example, you
can replace the default text settings to reinforce the terminology used by your agency, as well as make
instructions and other messages clear to users. Text settings appear in error messages, in dialog boxes,
and in other areas throughout the interface.
To add or edit a text setting
1. Access the Text Settings portlet (Accessing the Text Settings Portlet).
2. Click New.
Civic Platform displays a blank form in the secondary portlet.

3. Add or edit display text.
Note:
Civic Platform automatically populates the grayed out fields.

a. Click the Select Display Text icon below the field.
b. Click the text setting in the Default Value column that you want to add.
c. Accept or modify the text, in the Display Text field, that you want to display in the interface.
To use a specific parameter for a text setting, enter the parameter name surrounded by the “$$”
signs. The parameter value then displays throughout the interface.
Note:
Civic Platform does not display the Module field or Type field if you select the “Format—Phone
Number” or “Format—Postal Code” categories.

4. Click Submit.

| Part 1: Configuring the User View | 88

Customizing Menus, Tabs, and Drop-down Lists
This section provides instructions for configuring the navigation elements that enable users to access
information and product features.
Click a topic title below for full details.
Related Information
Overview
Working with Menus and Tabs
Creating Template Menus for Modules
Creating Template Menus for User Groups
Creating User Flow Diagrams
Creating Shared Drop-down Lists
Configuring Record Detail Tabs
Defining the Create New Menu
Customizing Go To Menus

Overview
Administrators can create the following custom navigation elements that enable users to access the
information they need to perform their daily tasks.
•

Menus

•

Tabs

•

Flow Diagrams

•

Drop-down Lists

Custom menus are drop-down menus that group and organize daily tasks together. You can use custom
menus in place of, or in addition to, the standard record detail tabs. The sample screen below illustrates
the “Go To” menu, where users access custom menus, and the standard record detail tabs. The Go To
menu and the record detail tabs provide users two ways to quickly access and retrieve information to
perform their daily tasks.

| Part 1: Configuring the User View | 89

Users can access custom menus by clicking the Go To menu on the upper left side of the detail form
portlets. You can display a maximum of 16 menu items on custom menus, and then arrange those menu
items so that they display in the order that is most useful to a specific module or user group.
To enable the Go To menu, you must enable Function ID 0230: Menu Navigation Admin. You must also
enable the Standard Choice Menu_Navigation_Enabled. For more information on working with FIDs and
Standard Choices, refer to the Civic Platform Configuration Reference.

The Menu Navigation Tree
Civic Platform uses a folder structure to configure, create, and display custom menus.
Figure 9: Menu Navigation Tree shows a sample configuration of custom menus and tabs, and gives
the definitions for various navigation tree nodes. You can access the menu navigation tree by going to
Administration > Agency Profile > Menu Navigation.
Click the plus (+) or minus (-) sign in the menu navigation tree to view the configurations at different levels.
If you right-click a tree node in the menu navigation tree, the pop-up menu shows all the operations you
can perform with the node. For example, if you right-click a module name, you can add groups or menu
templates for the module, or delete the module settings.

| Part 1: Configuring the User View | 90

Figure 9: Menu Navigation Tree
A

The Portlet folder. Four portlet types can contain the Go To menu, custom drop-down menu and custom tabs:
Asset Data Management (asset details portlet), Record Form Portlet (record details portlet), Ref Address Form
Portlet, and Ref Parcel Form Portlet.

B

The Agency folder. You can add agency-level menu template, or add modules and groups and then configure
module-level and group-level templates in this folder.

C

The Template folder. You can create template menus for the entire agency or for individual modules and
groups. You can add custom menus or tabs with the right-click options, or open a template menu and then
change its settings.

D

The Tab folder. You can add a tab menu and create tabs within it. Only the selected tabs display in the details
portlet when users open the portlet.

E

Navigation Menus. Navigation menus are where you create or remove custom menus. You can add, cut,
copy, paste, and delete a menu with the right-click options.

F

Module folders. You can create module folders and define module-level custom menu items and custom tab.

G

Group folders. You can create group folders and define custom menu items and custom tab that work for a
specific group.

H

Menu items. Items are the daily tasks that a user performs. There can be a minimum of one menu item per
menu, and a maximum of 16 items per menu.

I

Tab Items. If you define a tab and assign tab items to the tab, when users open the details portlet (see A),
only selected tab items display in the details portlet.

Working with Menus and Tabs
Topics

| Part 1: Configuring the User View | 91

•

Managing Template Menus

•

Managing Menus

•

Managing Tabs

Managing Template Menus
Template menus provide a starting place for creating custom menus and tabs for the entire agency or for
individual modules or groups. For example, if you want to create a menu specific to the building module,
you can copy and modify the agency template menu. You can also create a separate template menu for
the building module with tasks specific to the users within the building department.
Topics
•

Creating a Template Menu

•

Deleting a Template Menu

•

Copying a Template Menu

Creating a Template Menu
If you assigned the template menu to a module, that template menu overrides any custom specific agency
menu. If you assigned a template menu to a user group, that template menu overrides the custom modulelevel menu.
To create a template menu
1. Access the Menu Navigation portlet (Accessing Menu Navigation).
2. Expand the desired portlet folder to the agency folder level.
Civic Platform displays the agency folder.

3. Right-click the agency folder and click Add Template.

Civic Platform displays the Template Menu portlet.

4. Complete the fields that display. For a list of field descriptions, see Table 5: Template Menu Fields.

| Part 1: Configuring the User View | 92

5. Click Submit.
Civic Platform confirms you successfully created the menu template.
Table 5: Template Menu Fields

Description

Enter a description of the menu.

Menu Template Name

Enter a name for the template menu. For example, you might name a menu template
for the building module Default Building Menu.

Portlet Name

The portlet where the menu displays. Civic Platform assigns this name automatically; it
is read-only.

Show All Tabs

Select Yes or No to set whether all tab items display as the record detail tabs. Table 6:
Tab Items to Display as Record Detail Tabs shows what tab items display as the record
detail tabs at different custom tab and “Show All Tab” settings.

Status

Select Enabled to display the menu. Select Disabled to hide the menu.

Table 6: Tab Items to Display as Record Detail Tabs

“Show All Tabs” Setting Custom Tab Configured

What Tab Items to Display as Record
Detail Tabs?

Yes

Yes

Customized tab items

Yes

No

All built-in tabs

No

Yes

The first custom tab item

No

No

The Summary tab

Deleting a Template Menu
You can delete template menus you no longer need. When you delete a template menu, it effects all
modules, user groups, and users who had the template menu assigned to them. For example, if you have
an agency template menu and a building template menu for the building user group, all the building group
users have the building template menu assigned to them. However, if you delete the building template
menu, Civic Platform assigns the agency template menu to the building user group by default.
To delete a template menu
1. Access the Menu Navigation portlet (Accessing Menu Navigation).
2. Expand to the portlet, module, or group folder where you want to delete the template menu.
Right-click the portlet, module, or group folder where you want to delete the menu template from and
click Delete.

Civic Platform displays a confirmation window to delete the template menu.
3. Click OK.
Civic Platform confirms you successfully deleted the menu template.

| Part 1: Configuring the User View | 93

Copying a Template Menu
Copying and modifying template menus is a fast and efficient way to create multiple menus for your
agency. You can save time by creating one menu and copy/pasting it to any module, user group or user.
Then you can make minor modifications as needed for the specific modules, groups and users.
To copy the template menu
1. Access the Menu Navigation portlet (Accessing Menu Navigation).
2. Right-click the template menu folder and click Copy.
Civic Platform copies the menu template.

3. Right-click the Module or Group folders where you want to copy the menu template, and then click
Paste.
Civic Platform displays the Copy page.

4. Click OK.
Civic Platform copies the menu to the selected module or group.

Managing Menus
Menus are the basic building blocks of creating custom menu navigation. Custom navigation menus are
drop-down menus that group and organize daily tasks together. You can use custom menus in place of, or
in addition to, standard menus and record detail tabs. Civic Platform organizes the menu items to display in
the order that is most applicable to a specific module or user group. Custom navigation menus display from
the Go To menu tab on the upper left side in the detail form portlets where scroll tabs usually display.
When users select a custom navigation menu item from the Go To menu, if the detail tab includes that
menu item, the menu item becomes the current tab in the detail tabs. If the detail tabs do not include the
menu item, the menu item appears to the right of the detail tabs and becomes the current tab.
To create menus Civic Platform requires a minimum of one menu item and a maximum of 16 menu items.
After you add menu items to a menu, you can add the menu to the template menu. After you add the menu
to a template menu you can copy/paste it to template menus in other modules or user groups, and then
make minor modifications to fit specific user needs.
Topics
•

Adding a Menu to a Template Menu

•

Copying a Menu to a Template Menu

•

Deleting a Menu from a Template Menu

•

Adding Built-in Menu Items to a Menu

•

Adding Custom Menu Items

| Part 1: Configuring the User View | 94

•

Removing Menu Items from a Menu

Adding a Menu to a Template Menu
You can add custom drop-down menus to specific modules and individual user groups. For example, you
can create a menu to grant access to a user that has limited access to certain tasks.
To add a menu to a menu template
1. Access the Menu Navigation portlet (Accessing Menu Navigation).
2. Right-click the template folder and click Add Menu.

Civic Platform displays the Menu detail form portlet.

3. Complete the following fields:
Description

Enter a description for the menu.

Menu Name

Enter a name for the menu.

Menu Template Name

This read-only field displays the template name you selected.

4. Click Submit.
Civic Platform confirms you successfully created the menu.

Copying a Menu to a Template Menu
Copying menus is a fast and efficient way to create multiple menus for your agency. You can save time
by creating one menu and copying it to multiple modules, users, or user groups. You can then modify the
menu to meet the specific needs of the modules, users, or user groups
To copy a menu
1. Access the Menu Navigation portlet (Accessing Menu Navigation).

| Part 1: Configuring the User View | 95

2. Right-click the menu folder you want to copy and click Copy.
Civic Platform copies the template menu.

.
3. Right-click the template folder where you want to copy the menu and click Paste.
Civic Platform displays the Copy page.
4. Click OK.
Civic Platform copies the menu to the template menu.

Deleting a Menu from a Template Menu
Delete menus you no longer need using the right-click options available in the left navigation portlet.
Deleted menus no longer display in the drop-down menu for the specified detail form portlet.
To delete a menu from a template menu
1. Access the Menu Navigation portlet (Accessing Menu Navigation).
2. Right-click the template menu folder where you want to delete the menu from, and then click Delete.
Civic Platform displays a confirmation window to delete the menu from the template menu.
3. Click OK.
Civic Platform confirms you successfully deleted the menu.

Adding Built-in Menu Items to a Menu
Built-in menu items are the default menu items in Civic Platform. You create a menu by adding and
arranging menu items in a list. A menu is complete after you add the menu items, arrange them, and
organize them in the drop-down list. You add menu items at the same time you create a menu or when
modifying existing menus. You can add up to a maximum of 16 menu items to a menu.
To add and arrange Built-in menu items to a menu, use the side-to-side and up/down arrow buttons. To
move a menu item from the from the Built-in menu item list to the Selected menu item list highlight the
Built-in menu item you want to move and click the single side-to-side arrow button. The single arrow button
moves Built-in menu items to the Selected menu item list one at a time. The double arrow button moves all
the Built-in menu items to the Selected menu item list. When you have added all the menu items you want
to display, arrange the order of the Selected menu items with the up/down arrows.
To add menu items to a menu
1. Access the Menu Navigation portlet (Accessing Menu Navigation).

| Part 1: Configuring the User View | 96

2. Expand the folders to the Template menu folder level.
Civic Platform displays the menus associated with the template.

3. Click the menu folder you want to add menu items to.
Civic Platform displays a Menu detail form portlet.

4. Click the Menu Items tab.
Civic Platform displays the Menu Items portlet.

| Part 1: Configuring the User View | 97

5. From the Built-in Menu Items list, select and highlight the menu item you want to add and click the
right Single Arrow button to move the menu item to the Selected list. To select all the Built-in Menu
Items, click the right Double Arrow button.
Civic Platform moves the Menu Item to the Selected Menu Items box.

6. Use the Up/Down Arrows to select the order the menu items are to display. These buttons only effect
the order the Selected Menu Items display.
7. Click Submit.
Civic Platform confirms you successfully added the menu items to the menu.

Adding Custom Menu Items
You can add custom menu items that reference data not stored in Civic Platform using a hyperlink to
a valid URL. For example, if a building permit clerk needs to reference building codes stored on your
agency’s Intranet, you can create a custom menu item that links with your agency’s Intranet.
To add a custom menu item
1. Access the Menu Navigation portlet (Accessing Menu Navigation).
2. Expand the portlet folder where you want to add the template menu.
Civic Platform displays the template menu.
3. Click the menu folder where you want to add menu items.
Civic Platform displays a Menu detail form portlet.

| Part 1: Configuring the User View | 98

4. Click the Menu Items tab.
Civic Platform displays the Menu Items detail page.

5. Click New.
Civic Platform displays the Menu Items detail form portlet.

| Part 1: Configuring the User View | 99

6. Complete the applicable fields. For a list of field descriptions, see Table 7: Custom Menu Item Detail
Fields. When adding a Custom menu item you are referencing a URL outside of Civic Platform.
7. Click Submit.
Civic Platform confirms you successfully created the menu item and adds it to the menu.
Table 7: Custom Menu Item Detail Fields

Description

Enter a description for the menu.

Link

Enter a valid URL of the website for the custom menu item.

Menu Item Label

Enter the label for the menu item that you want to display in the drop-down menu.

Menu Item Name

Enter the name of the menu item.

Menu Name

The name of the menu for the menu item displays as read-only

Removing Menu Items from a Menu
You can delete menu items you no longer want to display.
To delete menu items from a menu
1. Access the Menu Navigation portlet (Accessing Menu Navigation).
2. Expand the folders to the template menu folder.
Civic Platform displays the menus associated with the template.

3. Click the menu folder from where you want to remove menu items.
Civic Platform displays a Menu Detail form portlet.

| Part 1: Configuring the User View | 100

4. Click the Menu Items tab.
Civic Platform displays the Menu Items portlet.

5. From the Selected Menu Items list, select and highlight the menu item you want to remove and click
the right Single Arrow

button to remove the menu item from the Selected list. To remove all the

Selected Menu Items, click the right Double Arrow button
.
Civic Platform moves the menu item to the Selected Menu Items box.

6. Click Submit.

| Part 1: Configuring the User View | 101

Civic Platform confirms you successfully removed the menu item.

Managing Tabs
The record detail tabs by default include every detail about a record that Civic Platform can support. If you
want to select and display a few tab items instead, you can create a tab menu and add the desired tab
items in the tab menu. Then the detail tabs only display the tab items in the tab menu. Users can quickly
and easily grasp what they want to know about a record and what they should do for the record.
What tab items display as the detail tabs rely on both the tab menu configuration and the template menu
“Show All Tabs” setting. For more information, see Table 6: Tab Items to Display as Record Detail Tabs.
You create tabs in the template menu folders in the menu navigation tree. Each template menu folder can
only hold one tab menu. Each tab menu inherits the settings from its template menu. For example, when
you disable a template menu, it also disables the tab menu.
In addition to select tab items for a tab menu, you can define the order of the tab items, and customize the
tab item labels.
See Figure 10: Tab Menu Sample. The record details portlet has a custom tab menu with four tab items.
Record, Related Records, Inspections and Work Order Tasks.
Note:
If you set the Function Identification for a tab to no access for a user group, those users are not be able to
view the tab, regardless of whether you add it to the tab menu.

Topics
•

Adding a Tab Menu to a Template Menu

•

Setting Tab Item Labels in a Tab Menu

•

Deleting a Tab Menu

Figure 10: Tab Menu Sample

Adding a Tab Menu to a Template Menu
You can create tabs for detail portlets. Before you add a tab menu to a portlet, decide whether you want
to enable the tab menu for the whole agency, specific modules, or individual user groups. Then follow the
instructions in Creating a Template Menu to create a template menu in the agency, specific module, or
individual user group.
To add tab menu to a template menu

| Part 1: Configuring the User View | 102

1. Access the Menu Navigation portlet (Accessing Menu Navigation).
2. Navigate to the template menu with which you plan to create the tab menu. The template menu can
reside in the agency, module, or user group folder, depending on the scope in which you want the tab
menu to take effect.
3. Right-click the template menu folder, and then click Add Tab.

Civic Platform displays the Tab Detail form portlet next to the menu navigation tree.

4. Complete the following fields.
Description

Enter a description for the tab menu.

Tab Name

This read-only field displays “Tab,” the default name reserved for tabs.

Template Name

This read-only field displays the template name.

5. Click Submit.
Civic Platform confirms you successfully created the tab menu.
6. Click the Tab Items tab.
Civic Platform displays the Tab Items portlet.

| Part 1: Configuring the User View | 103

7. Take the following actions to select tab items for the tab menu:
From the Built-in Tab Items list, select and highlight the tab item you want to add and click the right
Single Arrow

button to move the tab item to the Selected list. To remove all the Built-in Tab Items,

click the right Double Arrow button

.

a. Civic Platform moves the Tab Item to the Selected Tab Items box.

Note:
(1) Although available as built-in tab items, the following items only work as menu items and cannot
display in the detail tabs: Copy, Clone and Assign, including Assign Inspection and Assign Task.
(2) If you select “Application Spec Info” tab item, all the ASI screens display in the detail tabs.
(3) If the Selected list is empty, all built-in tab items display in the detail tabs.

b. If you want to remove a tab item from the Selected list, select the item and click the left Single
Arrow

button. If you want to clear the Selected list, click the left Double Arrow

button.

c.
Use the Up/Down Arrows
to select the order the menu items are to display. These buttons only
effect the order the Selected Menu Items display.
8. Click Submit.

| Part 1: Configuring the User View | 104

Civic Platform confirms you successfully added the tab items to the tab menu.

Setting Tab Item Labels in a Tab Menu
You can specify labels for any tab items in a tab menu. The labels are what users see for the
corresponding tab items in the detail tabs. Without labels, the tab item names represent tab items in the
tabs.
To set tab item labels in a tab menu
1. Access the Menu Navigation portlet (Accessing Menu Navigation).
2. Expand the portlet folder where the tab menu resides.
3. Click the plus (+) sign next to the tab menu folder in which you want to set labels to tab items.
The menu navigation tree expands the tab menu and displays all the tab items in the menu.
4. Select the tab item for which you want to set the label.
Civic Platform displays a Tab Item detail form portlet.

5. Enter the new label in the Tab Item Label field. The label is what users see for the tab item in the detail
tabs.
Note:
You can ignore the Link field in the tab item detail portlet. This field is applicable for navigation menu
items only. See Adding Custom Menu Items for the description of the field.

6. Click Submit.
Civic Platform confirms you successfully added the label to the tab menu.

Deleting a Tab Menu
You can delete tab menus that are not applicable for the portlet. You can remove the tab menu from the
agency, module, or user group folder. After the deletion, all the built-in tabs display in the detail tabs for the
agency, module, or user group.
To delete a tab menu from a template menu
1. Access the Menu Navigation portlet (Accessing Menu Navigation).
2. Navigate to the template menu and find the tab menu you plan to delete. The template menu can reside
in the agency, module, or user group folder, depending on the scope in which the tab menu takes
effect.

| Part 1: Configuring the User View | 105

3. Right-click the tab menu and click Delete.
Civic Platform displays a deletion confirmation window.
4. Click OK.
Civic Platform confirms you successfully deleted the tab menu.

Creating Template Menus for Modules
There are six modules in Civic Platform: building, service request, enforcement, licenses, permits, and
planning. All these modules perform unique tasks in Civic Platform, which requires you to create a template
menu for each module. When you add a template menu to a module you can add, delete, and modify the
menus associated with the module.
This section includes these topics:
•

Adding a Template Menu to a Module

•

Deleting a Template Menu from a Module

Adding a Template Menu to a Module
Creating template menus for specific modules streamlines the different tasks for each department in the
agency. For example, the building department and the enforcement department perform some similar
tasks, but they also have some unique, department-specific tasks. Creating module specific template
menus helps users navigate to tasks that are unique to their department.
To add a template menu to a module
1. Access the Menu Navigation portlet (Accessing Menu Navigation).
2. Expand the portlet folder where you want to add a template menu to a module.
Civic Platform expands the navigation tree to the module’s folder level.

3. To add a template menu, choose one of the following steps:
•

Right-click the module folder and click Add Template.

| Part 1: Configuring the User View | 106

•

Right-click the template menu folder you want to copy and click Copy.

4. To add the template menu, choose one of the following options:
•

Create a Template Menu. For information on how to do this, see Creating a Template Menu.
Civic Platform displays the Menu Template detail form portlet.

•

Click the module folder you want to copy the template menu to and click Paste.
Civic Platform displays the Copy page.

5. To complete the template menu, choose one of the following options:
•

Complete the fields that display. For a list of field descriptions, see Table 5: Template Menu Fields
and click Submit.
Civic Platform confirms the template menu was successful created and added to the module.

•

If the template menu name is the same as the copied template menu, click OK. If you want to
change the name of the template menu you are copying enter a new name in the Name field and
click OK.
Civic Platform copies the template menu to the assigned module.

Deleting a Template Menu from a Module
If a template menu is no longer applicable to a specific module you can delete a template menu from that
module. For example, if a department within the agency has restricted access and all the tasks change
for that department, the template menu no longer applies to that department. It might be easier to delete
the existing template menu and create a new one instead of editing the existing template menu. You must
delete all the template menus sub-items before you can delete the template menu from the module.
To delete a menu from a module
1. Access the Menu Navigation portlet (Accessing Menu Navigation).

| Part 1: Configuring the User View | 107

2. Expand the portlet and module folders where you want to remove the group.

3. Right-click the template menu folder located in the module folder and click Delete.
Civic Platform displays a confirmation window delete the module.

4. Click OK.
Civic Platform confirms you successfully deleted the template menu.

Creating Template Menus for User Groups
Civic Platform assigns users to a user group, which enables you to control the menus and tasks users view
in each module. For example, administrators can create a menu with tasks specific to permits for users in
the permit group. Menus and template menus automatically display in the module assigned to the group
where you assign the menu or template menu.
This section includes these topics:
•

Adding a Template Menu to a Group

•

Deleting a Template Menu from a Group

| Part 1: Configuring the User View | 108

Adding a Template Menu to a Group
Each user performs tasks specific to the user group you assigned them to in Civic Platform. Creating
and adding template menus for specific user groups helps streamline the different tasks for each user in
the department. Not everyone in a user group performs the same tasks. For example, in the permit user
group administrators can create two different menus with tasks specific to a permit processor and a permit
inspector. Creating and adding template menus to user groups helps users navigate to task that are unique
to their job and department.
To add a menu template to a group
1. Access the Menu Navigation portlet (Accessing Menu Navigation).
2. Open the portlet and module folders where you want to add a template menu to a group.

3. Right-click the module folder where you want to add a group and click Add Group.
Civic Platform displays a user group list.

4. Click the user group you want to add to the module and click Submit.
Civic Platform confirms you successfully added the user group to the module.

Deleting a Template Menu from a Group
If a template menu is no longer applicable to a specific user group you can delete a template menu from
that user group. For example, if a user group within the building department has restricted access and all
the tasks change for that user group the template menu no longer applies to that user group. It might be

| Part 1: Configuring the User View | 109

easier to delete the existing template menu and create a new one instead of editing the existing template
menu for that user group. You must delete all the template menu's sub-items before you can delete the
template menu from a user group.
To delete a menu template from a group
1. Access the Menu Navigation portlet (Accessing Menu Navigation).
2. Open the portlet and module folders where you want to remove the group.

3. Right-click the group folder you want to delete the template menu from and click Delete.
Civic Platform displays a confirmation window to delete the group from the template menu.

4. Click OK.
Civic Platform confirms you successfully deleted the template menu.

Creating User Flow Diagrams
You use the My Navigation portlet to define user flow diagrams. Flow diagrams provide users with a visual
representation of the steps they follow to accomplish specific tasks. The icons in the flow diagram link to
the portlets or URLs from where users perform their tasks.

| Part 1: Configuring the User View | 110

To create user flow diagrams
1. Access the My Navigation portlet (Accessing the My Navigation Portlet>).
•

Delete an existing flow diagram.
1. Locate an existing flow diagram by clicking on it in the My Navigation Name column or by
searching for it.
2. Click Delete.

•

Edit an existing flow diagram.
1. Locate an existing flow diagram by clicking on it in the My Navigation Name column or by
searching for it.
2. Complete the flow diagram configuration ().

•

Create a new flow diagram.
1. Click New.
2. Complete the flow diagram configuration ().

2. Complete the flow diagram configuration.
a. Complete the Diagram General tab.
My Navigation Name

Enter the name for the new flow diagram. For example, you might enter “Counter
Clerk” for a diagram to assist counter clerks with a simple workflow process for
issuing a permit.

Description

Enter a description of the flow diagram. For example, you might enter “Counter
Clerk workflow for issuing a new permit.”

Comments

Enter any comments about the flow diagram. The entered comments display at the
bottom of the flow diagram portlet.

| Part 1: Configuring the User View | 111

b. Complete the Flow Nodes tab.
•

Delete a flow node.
1. Select the checkbox next to the flow node(s) you want to delete.
2. Click Delete.

•

Change the order of the flow nodes.
1. Modify the order number(s) next to the flow node(s) you want to reorder.
2. Click Submit.

•

Add a new node.
1. Click the New Node button.
2. Select the link type (portlet or URL) for the new node.
3. Click Submit.

•

Edit an existing node.
1. Click the hypertext link for the node you want to edit.

c. Define new node parameters or edit existing node parameters (Table 8: Flow Nodes Fields).
Table 8: Flow Nodes Fields

Order

Indicates the relative order of the flow node (lowest/top to highest/bottom) in the
overall diagram. Two nodes with the same order number appear on the same line in
the flow diagram.

Portlet

For portlet link type only. The name of the portlet for the flow node.

Icon

For URL link type only. Select the icon you want to use for the flow node from the
Icon drop-down list.

Target

The portlet frame the flow node points to.capForm. Specifies the form portlet
frame.capList. Specifies the list portlet frame.

Text Align

The alignments of the text that displays next to the flow node icon.

Text

The text you want to display for the flow node icon.

Alternative Text

The text you want to display as the alternate text for the icon. The alternate text
displays when the cursor hovers over the icon.

URL

For URL link type. The URL to the portlet for the flow node.

Onclick

Specifies the JavaScript function to run when a user clicks the flow node.doReport().
Runs a report.new(). Creates a new record.

d. Complete the Recipient tab (Setting Up Security Policies).
e. Click Submit.

| Part 1: Configuring the User View | 112

Creating Shared Drop-down Lists
Shared drop-down lists are configurable lists you can apply to different group codes and templates in Civic
Platform. When you define shared drop-down lists, users can access them from drop-down list values in
the specified product area.
Example Use Case
You can create a drop-down list for a People template that indicates a licensed professional’s years of
experience. In other circumstances, you can create a drop-down list for an Application Specific Information
group indicating the number of floors in a building.
You can populate a shared drop-down list by adding values and defining their display order.
When you create a shared drop-down list, you must apply it to a specific product area (see Applying a
Shared Drop-down List).
To create a shared drop-down list
1. Access the Shared Drop-down list portlet (Accessing the Shared Drop-down List Portlet).
2. From the Shared Drop-down List tab, delete, inactivate, edit, or create a shared drop-down list.
•

Delete an existing shared drop-down list.
1. Locate an existing shared drop-down list by clicking on it in the Name column or by searching for
it.
2. Click Delete.

•

Inactivate an existing shared drop-down list.
1. Locate an existing shared drop-down list by clicking on it in the Name column or by searching for
it.
2. Set the Status field to Inactive.
3. Click Save.

•

Edit an existing shared drop-down list.
1. Locate an existing shared drop-down list by clicking on it in the Name column or by searching for
it.
2. Complete the shared drop-down list configuration.

•

Create a new shared drop-down list.
1. Click New.
2. Complete the shared drop-down list configuration.

3. Complete the shared drop-down list configuration.
Name

Enter the name you want to associate with the shared drop-down list.

Status

Use the drop-down list indicate if the drop-down list is active or inactive.

Description

Provide a brief description for the drop-down list.

4. Click Submit or Save.

| Part 1: Configuring the User View | 113

5. From the Values tab, delete a value, change the order of values, add a value, or edit a value.
•

Delete a value.
1. Select the checkbox next to the value(s) you want to delete.
2. Click Delete.

•

Change the order of the values.
1. Modify the order number(s) next to the value(s) you want to reorder.
2. Click Save.

•

Add a new value.
1. Click New.
2. Complete the fields for the new value.
3. Click Submit.

•

Edit an existing node.
1. Click the hypertext link for the value you want to edit.
2. Edit the field value(s).
3. Click Submit.

6. Click the Associations tab to view the shared drop-down list associations.

Applying a Shared Drop-down List
When you create a shared drop-down list, you must apply it to the group or template where you want it
to display. Civic Platform accommodates shared drop-down lists for multiple groups and templates. For
more information on applying shared drop-down lists in available product areas, see Shared Drop-down
List Product Areas.
Table 9: Shared Drop-down List Product Areas

Activity Specific Information
Groups

See Working with Activity-Specific Information Group Codes.

APO Templates

See Applying a Shared Drop-down List.

Application Specific
Information Groups

See Applying a Shared Drop-down List.

Asset Attributes

See Creating an Attribute.

People Templates and Info
Tables

See Applying Shared Drop-down Lists in people templates.

Task Specific Information
Groups

See Applying Shared Drop-down Lists for workflows.

| Part 1: Configuring the User View | 114

Configuring Record Detail Tabs
This section describes how to configure record detail tabs.

Configuring the Related Records Tab
You can configure a related records tab that enables users to build and view hierarchical relationships
between records. These relationships are referred to as parent, child, and sibling relationships in Civic
Platform.
Building relationships between records streamlines communication between different departments in
your agency and enables batch processing – an efficient way for users to execute common processes
on multiple related records. For example, users can create a set of related records that share the same
workflow, and execute a batch process that updates the workflow task status for the entire set.
This section focuses strictly on how to configure related records. For complete details on how to this
feature, including how to designate records as parents and children, and the other practical uses of this
feature, refer to the online help available from the Help menu in Civic Platform.

Setting Related Records FIDs and Standard Choices
To enable this feature you must configure the following FIDs and Standard Choices, according to your
agency’s business objectives. For complete instructions on how to configure FIDs and Standard Choices
refer to the Civic Platform Configuration Reference and the Administrator training modules available in
Accela Success Community – specifically Configuring Related Records, parts 1 - 3.
Related Records FIDs
•

FID 8154 - Application Hierarchy: enables the related records tab

•

FID 8236 - Related CAPs Search: enables the Look Up button

•

FID 8292 - Create Multiple Related CAPs: enables the Clone Mult button

•

FID 8293 - Open New Related CAP in SPEAR: enables the Clone Sgl button

•

FID 8323 - Update Related CAPs: displays an Update Related Records button, enabling users to
update or refresh the list of related records.

•

FID 8395 - CAP Summary: displays record summary information about related records. Works in
conjunction with SC RELATED_CAP_SUMMARY; you must set both.

•

FID 8460 - Delete Related Records: displays a Delete button, enabling users to delete related records.

Related Records Standard Choices
•

RELATED_CAP_CONFIG specifies the fields (including the Application Name field) that display in the
hierarchical view of the related records tab.

•

RELATED_CAP_SUMMARY enables users to display record summary information about related
records. Works in conjunction with FID 8395; you must set both.

•

CAP_CHILD_DOCUMENT enables users to display documents associated with related records.
Related documents only display on the parent record. Child records do not display the documents of the
parent records.

| Part 1: Configuring the User View | 115

Configuring the Application Summary Tab
You can create a customized Application Summary that contains a brief summary of the application, field
information, and links to relevant portlets.
For a complete list of sections you can add to the Record Summary tab, see Table 10: Application
Summary Page Sections.
To configure the summary tab
1. Access the Form Portlet Designer (Accessing the Form Portlet Designer).
2. Select Portlet > Record Summary.

•

Click New and assign the view as described in Designing Forms for Portlets. For example, select the
level you need, such as Agency, and then Click Submit.

3. For each field you want to display on the summary, select the field and Click OK on the Available
Fields page. To manage fields, click Available Fields.
4. Arrange the fields on the form in the same order you want them to appear to users when they complete
the form. For instructions on arranging the form, see Designing Forms for Portlets.
5. Rename any of the field labels, according to your agency’s business objectives, as follows:
a. Double click a field name to access the properties page for the field.
b. Modify the text that displays in the Label field. You cannot change the database label (DB Label).
c. Click OK.
Civic Platform displays the form with your customized field name.
6. To modify the properties of fields that display as sections or lists on the Summary page:

| Part 1: Configuring the User View | 116

a. Double click a section name or list name to access its properties page.
Civic Platform displays the Properties page for the section or list.

b. Click Customize Sub-section. Refer to Designing Forms for Portlets for details on modifying the
properties of sections and lists.
7. To restrict the display of fields based on your agency’s business objectives, you can use Expression
Builder functions. For complete details, refer to Using Expression Builder.
Note, however, that because the Record Summary page is read-only, certain functions are not available
for the Record Summary page. The only functions available for use with the Record Summary page are
the OnLoad expressions.
8. Enter a descriptive Filter Name. The Filter Name is the name you can use later to locate the form if
you need to make additional changes.
9. Click Save.
10.Configure the Application Summary page in the Menu Navigation (Go To) drop-down list so that
agency users can easily navigate to different record tabs. For instructions on how to configure Menu
Navigation, refer to Customizing Menus, Tabs, and Drop-down Lists .
11.Add the Summary tab to the Menu Navigation, so that it displays for users when they open a record.
a. From the Setup portlet, click Agency Profile > Menu Navigation.
b. From the Record Form Portlet, select the Agency > Module > Group > User > and Tab folder for
whom you want the Summary tab to display.
c. Go to the Menu Items tab, add the Summary tab from the Built in Menu Items list on the left, and
then arrange the order using the arrow buttons. See Adding Built-in Menu Items to a Menu.

| Part 1: Configuring the User View | 117

d. Click Submit.
Table 10: Application Summary Page Sections

Application Summary Page Section

Section Description

Adhoc Task Status

This section displays the status of any ad hoc tasks
associated with the application.

Application Comments

This section displays application comments.

Application Detail

Click application detail to view the Record portlet.

Custom Fields

This section displays any Custom Fields your agency has
added for the selected application type.

Application Type

Click application type to view the Record portlet. The
application type displays as the record alias, if present. If a
record alias is not present, the application type displays the
4-level organization path of the record.

Application Status

Click application status to view the Application Status
portlet.

Balance

Click balance amount to view the Payment portlet.

Conditions of Approval

Click a condition name to navigate to the Condition of
Approval portlet.

Condition Status

Click a condition to view the associated Condition Detail
and History portlets.

Contact Info

This section displays the contact detail for application
contacts.

Description of Work

Click description of work in this section to view the Record
portlet.

Documents

This section displays documents associated with the
application. Click a document’s file name to navigate to
Document Information portlet, where you can change a
document’s status and view document details, such as
Document Review Tasks and Document Review History.

File Date

This section displays the date the application was
submitted.

| Part 1: Configuring the User View | 118

Application Summary Page Section

Section Description

Resulted Inspections

This section displays completed inspections associated with
the application. For more information on the Inspections
section, see Configuring the Record Summary Tab
Inspection Section.

Scheduled/Pending Inspections

This section displays scheduled and pending inspections
associated with the application. For more information on the
Inspections section, see Configuring the Record Summary
Tab Inspection Section.

Job Value

Click job value amount to view the Additional Information
Form detail portlet.

Licensed Professional Info

This section displays licensed professionals associated with
the application.
Click the license number of a licensed professional to view
the Professionals detail portlet.

Parcel No

This section displays parcels associated with the
application.
Click a parcel number to view the Parcel detail portlet.

Required Inspections

This section displays inspections public users must
complete for Civic Platform to accept the application.

Structure

This section displays structures associated with the
application.

Total Fee Assessed

This section displays the total amount of fees assessed to
the application.
Click total fee assessed to view the Fee detail portlet.

Total Fee Invoiced

This section displays the total amount of the fees invoiced
to the application.
Click total fee invoiced to view the Payment detail portlet.

Tracking #

This section displays the application tracking number.

Workflow Status

This section displays the workflow tasks associated with the
application, including an Assigned To field.
The current application status displays as a link, which
enables you to view the Workflow Task portlet.

Configuring the Record Summary Tab
Users can view a summary of an application by clicking the Record Summary tab in a record list. The
Record Summary tab displays read-only information; users cannot edit the content that displays.

Configuring the Record Summary Tab Inspection Section
The Inspections section displays pending, scheduled, and resulted inspections associated with the
selected application.
When agency users access the Inspections section, they can review the inspection type, the scheduled
date, the inspector, and the status for any pending, scheduled, or resulted inspection. Agency users can
also click the link for any inspection that displays and view the associated inspection detail.
For a complete list of the fields that display in the Inspections section, see Table 11: Application Summary
Page Inspection Fields.

| Part 1: Configuring the User View | 119

To display the Inspections section, you must first configure the Application Summary page. For instructions
on how to configure the Application Summary page, see Configuring the Application Summary Tab.
You can remove the Inspections section from the Application Summary page using the Form Portlet
Designer. For instructions on removing a display section from the Application Summary page, see
Designing Forms for Portlets.
Table 11: Application Summary Page Inspection Fields

Inspection Date

This field indicates the inspection date, and displays it in the Resulted subsection of
the Inspections section.

Inspection Type

Displays the inspection category, such as electrical, insulation, or building.

Inspector

Displays the name of the inspector scheduled to conduct the inspection.

Resulted

Resulted inspections associated with the selected application display in this
subsection. Inspection results must correspond to the Approved or Denied Result
Type to display in this subsection.

Scheduled Date

This field displays in the Scheduled/Pending subsection and indicates the scheduled
date for the inspection.

Scheduled/Pending

Scheduled or pending (requested) inspections associated with the selected
application display in this subsection.

Status

This field displays in the Scheduled/Pending subsection and the Resulted
subsection.
In the Scheduled/Pending subsection, this field indicates whether a public user has
scheduled or requested an inspection. In the Resulted subsection, this field indicates
the result of an inspection, such as Approved or Denied.

Configuring the Conditions of Approval Tab
Use the Form Portlet Designer to customize what information displays and how it appears on the
Conditions of Approval tab for a record, an inspection, or a record set.
You can also decide which condition of approval fields appear as links in the Sort By area on the
Conditions of Approval tab. By default, the Group, Priority, and Applied Date links are available in the Sort
By area. Clicking a Sort By link sorts the conditions of approval by the corresponding field. Civic Platform
sorts the conditions of approval by group, type, status type, severity, and then priority, if users do not click
any of the links in the Sort By area.
To customize the Conditions of Approval tab
1. Access the Form Portlet Designer (Accessing the Form Portlet Designer).
2. Select one of these options from the Portlet drop-down list:
•

Record Conditions of Approval List (Conditions of Approval tab for a record)

•

Inspection Conditions of Approval List (Conditions of Approval tab for an inspection)

•

Set Conditions of Approval List (Conditions of Approval tab for a record set)

3. Click New and assign the view as described in Designing Forms for Portlets. For example, select the
level you need, such as Agency, and then Click Submit.
Civic Platform displays a layout editor.

| Part 1: Configuring the User View | 120

4. Complete the following fields.
Filter Name

Enter a descriptive name for the filter, so that you can identify it later if you need to
locate it. After you save a form, the Filter Name displays in the Name column.

Description

Enter a descriptive name to help identify the purpose of the form.

Source View Name

The Source View Name is inactive; you cannot modify it.

5. Click the Available Fields button.
Civic Platform displays the Conditions of Approval fields.

6. Double-click the field that you want to display for each condition of approval.
Civic Platform adds the field to the HTML editor as a predefined variable enclosed in the double dollar
signs, for example, $$conditionDescription$$.

| Part 1: Configuring the User View | 121

You can enter the predefined variables for the condition of approval fields into the HTLM editor, as
needed. For a list of the condition of approval fields and the corresponding variables, see Table 12:
Condition of Approval Variables. For a description of the condition of approval fields, see the Civic
Platform Online Help, and search for “Conditions Form Fields.”
7. Use the HTML editor to format the fields, such as changing the font size and color.
8. In the Sort Order area, choose the options (do not choose display order – see note below) you want to
appear as links in the Sort By area of the Conditions of Approval tab.
Note:
Do not select the Display Order field, as Civic Platform does not allow you to sort conditions of approval
by display order.

Civic Platform displays the fields as links on the Conditions of Approval tab.

| Part 1: Configuring the User View | 122

Table 12: Condition of Approval Variables

Field Name

Variable

Action by Dept

$$statusByUser.deptOfUser$$

Action by User

$$statusByUser.fullName$$

Active Status

$$auditStatus$$

Applied Date

$$issuedDate$$

Applied by Dept

$$issuedByUser.deptOfUser$$

Applied by User

$$issuedByUser.fullName$$

Comment

$$conditionComment$$

Condition Name

$$conditionDescription$$

Condition Status Type

$$conditionStatusType$$

Display Order

$$displayOrder$$Note: Do not add the Display Order field or enter this
variable into the HTML editor because the field is not visible on the
Conditions of Approval tab.

Effective Date

$$effectDate$$

Expiration Date

$$expireDate$$

Group

$$conditionGroup$$

Long Comments

$$longComment$$

Priority

$$priority$$

Public Display Message

$$publicDisplayMessage$$

Record ID

$$capID$$

Resolution Action

$$resolutionAction$$

Severity

$$impactCode$$

Status

$$conditionStatus$$

Status Date

$$statusDate$$

Type

$$conditionType$$

| Part 1: Configuring the User View | 123

Defining the Create New Menu
The Civic Platform console provides a Create New button on the toolbar that opens a drop-down menu
of options for creating records or performing other operational tasks. Administrators determine the Create
New button menu options by defining how many items display, which items display, and the order in
which the items display in the Create New Objects administration portlet (Figure 11: Create New Menu
Drop‑Down Menu).

Figure 11: Create New Menu Drop‑Down Menu
To define the Create New menu
1. Access the Setup Portlet (Navigating to the Setup Portlet).
2. Click Agency Profile > Create New Objects.
Civic Platform displays the Create New Objects administration portlet.

a. In the Display column, select the option to indicate if an object displays in the Create New dropdown menu.
Choose Yes to include the object in the drop-down menu.
Choose No to hide the object as an option in the drop-down menu.
b. Enter a number in the Display Order column for each object you want to display in the drop-down
menu. This number indicates the object position from top to bottom. The number 1 indicates the first
position in the menu.
c. Click Submit.

| Part 1: Configuring the User View | 124

Customizing Go To Menus
You can group the record detail tabs into a drop-down menu called a Go To menu. The Go To menu
provides a way to quickly navigate the record detail tabs.
To access the Go To menu
1. Locate a form portlet that contains a customized Go To menu.
Civic Platform displays the customized Go To menu tab.

2. Click Go To and choose the appropriate option from the drop-down list.
The menu items in the drop-down list are the same as the record detail tabs listed across the portlet.
System administrators can define whether users have access to the Go To menu, record detail tabs, or
both.
Civic Platform displays the detail portlet for the selected tab.

| Part 1: Configuring the User View | 125

Creating Custom Portlets
You can configure custom link portlets that provide users with links to both external websites and to
internal Civic Platform portlets.
Click a topic title below for full details.
Related Information
Working with Link Portlets
Working with the Portlets Portlet

Working with Link Portlets
Civic Platform provides 23 custom link portlets (three FAQ portlets and 20 Quicklinks portlets).

Figure 12: Sample Custom Link Portlet
To enable this functionality, first create the custom link portlet, then give users access to it by adding a
main link to it (Setting Up Your Console and Home Page) on the console page.
To delete, edit, or create a link portlet
1. Access the Link Portlets portlet (Accessing the Link Portlets Portlet).
2. Create, edit, or delete a link portlet, as follows.
a. To create a new link portlet:
a. Click New.
b. Complete the fields in the Portlet tab.

a. To delete an existing link portlet:
Note:
Removing a link portlet removes it from any primary tabs of Civic Platform that currently display the
portlet. It also removes all links within the portlet.

a. Locate an existing list portlet by clicking on it in the Name column or by searching for it.

| Part 1: Configuring the User View | 126

b. Select the checkbox for the item to delete.
c. Click Delete.
b. To edit an existing list portlet:
a. Locate the portlet you want to edit.
b. Complete the fields in the Portlet tab ().
3. Enter information in the following fields:
Portlet System Name

The name of the link portlet.

Name

The name to display for the link portlet. By default, Civic Platform sets this to the
Portlet System Name.

Description

The description of the portlet.

4. From the Links tab, delete a link, add a link, or edit a link.
•

Delete a link.
1. Select the checkbox next to the link(s) you want to delete.
2. Click Delete.

•

Edit an existing link.
1. Click the hypertext link for the link you want to edit.
2. Edit the field value(s).
3. Click Submit.

•

Add a new link.
1. Click New.
2. Select the link type.
3. Click Submit.
4. Complete the fields by entering the name of the link you want to display and the target
destination of the link (either a URL or portlet specification).

5. Click Submit.

Working with the Portlets Portlet
You use the Portlets portlet to specify which portlets you can add a link to from a link portlet.
To work with the Portlets portlet
1. Access the Portlets portlet (Accessing the Portlets Portlet).
2. Do any of the following:

| Part 1: Configuring the User View | 127

•

Create a portlet.
1. Click New.
2. Complete the fields (see Table 13: Portlet Details).
a. For the Portlet URL field, right-click anywhere in the portlet, and choose Properties.
The URL of the portlet displays in the Address (URL) field of the Properties window.
b. Enter the portlet URL in either of the following two formats:
The complete URL. For example, https://sample.accela.com:32443/portlets/reports/
adHocReport.do?
The shortcut URL which omits the server address. For example: /portlets/reports/
adHocReport.do?
3. Click Submit.

•

Edit an existing portlet.
1. Click the link to the portlet you want to update.
2. Update the fields (see Table 13: Portlet Details).
a. For the Portlet URL field, right-click anywhere in the portlet, and choose Properties.
The URL of the portlet displays in the Address (URL) field of the Properties window.
b. Enter the portlet URL in either of the following two formats:
The complete URL. For example, https://sample.accela.com:32443/portlets/reports/
adHocReport.do?
The shortcut URL which omits the server address. For example: /portlets/reports/
adHocReport.do?
3. Click Submit.

•

Delete a portlet.
1. Select the checkbox next to the portlet(s) you want to delete.
2. Click Delete.
Table 13: Portlet Details

FID

The Function Identification (FID) that Civic Platform uses to control access to the
portlet. The FID setting controls access to the portlet and visibility of the link to the
portlet.
For example, if you are adding the Parcels portlet, you can enter 0005 in the field
(FID 0005 controls the accessibility of the Parcels portlet). In a link portlet which
contains the link to the Parcels portlet, the link is only visible to the users who
have access permission to the Parcels portlet. For more information about portlet
FIDs, see the Accela Civic Platform Configuration Reference.

Portlet Description

The description for the portlet. You can enter the name of the portlet and any
other defining characteristics.

Portlet Icon

The icon to display for the portlet if you add the portlet to a flow diagram in the My
Navigation portlet. The icon does not display for the portlet.

Portlet Page ID

NA. The field is no longer used.

Portlet URL

The URL for the portlet.

| Part 1: Configuring the User View | 128

Filtering the Display of Data
Filters and queries enable users to find information easily and efficiently. You can configure filters and
queries to display only the data that is relevant to the user in the context of their current business objective
or use-case scenario.
Click a topic title below for full details.
Related Information
Creating a Data Filter
Assigning a Data Filter
Removing a Data Filter Assignment
Data Filter Enabled Portlets
Managing Global QuickQueries
Managing User Defined QuickQueries
QuickQuery Enabled Portlets

Creating a Data Filter
When you create a data filter, you specify the list that contains the fields you want to filter, the values for
each field, and the users who have access to the filter.
To create a data filter
1. Access the Data Filter portlet (Accessing the Data Filter Portlet).
2. Select the portlet to which you want to apply the data filter.
3. Click Submit.
Civic Platform displays a list of the filters defined for that portlet.
4. Click New to create a new filter.
Civic Platform displays a blank form.

5. Enter a name and description to help you identify the purpose of the data filter.
6. In the Search By section, do the following:
a. Use the first drop-down to select the Field you want to filter.

| Part 1: Configuring the User View | 129

Note:
The portlet you select at the beginning of this procedure determines which filter fields are available in
this drop-down:
•

The filter fields for the Record List portlet include all the fields that display in the record search
form, any custom fields, Address/Parcel/Owner (APO) template fields*, and module.
*Please note that only record-searchable APO template attributes are available.

•

The filter fields for the Reference Address (Parcel, or Owner) portlet include the address (parcel,
or owner) fields, and APO template fields.

•

The filter fields for other portlets are the fields that display in the search form for each portlet.

•

If you select Custom Fields as the filter field in the drop-down, Civic Platform displays the Custom
Fields groups page. Select a Custom Fields group code, and then find and click the desired field
in the navigation tree to specify the field you want to filter.

•

If you select Address Template, Parcel Template, or Owner Template as the filter field in the
drop-down, Civic Platform displays all the active template attributes. Click the desired attribute to
specify the field you want to filter.

b. Use the second drop-down to select the Relational Operator you want to use. See Relational
Operators.
c. In the third field enter the Value you want to compare the field against. The value must match
a value in your agency’s database. You can click the button to the right of the field and select a
variable from the Variable picker, or enter the variable into the field manually.

| Part 1: Configuring the User View | 130

See Data Filter Parameters.

•

If you select a user name field such as Requestor, Civic Platform displays three fields where you
can specify the first, middle, and last name of a person. See User Name List Portlets and Search
Fields.

However, if you pick a variable as the search criteria, Civic Platform turns the three fields into a
read-only Full Name field and populates the field with the specified variable.
d. If you are filtering additional fields, enter the logical operator in the fourth field to determine how
you want to combine the field-level filters. See Logical Operators.
7. If you are filtering more than one new field:
a. Click the New Field button located at the top of the portlet.
Civic Platform adds a condition to the Search By section for the additional field.
b. Repeat for every new field.
8. To delete a field from your query, select the field and click Delete Field.
9. Click the Preview SQL button to view the SQL in the Resulting Query text field.
10.Click Submit.
Civic Platform displays a message informing you whether you created the data filter successfully, and
updates the data filter list.
Table 14: Relational Operators

Operator

Description

!=

Not equal to

<

Less than

<=

Less than or equal to

=

Equal to

>

Greater than

>=

Greater than or equal to

| Part 1: Configuring the User View | 131

Operator

Description

IS NOT NULL

Used to query fields that contain any value, regardless of what that value is.
When you use this operator, do not use a variable in the third field.

IS NULL

Used to query fields that do not have a value. For example, you might set up a data filter to
query for records associated with a certain department, but not to any individual within the
department.
When you use this operator, do not use a variable in the third field.

Like

The alphabetic character field values that you want to include in the filter or query contain a
string (alphabetic characters).
For example, if you want to set up a query to list all contacts with the string “Jeff” in their
email addresses, choose “Like” as the relational operator and enter “Jeff” as the value.

Table 15: User Name List Portlets and Search Fields

List Portlet

“Search By” Field

AMS Asset CA List

Inspector

AMS PM Schedule Log List

Processed By Staff

Inspection Conditions of Approval List

• Action by User
• Applied by User

Inspection List

• Inspection Contact Name
• Inspector
• Requestor

My Workflow Task List

• Action By (Staff)
• Assigned to Staff

Record Conditions of Approval List

• Action by User
• Applied by User

Record Inspection List

• Inspection Contact Name
• Requestor

Set Conditions of Approval List

• Action by User
• Applied by User

Table 16: Data Filter Parameters

Variable

Name

Description

$$DEPARTMENT$$

Department

The department to which the current user belongs.

$$GAUSER ID$$

User ID

The logged in user’s ID.

$$USERFULLNAME$$

User Full Name

The logged in user’s full name.

$$GROUP$$

Group

The logged in user’s user group.

$$MODULE$$

Module

The name of the module for which the alert you created
the alert.

$$ORGANIZATION$$

Organization

All organizations. A Citizen Access term.

$$OWNORGANIZATION$$

Own Organization

The logged in citizen user’s organizations. A Citizen
Access term.

$$OWNLICENSE$$

Own License

The logged in citizen user’s licenses. A Citizen Access
term.

$$PUBLICUSER_EMAIL$$

Public User’s Email

The logged in citizen user’s email. A Citizen Access term.

$$SERV_PROV_CODE$$

Service Provider
Code

The logged in user’s agency code

| Part 1: Configuring the User View | 132

Variable

Name

Description

$$TODAY+/-#$$

Today

Today’s date, based on the workstation's system clock.
You can use this variable parameter in calculations to
specify a date range. For example, you could enter $
$Today-7$$to query for all records over the last week.

$$TODAY+n$$

Today +n

Date range beginning with today’s date. For example, you
could enter $$Today-7$$to query for all records over the
last week.

$$USERID$$

User ID

The ID of the user currently logged on to Civic Platform.

Table 17: Logical Operators

Operator

Description

And

Use this logical boolean operator to display values included only in multiple fields (results in a
smaller list of matches).

Or

Use this logical boolean operator to display values included in one field or another (results in a
larger list of matches).

Editing a Data Filter
This section describes how to edit the data filter information that displays on the Data Filter tab.
To edit a data filter
1. Access the Data Filter portlet (Accessing the Data Filter Portlet).
2. Select the view with the data filter you want to modify.
3. Click Submit.
Civic Platform displays a list of the filters defined for the selected view.

4. In the Name column, click the link of the filter you want to edit.
Civic Platform displays the filter details in the record tab.

| Part 1: Configuring the User View | 133

5. Modify the following fields if you want:
Name

Enter a brief name to identify the data filter.

Description

Enter a description to help you identify the purpose of the data filter.

6. Review and edit the Search By section:
a. To delete a field from your query, select the field and click Delete Field.
b. If you want to modify the filter condition for a field, find the target field, select the new Relational
Operator you want to use for the field, and enter the new Value that you want to compare the field
against.
c. If you want to add a new field, enter the Logical Operator in the last field to determine how you want
to combine the field-level filters, click the New Fieldbutton, and perform the following:
a. Use the first drop-down to select the Field you want to filter,
b. Use the second drop-down to select the Relational Operator you want to use.
c. In the third field enter the Value that you want to compare the field against. The value must match
a value in your agency’s database. You can click the button to the right of the field and select a
variable from the Variable picker, or enter the variable into the field manually.
d. Repeat the preceding step for every new field.
7. Click the Preview SQLbutton to view the SQL in the Resulting Query text field.
8. Click Submit.
Civic Platform displays a message informing you whether you updated the data filter successfully.

Deleting a Data Filter
This section describes how to remove a data filter from Civic Platform.
To remove a data filter
1. Access the Data Filter portlet (Accessing the Data Filter Portlet).
2. Select the view with the data filter you want to delete.
3. Click Submit.
Civic Platform displays a list of the filters defined for the selected view.

4. Select each data filter you want to delete.
5. Click Delete.
Civic Platform updates the data filter list for the selected view.

| Part 1: Configuring the User View | 134

Assigning a Data Filter
You can assign data filters to individual users as well as entire user groups to limit what field values they
can see in their list views.
By default, Civic Platform applies the primary filter which you specify to any portlet. If you defined multiple
filters for a portlet, authorized users can choose which filter to apply to the view. Only one filter can apply to
a portlet at any given time. If you do not give a user the option to choose from a list of available data filters
for a portlet, Civic Platform automatically applies the primary data filter you have defined for that portlet and
assigned to that user.
To assign a data filter
1. Access the Data Filter portlet (Accessing the Data Filter Portlet).
2. Select the portlet with the data filter you want to modify.
3. Click Submit.
Civic Platform displays a list of the filters defined for the selected portlet.
4. In the Name column, click the link of the filter you want to assign (click Search if you do not see the
filter you want).
5. Click the Recipients tab.
Civic Platform displays the users and user groups you assigned the filter to.

6. Click Assign Module, Assign Group, or Assign User to assign recipients to the filter.
7. If you want the data filter to be the primary data filter for the selected user group or user, do the
following:
a. Click the Recipient Key link next to the user group or user you want to make the primary.
Civic Platform displays the Primary information.

b. Select the Primary option.
c. Click Submit.

Removing a Data Filter Assignment
This section describes how to remove a data filter from a user or user group. If a user or group has had a
particular data filter assigned to limit their access to information, you can remove that filter if it no longer
applies.

| Part 1: Configuring the User View | 135

To remove a data filter assignment
1. Access the Data Filter portlet (Accessing the Data Filter Portlet).
2. Select the portlet with the data filter you want to modify.
3. Click Submit.
Civic Platform displays a list of the filters defined for the selected portlet.
4. In the Name column, click the link to the filter with the recipient you want to remove (click Search if you
do not see the filter you want).
5. Click the Recipients tab.
Civic Platform displays a list of recipients.
6. Select each recipient you want to remove from the list.
7. Click Delete.
Civic Platform displays a confirmation message and updates the recipient list.

Data Filter Enabled Portlets
This list details the administration portlets where you can set up and use data filters.
•

AMS Asset Attribute Table List: The Attribute Table list portlet.

•

AMS Asset Template List: The Attribute Template list portlet.

•

AMS Asset Type List: The Asset Type list portlet.

•

AMS Attribute List: The Attribute list portlet.

•

AMS Condition Assessment List: The Condition Assessment administration list portlet.

•

AMS Cost Group List: The Cost Group list portlet.

•

AMS Cost Item List: The Cost Item list portlet.

•

AMS Part Contact List: The Part Contact list portlet.

•

AMS Part Location List: The Part Location list portlet.

•

AMS RefRating List: The Rating Type list portlet.

•

AMS WO Task Definition List: The Work Order Task list portlet.

•

AMS Work Order Template List: The Work Order Template list portlet.

•

StructEstabl Type List: The Structure & Establishment Types portlet.

This list details the daily user portlets where you can set up and use data filters:
•

Citizen Access Record List: The record list in Citizen Access.

•

AMS Asset CA List: The Asset Condition Assessment list portlet.

| Part 1: Configuring the User View | 136

•

AMS Asset Data List: The Assets list portlet.

•

AMS Asset Work Order List: The Work Order tab in the Assets portlet.

•

AMS Part Inventory List: The Part Inventory list portlet.

•

AMS Part Transaction List: The Part Transaction tab in the Part Inventory portlet.

•

AMS PM Schedule List: The PM Schedules list portlet.

•

AMS Work Order Asset List: The Assets tab in the Work Orders portlet.

•

Batch Invoice List: The Invoices list portlet.

•

Batch Job List: The Batch Jobs list portlet.

•

Contact Record List: The Record List tab in the Contacts portlet.

•

Global Search Record List: The Record List tab in the Global Search portlet.

•

Inspection List: The Inspections list portlet, and the Inspections tab in the My Tasks portlet.

•

My Document Task List: The Document Review Tasks tab in the My Tasks portlet.

•

My Workflow Task List: The Workflow Tasks tab in the My Tasks portlet.

•

Point of Sale Transaction List: The Point of Sale list portlet.

•

Record List: The Record list portlet.

•

Record Set Member List: The Set Members tab in the Set: Records portlet.

•

Record Status History List: The Application History tab in the Record portlet.

•

Reference Address List: The Addresses list portlet.

•

Reference Contact List: The Contacts list portlet.

•

Reference Owner List: The Owners list portlet.

•

Reference Parcel List: The Parcels list portlet.

•

Reference Professional List: The Professionals list portlet.

•

Reference StructEstabl List: The Structures & Establishments list portlet.

•

Related Record List: The Related Records tab in the Record portlet.

•

Trust Account List: The Trust Account list portlet.

QuickQueries
A QuickQuery is a search predefined by an administrator that helps users to quickly access a list of
items. For example, you can set up a QuickQuery that refines a list of records to show only those records
assigned to a certain department. A QuickQuery does not display fields or values a data filter excludes. For
more information about data filters, see Filtering the Display of Data.

| Part 1: Configuring the User View | 137

You can filter data for any field name in a list portlet. You must designate the modules, groups, or users
that can access each Global QuickQuery you create. Global QuickQueries not assigned to the user do not
appear in the user’s My QuickQueries drop-down list in the list portlet. If you set up multiple queries for a
portlet, users can add any of those queries to their My QuickQueries drop-down list, and specify one of
them as a default QuickQuery.
Multiple daily users can assign a QuickQuery the same name. Civic Platform differentiates these
QuickQueries by the user’s login name. For example, John Q. Smith and Ann Jensen can both create a
query called “Projects Due Today.” A user or administrator who wants to create two QuickQueries with
the same name on the same login account must differentiate the two. For example, “Opened Today with
Balance (Global)” and “Opened Today with Balance (My QQ).”

Managing Global QuickQueries
Global QuickQueries are QuickQueries you define for your Civic Platform users. Civic Platform gives you
the flexibility to assign QuickQueries to every user in the agency, make them available to a specific group
only, or even limit them to an individual user. If needed, you can edit, delete, and un-assign QuickQueries
previously assigned.
Topics
•

Creating a Global QuickQuery

•

Editing a Global QuickQuery

•

Deleting a Global QuickQuery

•

Assigning a QuickQuery

•

Removing a QuickQuery

Creating a Global QuickQuery
For each portlet list, you can create any number of QuickQueries. For example, in the Building portlet, you
might want to sort the records by the Record ID and the street name.
You also have the option to designate one of the Global QuickQueries as the primary QuickQuery within
each portlet. You can only assign one primary Global QuickQuery at a time. If the daily user assigns a user
defined QuickQuery as primary, Civic Platform overrides the primary Global QuickQuery with the user’s
choice.
To create a QuickQuery
1. Access the Global QuickQueries portlet (Accessing the Global QuickQueries Portlet).
2. From the portlet drop-down list, choose the portlet for which you want to create a query.
3. Click Submit.
Civic Platform displays a list of the queries defined for that view.

| Part 1: Configuring the User View | 138

4. Click New.
Civic Platform displays a blank form in the secondary tab.

5. Complete these fields:
Name

Enter a brief name to identify the QuickQuery.

Description

Enter a description to help you identify the purpose of the QuickQuery.

6. In the Search By section:
a. Use the first drop-down to select the Field you want to filter.
Note:
The portlet you select sets the filter fields available in this drop-down:

•

•

The filter fields for Record List portlet include all the record fields that display in the record search
form, Application-Specific Info, Address Template, Owner Template, Parcel Template, and
Module Name.

•

The filter fields for the Reference Address (Parcel, or Owner) Portlet include the address (parcel,
or owner) fields, and Address Template (Parcel Template, or Owner Template).

•

The filter fields for other portlets are the fields that display in the search form of each portlet.

If you select Application-Specific Info (ASI) as the filter field in the drop-down, Civic Platform
displays all the ASI groups.

| Part 1: Configuring the User View | 139

Select an ASI group code, and then find and click the desired ASI field in the ASI Field
navigation tree to specify the field you want to filter.
•

If you select Address Template, Parcel Template, or Owner Template as the filter field in the
drop-down, Civic Platform displays all the active template attributes. Click the desired attribute to
specify the field you want to filter.

b. Use the second drop-down to select the Relational Operator you want to use. See Table 18:
Relational Operators.
c. In the third field, enter the Value that you want to compare the field against. The value must match
a value in your agency’s database. You can click the button to the right of the field and select a
variable from the Variable picker, or enter the variable into the field manually.
See Table 19: QuickQuery Parameters

| Part 1: Configuring the User View | 140

•

If you select a user name field such as Requestor, Civic Platform displays three fields where you
can specify the first, middle, and last name of a person. See Table 15: User Name List Portlets
and Search Fields.

However, if you pick a variable as the search criteria, Civic Platform turns the three fields into a
read-only Full Name field and populates the field with the specified variable.
d. If you are filtering additional fields, enter the Logical Operator in the fourth field to determine how
you want to combine the field-level filters. See Table 20: Logical Operators.
7. If you are querying more than one field:
a. Click the New Field button located at the top of the portlet.
Civic Platform adds a condition to the Search By section for the additional field.

b. Repeat for each new field.
8. To delete a field from your query, select the field and click Delete Field.
9. Click the Preview SQL button to view the SQL in the Resulting Query text field.

| Part 1: Configuring the User View | 141

10.Click Submit.
Civic Platform informs you if you created the QuickQuery successfully and updates the Global
QuickQueries list.
11.To set the QuickQuery as the primary QuickQuery for the portlet:
a. Click the Recipient tab.
Civic Platform displays a list of Recipients.

b. Click the Recipient Key link.
Civic Platform displays the Recipient Key list.

c. Select the Primary option.
d. Click Submit.
Table 18: Relational Operators

Operator

Description

!=

Not equal to

<

Less than

<=

Less than or equal to

=

Equal to

>

Greater than

>=

Greater than or equal to

| Part 1: Configuring the User View | 142

Operator

Description

IS NOT NULL

Used to query fields that contain any value, regardless of what that value is.
When you use this operator, do not use a variable in the third field.

IS NULL

Used to query fields that do not have a value. For example, you might set up a data filter
to query for records assigned to a certain department, but not to any individual within the
department.
When you use this operator, do not use a variable in the third field.

Like

The field values that you want to include in the filter or query contain a string of alphabetic
characters. For example, if you want to set up a query to list all contacts with the string “Jeff” in
their email addresses, choose “Like” as the relational operator and enter “Jeff” as the value.

Table 19: QuickQuery Parameters

Variable

Name

Description

$$DEPARTMENT$$

Department

The department to which the current user belongs.

$$GAUSER ID$$

User ID

The logged in user’s ID.

$$GROUP$$

Group

The logged in user’s user group.

$$MODULE$$

Module

The name of the module for which you created the alert.

$$ORGANIZATION$$

Organization

All organizations. A Citizen Access term.

$$OWNORGANIZATION$$

Own Organization

The logged in citizen user’s organizations. A Citizen
Access term.

$$OWNLICENSE$$

Own License

The logged in citizen user’s licenses. A Citizen Access
term.

$$PUBLICUSER_EMAIL$$

Public User’s Email

The logged in citizen user’s email. A Citizen Access term.

$$SERV_PROV_CODE$$

Service Provider
Code

The logged in user’s agency code

$$TODAY+/-#$$

Today

Today’s date, based on the workstation’s system clock.
You can use this variable parameter in calculations to
specify a date range. For example, you could enter $
$Today-7$$to query for all records over the last week.

$$USERID$$

User ID

The ID of the user currently logged on to Civic Platform.

Table 20: Logical Operators

Operator

Description

And

Use this logical (boolean) operator to display values included only in multiple fields (produces a
smaller list of matches).

Or

Use the logical (boolean) operator to display values included in either one or other of the fields
(produces a larger list of matches).

Editing a Global QuickQuery
This section describes how to edit information associated with a QuickQuery, including how to designate a
QuickQuery as the primary QuickQuery for the portlet.
To edit a QuickQuery
1. Access the Global QuickQueries portlet (Accessing the Global QuickQueries Portlet).
2. From the Portlet drop-down list, choose the portlet for which you want to edit a query.

| Part 1: Configuring the User View | 143

3. Click Submit.
Civic Platform displays a list of the queries defined for that view.
4. From the list of queries, click the link in the Name column of the query you want to edit.
Civic Platform displays the query details in the secondary portlet.
5. Modify these fields if you want:
Name

Enter a brief name to identify the QuickQuery.

Description

Enter a description to help you identify the purpose of the QuickQuery.

6. Review and edit the Search By section:
a. To delete a field from your query, select the field and click Delete Field.
b. If you want to modify the filter condition for a field, find the target field, select the new Relational
Operator you want to use for the field, and enter the new Value that you want to compare the field
against.
c. If you want to add a new field, enter the Logical Operator in the last field to determine how you want
to combine the field-level filters, click the New Field button, and perform the following:
a. Use the first drop-down to select the Field you want to filter,
b. Use the second drop-down to select the Relational Operator you want to use.
c. In the third field, enter the Value that you want to compare the field against. The value must
match a value in your agency’s database. You can click the button to the right of the field and
select a variable from the Variable picker, or enter the variable into the field manually.
d. Repeat the preceding step for every new field.
For more information on adding new fields in Search By, see Creating a Global QuickQuery.
7. If you are querying more than one field, click the New Field button located at the top of the portlet.
Civic Platform adds a condition to the Search By section for the additional field.
8. Repeat for each new field.
To delete a field from your query, select the field and click Delete Field.
9. Click the Preview SQL button to view the SQL in the Resulting Query text field.
10.Click Submit.
Civic Platform updates the Global QuickQueries list.
11.To set the QuickQuery as the primary QuickQuery for the portlet:
a. Click the Recipient tab.
Civic Platform displays a list of Recipients.

b. Click the Recipient Key link.

| Part 1: Configuring the User View | 144

Civic Platform displays the Recipient Key list.

c. Select the Primary option.
d. Click Submit.

Deleting a Global QuickQuery
This section describes how to remove a QuickQuery from your system.
To delete a QuickQuery
1. Access the Global QuickQueries portlet (Accessing the Global QuickQueries Portlet).
2. Select the portlet with the query you want to delete.
3. Click Submit.
Civic Platform displays a list of the queries defined for that portlet.
4. From the list of queries, select each query you want to delete.
5. Click Delete.
Civic Platform updates the Global QuickQueries list.

Assigning a QuickQuery
You can assign QuickQueries to individual users, to entire groups, or to modules in the Recipient tab of the
Global QuickQueries portlet (Navigating to the Setup Portlet). After you assign a query to a user or group,
those users can see the query in their My QuickQuery drop-down list in the toolbar for the applicable list
portlet. If you created multiple queries for that portlet, the user can select a primary QuickQuery to apply to
the portlet.
For more information, see Setting Up Security Policies.

Removing a QuickQuery
This section describes how to remove a QuickQuery from a user or user group.
To remove a QuickQuery from a user or user group
1. Access the Global QuickQueries portlet (Accessing the Global QuickQueries Portlet).
2. Select the portlet with the QuickQuery you want to modify.
3. Click Submit.
Civic Platform displays a list of the QuickQueries defined for the selected portlet.
4. In the Name column, click the link to the QuickQuery with the recipient you want to remove.
If you do not see the QuickQuery you want, click Search.
Civic Platform displays the QuickQuery details in the secondary portlet.
5. Click the Recipients tab.
Civic Platform displays a list of recipients.

| Part 1: Configuring the User View | 145

6. Select each recipient you want to remove from the list.
7. Click Delete.
Civic Platform displays a confirmation message and updates recipient list.

Managing User Defined QuickQueries
If you allow your agency Civic Platform users to create their own personal QuickQueries, known as My
QuickQueries, you can manage them through the Administration portlet. You can search for user defined
QuickQueries, edit them (if permitted), and delete them as needed.
Multiple daily users can assign a QuickQuery the same name. Civic Platform differentiates these
QuickQueries by the user’s login name. For example, John Q. Smith and Ann Jensen can both create a
query called “Projects Due Today.” A user or administrator who wants to create two QuickQueries with
the same name on the same login account must differentiate the two. For example, “Opened Today with
Balance (Global)” and “Opened Today with Balance (My QQ).”
For more information about defining user QuickQueries, see “Understanding QuickQueries” in the Accela
Civic Platform User Guide.
Topics
•

Searching for User Defined QuickQueries

•

Editing User Defined QuickQueries

•

Deleting User Defined QuickQueries

Searching for User Defined QuickQueries
Depending on the size of your agency, you might have hundreds of user defined QuickQueries that agency
users create. Civic Platform enables you to search for QuickQueries created by users so you can manage
them as needed.
To search for user defined QuickQueries
1. Access the My QuickQueries portlet (Accessing the My QuickQueries Portlet).
2. Select the view for which you are creating the query.
3. Click Submit.
Civic Platform displays a list of the queries defined for that view.

| Part 1: Configuring the User View | 146

4. Click Search.
Civic Platform displays a search form.
5. Complete any fields that display to search for a QuickQuery.
6. Click Submit.
Civic Platform displays a list of queries that match your search criteria.

Editing User Defined QuickQueries
Civic Platform enables you to edit QuickQueries created by users so you can manage them as needed.
To edit user defined QuickQueries
1. Access the My QuickQueries portlet (Accessing the My QuickQueries Portlet).
2. Select Record List from the Portlet drop-down list, then click Submit.
Civic Platform displays the list of User Created QuickQueires.
3. Locate and select the QuickQuery you want to modify.
Civic Platform displays the Query with all fields editable.

| Part 1: Configuring the User View | 147

4. Modify any of the fields as necessary
5. Click Submit.

Deleting User Defined QuickQueries
You can delete user defined QuickQueries as needed. You might need to delete a user defined
QuickQuery, for example, if an employee changes departments and you no longer want them to have
access to data they for which they created a QuickQuery. You might also want to delete QuickQueries for
employees who are no longer at your agency, to help keep unnecessary data out of your database.
To delete user defined QuickQueries
1. Access the My QuickQueries portlet (Accessing the My QuickQueries Portlet).
2. Select the view for which you are creating the query.
3. Click Submit.
Civic Platform displays a list of the queries defined for that view.
4. From the list of queries, select each query you want to delete.
If you do not see the QuickQuery you want, you can search for it by clicking the Search button located
in the toolbar.
5. Click Delete.
Civic Platform updates the Global QuickQueries list.

QuickQuery Enabled Portlets
This list details the administration portlets where you can set up and use global or user-defined
quickqueries.
•

AMS Asset Attribute Table List: The Attribute Table list portlet.

•

AMS Asset Template List: The Attribute Template list portlet.

•

AMS Asset Type List: The Asset Type list portlet.

•

AMS Attribute List: The Attribute list portlet.

•

AMS Condition Assessment List: The Condition Assessment administration list portlet.

•

AMS Cost Group List: The Cost Group list portlet.

•

AMS Cost Item List: The Cost Item list portlet.

•

AMS Part Contact List: The Part Contact list portlet.

•

AMS Part Location List: The Part Location list portlet.

•

AMS RefRating List: The Rating Type list portlet.

•

AMS WO Task Definition List: The Work Order Task list portlet.

•

AMS Work Order Template List: The Work Order Template list portlet.

| Part 1: Configuring the User View | 148

•

StructEstabl Type List: The Structure & Establishment Types portlet.

This list details the daily user portlets where you can set up and use global or user-defined
quickqueries.
•

ACA My Permit List: The My Permit List on the record home page in Citizen Access.

•

Citizen Access Record List: The record list in Citizen Access.

•

AMS Asset CA List: The Asset Condition Assessment list portlet.

•

AMS Asset Data List: The Assets list portlet.

•

AMS Asset Work Order List: The Work Order tab in the Assets portlet.

•

AMS Part Inventory List: The Part Inventory list portlet.

•

AMS Part Transaction List: The Part Transaction tab in the Part Inventory portlet.

•

AMS PM Schedule List: The PM Schedules list portlet.

•

AMS Work Order Asset List: The Assets tab in the Work Orders portlet.

•

Batch Invoice List: The Invoices list portlet.

•

Batch Job List: The Batch Jobs list portlet.

•

Contact Record List: The Record List tab in the Contacts portlet.

•

Fees List - The Payment tab in the Payment Processing portlet.

•

Inspection List: The Inspections list portlet, and the Inspections tab in the My Tasks portlet.

•

My Document Task List: The Document Review Tasks tab in the My Tasks portlet.

•

My Workflow Task List: The Workflow Tasks tab in the My Tasks portlet.

•

Point of Sale Transaction List: The Point of Sale list portlet.

•

Record List: The Record list portlet.

•

Record Set Member List: The Set Members tab in the Set: Records portlet.

•

Record Status History List: The Application History tab in the Record portlet.

•

Reference Address List: The Addresses list portlet.

•

Reference Contact List: The Contacts list portlet.

•

Reference Owner List: The Owners list portlet.

•

Reference Parcel List: The Parcels list portlet.

•

Reference Professional List: The Professionals list portlet.

•

Reference StructEstabl List: The Structures & Establishments list portlet.

•

Related Record List: The Related Records tab in the Record portlet.

•

Trust Account List: The Trust Account list portlet.

| Part 1: Configuring the User View | 149

Designing Forms for Portlets
Form Portlet Designer enables you to customize the forms in your Civic Platform system. “Forms” are
where agency users enter data, and where Civic Platform collects all of the data that it stores in the backend database. You can design forms for use at the agency, module, user group, and individual user
levels, depending on your agency’s information-gathering requirements. Form layout designs and field
characteristics apply to all sub-levels.
Click a topic title below for full details.
Related Information
Working with Forms
Working with Lists
Working with Customized Views
Creating Dynamic Text Labels

Working with Forms
Topics
•

Creating a Form

•

Customizing a Form

•

Setting Default Values for Fields in a Search Form

•

Using the Edit View Feature

Creating a Form
This section describes how to create a form using the Form Portlet Designer. To create a form, you select
the portlet and then determine what organizational level you want to apply to the form. After determining
the portlet and the organization levels, choose which fields to make available. Each field has unique
attributes you can specify; for full details see Customizing a Form.
To create a form
1. Access the Form Portlet Designer (Accessing the Form Portlet Designer).
2. Identify which users you are granting access to your new form. Click the tab that corresponds with the
access-level you are creating for the form: Agency, Module, Group, or User tab.
Best practice is to design a form on the Agency tab and then restrict access based on any other user
access: Module, User Group, and User.
If you choose the User tab you can limit access to just one user, which eliminates the possibility for
other groups to access the form.
3. Choose from the Portlet, Agency, Module, Group, and User drop‑down menus to specify where you
want the form to display. For example, if you selected the Module tab, choose the Module from the
drop-down menu. With each selection, Form Portlet Designer refreshes and displays available options.
Also, depending on which tab you selected, the fields vary. For example, if you selected the Agency
tab, you only need to choose an item from the Agency and Portlet drop-down menus.

| Part 1: Configuring the User View | 150

4. Click New.
Civic Platform displays a layout editor and the Available Fields page.

5. Complete the following fields.
Filter Name

Enter a descriptive name for the filter, so that you can identify it if you need to locate it
later. After you save a form, the Filter Name displays in the Name column.

Description

Enter a descriptive name to help identify the purpose of the form.

Source View

The Source View Name is read-only and you cannot modify it.

6. Arrange the fields on the form in the same order you want them to appear for users when they complete
the form.
For complete details, see Customizing a Form.
7. Rename any of the field labels, according to your agency’s business objectives, as follows:
a. Double click a field name to access the properties page for the field.

| Part 1: Configuring the User View | 151

b. Modify the text that displays in the Label field. You cannot change the database label (DB Label).
c. Click OK.
Civic Platform displays your customized field name.
8. When you are happy with the layout of the form click Save.

Customizing a Form
When you create or edit a form in the Form Portlet Designer, you can use the different controls to show,
hide, move, make read-only, and alter the available fields according to your business objectives. This
section explains the controls you can use to customize forms in the Form Portlet Designer.
To customize a form
1. Open the Form Portlet Designer by either creating or editing a form layout.
For instructions, see Creating a Form or Customizing a Form.
2. Click Available Fields.
Civic Platform displays the Available Fields page.

3. To display or hide fields:
a. To display fields, from the list of Available Fields, double-click each field you want to add to the
form, and then click OK.
Civic Platform displays the selected field on the layout page and removes the selected fields from
the Available Fields list.
Note:
The Available Fields list also provides the Address Template, Parcel Template, or Owner Template
options. If you select any of those options, Civic Platform removes the option from the Available
Fields list and displays all active attributes of the selected template as additional fields on the form.
The APO Form Layout Editor defines the layout and display of each field in a template.
On the Record Search form, only record-searchable attributes display as available fields. You can
specify which attributes are record-searchable when creating or editing a template.

b. To hide a field, select the field on the layout page and click Delete.
4. To change the location of a field, drag the field to its new location on the layout page.
If your field arrangement causes any fields to overlap, the overlapping fields display with red borders,
enabling you to easily identify them.

| Part 1: Configuring the User View | 152

If you have any overlapping fields on your form when you attempt to save it, Civic Platform returns an
error. To save the form, you must locate the overlapping fields (see the above example) and separate
them.
5. To change a field name (Label) or any of the field’s properties:
a. Double-click the field you want to change.
Civic Platform displays the Field Properties page.

b. Modify the field properties as necessary. Note: you cannot modify the database label (DB Label).
For a list of field descriptions, see Table 21: Form Designer Field Properties
c. Click OK.
6. To add a URL link to the form:
a. Click Text, which adds a dynamic label to the form. Then double-click the dynamic label and:
•

In the Label field, enter the text of the link.

•

In the URL field, enter the URL for the website that opens when a user clicks the link.

| Part 1: Configuring the User View | 153

7. Click Preview to review the layout of your form.
Civic Platform displays a Preview page.

To close the preview, simply close the preview page.
8. When you are happy with the appearance of your form, click Save.
Table 21: Form Designer Field Properties

Access Key

Enter the shortcut key that users can press in addition to the ALT key to position the
cursor in this field. For example, if you want users to be able to access the Asset ID
field by pressing ALT+I, enter the letter I in this field.

| Part 1: Configuring the User View | 154

By Range

When applicable, allows the user to search this field based on a range of values. The
default is Yes. If you select No, the field allows for searching on a single field, not on a
range. (Optional)

DB Label

This field is display-only. It shows the actual name of the field as it displays in your
database.

Default Value

Set a default value for the field on a search form portlet. The default value you set
appears in the field whenever users navigate to the search form portlet.
If you do not supply a value, the field can either be blank (null) or it can display the
value that the user entered during his or her last search, depending on the field type.
If you want this type of field to always appear as blank (null) in a new search, select
Set Null in the Default Value property setting for the desired field. This property is only
available for fields on search form portlets.
The default value varies depending on the By Range field property. When you set
the By Range field property to Yes, Civic Platform displays the Default From and
Default To properties instead of the Default Value property. When you set it to No,
Civic Platform displays the Default Value property only.
For more information on setting a default value for a search field, see Setting Default
Values for Fields in a Search Form.

Label

Enter a label for the field as you want it to display on the form.

Mask

Choose a mask type from the list of masks to apply to the field.

Read Only

The default is No. Use the drop-down list and choose Yes to make the field read-only
when users access the form. Whichever level you design the form for, the read-only
characteristic then affects all of its sublevels.
For example, if you design the form for the agency level, the read-only attribute applies
to the sublevels of module, user group, and individual users. Or, if you design the form
at the module level then the read-only characteristic applies to the sublevels of user
group and users.

Required

Specify if you want to make the field mandatory. When completing a form, users must
enter information in a required field. Required fields display in the Form Layout Editor
as well on the actual form with a red asterisk.

Tab Index

Enter a number to determine the position of this field in a tab sequence. When a user
is working with a form, he or she can press the TAB key to move from field to field.
The index number determines the order in which this field becomes active in relation to
other fields on the same form.

Setting Default Values for Fields in a Search Form
This section explains how to set a default value for a field in a search form. The default values you set
appear in the field whenever users navigate to the search form. For example, you can have the City field
populated with the value of “Bridgeview” when the user opens the Owner Search form so the user does not
need to manually select or enter the city name.
You can set default values in the Form Portlet Designer, in the Edit View feature, or any fields that allow
you to enter a value in the Default Value property. If you do not supply a value, the field can either be
blank (null) or it can display the value predefined by the search logic. If you want this type of field to always
appear as blank (null) in a new search, select Set Null in the Default Value property setting for the desired
field.
You can set a default value for a field of the text, numeric, date, radio button, or check box type. You
can also set a default option for a drop-down list field. However, the Default Value property setting is not
available for data picker fields such as Record Type, Department, and User, because the options for those
fields vary by agency. For radio button fields, check box fields, and drop-down list fields, the default value
must be a valid database value, instead of a label text.

| Part 1: Configuring the User View | 155

Some numeric fields support a range of values as the search criteria. You can allow a range of values for
a numeric field by setting the By Range property for the desired field to Yes. This way, you can specify a
default minimum value, a maximum value, or both that you want to apply to the range of acceptable values.
To set a default value for a search field
1. Access the Form Portlet Designer (Accessing the Form Portlet Designer).
2. In the Portlet field, select the search form you want to customize.
Civic Platform displays the form layout editor.
3. Double-click field you want to change.
•

Date fields
Civic Platform displays the Default Value property with a Set Null option and a Today + Days field.

Note: The Set Null default value setting of the date field on a search form overrides the
FIND APP DATE RANGE standard choice setting. For example, if Set Null is enabled for the
Opened Date field on the Search Form Portlet Designer, and the FIND APP DATE RANGE
standard choice value is set to 120 days, the Opened Date field on the form will be set to null.
•

Fields of other types that do not support searches based on a range of values
Civic Platform displays the Default Value property with a Set Null option and a text field.

| Part 1: Configuring the User View | 156

•

Fields of other types that support searches based on a range of values
Civic Platform displays the Default From and Default To properties. Each default value property has
a Set Null option and a text field.

4. Enter a default value for the field.
The value you can enter depends on the type of the field. For examples of default values, see Table 22:
Default Value Property Setting.
5. Click OK.
Table 22: Default Value Property Setting

Field Type

Example Default Value

Notes

Check Box

Y

Enter the key value of the check box status as stored in
your database.

| Part 1: Configuring the User View | 157

Field Type

Example Default Value

Notes

Date

Today + 90 Days

Specify a date range in the Today + n Days field. If you
enter a positive integer, the default search criteria is within
X days after the current date. If you enter a negative
integer, the default search criteria is within X days before
the current date.

Drop-down List

North

Enter the key value of a valid option as stored in your
database. An easy way to identify the correct key value
is to view the source code for the search form in your
browser and locate the content of the option value.

Numeric

8887222352

If you set the By Range property for the field to Yes, enter
a valid number in the Default Value property setting. If
you set it to No, enter a valid number in the Default From
property setting, the Default To property setting, or both.

Radio Button

Y

Enter the key value of a valid option that you have stored
and identified in your database. An easy way to get the
correct key value is to view the source code of the search
form in your browser and locate the content of the option
value.

Text

New

Enter valid alphanumeric characters in the Default Value
property setting.

Using the Edit View Feature
Civic Platform provides the Edit View feature to customize how information displays in a form.
To edit the view of a form portlet
1. Locate the form portlet you want to customize and click Menu.
Civic Platform displays the menu options.

2. Choose the Edit View option from the drop-down menu.
Civic Platform displays the Edit View page and the Available Fields page.

| Part 1: Configuring the User View | 158

3. Complete the following fields:
Filter Name

Enter a descriptive name for the form portlet. This filter name is the name you can
use to locate the form using the Form Portlet Designer.

Source View Name

This field is not editable.

Description

Enter a description to help identify the purpose of the form.

Align Command

Use this drop-down list after you have added fields to the form. Select one or more
fields and choose the desired option from the drop-down list.

Effect Scope

Specify the availability of the customized filter for the desired module, user group,
or user with the corresponding drop-down list.

4. If you want to show an available field, do the following:
a. Click Available Fields.
Civic Platform displays the Available Fields page.

b. Select a field from the list of Available Fields. To select multiple fields, double-click each field.
c. Click OK.
Civic Platform places the selected field on the form and removes the field from the Available Fields
list.

| Part 1: Configuring the User View | 159

Note:
The Available Fields list also provides the Address Template, Parcel Template, or Owner Template
options. If you select any of those options, Civic Platform removes the option from the Available
Fields list and displays all active attributes of the selected template as additional fields on the form.
The APO Form Layout Editor defines the layout and display of each active field in a template.
On the Record Search form, only record-searchable attributes can show up as additional fields. You
can specify which attributes are record-searchable when creating or editing a template.

5. To hide a selected field, select the field on the form and click Delete.
6. To change the position of a field, drag the field to the new position on the form.
7. To change a fields name or its properties:
a. Double-click the field you want to change.
Depending on the type of form you are editing, your options vary.
Civic Platform displays the Field Properties page.

b. Complete the field properties as necessary.
For a list of field descriptions, see Table 21: Form Designer Field Properties
c. Click OK.
8. When you are happy with the appearance of your form click Submit.

Working with Lists
The List Layout Editor enables you to customize the list portlets in Civic Platform. You can set up lists at
the agency, module, user group, and even individual user levels, depending on what you want certain
users to see. When you create a list design, it applies to all sub-levels.
Topics

| Part 1: Configuring the User View | 160

•

Creating a List Portlet

•

Editing a List Portlet Layout

Creating a List Portlet
This section describes how to create a list portlet using the List Layout Editor. To do this, select the portlet
and determine which organization level you want to apply to the list. After you determine the portlet and the
affected organization level, you can determine which fields you want to make available on the list portlet
using the List Layout Editor.
You can show or hide certain fields, make fields read-only, and control the field order and width of each
field using the List Layout Editor. Fields on a list display as column headers.
To create a list portlet
1. Identify which users can access your new list and select an existing list to use as a template upon which
to build your portlet.
For instructions to do this, see Customizing Menus, Tabs, and Drop-down Lists .
2. Click New.
Civic Platform displays the List Layout Editor.

3. Complete the fields as necessary.
For a list of field descriptions, see Table 23: List Layout Editor Details.
4. Click Save.
Table 23: List Layout Editor Details

Available Fields

Displays the fields that are available to use but are not currently displaying in the list
portlet. To move any field to the Selected Fields box, highlight the field and click the
right-arrow. To move all fields, click double arrow. Hold the CTRL key to select multiple
fields.

A > Z Ascending

Select this option to further sort a selected sort order field in an ascending order
alphabetically from A to Z. This option is the default setting and is available when you
select a sort order for a field.

Contract

Enter the minimum number of items to display on one page of a list.

Description

Enter a description for the form.

| Part 1: Configuring the User View | 161

Display Order

Specify the order for displaying each field on the form.

Effect Scope

Specify the availability of the customized sort/filter using the drop‑down feature for
Module, Group, and User.

Element

Civic Platform lists the fields in the Selected Fields box in their current order.

Expand

Enter the maximum number of items to display on one page of a list.

Filter Name

Enter a descriptive name for the filter.

Label

If you want to customize the text label for a field, enter the new text label in the label
field.

Mask

If you want to add a mask to the display of any field, click Mask to set up the mask.

Number of Records

The amount of records you want the user to see. The Contract option is the number
of records displaying when a user contracts a list in a portlet and you have more than
one portlet on your screen. The Expand field is the list of records shown when a user
expands a list in one portlet.

Record Selection

Select the type of record selection icon you want to apply to the list. Civic Platform
defaults to the Check Box record selection tool. If you do not want to allow users to
select records, select None.

Required

Specify if you want to make the field mandatory. If you select Yes, a red asterisk
displays on that field and a user cannot submit the form until that field has data entered
in it.

Selected Fields

Displays the fields that currently display in the list portlet. To remove any field, highlight
the field and click left-facing arrow. To move all fields, click double arrow. Hold the
CTRL key to select multiple fields.
To change the order, highlight a field and click up or down arrows.

Sort Order

Enter the sort order of a particular field. Civic Platform sorts lists based on the sort
order. Civic Platform sorts fields with the lowest sort order (highest priority) first, to
simplify organizing and grouping list items. For example, if you assign the sort order
of the Type field to “1st” and the sort order of the Subtype field to “2nd,” Civic Platform
sorts the list first by type and then by subtype.
Note:
If you want the newest record to appear at the top of the list, assign the Audit
Date field to the 1st sort order. This field contains the record's creation date
and time.

Source View Name

Civic Platform identifies the name of the form you are modifying.

Width

Enter the number of pixels for the column width.

Z > A Descending

Select this option to further sort a selected sort order field in a descending order
alphabetically from Z to A. This option is available when you select a sort order for a
field.

Editing a List Portlet Layout
You can show or hide certain fields, make fields read-only, and control the order in which fields display and
their width, with the List Layout Editor. Fields on a list display as column headers.
To edit a list portlet layout
1. Find the list to edit by identifying which users access the list.
For instructions to do this, see Customizing Menus, Tabs, and Drop-down Lists .
2. Click the list design you want to edit.
Civic Platform displays the List Layout Editor.

| Part 1: Configuring the User View | 162

3. Complete the fields as necessary.
For a list of field descriptions, see Table 23: List Layout Editor Details.
4. Click Save.

Working with Customized Views
•

Removing a Customized View

•

Copying a Customized View

•

Accessing and Assigning the View

Removing a Customized View
This section describes how to remove a customized form or list portlet. Removing a customized view
allows users to see all available fields according to the default settings.
To remove a customized view
1. Identify which users access the customized view you want to remove.
For instructions to do this, see Customizing Menus, Tabs, and Drop-down Lists .
2. Select the customized view you want to remove.
3. Click Delete.
Civic Platform removes the form design, and updates the list of available forms.

Copying a Customized View
This section describes how to copy a customized view to another user or group of users. For example, if
you need to make a customized record list for all users who manage fee information, you need to make the
list for the billing department as well as the cashier user group. The cashier user group might not belong to
the same user group as the billing department. In such a case, you can create a customized view and copy
it to all necessary user groups.

| Part 1: Configuring the User View | 163

To create a copy of a customized view
1. Select the existing customized view to use as a pattern.
For instructions to do this, see Customizing Menus, Tabs, and Drop-down Lists .
2. Use the Copy to Fields to identify which user or users you want to copy the customized view
assignment to.
For descriptions of each field, see Table 24: Copy to Field Details
3. Select each view you want to copy.
4. Click Copy in the toolbar.
Civic Platform copies the view and identifies how many customized views it successfully copied.
Table 24: Copy to Field Details

Agency

Select the agency to which you want to copy the customized view.

Module

Select the module to which you want to copy the customized view.

User Group

Select the user group to which you want to copy the customized view.

User

Select the user to which you want to copy the customized view.

Accessing and Assigning the View
To access and assign a view
1. Access the Form Portlet Designer (Accessing the Form Portlet Designer).
2. Click one of the following tabs depending on the level of form you want to create: Agency, Module,
User Group, User, Personalization, or Dynamic Text. We are using the Module tab to illustrate this
example. For a list of fields, see Table 25: View Filter Fields. Depending on the level (agency, module,
user group, or user) of the design you create, you might not see all of these fields.
The Personalization tab is view only. Administrators can only view and delete personal forms or lists.
You cannot modify lists or forms using this tab.
Civic Platform displays a list of all custom views defined for the selected organization level.

3. Use the filter menus to refine the list of views.
For a list of fields, see Table 25: View Filter Fields. Depending on the level (agency, module, user
group, or user) of the design you create, you might not see all of these fields.
Civic Platform updates the list to reflect the selected agency, module, user group, and view.
4. Choose one of the following as appropriate:
•

Add a new customized form. For instructions, see Creating a Form.

| Part 1: Configuring the User View | 164

•

Add a new customized list. For instructions, see Creating a List Portlet.

•

Edit an existing form. For instructions, see Customizing a Form.

•

Edit an existing list. For instructions, see Editing a List Portlet Layout.

•

Remove an existing customized view. For instructions, see Removing a Customized View.

•

Copy an existing view. For instructions, see Copying a Customized View.
Table 25: View Filter Fields

Agency

Select the agency that contains the module you want to work with.

Module

Select the module that contains the user group you want to work with.

Portlet

Select the list or form view you want to work with.

User Group

Select the user group that contains the user you want to work with.

User

Select the view you want to work with. A view is either a list or a form in Civic Platform.
Every list or form you can modify appears in this drop-down menu.

Creating Dynamic Text Labels
The Dynamic Text Tab enables you to create text labels that allow users to switch languages in
customized form layouts. Use the buttons at the top of the portlet to search for, add, or delete a dynamic
text label. After you create a label, you must add it to the form layout where you want it to display. For
instructions on creating a form layout, see Creating a Form.
Note:
The dynamic text label feature specifically applies to Civic Platform systems configured for
Internationalization.

To create a dynamic text label
1. Access the Form Portlet Designer (Accessing the Form Portlet Designer).
2. Click Dynamic Text tab.
Civic Platform displays the Dynamic Text List view.

3. Click New.
Civic Platform displays the Dynamic Text New page.

| Part 1: Configuring the User View | 165

4. Complete these fields:
Key

The name of the text label.

Display Text

The text that displays on the screen to the user.

Language

If your system is localized/internationalized, select the desired language from the
available drop-down list to apply to the display text.

5. Click Submit.
Civic Platform adds the label to the Dynamic Text List view.

| Part 2: Setting Up Agencies, Organizations, and People | 166

Part 2: Setting Up Agencies, Organizations, and People
Civic Platform provides functions to set up your agency.
Related Information
Configuring Organizations, Departments, and Users
Managing Contacts, Licensed Professionals, and Public Users
Setting Up Cross-Agency Operations
Customizing Regional Settings

| Part 2: Setting Up Agencies, Organizations, and People | 167

Configuring Organizations, Departments, and Users
This section contains the information you need to structure your organization and conduct user
administration tasks, such as resetting passwords and assigning access permissions.
Click a topic title below for full details.
Related Information
Working with Organizations
Establishing User Groups
Managing Users

Working with Organizations
Topics
•

Adding a Level to an Organization Structure

•

Establishing an Organization Structure

•

Editing an Organization Structure

•

Establishing an Organization Alias

•

Editing an Organization Level

Adding a Level to an Organization Structure
When you set up your organization in Civic Platform, you define up to six organization levels. The main
level is the service provider. Civic Platform provides this value when you implement Civic Platform. Your
service provider code is a unique code that distinguishes your agency from all other jurisdictions for which
Civic Platform is the service provider. You cannot change this value.
You can define these six levels:
•

Agency. You determine this value for one or more agencies that you set up. When you search for
departments within Civic Platform, this is the first level within an organization structure you can select.
You also use your agency name when you log in to Civic Platform.

•

Bureau. An organization level within an agency.

•

Division. An organization level within a bureau.

•

Section. An organization level within a division.

•

Group. An organization level within a section.

•

Office. An organization level within a group. An office is the final level within an organization structure.
You cannot add a branch to this organization level.
Note:
When you set up an organization structure, you must include all six levels, or branches. Even if you do
not use the lower organization levels, you should add an “NA” branch for each level to include in the
structure.

| Part 2: Setting Up Agencies, Organizations, and People | 168

Examples:
Metroville > building > na > na > na > na > na > Counter Technicians
Metroville > building > inspections > na > na > na > na > Inspectors
Metroville > buidling > na > na > na > na > Inspections > Inspectors
Civic Platform uses this structure in two places:
•

To identify the department assigned to the Task in a process stack

•

To assign a user to a department

When a user does anything, Civic Platform inserts not only the user name but also the assigned
department. Also, when assigning inspections or tasks, the manager can look up the department and
select a user in that department to do the required inspection or task.
To set up a hierarchy among departments, you can define branches within each branch.
Here is an example of a typical setup:
•

Your Civic Platform implementation specialist defines the Service Provider as the main agency when
during your initial system set up.

•

Add the first level to the main agency. Usually, this level matches or is equal to the available modules
turned on for Civic Platform. For example, if you had Building, Enforcement, and Planning modules, you
can add three levels to the Agency called Building, Enforcement, and Planning.

•

Add under each first level a level called Bureau. The setup looks like this example: Metroville > Building
> Inspections Metroville > Enforcement > Inspections Metroville > Planning > Inspections

•

Add additional levels to the Bureau level. For example, in Building you might have Inspections, Counter,
BuildingAdmins, and Cashier. The setup looks like this example: Metroville > Building > Inspections
Metroville > Building > Counter Metroville > Building > BuildingAdmins Metroville > Building > Cashier

•

Each agency could have multiple nodes at the Bureau level. Enforcement might have Inspections,
Counter, BuildingAdmins, or Cashier. The setup looks like this example: Metroville > Enforcement >
Inspections Metroville > Enforcement > Counter Metroville > Enforcement > BuildingAdmins Metroville >
Enforcement > Cashier

When you have no more levels to add, use NA.
To add a level to an organization structure
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose User Profile > Organizations.
Civic Platform displays the Set Up Organization page with links to each organization level.

3. Click the link to the appropriate level to which you want to add a branch. For example, click Metroville.
Civic Platform displays a list of all of the branches embedded within a level. For example, if you click the
link to a specific agency, Civic Platform displays a list of all of the bureaus defined for that agency.
4. Continue to click the link to the next level as needed to add a branch to that level.

| Part 2: Setting Up Agencies, Organizations, and People | 169

For example, to add an office to a group, click the link to the agency, then the link to the bureau, then
the link to the division, then the link to the section. Lastly, click the link to the group to which you want to
add the office branch.
5. Click Add.
Civic Platform displays an Add Branch window, where you can view the current level of the branch you
are about to add.
6. Complete these fields:
Name

Enter the name of the branch that helps to identify it.

Description

Enter a description of the branch that helps to identify its purpose.

Status

If you want the branch to be available in Civic Platform, select Enable; otherwise,
select Disable.

7. Click Add.

Establishing an Organization Structure
After you identify the branches for each organization level in your agency, you can set up an organization
structure. An organization structure, similar to a department, identifies a certain group of staff members.
When a user searches for departments in Civic Platform, they can find the organization structures you
have set up.
Note:
Before you can define a new organization structure, you must define branches and include all six levels
of organization branches within the structure. To set up branches, see Adding a Level to an Organization
Structure.

To establish an organization structure
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose User Profile > Organization.
Civic Platform displays the Set Up Organization page with links to each organization level.
Note:
Your service provider code shows up as a link under the Service Provider heading.

3. Click the link to the agency you want to include in your organization structure.
Civic Platform displays a list of all of the bureaus within the agency.
4. Click the link to the bureau you want to include in your organization structure.
Civic Platform displays a list of all of the divisions within the bureau.
5. Click the link to the division you want to include in your organization structure.
Civic Platform displays a list of all of the sections within the division.
6. Click the link to the section you want to include in your organization structure.
Civic Platform displays a list of all of the groups within the section.
7. Click the link to the group you want to include in your organization structure.
Civic Platform displays a list of all of the offices within the group.
8. Click the link to the office you want to include in your organization structure.

| Part 2: Setting Up Agencies, Organizations, and People | 170

9. Click Add.
Civic Platform displays an Add Structure screen. In this window, you can view the definition of the
structure you are about to add.
10.Complete these fields:
Description

Enter a unique description for the structure.

Status

If you want the structure to be available in Civic Platform, select Enable; otherwise,
select Disable.

11.Click Add.

Editing an Organization Structure
After you add an organization structure to Civic Platform, you might need to change the description. You
might also need to disable a structure that represents an obsolete department within your agency.
Note:
Because departments link directly to tasks, if you change a department name, you must rework every
related task and associated user in Civic Platform. Accela recommends that you do not change organization
names.

It is best practice to inform users of any departments that you disable. Departments affect many areas of
the Civic Platform system, including conditions, workflow, and inspections. If users try to use a disabled
department, Civic Platform displays a message informing them that the department is not active and to
contact their agency administrator.
To edit an organization structure
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose User Profile > Organization.
Civic Platform displays a list of structures at the bottom of the window.
3. In the list of structures, click the red dot that appears next to the structure you want to edit.
Civic Platform displays the Edit Structure pop‑up window. In this window, you can view the definition of
the structure you are about to edit.
4. Update these fields:
Description

Enter a unique description for the structure.

Status

If you want the structure to be available in Civic Platform, select Enable; otherwise,
select Disable.

5. Click Update.

Establishing an Organization Alias
An organization contains six organization levels. If enabled, you can have the option to specify a
department name alias. Aliases enable you to replace a multi-level organization description with an
abbreviated and descriptive alias, such as Records Department.
After you establish an alias, users can choose from a list of organization aliases when selecting a
department in these situations:
•

Assigning a workflow task

•

Creating a new user

| Part 2: Setting Up Agencies, Organizations, and People | 171

•

Scheduling an inspection

•

Assigning an inspection

•

Looking up inspection statistics

•

Applying conditions

•

Updating the workflow status for a set of applications

•

Creating a tickler
Note:
If you choose not to establish an alias for an organization structure, Civic Platform displays the 6-level
combined version of the department name when users search for a department.

You must establish an organizational structure before you can apply an alias to the structure. For
instructions, see Establishing an Organization Structure.
To establish an organization alias
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose User Profile > Organization.
Civic Platform displays the Set Up Organization page.
3. Scroll down the page to display the list of organizational structures.
4. Click the red dot that appears to the left of the organization structure you want.
Civic Platform displays the Edit Organization Structure window.
5. Complete this field:
Department

Enter a unique alias that clearly represents the organization structure.

6. Click Update.

Editing an Organization Level
After you add a branch to an organization level, you might need to change the branch description. You can
enable and disable branches in your organization as needed.
It is best practice to inform users of departments that you disable. Departments effect many areas of the
Civic Platform system including conditions, workflow, and inspections, for example. If users try to use a
disabled department, Civic Platform displays a message informing them that the department is not active
and to contact their agency administrator.
To edit an organization level
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose User Profile > Organization.
Civic Platform displays the Set Up Organization page with links to each organization level.
3. Click the link to the appropriate level for which you want to edit a branch.
Civic Platform displays a list of all of the branches embedded within a level. For example, if you click the
link to a specific agency, Civic Platform displays a list of all of the bureaus defined for that agency.
4. Continue to click the link to the next level as needed to edit a branch at that level.

| Part 2: Setting Up Agencies, Organizations, and People | 172

Click the link to the agency > the link to the bureau > the link to the division > the link to the section.
Lastly, click the link to the group where you want to edit that branch.
5. Click the red dot that appears next to the branch you want to edit.
Civic Platform displays an Edit Branch pop‑up window. In this window, you can view the current level
and the name of the branch you are about to edit.
6. Update these fields:
Description

Enter a description of the branch that helps to identify its purpose.

Status

If you want the branch to be available in Civic Platform, select Enable; otherwise,
select Disable.

7. Click Update.

Establishing User Groups
Topics
•

Adding a User Group

•

Searching for a User Group

•

Editing a User Group

Adding a User Group
Before you can grant a user certain privileges in Civic Platform, you must determine what privileges you
want to include in the user group. When you add a new user group you can determine each function you
want to make available to users who are part of the group. You can also determine what level of access
you want to apply to each function—for example, “full access” or “read only.”
Note:
Although you cannot delete a user group, you can disable the user group.

To add a user group
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose User Profile > User Group.
3. Click Add.
4. Complete the fields as described in Table 26: User Group Fields.
5. For each function, select the level of access you want to grant to the user group.
6. Click Save.
Table 26: User Group Fields

Group Name

Enter a unique name for this user group that describes the functions and privileges
of the group. For example, enter “Admin Full” or “Inspectors.”

| Part 2: Setting Up Agencies, Organizations, and People | 173

Module

Select the module you want to make accessible to users in this group.
If you want to give this user group access to additional modules, you can set up a
new user group with the same name, but choose a different module.

Description

Enter a description of the user group.

Status

If you want the user group to be available to use Civic Platform, select Enable;
otherwise, select Disable.

Searching for a User Group
You can search for any user group on your system, including those you previously disabled. For example,
you can search for a user group to update information or to change its status.
Note:
To see a list of all user groups, Click Submit without entering the group name.

To search for a user group
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose User Profile > User Group.
3. Enter the name of the user group in the Group Name field.
4. Click Submit.
Civic Platform displays the User Group Browse page.
5. Click the red dot next to the group you want to edit.

Editing a User Group
After you create a user group, you might need to change some of the functions and privileges within the
user group. You can change the group name as well as the group status. If you no longer use a user
group, you can disable it.
To edit a user group
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose User Profile > User Group.
3. Search for the user group you want to edit.
4. Complete the necessary fields as described in Table 26: User Group Fields.
5. For each function, select the level of access you want to grant to the user group.
6. Click Save.

Managing Users
Topics
•

Adding a User

| Part 2: Setting Up Agencies, Organizations, and People | 174

•

Viewing a User

•

Editing a User

•

Setting a User's Default Module

•

Setting a User Account Disable Time Frame

•

Setting a User Password Time‑out Time Frame

•

Manually Enabling a User Account

•

Changing a User Password

•

Synchronizing External User Data

Adding a User
As your agency’s staff changes, you might need to add new users to your system. You can determine the
ID and password information that the user needs to log in to Civic Platform. You can also determine the
department and the user group to which the new user belongs.
Note:
If a specific user is an inspector and you choose to automatically assign and schedule inspections, you must
identify the inspector profile. For instructions, see Inspections.

To add a user
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose User Profile > User.
3. Click the Add New User button.
Civic Platform displays the User-Add page.

| Part 2: Setting Up Agencies, Organizations, and People | 175

4. Complete the fields as described in Table 27: User Fields.
5. In the User Group/Privilege section, mark the check box next to each module you want the user to be
able to access.
6. For each module that you marked, choose the user group you want to assign the user to within that
module. A single user can belong to only one user group for each module.
7. Click Save.
Table 27: User Fields

Access Mode

Mark either the Standard or Alternate option.
In Standard access mode, pop-up windows sometimes display. In Alternate access
mode, Civic Platform displays information in a new window instead of in pop-up
windows.
This accommodates users who depend on accessibility devices to interpret the content
of web pages, because these devices typically cannot interpret the JavaScript used
with pop-up windows.

| Part 2: Setting Up Agencies, Organizations, and People | 176

Account Disable Time
Frame

Enter the number of days a user account can remain inactive before it becomes
disabled. Enter this value as a non-negative integer. When the number of days since
the Last Login Date is greater than the value in this field, the account becomes
disabled. Mark the Enable option for the Status field to manually reactivate an
account.
If you leave this field blank, Civic Platform uses the agency account disable time
frame. If both the user and agency Account Disable Time Frame fields are blank, Civic
Platform uses the default value of 90 days.

Billing Rate

Enter the billing rate per hour for the user.

Cashier ID

Enter the cashier identification number for the user. Civic Platform uses this number in
the receipt number to identify the cashier and workstation. The ID number must be no
more than 10 characters.

Confirm Password

This field displays on the User Profile Edit page; Civic Platform uses this field together
with the New Password field to change a user password. Enter the same password you
typed in the New Password field.

Daily Inspection Units

Enter the units the user is available for inspections each day. Typically, a unit is one
hour.

Department

Use this button to choose the department that this user belongs to. You must choose
all six levels or organization.
For the user account of a contract inspector or a self-certified inspector, this field is
ready-only and Civic Platform sets the department to ///
PUBLIC/NA/NA/NA.

Display Initials in Citizen Civic Platform uses this field to indicate the display of the user’s initials in Citizen
Access
Access. Mark the check box to display the user’s initials or clear the check box to
display the user’s name in Citizen Access.
Distinguished Name

If you previously authorized this user for a LDAP services, enter the LDAP identifier.
Agencies often use LDAP as user’s repository.

Email

Enter the user’s email address. Public users in Citizen Access can have permissions to
view the email address provided in this field to notify the agency user of the completion
of an action item or an inspection.

Employee ID

Enter the ID, abbreviation, or code your agency uses to represent this user.

Initial

Enter the user initials you want displayed in Civic Platform. For example, initials display
as an indication of who re-scheduled an inspection or completed a task in workflow.
Clear this field if you do not want user initials to display.

Initial (Default)

This is a read-only field displaying the default user initials based on the user’s first,
middle, and last name.

Inspector Status

You can identify users as inspectors and assign them to inspections.Mark the Enable
option to identify users as inspectors; otherwise, mark the Disable option. For the user
account of a contract inspector or a self-certified inspector, Civic Platform marks the
Enable option by default.

Integrated

This field displays only if you are integrating an Active Directory user into Civic
Platform. Mark Yes if you want to add an integrated user. Mark No if you do not want to
add an integrated user.

IVR User Number

An interactive voice response user number automatically generates in this field.

IVR Pin Number

Enter the user’s IVR pin number.

| Part 2: Setting Up Agencies, Organizations, and People | 177

Last Login Date

This read-only field automatically populates with the most recent date the user logged
into their account.
When an agency administrator manually changes the Status from Disabled to
Enabled, this field resets.

Mobile Phone

Enter the user’s mobile phone number.

New Password

This field displays on the User Profile Edit page; Civic Platform uses it together with the
Confirm Password field to change a user’s password. Enter the user’s new password in
this field. Then, enter this same password into the Confirm Password field.
Note that the password strength indicator displays a visual representation of the
password security strength against the agency's minimum password requirements.
If you have trouble entering a valid password, click the Requirements link to view the
agency’s minimum password requirements.

Password

Enter any combination of alphanumeric characters that the new user wants to use
to log in to Civic Platform. As a security measure, Civic Platform displays an asterisk
instead of the actual characters you enter.
Note that the password strength indicator displays a visual representation of the
password security strength against the agency's minimum password requirements.
If you have trouble entering a valid password, click the Requirements link to view the
agency’s minimum password requirements.
You cannot use special characters (@ * ! % $ #) in a password.

Password Change

Use these options to determine who sets the user’s password when the old password
expires.
Select the By User option to allow users to change their own password when their
previous password expires.
Select the By Administrator option to require the administrator to change passwords.
This field defaults to agency settings. If your agency allows users to change their
passwords, Civic Platform automatically selects the By User option. If your agency
requires an administrator to change passwords, Accela Automation automatically
selects the By Administrator option.

Password Time-out
Time Frame

Enter the number of days a user password can remain valid before Civic Platform
requires a password change. Enter this value as a non-negative integer.

Preferred Channel

Select which contact information to expose as the preferred method of contact on
Accela’s Contractor app. Choices include Email, Mobile Phone, Office Phone (uses
Agency level phone number), and None (default).

Section 508 Support

If you want to enable the Accessibility mode for the user, mark the check box next to
the field; otherwise, clear the check box. For more information about configuration and
usage instructions for the Accessibility features in Civic Platform and Citizen Access,
see the Accessibility Configuration and Compliance Guide.

Status

If you want the user to be able to access Civic Platform, mark the Enable option;
otherwise, mark the Disable option.

Title

Enter the user’s job title. For example, enter “Building Inspector” or “Supervisor.”

User cannot log in to
Civic Platform and does
not consume a Civic
Platform license

When selected, the user cannot log in to Civic Platform with this account, and does not
need a Civic Platform license. However, the user can log in to Accela apps with this
account but he must obtain an Mobile Office license for app access. For user accounts
of public users, Civic Platform selects the check box by default.
When cleared, the user must obtain a Civic Platform license and can log in to Civic
Platform with this account. If the user wants to log in to Accela apps with this account,
the user must also obtain an Mobile Office license.

| Part 2: Setting Up Agencies, Organizations, and People | 178

User Group Permission

Use this section to define user access permissions, and to assign the user to the to the
appropriate user groups.
Select each module for which you want to grant access.
Select each user group for which you want to grant access.

User Login ID

Enter a unique combination of alphanumeric characters that the new user wants to use
to log in to Civic Platform.
You cannot use special characters (@ ! # $ % *) in a login ID. You can, however, use
the underscore symbol.

User must change
Password at next Logon

Use these settings to control when you want the user to change their password.
Select Yes to force the user to change their password at next login; which is best
practice if you feel the password is not secure.
Select No to allow the user to change the password when they reach the designated
password Time-out Time Frame.

User Name

Enter the first, middle, or last name of the user.

Viewing a User
You can search for any user on your system, including those that you previously disabled. If you are using
Active Directory and integrating users, you can also search for Active Directory users. You might need to
search for a user to update information or change the user’s status. You can also view all users.
To view users
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose User Profile > User.
Civic Platform displays the User—Search window.
3. To display all users, click the Browse All Users button.
4. To search for a user, complete the applicable fields:
User Login ID

Enter the user login identification.

User Name

Enter as much of the user name as you know.

Status

Select the status types you are searching for.

Exclude Public Users

Choose Yes to display only agency users. Choose No to display agency and public
users.

5. Click Submit.
Civic Platform displays the User Browse window. If you have activated this feature, Active Directory
users see a “Yes” in the Integrated column.
6. Click the red dot next to the user you want to view.
Civic Platform displays the User - Edit page.

Editing a User
After you create users in Civic Platform, you might need to change certain details about the user’s profile.
For example, you might need to update the users email address if it changes. If you use Active Directory,
administrators can also either convert external users to Civic Platform users, or convert Civic Platform
users to external users.
Although you cannot delete a user from Civic Platform, you can disable a user that should no longer have
access to Civic Platform. This feature is useful when an employee leaves your agency.

| Part 2: Setting Up Agencies, Organizations, and People | 179

To edit a user
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose User Profile > User.
3. Search for the user you want to modify. For instructions, see Viewing a User.
4. If you use Active Directory, choose either Civic Platform user or External User, according to your
agency’s needs.
5. Update the fields as necessary. For a list of fields, see Table 27: User Fields.
6. In the User Group/Privilege section, select each module you want the user to be able to access.
7. For each module that you select, choose the user group to which to which the user belongs within that
module.
Note:
A single user can belong to only one user group for each module.

8. Click Save.
Civic Platform updates the user profile.

Setting a User's Default Module
Civic Platform provides enhanced user group management functionality, including the ability to: view and
search all users in a group, add/remove a user from a group, move a user from one group to another, and
view/change a user's default module setting.
Administrators can view and change users' default module settings using their Administrator login account
to make such changes.
To view and change a user's default module setting
1. Log in to Civic Platform as an Administrator.
2. Navigate to Classic Administration > User Profile > User.

| Part 2: Setting Up Agencies, Organizations, and People | 180

3. Edit the user profile to change the user's module setting:

Setting a User Account Disable Time Frame
Configure your system to disable individual user accounts that are inactive for a set period of time.
When an account becomes disabled, the user must contact the agency administrator, who can manually
reactivate accounts. To manually enable an account, see Manually Enabling a User Account.
You can set account disable time frames at the agency and the individual user level. The user account
disable time frame defaults to the agency-level account disable time frame, if you specified one. If you
have not set an agency disable time frame, Civic Platform uses the default time frame of 90 days. Any
value you set at the user level overrides the default value or the agency value. If the Account Disable
Time Frame field in a User Profile is blank, Civic Platform defaults to the agency‑level time frame. For
information on setting an agency‑level account disable time frame, see “Adding an Agency” in the Civic
Platform On-premise Administrator Supplement.
To set an account disable time frame
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose User Profile > User.
3. Search for the user profile for which you want to create an account disable time frame. For instructions,
see Viewing a User.
4. In the Account Disable Time Frame field, enter the number of days an account can be inactive before
it becomes disabled.
5. Click Save.
Civic Platform updates the user profile and begins checking its activity.

Setting a User Password Time‑out Time Frame
You can require users to regularly change their password to increase your system’s security. If you choose
to allow users to change their own password, they begin receiving messages prompting them to change
their password 15 days before it expires. Users can change their password immediately, at a later log in,
or at any time during their Accela session. If users fail to change their password within the time frame, they

| Part 2: Setting Up Agencies, Organizations, and People | 181

must change their password or have it changed by their administrator before they can log in. To change a
password during an Accela session, see Changing a User Password.
You can set password time‑out time frames at the individual user level, and multi‑agency administrators
can set a password time‑out time frame at the agency level. Any value set at the user level overrides the
default time frame or the agency time frame, if you have set one. If the Password Time‑out Time Frame
field in a user profile is blank, Civic Platform defaults to the agency‑level time frame. If you have not set
an agency time frame, the default value is 90 days. For information on setting an agency‑level account
disable time frame, see “Adding an Agency” in the “Agencies and Functions” chapter in the Civic Platform
On-Premise Administrator Supplement.
To set a password time‑out time frame
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose User Profile > User.
3. Search for the user profile for which you want to create a password time‑out time frame. For
instructions, see Viewing a User.
4. Complete the following fields:
Password Time‑out

Enter the number of days that a password can remain active.

Password Change

Select By User to allow users to change their own passwords. Select By
Administrator to only allow agency administrators to change passwords. For
information on changing a password, see Changing a User Password.

Must Change Password
Next Login

Civic Platform automatically sets this option to Yes after the password time‑out time
frame has passed. When the user or the administrator changes the password, Civic
Platform sets this option to No. You can also set this option manually.

5. Click Save.
Civic Platform updates the user profile and begins monitoring its password time‑out time frame.

Manually Enabling a User Account
After a user account becomes inactive longer than the agency or user account disable time frame, or if
the account password has expired, the user cannot access Civic Platform. The agency administrator must
manually enable the account.
To manually enable a disabled account
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose User Profile > User.
3. Search for the user profile you want to enable. For instructions, see Viewing a User.
4. Select Enable in the Status field.
5. Click Save.
Civic Platform clears the Last Login Date field and enables the user account.

Changing a User Password
When you set the password time‑out time frame, you can choose to allow users to change their own
passwords or require that administrators change their password. For instructions on setting a password
time‑out time frame, see Setting a User Password Time‑out Time Frame.
To change a user password

| Part 2: Setting Up Agencies, Organizations, and People | 182

1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose User Profile > User.
3. Search for the user profile you want to change the password for. For instructions, see Viewing a User.
Civic Platform displays the User - Edit page.
4. Complete the following fields:
New Password

Enter the new password for this user. If you experience trouble entering a valid
password, click the Requirements link to view your agency’s minimum password
requirements.

Note:
The password strength indicator displays a visual representation of your password security strength
against the agency's minimum password requirements.
Confirm Password

Enter the new password again.

5. Click Save.
Civic Platform updates the user’s password

Synchronizing External User Data
You can synchronize external user data with user data already in your agency’s database. To do this,
you must add an Active Directory server to your Civic Platform security policies. After you do this, when a
user logs in and Civic Platform validates their credentials, Civic Platform compares the external user data
with the existing user data on the Civic Platform server and updates the Civic Platform data as needed.
Administrators can also add external users to the Civic Platform database if you activate this feature.
Additionally, administrators can either convert external users to Civic Platform users, or convert Civic
Platform users to external users. For instructions, see Editing a User.
Note:
An administrator user (ADMIN) and public users cannot be external users.

The Civic Platform user login procedure authenticates the user directly against the Civic Platform
database. When an external user logs in, Accela sends the authentication request to the external source
for validation. If the user passes the validation, Civic Platform compares the attributes of the external
source and the Civic Platform database. If there are any changes in the external source, Civic Platform
corrects the data in the Civic Platform database.
Because this procedure affects the Civic Platform database, it also affects all Accela products, including
add-ons. This means that all external users who Civic Platform has validated using this process can log in
to products such as Civic Platform, Accela Wireless, or Citizen Access.
Topics
•

Adding an Active Directory Server

•

Integrating a User from Active Directory

Adding an Active Directory Server
To synchronize external user data with user data already in your agency’s database, you must add an
Active Directory server to your Civic Platform security policies.
To add an Active Directory server

| Part 2: Setting Up Agencies, Organizations, and People | 183

1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Agency Profile > Security Policy.
Civic Platform displays the Agency Security Policies—Select Policy page.

3. Click the External User Policy link.
Civic Platform displays the Agency Security Policies page.

4. Complete the External User Policy fields. For a list of field descriptions, see Table 28: External User
Policy Fields.
5. Click Save.
Table 28: External User Policy Fields

Provider URL

Enter the IP address of the external user server for the specified domain controller.
For example, enter the LDAP server URL. You can use SSL LDAP with “ldaps://”
URL.

Provider Port

Enter the external user server’s IP port for LDAP access to Active Directory. This
port number is usually 389.

Access User Name

Enter the ID of the user who can access Active Directory when performing a search
to add new integrated users. Enter the CN (common name) from the DN of the
access user entry.

Access User Passwd

Enter the password for the user ID that can access Active Directory.

Access User OU

Enter the base organization unit you want to use for searches. Access User OU is
the location within Active Directory where Civic Platform should search for users.
The Active Directory administrator provides this information.

| Part 2: Setting Up Agencies, Organizations, and People | 184

Access User DC

Enter the DC (domain component) of the parent entry of the access user entry. The
Active Directory administrator provides this information.
Note:
Civic Platform accesses the LDAP server with the following user
information: CN=,,.

OU Filter

Required. OU Filter defines the organization unit from which to filter users in the
Access User DC and Additional Directory Entries from the LDAP server. If undefined,
Civic Platform searches all the OUs in the Access User DC and the Additional
Directory Entries. You can specify multiple filters, separated by comma, joined by
OR.

Additional Directory Entries Enter more organization units from which to retrieve user entries. Note that you must
specify the DC and root of each organization unit. In case you want to enter multiple
additional organization units, separate them by comma.
Status

To use Active Directory to synchronize the Civic Platform server, select Enable from
the drop-down list; otherwise, select Disable.

Integrating a User from Active Directory
You can synchronize existing external user data with user data already in your agency’s database. After
you have added an Active Directory server to your Civic Platform security policies, you can search for
external users to add to your database. You can also indicate the department and user group to which an
added external user belongs.
Note:
An administrator user (ADMIN) and public users cannot be external users.

To integrate a user from Active Directory
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose User Profile > User.
Civic Platform displays the User—Search page.
3. Click Add.
Civic Platform displays the User—Add page.
4. Select External User.
Civic Platform displays the External User Search button on the User—Add page.

| Part 2: Setting Up Agencies, Organizations, and People | 185

5. Click the External User Search button.
Civic Platform displays the External User—Search page.

6. Complete any of these fields:
OU Search Root

Enter the base organization unit to search.

Common Name

Enter the given, or first, name of the user you want to locate.

Surname

Enter the family, or last, name of the user you want to locate.

7. Click Search.
Civic Platform displays the search results.

| Part 2: Setting Up Agencies, Organizations, and People | 186

8. Click Select for the user that you want to integrate from Active Directory.
Civic Platform auto-populates the User Login ID field with the selected user.
Note:
If you specify an Active Directory attribute (for example, Common Name) in the Standard Choice
DEFAULT_USER_LOGIN_ID, Civic Platform uses the attribute value of the selected user to populate the
User Login ID field. Otherwise, Civic Platform uses userPrincipalName of the selected user from Active
Directory to populate the field.

9. Do one of the following:
•

Enter the department that you wan to associate the integrated user with.

•

Click the Department button to choose a department from a list and click Submit.

10.In the User Group/Privilege section, select each module you want the user to be able to access.
11.For each module that you selected, choose the user group to which the user belongs within that
module.
Note:
A single user can belong to only one user group for each module.

12.Click Save.
Civic Platform displays a confirmation massage indicating that you successfully integrated the user.

| Part 2: Setting Up Agencies, Organizations, and People | 187

Managing Contacts, Licensed Professionals, and Public Users
Civic Platform divides contacts into two categories: reference contacts that serve as the reference
database, and daily contacts that users add to records. Best practice is to manage contact types by
defining only generic reference contact types, such as Individual and Organization. Record each individual
or organization as one reference contact. Then link reference contacts to records in various roles, such
as Applicant, License Holder, etc. This enables you to easily track all the transactional and reference
information about every individual and organization.
After you implement Civic Platform, you might need to add new licensed professionals, as appropriate for
your agency. After you add a licensed professional, users can search for the licensed professional when
creating or editing an application.
Anyone who uses the public facing portion of Citizen Access, IVR, or other Accela add-on products are
called public users. Public users include Anonymous Users and Registered Users who either navigate
the agency’s Citizen Access website or who use IVR and follow the call flow. System administrators can
control which functions are available for both types of public users.
Click a topic title below for full details.
Related Information
Establishing People Templates
Managing Licensed Professionals
Managing Contacts
Creating a Public User Account
Searching for a Public User Account
Managing Accounts for Registered Agencies
Editing a Public User Account
Associating Addresses, Parcels, and Owners with Public User Accounts
Changing a Public User Password
Managing Licenses Associated with Public User Accounts

Establishing People Templates
Topics
•

Creating a People Template

•

Adding People Fields to Forms

•

Searching for a Template

•

Editing a Template

•

Adding an Attribute to a People Template

•

Editing an Attribute

•

Setting Values for a People Template Drop-down List

•

Applying Shared Drop-down Lists

| Part 2: Setting Up Agencies, Organizations, and People | 188

Creating a People Template
When you create a new template, you determine the name, type, and description of the template. there are
three main types of people templates: contact, professional, and Public User. You can define contact types
and professional types in Standard Choices.
To create a template
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose People > People Template.
3. Click Add.
4. Complete the necessary fields as described in Table 29: People Record Template Fields.
5. Click Submit.
6. Add one or more attributes to the template. For instructions, see Adding an Attribute to a People
Template.
7. Add the People template data to the various People forms. For instructions, see Adding People Fields
to Forms.

Adding People Fields to Forms
After you create your new People Template you must add this template data to the various “People” forms
to enable users to see your new agency-defined People fields.
To add template data to forms
1. Navigate to the appropriate people tab (Contacts or Professionals) on the Record detail portlet.
2. To open the detail form, click the link to the contact or professional.
3. To add the new field to the form, choose Menu > Edit View.
4. From the list of fields, click Template Data.
5. Click OK.
6. In the Effect Scope section, set the user access.
7. Click Save.

Searching for a Template
You can search for any template defined on your system, including templates that you previously disabled.
For example, you might need to search for a template to update information or to change the status of the
template.
To see a list of all the templates on your system, click Submit without entering details about an individual
template.
To search for a Template
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose People > People Template.
3. Complete the necessary fields as described in Table 29: People Record Template Fields.
4. Click Submit.

| Part 2: Setting Up Agencies, Organizations, and People | 189

Civic Platform displays the People Template—Browse window.
5. Click the red dot that appears next to the template that you want.
Table 29: People Record Template Fields

Template Name

Enter the template name.

Template Type

Select the type of template you want to find. For example, if you want to find a template
for a billing contact, choose “Billing Contact.” Except for “Public User,” which is hardcoded into the drop-down list, Civic Platform pulls the other values from the values you
set up as Standard Choice values for Contact Types and Licensed Professional Types.
You can set up additional template types in these Standard Choices, as needed.

Description

Enter a description of the template that you want.

Status

Choose the current mode of the template you are searching for.

Editing a Template
After you create a template, you might need to change the description or status. You can also edit any
attributes for the template. You can provide agency users with the ability to edit licensed professional
template fields on detail and reference detail forms. This feature is available in both Civic Platform and
Citizen Access. For more information on how to configure this feature, see Editing a Template.
Note:
You cannot change the template name or its type, but you can add a new template and disable any
templates that you no longer use.

To edit a template
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose People > People Template.
3. Search for the template that you want.
4. Click Edit to the right of the Template Information section.
Civic Platform displays the People Template—Edit window.
5. Complete the necessary fields as described in Table 29: People Record Template Fields.
6. Click Submit.
7. Add one or more attributes to the template.
8. Edit any existing attributes for the template, as needed. For instructions, see Editing an Attribute.

Adding an Attribute to a People Template
Each attribute that you define for the template shows up as an additional field. If the attribute is of contact
or licensed professional type, the additional field shows up when you add or edit a contact or licensed
professional of the same type as your template. If the attribute is of Public User type, the additional field
displays on the Account Registration page and Contact Information section on the Account Management
page.
If you add a drop-down list attribute to a template, you must set up the values that you want to include in
the list. Users can then choose from the values when adding or updating contacts or professionals on your
system.
To add an attribute to a people template

| Part 2: Setting Up Agencies, Organizations, and People | 190

1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose People > People Template.
3. Search for the template that you want.
4. Click Add.
5. Complete the necessary fields as described in Table 30: People Record Template Attribute Fields.
6. Click Submit.
Table 30: People Record Template Attribute Fields

Attribute Name

Enter the name of the attribute.

Label

Enter the label for the attribute that you want to display when a user adds or edits
contact information.

Data Type

Use the drop-down list to define the data information type for the field. For example,
Text, Numeric, Date, or DropdownList. If you are populating field information by EMSE,
you must choose the DropdownList data type for the attribute.

Description

Enter a description of the attribute that helps to identify its purpose.

Default Value

If you want to supply a default value, enter it here. If you are setting up a drop-down
list, you can add values to the drop-down list so that a user has multiple values to
choose from.

Unit

If you want to attach a unit such as square feet, dollars, or miles to the first field value,
enter it here. Choose from standard choices.

New Unit

If the unit you want is not in the drop-down list, type in the new unit here.

Data Type

Choose the type of the attribute. You can choose from Date, Number, Radio, Text, or
Drop-down List.

Display Order

Enter a number to determine the position of the first field in your Application Specific
Information group. For example, if you want the field to display before any other fields,
enter “1.”

Required Flag

If you want the record attributes to be mandatory for the people template, select Yes;
otherwise, select No.

Citizen Access Display
Configuration

Select the appropriate option(s) for implementation in Citizen Access. Indicate if you
want the people template, such as the contact template, to be available on an online
application intake form, a search form, or on the record detail page. Also, indicate if you
want the template fields to be editable on both the record detail page and on the intake
form. For more information, refer to the “Record Inquiry” chapter in the Citizen Access
Administrator Guide.

Display in Citizen
Access Lists

If you want to display the attribute as a column header in the People lists, such as
Licensed Professional list, in Citizen Access, select Yes; otherwise, select No. Civic
Platform displays attributes with this option set to Yes in Citizen Access as one of the
available options of column headers of the People lists.
Administrators can set the option to be visible in the People lists. For complete
information on how to set an attribute to be a column header, see the “Working with
Web Pages” chapter in the Citizen Access Administrator Guide.

Status

If you want to let users see this field in Civic Platform, select Enabled; otherwise,
select Disabled.

| Part 2: Setting Up Agencies, Organizations, and People | 191

Editing an Attribute
After you create a template, you might need to change it. You can update any attributes within the template
by changing the label, data type, and any other features about the attribute.
Note:
You cannot change the attribute name or delete the attribute after you save it. You can add a new attribute
and disable attributes that you no longer use, as needed.

To edit an attribute
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose People > People Template.
3. Search for the template that you want.
4. Click the red dot that appears next to the attribute that you want to edit.
5. Complete the necessary fields as described in Table 30: People Record Template Attribute Fields.
6. Click Submit.

Setting Values for a People Template Drop-down List
You can add an attribute to a template that displays as a drop-down list. After you add a drop-down list
attribute to a template, you must set up the values that you want to include in the list. You can also apply
a drop-down list with preconfigured values, known as a shared drop-down list, to a template attribute. For
more information, see Applying Shared Drop-down Lists.
To set up values for a people template drop-down list
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose People > People Template.
3. Search for the template that you want. For instructions, see Creating a People Template.
4. Click Edit next to the drop-down list attribute that you want.
Civic Platform displays a page where you can add, delete, or update drop-down list values.
5. Do one or more of the following:
•

To add a new value, click Add, enter the value in the Attribute Value field, then Click Save.

•

To update an existing value, enter the value, and then Click Update.

•

To delete a value, click Delete.

6. Click Close to return to the People Template—Detail window.

Applying Shared Drop-down Lists
You can apply a drop-down list with preconfigured values, known as a shared drop-down list, to a template
attribute. Shared drop-down lists provide a useful way of capturing information that is generic to multiple
people templates or people information tables.
For more information on creating shared drop-down lists, see Customizing Menus, Tabs, and Drop-down
Lists .
To apply a shared drop-down list

| Part 2: Setting Up Agencies, Organizations, and People | 192

1. Locate the People template to which you want to apply a shared drop-down list. For instructions, see
Searching for a Template.
2. Click the red dot next to the template to which you want to apply a shared drop-down list.
Civic Platform displays the People Template Detail page.

3. Click Edit next to the drop-down list you want to modify.
Civic Platform displays the People Template Drop-down List Add page.

4. Click Use Shared Drop-down Lists.
5. Do one of the following:
•

Click Search to return all shared drop-down lists.

•

Enter the first letter of the drop-down list, or enter any 0other search criteria, then click Search.
Civic Platform returns the Shared Drop-down List Browse page.

6. Click Select next to the drop-down list you want to apply.
Note:
You can only select one shared drop-down list.

Civic Platform returns to the People Template Drop-down List Add page with the Field Values from the
shared drop-down list listed in blue.

| Part 2: Setting Up Agencies, Organizations, and People | 193

7. Click Update.

Managing Licensed Professionals
Topics
•

Adding Licensed Professionals

•

Searching for a Licensed Professional

•

Editing a Licensed Professional

Adding Licensed Professionals
After you implement Civic Platform, you might need to add new licensed professionals, as appropriate for
your agency. After you add a licensed professional, users can search for the licensed professional when
creating or editing an application.
A licensed professional can have the same license number for multiple license types, such as Electrical,
Mechanical, and Plumbing licenses.
Note:
Depending on how you set up the licensed professional type, you might see other attributes or other fields,
in addition to the standard attributes listed here.

To add a licensed professional
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose People > Licensed Professional.
3. Click Add.
4. Use the License Typedrop-down list to choose the appropriate license type.
Civic Platform displays fields specific to the license type you chose.
5. Complete the fields specific to the license type you chose. For a list of common fields, see Licensed
Professional Fields.
Civic Platform pulls these values and fields from the values you set up as Standard Choices for
LICENSED_PROFESSIONAL_TYPE. Refer to the Civic Platform Configuration Reference.
6. Click Submit.
Table 31: Licensed Professional Fields

Address

Enter the licensed professional’s street address.

Address 3

Any additional address information.

Bond #

If the licensed professional holds a bond, enter the bond number.

Business License #

Enter the official number that identifies the business license issued to the professional
by a local agency or a jurisdiction, such as a city. A licensed professional can have the
same license number for multiple license types, such as an Electrical, Mechanical, or
Plumbing license.

| Part 2: Setting Up Agencies, Organizations, and People | 194

Business License
Expiration Date

Enter the date when the business license is due to expire, or use the Date button to
find the date on a calendar.

Business Name

Enter the name of the business associated with the business license.

City

Enter the city name or click Get Cityto choose the city from a standard list.

Comment

Enter any comments about the business license or licensed professional.

Comp Insurance
Company Code

Enter the code associated with the Worker’s Compensation Insurance Company. For
example, Worker’s Compensation Fund (WCF). Limit to 30 characters.

Contact Name

Enter the first, middle, or last name of the licensed professional. “F/M/L” stands for
First/Middle/Last.

Contractor Business
Name

Enter the contractor business name in the text field, if applicable. For example, AJ’s
Construction. Limit to 65 characters.

Contractor License
Number

Enter the contractor’s license number. Limit to 30 characters.

Email

Enter the licensed professional’s email address.

Fax

Enter the licensed professional’s fax number.

FEIN

If applicable, enter the licensed professional’s federal Employer Identification Number.

Insurance Amount

Enter the cost, in dollar amounts, of the insurance policy.

Insurance Company

Enter the name of the licensed professional's insurance carrier.

Insurance Expiration
Date

Enter the date when the insurance policy is due to expire, or use the Date button to find
the date on a calendar.

License Expiration Date

Enter the date when the business license is due to expire, or use the Date button to
find the date on a calendar.

License Issue Date

Enter license's issued date; you can click the Date button to locate the date on a
calendar.

License Last Renewal
Date

Enter the license's last renewal date; you can click the Date button to find the date on a
calendar.

License Number

Enter the official number that identifies the business license issued to the professional
by a local agency or a jurisdiction, such as a city.

License State

Choose the state that issued the professional business license.

License Type

Choose the type of license the professional holds.

Licensing Board

Choose the licensing board. For example, the Louisiana State Licensing Board for
Contractors.

Phone

Enter the licensed professional’s phone number.

Policy #

Enter the insurance policy number.

SSN

Enter the licensed professional’s social security number.

State

Choose a state.

State License #

Enter the official number that identifies the business license issued by the state. If
the licensed professional is an owner of a licensed food facility, enter the Alt ID field
value of a record that conducts the inspection of the food facility. For more information
about food facility inspection, see “Customizing Food Facility Inspection Search” in
the Citizen Access Administrator Guide. Note: You can create a sequence definition
for this field based on licensed professional type should an applicant fail to provide a
number here. You must configure the People Number in the Sequence Mask Definition
portlet. For information on how to create a mask, see Setting Up Number Sequences
and Masks. For information on how to create a licensed professional type, see Accela
Civic Platform Configuration Reference.

| Part 2: Setting Up Agencies, Organizations, and People | 195

Status

If you want to let users search for this professional, select Enable; otherwise, select
Disable.

Type

Select the licensed professional type, and the organization the licensed professional
belongs to. You can also select Individual.

Worker’s Comp Exempt

Choose a value from the drop-down list. Yes indicates the licensed professional is
exempt from Worker’s Comp. No indicates they are not.

Worker’s Comp
Expiration Date

Use the picker to enter the expiration date of the Worker’s Compensation Insurance
Policy.

Worker’s Comp Policy #

Enter the policy number for the Worker’s Compensation Insurance. Limit of 30
characters.

Zip

Enter the ZIP code of the licensed professional.

Searching for a Licensed Professional
You can search for any licensed professional registered on your system, including professionals that you
previously disabled. For example, you might need to search for a professional to update information or to
change the status of the professional.
Note:
To see a list of all the professionals on your system, click Submit without entering details about an individual
professional.

To search for a licensed professional
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose People > Licensed Professional.
3. Complete the License Type field.
4. Complete the fields specific to the license type you chose.
5. For a list of common fields, see Licensed Professional Fields.
6. Do one of the following:
•

If you do not want to search using the license type specific fields, click Submit under the City field.

•

If you want to search by license-type information, complete the fields at the bottom of the window
and click Submit at the bottom of the window.
Civic Platform displays the results for your search.

Editing a Licensed Professional
You can change information about individual professionals as necessary. For example, you might need to
change a professional’s status to “disabled” after the professional’s license expires. A licensed professional
can have the same license number assigned to multiple license types, such as Electrical, Mechanical, and
Plumbing licenses. To duplicate a license number for a new professional license type, you must add a new
licensed professional record.
Note:
Depending on how you set up this licensed professional type, you might see additional attributes and fields
in addition to the standard attributes listed here.

To edit a professional

| Part 2: Setting Up Agencies, Organizations, and People | 196

1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose People > Licensed Professional.
3. Search for the professional that you want to edit. For instructions, see Searching for a Licensed
Professional.
4. Click the red dot next the professional you want to edit.
Civic Platform displays the Licensed Professional—Edit window.
5. Complete the fields as necessary. For a list of common fields, see Licensed Professional Fields.
6. Complete the fields specific to the license type you are working with.
7. Click Save.

Managing Contacts
Civic Platform divides contacts into two categories: reference contacts that serve as the reference
database, and daily contacts that users add to records. Best practice is to manage contact types by
defining only generic reference contact types, such as Individual and Organization. Record each individual
or organization as one reference contact. Then link reference contacts to records in various roles, such
as Applicant, License Holder, etc. This enables you to easily track all the transactional and reference
information about every individual and organization.
Before users add new reference contacts or associate contacts with records, you must set a number
of Standard Choices to define the ways of managing contacts in Civic Platform, such as CONTACT
TYPE, AUTO_SYNC_PEOPLE, and INDIVIDUAL_CONTACT_MATCH_ CRITERIA. For instructions on
configuring the Standard Choices, refer to the Accela Civic Platform Configuration Reference.
Users often look up existing reference contacts to associate the desired one with a record. You can specify
contact identity fields to guarantee the uniqueness of each reference contact, and specify contact address
identity fields to guarantee the uniqueness of each contact address in each contact.
By default, users have full access to all contact types from within all modules and the reference Contact
portlet. If a contact type is available for a few modules, then you can limit the use of the contact type by
module through specifying the applicable module in the Contact Type Setting portlet. For more information,
see Setting Up Security Policies.
Topics
•

Managing Contact Identifier Settings

•

Adding a Contact

•

Searching for a Contact

•

Editing a Contact

•

Enabling Close-Match Searches

Managing Contact Identifier Settings
Topics
•

Managing Contact Address Identifier Fields

•

Managing Reference Contact Identifier Fields

| Part 2: Setting Up Agencies, Organizations, and People | 197

Managing Contact Address Identifier Fields
You can configure one or more contact address identifier fields. Civic Platform checks whether a contact
address is a duplicate of an existing active contact address in the same contact by comparing their
identifier field values (joined by AND), and prevents users from saving duplicate contact addresses.
By default, there are no contact address identifier fields in Civic Platform. After you add several contact
address identifier fields, Civic Platform executes the duplicate contact address checking in the following
ways.
•

When users add or update a duplicate contact address to a contact, an error message displays
indicating the conflict.

•

When you sync a record contact with a reference contact, if an address in the record contact duplicates
with an address in the reference contact, the address in the reference contact replaces the contact
address.

•

When users add new contact addresses to replace old addresses, if the new address duplicates
with an active one in the same contact, Civic Platform uses the existing active contact address as a
replacement

•

In previous versions, users were able to create duplicate contact addresses. Civic Platform
automatically filters duplicate contact addresses when users look up and select contact addresses to
add in records.

To manage the contact address identifier fields
1. Access the Identity Settings portlet (Accessing the Contact Identity Settings Portlet).
Civic Platform displays the Identity Settings portlet.
2. Expand the Identity Settings node in the navigation tree, and then click Contact Address.
The Identity Settings portlet displays the list of contact address fields that you previously set as identifier
fields.

All the contact address identifier fields, joined by AND, work as one identifier in duplicate contact
address checks.
3. To modify the selection of identifier fields
a. Click the field selector next to the Address Fields for Duplicate Check label.
Civic Platform displays the list of contact address fields that you can set as identifier fields. The
available field options include all the contact address fields, except for Status, Primary, Validate, and
Contact Address ID.

| Part 2: Setting Up Agencies, Organizations, and People | 198

b. Select the fields you want to set as identifiers.
c. Click the Close button.
Civic Platform updates the contact address identifier fields according to your latest selection.
To clear the selection of identifier fields
a. Click the recycle bin icon next to the field selector.
Civic Platform clears the current selection of identifier fields.
4. Click the Save button to save the changes.

Managing Reference Contact Identifier Fields
You can choose to define a number of contact fields as reference contact identifier fields. Table 32:
Possible Reference Contact Identifier Fields lists your options. Civic Platform checks whether a reference
contact is a duplicate of an existing active contact by comparing their identifier field values and thus
prevents users from saving duplicate contacts. To set the comparison rule with the identifiers, Civic
Platform joins by OR the contact fields that you add separately as identifiers, and joins by AND the fields
that you combine and add as one identifier.
By default, there are no contact identifier fields in Civic Platform. After you add several contact identifier
fields, Civic Platform executes the duplicate reference contact checking in the following way.
•

When users add or update a reference contact that has duplicate identifier field value with an existing
reference contact, an error message displays indicating the conflict.

To manage the contact identifier fields
1. Access the Identity Settings portlet (Accessing the Contact Identity Settings Portlet).
Civic Platform displays the Identity Settings portlet.
2. Expand the Identity Settings node in the navigation tree, and then click Reference Contact.
The Identity Settings portlet displays the list of identifier fields.

| Part 2: Setting Up Agencies, Organizations, and People | 199

3. To add an identifier field, click Look Up to add a contact field from Table 32: Possible Reference
Contact Identifier Fields.
Civic Platform displays the list of fields you can add as identifier fields.

4. Select the field, and then click Select. If you want two or more fields to work as one identifier (joined by
AND), select several fields, and then click Select & Combine.
Civic Platform adds the selected fields as identifiers. If a user attempts to add a reference contact that
contains an email address that exists in another contact record, Civic Platform prevents the user from
saving the duplicate contact and displays the following notification.

5. To remove an identifier field, select the identifier field and click Delete.
Civic Platform no longer regards the field as an identifier field.
Table 32: Possible Reference Contact Identifier Fields

Identifier Field

Description

Email

The email address of the contact.

| Part 2: Setting Up Agencies, Organizations, and People | 200

Identifier Field

Description

FEIN

This acronym stands for Federal Employer Identification Number and identifies
a business for tax purposes. This field is only active when the Contact Type
selected is Organization.

Driver’s License Number

The driver’s license number of the contact.

Driver’s License State

The driver’s license state of the contact.

Passport Number

The contact’s passport number.

SSN

The contact’s Social Security Number.
This field is only active when the Contact Type selected is Individual.

State ID Number

The contact’s state ID number.

Adding a Contact
To enable users to search for a contact, you must add the contact to your reference database. Your
reference database acts like a library that lets users search for certain types of stored information. For
example, users might need to search for an existing contact when creating a new application.
Note:
Depending on how you set up this contact type, you might see additional attributes and fields. You can add
or edit attributes using the people template.

To add a contact
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose People > Contact.
3. Click Add.
4. Use the Contact Type drop-down list to choose the appropriate contact type.
Civic Platform displays fields specific to the contact type you chose.
5. Complete the fields as described in Table 33: Contact Fields.
6. Click Save.
Table 33: Contact Fields

Address

Enter up to three lines of the contact’s address information.

City

Enter the city name or click the Get City button to choose from a standard list of cities.

Comment

Enter any comments regarding the contact.

Contact Relationship

Choose the appropriate relationship between the contact and the application.

Contact Type

Choose the appropriate contact type.

Country

Enter the country.

Email

Enter the contact’s email address.

Fax

Enter the contact’s fax number.

FEIN

Federal Employer Identification Number (FEIN) associated with the contact. You can
leverage this field when performing searches for a record or eliminating duplicate
contact entries in your database.

| Part 2: Setting Up Agencies, Organizations, and People | 201

Flag

Enter the status of the hold.
For example, if the hold is still active, enter “Y” for Yes.

Hold Code

If your agency places holds on certain contacts, enter the code that identifies the hold
here. For example, if a contact has bad credit, enter “Bad Credit.”

Hold Description

If you enter a hold code, enter a description to help identify the code. For example,
enter “Contact has repeatedly failed to pay bills.”

ID

Enter any other form of ID to help you identify the contact. For example, enter a driver
license number of a social security number.

Name

Enter the First, Middle, or Last name of the contact.

Organization Name

Enter the name of the organization to which the contact belongs.

Phone

Enter one or two phone numbers of the contact.

SSN

Contact Social Security Number. After saving, the number only displays the last 4
digits. For example ***-**-1234. You can leverage this field when performing searches
for a record or eliminating duplicate contact entries in your database.

State

Choose the state.

Status

If you want to let users search for this contact, select Enable; otherwise, select
Disable.

Title

Enter the contact’s title. A title indicates an official position or professional/academic
qualification. For example: Mr., Mrs., Ms., Officer, RN, PhD, DDS, Professor, Judge, or
Notary. The Title field is a text field.

Zip

Enter the contact’s ZIP code.

Searching for a Contact
You can search for any contact on your system, including contacts that you previously disabled. For
example, you might need to search for a contact to update information or to change the status of the
contact.
Note:
To see a list of all the contacts on your system, click Submit without entering details about an individual
contact.

To search for a contact
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose People > Contact.
3. Complete the fields as described in Table 33: Contact Fields.
4. Do one of the following:
•

If you do not want to search using the contact type specific fields, click Submit under the City field.

•

If you want to search by contact-type information, enter the information in the fields at the bottom of
the window and Click Submit.
Civic Platform displays the results of your search.

Editing a Contact
After you add a contact to your reference database, you might need to change certain information about
the contact.

| Part 2: Setting Up Agencies, Organizations, and People | 202

Note:
Depending on how you set up this contact type, you might see additional attributes or fields in addition to the
standard attributes listed here.

To edit a contact
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose People > Contact.
3. Search for the contact that you want.
4. Complete the fields as described in Table 33: Contact Fields.
5. Click Save.

Enabling Close-Match Searches
Configure contact match criteria to enable close-match searching in Civic Platform, Citizen Access, and
Mobile Office.
Close-match searching enables users to locate reference contacts that do not exactly match their search
criteria, but come close. The standard search function returns reference contacts that exactly match user’s
search criteria. In some cases, users might find that the search results do not include the contacts they
intend to find, for example, if the user mistypes the criteria. In that case, users can click the Close Matches
button to locate reference contacts that do not exactly match their search criteria, but come close.
To enable close-match searching, configure the following standard choices in the Standard Choices portlet
in the Setup Admin:
•

ENABLE_CONTACT_ADDRESS

•

INDIVIDUAL_CONTACT_MATCH_CRITERIA

•

ORGANIZATION_CONTACT_MATCH_CRITERIA

See the Civic Platform Configuration Reference for more information about Standard Choices.

Creating a Public User Account
Topics
•

Adding a New Public User Account

•

Using a Reference Professional to Create a Public User

Adding a New Public User Account
To create a registered public user account
1. Access the Public User portlet (Accessing the Public User Portlet).
2. Click New.
Civic Platform displays a blank registration template in the detail portlet.

| Part 2: Setting Up Agencies, Organizations, and People | 203

3. Complete the registration fields. For a description for each field, see Table 34: Public User Registration
Fields.
4. Click Submit.
Citizen Access displays the new registration information in the Public User list portlet.
5. Associate the public user with a reference contact (Managing Contacts Associated with Public User
Accounts). If a public user does not have an association with a reference contact, the account remains
disabled in the registered agency.
Table 34: Public User Registration Fields

Civic Platform User Account

This field displays the Civic Platform user login ID in read-only. When a
public user registers an account from Citizen Access or when you create an
account from the Public User portlet, Civic Platform automatically creates the
corresponding Civic Platform user account with the login ID numbered like
PUBLICUSER{seq_number}. Civic Platform automatically does the following in
user profiles for such user accounts:Marks the user as External UserSets the
department to ///PUBLIC/NA/NA/NA.Categorizes
the user into the default user group for public users in each module. Within each
assigned module, the external inspector is available for inspection assignments
and scheduling. Sets the inspector status to “Enable”, if the user account is for a
contract inspector or a self-certified inspector.
For the Civic Platform user accounts of contract inspectors and self-certified
inspectors, your agency can update the user profiles manually or using an
EMSE script.
For example, use an EMSE script either with the AddContractLicenseAfter or
RegistrationSubmitAfter event to set the district that the inspector is responsible
for, set the discipline based on the inspector’s license, and so forth.
The AddContractLicenseAfter event occurs after you associate a licensed
professional with the public user account of an external inspector through the
Public User portlet and the association takes affect. The RegistrationSubmitAfter
event occurs after a public user submits a registration and also occurs after
the external inspector associates a licensed professional with his public user
account through Citizen Access.
For more information about the Civic Platform user account, see Configuring
Organizations, Departments, and Users.

| Part 2: Setting Up Agencies, Organizations, and People | 204

Account Type

There are five account types of public users.
Citizen: Citizens are common public users in your agency. Citizen users access
Citizen Access to apply for and pay for permits, schedule inspections, and find
information. Citizen is the default in this field.
Authorized Agent: Authorized agents conduct authorized service sales (for
example, fishing and hunting license sales) in Citizen Access.
Authorized Agent Clerk: When authorized agents manage their accounts in
Citizen Access, they can authorize clerks to conduct authorized service sales.
You can view, but cannot create authorized agent clerks in the Public User
portlet.
Self-Certified Inspector: Self-certified inspectors upload inspection results
using Citizen Access. Self-certified inspectors are certified or licensed
professionals so you must associate at least one licensed professional to the
public user account from the Public User portlet. You can also let self-certified
inspectors themselves associate licensed professionals with their public user
accounts through Citizen Access. For details, see “Understanding Inspectors” in
the the Accela Civic Platform Concepts Guide.
Contract Inspector: Contract inspectors upload inspection results using
Citizen Access. Contract inspectors are certified or licensed professionals or
businesses so you must associate at least one licensed professional to the
public user account from the Public User portlet. You can also let contract
inspectors themselves associate licensed professionals with their public user
accounts through Citizen Access. For details, see “Understanding Inspectors”
the Accela Civic Platform Concepts Guide.

Cell Phone

The public user’s cellular phone number.

Change Password at Login

Select Yes to ask the public user to change password at the first time login.
Otherwise, select No.

Email

The public user’s email address. By default, this is the User ID. You can modify
both the User ID and the email address separately.

Password

The public user’s password used when logging in to Citizen Access.
Note: If your agency has configured password rules for the public users, then
there is a password requirements link and a strength indicator. The password
strength indicator displays a visual representation of the password security
strength against the agency's minimum password requirements.
If you have trouble entering a valid password, click the Requirements link to
view the agency’s minimum password requirements.

Confirm Password

A second entry to verify the user’s password.

Password Request Answer

Enter the answer to the password request question. The field maps to the
Answer field on the registration page in Citizen Access.

| Part 2: Setting Up Agencies, Organizations, and People | 205

Password Request Question

Enter one or more password request questions. The field maps to the Enter
Security Question field on the registration page in Citizen Access. The
Authentication by Security Question setting in Citizen Access Admin determines
the number of password request questions to display in this field.
If an account has password request questions and answers and the public user
forgets their password, Citizen Access requires the user to answer one of the
questions to validate the user.
If an account has no password request question, Citizen Access only requires
the user to specify the email address in the reset-password request.
Password Request Questions may be a non-required field in Civic Platform.
However, if a user logs in to Citizen Access with an account that has no
password request question, an Update Security Question and Answer section
displays for the user to specify one or more security questions and answers.

Receive SMS Message

Mark or clear the check box to enable or disable SMS messaging for the public
users. This feature applies to agencies that implement custom SMS interfaces.

User ID

The user identification for logging in to Citizen Access. The default User ID is
the email address provided in registration. You can modify this field to create a
unique User ID.

Using a Reference Professional to Create a Public User
You can configure the EMSE sample script REFLICPROFADDAFTER to create a public user account to
associate with a licensed professional a user enters at application-intake. The reference professional must
have an email address associated with it, for this feature to work. After the intake process, EMSE initiates
the public user account registration process for the referenced professional associated with the email
address. Civic Platform sends an activation email. When you activate the account, Civic Platform sends the
registration confirmation email to the professional. For information on the public user registration process,
including the configurations for the activation email, refer to the “Registration” chapter in the Citizen Access
Administrator Guide.
Note:
An Accela Implementation specialist or a system administrator who has received training from an Accela
Implementation specialist or a Product Manager should write the script for this feature. Improperly written
scripts can seriously damage your system by incorrectly altering or deleting data for many records. For
information on writing and implementing scripts, see the Accela Civic Platform Scripting Guide.

Searching for a Public User Account
To search for a public user account
1. Access the Public User portlet (Accessing the Public User Portlet).
2. Click Search.
Civic Platform displays a search form.
3. Enter any search criteria in the appropriate fields.
You can search by public user registration fields, and a few contact standard fields. Civic Platform
searches for the public users that meet the specified registration criteria, and who have associations
with a contact that meets the specified contact criteria. For a description of the fields, see Table 35:
Fields for Searching Public User Accounts.

| Part 2: Setting Up Agencies, Organizations, and People | 206

4. Click Submit.
Civic Platform displays the list of public users that match your search criteria.
Table 35: Fields for Searching Public User Accounts

Account Type

There are five account types of public users.Citizen: Citizens are common public
users in your agency. Citizen users access Citizen Access to apply for and pay for
permits, schedule inspections, and to find information. Citizen is the default in this field.
Authorized Agent: Authorized agents conduct authorized service sales (for example,
fishing and hunting license sales) in Citizen Access. Authorized Agent Clerk: When
authorized agents manage their accounts in Citizen Access, they can authorize clerks
to conduct authorized service sales. You can view, but cannot create authorized agent
clerks in the Public User portlet.Self-Certified Inspector: Self-certified inspectors
upload inspection results using Citizen Access. Self-certified inspectors are certified
or licensed professionals so you must associate at least one licensed professional
to the public user account from the Public User portlet. You can also let self-certified
inspectors themselves associate licensed professionals with their public user accounts
through Citizen Access. For details, see “Understanding Inspectors” in the Accela
Civic Platform Concepts Guide.Contract Inspector: Contract inspectors upload
inspection results using Citizen Access. Contract inspectors are certified or licensed
professionals or businesses so you must associate at least one licensed professional
to the public user account from the Public User portlet. You can also let contract
inspectors themselves associate licensed professionals with their public user accounts
through Citizen Access. For details, see “Understanding Inspectors” in the Accela Civic
Platform Concepts Guide.

Address Line 2

The address information of the contact that has an association with the public user.
You can have up to three lines of address information.

Authorized Agent

If you select “Authorized Agent Clerk” option in the Account Type field, you can specify
the name of the authorized agent who created the authorized agent clerks.
Civic Platform supports fuzzy string searching on the field.

Birth Date

The birth date of the contact associated with the public user.

Change Password at
Login

Select Yes to ask the public user to change password at the first time login. Otherwise,
select No.

City

The city of the contact associated with the public user.

Confirm Password

The public user’s password. A password confirmation/verification.

Country/Region

The country or region of the contact associated with the public user.

DBA/Trade Name

The DBA or trade name of the contact associated with the public user. DBA is an
acronym for Doing Business As.

FEIN

The FEIN information of the contact associated with the public user. FEIN is an
acronym for Federal Employer Identification Number; it identifies a business for tax
purposes.

First Name

The first name of the contact associated with the public user.

Gender

The gender of the contact associated with the public user.

Last Name

The last name of the contact associated with the public user.

Middle Name

The middle name of the contact associated with the public user.

Organization Name

The organization name of the contact associated with the public user.

P.O.Box

The post office box number of the contact associated with the public user.

| Part 2: Setting Up Agencies, Organizations, and People | 207

Password

The public user’s password used when logging in to Citizen Access.
Note:
If your agency has configured password rules for the public users, then there
is a password strength indicator and a requirements link. The password
strength indicator displays a visual representation of the password security
strength against the agency's minimum password requirements.
If you experience trouble entering a valid password, click the Requirements link to view
the agency’s minimum password requirements.

Password request
answer

The answer to the password request question.

Password request
question

Choose a password request question from the drop-down list. If a public user forgets
their password, they can answer this question. If the answer is correct, Civic Platform
emails their password to the email provided from registration.

Phone 3

The phone of the contact associated with the public user.

Preferred Channel

The method by which the contact associated with the public user, prefers to receive
notifications, for example by phone, email, fax, or postal mail.

Public User’s Cell Phone The public user’s cellular phone number.
Public User’s Email

The public user’s email address. By default, this is the User ID. You can modify both
the User ID and the email address separately.

Receive SMS Message

Click this option to enable or disable SMS messaging for the public users. This feature
applies to agencies that implement custom SMS interfaces.

Salutation

The salutation to address the public user or the contact associated with the public user,
for example Mr. or Ms.

SSN

The SSN of the contact associated with the public user.

State

The state of the contact associated with the public user.

Street Address

The street address of the contact.

Telephone

The telephone of the contact associated with the public user.

Type

The contact type of the contact associated with the public user.

User ID

The user identification for logging in to Citizen Access. The default User ID is the email
address provided in registration. You can modify this field to create a unique User ID.

Zip Code

The ZIP code of the contact associated with the public user.

Managing Accounts for Registered Agencies
To register a public user in an agency, you must associate at least one enabled reference contact in the
settagency with the public user account, and then enable and activate the public user account for the
agency.
Topics
•

Managing Contacts Associated with Public User Accounts

•

Enabling or Disabling an Account

•

Activating a Public User Account

| Part 2: Setting Up Agencies, Organizations, and People | 208

Managing Contacts Associated with Public User Accounts
Follow the instructions below to manage the associations between public user accounts and contacts. You
can associate a contact with a public user; approve, reject, or remove the association; or set a contact as
the account owner of a public user.
Topics
•

Associating Contacts with a Public User Account

•

Setting an Associated Contact as the Account Owner

Associating Contacts with a Public User Account
To associate contacts with a public user account
1. Access the Public User portlet (Accessing the Public User Portlet).
2. Select the user account you want to edit.
Civic Platform displays the public user account registration details.
3. Click the Contact tab.
Civic Platform displays the Contact list portlet.
4. Do any of the following:
•

To search and associate a contact with a public user account.
1. Click Look Up.
Civic Platform displays the contact search form.
2. Enter your search criteria and then click Submit.
Civic Platform displays a list of reference contacts meeting the search criteria.
3. If you cannot find the contact in the results list, click Close Matches to view the close matches to
the search criteria, and select the contact from the close match contacts.
The Standard Choices INDIVIDUAL_CONTACT_MATCH_CRITERIA and
ORGANIZATION_CONTACT_MATCH_CRITERIA define the close match criteria respectively
for individual contacts and reference contacts. See the Accela Civic Platform Configuration
Reference for more information about Standard Choices.
4. Select the contact that you want to associate with the public user.
5. Click Connect.
Civic Platform links the contact with the public user account.
For contacts directly added in the public user portlet, Civic Platform approves the association by
default.

•

To approve the association between a contact and the public user account.
1. Select the contact.
2. Click Approve.

•

To reject the association between a contact and the public user account.
1. Select the contact that you do not want to approve the association.
2. Click Reject.

| Part 2: Setting Up Agencies, Organizations, and People | 209

Civic Platform rejects the association.
Note:
A public user account must have at least one approved contact association to stay enabled, so
you cannot reject an association if it is the only one with the approved status in an enabled public
user account.

•

To delete the association between a contact and the public user account.
1. Select the contact that you want to remove.
2. Click Delete.
Civic Platform deletes the contact from the public user account.

Setting an Associated Contact as the Account Owner
A public user may be associated with more than one contact, but only one contact can be the account
owner of the public user. Public users can designate or change the account owner in their accounts on the
Account Management page in Citizen Access. You can also designate or change the account owner of a
public user account following the instruction in this section.
Note:
If your agency enables the Automatically Activate New Association feature in Citizen Access, the first
contact added to an account is the account owner of the account by default. If an account is created in a
version earlier than 7.3 FP2 or with the Automatically Activate New Association feature disabled, there is no
default account owner in the account.

When you add variables (for example, $$firstName$$, $$middleName$$, $$lastName$$) about the public
user contact information in notification templates, Civic Platform uses the following priority order to decide
from which contact, out of all the contacts that have approved association with the public user, to get the
variable values:
•

Priority one, the account owner of the public user

•

Priority two, the first individual contact that has the same email address as the account

•

Priority three, the first organization contact that has the same email address as the account

•

Priority four, the first individual contact that has approved association with the account

•

Priority five, the first organization contact that has approved association with the account

For more information about how to create notification templates, seeWorking with Communication Manager
.
To change the account owner of a public user
1. Access the Public User portlet (Accessing the Public User Portlet), and select the user account you
want to edit.
Civic Platform displays the public user account registration details.
2. Click the Contact tab.
Civic Platform displays the Contact list portlet.
3. Select an approved contact which you want to set as the account owner of the public user.
4. Click Set as account owner.

| Part 2: Setting Up Agencies, Organizations, and People | 210

Civic Platform changes the account owner of the public user to be the current contact.

Enabling or Disabling an Account
To enable or disable a public user account
1. Access the Public User portlet (Accessing the Public User Portlet).
2. Click the user account which requires a change of status.
Civic Platform displays the public user account registration details in the detail portlet.
3. Click the Registered Agencies record tab.
4. Select the Agency that requires a change status.

Note:
If you have enabled the multiple agency administration feature (see Setting Up Cross-Agency
Operations), after a public user attempts to log in to Citizen Access hosted by a different agency from the
one that created the account, you can enable and activate the public user account in the new agency.
If you enable an authorized agency or authorized agent clerk account in a different agency from the one
that created the account, the account type is Citizen, not Authorized Agent nor Authorized Agent Clerk, in
the new agency.

5. Click one of the following buttons to change the status of an account.
Disable Account. Click this button to disable the public user for the agency. Disable, in this context,
means that the public user is not able to log in to Citizen Access.
Note:
If you disable an authorized agent account, the authorized agent account becomes inactive, and all the
authorized agent clerk accounts created by the agent account become inactive as well.

| Part 2: Setting Up Agencies, Organizations, and People | 211

Enable Account. Click this button to enable the public user to use the account for the agency.
Civic Platform displays a message indicating a status change.

Activating a Public User Account
Topics
•

Activating the Public User Account

•

Using EMSE to Activate a Public User

Activating the Public User Account
If your agency does not use the activation email, your agency can activate an account manually for a user
in the Public User portlet. For example, if an account requires additional information before the agency
allows activation, you can manually activate their account for public users after the additional information
arrives at the agency in the Public User portlet.
To activate a public user account
1. Access the Public User portlet (Accessing the Public User Portlet).
2. Click the user account which requires activation.
Civic Platform displays the public user account registration details in the detail portlet.
3. Click the Registered Agencies record tab.
4. Select the Agency that requires activation for this account.
5. Click Activate Account.

Civic Platform displays the account is active and the user has permission to log in to Citizen Access for
that agency.

| Part 2: Setting Up Agencies, Organizations, and People | 212

Using EMSE to Activate a Public User
Your agency can activate a public user account using an EMSE script. The script works with the
ApplicationSubmitAfter event to activate the public user in the agency, activate licenses for the public user,
and send out the activation email to the user. For example, an applicant comes to the counter to apply for
a license. While submitting the application users receive the option of creating a Citizen Access account so
that they can track progress. The counter clerk selects the option “Create online account.” EMSE creates
the online account and email the link, login, and password to the applicant.
For more information on EMSE scripts, see the Accela Civic Platform Scripting Guide.
To activate a public user account through EMSE scripting
1. Refer to the sample EMSE script below to activate a public user account, activate any licenses
associated with the account, and send the activation emails to the public user.
//Get the Service Provide Code.
var servProvCode = Accela Automation.env.getValue(“servProvCode”);
//Get the Universally Unique Identifier for public user verification.
var uuid= Accela Automation.env.getValue(“UUID”);
//Activate Public User by servProvCode and uuid.
var result = Accela
Automation.publicUser.activatePublicUser(servProvCode,uuid);
if(result.getSuccess())
{
//If Activate Public User Successefully, then print the User ID.
Accela Automation.print(result.getOutput());
}
else
{
//If Activate fail, then print the error message.
Accela Automation.print(result.getErrorMessage());
}

| Part 2: Setting Up Agencies, Organizations, and People | 213

Editing a Public User Account
You can make edits to a public user account if it requires modification. For example, if a user wants to
reset their password or change their user ID, you can update their user account registration information
with the specified request.
To edit a registered public user account
1. Access the Public User portlet (Accessing the Public User Portlet).
2. Click the user account that you want to edit from the PublicUser list portlet.
Civic Platform displays the public user account registration details in the detail portlet.
3. Enter the modifications in the applicable fields. For a description of each field, see Table 34: Public
User Registration Fields.
4. Click Submit.
5. Click Registered Agencies record tab.
6. Click the appropriate button from the toolbar to reflect the desired status for the account. For more
information about account status, see Changing a Public User Password.

Associating Addresses, Parcels, and Owners with Public User
Accounts
Public users can create public user accounts when they register to access Citizen Access. Administrators
can then link the public user account to addresses, parcels, and owners, exposing features as appropriate.
This linked relationship is particularly useful when the public user initiates an application in Citizen Access.
He or she can use the Auto-Fill drop-down list to populate the address details into the application intake
form with one click.

Associating an Address with an Account
After you have created address records, you can use the Associated Public User tab to associate one or
more public users to an address, or to disassociate one or more public users from an address.
Public users can create public user accounts when they register to access Citizen Access. Administrators
can then link the public user account to addresses, exposing features as appropriate. This linked
relationship is particularly useful when the public user initiates an application in Citizen Access. He or she
can use the Auto-Fill drop-down list to populate the address details into the application intake form with one
click.
To associate an address with a public user account
1. Access the Public User portlet (Accessing the Public User Portlet).
2. Select the user account to which you want to edit.
Civic Platform displays the public user account registration details.

| Part 2: Setting Up Agencies, Organizations, and People | 214

3. Click the Address tab.
Civic Platform displays the Address list portlet.
4. Click Look Up.
Civic Platform displays the Address search form.
5. Enter your search criteria and then click Submit.
Civic Platform displays a list of addresses meeting the search criteria.
6. Select the address to which you want to associate the public user.
7. Click Connect.
Civic Platform links the address with the public user account.
8. Do any of the following:
•

To view address details, click the link for the address that you want to view.

•

To remove the link between an address and a public user, select the address you want to remove
and click Delete.

Associating a Parcel with an Account
After you have created parcel records, you can use the Associated Public User tab to associate one or
more public users to a parcel, or to disassociate one or more public users from a parcel.
Public users can create a public user account when they register with an agency through Citizen Access.
Administrators can then link the public user account to parcels, exposing features as appropriate. This
linked relationship is particularly useful when the public user initiates an application in Citizen Access. He
or she can use the Auto-Fill drop-down list to populate the parcel details into the application intake form
with one click.
To associate a parcel with a public user account
1. Access the Public User portlet (Accessing the Public User Portlet).
2. Select the user account to which you want to edit.
Civic Platform displays the public user account registration details.

| Part 2: Setting Up Agencies, Organizations, and People | 215

3. Click the Parcel tab.
Civic Platform displays the Parcel list portlet.
4. Click Look Up.
Civic Platform displays the Parcel search form.
5. Enter your search criteria and then click Submit.
Civic Platform displays a list of parcels meeting the search criteria.
6. Select the parcel to which you want to associate the public user.
7. Click Connect.
Civic Platform links the parcel with the public user account.
8. Do any of the following:
•

To view parcel details, click the link for the parcel that you want to view.

•

To remove the link between a parcel and a public user, select the parcel you want to remove and
click Delete.

Associating an Owner with an Account
For more information about Owners, refer to “Managing Owners” in the Accela Civic Platform User Guide.
For more information, refer to “User Role Definitions” in the “Module Settings” section of the Citizen Access
Administrator Guide.
To associate an owner with a public user account
1. Access the Public User portlet (Accessing the Public User Portlet).
2. Select the user account to which you want to edit.
Civic Platform displays the public user account registration details.

3. Click the Owner record tab.

| Part 2: Setting Up Agencies, Organizations, and People | 216

Civic Platform displays the owner list portlet.
4. Click Look Up.
Civic Platform displays the owner search form.
5. Enter your search criteria and then click Submit.
Civic Platform displays a list of Owners meeting the search criteria.
6. Select the owner to which you want to associate the publicuser.
7. Click Connect.
Civic Platform links the Owner with the publicuser account.
8. Do any of the following:
•

To view owner details, click the link for the owner that you want to view.

•

To remove the link between an owner and a public user, select the owner you want to remove and
click Delete.

Changing a Public User Password
When users request that you reset their password in person or by phone, ask them their security question
and verify the user’s identity. Then, send the user the password email which contains the new Civic
Platform generated password. The user’s email address must be current for this to work properly.
If you want to customize the text of the email associated with changing the user password, refer to “Email
Settings” in the “Creating Records” section of the Citizen Access Administrator Guide.
To reset a user password
1. Access the Public User portlet (Accessing the Public User Portlet).
2. Select the user which requires a resetting of their password.
Civic Platform displays user information in the Public User detail portlet.

3. Click Send Password to reset the password.
Civic Platform displays a message indicating that it sent an email to the user with new password
information.

| Part 2: Setting Up Agencies, Organizations, and People | 217

Managing Licenses Associated with Public User Accounts
This feature requires you to customize the content of the renewal and new license emails in Citizen Access
Admin on the General Settings page. For more information about customizing the content of the emails,
see “Email Settings” in the Citizen Access Administrator Guide.
After you configure the emails, the agency can receive email notification that a license requires approval.
Follow the instructions below to approve or reject a license for an account.
To manage licenses associated with a public user account
1. Access the Public User portlet (Accessing the Public User Portlet).
2. Choose the Account which requires the license approval.
3. Click the License tab.
Civic Platform displays a list of Licenses that are pending, approved or rejected for the account.

4. Do any of the following:
•

Add a license to a public user account.
1. Click New.
2. Select a license type, enter a license number, and then click Submit.
Civic Platform adds the license to the public user account.

| Part 2: Setting Up Agencies, Organizations, and People | 218

•

Search and associate a license with a public user account.
1. Click Look Up.
Civic Platform displays the license search form.
2. Enter your search criteria and then click Submit.
Civic Platform displays a list of licenses meeting the search criteria.
3. Select the license to which you want to associate the public user.
4. Click Connect.
Civic Platform links the license with the public user account.

•

Approve a license.
1. Select the licenses that require approval.
2. Click Approve.

•

Reject a license.
1. Select the licenses that do not meet license requirements.
2. Click Reject.
Civic Platform sends a confirmation email to the account.

| Part 2: Setting Up Agencies, Organizations, and People | 219

Setting Up Cross-Agency Operations
If you manage multiple agencies you must set up the participating agencies individually first. We
recommend that you work with the Accela Services team to formulate and incorporate best practices in the
planning and establishment of the agencies.
For more information, see the “Agencies and Functions” chapter in the Civic Platform On-premise
Administrator Supplement.
Click a topic title below for full details.
Related Information
Enabling Multiple Agency Administration
Sharing APO and Contacts Across Agencies
Delegate User Management
Multi-Agency Service Management
Record Creation Across Agencies

Enabling Multiple Agency Administration
You can enable multiple agency administration (aka Super Agency) by setting up the agencies in a
common database.
When you have multiple agencies that work together, Civic Platform offers a way to brand each agency so
that users can easily recognize the source agency of information. You do this by associating an image or
logo with a Custom Fields Subgroup in the Logo portlets of Civic Platform.

Delegate User Management
For instructions on how to create a delegate user specific to a Citizen Access public user group, so that
they have permissions to create records for multiple agencies, see Creating a Delegate Account for a
Public User Group.
Topics
•

Creating a Delegate User

•

Creating a Delegate Account for a Public User Group

•

Enabling Delegate User Agency Access

•

Searching and Editing Delegate User Information

•

Viewing Delegate User History

•

Toggling between Agency Locations

Creating a Delegate User
Civic Platform uses delegate user accounts, for users external to a particular agency, to enable user to
access information across multiple agencies. The external user, for which you set up a delegate user

| Part 2: Setting Up Agencies, Organizations, and People | 220

account, can access agency data (as a delegate) and super-agency data, for which they have a regular
user account. You can relate the delegate user account to only one external agency user.
Example Use Case
The State of Oregon functions as a super agency for the Marion County agency, the city of Portland
agency, and the city of Sandy agency. Betty Greenwood, an Oregon user, needs to access Marion County
and Portland information, but not Sandy information. Marion County and Portland administrators each
create a regular user account for Betty Greenwood, using Betty’s unique user ID from Oregon, and
designate this user account as a delegate user account for their agency.
from Civic Platform, Betty can now toggle between the Oregon, Marion County, and Portland agencies, but
not the Sandy agency, to work with information owned by those agencies. The Marion County and Portland
administrators can change or revoke Betty’s access at any time; Civic Platform tracks changes to Betty’s
delegate user account.
To create a delegate user
1. Create a user account at your agency, designated for an external agency user, and then configure the
permissions.
a. Access the Classic Administration page. Accessing Classic Administration
b. Navigate to User Profile > User.
c. Click Add and complete the user fields. Refer to Adding a User.
d. In the User Group/Privilege section, select each module that you want the user to be able to access.
e. Assign which user group the external user belongs to for each module.
f. Click Save.
2. Define the Delegate user account. This account links the agency account with the external agency user
account.
a. Access the Delegate User portlet.
b. Click New.
Civic Platform displays the New Delegate User portlet.
c. Complete the fields as described in Delegate User Fields.
d. Click Save.
Table 36: Delegate User Fields

Allow Delegate User
Login

Select this option if you want to allow delegate users to log in to your agency.

Delegate User ID

The delegate user’s User ID that your agency created. Click the picker icon to
search and select the User ID. Refer to .

Super Agency

Select the delegate user’s primary agency location.

Parent User ID

Enter the delegate user’s User ID at the primary agency. Click the picker icon to
search and select this information.

Status

Select the user’s status. Select Enable to activate or Disable to deactivate the
delegate user account.

| Part 2: Setting Up Agencies, Organizations, and People | 221

Creating a Delegate Account for a Public User Group
You can enable public users of Citizen Access to view information across agencies, or request services
from multiple agencies, by creating delegate user accounts in the public user group.
Note:
Permissions do not apply to public users of Citizen Access.

To create a delegate account for a public user group
1. Create a user account at your agency designated for the public user group. You do not need to assign
permissions.
a. Access the Classic Administration page. Accessing Classic Administration
b. Navigate to User Profile > User.
c. Click Add and complete the user fields. Refer to Adding a User. You do not need to assign this user
any permissions.
d. Click Save.
2. Define the Delegate user account. This account links the agency user account with the public user
group.
a. Access the Delegate User Portlet.
a. Click New.
Civic Platform displays the New Delegate User portlet.
b. Complete the Delegate User fields as described below:
Delegate User ID

Use the picker icon to select the agency user account created for the public user
group. Refer to .

Allow Delegate User
Login

Select this option to allow public user access to multi-agency information.

Super Agency

Select the agency to which you want public users to have the multi-agency
access.

Status

Select the delegate user status. Select Enable to activate or Disable to deactivate
the delegate user account.

Parent User ID

Click the picker icon to search and select PUBLICUSER.

c. Click Save.

Enabling Delegate User Agency Access
Your agency can allow a delegate user from another agency to access your data in Civic Platform for
viewing or performing tasks. The delegate user can perform tasks or view information in your agency only
when you establish the delegate user relationship. Enable or disable delegate user access to your agency
at any time. For information on how to set up a new delegate user, see Creating a Delegate User.
To enable a delegate user
1. Access the Delegate User portlet (Accessing the Delegate User Portlet).
2. Search and select a Delegate user. If there is no delegate user account, refer to Creating a Delegate
User.

| Part 2: Setting Up Agencies, Organizations, and People | 222

Civic Platform displays the Delegate User detail portlet.
3. Select the option to allow the delegate user access to your system at login.
4. Click Save.

Searching and Editing Delegate User Information
You can search for and edit delegate user information at any time. For example, you can do this to
inactivate a delegate user. Civic Platform stores changes to delegate user information in the Delegate User
History portlet. Refer to Viewing Delegate User History.
If you want to change permissions for the delegate user, you must make those changes to the user
account profile you established at your agency for the external user. For example, you can change a user’s
access from full access to view only. Changing a user's access restricts a delegate user from making
changes. See Creating a Delegate User or refer to Editing a User.
To search for and edit delegate user information
1. Access the Delegate User portlet (Accessing the Delegate User Portlet).
2. Click Search.
Civic Platform displays the delegate user search portlet.
3. Enter search criteria in one or more of the delegate user fields and then click Submit. Refer to Delegate
User Fields.
Civic Platform returns a list of delegate users that meet the search criteria.
4. Select the delegate user to which you want to modify information.
Civic Platform displays the delegate user detail in the Delegate User detail portlet.
5. Make modifications. Refer to Delegate User Fields for details regarding each delegate user field.
6. Click Submit to save changes.

Viewing Delegate User History
The delegate user history portlet provides a running history of the delegate user account. Delegate
user history includes the operation name and corresponding date. For example, it shows the date
when you created or reactivated the delegate user account. This portlet does not display changes to
user permissions or any tasks that the delegate user performed. You can search and select historical
information with the delegate user search feature.
You can search and select delegate user history in two different areas. You can select a delegate user
from the list portlet and click the Delegate User History record tab. You can also click the Search History
button located in the delegate user list portlet to search for a specific operation type, activity during a date
range, or status of delegate users.
To view delegate user history
1. Access the Delegate User portlet (Accessing the Delegate User Portlet).
2. Choose any of these options:
•

View delegate user history from the Delegate User detail portlet.
1. Search and select the delegate user for which you want to view history.
2. Click the Delegate User History tab.
Civic Platform displays a list of delegate user history.

| Part 2: Setting Up Agencies, Organizations, and People | 223

•

View delegate user history from the Delegate User History search results.
1. Click Search History.
Civic Platform displays the Delegate User History Search form.
2. Enter the search criteria based on the field descriptions provided in Delegate User History Fields
and click Submit.
Civic Platform displays a list of delegate users meeting search criteria.
Table 37: Delegate User History Fields

Allow Delegate User
Login

Select this option to allow public user access to multi-agency information.

Delegate User ID

Use the picker icon to select the agency user account created for the public user
group.

Operation Date

Use the drop-down list to specify the type of modification for this Delegate User.
The Operation Type field lists these types of actions or operations: Create,
Delete, or Update.

Operation Type

Use the drop-down list to specify the type of modification for this Delegate User.
The Operation Type field lists these types of actions or operations: Create,
Delete, or Update.

Operator

Use the picker icon to expand the list of agencies and their delegate users.

Super Agency

Select the agency to which you want public users to have the multiple agency
access.

Parent User ID

Click the picker icon to search and select the delegate user’s User ID at their
primary agency.

Status

Select the delegate user status. Select Enable to activate or Disable to deactivate
the delegate user account.

Toggling between Agency Locations
Civic Platform provides a way for a multi-agency user to switch from one agency to another. After a user
logs into their primary agency, Civic Platform displays a drop-down list in the upper areas of the page. This
list populates with the sub-agencies where they have delegate user access.
To switch between agency locations
1. To switch between agencies in Classic Administration, use the drop-down list in the upper toolbar of
your console.
2. To switch between agencies in Civic Platform, use the drop-down list in the upper area of your page.

| Part 2: Setting Up Agencies, Organizations, and People | 224

Multi-Agency Service Management
Manage the services offered by associating the services with a record type. You can also associate the
service with a licensed professional type. For example, a licensed commercial contractor can have access
to request plumbing or water service repairs. You can also associate an address type with a service. For
example, 123 Main Street is a commercial building and has access to roof repair, water, and plumbing
services offered by the State, county, and city. For more examples of service configurations, refer to
Services Example Configurations.
Filter which services your agency offers by using the Service Lock Condition feature. This feature provides
the option to exclude services to a particular address or licensed professional.
In order for complete feature functionality, you must consider these configuration considerations. The multiagency services feature also applies to Citizen Access, which means the public user group must have an
associated delegate user account to enable users to view the services offered from multiple agencies. See
Creating a Delegate Account for a Public User Group. If you want to provide public users with the ability to
request services from multiple agencies, you must configure Civic Platform before you can create records
that accommodate multi-agency functionality. This configuration requires matching service configurations
such as Application-Specific Information Subgroups at the parent and sub-agency level. Refer to the
“Creating Records” section of the Citizen Access Administrator Guide. An administrator must configure the
sharing of information across all agencies providing services. Refer to Delegate User Management.
Topics
•

Adding a New Service

•

Searching and Editing a Service

•

Associating License Types with a Service

•

Associating an Address Type with a Service

•

Incorporating the Service Lock Condition

•

Synchronizing Licensed Professional Data between Agencies

Adding a New Service
You can offer services from multiple agencies to your public users through ACA. You can add any service
offered by your agency or a service from an agency to which you share information. See Delegate User
Management. You can associate each service with a record type and with a Licensed Professional or
Address Type. For examples, see Services Example Configurations. These configurations determine which

| Part 2: Setting Up Agencies, Organizations, and People | 225

services users view when logged into ACA. A pre-configured EMSE script determines which agency to use
if multiple agencies offer the same service.
The public user group or agency user must have a delegate user account to view services. Refer to
Delegate User Management for configuration information.
To learn more about associating a licensed professional type or address type, see Associating License
Types with a Service and Associating an Address Type with a Service.
To add a new service
1. Access the Service portlet (Accessing the Service Portlet).
2. Click New.
Civic Platform displays the Service portlet.

3. Complete the fields as described in Service Field Descriptions.
4. Click Save.
5. Associate a Licensed professional as described in Associating License Types with a Service.
6. Associate an Address Type as described in Associating an Address Type with a Service.
7. Click Save.
Table 38: Service Field Descriptions

ASI Group

This field automatically populates based on the selected record type.

ASI Sub Group

Use the drop-down list to select the ASI Sub Group, or leave it empty. The ASI sub
group sets the scope of the service to a specific portion of the record type. If you do not
specify the ASI sub group, the service scope is identical to that of the record type.

Record Type

Click the picker icon to select the Record Type you want associated with this service.

Service

Enter the name of the Service.

Table 39: Services Example Configurations

Agency

Service
Name

Record
Type

ASI Group

ASI Sub
Group

Associated
Licensed
Professional

Associated
Address Type
Group

Oregon

Water
Heating

Plumbing

Plumbing_ services

-

Contractor

Address Type
Group 1

Oregon

New Drain

Plumbing

Plumbing_ services

New
Drain_Info

Architect

Address Type
Group 1 and
Address Type
Group 2

| Part 2: Setting Up Agencies, Organizations, and People | 226

Agency

Service
Name

Record
Type

ASI Group

ASI Sub
Group

Eugene

Re-roof

Structural

Structural_ services Re-roof_info

Portland

Fishing

Fishing

Fishing_ services

Fishing_info

Associated
Licensed
Professional

Associated
Address Type
Group

Contractor

Address Type
Group 1
Address Type
Group 2

Searching and Editing a Service
Search for an existing service and make any updates as needed. For example, you might change the
record types associated with the service.
To search and edit a service
1. Access the Service portlet (Accessing the Service Portlet).
2. Click Search.
Civic Platform displays the Service Search portlet.

3. Enter your search criteria.
Civic Platform displays a list of services that meet your criteria.
4. Select the service you want to work with.

5. Make your modifications. Refer to Service Field Descriptions.
6. Click Save.

Associating License Types with a Service
You can associate a license type with a service, which provides a way for a user to view services and
request services appropriate to their license type. For examples, refer to Example Multi-Agency Services
and Licensed Professional Type Associations.
You can use this feature with EMSE scripts for license validation. When you update licensed professional
information in Civic Platform, you can verify the license at an external database by using a dynamic web

| Part 2: Setting Up Agencies, Organizations, and People | 227

service. This feature also applies to a licensed professional registered with a public user account for
Citizen Access. Validation of license information can occur at the time of login.
To associate a license type with a service
1. Access the Service portlet (Accessing the Service Portlet).
2. Search and select the service you want to work with.
Civic Platform displays the service details in the detail portlet.
3. Click the License Type tab.
Civic Platform displays the Licensed Professional Type list portlet.

4. Click Look Up.
Civic Platform displays the License Type portlet.
5. Enter the Licensed Type Name and Description, or leave the fields empty.

6. Click Submit.
Civic Platform displays the license types that meet your search criteria.

7. Select the license types you want to associate with the service, and then click Select.
Civic Platform adds the license types to the License Type list portlet of the service.
Table 40: Example Multi-Agency Services and Licensed Professional Type Associations

Agency

Service Name

License Type

Oregon

Water Heating

Contractor

Oregon

Water Heating

Architect

Eugene

New Drain

Contractor

| Part 2: Setting Up Agencies, Organizations, and People | 228

Agency

Service Name

License Type

Eugene

New Drain

Architect

Portland

Re-roof

Contractor

Portland

Re-roof

Architect

Associating an Address Type with a Service
You can associate an address type with a service. This feature provides a way for a user to view services
and request services appropriate to their address. For examples, refer to Example Services and Address
Type Associations.
To associate an address type with a service
1. Access the Service portlet (Accessing the Service Portlet).
2. Search and select the service you want to work with.
Civic Platform displays the service details in the detail portlet.
3. Click the Address Type tab.
Civic Platform displays the Address Type list portlet.

4. Click Look Up.
Civic Platform displays the Address Type list portlet.
5. Enter the Address Type Name and Description you want associated with the Service.
6. Click Submit.
Civic Platform returns you to the Address Type list portlet.
Table 41: Example Services and Address Type Associations

Agency

Service Name

Address Type Group

Eugene

Water Heating

Eugene

Eugene

New Drain

Oregon

Portland

Re-roof

Oregon

| Part 2: Setting Up Agencies, Organizations, and People | 229

Incorporating the Service Lock Condition
You can choose to limit one or more services to a particular licensed professional or address. The Service
Lock Condition feature is particularly useful if you want to lock out services from a particular agency at an
address or licensed professional, but still offer services from other agencies.
Select the Service from the Condition Name drop-down list to lock out that service from the Licensed
Professional or address. If you only want to lock out one service, create a Lock condition and associate
it with a Service Name. Create as many conditions to limit the available services for the Licensed
Professional or Address.
Topics
•

Adding a Service Lock Condition to a Licensed Professional

•

Adding a Service Lock Condition to an Address

Adding a Service Lock Condition to a Licensed Professional
Your agency can filter available services for a licensed professional using the Conditions portlet. Provide
a Service Lock on all services for the Licensed Professional or create a condition to lock out one particular
service.
To add a service lock to a licensed professional
1. Access the Professionals portlet (Accessing the Professionals Portlet).
2. Select the Licensed professional to which you want to associate a Service Lock condition.
Civic Platform displays the Licensed Professional details in the detail portlet.
3. Click the Conditions tab.
Civic Platform displays the Licensed Professional Conditions portlet.
4. Go to the Severity field and select Service Lock from the drop-down list.
5. Go to the Service Name field and select the condition to which you want to associate the service lock
from the drop-down list.
6. Click Submit.

Adding a Service Lock Condition to an Address
Your agency can filter available services for an Address using the Conditions portlet. Provide a Service
Lock on all services for the Address or create a condition to lock out one particular Service.
To add a service lock condition to an address
1. Access the Addresses portlet (Accessing the Addresses, Parcels, or Owners Portlets).
2. Search and select the address to which you want to associate a Service Lock condition.
Civic Platform displays the Address details in the detail portlet.
3. Click the Conditions record tab.
Civic Platform displays the Address Conditions portlet.
4. Go to theSeverity field and select Service Lock from the drop-down list.
5. Go to the Service Name field and select the condition to which you want to associate the service lock
from the drop-down list.
6. Click Submit.

| Part 2: Setting Up Agencies, Organizations, and People | 230

Synchronizing Licensed Professional Data between Agencies
Maintain the accuracy of licensed professional information by running a regularly scheduled batch job
to synchronize licensed professional data from super agency to sub-agency. The administrator from the
super agency is responsible for setting up the batch job for data synchronization. When you run the batch
job and Civic Platform recognizes that the sub-agency does not have the Licensed Professional in the
database, Civic Platform creates the Licensed Professional at the sub-agency with same License State,
State License number, License Type as the one at the super agency.
For information about Batch jobs, refer to Working with Batch Jobs.
To schedule a batch job that synchronizes licensed professional data between agencies
1. Access the Batch Jobs portlet (Accessing the Batch Jobs Portlet).
2. Click New.
The Job Detail tab displays.

3. Complete the Job detail fields as described below.
Name

Provide a name for the new job.

Job Type

Choose System from the drop-down list.

Description

Provide a brief comment about the Job name.

4. Click Submit.
5. Schedule the Job by clicking the Job Schedule tab.
Civic Platform displays the Job Schedule portlet.

| Part 2: Setting Up Agencies, Organizations, and People | 231

a. Complete the fields as described below:
Start Time, Start Date
and End Date

Enter the time that you want the job to execute. This time should be a time at which
the server is running and free to run the batch job. Select a start and end date too
using the date picker icon.

Schedule Status

Choose one: To have the batch job run, select Active from the drop-down list. To
disable the job from running on schedule, select On Hold.

Time Out (seconds)

Specify how long you want the server to wait (in seconds) if the batch job does not
run as scheduled.

Frequency

Select how often to run the batch job from this drop-down list.

b. Click Save.

Record Creation Across Agencies
In a multi-agency environment, your agency requires the implementation of Citizen Access to provide
the record creation process across multiple agency services. When configured this way, Citizen Access
provides a way for public users to manage records from multiple agencies all from a single login. This
type of configuration is best used when a single Citizen Access site exists to service multiple agencies.
An example of this type of configuration is when a state hosts a single Citizen Access site that provides
access to all of the cities and counties within the state. You must perform multiple configurations for
numerous features within Civic Platform and Citizen Access for complete functionality. This section
provides the basic conceptual flow for the process to create a record, what you need to configure, and the
impact of configurations on the user interface.

Impact on the User Interface
To use this feature, you must configure multi-agency services, the sub-agency record types, and the
reports. The most critical element of the process is the main record type which works as a place holder
for sub-agency records and resides at the super agency level. The place holder record type does not
require Custom Fields Group, Workflow, or Fee setup as, again, it merely functions as a container. You
must configure a page flow for the place holder record type. You must also configure the record type filter
in Citizen Access so that this main record type is the only available record type available to public users.
Doing so forces the public user to initially select the place holder record type so you can associate the
record types for the sub-agency services with it moving the group of records together through the record
creation process. The following section contains the configuration instructions for the record creation
feature and its impact on the user interface.

| Part 2: Setting Up Agencies, Organizations, and People | 232

To configure the ability to create records
1. Configure any Delegate Users to have the ability to manage multiple agencies and their services. You
must enable this feature for public users so that they have access to multiple agency services when
creating a record online. For complete configuration information, refer to Delegate User Management.
2. Configure the ability for multiple agencies to share information in a common database. Multi-agency
sharing is particularly useful when you search for addresses across multiple agencies to select a work
location. For complete configuration information, refer to Delegate User Management.
3. Enter the Official website URL on the Global Settings page. For complete configuration information,
refer to “Official Website” in the “Global Settings” section of the Citizen Access Administrator Guide.
4. Configure the multi-service functionality for multiple agencies, including:
a. Configure a record type at the super agency level. This record type does not require a Custom
Fields group, Workflow, or Fee setup.
b. Configure any record types at the sub-agency level.
c. Configure Custom Fields for sub-agency services. For example, Custom Fields Groups "plumbing
services" with the sub-group "water heater". For more examples, refer to Table 39: Services
Example Configurations.
Note:
You must define Custom Fields subgroups at both the parent and sub-agency level and they must
be configured to match each other. At the parent level the Custom Fields subgroup information must
exist in the database but you do not need to associate it with a record type.

d. Set up the multi-agency services and associate them to record types, Licensed Professionals,
Addresses. You must also configure the Service Locks. For basic configuration information refer to
Multi-Agency Service Management.
e. Associate any Logos with an agency. For complete configuration information, refer to Branding Civic
Platform for Your Agency.
5. Receipt and Permit Summary configurations.
a. Configure the Receipt and Permit Summary in Report Manager. You must define receipts for each
sub-agency and super agency. You must also define an overall multi-agency receipt that includes all
sub-agency information at the super agency level. For complete configuration information, refer to
“Setting up Permit Reports” in the Citizen Access Administrator Guide.
b. Associate the receipts and the Permit Summary to buttons in Citizen Access. For complete
configuration information, refer to “Associating Reports with Print/View Buttons” in the “Reporting
Information” chapter of the Citizen Access Administrator Guide.

| Part 2: Setting Up Agencies, Organizations, and People | 233

6. Configure the page-flow for the super agency placeholder record type. For complete configuration
information, refer to “Defining the Page Flows for Record Types” in the “Creating Records” chapter of
the Citizen Access Administrator Guide.
Configure the record type filter to exclude all records but the super agency placeholder record type. For
complete configuration information, refer to “Record Type Filters” in the Citizen Access Administrator
Guide.

Sharing APO and Contacts Across Agencies
Civic Platform provides a way for multiple agencies to share address, parcel, owner, licensed professional,
and contact information. When you consolidate APO, licensed professional information, and contact
information, it allows users to perform searches or update information across agencies. Consolidating
information also limits duplicate information in various agency databases. For complete information
about how to consolidate licensed professionals, see Synchronizing Licensed Professional Data between
Agencies.
Topics
•

Sharing Addresses, Parcels, and Owners (APO)

•

Sharing Contacts

Sharing Addresses, Parcels, and Owners (APO)
To enable normal agency users to search and edit the information from other agencies without toggling
between agencies, you must configure the agency option “APO Source Number” to an identical value for
each agency that is sharing information. For instructions, see To configure the agency option “APO Source
Number” for information sharing.
For more information on configuring the agency options, see the “Agencies and Functions” chapter in the
Civic Platform On-premise Administrator Supplement.
If the APO Source Number differs in the super-agency and sub-agency, a super-agency user can still
search for and edit the sub-agency information, provided the sub-agency administrator creates a delegate
user for the super-agency user.

| Part 2: Setting Up Agencies, Organizations, and People | 234

For delegate users management, see Delegate User Management.

To configure the agency option “APO Source Number” for information sharing
1. Access the Classic Administration page. (Accessing Classic Administration.)
2. Choose Agency Profile > Agency.
Civic Platform displays the Agency—Search page.

3. Enter the Agency Code of the agency for which you want to share the reference information with other
agencies.
4. Click Submit.
Civic Platform displays the Agency-Browse page.
5. Click the red dot next to the agency you want to work with.
Civic Platform displays the Agency-Edit page and existing Agency Properties.

| Part 2: Setting Up Agencies, Organizations, and People | 235

| Part 2: Setting Up Agencies, Organizations, and People | 236

6. Set the APO Source Number to be the same as the other agency that you want to share information
with. If you do not want an agency not to share the information this way, assign a unique APO Source
Number value to it.
7. Repeat Steps 2 through 5 for each agency that you want to share information.

Sharing Contacts
In a multiple-agency environment, you can share contacts across agencies. When an agency user adds
or updates a contact from the main agency or the sub-agency, Civic Platform can synchronize contact
information across all agencies in the multiple-agency environment. The shared contact information
includes basic contact information, contact template data, contact addresses, contact aliases, contact
relationships, and contact association with public users.
You must associate contact templates with contact types. If agencies associate different contact templates
for the same contact type, only the template fields with the same field labels synchronize between the
agencies. For example, Main Agency, Sub-Agency 1, and Sub-Agency 2 have defined the template fields
for the contact type “Applicant” as shown in the Table 42: Example Contact Templates. When you add an
applicant from Main Agency, the applicant’s information including the template fields is available in both
sub-agencies. However, Sub-Agency 2 does not display the applicant’s ethnicity. Similarly, when you add

| Part 2: Setting Up Agencies, Organizations, and People | 237

an applicant from Sub-Agency 2, the applicant is available in both Main Agency and Sub-Agency 1 but
those two agencies do not have the applicant’s ethnicity information.
Table 42: Example Contact Templates

Main Agency

Sub-Agency 1

Sub-Agency 2

Gender

Gender

Gender

Language

Language

Language

Ethnicity

Ethnicity

The sharing contacts feature requires Standard Choice configuration. Each agency must configure the
Standard Choice CONTACT_ACROSS_AGENCIES in the same way to specify which agencies share
contacts. For complete information on how to configure a Standard Choice, refer to the Accela Civic
Platform Configuration Reference.

Viewing Information Across Agencies
A multi-agency environment provides users the ability to view information across agencies in the following
Civic Platform features:
•

Task dashboard

•

Related records

•

Record search

•

Inspection search

Configuration
These configuration instructions listed below assume that you have already configured your multi-agency
environment as described in this chapter. To enable users to view information across agencies:
•

•

•

Configure all agencies in your multi-agency environment to use the new UI (these enhancements are
not available in the legacy V360 user interface).
•

Set the ENABLE_80_UI standard choice value to YES in each agency. This adds the Switch to
new UI link to the V360 console.

•

Users must select the Switch to new UI link in each agency comprising the multi-agency
environment.

To display your agency code on record IDs in the tree view of the Related Records page, configure the
existing standard choice RELATED_CAP_CONFIG as follows:
Standard Choice Value

Value Description

Description

DISPLAY_CONFIG

$SERV_PROV_CODE$

Displays your agency code on
record IDs in the tree view of the
Related Records page in multiagency environments.

To enable users to search for records and inspections across multiple agencies, add the Agency field to
your records search form and your inspections search form as described below.

| Part 2: Setting Up Agencies, Organizations, and People | 238

•

To enable users to search for records by status type across multiple agencies, add the Status Type field
to your records search form and your inspections search form as described below.

To enable cross-agency records and inspections searches:
1. Click

to access the launchpad.

2. Navigate to the Records or Inspections page.
3. Click Search. The Records or Inspections Search page displays.
4. Add the Agency and Status Type fields to your records search page:
a. Click Menu > Edit View.
b. For complete instructions see Working with Forms > Using the Edit View Feature.
Note: Cross-agency searches are only supported for record and inspection searches.
However when FID 8403-Multi Agency Switch is enabled, cross-agency search fields
(Agency and Status Type) may display in search forms where cross agency searches are
not supported, and will only return results from a single agency (the agency you are currently
logged in to).

| Part 2: Setting Up Agencies, Organizations, and People | 239

Customizing Regional Settings
You can manage and accept data from people who live outside of the United States without turning on the
Internationalization and Localization feature.
Before your agency issues professional licenses and receives applications from customers who:
•

are not residents of the United States, or

•

have completed education, continuing education, or examination outside the United States,

You must define regional settings for each foreign country or region. This way, both internal staff and
external citizen users can enter, format, and store the zip code or postal code, country code, phone
number, and fax number based on the selected country or region.
The regional settings for a country or region applies to Civic Platform and its add-ons such as Citizen
Access and Mobile Office.
Click a topic title below for full details.
Related Information
Defining Regional Settings for a Country or Region
Viewing or Editing Regional Settings for a Country or Region
Deleting Regional Settings for a Country or Region

Defining Regional Settings for a Country or Region
Follow the steps below to define regional settings for a country or a region other than the United States.
Do not define regional settings for the United States, because Civic Platform contains a pre-configured
regional settings entry for the United States. See Viewing Default Regional Settings for the United States
for more information.
To define regional settings for a country or region
1. Access the Regional Settings portlet (Accessing the Regional Settings Portlet).
2. Click New.
Civic Platform displays the regional settings form.
3. Complete the fields that display. For a list of field descriptions, see Table 43: Regional Settings Fields.
4. Click Save.
Table 43: Regional Settings Fields

Country/Region

Use this drop down list to choose the country or region for which you want to define the
regional settings. When you enable the Standard Choice COUNTRY, this drop-down
list contains the values defined in the Standard Choice. When you disable the Standard
Choice, this drop-down list contains all the countries and regions available in the Civic
Platform database. However, to avoid any duplicate or conflict settings, this drop-down
list always excludes the countries or regions for which you have already defined the
regional settings. For more information about the Standard Choice COUNTRY, see its
listing in the “Internationalization Standard Choices” section of the Internationalization
Installation and Administrator Guide.

| Part 2: Setting Up Agencies, Organizations, and People | 240

Default Country/Region

Select this option if you want to set this country or region as the default. The country
or the region displays as the default Country/Region in a drop-down list for users (for
example, on the application intake form). You can only set one country or region as the
default one for an agency.
Another quick way to set a country or region as default is to select the country or region
from the Regional Settings list portlet and then click Set Default.

State/Province

Use the drop-down list to decide the list of the states or provinces that comprise the
country or region. The options available in this drop-down list are the Standard Choices
of the Business Configuration - State/Province type. For example, this drop-down list
might have two options: one is “US_State/Province,” which defines a list of states for
the United States; and the other is “AU_State/Province,” which defines a list of states
for Australia. So if you are defining regional settings for the United States, choose
“US_State/Province” from this drop-down list. This way, when the user selects the
United States in a form like the Contact Address intake form, the State drop-down list
in that form contains the values you define in the Standard Choice US_State/Province.
For more information about the Standard Choices of the State/Province type, see
the listing “State/Province (User-defined Name)” in the Standard Choices Reference
chapter of the Accela Civic Platform Configuration Reference. If you do not choose any
option from this drop-down list to define the states available for a country or region,
users must manually enter a state name or a province name for that country or region
in various forms.

Use ZIP Code

Select this option if the country or region uses ZIP codes in addresses. If you leave this
option blank, Civic Platform ignores the Required property defined for the ZIP Code (or
Postal Code) field in the Form Portlet Designer and prevents users from filling in that
field.

ZIP Code Mask

This field defines the mask for the ZIP Code (or Postal Code) field in all pages related
to contact addresses and premise addresses across Civic Platform, Citizen Access,
and Mobile Office. It is an active field only when you select Use ZIP Code. When
users select a country from the Country/Region drop-down list, the specified mask
automatically applies to the ZIP Code field. The mask ensures that users enter proper
values in the expected format and position. You can use the following placeholder and
literal characters to define a ZIP Code mask:
A: Users must enter a letter. The letter automatically capitalizes.
#: Users must enter a digit.
( ): Parentheses indicate optional fields. For example, if the ZIP Code mask is #####(####), the last 4 digits of the ZIP Code are optional. Users can enter “94610” or
“94610-6279” in the ZIP Code field. NOTE: Parentheses can only be used at the end of
the mask. For example, the following masks do not work: (###) ###, ### (###) ###.
Space or hyphen: Spaces and hyphens are formatting characters. They automatically
populate in the field in the position that you specify. For example, a U.S. ZIP code
might be 94596-2801, while a Canadian postal code might be M5T 2T9. The masks for
these formats are: #####-#### and A#A #A#.

Phone Number Country
Code

This field defines the country code for phone numbers and fax numbers. When
users select a country from the Country/Region drop-down list, the pre-defined value
automatically populates into the Country Code field.
Note:
You must configure Standard Choice PHONE_NUMBER_IDD_ENABLE and
set its value to Yes. Otherwise, the Country Code field is not available to
users. For more information see the “Internationalization Standard Choices”
section of the Internationalization Installation and Administrator Guide.

| Part 2: Setting Up Agencies, Organizations, and People | 241

Phone Number Mask

This field defines the mask for the Phone Number and Fax Number fields in all pages
related to contact addresses and premise addresses across Civic Platform, Citizen
Access, and Mobile Office. When users select a country from the Country/Region
drop-down list, the specified mask automatically applies to the Phone Number and
Fax Number fields. The mask ensures that users enter proper values in the expected
format and position. You can use the following placeholder and literal characters to
define a Phone Number mask:
#: Users must enter a digit.
(): Parentheses in the phone number mask differ from the ZIP code mask. These
parentheses are formatting characters. They automatically populate in the field in the
position that you specify. For example, you might always want telephone numbers
formatted like so: (510) 813-9225. The mask for this format is (###) ###-####.
Space or hyphen: Spaces and hyphens are formatting characters. They automatically
populate in the field in the position that you specify.

Viewing or Editing Regional Settings for a Country or Region
To view or edit regional settings for a country or region
1. Access the Regional Settings portlet (Accessing the Regional Settings Portlet).
2. Select the country or region for which you want to view or update regional settings.
Civic Platform displays the regional settings form.
3. Update the fields that display, as appropriate for your agency. For a list of field descriptions, see Table
43: Regional Settings Fields.
4. Click Save.

Viewing Default Regional Settings for the United States
When your agency first implements the latest version of Civic Platform or upgrades an existing instance
to the latest version, Civic Platform automatically creates an entry for the United States in the Regional
Settings portlet. That entry populates with the default settings for the United States. See Table 44: Default
Regional Settings for the United States. You can update the settings as appropriate for your agency.
Table 44: Default Regional Settings for the United States

Country/Region

United States

Default Country/Region

If you set the United States as the default country, and if you do not set a default country
before upgrading Civic Platform, this option automatically enables.

State/Province

STATES

Use ZIP Code

Enabled

ZIP Code Mask

#####(-####)

Phone Number Country
Code

1 or 001, same as the phone number country code defined for the United States in the
Standard Choice PHONE_NUMBER_IDD. If your agency does not enable or define
that Standard Choice, this field uses the US phone number country code that the
STANDARDDATA agency defines in the Standard Choice PHONE_NUMBER_IDD. For
more information about the Standard Choice, see its listing in the “Internationalization
Standard Choices” section of the Internationalization Installation and Administrator Guide.

Phone Number Mask

###-###-####

| Part 2: Setting Up Agencies, Organizations, and People | 242

Deleting Regional Settings for a Country or Region
To delete regional settings for a country or region
1. Access the Regional Settings portlet (Accessing the Regional Settings Portlet).
2. Select the country or region for which you want to delete the regional settings.
3. Click Delete.

| Part 2: Setting Up Agencies, Organizations, and People | 243

Configuring Global Search
Civic Platform provides a search engine to find information globally throughout the software. Users enter
search criteria and Civic Platform displays results in a global search portlet grouped by information type.

You can configure search to define how many max records return in a global search and how many result
rows to display in a group results list page. For example, record result information is grouped together in
pages and licensed professional result information is grouped together in pages. Within each group, a user
can filter, page through, or sort through the result information.
The global search function works against indexed content in the Civic Platform database. To ensure the
most accurate and up-to-date search results, configure a batch job to regularly index the Civic Platform
database.
To configure global search:
1. Set the following FID(s) and Standard Choices (refer to the Civic Platform Configuration Reference for
full details):
•

8434-Global Search

•

GLOBAL_SEARCH_MAX_COUNT

•

BATCH_JOB_SERVICE_CATEGORY

•

GLOBAL_SEARCH_BUILD_INDEX_ENTITIES

2. Create a Global Search Index Batch Job. See Creating a Global Search Index Batch Job for complete
details.

| Part 2: Setting Up Agencies, Organizations, and People | 244

| Part 3: Configuring Agency Business Objects | 245

Part 3: Configuring Agency Business Objects
Civic Platform provides functions to configure agency business objects.
Related Information
Creating and Configuring Records
Creating Custom Fields
Designing Application Intake Forms
Setting Up Security Policies
Defining Sequences, Masks, and Autonumbering
Designing Workflows
Using Expression Builder
Configuring Standard Comments
Setting Up Conditions
Configuring Record-Related Activities
Configuring Global Search

| Part 3: Configuring Agency Business Objects | 246

Creating and Configuring Records
Records are the cornerstone of the system, consisting of a broad range of forms that users create and
manage within Civic Platform, including applications, cases, licenses, permits, service requests, and work
orders. Records provide a means of collecting the data that Civic Platform stores in its back-end database,
enabling users to access the data and process it to achieve your agency’s business objectives.
Click a topic title below for full details.
Related Information
Accessing Record Type Administration
Creating New Record Types
Working with Record Types
Working with Address Type Groups
Working with Application Status Groups
Working with Intake Form Configuration Groups
Working with Virtual Folder Groups
Associating Record Types
Setting Default Clone Options
Managing Documents for Attachments

Accessing Record Type Administration
You can access Record Type Administration portlets by selecting the Civic Platform Admin option from the
Administration Setup portlet.
To access Record Type administration
1. Access the Record Type Administration portlet (Accessing Record Type Administration).

Creating New Record Types
This section provides instructions for creating a new record type, which involves three basic configuration
tasks:
•

To begin, click Create New Record and enter basic record type information. You can access additional
record type configurations with the tabs on the record type summary navigation panel.

•

Use the Settings portlet to configure additional record type features for add-ons, like Citizen Access and
legacy Accela GIS.

•

Use the Other Associations portlet to configure other related items for the record type, such as fee
schedule, expiration code, application specific information, and workflows. The Other Associations
portlet is also where you can configure the ability for agency users to submit partially completed
applications.

| Part 3: Configuring Agency Business Objects | 247

You can save and resume as you go, but you must review all three areas of configuration to ensure you
properly configure the record type. Additional administrator configurations that you can apply to record
types include Standard Comments and Conditions. Refer to Configuring Standard Comments and Setting
Up Conditions.
Topics
•

Specifying Basic Record Type Information

•

Configuring Record Type Settings

•

Configuring Other Associations

Specifying Basic Record Type Information
You must complete the required fields that display in the new record type page. This basic information
allows the user to save enough critical data elements in Civic Platform so you can access the information
about additional configuration or modification later.
To create a new Record type
1. Access the Record Type Administration portlet (Accessing Record Type Administration).
2. Locate the module that you want to add a record type and then Click New Record Type.

Civic Platform displays the New Record Type page.

| Part 3: Configuring Agency Business Objects | 248

3. Enter information in the fields as described in Table 45: New Record Type Form Fields.
At a minimum, you must complete the Record Type Alias, Group, Type, Sub-Type, and Category. When
those are complete, you can save and resume later.
4. Click Save or Save and Create Another.
Table 45: New Record Type Form Fields

Category

Enter the name of the new category.

Fee Schedule

Use the drop-down list to search and select a fee schedule to assign to the record type.

Group

Select a group for the record type.

Partial ID Mask

Use the drop-down list to search for a Partial ID Mask to identify records that users
partially completed at intake, that represent an estimate, or that a user saved and
resumed processing later in Citizen Access.

Record Key Mask

Use the drop-down list to search and select a Record Key mask, which identifies
a record of this type in Civic Platform. You can also use the default value: $$yy$
$CAP-00000-$$SEQ05$$ by choosing Default from the list.

Record Type Alias

Enter an alias name for the record type. Record type aliases display in the Records
list portlet. A record type alias is a short, logical name that represents the four-level
name structure for the record type. For example, instead of displaying the record type
Licenses/Business License/Retailer/Hairdresser, you can configure a record type alias
that displays simply “Hairdresser.”If you do not see the option to specify a Record
Type alias, you might need to enable the functionality. To enable record type aliases,
set the Standard Choice ENABLE_CAP_TYPE_ALIAS. Refer to the Civic Platform
Configuration Reference for more details.

Intake Form
Configuration Group

Use the drop-down list to search and select an Intake Form Configuration Group.
Intake Form Configuration Group is an important step as it indicates what intake
information Civic Platform gathers for this record type.

Sub-Type

Do one of the following: choose an existing or create a new sub-type.
To create a new sub-type, enter a name in the field for it.
To choose an existing sub-type, use the drop-down list to search and select the subtype you want to use.

Temporary ID Mask

Use the drop-down list to search and select the mask used for the Partial ID Mask for
this record type.

Type

Do one of the following: choose an existing or create a new type.
To create a new type, enter a name in the field for it.
To choose an existing type, use the drop-down list to search and select the type you
want to use.

Workflow

Use the drop-down list to search and select a workflow process to assign to the record
type.

Configuring Record Type Settings
After you define the basic configuration for a record type, you can complete the record type settings. These
configurations include: settings for Citizen Access, Audit Frequency, and GIS Settings. For an overview of
the Record Type Settings page, see Configuring Other Associations.
To configure the Settings portlet
1. Access the Record Type Administration portlet (Accessing Record Type Administration).

| Part 3: Configuring Agency Business Objects | 249

2. Expand a module to search and select the record type you want to work with. For instructions on how to
search for a record type, see Searching for Record Types.
Civic Platform displays the Record Type Summary page.
3. Click the Settings tab from the summary panel.
Civic Platform displays the Settings portlet.

4. Complete the Settings fields as described in Table 46: Record Type Settings Field Descriptions.
•

Complete the Settings for Citizen Access section, as appropriate for your agency.

•

Complete the Audit Frequency section, as appropriate for your agency.

•

Complete the GIS Settings fields section, as appropriate for your agency.

5. Click Save.
Table 46: Record Type Settings Field Descriptions

Section on Page

Field

Field Description

Settings for any module

Copy all associated APO

Select the option to copy all associated APO
information about this record type application.

| Part 3: Configuring Agency Business Objects | 250

Section on Page

Field

Field Description

Settings for any module

Duration

Enter the number of days you estimate the record
should take to complete.

Settings for any module

Icon

Click Browse to search and select the image you want
associated with the record type.

Settings for any module

IVR Number

For each record type you want to assign, enter a
unique numerical value in this field. This field is not
for a phone number. Assign a unique number to each
record type to make it faster and easier for public
users to navigate the IVR call flow. When a caller
receives a prompt to enter the record type, the caller
enters the pre-assigned numerical value entered in
this IVR Number field. For more information on how to
set this up with IVR, see the Accela Civic Platform IVR
Installation Guide.

Settings for any module

Status

Select Enable or Disable. You can choose to Disable
a record type to prevent users from creating this type
of record. The Disable option does not remove the
record type. All application types with the Enable
status are searchable. If you disable an application
type, you can select the Searchable option, to
enable users to search records with the disabled yet
searchable record type.

Settings for any module

As Child Only

Enable this option for a record type to prevent users
from selecting the record type for a stand-alone record.

Settings for Asset Module

Default Production Unit

Enter a fixed production quantity for a Work Order.

Settings for Asset Module

Estimated Cost Per
Production Unit

Enter a value you want to use to generate the
estimated cost for each work order. Asset Module
settings are particularly useful so that Accela Civic
Platform - Asset users can record the estimated cost
per production unit.

Settings for Asset Module

Unit of Production

Select the unit of measure for Production Units for
the record type for Accela Civic Platform - Asset. For
example, Each, Feet, Acres, or Miles.

Settings for Asset Module

Value Required to Close

Select the option to indicate users must enter a value
in the Production Quantity field before they can close a
work order in Accela Civic Platform - Asset.

Settings for Enforcement
Module

Email for Hearing
Notification

Enter the email address used to send email
notifications for hearings.

Settings for Enforcement
Module

Enforcement Type

Enter the enforcement type in this field. For example,
Abatement.

| Part 3: Configuring Agency Business Objects | 251

Section on Page

Field

Field Description

Settings for Citizen Access

Enable Associated Forms

Select this option to display the Associated Forms
step to the record creation process. Use Associated
Forms to display and manage child records for the
parent record during parent record creation. For more
information about creating parent and child records,
see the topic “Parent-Child Record Creation” in the
Citizen Access Administrator Guide. Selecting this
option also activates the Enable Partial Submission
option.Enable Partial Submission: Select this option
to enable public users to continue the application
intake process without completing all available
associated forms.

Settings for Citizen Access

Enable for Application

Select Enable Application to make the Record
type available in Citizen Access. When you only
select the Enable Application option, the Record
Type is available in Citizen Access, but you cannot
automatically issue it though ACA. The agency must
approve it.
This option also flags Civic Platform to display
the Record Type alias in Citizen Access. Also
Enable Issuance: Select this option if you want to
automatically approve and issue the record type
through Citizen Access after a public user pays the
fees in full.

Settings for Citizen Access

Enable Fee Estimation

Select this option if you want to allow users to create
a partial application that includes a calculation
of estimated fees. Civic Platform bases this fee
estimation on the Fee Schedule.

Settings for Citizen Access

Enable Renewal

Select the Enable Renewal option if you want to
enable the renewal of licenses in Citizen Access for
this record type. Select this option to activate the
Enable Issuance option for this renewal, and the
Renewal Record Type drop-down list. You must then
define a renewal record type to associate with this
renewal process.
Enable Issuance: Select this option for renewals if
you want to provide issuance online, and enable the
License or Permits status change back to active when
the Citizen Access public user completes the Renewal
Application.
Choose a Renewal Record Type from the dropdown list to designate the renewal Record Type for
the expired Record. For example, choose a Renewal
Plumber Permit for the expired plumbing permit.

Settings for Citizen Access

Document Code

Indicate the document code set for the types of
documents public users can upload and attach to
record types in ACA.

| Part 3: Configuring Agency Business Objects | 252

Section on Page

Field

Field Description

Settings for Citizen Access

Page Flow Code

Use this drop-down list to associate a Page Flow code
to this record type. The page flow code you choose
displays within Citizen Access Admin. You create and
assign the default setting for this field in Citizen Access
Admin page flow configuration. For more information,
see “Configuring the Page Flows for a Module” in
the “Creating Records” section of the Citizen Access
Administrator Guide.

Settings for Citizen Access

Searchable in Citizen
Access

Civic Platform enables this option by default, which
means that the type of application is searchable in
Citizen Access. You can clear this option to make the
applications unsearchable.

Settings for Citizen Access

Set the criteria for
selecting fees

To set the fee valuation associated with the record,
you can choose between the higher value or the
lower value of the Contractor Value and the Valuation
Calculator.

Settings for Citizen Access

Do you want this permit
to be available through
Citizen Access

You can either select Yes to make the record type
available in Citizen Access, or select No to prevent the
record type being available from Citizen Access.

Audit Frequency

Audit Frequency

Enter the number of months in the Audit Frequency
column to designate the interval between audits for the
Record Type. You can enter a number under any of
the Record Type Levels. For example, enter a “3” next
to the Building Permit Record Type Level to prevent
Civic Platform from selecting Building Permit Records
for auditing within a three month period.
When you edit any level of a Record Type, Civic
Platform automatically syncs the audit frequency for all
related Record Types.
For example, if you modify the audit frequency for
Building to 18 months for Building/Commercial/
Addition/Apt +5, the audit frequency for Building/
Commercial/Addition/Amusement also changes to 18
months.

GIS Settings

Edit Layer

If your agency uses the legacy Accela GIS, use this
field to limit users to a particular map edit layer when
using this application category. For example, if the
application category is for sewer lines, you can limit
users to editing only a sewer map layer rather than all
the edit layers. After you select the GIS Service, use
this drop-down list to select the edit layer.

GIS Settings

GIS Service

If your agency uses the legacy Accela GIS, use this
field to limit users to a particular map edit layer when
using this application category. For example, if the
application category is for sewer lines, you can limit
users to editing only a sewer map layer rather than all
the edit layers. Select the GIS Service that contains
the map edit layer you want to use.

| Part 3: Configuring Agency Business Objects | 253

Configuring Other Associations
After you define the basic configuration and the settings for a record type, you can configure the Other
Associations settings. These configurations include:
Address Type Group, Application Specific Info Group, Associated Record Types, Document Code,
Expiration Code, Fee Schedule, Inspection Group, Sequences and Masks, Intake Form Configuration
Group, Status Group, and Workflow.
You might have already defined some of these in the basic record type setup, but you can modify them if
you have permission. Also, you can use this record type Other Associations portlet to create new codes or
groups and assign them to the record type if you have permissions.
The Other Associations portlet is also where you can configure the ability for agency users to submit
partially completed applications.
To configure the other associations portlet
1. Access the Record Type Administration portlet (Accessing Record Type Administration).
2. Expand a module to search and select the record type you want to work with. For instructions on how to
search for a record type, see Searching for Record Types.
Civic Platform displays the Record Type Summary page.
3. Click the Other Associations tab from the summary panel.
Civic Platform displays the Other Associations portlet.

4. Complete the Other Association fields as described in Table 47: Record Type Other Associations
Fields.

| Part 3: Configuring Agency Business Objects | 254

Table 47: Record Type Other Associations Fields

Section on Page

Field

Field Descriptions

Sequences and Masks

ID Mask

Select the mask for the application type. Users can click the
ID Mask Definition link to read the pattern and definition of ID
masks. Within the Sequence Mask Definition page you can also
click Guide to review the recommended mask patterns and the
examples.
For information on sequences and masks, see Defining
Sequences, Masks, and Autonumbering.

Sequences and Masks

Invoice Number
Scheme

From the drop-down list, choose the invoice number format for
the record type.
You format an invoice number scheme by creating a mask. For
an example on formatting a receipt number scheme or mask,
see Defining Sequences, Masks, and Autonumbering. Users
can click the Select a Invoice Number Scheme link to read
the pattern and definition of the invoice in this drop-down list.
For example, administrators can number invoices for the code
enforcement department differently from invoices for the permit
department.

Sequences and Masks

Partial ID Mask

Use the drop-down list to search for Partial ID Mask to identify
records that a user only partially completed at intake, that
represent an estimate, or that a user saved and resumed
processing later in Citizen Access. Partial ID Mask is a required
field.

Sequences and Masks

Receipt Number
Scheme

From the drop-down list, choose the receipt number format for
the record type.
You format a receipt number scheme by creating a mask. For
an example on formatting a receipt number scheme or mask,
see Defining Sequences, Masks, and Autonumbering .
Users can click the Receipt Number Definition link to read the
pattern and definition of the receipt in this drop-down list. For
example, administrators can group receipts for the building
department differently from receipts for the code enforcement
department.

Sequences and Masks

Record Key Mask

Use the drop-down list to search and select a Record Key
mask, which identifies a record of this type in Civic Platform.
You can also use the default value: $$yy$$CAP-00000-$
$SEQ05$$ by choosing Default from the list. Record Key Mask
is a required field.

Sequences and Masks

Temporary ID Mask

Use the drop-down list to search and select the mask used for
the Temporary ID Mask for this record type. Temporary ID Mask
is a required field.

Document Code

Default Document
CodeDefault
Document Type

Use the drop-down menu to select an existing document code.
You can view or edit this code by clicking the View/Edit link.
If you want to create a new Document Code, click the Create
new Document Code link. For complete instructions on how
to create a document code, see Managing Documents for
Attachments.Use the Default Document Type to provide a
label for type of document, such as a graphic image or photo,
diagram, or Word document.

| Part 3: Configuring Agency Business Objects | 255

Section on Page

Field

Field Descriptions

Expiration Code

Expiration Code

Use the drop-down menu to select an existing expiration code.
You can view or edit this code by clicking the View/Edit link. If
you want to create a new Expiration Code, click the Create new
Expiration Code link.
For complete instructions on how to create an expiration code,
see License Renewal.

Inspection Group

Inspection Group

Use the drop-down menu to select an existing Inspection code.
You can view or edit this code by clicking the View/Edit link. If
you want to create a new Inspection Group, click Create New
Inspection Group.
For instructions on creating a new inspection code, see
Inspections.

Address Type Group

Address Type Group

Use the drop-down menu to select an Address Type Group you
want to assign to the record type.
For more information, see Working with Address Type Groups.

Status Group

Application Status
Group Code

Use the drop-down menu to select an existing Application
Status Group code. You can view or edit this code by clicking
the View/Edit link. If you want to create a new Application
Status Group, click Create New Status Group.
For more information, see Working with Application Status
Groups.

Status Group

Default Record
Status

Use the drop-down menu to select the default record status you
want to assign to the record type.
For more information, see Working with Application Status
Groups.

Fee Schedule

Fee Schedule

Use the drop-down menu to select an existing Fee Schedule.
You can view or edit the Fee Schedule code by clicking the
View/Edit link. If you want to create a new Fee Schedule, click
Create New Fee Schedule. Fee Schedule is a required field.
For more information about fee schedules, see the
Understanding Fee Items.

Workflow

Workflow

Use the drop-down menu to select an existing Workflow. You
can view or edit the Workflow by clicking the View/Edit link. If
you want to create a new Workflow, click Create New Workflow.
Workflow is a required field.

Workflow

Enforce Validation
Prior to Workflow
Update

With this setting, when an agency user creates an application,
but does not have all the necessary information to enter data
in all of the required fields, the user can submit the application
and defer validation of the application until all the required
information is available.
When a user submits an application without validation, Civic
Platform sets a Pending Validation flag on the newly created
record. Civic Platform also creates a flag, Generated by
Cloning, which defaults to No.

| Part 3: Configuring Agency Business Objects | 256

Section on Page

Field

Field Descriptions

Intake Form
Configuration Group

Intake Form
Configuration Group

Use the drop-down menu to select an existing Intake Form
Configuration Group. You can view or edit the Intake Form
Configuration Group code by clicking the View/Edit link. If you
want to create a new Intake Form Configuration Group, click
Create New Intake Form Configuration Group. Intake Form
Configuration Group is a required field.
For more information about Intake Form Configuration Groups,
see Working with Intake Form Configuration Groups.

Application Specific Info Application Specific
Group
Info Group

Use the drop-down menu to select an existing Application
Specific Info Group. You can view or edit the Application
Specific Info Group code by clicking the View/Edit link. If you
want to create a new Application Specific Info Group, click
Create New Application Specific Info. For more information
about Application Specific Info Groups, see Creating Custom
Fields.

Virtual Folder Group

Virtual Folder Group

Use the drop-down menu to select an existing Virtual Folder
Group. You can view or edit the settings for the displayed
Virtual Folder group by clicking the View/Edit link. If you want
to create a new Virtual Folder Group, click Create New Virtual
Folder Group. For more information about Virtual Folder
Groups, see Working with Virtual Folder Groups.

Associated Record
Types

No StatusStatus
Group

Click the No Status link or click a status group link to prompt
users to associate a record type. For more information about
Status Group, see Working with Application Status Groups.

5. Click Save.

Enabling Submittal of Partially Completed Applications
You can enable agency users to submit partially completed applications, creating records that contain fully
functional record detail tabs. The primary mechanism that enables this functionality is a setting in the Other
Associations portlet, Enforce Validation Prior to Workflow Update, where you specify which workflow task
triggers the validation of an application.
Civic Platform flags partially completed applications with a Pending Validation flag to easily distinguish
them from validated applications when specifying records for EMSE handling and scripting, and when
searching and filtering records. For example, you might want to write a script or conduct a search only for
fully validated records.
A typical use case for this feature is when a paper application comes into the back office and is incomplete
or does not yet contain information or documentation for all of the required fields. The agency still needs to
enter the application into Civic Platform to enable payment processing, generate deficiency letters, and for
other relevant activities.
To enable agency users to submit partially completed applications
1. Access the Record Type Administration portlet (Accessing Record Type Administration).
Civic Platform displays the Record Type Administration portlet.

| Part 3: Configuring Agency Business Objects | 257

2. Open the record type for which you want to enable agency users to submit partially completed
applications. In this example, we are using a Waste Site Permit application.
Civic Platform displays the record type.

3. Click Other Associations.
Civic Platform displays the record type associations that you can modify.

| Part 3: Configuring Agency Business Objects | 258

4. Scroll to the Workflow section, and in the Enforce Validation Prior to Workflow Update area, click View/
Edit.
Civic Platform displays the Workflow Task Status to Enforce Validation screen.

5. Click the selection icon.
Civic Platform displays a navigation tree.

| Part 3: Configuring Agency Business Objects | 259

6. Use the navigation tree to select the workflow task and status that enforces application validation. For
example, the Application Acceptance task, Accepted status. By deferring validation until the application
reaches its Accepted status, agency staff can conduct business on the application without delay.

Working with Record Types
You can perform various tasks within the record type lists of a module. This section describes those tasks
including searching, filtering, and enabling record types. This section also provides instructions on how to
access online help.
Topics
•

Searching for Record Types

•

Filtering a Record Type List

•

Enabling or Disabling Record Types

•

Accessing Online Help for Record Types

Searching for Record Types
You can search for a record type by name. The record type search for each module returns results
instantly when you enter any partial search criteria into the search window. For example, if you start typing
a word that begins with the letter Co, Civic Platform returns all record types with a name beginning with Co.
To search for a record type
1. Access the Record Type Administration portlet (Accessing Record Type Administration).
2. Expand the module to reveal the associated record types.

| Part 3: Configuring Agency Business Objects | 260

3. Civic Platform supports quick search for record type aliases. Begin typing your search criteria in the
search window. For example, Co.
Civic Platform returns a list of record types meeting the search criteria.

Filtering a Record Type List
You can filter record types to easily view record types on the Record Type Administration portlet.
To filter the record types list
1. Access the Record Type Administration portlet (Accessing Record Type Administration).
2. Expand any module to reveal the associated record types.
3. Click Set Filters.
Civic Platform displays the filtering options
4. Expand the navigation tree to expose record types for each module.
5. Select which record types you want to display.

6. Click Apply Filters.
Civic Platform filters the record types based on the filter settings.

Enabling or Disabling Record Types
A record type that requires you to enable it for a module displays an Action button. Click the Action button
in the row of the record type to display the available options.

| Part 3: Configuring Agency Business Objects | 261

To enable a record type
1. Access the Record Type Administration portlet (Accessing Record Type Administration).
2. Expand the module to display the associated record types.
3. Locate the record type you want to enable or disable.
4. Click the Action button and choose one of the following:

•

Choose Enable from the drop-down list to enable the record type in the module.

•

Choose Disable from the drop-down list to disable the record type from the module.
Civic Platform enables or disables the record type for the module.

Accessing Online Help for Record Types
You can access online help for Record Types by clicking the help button in the upper right corner of the
portlet.
To access online help for record types
1. Access the Record Type Administration portlet (Accessing Record Type Administration).
2. Click the online help button on the corner of the page to access online help.
Civic Platform displays the help topic on record type configuration information.

| Part 3: Configuring Agency Business Objects | 262

Creating Record Type Filters
Civic Platform uses record type filters to show back-office users a filtered list of record types they can
select from when creating records and performing other transactions which require them to select a record
type. A record type filter shows a shorter and relevant list of record types which makes it easier for users to
select record types.
An administrator can create record type filters for the various modules used by the agency, and for the
various record transactions.
To create a record type filter
1. Go to Civic Platform Administration > Application > Record Type Filters.
2. On the Module dropdown list, select the module you want to add the record type filter to.
3. On the Action dropdown list, select the action with which the record type filter will be used. Choose one
of the following:
•

Create an Application - The record type filter will be used in the record type selection list when a
back-office or Citizen Access user creates a record (or application)

•

Amend an Application - The record type filter will be used in the record type selection list when a
Citizen Access user creates a record amendment.

•

Amend a Contact - The record type filter will be used in the record type selection list when an
authorized agent amends a contact in Citizen Access Account Management.

•

Create a Hunting License - The record type filter will be used in the record type selection list when
an authorized agent creates a hunting license in Citizen Access.

4. Click New.
5. Enter the record type Filter Name.
6. Optionally enter the Order in which the record type filter will appear in the record type selection list.

| Part 3: Configuring Agency Business Objects | 263

7. Click Select to open the list of record types to include in the filter.
8. Mark the record types to be included in the filter.
9. Click Submit to finish selecting the record types.
The following diagram illustrates the summary of steps:

The following diagram shows the new sample record type filter, Design Review, and the record types
included in the new filter:

The following diagram shows the list of record type filters for the Planning module and Create an
Application action, which includes the newly created Design Review filter:

| Part 3: Configuring Agency Business Objects | 264

The following shows the record type selection window that is displayed when a back-office user creates a
record. Note that the list of record types for the Planning module includes the new Design Review filter and
its record types:

Working with Address Type Groups
You can specify the Address Type Group Code name to associate with the application type. The purpose
is to set the types of addresses you can use or add to an application type. Specify an Address Type Group
Code name to enable Civic Platform to restrict an application type to only those specific address types
listed in the Group Code name. For more information on associating an address to an application type, see
Configuring Other Associations.

| Part 3: Configuring Agency Business Objects | 265

You can set an application type, for example, new commercial building permit, to allow users to only add
Street Address types and Parcel Address types to it. A user could also search for those same application
types based on the Address Type.
Topics
•

Searching for an Address Type Group

•

Creating an Address Type Group and Associating Address Types

•

Adding an Address Type to an Address Type Group

•

Deactivating an Address Type Group

Searching for an Address Type Group
Before you can edit an existing Address Type group, you must search for it.
To search for an Address Type group
1. Access the Address Type Group portlet (Accessing the Address Type Group Portlet).
2. Click Search.
Civic Platform displays the Address Type Group search page.

3. Enter the Address Type Group name.
4. Click Submit.
Civic Platform displays the Address Type group name in the primary portlet, and the details for the
group in the secondary portlet.

Creating an Address Type Group and Associating Address Types
You can create new Address Type groups as needed.
To create an Address Type group and associate Address Types
1. Access the Address Type Group portlet (Accessing the Address Type Group Portlet).
2. Click New.

| Part 3: Configuring Agency Business Objects | 266

Civic Platform displays the new Address Type Group Detail information in the detail portlet.

3. Enter the Address Type Group code name. This field is a code name or an abbreviation of the address
types.
The Address Type Group names display in the Address Type Group Code drop-down list when a user
creates or edits an application type. Define address types, to enable users to only associate those
unique address types to certain application types. For example, you might require that new commercial
building permits only allow users to enter Street Address types and Parcel Address types.
4. Click Submit.
Civic Platform creates the address type group.
5. Click the Address Type tab.
6. Click Look Up to locate and associate the address types with the Address Type Group name.
Civic Platform displays the Look Up page.

7. Enter the first few characters of an Address Type you want to locate and add it to the Address Type
Group name.
The available Address Types are controlled by the Values specified for the REF_ADDRESS_TYPE
Standard Choice.
8. Click Submit.
Civic Platform displays a list of Address Types that match your criteria.

9. Select the Address Type you want to add.
10.Click Select.
Civic Platform adds the Address Type to the Address Type Group.
11.To add additional Address Types, Click Look Up to return to the Address Type field and repeat through

| Part 3: Configuring Agency Business Objects | 267

Adding an Address Type to an Address Type Group
An Address Type group can contain multiple address types that allows a user to apply or search for when
creating a specific application type. Follow these steps to add Address Types to an Address Type Group
code name.
To add an Address Type to an Address Type group
1. Locate and select the existing Address Type group or create a new Address Type group.
For instructions on searching for an existing Address Type group, see Searching for an Address Type
Group.
For instructions on creating a new Address Type group, see Creating an Address Type Group and
Associating Address Types.
Civic Platform displays the Address Type Group code name detail portlet, including the Group Detail tab
and Address Type tab.

2. Click the Address Type tab in the detail portlet.
Civic Platform displays the Address Type tab.

3. Click Look Up.
Civic Platform displays the Look Up page.

4. Enter the Address Type name or Description of the Address Type you want to add.
Civic Platform displays a list of Address Types that match your criteria.

| Part 3: Configuring Agency Business Objects | 268

5. Select the Address Type you want to add.
6. Click Select.
To remove an Address Type, select it and click Delete.

Deactivating an Address Type Group
You can inactivate an Address Type group if it no longer applies within your agency.
To deactivate an address type group
1. Access the Address Type Group portlet (Accessing the Address Type Group Portlet).
2. Select the Address Type group you want to inactivate.
3. Click Delete.
To reactivate an inactive Address Type group, open the Address Type group you want to activate. In
the detail portlet, select Active from the Record Status drop-down list, and then click Save.

Working with Application Status Groups
When you create or view an application, you have the option of applying a status to each application.
Sometimes there is a group of applications that have the same list of statuses. For example, a group
of electrical building applications can all have the same list of status options, but a group of real estate
applications can have an entirely different list of statuses. In this case, you can create an Application
Status Group that applies to a specific type of application.
Topics
•

Creating an Application Status Group

•

Searching for an Application Status Group

•

Editing an Application Status Group

Creating an Application Status Group
If you do not find the status group you want, you can create a new status group.
To create an application status group
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Application > App Status Group.

| Part 3: Configuring Agency Business Objects | 269

3. Search for the group you want. For instructions, see Searching for an Application Status Group.
4. Click the red dot next to the group you want.
Civic Platform displays the Application Status Group—Edit window.
5. Click Add at the bottom of the window.
Civic Platform displays the Application Status Group—Add window.
6. Type in the status group and the status description that you want.
7. Click Save.

Searching for an Application Status Group
If you want to find a specific application status group, you can search for it.
To search for an application status group.
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Application > App Status Group.
3. Type in the group you are looking for and Click Submit, or just Click Submit to browse the groups.
4. Click the red dot that appears next to the status group that you want.

Editing an Application Status Group
In addition to editing an application status and the status group, you can also edit the status of the actual
group.
To edit an application status group
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Application > App Status Group.
3. Search for the group you want. For instructions, see Searching for an Application Status Group.
4. Click the red dot next to the group you want.
Civic Platform displays the Application Status Group—Edit window.
5. Click the red dot next to the status you want to edit.
6. Update the field:
Status

If you want to make this status available to users, select Enable; otherwise, select
Disable.

7. Click Save.

Working with Intake Form Configuration Groups
This section describes how to create and define an Intake Form Configuration Group, with instructions for
each section of the Intake Form Configuration Group, and how to include or exclude the field groups on
certain types of applications.

| Part 3: Configuring Agency Business Objects | 270

For instructions on applying an Intake Form Configuration Group to an application type, follow the steps in
Configuring Other Associations.
Topics
•

Adding an Intake Form Configuration Group

•

Searching for an Intake Form Configuration Group

•

Editing an Intake Form Configuration Group

Adding an Intake Form Configuration Group
An Intake Form Configuration Group enables you to specify parameters and settings for the fields on an
intake form. For example, you can display or hide fields, choose whether those fields are mandatory or
optional, specify where the fields display on the form, and so forth.

Intake Form Configuration Group Settings
You can set the following parameters for fields on intake forms:
•

Display: Do you want the field to display on the form?

•

Required: Is the field required or optional?

•

Validate: Do you want to give users the ability to validate their entry against your database?

•

Default Values: Do you want to display default values that tell users what information you expect them
to enter? (This only applies to Contact sections)

•

Display Button: Where do you want the field to display on the intake form?

•

Display Order: Where do you want the field to display on the intake form?

•

depending on the field type (for example, Default Values are only available for certain fields):

To add an Intake Form Configuration Group
1. Access the Classic Administration page (Accessing Classic Administration).
2. In the Application area, click Intake Form Configuration Group.
3. Click Add.
Civic Platform displays the Intake Form Configuration Group - Add page, illustrated in the sample
screen below. The first column lists the intake form fields and its sections, starting with Record Detail;
see Table 49: Intake Form Fields and Sections for a complete list. The columns that display horizontally
across the top of the page contain the parameters you can set for each row listed in the first column.
4. Enter a name for your new Intake Form Configuration Group.
5. For each row in the first column, specify the parameter settings for the columns that display horizontally
across the top of the page. For complete details of these settings, see Table 48: Intake Form
Configuration Group Parameter Settings.

| Part 3: Configuring Agency Business Objects | 271

Table 48: Intake Form Configuration Group Parameter Settings

Display

Click Yes to display the field on the intake form.
Click No to hide the field on the intake form.

Required

Click Yes to require the user to complete this field. If you click Yes, users cannot submit
the form unless the form contains the required information. Click No to make this field
optional. If you click No, users can submit the form without entering a value in this field.

Validate

Click Yes to enable a Validate button on the form. If a section requires validation, users
can only search and add information from the reference database into the section. The
reference database can be the local Civic Platform database, an external data source that
holds address, parcel, owner data, or data from ‘PERMITS’ Plus, Kiva, or GIS.
If you click Yes at the Validate and Required options of the Applicant or Contact section,
all the other sections and the fields in the intake form are inactive until users validate the
section. If a contact list requires validation, you only need to validate the primary contact
in the list. Click No to disable validation. If a section does not require validation, users
can enter new information or modify the information that they select from the reference
database.

| Part 3: Configuring Agency Business Objects | 272

Default Value

Specify a default value from the drop-down list to indicate the information you expect the
user to enter in the field. For example, if users generally enter billing information in this
form, you can set the default value for a contact field to “billing contact,” so that a user
who is completing the form sees “Billing Contact” in the field.
For the Multiple Contact fields, click the “Click to add contact types” link and add the
default contact types and the minimum number of contacts a user must enter. When you
set default values to “required,” users must enter the information on the form before Civic
Platform allows them to submit the form.

Display Button

Check the As Owner option to display the As Owner button in this section on the form. To
hide this button, clear the check box.
Check the As Lic Pro option to display the As Lic. Pro button in this section on the form.
To hide this button, clear the check box.
Note:
In Civic Platform 7.1.0 or earlier versions, the display of the As Owner and As
Lic. Pro buttons on the Applicant and Contact sections was controlled by FID
8235-Search Owner and FID 0008 Reference Licensed Professionals. Upgrading
Civic Platform to Version 7.2.0 automatically migrates the display settings of
the As Owner and As Lic. Pro buttons to Intake Form Configuration Group
configuration.

Display Order

Enter a Display Order number that represents the field’s position on the form. For
example, to display the Record Detail first on the form, enter 1.

Table 49: Intake Form Fields and Sections

Record Detail

The Record Detail section of a form displays the details of the record. The only
parameter that you can set for this section is the Display Order.

Address

The address section of an intake form lets users enter the address of the primary parcel,
including a range of street and unit numbers.
If you set the Display and Required parameters in this section to Yes, Civic Platform
validates whether a user adds information to the Addresses section on the Location tab
upon the submittal of a new record.

Parcel

The parcel section of an intake form lets users enter information about the parcel. The
County Assessor’s Parcel Number (APN) determines the parcel information.
If you set the Display and Required parameters in this section to Yes, Civic Platform
validates whether a user adds parcel information to the Parcels tab upon the submittal of
a new record.

Owner

The owner section of an intake form lets users enter information about the individual or
institution that owns the parcel, property, or structure.
If you set the Display and Required parameters in this section to Yes, Civic Platform
validates whether a user adds owner information to the People tab upon the submittal of
a new record.

Licensed Professional

The licensed professional section lets users enter contractor, architect, engineer, or
developer (CAED) information. The state usually provides this information, including the
license number and license type.
If you set the Display, Required, and Validate parameters in this section to Yes, Civic
Platform validates whether a user adds licensed professional information to the People
tab upon the submittal of a new record.

| Part 3: Configuring Agency Business Objects | 273

Applicant

The applicant section lets users enter information about the individual or institution who
submits the form. If you set the Validate and Required parameters in this section to Yes,
the Validate button displays in this section. All other sections of the form are inactive,
and the user must complete the Applicant section and click the Validate button to
activate the other sections. You cannot activate this section if you activated the Multiple
Contacts section.
If you set the Display, Required, and Validate parameters in this section to Yes, Civic
Platform validates whether a user adds applicant information to the People tab upon the
submittal of a new record. If you specify a default value for this section, Civic Platform
also validates whether a user adds the required type of applicant.

Contact 1
Contact 2
Contact 3

Up to three Contact sections on a form let users enter information about billing, legal,
and any additional contacts.
If you set the Validate and Required parameters in any Contact section to Yes, the
Validate button displays in the section. All other sections of the form are inactive, and
the user must complete any Contact sections and click the Validate button to activate the
rest of the form.
If you set the Display, Required, and Validate parameters in this section to Yes, Civic
Platform validates whether a user adds contact information to the People tab upon the
submittal of a new record. If you specify a default value for this section, Civic Platform
also validates whether a user adds the required type of contact.
NOTE: You cannot activate this section if you activate the Multiple Contacts section.

Multiple Contacts

Set the Display option to Yes to display multiple contacts as a list and to allow users to
add more than three contacts. From the list of contacts, users can set a primary contact
and can search for, add, and delete contacts.
When you activate the Multiple Contacts section, you cannot activate the Applicant and
Contact 1, Contact 2, and Contact 3 sections.
If you set the Validate and Required parameters in this section to Yes, the Validate
button displays in this section. All other sections of the form are inactive, and the user
must complete the section and click the Validate button to activate the other sections. If
you set the Required parameter to Yes and Validate to No, Civic Platform only enforces
the Required parameter.
Note:
Multiple Contacts require the intake form available in Civic Platform 6.5. To get
this form contact Accela Customer Support and request the Civic Platform 6.5.0
Migration Document for application intake form consolidation (07ACC-03396) to
migrate to the new intake form.
If you set the Display, Required, and Validate parameters in this section to Yes, Civic
Platform validates whether a user adds contact information to the People tab upon the
submittal of a new record. If you specify a default value for this section, Civic Platform
also validates whether the user added the required type of contact.

Complainant Information

The complainant section lets users enter information to identify an individual or institution
who registers a complaint. Only include this section for intake forms that you use in the
code enforcement module.
NOTE: The complaint and complainant sections of an Intake Form Configuration
Group only work with Classic Administration - Daily User. They do not work in V360.
Best practice is to configure Complaint and Complainant fields in Application Specific
Information or Application Specific Information Tables for the enforcement record types.

| Part 3: Configuring Agency Business Objects | 274

Complaint Information

The complaint section lets users enter a description of a complaint, including the
reported address. Only include this section for intake forms that you use in the code
enforcement module.
NOTE: The complaint and complainant sections of an Intake Form Configuration
Group only work with Classic Administration - Daily User. They do not work in V360.
Best practice is to configure Complaint and Complainant fields in Application Specific
Information or Application Specific Information Tables for the enforcement record types.

Additional Information

The additional information section lets users enter information that the U.S. Census
Bureau requires in a C404 report. This report, also known as the “Report of Privatelyowned Residential Building or Zoning Permits Issued,” surveys new residential units,
additions, and alterations.

Application Status

Click Yes to display the Application Status. Civic Platform displays the Application Status
based on the Application Status Group assigned to the Application Type. Click No to
hide the Application Status.

Application‑Specific
Information

The application-specific information section enables you to enter custom information
specific to your agency.

Associated GIS Features

For information about GIS, refer to the Accela Civic Platform GIS Administrator Guide.
If you set the Display and Required parameters in this section to Yes, Civic Platform
validates whether a user adds GIS features to the Map Objects section on the Location
tab upon the submittal of a new record.

Structure

The structure section lets users enter information about any structures under
construction. For example, “Twin Pines Mall.”

Establishment

An establishment is a business or residence that occupies space in a structure. For
example, users can enter information about a store in a mall.

Event

The event section lets users access an existing calendar and schedule an event related
to the intake form.

Asset

Click Yes to display the Asset Section in a new permit intake form.
Click No to hide the Asset Section in a new permit intake form.
If you set the Display and Required parameters in this section to Yes, Civic Platform
validates whether a user adds asset information to the Assets tab upon the submittal of a
new record.

Application- Specific Info
Table

Click Yes to display the ASI Table section in a new permit intake form.

Documents

The documents section lets users attach documents, such as building plans or an
insurance bond, to a permit application. The value you enter in the Default Value field
indicates the number of documents users can attach. You can configure the maximum
number of documents or set a fixed number of documents in the Default Value field. If
you set the Default Value to null, there is no limit to the number of documents you can
allow users to add to a permit application.

Click No to hide the ASI Table section in a new permit intake form.

To set a maximum number of documents, enter “<=#” in the Default Value field. For
example, if you want to set the maximum number of documents at 10, enter <=10. You
can also set a maximum number of documents by entering <# For example, if you want
to set the maximum number of documents at 10 or fewer, enter <11. To set a fixed
number of documents, enter “=#” in the Default Value field. For example, if the fixed
number of documents is 5, enter =5.
If you set the Display and Required parameters in this section to Yes, Civic Platform
validates whether a user adds a document to the Attachments tab upon the submittal of
a new record.
Education

This section lets users enter the Education credentials of a licenced professional.

| Part 3: Configuring Agency Business Objects | 275

Continuing Education

This section lets users enter the Continuing Education credentials for a licenced
professional.

Examination

This section lets users enter the Examination details of a licenced professional.

Comments

This section lets users enter any additional description or details about the application.

Searching for an Intake Form Configuration Group
To edit an existing Intake Form Configuration Group, you first need to find the group in your system. To
see a list of all Intake Form Configuration Groups, click Submit without entering the details about an
individual group.
To search for an Intake Form Configuration Group
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Application > Intake Form Configuration Group.
3. Enter the name of the group that you want to find in the Group Name field.
4. Click Submit.
Civic Platform displays the Intake Form Configuration Group browse page.
5. Click the red dot that appears next to the group that you want.

Editing an Intake Form Configuration Group
After you set up an Intake Form Configuration Group, you might need to change certain details about it.
You can change the standard sections that you want to display in a group, as well as change the required
and validation status of each section.
You cannot change the group name.
To edit an Intake Form Configuration Group
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Application > Intake Form Configuration Group.
Civic Platform displays a list of Intake Form Configuration Groups.
3. Click the red dot by the Intake Form Configuration Group that you want to edit.
Civic Platform displays the Intake Form Configuration Group Details-Edit page.

| Part 3: Configuring Agency Business Objects | 276

4. Update the values for each section of the application as defined in Table 48: Intake Form Configuration
Group Parameter Settings and Table 49: Intake Form Fields and Sections.
5. Click Save.

Working with Virtual Folder Groups
When you upload an attachment in Civic Platform, the user who uploads the attachment can select from
a pre-defined list of folders or create a new virtual folder as appropriate. However, Citizen Access users
can only select from the pre-defined virtual folder group to upload attachments. Assignation of attachments
to virtual folders serves the same purpose as an actual folder: It allows users to organize uploaded
attachments into groups (folders), making it easier to keep track of those attachments.
You can create as many virtual folders and folder groups as you need, by creating standard choices (virtual
folder groups) with the desired values (virtual folders) you want to use. You can then associate each virtual
folder group with a corresponding record type.

| Part 3: Configuring Agency Business Objects | 277

Note:
Existing users with file upload permissions (FID 8212) can edit the virtual folder settings.

Topics
•

Accessing the Virtual Folder Group Settings

•

Creating a New Virtual Folder Group

•

Viewing or Editing a Virtual Folder Group

•

Assigning a Virtual Folder Group to a Record Type

Accessing the Virtual Folder Group Settings
1. Access the Record Type Administration portlet (Accessing Record Type Administration).
2. Expand the module you want to work with by clicking the down arrow on the right side of the module
bar.
A list of existing record types displays.
3. Select the record type for which you want to create a virtual folder group by clicking the record type
alias hyperlink. If you have a large number of record types, you can use Search to locate the desired
record type by name.
The record type summary displays.
4. In the left panel, click Other Associations.
5. From the list of associations at the top of the window, click Virtual Folder Group.
Civic Platform displays the Virtual Folder Group settings.

Creating a New Virtual Folder Group
You can add new virtual folder groups directly from the Record Type Administration portlet.
To create a new virtual folder group
1. Access the Virtual Folder Group Settings (Accessing the Virtual Folder Group Settings).
Civic Platform displays the Virtual Folder Group settings.
2. Click Create New Virtual Folder Group.
The New Standard Choice form displays in a new window.

| Part 3: Configuring Agency Business Objects | 278

3. Enter the name of the new virtual folder group you are creating in the Standard Choices Item Name
field.
4. Describe the folder group you are creating; enter usage and relevant information.
5. In the Status field, select Enable.
6. In the Type field, select Business Configuration.
7. Select Virtual Folder from the drop-down list below the Type field.
8. Click Submit.
Civic Platform creates the new Virtual Folder Group. Now you must add virtual folders to your group.
9. Click Add at the bottom of the window (below the Standard Choices Value banner).
The Add Standard Choices Value form displays in a new window.
10.Enter the name of the virtual folder you want to add to the group in the Value field.
11.In the Value Desc field, describe the folder group you are creating; enter usage and relevant
information.
12.In the Status field, select Enable.
13.Click Submit.
Civic Platform adds the new folder below the Standard Choices Value banner.
14.Repeat from for each folder you want to add to the group.
15.When you finish adding folders, click Update to save your new virtual folder group and folders.
16.Close the window and return to the Virtual Folder Groups section of the Other Associations tab on the
Record Settings portlet.
17.Click Refresh

.
The new virtual folder group is now available for assignment to a record type in the drop-down list to the
far left.

Viewing or Editing a Virtual Folder Group
You can access virtual folder group details directly from the Record Type Administration portlet.
To view or edit Virtual Folder group details
1. Access the Virtual Folder Group Settings (Accessing the Virtual Folder Group Settings).
Civic Platform displays the Virtual Folder Group settings.

| Part 3: Configuring Agency Business Objects | 279

2. Select the virtual folder group you want to view/edit.
3. Click the View/Edit link to the right of the field.
The Standard Choices Item - Edit window displays.
4. Make modifications to the settings as needed.
5. click Update if you made changes, then close the window.

Assigning a Virtual Folder Group to a Record Type
To make virtual folders available for use to users, you must assign the appropriate virtual folder group to
each record type. You can create a unique virtual folder group for each record type. You can also assign
a single virtual folder group to multiple record types. You cannot, however, assign multiple virtual folder
groups to a single record type.
To assign a virtual folder group to a Record Type
1. Access the Virtual Folder Group Settings (Accessing the Virtual Folder Group Settings).
Civic Platform displays the Virtual Folder Group settings.
2. Select the virtual folder group you want to associate with the current record type.
If you do not see the virtual folder group you need, you might need to add it. See Creating a New Virtual
Folder Group for information about adding a new virtual folder group.
3. Click Save in the left side panel, near the bottom.
Civic Platform assigns the selected virtual folder group to the current record type. Folders contained
within are available to users when they upload documents to records of the current type.

Associating Record Types
You can define record types that are dependent on other record types. A use case example for this is:
when public users pay fees for a record type in their shopping cart, they must also complete the application
or renewal for the dependent record types. Otherwise, the user receives a payment failure message.
For instance, a nurse applies for a nurse practitioner license, and their registered nurse license expires.
Upon check-out for the nurse practitioner license, the nurse sees on the cart page a payment failure
message informing them that they must renew and pay for the registered nurse license. After renewing and
paying for the registered nurse license, the nurse can pay for both types of licenses in the shopping cart.
When nurses renew and pay for their registered nurse licenses, they see an associated nurse practitioner
license link for application on the receipt page in the shopping cart.
To associate record types
1. Access the Record Type Administration portlet (Accessing Record Type Administration).
2. Expand any module to reveal the associated record types.
3. Locate the record type you want to work with.
4. Click the Other Associations portlet.
5. Locate the Associated Record Types section.
6. Do any of the following to define a record status for the selected record type:

| Part 3: Configuring Agency Business Objects | 280

•

To define the selected record type with no status, click the No Status link.

•

To define the selected record type with a status group, click the status group link.
If you do not see any status group other than theNo Status link, customize the Status Group
section. For more information about Status Group, see Working with Application Status Groups.

•

To define the selected record type with a specified record status, do the following:

a. Expand the desired record status group to display the statuses within that group.

b. Click any of the record status.
Civic Platform displays the Record Type List.

7. Select the Record Type you want to associate.
8. Click Select.
An information pops up.

9. Click OK.
Civic Platform associates a record type with another record type.

| Part 3: Configuring Agency Business Objects | 281

10.Click Save.

Setting Default Clone Options
You can define default clone options that display when users invoke Clone Sgl and Clone Mult.
Note:
The Default Clone Options portlet must be enabled (FID 0367) before you can set default clone options by
record type.

To set default Clone Options
1. Access the V360 Administration portlet.
2. In the Setup panel, select Application > Default Clone Options.
The Default Clone Options portlet displays.
3. Select the record type for which you want to set default clone options.
You can use either the tree view to drill down to the record type you want to use. You can also click
Search to locate the record type you want.
A list of data options displays.

| Part 3: Configuring Agency Business Objects | 282

4. Select which data you want to copy from the source record to the destination record. You can select a
single option or multiple options.
If you select an option that has a Select link, use the link to drill down to more specific data. For
example, you can click the Select link for Contact to select which contact types you want to copy.
5. Click Save.

Managing Documents for Attachments
•

Enabling Users to Upload and Download Documents

•

Creating a Document Group

•

Searching for a Document Group

•

Editing a Document Group

•

Working with Document Types

•

Setting Required Document Types

•

Large File Upload in Civic Platform

Enabling Users to Upload and Download Documents
To enable users to upload and download documents, configure your agency Security Policy as shown
below.
Users can download and print multiple documents at one time. See the Civic Platform User Guide for
details on downloading and printing documents.
To enable users to upload and download documents
1. Go to Classic Administration and select Agency Profile > Security Policy > EDMS Access Security >


| Part 3: Configuring Agency Business Objects | 283

2. Select the download and upload options for the agency, module, or group where you want to enable
downloading multiple documents.
3. Click Save.
4. Repeat steps 1-3 for each EDMS that is configured in your Civic Platform environment.

Creating a Document Group
A document group lets you organize the different types of documents that users might need to add to
certain applications. When you create a new document group, you determine the group name and add an
initial document type to the group. You can add more document types to the group when you edit it.
To create a document group
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Review > Document.
3. Click Add.
Civic Platform displays the Document Type Add page.

| Part 3: Configuring Agency Business Objects | 284

4. Create a new document group by providing a name in the New Group field.
5. Add Document Types to the Document Group. For specific instructions on how to add document types,
see Adding a Document Type.

Searching for a Document Group
You can search for any document group currently defined on your system. For example, you can search
for a document group if you want to add or update document types, or if you want to view the details for a
certain group. To see a list of all document groups in alphabetical order, click Submit without entering any
information in the search field. You can also enter partial information to perform a partial search.
To search for a document group
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Review > Document.
3. Enter the group name in the Select Group field.
4. Click Submit.
Civic Platform displays the Document Group—Browse page.
5. Click the red dot that appears next to the group that you want.

Editing a Document Group
After you create a document group, you might need to change it. When you edit a document group, you
can change any of the document types that make up the group. After you create a document group, you
cannot delete the group without first deleting all document types that make up the group. When you delete
the last document type, Civic Platform automatically deletes the group.
To edit a document group
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Attachments > Documents.
3. Search and select the document group you want to modify.

| Part 3: Configuring Agency Business Objects | 285

4. To add, edit, or delete an additional document type, see Adding a Document Type.
5. ClickSubmit.

Working with Document Types
This section provides instructions on how to work with document types associated with a document group
and, if your agency uses Citizen Access, define how to apply permissions to public users for the document
type.
Topics
•

Adding a Document Type

•

Editing a Document Type

•

Deleting a Document Type

Adding a Document Type
After you create a document group, you can add document types to the group. The document types that
you set up apply to both the electronic and non-electronic documents, and determine how users categorize
the documents associated with an application. If your agency uses Citizen Access, you must indicate
which public users have permissions to view, upload, and delete the document type attachment online.
The public user types include: All Citizen Access users (including anonymous users), registered users,
Licensed Professionals, Record Creator, Contact, and Owner. Administrators can specify which licensed
professionals can upload, delete, or view the document type by clicking the License Type button and
selecting the appropriate options. If you want to restrict access to a specific document, navigate to the
document tab for the record and assign additional permission settings. For instructions on how to restrict
access to a specific document, see “Defining Citizen Access Permissions for a Document” in the Accela
Civic Platform User Guide.
To add a document type
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Attachments > Document.
3. Search for the document group that you want.
4. Click Add.
Civic Platform displays the Document Type-Add page.

| Part 3: Configuring Agency Business Objects | 286

5. Complete one of these fields to define the document group code:
Select Group

Choose an existing document group.

New Group

Type in what you want to name the new group.

Note:
You should not enter a new group name here unless you want to create a new group as well as a new
document type. When you choose an existing group, Civic Platform automatically populates this field with
your choice, because this field is a required field.

6. Complete the document type fields as described in Document Type Fields.
If you want to specify the licensed professional types allowed to upload, delete, or view the document
type in Citizen Access, click Licensed Professional, indicate the specific licensed professional types,
then click Select.
7. Click Submit.
Table 50: Document Type Fields

Checklist Group

Select a checklist group for the document type. Upon a successful upload of a
document, if a checklist group is associated with the document type of the document,
Civic Platform automatically adds the Auto Create checklists in the checklist group as
the document review checklist for the document. Users can add more checklists or
checklist items for the document review if they want. The steps to configure checklists
and checklist groups for document reviews are the same as configuring checklists
and checklist groups for inspections. For more information, see Managing Checklist
Groups.

Comment

Enter any comments or notes about the document type.

| Part 3: Configuring Agency Business Objects | 287

Deletable in Citizen
Access

Select which public users have permission to delete the document in ACA.

Document Group

Document Group is a read-only field that displays the name of the Document Group for
the Document Type.

Document Type

Enter the document type that you want to include in the group.

Download Automatically
to Accela Wireless?

Select Yes if you want to download files of this document group automatically to Accela
Wireless; otherwise, select No.

Downloadable in Citizen
Access

Select the users for which you want to grant permission to download the documents
of this document type. When you select Licensed Professional, click the License Type
button to select the desired licensed professionals.

Set Permissions for
Citizen Access

Select Yes to grant permission on documents of this document type to Citizen Access
users; otherwise, select No.

Uploadable in Citizen
Access

Select those individuals for which you want to grant permission to upload documents
of this document type. When you select Licensed Professional, click the License Type
button to select the desired licensed professionals. For users without Title Viewable
in Citizen Access permission, if you grant this permission to them, they can upload
documents of this document type, but they cannot view them in the document list.

Title Viewable in Citizen
Access

Select those individuals for which you want to grant access to view the document titles
of this document type. When you select Licensed Professional, click the License Type
button to select the desired licensed professionals. Note: Those users without this
permission consequently cannot download or delete documents of this document type,
even though they have the downloadable and deletable permissions.

Editing a Document Type
After you add a document type to a document group, you might need to change it. You can update type
name as well as any comments about it. If you no longer want to include the document type in the group,
you can delete it.
To edit a document type
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Review > Document.
3. Search for the document group that you want.
4. Click the red dot that appears next to the document type that you want.
Civic Platform displays the Document Type-Edit page.
5. Complete the necessary fields as described in Document Type Fields.
6. Click Submit.

Deleting a Document Type
You can delete any document type in a document group. After you delete the last document type in a
group, Civic Platform automatically deletes the group. Civic Platform prompts you when this happens and
gives you the option to cancel the deletion of the document group.
To delete a document type
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Review > Document.

| Part 3: Configuring Agency Business Objects | 288

3. Search for the document group that you want.
4. Click Delete to the right of the document type that you want.
5. Click OK.

Setting Required Document Types
Agencies can configure Civic Platform to require certain documents when an agency user submits a
new application of a given type. Agencies can also configure document requirements when a public user
submits a new application of a given record type via Citizen Access or Mobile Office. Agencies can also
configure Civic Platform to require certain documents before a workflow task status change occurs.
You can access the Required Document Setting form both from the Administration tool in Civic Platform
and from the Citizen Access Setup form. The following procedure describes how to access the Required
Document Setting from the Administration tool.

The Role of Scripting in Required Document Functionality
Agencies can use existing EMSE scripting functionality to require documents dynamically as part of new or
existing record processing. For example, agencies can create a script that auto-applies a notice condition
that prompts for the required documents after a new application submission (ApplicationSubmitAfter)
or after a workflow status update (WorkflowTaskUpdateAfter). Agencies can also create a script
(DocumentUploadAfter) that clears required document conditions once required documents get uploaded.
Agencies may have more complex document submission requirements. For example, agencies may
configure a page flow in Citizen Access Administration to prompt for or validate required documents
by associating scripts to the OnLoad or OnSubmit event in the relevant step. Agencies can write the
script to block or not to block the page flow if a validation fails. For existing records, agencies can
use scripting to enforce or prompt for required document submissions against various business rules
for events like workflow status update (WorkflowTaskUpdateAfter) or application specific info update
(ApplicationSpecificInfoUpdateAfter).

Setting Required Document Types by Record Type
When you set required documents, the list of required documents displays on the application intake
form when a user adds a new record from Civic Platform, Citizen Access, or Accela Mobile Online. This
informs the user which documents he must prepare and submit. If the user does not attach the required
documents, he cannot submit the application.
Note:
If EDMS is not accessible from Citizen Access, the public user may be able to submit his application without
the required documents.

Before you can set required documents, you must have the following in place:
•

The desired document group code and assigned documents types for that group code must exist
and have an association with the record type you are working with. See Managing Documents for
Attachments.

•

The document group code to which you apply required document settings must be consistent for both
Civic Platform and Citizen Access, if the record type you are working with is available to both Civic
Platform and Citizen Access.

To set required document types by record type
1. Access the Record Type Administration portlet (Accessing Record Type Administration).

| Part 3: Configuring Agency Business Objects | 289

2. Expand the module you want to work with by clicking the down arrow on the right side of the module
bar.
A list of existing record types displays.
3. Select the record type for which you want to set required document types by clicking the record type
alias hyperlink. If you have a large number of record types, you can use Search to locate the desired
record type by name.
The record type summary displays.
4. In the left panel, click Other Associations.
5. From the list of associations at the top of the window, click Document Code.
Civic Platform displays the Document Code settings. A document group code must be assigned to
the record type you are working with. If not, you must assign a document group code. See “Managing
Documents for Attachments” for more information about assigning or changing a document group code.
6. Click the View Edit link for Required Document Types.
The Required Document Setting form displays.

7. To set required documents for new record submission:
•

Click the picker to the right of Required for New Record Submission. A widget displays a list of
documents included in the selected document group.

•

Select the document type(s) that your agency wants to require as part of a new record submission.
If needed, you can mark Select All to require all the listed documents. The selected document types
display in the Required for New Record Submission box.

8. To set required documents for a workflow task status update:
•

Click the picker to the right of Workflow Task/Status Check.

•

Select each task status for which you want to require a document submittal.

•

Each time you select a task status, Civic Platform adds a new row to the Required for Workflow
Status Update list. In the example below, we selected three workflow status options. Civic Platform
added three rows - one for each status option - for you to configure individually.

| Part 3: Configuring Agency Business Objects | 290

9. Click outside the widget to exit the widget and interact with the new rows.
10.Click the picker to the right of the Document Types box for one of the workflow task/status check rows.
A widget displays the list of document types for the selected document group.

11.Select the document type(s) that your agency wants to require before the workflow can advance with
the selected status. If needed, you can mark Select All to require all the listed document types.
The selected document types display in the Document Types box.
12.Repeat the previous two steps for each workflow task you have listed.
13.Click Save.

Large File Upload in Civic Platform
When uploading a single file in Civic Platform, a 1GB maximum file size is supported. When uploading
multiple files, 10 files may be uploaded in one batch. No single batch should exceed 1GB.

| Part 3: Configuring Agency Business Objects | 291

Configuring Large File Upload in Civic Platform
The EDMS Standard Choice parameter EDMS_DOCUMENT_SIZE_MAX allows the user to determine the
default maximum size for EDMS document attachments. Modify the value of the Standard Choice EDMS
parameter EDMS_DOCUMENT_SIZE_MAX to equal 1000MB as follows.
1. Log in to Civic Platform.
2. Click the main link for Civic Platform administration.
3. Click Agency Profile > Standard Choices.
4. Search for the existing Standard Choice by entering EDMS in the Standard Choices Item Name. field.
5. Click Submit.
6. Click the red dot to the left of EDMS.
7. In Value Desc, modify the value of EDMS_DOCUMENT_SIZE_MAX parameter to equal 1000MB.

Configuring Third Party Plan Review Integration
This topic pertains to Civic Platform's e-PlanCheck integration, referred to as "third party plan review
integration" throughout.
•

Preparation

•

Mapping Data for Third Party Document Review

•

Preparing Document Types

•

Other Admin Configuration

Preparation
Before proceeding with the configuration to enable third party plan review integration, agencies must do the
following:
•

Configure a Civic Platform user account for third party use.

•

Include all permissions for the user account that are needed to complete a document review task, such
as review status update and check-in.

•

Designate an API account for the third party application. This account will be dedicated for API calls.
Make note of the account name/password, and the web application URL.

•

Configure the following standard choices: EXTERNAL_DOC_REVIEW (used to define connectivity and
authentication of the third party plan review tool, as well as enable the mapping portlet for the named
plan review tool), and EXTERNAL_REVIEWERS (used to accommodate plan reviewers who are not
Civic Platform users).

Use this Civic Platform user account information along with the URL for the Civic Platform API to configure
the connection to Civic Platform in the third party software. Refer to the third party software documentation
for more information.

| Part 3: Configuring Agency Business Objects | 292

Mapping Data for Third Party Document Review
To integrate the Civic Platform with a third party document review tool such as EPC or e-PlanCheck,
agency administrators need to map Civic Platform fields to the third party document review fields.
A data mapping tool is available to help you do that. After you configure the standard choice
EXTERNAL_DOC_REVIEW, this data mapping tool is enabled.
Topics
•

Accessing the Third Party Mapping Tool

•

Mapping Record Types

•

Mapping Record Statuses

•

Mapping Departments

•

Mapping Construction Types

•

Mapping Contact Types

Accessing the Third Party Mapping Tool
Configure the standard choice EXTERNAL_DOC_REVIEW to make this tool available in the Administration
portlet.
1. Open the Civic Platform Administration tool.
2. In the Setup panel, select Document > 3rd Party Integration.

Mapping Record Types
Use the record type mapping tab on the 3rd-Party Integration portlet to map Civic Platform record types to
key fields in the third party review tool, such that the sum of the fields is equivalent to the Civic Platform
record type.
Example: Map the Civic Platform record type “Building/Commercial/New Building/With Plans” to ePlanSoft
(EPC) field values for Project Type=New Building, Permit Type=With Plans, and Occupancy=Business.
When a plan is assigned for review in Civic Platform, the Civic Platform record type displays. When the
same plan is opened in EPC, the field values for Project Type, Permit Type, and Occupancy display as you
mapped.
Note:
When mapping values between Civic Platform and EPC, note that EPC permit type options display as string
values rather than as the associated labels for each value. This is because the Create Permit EPC API
accepts the EPC Permit Type string value, not its key, as the required parameter. Other EPC field values
display label values.

To map record types
1. Access the third party mapping tool (see Accessing the Third Party Mapping Tool).
2. Select the Record Type Mapping tab.
3. Click New.
The record type mapping form displays.

| Part 3: Configuring Agency Business Objects | 293

4. Select the Civic Platform record type you want to map.
A record type picker is available to the right of the Record Type field. Use it to locate and select a
record type.
5. For each of the following fields in the third party tool, select a value such that, when the three are
combined, they form an equivalent value to the selected Civic Platform record type. If none of the
defined project or permit types on EPC properly map to the selected Civic Platform record type, select
Add New to add new project or permit type values on EPC.
3rd-party Project Type

Type of project, such as Commercial or Residential. If you add a new ‘Project
Type’ value (select Add New), Civic Platform uses the subtype string value for
the selected Civic Platform record type as the new ‘Project Type’ value to add
to EPC.

3rd-party Permit Type

Type of permit being requested, such as Deck or Roof.If you add a new
‘Permit Type’ value (select Add New), Civic Platform uses the category string
value for the selected Civic Platform record type as the new 'Permit Type'
value to add to EPC.

3rd-party Occupancy

Use of building, such as Factory/Industrial or Residential.

6. Click Submit.

Mapping Record Statuses
Use the record status mapping tab on the 3rd-party Integration portlet to map Civic Platform record status
to equivalent status values in the third party review tool.
To map record statuses
1. Access the third party mapping tool (see Accessing the Third Party Mapping Tool).
2. Select the Record Type Mapping tab.
3. Select an existing record type mapping from the list.
The mapping page displays for the selected record type mapping.
4. Select the Record Status Mapping tab.
5. Click New.
A blank row is added to the record status mapping list.

| Part 3: Configuring Agency Business Objects | 294

6. Select a Civic Platform record status value from the drop-down list on the left.
7. Select a corresponding third party permit status type value from the drop-down list on the right.
8. Click Submit.
9. To map an additional record status, click New and repeat this process.

Mapping Departments
Use the department mapping tab on the 3rd-party Integration portlet to map Civic Platform department
names to equivalent department values in the third party review tool.
To map departments
1. Access the third party mapping tool (see Accessing the Third Party Mapping Tool).
2. Select the Department Mapping tab.
3. Click Add.
A blank row is added to the department mapping list.

4. Select a Civic Platform department value from the drop-down list on the left.
5. Select a corresponding third party department value from the drop-down list on the right, OR
Select Add New to automatically add the Civic Platform department string value to EPC.
Note:
The Add New option enables agencies to automatically build the same department structure on EPC as
exists on Civic Platform without having to manually input the departments separately in EPC

| Part 3: Configuring Agency Business Objects | 295

Note:
Agencies should ensure that the department defined in the EPC user profile is the same one that maps
to the department to which the mapping AA user belongs. If the User ID and Department values are not
consistently defined, review task assignments will return an error

6. Click Submit.
7. To map an additional department, click Add and repeat this process.

Mapping Construction Types
Use the construction type mapping tab to map Civic Platform construction type values to equivalent
construction type values in the third party review tool.
To map construction types
1. Access the third party mapping tool (see Accessing the Third Party Mapping Tool).
2. Select the Construction Type Mapping tab.
3. Click Add.
A blank row is added to the construction type mapping list.

4. Select a Civic Platform construction type value from the drop-down list on the left.
5. Select a corresponding third party construction type value from the drop-down list on the right, OR
Select Add New to automatically add the Civic Platform construction type string value to EPC.
Note:
The Add New option enables agencies to automatically build the same construction types on EPC as
exist on Civic Platform without having to manually input the departments separately in EPC

6. Click Submit.
7. To map an additional construction type, click Add and repeat this process.

Mapping Contact Types
Use the contact type mapping tab to map Civic Platform contact type values to equivalent contact type
values in the third party review tool.
To map contact types
1. Access the third party mapping tool (see Accessing the Third Party Mapping Tool).
2. Select the Contact Type Mapping tab.

| Part 3: Configuring Agency Business Objects | 296

3. Click Add.
A blank row is added to the contact type mapping list.

4. Select a Civic Platform contact type value from the drop-down list on the left.
5. Select a corresponding third party contact type value from the drop-down list on the right, OR
Select Add New to automatically add the Civic Platform contact type string value to EPC.
Note:
The Add New option enables agencies to automatically build the same contact types on EPC as exist on
Civic Platform without having to manually input them separately in EPC

6. Click Submit.
7. To map an additional contact type, click Add and repeat this process.

Preparing Document Types
Agencies need to confirm that the document types are properly configured for third party integration.
Agencies should ensure that the following are in place:
•

If your agency is using EPC as your third party plan review tool, create a document type called Plan in
Civic Platform. Agency users must use this new document type, Plan, for any document or plan to be
reviewed in EPC. As you configure the Plan document type, be sure to configure the Document Status
Group and Review Status Group for the new document type.

•

For both the Plan and Correction Notice Report document types, you need to ensure that public access
via the Citizen Access is enabled. Do this by choosing Yes for the ‘Set Permission for ACA’ option for
each document type.

Other Admin Configuration
Agencies need to:
•

Confirm that Street Type values (for example, Ave or Blvd) match on both Civic Platform and
on the third party document review tool. In Civic Platform, street types are configured in the
STREET_SUFFIXES standard choice.

| Part 3: Configuring Agency Business Objects | 297

Creating Custom Fields
Custom Fields are agency-defined fields that you create and display on records in Civic Platform, based
on the specific needs of your agency. To reuse the same Custom Fields in various record types, you can
create Custom Fields Groups and Subgroups. These Custom Fields Groups and Subgroups enable you to
design application intake forms for specific types of records, such as building permits, zoning applications,
or enforcement complaints. Citizens can then fill in these custom fields when they apply for permits, fill
out complaint forms, and submit zoning applications. You choose the order in which the fields display and
specify other information as well.
You can globally change Custom Fields Groups for applications already existing in your Accela system,
regardless of the application’s status. This includes completed applications, applications that are moving
through a workflow, or partially completed applications submitted through Citizen Access. You can define
the processes surrounding what happens when you create or modify Custom Fields and how those
changes impact existing applications.
Certain components of Citizen Access user interface can be customized using Custom Fields. You can
display pop-up windows, write instructional text, customize the text and size of labels, change page flows
and their display order, and add watermarks. You do this by configuring the Citizen Access sections of
Custom Fields Groups and Subgroups.
Click a topic title below for full details.
Related Information
Working with Custom Fields Groups and Subgroups
Auto Filling Custom Fields with GIS Object Attribute Values
Designing Custom Fields Layouts for Citizen Access
Working with Custom Fields Groups
Custom Fields Lookup Tables

Working with Custom Fields Groups and Subgroups
When you create a new Custom Fields Group, you specify the group code, the name, and the first field
to include in the group. Then you set up other information about the field, including the field type and a
default value. You can then create additional fields, change the order of fields in the group, and change
any field values. When you add new fields to a Custom Fields Group, you have the option to include the
newly added fields to existing records.
Click a topic for full details:
•

Creating a New Custom Fields Group or Subgroup

•

Searching for a Custom Fields Group

•

Working with Custom Fields Subgroups

Creating a New Custom Fields Group or Subgroup
1. Go to Administration > Setup Portlet > AA Admin.
2. Expand the appropriate module, then click the link for the record type you want to work with.
3. Click Other Associations.

| Part 3: Configuring Agency Business Objects | 298

4. Click or scroll to the Custom Fields Group section.
5. Click Create New Custom Fields Group.
Civic Platform displays the Custom Fields Group – Add page.

6. Complete the fields that display. For a description of the fields, see Table 51: Fields you can modify in a
Custom Fields Group .
7. Click Submit.

Searching for a Custom Fields Group
To view or edit an existing Custom Fields Group, you must first locate the group you want to work with.
1. Go to Classic Administration (Accessing Classic Administration) and click the Admin Tools tab.
2. Select Application > Custom Fields. The Custom Fields Search page displays.
3. To see a list of all groups, click Submit without entering details.
4. To find a specific group, enter the Custom Fields Group Code and/or Subgroup Code, then click
Submit.

| Part 3: Configuring Agency Business Objects | 299

5. Click the red dot next to the group you want to work with.
Civic Platform displays the Custom Fields — Edit and Manage Subgroups page.

Working with Custom Fields Subgroups
Each Custom Fields Subgroup represents a group of fields on a section of an application intake form.
For example, you will want to display general information fields at the top of the application intake form,
and then display specific fields in discreet sections that comprise the rest of the form. For each of those
sections, you'll want to create a separate supgroup.
For your Citizen Access website, you can design the layout of fields and instructional text via the ACA
Configuration button on the Custom Fields subgroup page. For more information, see Designing Custom
Fields Layouts for Citizen Access.
Topics
•

Changing the Display Order of a Subgroup

•

Deleting a Subgroup from a Group Code

•

Creating a New Subgroup Within a Custom Fields Group

•

Adding an Existing Subgroup to a Custom Fields Group

•

Editing a Subgroup

Changing the Display Order of a Subgroup
You can change the positioning of where a group of fields displays on an application intake form.
To change the display order of a subgroup
1. Locate the Custom Fields Group you want to work with. For instructions, see Searching for a Custom
Fields Group.
Civic Platform displays the Custom Fields — Edit and Manage Subgroups page.
2. Enter the display order in the Display Order field. For example, if you want the subgroup to display first
on the application intake form, enter 1.

| Part 3: Configuring Agency Business Objects | 300

3. If you want to change order in which the fields display within a subgroup, click the red dot next to the
subgroup you want to modify.
Civic Platform displays the Custom Fields page.
4. In the Display Order field, enter the number that represents the field's position on the form relative to
the other fields on the form.
5. Click Update.
Civic Platform updates the display information.

Deleting a Subgroup from a Group Code
If you no longer need a subgroup associated with an application specific information group code, you can
remove the subgroup.
To delete a subgroup from a group code
1. Locate the Custom Fields Group you want to work with. For instructions, see Searching for a Custom
Fields Group.
2. Select the Delete option next to each subgroup you want to remove.
3. Click Submit.

Creating a New Subgroup Within a Custom Fields Group
To create a new subgroup within a Custom Fields Group
1. Locate the Custom Fields Group you want to work with. For instructions, see Searching for a Custom
Fields Group.
2. Click New.
Civic Platform displays the Custom Fields Group—Add page.
3. Complete the fields that display. For a description of the fields, see Table 51: Fields you can modify in a
Custom Fields Group .
4. Click Submit.
Civic Platform adds the new subgroup, and then displays the Custom Fields page.

Adding an Existing Subgroup to a Custom Fields Group
To add an existing subgroup to a Custom Fields Group
1. Locate the Custom Fields Group you want to work with. For instructions, see Searching for a Custom
Fields Group.
2. Click Add.
Civic Platform displays the Custom Fields Group Code — Add page.
3. Select the Group Code containing the existing subgroup you want to add.
Civic Platform displays all of the subgroups associated with the group code you selected.
4. In the Subgroups field, select the subgroup you want to add.
5. Click Add.
Civic Platform adds the selected subgroup to the group code you are working with.

| Part 3: Configuring Agency Business Objects | 301

6. Click Update.

Editing a Subgroup
After you create a Custom Fields Group, you might need to update a subgroup within the group. You can
apply any changes you make to all subgroups. For information about applying or updating user access
security permissions to a subgroup, see Setting Up Security Policies.
To edit a subgroup
1. Search for the Custom Fields Group with the subgroup that you want to edit. For instructions, see
Searching for a Custom Fields Group.
2. Click the red dot next to the subgroup that you want to edit.
Civic Platform displays the Custom Fields Group page.

3. Select whether to apply changes to this subgroup only or to all subgroups.
4. Update the fields that display. For a description of the fields, see Table 51: Fields you can modify in a
Custom Fields Group .
5. Click Update.
Table 51: Fields you can modify in a Custom Fields Group

ACA Configuration

If your agency implements Citizen Access, click the ACA Configuration button, then
design the Citizen Access form display for the group. For more information, see
Designing Custom Fields Layouts for Citizen Access.

ACA Displayable

This option controls the ability for citizens to view Custom Fields in Citizen Access.
For example, you can specify whether or not a citizen can view the property frontage
information on a planning application.
Select Yes to give users full or read-only access to Custom Fields in Citizen Access,
then set the Custom Fields Security (Setting Up Security Policies) to full or read-only.
Select No to hide the Custom Fields in Citizen Access. Use the Hidden option for
expressions when the value from a field not displayed on the form becomes updated by
the expression or the expression criteria uses the value.

| Part 3: Configuring Agency Business Objects | 302

ACA Searchable

This option controls the ability for citizens to search for Custom Fields in Citizen
Access. For example, citizens can search for the property frontage information on a
planning application.
Select Yes to allow users to search on Custom Fields in Citizen Access. Select No to
hide the Custom Fields on the search form.
There are four combinations of settings for the ACA Displayable and ACA Searchable
options:
If you select Yes for both options, the Custom Field displays and is available for use in
the search form.
If you select Yes for ACA Displayable, but No for ACA Searchable, the Custom Field
displays as read only in the search form.
If you select No for ACA Displayable and Yes for ACA Searchable, the Custom Field
does not display in the search form. This is not best practice. If you do not want the
field to display in the search form, select No for both options.

Alternative ACA Label

Enter a custom field label to display to public users on web pages in Citizen Access,
to enable the agency to ask questions to an applicant during the application intake
process online. For example, you can change a field label from “Criminal History”
to “Have you or any member of your immediate family, including spouse, children,
parents, or siblings been convicted of a crime?” This field is available only when you
are adding a field to a Custom Fields subgroup.

Custom Fields Group

Enter a unique code to identify the Custom Fields Group that you are creating. If
you are creating a subgroup for an existing group code, Civic Platform automatically
populates this field with the group code that you are working with.
This field is read-only when you are editing a subgroup or adding a field to a Custom
Fields Group.

Custom Fields Subgroup Enter the name of the Custom Fields subgroup you are creating.
This field is read-only when are editing a subgroup.
Custom Fields Subgroup Enter a subgroup alias. The alias replaces the subgroup name in all areas that the
Alias
Custom Fields subgroup displays to users in Civic Platform, Citizen Access, and Mobile
Office.
Custom List

Choose a Custom Lists Group. You must create the Custom Lists Group before you
can choose it. For more information, see Working with Custom Lists.

Apply changes to all
subgroups

Choose this option if multiple groups contain the subgroup and you want to apply the
changes to the subgroup in all groups.

Apply changes to this
subgroup only

Choose this option if multiple groups contain the subgroup and you just want to apply
the changes to the subgroup in current group.

Default Value

Enter a default value for the field. If you are adding a Custom Fields Group, this field
defines the default value for the first field in your subgroup.
Note:
If you are setting up a drop-down list, you can add values to the drop-down
list so that a user can choose between multiple values. For instructions, see
Setting or Editing Drop-Down List Field Values.

Display Len

Specify the maximum number of characters that Civic Platform displays.

Display New Custom
Field on Existing
Contacts

Select Yes to apply the new Custom Field to existing contacts. Select No to apply the
new Custom Field to new contacts only.

| Part 3: Configuring Agency Business Objects | 303

Display New Custom
Field on Existing
Records

Select Yes to apply the new Custom Field to existing applications. Select No to apply
the new Custom Field to new applications only.

Display new Custom
Field on existing
Education/Examination/
Continuing Education

Choose Yes to make the new user-defined field, table, or sub-group of user-defined
fields available to existing education, examination and/or continuing education records
in addition to being available for new records. Choose No to apply the new userdefined objects to new records only.

Display Order

Enter a number to determine the position of the field in a subgroup. If you are adding
a Custom Fields Group, this field determines the position of the first field in your
subgroup.

If you cannot see the option, you must configure the related Standard Choice. Refer to
the Accela Civic Platform Configuration Reference for additional information.

For example, to display the field before any other fields, enter 1.
Fee Indicator

To use the field value in fee calculations, enter the unique 5-digit code that you use to
identify this variable in a fee formula. You must use a value between 10100 and 10599
and use the format displayed: $fixxxxx$ For example, enter $fi10101$

Field Type (or Type)

Choose the type of field. If you are adding a Custom Fields Group, this field defines the
type of the first field in your subgroup. For more information on field types, see Adding
a Field to a Custom Fields Group.
If the field type is a drop-down list, click Edit to update, add, or delete values from the
drop-down list. For instructions, see Setting or Editing Drop-Down List Field Values.

Field Label (or 1st Field
Label)

Enter the label of the field. If you are adding a Custom Fields Group, this field defines
the label for the first field in your subgroup.
For example, if you want to prompt end-users to specify a date, enter the word Date.

Group Display Order

Enter a number to specify the position of this Custom Fields Group on ab application.
For example, if you want this a Custom Fields Group to display in the second position,
enter 2.

Justification

Use the drop-down list to determine the justification of the field value. If you display
Citizen Access in a Cyrillic font, which reads from the right side of the page to the
left, you can specify a text justification that takes into consideration the font direction.
The default setting uses left-alignment. If you cannot see any options, you must
configure the related Standard Choice. For more information about the justification, see
“Setting Custom Field to Right Justification” in the Internationalization Installation and
Administrator Guide.

Location Query

Select Yes to support populating the Custom Fields with the map data from multiple
GIS layers.
Select No to allow populating the Custom Fields only with the map data from the layer
where the selected GIS object lies.

Max Len

Specify the maximum number of characters that the field accepts.

Req for Fee Calc

To require users to complete the Fee Calculation fields, click Yes or choose Yes from
the drop-down list.
Fields required for Fee Calculation display a visual indicator ($) on an application form.
You must configure FID 0242 Required for Fee Calculation to enable this feature.

Required Flag (or
Required)

To require users to enter a value in this field, click Yes or choose Yes from the dropdown list.

Searchable Flag (or
Searchable)

To let users search for applications based on this field, click Yes or choose Yes from
the drop-down list.

Status

To let users see this group or this field in Civic Platform, click Enable or choose
Enabled from the drop-down list; otherwise, click Disable or choose Disabled.

| Part 3: Configuring Agency Business Objects | 304

Supervisor Edit Only

Select Yes or choose Yes from the drop-down list to make this information read-only to
non-supervisor users after a user creates an application. For instructions, see Limiting
Custom Field and Custom List Editing Rights to Supervisors Only.

Unit or New Unit

Enter any desired unit such as square feet, dollars, or miles that you want to attach to
the field value. Choose from Standard Choices, or enter a new unit.
Note:
If you are editing Custom Fields subgroup, you cannot enter a new unit.

Auto Filling Custom Fields with GIS Data
Civic Platform can automatically populate Custom Fields in an application intake form with GIS object
attribute values when a user attaches a GIS object to the application intake form. GIS objects may
represent assets or parcels on the map.
•

Enabling Custom Fields Auto-Filling

Enabling Custom Fields Auto-Filling
To enable Custom Fields auto filling in Civic Platform
1. Create a mapping relationship where attributes of GIS objects on the various map layers are mapped to
specific Custom Fields.
For instructions, see “Creating Attribute Mapping” in the Configuring Civic Platform section of the Accela
Civic Platform GIS Administrator Guide.
2. If you want to automatically populate Custom Fields with attribute values of the GIS object that
represents an asset, map each asset in Civic Platform to a GIS object in the legacy Accela GIS.
Skip this step if you only need to automatically populate Custom Fields with attribute values of the GIS
object that represents a parcel.
For instructions, see Asset Types.
3. Make sure that the record contains the Custom Fields for which you have created attribute mapping by
associating the record type with the Custom Fields group code.
4. Do any of the following:
•

Launch the map viewer from the main console or the Record list portlet, select a GIS object that
represents an existing asset in the Civic Platform database, and click Create New Record, Create
Single Work Order, or Create Multiple Work Orders.

•

Look up an existing parcel that you can plot on the map and add it to the Parcel section.

•

Launch the map viewer from the Parcel section, select a GIS object that represents an existing
parcel in the Civic Platform database, and click Send GIS Features.

•

Look up an existing asset that you can plot on the map and add it to the Asset section.

•

Launch the map viewer from the Asset section, select a GIS object that represents an existing asset
in the Civic Platform database, and click Link Object to Work Order.

•

Launch the map viewer from the Associated GIS Features section, select a GIS object that either
represents an existing parcel or asset, and click Send GIS Features.

| Part 3: Configuring Agency Business Objects | 305

Note:
If you attach multiple parcels, assets, or associated GIS features to a record all at once, a dialog box
prompts you to set one item as primary. The Custom Fields get the corresponding values from the
attributes of the primary GIS object.

Civic Platform uses the attributes from the GIS object in the new application form.

Designing Custom Fields Layouts for Citizen Access
If your agency provides Citizen Access, you can customize the layout and display of Custom Fields
on your Citizen Access page. You can design instructional text, labels, field arrangements, page flow
configuration, display order, and you can add watermarks. You can configure this through the Citizen
Access configuration section of the Custom Fields group and subgroup. For additional information on how
to design a form layout for Citizen Access, refer to the “Working with Web Pages” chapter in the Citizen
Access Administrator Guide.
Topics
•

Defining Custom Fields Layouts for Citizen Access

•

Customizing Fields for Citizen Access

Defining Custom Fields Layouts for Citizen Access
Custom Fields Layouts provide the ability to define online form displays in Citizen Access. For example,
you can set the display order in a page flow, add instructional text, and design layouts for labels and
columns.
Note:
When you hide Custom Fields using expressions on a page for a subgroup, Citizen Access re-aligns the
displayable fields appropriately. There is no indication of a missing or hidden field.

To design a layout for Citizen Access
1. Locate the Custom Fields groups and subgroups that you want to design for Citizen Access. For
instructions, see Searching for a Custom Fields Group.
Civic Platform displays the group and subgroup information.
2. Click ACA Configuration next to the group or subgroup requiring layout configuration.
Civic Platform displays the Layout Configuration pop-up page.

| Part 3: Configuring Agency Business Objects | 306

3. Complete the fields as described in Table 52: Custom Fields Group and Subgroup Layout Configuration
Fields.
4. Click Save.
Table 52: Custom Fields Group and Subgroup Layout Configuration Fields

Column Arrangement

This field becomes active when you choose to provide the Custom Fields group
information in a two column layout. Use the drop-down menu to define how you want to
display the subgroup information. Choices are vertical and horizontal. Choose Vertical
if you want information to display down the page first, then to flow to the next column.
Choose Horizontal if you want information to flow across the page horizontally, row by
row.
Note:
This setting only applies to the application page flow, and does not apply to
the Record Detail page and Record Review page.

Column Layout

Use the drop-down field to set how the fields display in a column. Choose single
column layout or two-column layout for Custom Fields subgroup fields in the application
page flow, the Record Detail page, and the Record Review page in Citizen Access.

Field Arrangement

This field is active when you choose to provide the Custom Fields subgroup fields in a
two-column layout. Use this drop down list to determine if the fields display from left to
right or top to bottom arrangements. For example, if you number the fields 1-6, fields 1,
3, and 5 display in the left column; fields 2, 4, and 6 display in the right column for left
to right alignment. In the top to bottom arrangement, fields 1,2, & 3 in left column and 4,
5, and 6 in right column.

Instructions

Use this text field to enter any accompanying instructional text for the group or
subgroup. This field supports embedded hyperlink functionality.

Label Display

Specify where you want to position the field label in relation to the field. Choose Top for
the label display to be above the field. Choose Left to have the label to the left of the
field.
Note:
This setting only applies to the application page flow, and does not apply to
the Record Detail page and Record Review page.

Page Index

This configuration determines if the information displays on one or more pages in a
pageflow in Citizen Access.
Set the display order for Custom Fields subgroup information in pageflows by entering
a number in the Page Index field.
For example, if all subgroups have a Page Index number of 1, then all the subgroups
display on one page in Citizen Access. If you want the subgroups split up onto different
pages, enter the appropriate number for each subgroup page a configured sequence.
For example, 2 indicates a second page, 3 indicates a third page, and so forth.

Customizing Fields for Citizen Access
Use the Citizen Access Configuration page to define the field labels, provide instructional text, or create
watermarks for Custom Fields. This section provides details to help you to customize fields for Citizen
Access. For more information on how to customize fields for Citizen Access, refer to the “Working with
Web Pages” chapter in the Citizen Access Administrator Guide.
Note:
When you hide Custom Fields, Citizen Access re-aligns the displayable fields appropriately. There is no
indication of a missing or hidden field.

| Part 3: Configuring Agency Business Objects | 307

To customize Custom Fields for Citizen Access
1. Navigate to the Custom Fields or Custom Lists subgroup that contains the fields that require
customization.
Civic Platform displays the Custom Fields page.
2. Click ACA Configuration next to the field requiring customization.
Civic Platform displays the Citizen Access Configuration page.

3. Complete the fields as described below:
Alternative ACA Label

Provide a custom label for the field in this here.

Instruction

Enter any instructional text to indicate the data you are trying to collect in this field.

Watermark

Enter sample text for how the user is to complete the field. This information displays in
a faint watermark in the text field.

4. Click Submit.

Working with Custom Fields Groups
Topics
•

Adding a Field to a Custom Fields Group

•

Editing a Field in a Custom Fields Group

•

Deleting a Field from a Custom Fields Group

•

Setting or Editing Drop-Down List Field Values

•

Applying Shared Drop-down Lists

•

Mapping a Field to a Session or SQL-Defined Variable

•

Working with Custom Lists

•

Deleting Custom List Subgroups and Columns

•

Configuring Custom Field and List Drill-downs

•

Limiting Custom Field and Custom List Editing Rights to Supervisors Only

| Part 3: Configuring Agency Business Objects | 308

•

Configuring the Record Detail Audit Log

Adding a Field to a Custom Fields Group
You can add any number of fields to a Custom Fields Group. The fields you add to a Custom Fields Group
become available in the Custom Fields Form Layout Editor. You can also specify whether to display a
newly-added field on existing records.
Once you've added the Custom Field to a group, you can add it to a form, using the Custom Fields Form
Layout Editor. These are the field types that are supported in the Custom Fields Form Layout Editor:
•

Number Field: Lets users enter only numeric characters in a number field. A number field displays the
word “number” to the right of the field.

•

Text Field: Lets users enter only text characters in a text field. A text field displays the word “text” to the
right of the field.

•

Text Area: Lets users enter multiple lines of text, such as a three-line address.

•

Date Button: Lets users search for a date rather than entering a date manually.

•

Yes/No Option Buttons: Lets users select either a Yes or No value by selecting the option.

•

Drop-down List: Lets users choose a value from a list of predefined values determined by your
agency.

•

Time: Lets users enter a time value.

•

Money: Lets users enter a dollar amount.

•

Check box: Lets users click a check box to select the option.

To add a field to a Custom Fields Group
1. Locate the Custom Fields Group to which you want to add a subgroup.
2. Click Add.
Civic Platform displays the Custom Fields Group Code—Add page.
3. Select the Group Code containing the existing subgroup you want to add.
Civic Platform displays all of the subgroups associated with the group code you selected.
4. In the Subgroups field, select the subgroup to which you want to add a field.
Civic Platform displays the Custom Fields page.

5. Click Add.

| Part 3: Configuring Agency Business Objects | 309

Civic Platform displays the Custom Fields Field—Add page.
6. Complete the fields that display. For a description of the fields, see Table 51: Fields you can modify in a
Custom Fields Group .
7. Click Submit.

Editing a Field in a Custom Fields Group
After you create a Custom Fields Group, you might need to change it. You can add or delete fields, or
change the field type, its display order, and its default value. However, you cannot change the group code,
the group name, or the field labels when you edit the group. Changing a field label requires that you delete
the field and add it again with the new label.
To edit a Custom Fields Group
1. Locate the Custom Fields group to which you want to add a subgroup. For instructions, see Searching
for a Custom Fields Group.
2. Click the red dot next to the subgroup whose field you want to update.
Civic Platform displays the Custom Fields page.

3. Update the information about the field you want to change. For a description of the fields, see Table 51:
Fields you can modify in a Custom Fields Group .
4. Do any of the following, as appropriate for your agency's objectives:
•

Click the Security button next to the field to apply or update user access security permissions to it.
For instructions, see Setting Permissions for Custom Fields Groups and Custom Lists Groups.

•

Click the Edit button next to the field of the Drop-down List type to define the options in the dropdown list. For instructions, see Setting or Editing Drop-Down List Field Values.

•

Click the Variable Mapping button next to the field of the Text or Text Area type to map the field to
a session variable or a SQL-defined variable. For instructions, see Mapping a Field to a Session or
SQL-Defined Variable.

Deleting a Field from a Custom Fields Group
If you no longer need a field in a Custom Fields Group, you can delete it.
To delete a field from a Custom Fields Group
1. Locate the Custom Fields group that you want to add a subgroup to. For instructions, see Searching for
a Custom Fields Group.
2. Click the red dot next to the subgroup from which you want to delete a field.
Civic Platform displays the Custom Fields page.

| Part 3: Configuring Agency Business Objects | 310

3. Click Delete next to the field that you want to delete.
4. Click OK.
Civic Platform deletes the field.

Setting or Editing Drop-Down List Field Values
After you create a Custom Fields Group, you can add fields to the group. If you add drop-down list fields,
you must then set the values that you want to include in the list. You can also specify a shared drop-down
list, which already has preconfigured values. For information on how to implement shared drop-down lists,
see Applying Shared Drop-down Lists.
Users can choose from field values when completing an application. For example, if you add a field to
enter contact information, you can provide a drop-down list of contact types. You can also edit existing
drop-down list values or delete drop-down values that you no longer use.
To edit drop-down list values
1. Locate the Custom Fields Group with the drop-down list whose values you need to set.
2. Click the red dot next to the subgroup that contains the field for which you want to set drop-down list
values.
Civic Platform displays the Custom Fields page.
3. Click Edit next to the drop-down list you want.
Civic Platform displays the Custom Fields Drop-down List—Add page.
4. Choose one of the following:
•

To add a new value, click Add, enter the value in the Item Value field, and then click Submit.

•

To update an existing value, replace the value text and then click Update.

•

To delete a value, click Delete.

Applying Shared Drop-down Lists
After you create a Custom Fields Group, you can add a drop-down field to the group. If you add drop-down
list fields, you must then set the values that you want to include in the list. You can implement a shared
drop-down list, which already has preconfigured values.
For information on how to create a shared drop-down list, see Creating Shared Drop-down Lists.
To apply a shared drop-down list
1. Locate the Custom Fields Group to which you want to apply the shared drop-down list. For instructions,
see Searching for a Custom Fields Group.

| Part 3: Configuring Agency Business Objects | 311

2. Click the red dot next to the subgroup that requires you to configure the drop-down list values.
Civic Platform displays the Custom Fields page.

3. Click Edit next to this drop-down list you want to modify.
Civic Platform displays the Custom Fields Drop-down List-Add page.

4. Select the Use Shared Drop-down Lists option.
5. Do one of the following:
•

Click Search to return all shared drop-down lists.

•

Enter the first letter of the drop-down list, or any other search criteria, then click Search.
Civic Platform returns the Shared Drop-down List-Browse page.

6. Click Select next to the drop-down list you want to apply.

| Part 3: Configuring Agency Business Objects | 312

Note:
You can only select one shared drop-down list.

Civic Platform returns to the Custom Fields Drop-down List-Add page, and displays the Field Values
from the shared drop-down list in blue.
7. Click Update.

Mapping a Field to a Session or SQL-Defined Variable
Administrators can map Custom Fields to a session variable or SQL-defined variable. When you use the
field as a template field in a report with the Save to EDMS option set to Yes, Civic Platform can retrieve the
value of the template field based on the variable mapping for the field. If Civic Platform retrieves a blank
field value from session information or SQL query results, or fails to retrieve any value, an alert displays
and you must enter the field value manually.
Civic Platform provides you with a set of standard out-of-the-box session variables. This set of variables
include frequently used parameters from Civic Platform such as Department, Module, or Service Provider
Code. For more information and a list of these session variables, see Table 53: Session Variables in
Variable Mapping.
To map a field to a session or SQL-defined variable
1. Locate the Custom Fields Group that you want to work with.
2. Click the red dot next to the desired subgroup.
Civic Platform displays the Custom Fields page.
3. Click the Variable Mapping button next to the Text or Text Area field you want to modify.
Civic Platform displays the Variable Mapping page.

4. To map the Custom Field to a session variable, do the following:
From the Type drop-down list, select SessionVariable.
Civic Platform refreshes the Variable Mapping page to display the Value field as a drop-down list.

Select the session variable to which the Custom Field is mapped from the Value drop-down list. For a
description of the session variables, see Table 53: Session Variables in Variable Mapping.
5. To map the Custom Field to an SQL variable, do the following:

| Part 3: Configuring Agency Business Objects | 313

From the Type drop-down list, select Variable.
Enter an SQL statement in the Value field to retrieve the field value at run time.
6. To remove the relationship between the Custom Field and variable, leave the Type and Value fields
blank on the Variable Mapping page.
Table 53: Session Variables in Variable Mapping

Variable

Description

ALTID

Retrieves the alt(ernate) ID from a specific portlet.

AssetNbr

Retrieves the asset sequence number from a specific portlet.

CAPID

Retrieves the alt(ernate) ID from a specific portlet.

CollectionID

Retrieves the public user collection ID.

Department

Retrieves the department of the logged-in user.

DocumentID

Retrieves the document sequence number from a specific portlet.

GAUserID

Retrieves the ID of the logged-in user.

InvoiceBatchNbr

Retrieves the invoice batch number.

InvoiceNbr

Retrieves the invoice sequence number.

Language

Retrieves the language that the logged-in user selected. For example, en_AU
(for Australian English) or en_US (for US English).

Module

Retrieves the module name from a specific portlet.

ParcelID

Retrieves the parcel number from the Parcels portlet.

PortletID

Retrieves the portlet ID of a specific portlet.

ProviderNumber

Retrieves the provider number.

PublicUserID

Retrieves the user login ID that a public user generates when they create an
account.

ServiceProviderCode

Retrieves the agency code for the logged-in user.

SetID

Retrieves the set ID from a specific portlet.

StateLicNum

Retrieves the official number that identifies the business license issued by the
state.

Today

Retrieves today’s date. The workstation's system date determines this date.

TransactionID

Retrieves the transaction ID.

TrustAccountReceiptID

Retrieves the trust account receipt number.

UserFullName

Retrieves the logged-in user’s full name.

UserGroup

Retrieves the group name of the logged-in user.

UserID

Retrieves the ID of the logged-in user.

Working with Custom Lists
Administrators can set up Custom Lists that enable users to add custom data with zero-to-many
relationships. This enables you to store the same data for multiple items. For example, you might want to
store the quantity and manufacturer for different types of fixtures, such as bathtubs, sinks, and drains. The
Custom List name becomes the label that displays for the user.
A Custom List can have as many data fields with as many individual data types as you require. You can
make all of the table data fields available for use during fee calculation and for Event Manager Scripting
Engine (EMSE) scripts.

| Part 3: Configuring Agency Business Objects | 314

Topics
•

Creating a Custom List

•

Editing a Custom List

Creating a Custom List
Administrators can create new tables to let users add custom data to applications. Custom Field tables can
have as many data fields with as many individual data types as you need.
To create a Custom List
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Application > Custom Lists.
Civic Platform displays the Custom Lists – Search window.
3. Click Add.
Civic Platform displays the Custom Lists Group – Add page.

4. Complete the fields to define the structure of the Custom List you want to create. For a description of
the fields, see Table 54: Custom List Group Fields.
5. Click Submit to save the new table group.
Civic Platform displays the structure of the table you are defining.
6. Select whether to apply changes to this subgroup only or to all subgroups.
7. Make any necessary changes in the subgroup. For a description of the fields, see Table 54: Custom
List Group Fields.
8. To delete a subgroup, click Delete next to the subgroup you want to delete.
Note: Deleting all subgroups from a Custom List group also deletes the table group.

9. To add an existing subgroup, complete these steps:
a. Click Add.
Civic Platform displays the Custom List Group Code—Add pop up.

| Part 3: Configuring Agency Business Objects | 315

b. Select whether to apply changes to this subgroup only or to all subgroups.
c. Complete the necessary fields. For a description of the fields, see Table 54: Custom List Group
Fields.
d. Click Submit.
10.Click Update.

Editing a Custom List
Administrators can edit Custom Lists. You can change the display order, add instructional text, and add or
delete subgroups.
To edit a Custom List
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Application > Custom Lists.
Civic Platform displays the Custom Lists—Search window.
3. Enter relevant search criteria in the Group Code and Subgroup fields and click Submit. To browse all
tables, click Submit without entering any search criteria.
4. Click the red dot beside the Custom List that you want to edit.
Civic Platform displays the Custom Lists—Edit and Manage Subgroups window.

5. To change an existing subgroup’s display order, enter the number to determine the position in the
Display Order field and click Update.
6. To allow users to sort Custom List fields, clear the Disable Sorting check box. To prevent users from
using the column sort, select the Disable Sorting option.
If you clear Disable Sorting, a sort control arrow displays on the heading of each Custom List column
in all applicable locations in Civic Platform. Users can sort a column in the Custom List in ascending or
descending order.

7. To add instructional text for a group, click ACA Configuration, enter instructional text into the
Instructions text field, and then click Save.
8. To delete a subgroup, click Delete next to the subgroup you want to delete.

| Part 3: Configuring Agency Business Objects | 316

Note:
Deleting all subgroups from a Custom List group also deletes the table group.

9. To add an existing subgroup from another table to the current table:
a. Click Add.
b. From the Group Code drop-down list, choose the group code that contains the subgroup you want
to add.
c. In the Subgroups field, click the subgroup you want to add.
d. Click Add.
10.To create a new subgroup:
a. Click New.
b. Edit the fields as necessary. For a description of the fields, see Table 54: Custom List Group Fields.
c. Click Submit.
11.To edit an existing subgroup in the table:
a. Click the red dot beside the table subgroup you want to edit.
Civic Platform displays the subgroup edit page.
b. Edit the fields as necessary. For a description of the fields, see Table 54: Custom List Group Fields.
12.Click Update.
Table 54: Custom List Group Fields

Custom Lists Group

Enter a unique code to identify the Custom List group that you are creating. If you
are creating a subgroup for an existing group code, Civic Platform automatically
populates this field with the group code that you are working with.

Custom Lists Group
Subgroup

Enter the name of the subgroup you are creating.

Custom Lists Group
Subgroup Alias

Enter the Custom List subgroup alias. The alias replaces the Custom List subgroup
name in all areas where it displays to users in Civic Platform, Citizen Access, and
Mobile Office.

Column Name

Enter the name of the first column for this table group.

Default Value

Enter a default value for the first field in your Custom List group.
Note:
If you are setting up a drop-down list, you can add values to the drop-down
list so that a user can choose from multiple values. For instructions, see
Setting or Editing Drop-Down List Field Values.

Display Len

Specify the maximum number of characters that Civic Platform displays.

Display new Custom Fields Select Yes to apply the new Custom Field to existing applications. Select No to
on existing Records
apply the new Custom Field to new applications only.
If you cannot see the option, you must configure the related Standard Choice.
Refer to the Civic Platform Configuration Reference for additional information.

| Part 3: Configuring Agency Business Objects | 317

Display new Custom List
on existing Education/
Examination/Continuing
Education

Choose Yes to make the new user-defined field, list, or sub-group of user-defined
fields available to existing education, examination and/or continuing education
records in addition to being available for new records. Choose No to apply the new
user-defined objects to new records only.

Display Order

Enter a number to determine the position of the first field in your Custom List group.
For example, to display the field before any other fields, enter 1.

Group Display Order

Enter a number to determine the position of this list on the Custom Lists section of
an application in Daily Activities. For example, if you want this information group to
display in the second position, enter 2.

Req for Fee Calc

To require users to complete the Fee Calculation fields, choose Yes.
Fields required for Fee Calculation display a visual indicator ($) on the permit
application form. You can configure this feature using the Function Identification
0242 Required for Fee Calculation.

Required Flag

To require users to enter a value in this field, select the Yes option.

Searchable

To make this Custom List searchable within Civic Platform, select the Yes option.

Status

To let users see this field in Civic Platform, click Enabled; otherwise, click Disabled.

Supervisor Edit Only

Select Yes to make this information read-only to non-supervisor users after a user
creates an application. For further information about this field, please see Limiting
Custom Field and Custom List Editing Rights to Supervisors Only.

Type

Choose the type of the first field in your Custom Lists group. For more information on
field types, see Table 54: Custom List Group Fields.

Deleting Custom List Subgroups and Columns
Civic Platform has an option to delete Custom Field data and Custom List columns from all reference and
transactional records. You can do this to restrict Custom Fields subgroups to only display in a historical
record, new records, or both. You can also completely remove Custom List columns from historical
transactional data, instead of just disabling the column.
If you delete the Custom List subgroup, Civic Platform deletes the information from all Custom Lists related
to the subgroup. If you delete the column within a Custom List, you remove the column information, but
the rest of the information in the Custom List continues to display. When you delete either a column or
subgroup, it removes the related data from Custom List reference data, Custom List transactional data,
Custom List drill downs, and Custom Fields security data. Expression records related to the deleted
Custom List column or subgroup remain intact. The V360 user experience pages affected are the Custom
List tab, the Record Summary tab, the new record in the Building portlet, and the Checklist tab in the
Inspections portlet.
Note:
The delete function is permanent. You cannot retrieve deleted subgroups.

You have several options when you delete a Custom List column or subgroup. You can combine any of
these options to determine the desired result. The first option is to apply the changes to only the selected
subgroup or to all subgroups. The second is to remove the Custom List column or subgroup from the
reference and associated Checklist transactional records. The third option enables you to hide the Custom
List columns and subgroups for future records, but leave them visible in historical records.
To delete Custom List columns and subgroups
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Application > Custom Lists.
Civic Platform displays the Custom Lists - Search page.

| Part 3: Configuring Agency Business Objects | 318

3. Enter relevant search criteria in the Group Code and Subgroup fields and click Submit. To browse all
tables, Click Submit without entering any search criteria.
4. Click the red dot beside the Custom List that you want to edit.
Civic Platform displays the Custom Lists — Edit and Manage Subgroups window.

5. To delete the entire subgroup, click Delete.
Civic Platform displays the Custom Lists Subgroup - Delete page.

6. Select the associated data you also want to delete.
Click Submit.
Civic Platform deletes the subgroup, along with any associated data that you selected for deletion.
7. To delete a column within the Custom List subgroup, click the red dot next to the subgroup, then click
Delete next to the column you want to delete.
Civic Platform displays the Custom Lists Column - Delete page.

8. Do one of the following:

| Part 3: Configuring Agency Business Objects | 319

•

If you are deleting a Custom List column, select either Apply changes to this subgroup only or
Apply changes to all subgroups. If you select Apply changes to this subgroup only, Civic Platform
only removes the column from the current subgroup. If you select Apply changes to all subgroups,
Civic Platform removes the column from all of the subgroups in which the Custom List displays.

•

To hide the column and subgroup for future records, but leave them visible in historical records, click
Submit without selecting any options.
Civic Platform closes the page and hides the column or subgroup from new records.

Configuring Custom Field and List Drill-downs
You must configure Civic Platform to display Custom Field and Custom List drill-downs for Civic Platform
users. The configuration steps include:
•

Setting three FIDs

•

Defining the Custom Field information in Classic Administration

•

Creating or editing shared drop-down lists

•

Creating or editing Custom List drill down records.

You can associate a Custom Fields Group with a Custom Field or Custom List in your application. To
specify the application to apply the field or list to, you must associate the Custom Fields group or Custom
List group with the record type. The shared drop-down lists contain the values for the Custom Field or
Custom List drill-downs.
Note:
As soon as you associate the Custom Fields Group with a Custom List drill-down, the drill-down displays on
the application, even if you have not assigned values to the drill down record. You can set the Custom Field
or Custom List drill-down record as “inactive” until it is ready for the application.

Custom List drill-downs allow users to search for the value of a column with a drill-down approach. This
drill down displays in the application. The drill-down functionality guides the user through a series of
drop-down fields that present unique data choices based on previously-selected data fields. When you
complete all the selections, Civic Platform displays a field or list drill-down table with the value results in the
application. You can apply drill-down fields to multiple Custom Fields Groups. For example, you can apply
a list of business license types to both business and professional licenses.
For example, you can prepare a list for multiple business license types. You can specify the first option,
such as Agriculture, and then assign subgroups, such as Plants and Trees Cultivation, and Seeds and
Crops Cultivation. You can then create additional groups for each of the subgroups which narrows the
license options available. After you assign the groups and subgroups, the options display as Custom Lists
in the public user view.
Figure 13: Custom List Table Drill-Down – User View shows a sample completed Custom List table drilldown.

| Part 3: Configuring Agency Business Objects | 320

Figure 13: Custom List Table Drill-Down – User View
Custom Fields and Custom Lists drill-downs are available to both Civic Platform and Citizen Access users.
For information about the additional steps required to configure Custom Lists drill-downs for Citizen Access
applications, see “Configuring ASI Table Drill-Downs” in the Citizen Access Administrator Guide.
To configure Custom Fields and Custom Lists drill-down display
1. Create or edit the Custom Fields group and subgroup and the Custom Lists group and subgroup.
2. On the Intake Form Configuration Group (Classic Administration > Application > Intake Form
Configuration), select Yes on the Custom Fields and Custom Lists options.
For further details on Intake Form Configuration Groups, see Working with Intake Form Configuration
Groups.
3. Create or edit the shared drop-down lists with the values needed for the drill-down.
For details on completing this task, see Creating Shared Drop-down Lists.
4. Create or edit the Custom Field or Custom List drill-down record.
For details on completing this task, see Creating Custom Fields Drill-Downs.

Limiting Custom Field and Custom List Editing Rights to Supervisors Only
Administrators can set Custom Fields and Custom Lists to read-only for non-supervisor roles after an
application is submitted. This means that any user other than a supervisor can only view, not edit, the
information. Non-supervisor users can enter or change the information during application creation, but you
can designate individual fields to allow only supervisors to update those data elements after a user saves
the application. The supervisor edit only designation can also apply to individual subgroup fields in Custom
Lists. For example, an intake clerk user can create and complete all fields for an application, but after the
application is submitted, the clerk who is a non-supervisor user can read but not edit those fields.
To limit editing rights to Supervisor Edit Only
1. Access the Classic Administration page (Accessing Classic Administration).
2. Go to Application > Custom Fields or Custom Lists.
Civic Platform displays the search page.

| Part 3: Configuring Agency Business Objects | 321

3. Enter relevant search criteria in the Group Code and Subgroup fields and click Submit. To browse,
click Submit without entering any search criteria.
4. When you create or edit the Custom Fields or Custom Lists group, set the Supervisor Edit Only field
to Yes and Click Submit.

Configuring the Record Detail Audit Log
Civic Platform provides an audit log that contains modification details for each record. Audit logs enable
you to track all activity that occurs on a record, including changes to Custom Fields and Custom List data.
You can define an audit log for these activities within each application record.
When a user creates a record, the log records the first entry of each field. When a user makes a change
to any of the record details including Custom Field and Custom List values, the log records the change.
The log records the action performed such as added, updated, or deleted. The log also records the Custom
Field and Custom List subgroup, the field, the updated value, the date, the current user and the product.
For example, if an agency user needs to determine who changed custom data, such as the income value
for a specific record, and when they changed it, they can access the record audit log to view the changes.
Note:
The audit log does not record activity on a partial record. A partial record can have many details in the
application, but it is never complete until a user submits it. After it is complete and you submit the record, the
record detail audit log records the activity.

Custom Fields Lookup Tables
Topics

| Part 3: Configuring Agency Business Objects | 322

•

Understanding Custom Fields Lookup Tables

•

Creating Custom Fields Lookup Tables

•

Adding Custom Fields Lookup Table Rows and Columns

•

Searching for a Custom Fields Lookup Table

•

Editing Custom Fields Lookup Table Data

Understanding Custom Fields Lookup Tables
Custom Fields Lookup Tables provide fields for users to complete. They can also populate specific data as
a reference for an record type.
You assign the Custom Fields Lookup Table to a record type, and the Lookup data displays in the Custom
Fields section for that record type. You can also create Lookup Tables for use with expressions. With
Expression Builder, administrators can design Lookup Tables to populate data into other fields in the
Custom Fields section of a record, add a new row to the end of a Custom Fields Lookup Table, or store
new data in a Custom Fields Lookup Table.
To use the Custom Fields Lookup Tables feature, you must first create the Custom Fields group in Classic
Administration.
After you set up a Custom Fields group, you can use it in multiple record types. See Creating a New
Custom Fields Group or Subgroup.

Creating Custom Fields Lookup Tables
After you create a Custom Fields Lookup Table, you can apply it or its column data to a record via
Expression Builder (Using Expression Builder). When creating an expression you can include criteria
so the Lookup Table gets a new row added to it. For example, you can specify that if a field value for a
Custom Field has the option “R2” selected, specific data will be added to the end of the Lookup Table.
You can also add data into a specific cell of a Lookup Table based on matching criteria. For example, if a
user enters “R4” into the Zone field, then you can add a corresponding row of data to the Lookup Table.
To create a Custom Fields lookup table
1. Access the Custom Fields Lookup Tables portlet (Navigating to the Setup Portlet).
2. Click New.
Civic Platform displays the Custom Fields Lookup Table Name detail portlet with Table Structure
secondary tab.
3. Click the Record Type picker, next to the Lookup Table Name field.
The Record Type navigation tree displays.
4. Use the (+) to expand the list and (-) to locate and select a record type to apply the lookup table name.
Civic Platform displays the Column Name drop-down list. The Record Type field displays the record
type selected.
5. Click New Column to add other columns to the Custom Fields Lookup Table. Do the following:
a. From the New Column drop-down list, select the column name.
See the Table 55: Custom Fields Lookup Tables Fields You Can Modify.
b. Enter a lookup table name in the Lookup Table Name field associated with the Custom Fields Group
Code for that record type.
6. Click Submit.

| Part 3: Configuring Agency Business Objects | 323

Civic Platform adds the new column to the Custom Fields Lookup Table list.
7. Repeat for each new column required for the table.
8. Click the Table Data tab to set up the content for the row cells within each column.
9. In the first field of the new row, add the text of other content as required.
10.Optionally, click New to add other rows to the Custom Fields Lookup Table.
11.Click Submit to save all modifications.
The Table Data updates to the database successfully.
Table 55: Custom Fields Lookup Tables Fields You Can Modify

Column Name

An inactive new Column Name displays. Complete and submit the Lookup Table Name
and Record Type fields. Then click Table Data and use the Record Type picker to
select a Record Type to associate the column to.

Lookup Table Name

In the Table Structure secondary tab: Add a new name for the table. Lookup Table
Name is a required field.

Record Type

In the Table Structure secondary tab: Click the record type using the Record Type
picker. Use the plus sign (+) to expand and select the record type you want to apply the
lookup table name to (record type is a required field). Then select the Column Name
from the drop-down list.

If the record type you select does not yet have a Custom Fields Group Code
associated with it, go to Classic Administration > Application > Custom Fields and set
up a Custom Fields Group. Then use the Custom Fields Form Layout Editor in Civic
Platform to design the appearance and function of those Custom Fields for that record
type.

Adding Custom Fields Lookup Table Rows and Columns
Use this page to specify the record type that contains the Custom Fields you want to add to a Custom
Fields Lookup Table. Based on the record type, you select the column data you want to add to the table.
Then use the Table Data to add rows and enter the appropriate values, data or numerical values for each
row in each column.
You can to add one or more columns to the table.
Note:
To create a table structure you must first create a Custom Fields group and optionally, a subgroup. You can
do this by going to Classic Administration > Custom Fields.

To create a Custom Fields lookup table name and add columns and data
1. In the Custom Fields Lookup Table Name detail portlet, complete these fields:
Lookup Table Name

Enter name to identify the table or its columns or functions.

| Part 3: Configuring Agency Business Objects | 324

Record Type

Locate the record type to which you want to expose Custom List data. If the record
type you select has no Custom Fields associated with it, you must use Classic
Administration to set up a Custom Fields group code. Then use the Custom Fields
Form Layout Editor in V360 Admin to design the appearance and function of the
Custom Fields.

2. Click New Column to add additional columns to the Lookup Table. Specify the column name for the
drop-down list. Repeat this step for each new column required for the table. Click Submit.
Civic Platform updates the column data and the Lookup Table Name field and Record Type field
become inactive. You cannot modify these fields.
3. Click the Table Data tab to set up the content for the row cells within each column.
4. Click New to add a new row to the Lookup Table.
5. In the first field of the new row, add the text of other content as required. This information populates for
daily users to refer to as they process the record type.
6. Add additional rows and enter the data, text, or numerical values.
7. Click Submit to save all modifications.
The Table Data updates to the database successfully.

Searching for a Custom Fields Lookup Table
To locate a Custom Fields Lookup table
1. Click Search.
Civic Platform displays the Custom Fields Lookup Table search screen.
2. Enter the full name or the initial letters for the name in the Lookup Table Name field.
3. Click Submit.
Civic Platform displays search results for you to choose from.
4. To return to the Custom Fields Lookup Tables portlet, click Search, clear the search fields, and then
Click Submit.

Editing Custom Fields Lookup Table Data
Use the Custom Fields Lookup Table portlet to add data or delete data from a row in a Custom Fields
Lookup Table.
To add data to or delete data from a row in a Custom Fields Lookup Table
1. From the Table Structure tab, mark the Column Name you need to add or remove data.
2. Click the Table Data tab.
Civic Platform displays the column names and the current data for each row.
3. Do one of the following:
a. To add a row, click New and enter the data for the new row. In the first field of the new row, add
the text of other content as required. This information populates for daily users as they process the
record type. This information displays in the Custom Fields section of the record type.
b. To enter multiple row data, Click New Row.

| Part 3: Configuring Agency Business Objects | 325

c. To delete a row, mark the check box next to the row to remove from the table and click Delete.
Civic Platform deletes the record from the Table Data list
4. Click Submit.
"Table Data Created Successfully" displays. Civic Platform saves the changes to the Custom Fields
Lookup Table Name.

| Part 3: Configuring Agency Business Objects | 326

Designing Application Intake Forms
Click a topic title below for full details.
Related Information
Understanding the Form Layout Editors
Designing a Form Layout
Creating Custom Fields Drill-Downs

Understanding the Form Layout Editors
Consult the list below to determine which Form Layout Editor tool you need to use for the type of form you
want to create or edit.
APO Form Layout Editor
The fields you add display in any of these sections on a new application: Address Information, Owner
Information, and Parcel Information.
You specify the APO Type of Address, Parcel, or Owner. When a user creates a new application, these
fields display at the bottom of the APO Type section, for example in the Owner Information section if you
added fields to the Owner APO Type.
ASI Form Layout Editor
The unique fields you add display in the application-specific information section of an application based on
the application type.
You must obtain the application-specific information group codes for the application type you want to add
fields. When a user creates an application type, these fields display in the ASI section.
To understand how to set up application-specific information group codes, see Working with ActivitySpecific Information Group Codes. An application-specific information group is a group of fields that you
want to include on an application in addition to standard fields such as contact information. You can locate
this feature in the following areas:
•

Classic Administration > Application > Application Spec Info

•

V360 Admin > Application > ASI Lookup Tables.

Asset Form Layout Editor
The fields you add display in the Asset Detail form of an asset based on the asset type.
You must obtain the Asset Template ID for the asset type where you want to add fields. When a user
creates an asset type, these fields display at the bottom of the Asset Detail form.
To learn how to set up asset templates, see Attributes and Templates
TSI Form Layout Editor
The unique fields you add display in the task-specific information section of a workflow task based on the
task.
You must obtain the task-specific information group name for the workflow task to which you want to add
fields. When a user creates an application and Civic Platform assigns a set of workflow tasks, these fields
display in the TSI section at the bottom of the Task Details form.
To understand how to set up task-specific information groups, see Configuring Agency-defined Fields
for Workflows. A workflow is a set of tasks an agency defines and follows for the purpose of managing
an application. Workflow tasks function as the agency’s to-do list when a user creates an application. A
task-specific information group is a group of fields that you want to include on a task in addition to the

| Part 3: Configuring Agency Business Objects | 327

standard task fields, such as status, status date, and comments. You can locate this feature in Classic
Administration under Admin Tools > Workflow > Task Specific Info.

Designing a Form Layout
Designing a form layout consists of the following topics.
Topics
•

Creating a Form Layout

•

Searching for a Form

•

Editing a Form Layout

•

Copying a Form Layout

Creating a Form Layout
Creating a new screen is the first step in setting up the fields you want to expose in a form to a certain
group of users. You can add, customize, and manipulate the size of each field, and use the buttons on the
screen to preview, align, add dynamic text, draw lines and insert tables.
To create a new form portlet layout
1. Access the appropriate Form Layout Editor (Accessing the Form Layout Editors).
2. Click New.
Civic Platform displays the Screen Name page.
3. Select the appropriate item from one of these drop-down lists, APO Type, Custom Fields Group Code,
Asset Template ID, or TSI Group Code:
a. Select the APO Type from the drop down list.

Select the APO Type associated with the fields you want applied to the new APO Screen Name. The
APO Screen Name might be a name to easily identify the fields or their unique functions for the APO
Type.
When a user creates a new application, the fields you add display at the bottom of the APO Type
section, for example in the Owner Information section if you added fields to the Owner APO Type.
b. Select the Custom Fields Group Code from the drop down list.

Select the Custom Fields Group Code applicable to the fields you want to apply to the new Custom
Fields Screen Name. The Custom Fields Screen Name should enable you to easily identify the fields
or functions of the Custom Fields Group Code.

| Part 3: Configuring Agency Business Objects | 328

The Custom Fields Group Code is a unique code name that identifies the custom fields you are
working with. A Custom Fields Group is a group of fields that you want to include on an application in
addition to the standard application fields such as address, contact, and owner details.
The items in this drop-down list are based on your configurations in Classic Administration > Admin
Tools tab > Application > Custom Fields.
For information and details on setting up Custom Fields Groups, see Creating Custom Fields.
c. Select the Asset Template ID from the drop down list.

Select the Asset Template ID applicable to the fields you want to apply to the new Asset Screen
Name. The fields you add display in the Asset Detail form of an asset based on the asset type.
When a user creates an asset type, these fields display at the bottom of the Asset Detail form. The
Asset Screen Name might be a name to easily identify the fields or functions of the asset template
ID or asset type.
To understand how to set up asset templates, see Attributes and Templates
d. Select the TSI Group Code from the drop down list.

Select the TSI Group Code applicable to the fields you want apply to the new TSI Screen Name. The
TSI Screen Name might be a name to easily identify the fields or functions of the TSI Group Code.
You must obtain the task-specific information group name for the workflow task to which you want to
add fields. When a user creates an application and Civic Platform assigns a set of workflow tasks,
these fields display in the TSI section at the bottom of the Task Details form.
To understand how to set up task-specific information groups, see Designing Workflows . A workflow
is a set of tasks an agency proscribes and follows for the purpose of managing an application.
Workflow tasks functions as the agency’s to-do list when a user creates an application. A taskspecific information group is a group of fields that you want to include on a task in addition to the
standard task fields, such as status, status date, and comments. You can locate this feature in
Classic Administration under Admin Tools > Workflow > Task Specific Info.
4. Click Submit.
Civic Platform displays the Screen Name page and the Available Fields page, which contains the fields
associated with the APO Type, Custom Fields Group Code, Asset Template ID, or TSI Group Code.

| Part 3: Configuring Agency Business Objects | 329

A

The Designer tab is where you create and design the form.

B

The Permission tab is where you assign permissions and make forms available to users.

C

The Preview button. Click to preview your changes.

D

The Available Fields button. Click to view the available fields you can add to this page. Double-click the
name of the field to add it to the form.

E

The Add Label button. Click to add text to the page.

F

The Add Line button. Click to add a line to the page.

G

The Add Custom Lists or Attributes button. This button is only available in the Custom Fields tool and the
Asset Form Layout Editor. Click the button to add the table associated with a Custom Fields Group Code
or an Asset Template ID to the form.

H

The Alignment buttons. Click to align the fields left, right, top, or bottom.

I

Custom Fields Properties. This link takes you to respective configuration area in Civic Platform. The fields
available pertain to the attribute template for the APO Type, the Custom Fields subgroups, or the Workflow
subgroups. If you need to add a field to available fields list, you must first add it to the respective area: the
attribute template, the Custom Fields subgroups, or the Workflow subgroups.

J

The Available Fields window. This window displays all available fields for the APO Type, Custom Fields
Group Code, Asset Template ID, and TSI Group Code. Double-click the field name to add it to the form.

5. Complete the appropriate fields for the form you are designing. Go to the substep for the screen name
you are designing: APO screen name, Custom Fields screen name, Asset screen name, or TSI screen
name.
APO Screen Name:
Align Command

Use this drop-down list after you have added fields to the screen. Highlight a
field and click Align to move the field. To align multiple fields, hold the Ctrl key,
click each field you want to move, then click Align.

APO Description

Enter descriptive text to help identify the form use or its function.

APO Screen Name

Enter the screen name for the page.

APO Type

This read-only field is pre-filled with the choice you made in .

| Part 3: Configuring Agency Business Objects | 330

Custom Fields Screen Name:
Align Command

Use this drop-down list after you have added fields to the screen. Highlight a field
and click Align to move the field. To align multiple fields, hold the Ctrl key, click
each field you want to move, then click Align.

Custom Fields Description

Enter descriptive text to help identify the purpose of the form.

Custom Fields Group Code

This read-only field is pre-filled with the choice you made in .

Custom Fields Screen Name

Enter the screen name for the page. When creating a standard Condition, this
name becomes available in the Template drop-down list of the New Condition
detail portlet.

Custom Fields Tab Label
Name

Enter the detail portlet tab label associated with this screen.

SPEAR Only

The SPEAR Only option enables you to define Custom Fields forms for a Custom
Fields group used in the application. For example, a Custom Fields group with
400 fields is a large number of fields. Not all of those fields are necessary during
record creation. Choose SPEAR only if you want to define a form for the Custom
Fields Group Code and display it on the application if you enabled ac Custom
Fields Smart Choice group.

Asset Screen Name:
Align Command

Use this drop-down list after you have added fields to the screen. Highlight a field
and click Align to move the field. To align multiple fields, hold the Ctrl key, click
each field you want to move, then click Align.

Asset Description

Enter descriptive text to help identify the form use or its function.

Asset Template ID

This read-only field is pre-filled with the choice you made in .

Asset Screen Name

Enter the screen name for the page.

TSI (Task Specific Information) Screen Name:
Align Command

Use this drop-down list after you have added fields to the screen. Highlight a field
and click Align to move the field. To align multiple fields, hold the Ctrl key, click
each field you want to move, then click Align.

TSI Description

Enter descriptive text to help identify the form use or its function.

TSI Group Code

This read-only field is pre-filled with the choice you made in .

TSI Screen Name

Enter the screen name for the page.

TSI Tab Label Name

Enter the detail portlet tab label associated with this screen.

6. Add fields to the screen.
a. Click available fields to open the available fields page.
b. If there is more than one APO template, Custom Fields subgroup, Asset template, or TSI subgroup
the available fields page has a drop-down list. Choose the template or the subgroup name from the
drop-down list. Then hold down the Ctrl key and click each field name you want to add to the page.
c. Click OK.
7. Resize and position each field using the mouse.
8. Customize the fields to change font, color, or add a watermark.
a. Right-click the field you want to customize and choose Properties.

| Part 3: Configuring Agency Business Objects | 331

Civic Platform displays the Properties window.
b. Customize the fields below.
Label

Custom label name for the field.

DB Label

Database default label name.

Watermark Label

Enter the text you want to be initially display in the field. When a user tabs or
moves off one field the results might display in the next field, replacing the
watermark label text with new data.

Font

Select the font from the drop-down list. If there are no available fonts, see the
Standard Choice in Understanding the Form Layout Editors.

Justification

Specify justification of label name with drop-down list.

Color

Click the color picker to choose the color of the text label for the field.

Width

Enter the width of the attribute field you want to display in the form.

Height

Enter the height of the attribute field you want to display in the form.

9. Delete any unnecessary fields.
a. Right-click on the field you want to delete.
b. Choose Delete from the drop-down list.
10.Add lines or additional dynamic text accessed by corresponding buttons.
11.Click Preview to evaluate whether you want to make adjustments.
12.When you are happy with the form layout click Submit.

Searching for a Form
To search for a form
1. Access the appropriate Form Layout Editor (Navigating to the Setup Portlet).
2. Click Search.
Civic Platform displays the form layout editor search screen.
3. Enter search criteria as necessary.
For a description of the fields that display on the search screen, see Creating a Form Layout.
4. Click Submit.
Civic Platform displays the screens that match your search criteria.

Editing a Form Layout
Edit Custom Fields screens by adding or removing fields, manipulating the size of the fields, or applying
customization.
To edit a form layout
1. Access the appropriate Form Layout Editor (Accessing the Form Layout Editors).
2. Select the Screen Name on which you want to act.
Civic Platform displays the Screen Name detail page.

| Part 3: Configuring Agency Business Objects | 332

3. Make the necessary edits to fields. For information on how to make changes to the screen, see
Accessing the Form Layout Editors.
4. Click Submit.

Copying a Form Layout
You can copy an existing form layout screen name from the list and update it as necessary.
To copy a form layout
1. Access the appropriate Form Layout Editor (v).
2. Select the screen you want to copy and click Copy.
3. Make the necessary edits to fields. For information on how to make changes to the screen, see
Creating a Form Layout.
4. Click Submit.

Assigning Permissions
After creating the form, decide which user group or module requires permission to edit or view the fields.
For example, you might want to assign permission for a supervisor to enter data in the fields, limit other
users to view-only access, and perhaps restrict another group from being able to see the information
whatsoever. Make the appropriate permission assignments based on the access-level required by each
user type and group.
You can further refine permissions and access-levels by setting Application Type Security, Record Type
Security, and Workflow Security. For more information about Security, see Setting Up Security Policies.
To access and assign a view
1. Access the appropriate Form Layout Editor (Accessing the Form Layout Editors).
2. Select the Screen Name on which you want to act.
Civic Platform displays the Screen Name detail page.

3. Go to the Permissions tab.
Civic Platform displays the Permissions detail portlet for the screen name.

4. Click Assign.

| Part 3: Configuring Agency Business Objects | 333

5. Select the Module, Group or User from the drop-down list.
Civic Platform displays a navigation tree with associated selection.
6. Navigate through the tree view to select the associated Module, Group, or User.
7. Click Submit.
8. Use the drop-down list to assign Full Access, Read Only, or No Access for the Module, Group, or
User.
You can change the access level at any time.
9. Click Submit.

Creating Custom Fields Drill-Downs
Custom Fields drill-downs guide users through a series of drop-down lists that present unique data choices
based on previously-selected data field selections. When the user completes all of the selections, Civic
Platform displays the field or a drill-down table with the value results.
Drill-downs display in the application and in the App Spec Info or App Spec Info Table tabs in the
application record.
For example, you can prepare a table for multiple business license types. You can set the first option, such
as Agriculture, and then assign subgroups, such as Plants and Trees Cultivation, and Seeds and Crops
Cultivation. You can then create additional groups for each of the subgroups which narrows the license
options available. After you assign the groups and subgroups, the drill-down options display in the public
user view.
Topics
•

Searching for a Drill-Down

•

Creating or Editing a Custom Fields Drill-Down

•

Creating or Editing a Custom Lists Drill-Down

•

Understanding the Drill-Down Series Tab

•

Assigning Values to a Custom Fields Drill-Down Series

•

Enabling Drill-Downs to Display

Searching for a Custom Fields Drill-Down
1. Go to Administration > Drill Down > Custom Fields Drill-Down.
2. Click Search.
Civic Platform displays the Custom Fields Drill-Down search page.
3. Complete any fields that display. For a description of the fields, see Custom Fields Drill-Down Fields.
4. Locate the Custom Fields drill-down you want to edit in the list.
5. Click the Custom Fields drill-down link in the Drill Down column.
Civic Platform displays the Custom Fields drill-down record details.

| Part 3: Configuring Agency Business Objects | 334

Creating or Editing a Custom Fields Drill-Down
You can create a drop-down field to enable users to search for the value of a Custom Field using a drilldown approach. The drill-down approach allows users to filter the list of value results by performing
a search within the Custom Fields drill‑down result value data. The drill-down functionality guides the
user through a series of drop-down lists that limits the selection values for subsequent fields based on
previously-selected data. When a user completes all of the selections, Civic Platform displays the value
results. You can apply drill-down fields to multiple groups.
For example, your agency can create a drill down for Business License applications. The first drill-down
lists the nature of the license, such as Agriculture, Bakeries and Confectionery, and Building Materials.
If the user selects Building Materials, the next drill-down lists materials such as Paints and Bonding
Materials, Tiles and Ceramics, and Wood and Wooden Products. If the user selects Wood and Wooden
Products, the third drill-down lists options such as Import of Wood, Furniture Repair and Refurbishing,
Plywood Manufacture, and Sawdust Collection and Recycling. See the example screen below.
The Custom Fields drill-downs displays on the application, application records, and checklists specified for
that record type. If you add a drill-down for a Custom Fields group that belongs to more than one record
type, the drill down is active for all of those record types. For further details, see Creating Custom Fields.

Figure 14: Application Record Custom Fields Drill-Down
To create or edit a Custom Fields drill-down
1. Go to Administration > Drill Down > Custom Fields Drill-Down.
2. Click New, or click the name of the item you want to edit.
Civic Platform displays the Drill Down detail portlet.

| Part 3: Configuring Agency Business Objects | 335

3. Complete the necessary fields, then click Submit.
For a list of fields, see Custom Fields Drill-Down Fields.
Note: As soon as you associate a Custom Fields group with a Custom Fields drill-down, the drill-down
displays on the application and in the record, even if you have not assigned values to it yet. You can set
the drill-down's record status to Inactive while you are working on it and then change the status to Active
when it's ready.

4. Go to the Value Mapping tab.
Civic Platform displays the series order.

5. Click the plus (+) sign in the picker, then click the parent Custom Fields item.
Civic Platform displays a secondary portlet that lists the shared drop-down values linked to the dropdown selected for the parent Custom Fields drill-down.

6. Select the value(s) you want to apply to the drill down, and then click Submit.
7. Click the plus (+) sign in the picker, then click the child item.
Civic Platform displays the shared drop-down values that you associated with the drop-down values.
8. Select the value(s) you want to apply to the drill down, and then click Submit.

| Part 3: Configuring Agency Business Objects | 336

Creating or Editing a Custom Lists Drill-Down
Users can search for the value of a Custom List with a drill-down approach. Custom Lists display in the
application and in the Custom Lists tab of the application record. The drill-down functionality guides the
user through a series of windows that presents unique data choices based on previously-selected data
field selections. When the user completes all of the selections Civic Platform displays a drill-down table
with the value results. The drill-down feature allows users to filter the list of value results by performing a
search within the results values. You can apply drill-down tables to multiple Custom Fields and Custom
List groups. For example, the agency can apply a table of business license types to both business or
professional licenses.
You must create or edit an existing Custom Lists drill-down before applying the drill down to an application.
In the Drill Down details area, each combination of Custom List groups and subgroups can only apply to
one active drill down at a time. The Custom List drill-down displays on the application specified for that
record type. If you add a drill down for a Custom List group you assigned to more than one record type, the
drill-down is active for all of those record types. For further details, see Creating Custom Fields.
To create or edit a Custom Lists drill-down
1. Go to Administration > Drill Down > Custom Fields Drill-Down.
2. Click New, or click the name of the record you want to edit.
Civic Platform displays the Drill Down detail portlet.

3. Complete the necessary fields, then click Submit.
For a list of fields, see Custom Fields Drill-Down Fields.
Note: As soon as you associate a Custom Fields group with a Custom Fields drill-down, the drill-down
displays on the application and in the record, even if you have not assigned values to it yet. You can set
the drill-down's record status to Inactive while you are working on it and then change the status to Active
when it's ready.

4. Do the following:
a. Establish the drill-down relationship. See Understanding the Drill-Down Series Tab.
b. Assign values to drill-down series. See Assigning Values to a Custom Fields Drill-Down Series.
Table 56: Custom Fields Drill-Down Fields

Drill Down

Enter a unique name for the Custom Fields Drill-Down.

Custom Fields Group

Use the picker to select the Custom Fields or Custom Lists groups to apply to the
drill down.
You define the Custom Fields and Custom Lists groups and subgroups in Classic
Administration > Admin Tools > Application > Custom Fields (or Custom Lists).

| Part 3: Configuring Agency Business Objects | 337

Custom Fields
Subgroup

Click the picker for the Custom Fields Subgroup field, then click the Custom Fields
group or Custom Lists group name to expand the view and display the subgroups
applicable to each group.
The first Custom Fields subgroup list is the primary subgroup. To choose a primary
subgroup, double-click the desired subgroup. All other subgroups display in
alphabetical order.
The configuration of the primary Custom Fields subgroup, including column names,
field types, display order, and so forth, becomes the default for all subgroups
attached to the drill-down. If the configuration for subsequent Custom Fields
subgroups does not match, Civic Platform displays an alert message to notify you
that the drill down cannot display on the Custom Fields subgroup.
If you want to disassociate a single Custom Fields subgroup from the Custom Fields
drill-down, click the Custom Fields subgroup and then click Delete.
If you want to disassociate multiple Custom Fields subgroups, press the Ctrl key on
your keyboard while clicking the unwanted Custom Fields subgroups. After you have
highlighted all unwanted subgroups, click Delete.

Custom Fields Type

Choose either Custom Fields or Custom Lists to determine which type of drill-down
to create.

Apply To

To determine whether the drill-down displays in Civic Platform, Citizen Access, or
both products, click the appropriate option.

Record Status

Select Active or Inactive.
Set the drill-down's record status to Inactive while you are working on it and then
change the status to Active when it's ready.

Figure 15: Custom Fields Drill-Down Table Select Single Item

| Part 3: Configuring Agency Business Objects | 338

Figure 16: Custom Fields Drill-Down Table Select Multiple Items

Understanding the Drill-Down Series Tab
The Drill Down Series tab determines how many drill-down levels you want to display in the drill-down. You
need only add two columns in the series to display three drill-down levels. After you have entered
your information into this tab, you progress to the Value Mapping tab to determine the data values for each
level.
To create a drill-down series
1. Access the Custom Fields Drill-Down portlet (Accessing the Custom Fields Drill-Down Portlet).
2. Select the Custom Fields drill-down you want to work with.
3. Go to the Drill Down Series tab. This is where you specify how many drill-down levels you want to
display in the drill-down.
Note: You cannot access the Drill Down Series tab until you save the new drill-down record.

Civic Platform displays the Drill Down Series tab in the detail portlet.

| Part 3: Configuring Agency Business Objects | 339

4. Establish the drill-down relationship.
To create additional drill-down levels, repeat sub-steps a - c above. Civic Platform automatically
identifies the Parent Custom Fields drill-down type and shared drop-down list as the Child from the
previous level. Specify the relevant Custom Lists Subgroup in the Child Column and Child Drop Down
for the new level.
Note:
You need only specify two rows for three drill downs.

a. Click New.
Civic Platform displays a Custom Fields Drill Down series row.

b. Enter the necessary information into these fields:
Type

Use the drop-down list to determine whether the Single or Multiple Selection
Drill-down page displays for the daily user. If you select “Single,” the user
can only select one value from the drill-down page. “Multiple” allows users to
select multiple options in the drill-down page by pressing the “Ctrl” key and
clicking all of the desired options on the page. For an example, see Custom
Fields Drill-Down Table Select Single Item and Custom Fields Drill-Down
Table Select Multiple Items.

| Part 3: Configuring Agency Business Objects | 340

Parent Column/Field

Select the Custom Lists Group from the drop-down list. The drop-down
option relates to the subgroup you selected on the Drill Down tab. When
creating a new Custom List drill-down this field is editable. When updating
an existing Custom List drill-down the field is read-only, but you can delete
the row.

Parent Drop Down

Click Search to select the shared drop down list used to populate the first
level on the Custom List drill down.

Child Column/Field

Select the Custom Lists Subgroup from the drop-down list. The drop-down
option relates to the subgroup you selected on the Drill Down tab. When
creating a new Custom Lists drill-down this field is editable. When updating
an existing Custom List drill-down the field is read-only, but you can delete
the row.

Child Drop Down

Click Search to select the shared drop-down list used to populate the
second level on the Custom Lists drill down.

c. Click Submit.
Civic Platform saves the series information.

Assigning Values to a Custom Fields Drill-Down Series
The Value Mapping tab for a drill-down enables the data values in the Child Column/Field to be mapped
to the Parent Column/Field data values. The Value Mapping tab for a Custom List drill-down enables
the data values in the Child Column/Field to be mapped to the Parent Column/Field data values. You
define the data values with shared drop-down lists. The nodes in this level depend on your selections in
the Drill Down Series tab. When you create the drill-down field or the drill-down table, all of the values
from the shared drop-down list display in the Value Mapping tab, which enables you to use duplicate
Child values for multiple Parent criteria. For example, two categories, such as “condominium” and “singledwelling,” could potentially drill down into the same subcategories of demolition, remodel, and stick-built.
An administrator can select “demolition,” “remodel,” and “stick-built” as subcategories of both categories.
For more information about shared drop-down lists, see Creating Shared Drop-down Lists.
To assign values to a Custom Fields Drill Down Series
1. Access the Custom Fields Drill-Down portlet (Accessing the Custom Fields Drill-Down Portlet).
2. Click the link to the drill-down you want to work with.
3. Go to the Value Mapping tab.
Civic Platform displays the series order.

| Part 3: Configuring Agency Business Objects | 341

4. Click the plus (+) sign in the picker, then click the Parent Custom Field or List item.
Civic Platform displays a secondary portlet.

5. Select the value(s) you want to apply to the drill down, and then click Submit.
6. Click the plus (+) sign in the picker, then click the Child Column/Field item.
Civic Platform displays the shared drop-down values.
7. Select the values you want to provide for users to choose from when they navigate the drill down.
8. Click Submit.

Enabling Drill-Downs to Display
Administrators must complete some configuration to enable the drill-downs to display for the user. These
steps include:
•

Setting three FIDs

•

Defining the Custom Fields groups and subgroups in Civic Platform Classic Admin.

•

Setting user security permissions for the Custom Fields group or Custom Lists group to Full Access

•

Creating or editing shared drop-down lists

•

Creating or editing Custom Field or Custom List drill-down records.

You associate a Custom Fields group with the field or list in the application. To specify the application to
apply the drill-down to, you must associate the Custom Fields or Lists with the record type. The shared
drop-down lists contain the values for the drill-downs.
Note: As soon as you associate a Custom Fields group with a Custom Fields drill-down, the drill-down
displays on the application and in the record, even if you have not assigned values to it yet. You can set the
drill-down's record status to Inactive while you are working on it and then change the status to Active when
it's ready.

| Part 3: Configuring Agency Business Objects | 342

If Custom Fields security settings block users from viewing the fields or lists for a record type, the drilldowns assigned to that record type do not display for the user. Review these settings to ensure you set
them correctly. For information about setting permissions for a Custom Field or Custom List, see Setting
Permissions for Custom Fields Groups and Custom Lists Groups.
Custom Fields and Lists drill-downs are available to both Civic Platform and Citizen Access users. For
information about the additional steps required to configure this feature in ACA, see “Configuring ASI Table
Drill-Downs” in the Citizen Access Administrator Guide.
To enable drill downs to display
1. Set the permissions for the Custom Fields or Lists group to Full Access.
For information about setting permissions for Custom Fields or Lists, see Setting Permissions for
Custom Fields Groups and Custom Lists Groups.
2. For Custom Fields drill-downs, create or edit the Custom Fields Group and Subgroup.
For Custom Lists drill downs, create or edit the Custom List Group and Subgroup.
3. Create or edit the shared drop-down lists with the values needed for the drill down.
For details on completing this task, see Creating Shared Drop-down Lists.
4. Create or edit the Custom Fields or Custom Lists drill-down record.
For details on completing this task, see Creating or Editing a Custom Fields Drill-Down or Creating or
Editing a Custom Lists Drill-Down.

| Part 3: Configuring Agency Business Objects | 343

Setting Up Security Policies
Security policies enable you to control who has permission to access an object and to automate what
happens next when an object type reaches a certain status.
For example, you can restrict access to a building permit application when its status is Plan Review by
limiting users ability to schedule and result inspections while the application is in that status, and allowing
them to only view the application. When the application status changes to Issued, users can schedule and
result an inspection.
Click a topic title below for full details.
Related Information
Adding Record Type Security
Adding or Editing Workflow Task Security
Adding or Editing Inspection Type Security
Adding or Editing an Inspection Default Value Policy
Adding or Editing Inspection Type and Status Security
Adding or Editing Condition Type Security
Setting Permissions for Custom Fields Groups and Custom Lists Groups
Adding or Editing Asset Type Security
Adding or Editing EDMS Type Security
Adding or Editing Contact Type Security
Managing Recipients in Administration Portlets
Configuring Session Time Out

Adding Record Type Security
To set security on a record type in Civic Platform, you must first define each FID in the Standard Choice
APPLICATION_TYPE_SECURITY_FID.
The record type security defined in Civic Platform also takes effect in Mobile Office. For example, if you set
limitations on the status of a record type in Civic Platform, the limitations also apply to Mobile Office. Full
access lets users view and modify the record status when creating or editing records from Mobile Office;
Read-only access lets users only view the record status; and an access level of None lets users neither
view nor update the record status.
The process to set limitations on record status is through FID 8141 Application Status setting and the
record type security setting. The FID setting takes priority over the record type security. If you set FID 8141
Application Status to Read-only or None, Mobile Office adheres to the FID setting only. If you set FID 8141
Application Status to Full Access, Mobile Office adheres to the record type security based on these rules:
•

If you assign different security levels to the record type and its record status, the permission set on the
record status takes effect. Otherwise, inherit the permission set on the record type.

•

If you assign multiple security levels to an Application Status (user group, module, or agency, user
group), the security setting assigned to the user group takes effect.

•

If you assign different security levels to the Application Status functional area at the same level (user
group, module, or agency), the maximum permission takes effect.

| Part 3: Configuring Agency Business Objects | 344

Note:
If multiple security policies apply to an individual user, the security policy assigned to the user group
determines the security level. For example, if an individual user is in a user group that has Full access
but that user has only View access, the user security policy (View) applies.

Adding or Editing Workflow Task Security
The workflow task list displays only those tasks that the workflow supervisor can fully access, determined
by workflow task security policies. No workflow tasks display if the supervisor has no access or only read
access to those tasks.
You can limit access to a building permit application if the status is Plan Review by restricting users ability
to schedule inspections and result inspections, and allowing them to only view the application. When the
application status changes to Issued, users can schedule and result an inspection.
You can configure workflow task security in the Workflow Security portlet (Navigating to the Setup Portlet).
For information on how to assign recipients to a workflow task, see Managing Recipients in Administration
Portlets.

Adding or Editing Inspection Type Security
You can establish three security levels for inspection types. Full access lets users add, modify, and delete
inspections; Read-only access lets users only view inspections; and None lets users neither view nor
change inspections.
Civic Platform uses the security settings for an inspection group or an inspection type if they are different
from the agency inspection settings. If you assign security settings for both an inspection group and a
security type within that group, the security settings for the inspection type take effect.
Note that Civic Platform assigns access to an inspection based on the specific inspection security settings.
For example, if an inspection is read-only to a user or user group, then those users cannot modify, delete,
or copy checklists assigned to the inspection.
The inspection type security defined in Civic Platform also takes effect in Mobile Office. For example, if you
set an inspection type to No Access for a user group in Civic Platform, users of that group cannot view the
details about the inspections of that inspection type in Mobile Office. The inspection type is not available in
any Inspection Type drop-down list either.
You can configure inspection type security in the Inspection Type Security portlet (Navigating to the Setup
Portlet). For information on how to assign recipients to an inspection type, see Managing Recipients in
Administration Portlets.

Adding or Editing an Inspection Default Value Policy
To add or edit inspection default value policy
1. Access the Classic Administration page (Accessing Classic Administration).
2. Navigate to Agency Profile > Security Policy.
Civic Platform displays the Agency Security Policies-Select Policy page.

| Part 3: Configuring Agency Business Objects | 345

3. Click Inspection Default Value Policy.
Civic Platform displays the Inspection Group Select screen.

4. If you know the inspection group you want to work with, enter it in the Inspection Group field; otherwise,
leave the field blank.
5. Click Submit.
Civic Platform displays the Inspection Group list.

6. Click the link for the inspection group you want to work with. To assign security settings for all
inspection groups, click the All Inspection Groups link.
Civic Platform displays the Inspection Type list.

| Part 3: Configuring Agency Business Objects | 346

7. Click the link for the inspection type you want to work with. To assign security settings for the entire
inspection group, click the All Inspection Types link.
Civic Platform displays the security policy for the inspection type.

8. To add a new agency or a new group, select from the drop-down list the Agency or Group Name whose
access level you want to specify.
9. Choose the Default Status for all new inspections assigned to the inspection group and inspection type.
10.Enter the Number of Calendar Days Available (from 1 to 90) for a public user to schedule an inspection.
The default value is 30.
Note:
To enable this feature, you must configure the inspection blockout calendar. For more information, see
Setting Up Inspection Calendars for Public Users.

11.Select Allow Same Day Inspection Scheduling, to enable users to schedule inspections on the same
day they create the application.
12.Enter the Cutoff Time after which users cannot schedule the inspection for the following day.
13.Select Enable from the Status drop-down list if you want to activate this application type security;
otherwise, select Disable.
14.If this is a new policy, Click Add.
Civic Platform adds the security group to the list.

| Part 3: Configuring Agency Business Objects | 347

15.Click Save.
Civic Platform saves the security policy.

Adding or Editing Inspection Type and Status Security
If your agency uses Accela Wireless, you might set a code enforcement inspector’s inspection status to
Schedule. This lets code inspectors schedule, inspect, and record the results for a broken gas or water line
immediately, instead of having to wait for someone else to schedule the inspection.
To establish an inspection type and status security policy
1. Access the Classic Administration page (Accessing Classic Administration).
2. Navigate to Agency Profile > Security Policy.
Civic Platform displays the Agency Security Policies—Select Policy page.
3. Click the Inspection Type and Status Security link.
Civic Platform displays the Inspection Group Select page.
4. If you know the inspection group you want to work with, enter it in the Inspection Group field;
otherwise, leave the field blank.
5. Click Submit.
Civic Platform displays the Inspection Group list.
6. Click the link for the inspection type you want to work with. To assign security settings for all of the
conditions, click the All Inspection Groups link.
Civic Platform displays the Agency Security Policies—Select page.
7. Click the inspection type you want to work with.
Civic Platform displays the Agency Security Policies—Scope page.
8. To add a new agency or a new group, select the agency name or group name whose access level you
want to specify. Civic Platform uses the security settings for a user group if they are different from the
agency security settings.
9. Select the Inspection Status for the agency and for the user group. Leave this field blank and select
Create if you want to allow a group or user to create a new inspection. If you leave this field blank, it
deactivates the other available options.
10.Select the access level for the group (Edit, View, or None).
11.Select Enable from the Status drop-down list if you want to activate this application type security;
otherwise, select Disable.
12.If this is a new policy, Click Add.
Civic Platform adds the inspection default value policy to the agency and group.
13.Click Save.
Civic Platform saves the inspection default value policy.

| Part 3: Configuring Agency Business Objects | 348

Adding or Editing Condition Type Security
To add or edit condition type security
1. Access the Classic Administration page (Accessing Classic Administration).
2. Navigate to Agency Profile > Security Policy.
Civic Platform displays the Agency Security Policies—Select Policy page.
3. Click the Condition Type Security link.
Civic Platform displays the Condition Type Select page.
4. If you know the condition type you want to work with, enter it; otherwise, leave the field blank.
5. Click Submit.
Civic Platform displays the Condition Type list.
6. Click the link for the condition type you want to work with. To assign security settings for all the
conditions, click the All Condition Types link.
Civic Platform displays the security policy for the condition type.
7. To add a new agency or a new group, select from the drop-down list the agency name or group name
whose access level you want to specify.
8. Select the access level for the group (Full or Read-only).
9. Select Enable from the Status drop-down list if you want to activate this application type security;
otherwise, select Disable.
10.If this is a new policy, Click Add.
11.Click Save.
Civic Platform saves the security policy.

Setting Permissions for Custom Fields Groups and Custom Lists
Groups
1. Go to Administration > Application > Custom Fields Security.
2. Click the appropriate Custom Fields Group or Custom Lists Group, and then do one of the following:
3. To apply the permissions to all Custom Fields Groups or Custom Lists Groups, select the top level
Custom Fields Group or Custom Lists Group.
4. To search for a Custom Field, click Search then enter the field name (up to 24 characters).
Civic Platform highlights in red all matched records through the entire ASI Security navigation tree.

| Part 3: Configuring Agency Business Objects | 349

5. Click the ASI Group or ASI Table Group to which you want to apply permissions.
Civic Platform displays the ASI Group or ASI Table Group in the permission detail portlet.

6. In the permission detail portlet, click or roll your mouse over Assign, and select an assignment option.
For more information, see Managing Recipients in Administration Portlets.

Adding or Editing Asset Type Security
You can set the access level for asset types in the Asset Security portlet (Accessing the Asset Security
Portlet). For more information, see Managing Recipients in Administration Portlets.

Adding or Editing EDMS Type Security
You can set up authentication by site or by user. If you choose site authentication, you must also set up a
site-wide user name and password. If you choose user authentication, users must enter their Civic Platform

| Part 3: Configuring Agency Business Objects | 350

credentials before they can perform the certain actions. If you do not set up any authentication, users can
directly access the EDMS without logging in.
To add or edit EDMS type security
1. Access the Classic Administration page (Accessing Classic Administration).
2. Navigate to Agency Profile > Security Policy.
Civic Platform displays the Agency Security Policies—Select Policy page

3. Click the EDMS Access Security link.
Civic Platform displays the EDMS Type Select page.

4. Click the EDMS type you want to work with.
Civic Platform displays the EDMS Security window.

5. To add a new agency or a new group, select from the drop-down list the Agency or Group Name whose
access level you want to specify.

| Part 3: Configuring Agency Business Objects | 351

6. Select any of the access levels you want the group to have (Upload, Download, View, and Delete). This
functionality is also applicable to attachments in Citizen Access.
7. Select Enable from the Status drop-down list if you want to activate this application type security;
otherwise, select Disable.
8. If you enable more than one EDMS security policy from the list, check the box next to the policy you
want to set as the Default policy.
Note:
Add-on products that use GovXML (the legacy Accela GIS, Accela Wireless, and Accela IVR) store
documents only in the default EDMS adapter.

9. Do one of the following:
a. To prompt users to enter their user name and password when uploading a document, select the
User option. The first time users receive this prompt to enter their user name and password, they
can select the “Remember” option for their login credentials.
b. To require users to enter credentials for EDMS authentication, select the Site option and enter the
site credentials
10.If this is a new policy, Click Add.
11.Click Save.
Civic Platform saves the security policy.

Adding or Editing Contact Type Security
Civic Platform divides contacts into two categories: record contacts that users associate or manually add
to records, and reference contacts that users work with from the Reference Contact portlet. You only need
to define security for record contact types. If you go to the Contact Type Security portlet and expand the
Record Contacts navigation tree node (see Figure 17: Record Contact Type Setting Portlets), you can view
all the contact types that are “for transactions” or “for both” in the CONTACT TYPE Standard Choice. You
can then select a contact type and establish the security levels for modules, user groups, and individual
users.
Because reference contacts are reference data, which are generally accessible and shared in various
transactions across departments, it is no longer necessary to define security for reference contact types.
In the Contact Type Setting portlet, you can limit the use of specific contact types by module and establish
three security levels for each contact type configured in the CONTACT TYPE Standard Choice. Table 57:
Contact Type Security Levels explains the security levels. Based on your Standard Choice configuration,
security policies are effective in Civic Platform, Citizen Access, and/or Mobile Office.
Table 57: Contact Type Security Levels

Security
Level

Description

Full

Users can view, add, modify, and delete the contacts of certain contact types.
Users can search for records or contacts by certain contact types.
Users can search for inspections by certain contact types (in Mobile Office only).

| Part 3: Configuring Agency Business Objects | 352

Security
Level

Description

Read-Only

Users can view the contacts of certain contact types but cannot add or modify the contacts of those
types.
Users can search for records or contacts by certain contact types.
Users can search for inspections by certain contact types (in Mobile Office only).

None

Users have no access to certain contact types and the contacts of those types.

By default, users have full access to all contact types from within all modules and the reference Contact
portlet. If a contact type is available for multiple modules, then you can limit the use of the contact type
by module through specifying the applicable module in the Contact Type Setting portlet. If some contact
information is sensitive, then you can limit access to the sensitive information by setting Read-Only or
None access for certain users in the Contact Type Setting portlet.

Figure 17: Record Contact Type Setting Portlets
To define security for record contact types
1. Access the Contact Type Setting portlet (Accessing the Contact Type Setting Portlet).
2. Click the plus sign (+) to the left of the Record Contacts node.
Civic Platform displays all available record contact types under the Record Contacts node.

| Part 3: Configuring Agency Business Objects | 353

3. Highlight the contact type to which you want to apply a security policy.
Civic Platform displays the Module list for the contact type.

4. Click the link to the module that you want to define security levels for.
Click Add, select a module, and then click Submit to add the module to the Module list.
Civic Platform displays the Permission list for the module.

| Part 3: Configuring Agency Business Objects | 354

5. Click Assign and choose which level to apply the contact type security. You can select Assign
Module, Assign Group, or Assign User from the drop \\\down menu.

Managing Recipients in Administration Portlets
Civic Platform provides a Recipient tab or a Permission tab in several administration portlets for you
to assign permissions to the relevant administrative settings. For example, Figure 18: Recipient Tab in
Console Configuration shows the Recipient tab in the Console Configuration portlet, Figure 19: Permission
Tab in Asset Type Security shows the Permission tab in the Asset Type Security portlet. You can click the
Assign buttons in either of the portlets to decide which agency, module, user group, and user has access
to the current record.

Figure 18: Recipient Tab in Console Configuration

Figure 19: Permission Tab in Asset Type Security

| Part 3: Configuring Agency Business Objects | 355

This section provides instructions on how to assign recipients with the Assign buttons in the Recipient or
Permission tab.
To manage recipients in an administration portlet
1. Go to an administrative portlet, and select a record in the portlet to which you want to assign recipient.
2. Click Recipient or Permission tab.
3. Click one of the following buttons to select which organization level you want to assign permission to
the record.
Note:
In different administration portlets, the availability of the buttons varies.

•

Assign Agency. The entire agency has permission to the record.

•

Assign Module. To select one or more modules. All users of the selected modules have permission
to the record.

•

Assign Department. To select one or more departments. All users of the selected department have
permission to the record.

•

Assign Group. To select one or more user groups. All users of the selected groups have permission
to the record.

•

Assign User. To select one or more users. All selected users have permission to the record.

•

(In the Message administration portlet only) Assign Role. To select one or more public user groups,
including registered users, anonymous users, and licensed professionals. All selected user groups
have permission to the record.
Civic Platform displays a selection hierarchy, for example, the module-selection hierarchy.

4. In most cases, you can search for a module, group, or user in the selection hierarchy.
To search for a module, group, or user, complete the following steps:
a. Click the plus sign next to the Module, Group, or User label on the navigation tree.
Civic Platform expands the navigation tree to display names.
b. Click Search.
Civic Platform displays a search page.

c. Enter a value in the Search field. The user can enter a maximum of 24 characters.

| Part 3: Configuring Agency Business Objects | 356

d. Click OK.
Civic Platform highlights in red all matched records through the navigation tree.

e. Select the module, user group, or user, and then click Submit.
5. Select a recipient.
Click plus (+) sign to expand folders in the hierarchy. Click minus (-) sign to collapse folders until you
locate the recipient you want.
6. Click Submit.
Civic Platform adds the selected recipients for the current record.
7. If you are assigning recipients in the Permission tab, specify the access level of the recipient from the
Access drop-down list (full, read or read-only, none or no access).

8. If you are assigning recipients in the Permission tab to a record type, inspection type, or asset
type, you have the options to configure more access options for the selected recipient. For example,
configure the inspection status access to an inspection type.

| Part 3: Configuring Agency Business Objects | 357

9. Click Submit.
Civic Platform saves the access settings.
10.If you need to remove a recipient from the recipient list, select the recipient you want to delete and click
Delete.

Configuring Session Time Out
Accela administrators can configure their system to time out after a period of inactivity, to minimize security
risks. You can specify the maximum amount of time that a Civic Platform session can remain idle before it
ends automatically, requiring the user to re-enter their login credentials. You can also configure a warning
dialog box to display, enabling the user to
By default, the time-out setting is 7200 seconds (2 hours). You can adjust the session time-out value
(in seconds) by configuring the Standard Choice SESSION_TIMEOUT at the agency level or by editing
the XPolicy.csv file at the Web server level. If both the Standard Choice SESSION_TIMEOUT and
the XPolicy.csv file specify the session time-out value, the session time-out setting at the agency level
overrides that at the server level. If the Standard Choice does not specify a session time-out value, Civic
Platform enforces the time-out setting configured in the XPolicy.csv file.
The minimum time-out value is 10 minutes (600 seconds). If you specify a value less than 600 seconds,
Civic Platform automatically enforces a session time-out period of 10 minutes.
To configure the session time-out value at the Web server level
1. On the server where you host Civic Platform, open the XPolicy.csv file.
2. Locate the sso.session.timeout property in the LEVEL_DATA column.
3. Enter a value greater than 600 in the DATA1 column next to the sso.session.timeout property.
4. Save the file.
To configure the session time-out value at the agency level
1. Log in to Civic Platform.
2. Configure the Standard Choice SESSION_TIMEOUT by adding the value Timeout, with a value
description of any number greater than 600. This value is the number of seconds of inactivity after
which Civic Platform times out.
For example, if you want Civic Platform to time out after 15 minutes, set the value description to 900.
The default is 7200 (2 hours).

| Part 3: Configuring Agency Business Objects | 358

Refer to “Standard Choices,” in the Accela Civic Platform Configuration Reference for complete details
on setting up Standard Choices.
3. Click Update.
4. Clear the cache:
a. Navigate to the Cache List portlet.
b. Click Clear Cache.
c. Select the Cache Name option at the top of the page to select all cache items.
d. Click Clear.

Session Time Out Warning
Accela administrators can configure a session time-out warning that displays notifying users that the
session is about to expire. Users can select Yes in the time-out warning to continue their session or No to
allow their session to expire, as shown in the sample screen below:

To configure a session time-out warning
1. Log in to Civic Platform.
2. Configure the Standard Choice SESSION_TIMEOUT by adding the value Timeout Warning with a value
description of the number second prior to timing out Civic Platform displays the time out warning.
For example, if you enter a value description of 300 the time-out warning displays to the user 5 minutes
before the session times out. The default value is 120 (2 minutes). The Timeout Warning value must be
less than the time out value.
Refer to “Standard Choices,” in the Accela Civic Platform Configuration Reference for complete details
on setting up Standard Choices.
3. Click Update.
4. Clear the cache:
a. Navigate to the Cache List portlet.
b. Click Clear Cache.
c. Select the Cache Name option at the top of the page to select all cache items.
d. Click Clear.

| Part 3: Configuring Agency Business Objects | 359

Defining Sequences, Masks, and Autonumbering
This section provides details about numbering sequences and masks, and how to apply them to any item
in Civic Platform that requires numbering, such as application types, invoices, and receipts.
Using the sequence generator you can define masks for numbered items. A mask in Civic Platform
determines how a number displays to a user. For example, each new permit number might have a prefix
indicating the type of permit and a date code in addition to the incremental number. A citation number can
have a prefix that identifies it as a citation and not a permit, receipt number, or other incremental record in
Civic Platform. After the initial implementation, you rarely need to modify masks.
Click a topic title below for full details.
Related Information
Accessing the Sequence Generator
Setting Up Number Sequences and Masks
Managing Sequence Intervals and Last Number Used
Understanding Recommended Mask Formats

Accessing the Sequence Generator
You can access the sequence generator portlets from the setup administration menu.
To view the sequence generator portlets
1. Go to Civic Platform Administration > System Tools > Sequence Generator.
Civic Platform displays the portlet.

Setting Up Number Sequences and Masks
This section explains how to define a Sequence Definition. We provide instructions for Mask Definitions
and provide examples for sequence numbering and formatted output of a sequence (how the result
displays to the user).

| Part 3: Configuring Agency Business Objects | 360

Civic Platform divides all Sequence Definitions into three elements, the Sequence Definition, the Mask
Definition, and the Sequence Intervals.
You must define the Sequence Definition before you can assign it to a Mask Definition.
Civic Platform organizes sequence types into several categories: Agency, Asset ID, Record ID, Record
Key, Partial Record ID, Temporary Record ID, and Receipt. For each category there is a pre-defined
setting that you can use without further configuration. It is ready to use immediately.
You can refer to Table 60: Pre-Defined Sequences and Masks. This table lists each default sequence type,
mask name, sequence definition name, and a description of the default sequence types.
To create or modify a sequence
1. Access the Sequence Definition portlet (Navigating to the Setup Portlet).
2. To define a number sequence, do one of the following:
•

Create a new sequence for the item by right-clicking it from the navigation tree, then select New
Sequence. You can also click the Menu button and select New Sequence from the drop-down list.
The sequence Name displays in the Sequence Definition portlet to the right.

Civic Platform organizes the items you can apply numbering to into several categories: Agency,
Asset ID, Record ID, Partial Record ID, Temporary Record ID, Record Key, and Receipt. Each
category has a Default numbering definition that is ready to use immediately, with no configuration.
To review the pre-defined or Default settings refer to Table 60: Pre-Defined Sequences and Masks.
Sequence by Type organizes sequence definitions based on the sequence type: Agency, Asset ID,
Record Id, Partial Record ID, Temporary Record Id, Record Key, and Receipt.
Sequence by Name lists the definitions based on the starting letter of the sequence definition name,
and then by the sequence type.
Mask by Type organizes mask definitions based on the sequence type: Agency, Asset ID, Record Id,
Partial Record ID, Temporary Record Id, Record Key, and Receipt.
Mask by Name lists the mask definitions based on the starting letter of the mask name, and then by
the sequence type
•

To locate an existing item in the navigation tree, click the plus sign (+) to the left of the sequence or
mask type to expand the list of items.

| Part 3: Configuring Agency Business Objects | 361

3. Complete or update the Sequence Definition fields. For field descriptions refer to Table 58: Sequence
Definition Fields.

4. Click Submit.
Civic Platform saves the Sequence Definition.
5. Click Refresh in the Navigation Tree to display the sequence you just created or updated. Now, you
can apply a Mask Definition to the item.
Civic Platform loads the new sequence type you created or updated in the Navigation Tree.
6. In the tree, locate the new or updated sequence and select (+) Masks.
The Mask Definition portlet displays to the right.
7. Complete the Mask Definition fields. For field descriptions refer to Table 59: Mask Definition Fields.
8. Optionally, use the Validate button. It takes the Maximum and Minimum Length, Sequence Type,
and Sequence Number Base and validates them against the mask Pattern using a sequence of 1 and
today's date.

| Part 3: Configuring Agency Business Objects | 362

9. Click Submit to save the Mask Definition.
Civic Platform automatically manage the Sequence Interval.
Table 58: Sequence Definition Fields

Cache Size

(Required) Enter the value to reflect how many of the numbers you want the sequence
to pull or reserve at a time. The default value is 1. We recommend you do not change
this value.

Description

Text for describing the pattern or any other characteristics of this sequence definition.
Maximum of 200 characters.

Increment By

(Required) Enter the number that specifies the increase using a positive integer. Civic
Platform does not support negative integers.

Interval Type

Select the type of interval for this sequence. Options are None, Calendar Year,
Calendar Month, Calendar Day, Fiscal Year, Fiscal Quarter, Fiscal Month. The
sequence value restarts based upon the interval type.
For example, selecting Calendar Year means the sequence number resets itself to the
Starting Value at the start of every calendar year. Select None if you do not want the
sequence number to reset itself based upon a date.

Name

Enter a unique name for this sequence definition. It must be unique within the
Sequence Type selected.

Reset Action

This field works in conjunction with the Reset Value. Reset Action tells the sequence
generator what action to take if you exceed the Reset Value maximum. The default
setting is Exception. You must configure Record Keys and Record IDs to throw an
Exception.
Note:
If you exceed the Reset Value maximum and an Exception error displays,
this is a very serious matter. Contact Accela Customer Support to resolve the
issue. You might need to change the format.
You must configure all categories to throw an exception, except the Agency sequence
type. You should only use the other one (Set to minimum) if duplicate sequence
numbers are acceptable. Do not configure the Set to minimum option unless you are
certain that duplicate numbers are not a problem.
Civic Platform stores many of the sequence numbers in database columns whose
values must be unique. If you choose the Set To Minimum option, the sequence
number resets to the Start Value if you exceed the Reset Value.

Reset Value

Enter the maximum value you want Civic Platform to generate from this sequence
definition. When you exceed this maximum value the Reset Action triggers.

| Part 3: Configuring Agency Business Objects | 363

Sequence Type

Groups of related sequence definitions. The groups are: Asset ID, Invoice, Record
ID, Partial Record ID, Temporary Record ID, Record Key, Receipt, and Agency.
One exception to this grouping is the Agency type which groups all single definitions
together. Each Sequence Type must have a unique Name.
NOTE: When you create the Mask Definition for an item, first select the Sequence
Type that is the same as the Sequence Definition. This filters the Sequence Definition
Name drop-down, listing only the Sequence Definitions available for that Type. Then
specify this Sequence Definition using the Table 59: Mask Definition Fields.

Start Value

Minimum starting value for the sequence.

Status

Enabled means you can use this definition. Set to Disabled if you no longer need to
use this sequence definition. You cannot delete a sequence definition

Table 59: Mask Definition Fields

Description

Text for describing the pattern or any other characteristics of this mask. Maximum of
200 characters.

Maximum Length

Enter a numeric value that defines the total number of allowed characters for the item
or for the formatted sequence output. For example, a receipt number, or a Record ID
number. Agency can be different for a pre-defined mask.

Minimum Length

Enter the minimum number of characters for the formatted sequence output.

Name

The name that defines the sequence mask.Maximum of 200 characters.

Pattern

Mask pattern describes how Civic Platform formats the sequence output. You must
consider several fields when creating a pattern:
The Sequence Number Base field works with the pattern. To make the pattern humanreadable apply Base10. To use a key or coded apply Base36. The Sequence Number
Base (10 or 36) is in this part of the sequence output [$$SEQ$$].
The Reset Value and Interval Type in the Sequence Definition. See Recommended
Patterns and Sequence Reset Values.
Include the date value in the pattern of the Interval Type to prevent duplication of
numbers.

Sequence Def Name

Select the sequence definition name for this mask to generate sequence numbers.
You can only select a sequence definition from the drop-down list that is the same
Sequence Type for the Mask Definition.You must define the Sequence Definition
before you can assign it to a Mask Definition.

Sequence Number Base Use Base 10 for user readable numbers. Use Base 36 to display the sequence output
[$$SEQ$$] using numbers and letters [0-9] and [A-Z].
See examples of mask patterns using Base 10 and Base 36 in Table 61: Example
Mask Patterns
.
Sequence Type

Select the category of the sequence. For example, Record ID or Receipt. You cannot
mix Mask Definitions and Sequence Definitions with different Sequence Types. You
also cannot assign a Record Key Mask Definition in place of a Record ID definition

Status

Enabled means you can use this definition. Set to Disabled if you no longer need to
use this mask definition. You cannot delete a mask definition.

Managing Sequence Intervals and Last Number Used
Use the Sequence Interval portlets to either review the Interval Type and refer to the last number used in
the sequence. Or, if absolutely necessary, to change the value of the next number used for this Sequence
Definition.

| Part 3: Configuring Agency Business Objects | 364

Use the Sequence Interval portlets to either review the Interval Type and the last number used in the
sequence. Or, if absolutely necessary, to change the value of the next number used for this Sequence
Definition.
The Last Sequence Number field displays the last number used in the Sequence Interval. For example,
if 15 is the value in the Last Sequence Number field for a Batch Invoice and the Increment is 1, and you
enter 99 in the Last Sequence Number field, this forces the next Batch Invoice number to start with 100.
To review or change the Last Sequence Number value
1. Identify the item that you either need to review or change its last number used.
2. Highlight the Sequence Type in the navigation tree. For example, Agency > Batch Invoice, or Asset ID >
Default.
The Masks and Sequence Intervals options display in the tree.
3. Expand the Sequence Intervals option.
The list of Sequence Intervals displays.
4. Select the Sequence Interval name you want to review or change in the Sequence Interval list portlet on
the right.
5. Determine both the Increment By value for the item's Sequence Definition and what new number you
want to apply to the numbering of the Sequence Interval. The Last Sequence Number field displays the
last number used or applied to the item (from step 1) in Civic Platform.
6. Subtract from or add to the value, depending upon your numbering requirements, and enter it into the
Last Sequence Number field.
7. Click Submit to update the interval numbering.

Understanding Recommended Mask Formats
This section provides supporting information when using the sequence generator. It repeats key sequence
and mask concepts previously covered in this section. It also has several tables to refer to when defining
the Pattern field in a Mask Definition. This information helps ensure the pattern you design meets your
numbering requirements.
Topics
•

Understanding Masks

•

Pre-defined Sequence Types and Masks

•

Example Mask Patterns

•

Common Date Formats

•

Fiscal Date Formats

•

Sequence Number Formats

•

Miscellaneous Formats

•

Receipt Variables for Receipt Masks

•

Recommended Patterns and Sequence Reset Values

| Part 3: Configuring Agency Business Objects | 365

Understanding Masks
You can apply masks to phone number and postal code fields to ensure that users enter these numbers
in the appropriate format. For example, your agency might want to require users to include their country
code with their phone number, or to require users to enter phone numbers as 888.555.1212 rather than
888-555-1212. If a user attempts to enter a number in another format, Civic Platform delivers an error
message and asks them to reenter the number.
When creating masks, enter “0”s or “#”s in the positions where you want Civic Platform to accept any
number or character. Civic Platform requires users to enter all characters in the expected format and
position. For example, to create a format that forces users to enter a phone number in the format
(800)555-1212 x.555, enter (000)000-0000 x.###.
Using the sequence generator you can define masks for numbered items. A mask in Civic Platform
determines how a number displays to a user. For example, each new permit number might have a prefix
indicating the type of permit and a date code in addition to the incremental number. A citation number can
have a prefix that identifies it as a citation and not a permit, receipt number, or other incremental record in
Civic Platform. After the initial implementation, you rarely need to modify masks.
When creating the pattern of the mask, be certain that you include the interval type within the sequence
number. By including the interval type in the pattern ensures uniqueness. Without the interval type, you
might introduce duplicates.
Mask Definitions can only reference a single Sequence Definition. You can have many mask definitions
that point to the same sequence definition. This way, you can have multiple masks using the same number
pool. For example, you might want to use a single number pool for all of the application types for the
building module but have the mask display different information with that number. For example: you could
name your Record ID Sequence Definition “Building” and then your mask definitions “Building-Residential”
and “Building-Commercial” could reference Sequence Definition Building.
A mask pattern consists of a combination of variable substitutions and literal text. A pattern has one
sequence number variable you can place anywhere in the pattern. All variables can appear in any position
of the mask pattern. Enclose all variables in “$$” delimiters. For example, you write a sequence number
variable as $$SEQ08$$. For example, a mask might contain CIT to indicate that the number is a citation
number. This section details the various items that you can include in the pattern.
Sequence mask patterns return results in all uppercase.
All variable names are case-sensitive. For example $$MM$$ represents month data but $$mm$$ represents minutes
data.

For the basic building blocks of masks, refer to Example Mask Patterns.
The date patterns can represent year, month, day, day of year, hour, day of month, day of week. For a list
of all mask pattern possibilities, refer to the Common Date Formats.
With pattern masks, you can represent numbers as Base 10 (meaning each digit can be 0-9) or Base 36
(meaning each digit can be 0-9 or A-Z). For example, you can represent over 60 million different Record
Keys from the same number pool (sequence interval) without conflict.
Example Record Key pattern

$$yy$$BLD-00000-$$SEQ05$$ with a base of 36

Corresponding Record ID pattern

$$yy$$BLD-$$SEQ08$$ with a base of 10

Pre-defined Sequence Types and Masks
Pre-Defined Sequences and Masks lists the predefined sequences and masks that come with Civic
Platform. This section also explains how to locate the pre-defined sequences by the Default name in the
navigation tree.

| Part 3: Configuring Agency Business Objects | 366

Table 60: Pre-Defined Sequences and Masks

Sequence
Type

Mask Name

Mask Definition Name Description

Best Practices

Agency >
Batch Invoice

Batch Invoice

Batch Invoice

Special Purpose Agency Sequence.
Batch Invoice definition is $$SEQ12$
$ with the numbers displayed as base
10. Sequence Interval equals “None”
which means it never resets based
upon a date.

Use the default
setting and do
not modify the
default.

Agency>
Classic
Citation
Number

Classic Citation
Number

Classic Citation
Number

Special Purpose Agency Sequence.
Classic Citation Number definition is $
$SEQ19$$ with the numbers displayed
as base 10.

Use the default
setting and do
not modify the
default.

Sequence Interval equals “None”
which means it never resets based
upon a date.
Agency >
Invoice

Invoice

Invoice

Special Purpose Agency Sequence.
Invoice definition is $$SEQ12$$ with
the numbers displayed as base 10.
Sequence Interval is equal to “None”
which means it never resets based
upon a date.

Use the default
setting and do
not modify the
default.

Agency
> Project
Number

Project Number

Project Number

Special Purpose Agency Sequence.
Project Number definition is $
$SEQ19$$ with the numbers displayed
as base 10. Sequence Interval is equal
to “None” which means it never resets
based upon a date.

Use the default
setting and do
not modify the
default.

Agency >Set
ID

< Set ID Masks
are listed
below>

Set ID

Special Purpose Agency Set ID
Sequence Definition.

Use default
setting.

Set ID defaults to a single Set ID
shared by multiple Set Masks. You can
modify each Set Mask to use a unique
number pool.
The Sequence Interval is equal to
“Calendar Year” so it resets based
upon a calendar year.
Civic Platform uses this Set ID
Sequence Definition for all of the
different Set ID Masks, including
Address Set ID, Record Set ID,
Licensed Professional Set ID, Parcel
Set ID, RandomAudit Set ID, and Set
of Sets ID.

Address Set ID

Set ID

The Record Set ID Mask Pattern is $
$yy$$-SET-$$SEQ05$$ with a base
of 10. Civic Platform shares the Set ID
Sequence Definition with the other Set
ID masks.

Use default
setting.

| Part 3: Configuring Agency Business Objects | 367

Sequence
Type

Asset ID >
Default

Mask Name

Mask Definition Name Description

Best Practices

Record Set ID

Set ID

Use default
setting.

The Record Set ID Mask Pattern is $
$yy$$-SET-$$SEQ05$$ with a base
of 10. Civic Platform shares the Set ID
Sequence Definition with the other Set
ID masks.

Licensed
Set ID
Professional Set
ID

The Licensed Professional Set ID
Use default
Mask Pattern is $$yy$$-LP-$$SEQ05$ setting.
$ with a base of 10. Civic Platform
shares the Set ID Sequence Definition
with the other Set ID masks.

Parcel Set ID

Set ID

The Parcel Set ID Mask Pattern is $
$yy$$-PARCEL-$$SEQ05$$ with a
base of 10. Civic Platform shares the
Set ID Sequence Definition with the
other Set ID masks.

Use default
setting.

Set of Sets ID

Set ID

The Set of Sets ID Mask Pattern is $
$yy$$-SETS-$$SEQ05$$ with a base
of 10. Civic Platform shares the Set ID
Sequence Definition with the other Set
ID masks.

Use default
setting.

Default

Default

The Default Mask Pattern for the Asset Use default
ID is $$SEQ015$$ with a base of 10.
setting.
The Sequence Interval Type is equal
to None and the Sequence Name is
“N” which means it never resets based
upon a date.

Invoice

Agency-Invoice

Agency-Invoice

Agency Invoice Sequence. AgencyInvoice definition is $$SEQ12$$ with
the numbers displayed as base 10.
The Sequence Interval is equal to
“None” which means it never resets
based upon a date (the agency default
if you do not set up any custom
receipts).

Use the default
setting and do
not modify the
default.

| Part 3: Configuring Agency Business Objects | 368

Sequence
Type

Mask Name

Mask Definition Name Description

Invoice

POS-Invoice


POS-Invoice  Agency Invoice Module.

Best Practices

Configure Point
of Sale Invoice
Point of Sale invoice module masks
can follow the pattern in your agency’s the same as any
other custom
accounting system. The Mask
Definition and Sequence Definition that invoice.
applies to a POS invoice is equal to
“POS-Invoice-.”
This configuration enables you to
identify what department or group
to associate with the Point of Sale
(POS) invoice. For example, replace
 with a department name
such as “POS-Invoice-Building.” You
must create invoice sequences and
mask definitions before you can use
the point of sale features.
The Sequence Interval Type is equal
to Calendar Year and the Sequence
Name is “CYyyyy” where yyyy reflects
the year in four digits so it resets
based upon a calendar year.

Record ID

Default

Default

The Record ID Default can handle
over 60,000,000 unique keys every
year. The Mask Pattern is $$yy$
$Record-00000-$$SEQ05$$ with a
base of 36 because it is a key.

Use default
setting.

The Sequence Interval Type is equal
to Calendar Year and the Sequence
Name is “CYyyyy” where yyyy reflects
the year in four digits so it resets
based upon a calendar year.
Record Key

Default

Default

The Record Key Default can handle
over 60,000,000 unique keys every
year. The Mask Pattern is $$yy$
$Record-00000-$$SEQ05$$ with a
base of 36 because it is a key. The
Sequence Interval Type is equal to
Calendar Year and the Sequence
Name is “CYyyyy” where yyyy reflects
the year in four digits so it resets
based upon a calendar year.

Use default
setting.

Record Key

Model Record

Model Record

Special Purpose Record Key
Sequence. You can have up to 9999
models defined each year in Civic
Platform. The Defaultpattern is: $$yy$
$MDL-00000-#$$SEQ04$$ The base
is 10.

Use the default
setting and do
not modify the
default.

| Part 3: Configuring Agency Business Objects | 369

Sequence
Type

Mask Name

Partial Record Default
ID

Mask Definition Name Description
Default

Best Practices

Special Purpose Record ID Sequence. Use the default
The Default pattern is $$yy$$EST-$
setting and do
$SEQ06$$. The base is 10.
not modify the
default.
The Sequence Interval Type is equal
to Calendar Year and the Sequence
Name is “CYyyyy” where yyyy reflects
the year in four digits so it resets
based upon a calendar year.

Temporary
Record ID

Default

Default

Special Purpose Record ID Sequence. Use the default
The Default pattern is $$yy$$TMP-$
setting and do
$SEQ06$$. The base is 10.
not modify the
default.
The Sequence Interval Type is equal
to Calendar Year and the Sequence
Name is “CYyyyy” where yyyy reflects
the year in four digits so it resets
based upon a calendar year.

Receipt

Agency-Receipt Agency-Receipt

Special Purpose Receipt Sequence.
Agency-Receipt definition is $
$SEQ12$$ with the numbers displayed
as base 10. The Sequence Interval is
equal to “None” which means it never
resets based upon a date (the agency
default if you do not define any custom
receipts).

Use the default
setting and do
not modify the
default.

Receipt

POS-Receipt

Special Purpose Receipt.

Configure Point
of Sale Receipts
the same as any
other custom
receipt.

POS-Receipt

Point of Sale receipt masks are for
special purpose Receipts. The point
of sale system uses this by getting
the Mask Definition and/Sequence
Definition named “POS-Receipt” where  is the
name of the Point of Sale (POS)
receipt that you are defining.
For example, “POS-Receipt-Building.”
You must create receipt sequence and
mask definitions before you can use a
point of sale.
The Sequence Interval Type is equal
to Calendar Year and the Sequence
Name is “CYyyyy” where yyyy reflects
the year in four digits so it resets
based upon a calendar year.

| Part 3: Configuring Agency Business Objects | 370

Sequence
Type

Mask Name

Mask Definition Name Description

Best Practices

Receipt

PP-Receipt

PP_RECEIPT_SEQ

Configure
Payment
Processing
Receipts the
same as any
other custom
receipt.

Special Purpose Receipt. Payment
Processing receipt masks are
for special purpose Receipts.
The Payment Processing system
uses them by getting the Mask/
Sequence Definition named
“PP_RECEIPT_SEQ.”
You must create these receipt
sequence and mask definitions before
you can use Payment Processing.

Receipt

SET-Receipt


SET-RECEIPT_SEQ

Special Purpose Receipt. Create Set
receipt masks for special purpose
Receipts. The Set/Sets system uses
this by getting the Mask/Sequence Def
named “SET_RECEIPT_SEQ.”

Configure Set/
Sets Receipts
the same as any
other custom
receipt.

You must create receipt sequence and
mask definitions before you can use
Payment Processing.
Receipt

POS-Invoice

POS-Invoice

Special Purpose Invoice.
Create Point of Sale Invoice masks
as a special purpose Invoice. The
point of sale system uses them by
getting the Mask/Sequence Def named
“POS-Invoice-” where
 is the name of the Point of
Sale (POS) invoices you are defining.
For example, “POS-Invoice-Building.”

Configure Point
of Sale Invoices
the same as any
other custom
receipt.

You must create these invoice
sequence and mask definitions before
you can use POS.

You can locate the Default settings by expanding the Sequence by Type in the navigation tree. Refer to
illustrations highlighting Default examples of a default Sequence Definition and Mask Definition for the
Asset ID.
Default Mask Definition for Asset ID, highlights where to locate the Default Sequence Definition for the
Asset.

| Part 3: Configuring Agency Business Objects | 371

Figure 20: Default Mask Definition for Asset ID
Default Sequence Definition for Asset ID, highlights the Default Mask Definition for the Asset ID.

Figure 21: Default Sequence Definition for Asset ID

Example Mask Patterns
Table 61: Example Mask Patterns

Sequence Type

Example

Output

Invoice

INV-$$yyyyMMddHH$$-$$SEQ08$$Base =
10Reset Value = 99999999 (10^8 – 1)

REC-2010083116-00000003

Record ID

$$yyyy$$-$$SEQ07$$-RESBase = 10 (always
recommended for Record ID)Reset Value =
99999999 (10^8 – 1)

2008-00000001-RES2008-00000021RES2008-00000301-RES2008-00087601RES

Record ID

LIC-$$yyyy$$-$$RANDOMZ06$$-$$SEQ##-####- LIC-2008-9AD633-12-3456-789LIC###$$Base = 10 Reset Value = 999999999 (10^9 – 2008-ZX8F3E-12-3456-789LIC1)
2008-78934RT-12-3456-789LIC- 2008K8J7D3D-12-3456-789

| Part 3: Configuring Agency Business Objects | 372

Sequence Type

Example

Output

Record Key

$$yy$$BLD-00000-$$SEQ05$$Base=36Reset
08BLD-00000-0000108BLD-00000Value = 60466175 (36^5 - 1) Note: In the pattern for 00A0108BLD-00000-0ZZ0108BLD-00000new Record Key definitions, always use Base=36,
ZA421
Reset Value = 60466175 (36^5 - 1), and $$SEQ05$
$

Record Key

$$yy$$BLD-00000-$$SEQ05$$Base = 10Reset
Value = 99999 (10^5 – 1)

08BLD-00000-0000108BLD-000000001108BLD-00000-0043108BLD-0000008801

Receipt

REC-$$CI$$-$$CDI$$-$$yyyyMMddHH$$-$
$SEQ08$$Base = 10Reset Value = 99999999
(10^8 – 1)

REC-DC4-02-2008071416-00002423

Common Date Formats
Table 62: Common Date Formats

Description

Syntax

Example of Output (2008-07-14 4:22 pm)

Year (2 digit)

$$yy$$

08

Year (4 digit)

$$FYYY$$

2008

Month in Year

$$MM$$

7

Month in Year

$$MMM$$

Jul

Week in Year

$$ww$$

28

Week in Month

$$W$$

2

Day in Year

$$DD$$

197

Day in Month

$$dd$$

14

Day of Week in month

$$F$$

1

Day of Week in month

$$EEE$$

Mon

AM/PM

$$Accela
Automation$$

PM

Hour in Day (0- 23)

$$HH$$

16(Example: 2008-07-14 0:22 -> 00)

Hour in Day (1 - 24)

$$kk$$

16(Example: 2008-07-14 0:22 -> 24)

You can combine Simple Date patterns into a
single, more complex pattern.

$$yyMMdd$$

080714

You can combine Simple Date patterns into a
single, more complex pattern.

$$yyMMM$$

08JUL

You can combine Simple Date patterns into a
single, more complex pattern.

$$yyMMdd-HH$$

080714-16

Fiscal Date Formats
Civic Platform supports fiscal years that start on the first day of a calendar month.
Table 63: Fiscal Date Formats

Description

Syntax

Example of Output (2008-07-14 4:22 pm with
Fiscal Year start = 07)

Fiscal Year (2 digit)

$$FY$$

09

| Part 3: Configuring Agency Business Objects | 373

Description

Syntax

Example of Output (2008-07-14 4:22 pm with
Fiscal Year start = 07)

Fiscal Year (4 digit)

$$FYYY$$

2009

Fiscal Quarter (1 digit)

$$FQ$$

1

Fiscal Month/Period (2 digit)

$$FM$$

01

Sequence Number Formats
Table 64: Sequence Number Formats

Description

Description

Example

Output

Sequence
$$SEQ$$
Number (Default)

1-5 digits with valid digits
determined by Sequence Number
Base (2-36).

$$SEQ$$Base = 10

99909990

$$SEQ$$Base = 36

8Z2SDFZ9ZZ8

Sequence
Number

[0] Left Zero Fill if sequence does
not require all n digits.n = maximum
number of digits to display.

$$SEQ05$$Base = 10

00009000
100083830000

$$SEQ5$$Base = 36

19AZ10999A
Z8888

Sequence
Number
(formatted
number)

Syntax

$$SEQ[0]n$$

$$SEQ####$$

Formatted Number. Starts with # or $$SEQ##-#####$
*. Each # represents one digit. Each $Base = 10
* represents one hidden digit.
$$SEQ##-###-##$
Warning: Do not use hidden digits
$Base = 10
if the sequence numbers generated
$$SEQ*****-##$$Base
must be unique because doing so
= 10
causes the mask definition to return
duplicate sequences. Do not use
this option for asset IDs, record
keys, record IDs, or receipts for
Civic Platform to function properly.

01-23456
01-234-56
*****-56

Civic Platform treats any other
character as literal text.
Sequence
Number

$$SEQZ05$$

Legacy Record Key Sequence
$$SEQZ05$$
Format. Most significant digit is base
36 (valid values are[0-9]|[A-Z]). All
other characters are base 10 (valid
values are [0-9].

0000199999
A0000A9999
B0000Z9999

Miscellaneous Formats
Table 65: Miscellaneous Formats

Description

Syntax

Description

Example

Output

Literal Dollar
Sign

$$DOLLAR$$

Text

$$DOLLAR$$

$

Random
Number
(Default)

$$RANDOM$$

Creates from 1-5 random digits
with values from [0-9].

$$RANDOM$$

9 90 990
9990

| Part 3: Configuring Agency Business Objects | 374

Description

Syntax

Description

Example

Output

Random
Number

$$RANDOM[Z][0]n$$

Creates from 1-20 random digits
with values from [0-9] (base 10)
or [0-9] |[A-Z] (base 36).[Z] set
= base 36. If not set = base 10.
[0] set = left zero fill to guarantee
the exact number of digits.n
= number of digits. Default=5,
Min=1, Max=20.

$$RANDOMZ05$$$
$RANDOMZ9$$

ASD83
23NMJKF823L12L
Z8M3829D2

Receipt Variables for Receipt Masks
The variables in Receipt Variables for Receipt Masks apply to receipt masks.
Table 66: Receipt Variables for Receipt Masks

Description

Syntax

Description

Example
Output

Cash Drawer ID

$$CDI$$

Cashier Drawer ID. Use only for receipt
sequences.

05

Cashier Workstation

$$CI$$

Cashier Workstation Information. Use only
for receipt sequences

D42

Type Alias

$$RECTYPE-ALIAS$$

Record Type Alias. Use only for receipt
sequences; does not work for PP-Receipt
and SET-Receipt.

Facilities
Condos

Group

$$RECTYPE-1$$

The first element of application type. Use
Building
only for receipt sequences but does not work
for PP-Receipt and SET-Receipt.

Type

$$RECTYPE-2$$

The second element of application type. Use Facilities
only for receipt sequences but does not work
for PP-Receipt and SET-Receipt.

SubType

$$RECTYPE-3$$

The third element of application type. Use
Remodel
only for receipt sequences but does not work
for PP-Receipt and SET-Receipt.

Category

$$RECTYPE-4$$

The fourth element of application type. Use
Condos
only for receipt sequences but does not work
for PP-Receipt and SET-Receipt.

Module Name

$$RECTYPE-MODULE
$$

The module name of application type. Use
Building
only for receipt sequences but does not work
for PP-Receipt and SET-Receipt.

Department Alias

$$DEPT-ALIAS$$

The department name of organization. Use
only for receipt sequences.

Long Range

Bureau

$$DEPT-1$$

The first element of the organization level.
Use only for receipt sequences.

DSD

Division

$$DEPT-2$$

The second element of the organization
level. Use only for receipt sequences.

PLN

Section

$$DEPT-3$$

The third element of the organization level.
Use only for receipt sequences.

NA

Group

$$DEPT-4$$

The fourth element of the organization level.
Use only for receipt sequences.

Long Range

| Part 3: Configuring Agency Business Objects | 375

Description

Syntax

Description

Example
Output

Office

$$DEPT-5$$

The fifth element of the organization level.
Use only for receipt sequences.

NA

User Name

$$USERID$$

User Login ID. Use only for receipt
sequences.

Admin

Invoice Variables for Invoice Masks
Table 67: Invoice Variables for Invoice Masks

Description

Syntax

Description

Example
Output

Record Type Alias

$$RECTYPE-ALIAS$$

Record Type Alias.

Facilities
Condos

Group

$$RECTYPE-1$$

The first element of application type.

Building

Type

$$RECTYPE-2$$

The second element of application type.

Facilities

SubType

$$RECTYPE-3$$

The third element of application type.

Remodel

Category

$$RECTYPE-4$$

The fourth element of application type.

Condos

Module Name

$$RECTYPE-MODULE
$$

The module name of application type.

Building

Department Alias

$$DEPT-ALIAS$$

The department name of organization.

Long Range

Bureau

$$DEPT-1$$

The first element of the organization level.

DSD

Division

$$DEPT-2$$

The second element of the organization
level.

PLN

Section

$$DEPT-3$$

The third element of the organization level.

NA

Group

$$DEPT-4$$

The fourth element of the organization level.

LONGRANG

Office

$$DEPT-5$$

The fifth element of the organization level.

NA

User Name

$$USERID$$

User Login ID.

Admin

Recommended Patterns and Sequence Reset Values
Table 68: Recommended Patterns and Sequence Reset Values

Mask Pattern

Base 10 Sequence Reset Value

Base 36 Sequence Reset Value

$$SEQ01$$

9

10^1-1

35

36^1-1

$$SEQ02$$

99

10^2-1

1295

36^2-1

$$SEQ03$$

999

10^3-1

46655

36^3-1

$$SEQ04$$

9999

10^4-1

1679615

36^4-1

$$SEQ05$$

99999

10^5-1

60466175

36^5-1

$$SEQ06$$

999999

10^6-1

2176782335

36^6-1

$$SEQ07$$

9999999

10^7-1

78364164095

36^7-1

$$SEQ08$$

99999999

10^8-1

2821109907455

36^8-1

$$SEQ09$$

999999999

10^9-1

101559956668415

36^9-1

$$SEQ010$$

9999999999

10^10-1

3656158440062975

36^10-1

$$SEQ011$$

99999999999

10^11-1

131621703842267135

36^11-1

| Part 3: Configuring Agency Business Objects | 376

Mask Pattern

Base 10 Sequence Reset Value

Base 36 Sequence Reset Value

$$SEQ012$$

999999999999

10^12-1

4738381338321616895

36^12-1

$$SEQ013$$

9999999999900

10^13-1

9223372036854775807

36^13-1

$$SEQ014$$

99999999999999

10^14-1

Not Applicable

N/A

$$SEQ015$$

999999999999999

10^15-1

N/A

N/A

$$SEQ016$$

9999999999999999

10^16-1

N/A

N/A

$$SEQ017$$

99999999999999999

10^17-1

N/A

N/A

$$SEQ017$$

999999999999999999

10^19-1

N/A

N/A

$$SEQ019$$

9223372036854775807

2^63-1

N/A

N/A

| Part 3: Configuring Agency Business Objects | 377

Designing Workflows
A workflow is a set of tasks that your agency follows to process a record. Each record type has a specific
workflow process that manages the individual records created by the users. A record moves through the
workflow process as the users update the status of the workflow tasks.
Click a topic title below for full details.
Related Information
Deciding Which Tool to Use
Workflow Redesign for Civic Platform's New User Interface
Working with Workflow Designer
Working with the Classic Workflow Tool
Creating Task Statuses
Configuring Agency-defined Fields for Workflows
Tracking In-possession Time for a Record
Configuring Automatic Email Messages
Managing Automatically Printed Reports
Assignments, Skillsets, and Workloads
Making Workflow Task Assignments
Managing Activities

Deciding Which Tool to Use
Civic Platform provides two options for designing workflows: the Classic Workflow tool and Workflow
Designer. You can view and edit workflows created in the Classic Workflow tool with Workflow Designer,
and vice versa.
•

Working with the Classic Workflow Tool
This tool provides standard workflow configuration styles based on the Classic Administration user
interface. When designing the task relationships with the Classic Workflow tool, you must determine the
position of each task in the workflow, and use proper phase numbers as indicators to the positions.

•

Working with Workflow Designer
This tool is the next generation of workflow design. Workflow Designer provides a graphical user
interface and is simpler and easier to use. Workflow Designer contains the same functionality as the
Classic Workflow tool, but has the added benefit of letting you see a visual representation of your
workflow while you design it.

The Classic Workflow tool enables you to save incomplete workflows, while Workflow Designer does not.
When you attempt to open a partially designed workflow in Workflow Designer, an error message displays,
and the workflow fails to load. In this case, you must open and edit the workflow in the Classic Workflow
tool first.
Best practice is to create all your workflows in Workflow Designer, unless the features are unique to the
Classic Workflow tool. See Workflow Configuration: Which Tool to Use for details.

| Part 3: Configuring Agency Business Objects | 378

Table 69: Workflow Configuration: Which Tool to Use

Workflow Configuration Task

Which Tool to Use

How to Access

Basic Workflow Configuration

Workflow Designer

Navigation path: V360 Administration
> Administration > Workflow Designer

Basic Process Configuration

Documentation: Working with
Workflow Designer.

Process Task Configuration
Task Status
Task Status' Email Setting
Task's Proximity Alert
Task specific-information definition

Classic Workflow

Task Status' Report Setting

Navigation path: Classic Admin Tools
> Workflow
Documentation:Working with the
Classic Workflow Tool.

Email Template
Workflow Blockout

Classic Calendar administration

Navigation path: Classic Admin Tools
> Calendar > Calendar

Task's Activity

Workflow and Activity
administration

Navigation path: V360 Administration
> Workflow and Activity

Workflow Security

Documentation:Adding or Editing
Workflow Task Security and
Configuring Record-Related Activities.
Task Standard Condition

Condition administration

Navigation path: V360 Administration
> Conditions > Conditions
Documentation: Setting Up
Conditions.

Workflow Redesign for Civic Platform's New User Interface
Topics:
•

Overview

•

Migrating to New Workflow Designer

•

Enhanced Card Views

•

Enhanced Workflow Designer Functionality

•

Enhanced Display Order Control

Overview
The new Workflow Designer offers a number of new features, a new look and feel, improved usability
and additional customization options. In addition, Classic Workflow users can now prevent workflow
incompatibility issues by adopting the new Workflow Designer available in the Civic Platform 9.0.0+
release.
Note: Classic Workflows (workflows created via Classic Administration) are not compatible with
the new Workflow Designer. Accela strongly recommends users migrate old workflows to the new
Workflow Designer in the 9.0.0+ release. Aside from the functionality advantages the new Workflow
Designer provides, users that migrate away from Classic Workflow can prevent future compatibility
issues that could arise as new features are developed. Please see the Migration Process section
below for information on how to migrate from Classic Workflow to Workflow Designer.

| Part 3: Configuring Agency Business Objects | 379

Note: Use Internet Explorer for best results with Workflow Designer.

Migrating to New Workflow Designer
Workflows created in Classic Workflow cannot be edited in Workflow Designer because of configuration
incompatibilities. Workflows created in Workflow Designer may lose their intended formatting and
configurations when edited in Classic Workflow. As a result of these incompatibilities, Accela strongly
recommends users upgrade to Workflow Designer in the 9.0.0+ release.
The migration process is straightforward, and this Community article provides a step-by-step walkthrough
of the process.

Enhanced Card Views
Summary Card View
The Summary Card View allows users to track the progress of an application throughout the workflow
process. Users can easily access information for each step in the process and quickly see which steps are
complete and incomplete, required and optional.

Each set of workflow tasks, Completed, In Progress and Up Next, can be collapsed in order to help the
user focus on a specific task or set of tasks. The Completed and Up Next tasks will be collapsed by default.
Users can quickly expand collapsed task sets and then expand the individual tasks that are most pertinent
to their jobs. This puts important information, such as Task-specific information (TSI) or ad hoc processes,
at the user's fingertips without presenting an overly detailed and distracting view of the entire workflow
process.

| Part 3: Configuring Agency Business Objects | 380

Ad Hoc tasks will be displayed in the same manner, with Completed and In Progress tasks grouped
together so they can be quickly collapsed or expanded. The method for creating an Ad Hoc task is
unchanged in 9.0.0+. Simply click the New Ad Hoc Task link to add it to the workflow.

Detail Card View
The Detail Card View allows users to see the detailed step information that is pertinent to a specific
workflow task so they can track, update and move an application forward.

| Part 3: Configuring Agency Business Objects | 381

If the task has been set up on the workflow to include sub tasks, they can be accessed by clicking the
collapsed Sub Task area on the parent task.

Sub tasks will be displayed just like standard tasks, with Completed, In Progress and Up Next task sets. To
return to the parent task, click the Workflow Tasks breadcrumb link at the top of the page.

| Part 3: Configuring Agency Business Objects | 382

Enhanced Workflow Designer Functionality
Enhanced Task Customization
Agency Administrators can use the new Workflow Designer to easily configure individual tasks to meet the
specific needs of a user group. Simply select Edit View from the Menu drop-down on the task to edit that
task.

The new Workflow Designer is built on the Bootstrap 12-column grid system. This framework provides
responsive output with easy-to-use snap to grid functionality. Users can select a field from the Controls
box on the left and drag the field into the desired position on the grid. A dotted blue box will indicate where
the field will snap into the grid. Once the field has been placed on the grid, the user can adjust the width
accordingly.

| Part 3: Configuring Agency Business Objects | 383

Once a field has been placed on the grid, the user can click the Properties button on the field container to
open the field Properties window. Here users can customize field labels, input formatting and other details.

Users can also use the Text button on the task menu to create a static text field in the grid. This text field
can be placed anywhere on the grid and edited to display user instructions, hyperlinks or other custom
content.

| Part 3: Configuring Agency Business Objects | 384

The Preview button is used to preview the edited task.

Clicking the Preview button opens the Task Preview window so users can confirm the task layout meets
their needs.

| Part 3: Configuring Agency Business Objects | 385

Enhanced Display Order Control
The Display Order field has been added to the Workflow Designer Administration window in the 9.0.0+
release. This enhancement allows users to specify a display order for workflow tasks.
By selecting a workflow task and specifying a display order between 1 and 999, users can control how
the task is displayed in the new Workflow Designer window. This will not affect the order in which the
tasks must be completed, but only the order in which they are displayed. Users will find this useful when
designing a workflow that includes multiple parallel tasks that can be processed concurrently, but when a
specific display order makes sense.

Note: Users must reassign the workflow to the record after specifying the new Display Order in
order for the tasks to display in the order specified.

| Part 3: Configuring Agency Business Objects | 386

Working with Workflow Designer
This section describes how to use Workflow Designer to create or edit a workflow, and how to design the
process and sub processes in the workflow. This section also contains information on where you can view
a video demonstration of creating workflows.
Topics
•

Opening Workflow Designer

•

Creating a Workflow

•

Designing the Workflow Process

•

Editing a Workflow

•

Cloning a Workflow

•

The Workflow Designer Menu

•

The Widgets Panel

•

Workflow Properties

Opening Workflow Designer
To open Workflow Designer
1. Navigate to the Administration portlet (see Navigating to the Setup Portlet).
2. From the Setup portlet, choose Administration > Workflow Designer.

Figure 22: Sample Workflow shows Workflow Designer displaying a sample workflow.

| Part 3: Configuring Agency Business Objects | 387

Figure 22: Sample Workflow
A

Workflow Designer Menu. Displays the New, Open, Save, Save Draft, Clone, Print, Exit and Help buttons.

B

Widgets Panel. This panel provides all the available widgets that you can add to a workflow process.

C

Workspace. The central panel provides the canvas for you to design workflow processes and sub processes.
Only one workflow process can be open at one time. If the workflow process has several sub processes, the
sub processes display in individual tabs.

D

Navigator Panel. This panel displays a thumbnail view of the design panel. You can drag the border of the
outline in the panel to quickly change the view of the design panel.

E

Property Sheet. This property sheet provides a list of properties directly related to the workflow process or sub
process displayed in the workspace, and the property settings of the widget (if any) that currently has focus.

Creating Workflows
Creating a Workflow
A best practice recommendation is to first plan out the design of your workflow on paper before you
create it in Workflow Designer. Draw a diagram of your workflow on paper to help you identify all the tasks
involved with a process, reduce oversights in your electronic version, and facilitate a thoughtful, welldesigned workflow process.
To create a workflow
1. Navigate to the Administration portlet (see Navigating to the Setup Portlet).
2. From the Setup portlet, choose Administration > Workflow Designer.

| Part 3: Configuring Agency Business Objects | 388

3. Click New.
The Create Workflow dialog box displays.

4. Enter a Workflow Name.
Workflow Designer validates the name and displays a check mark by the field to indicate successful
validation.

5. You can either create a new master process for the workflow, or specify an existing process as the
master process:
•

To create a new process, click Create a New Process, then enter a process name.

•

To specify an existing process, click Use Existing Process, then select a process.

If you create a workflow with an existing process, after you edit and save the process in the new
workflow, Civic Platform updates the process in the other workflows associated with it.
6. Click Submit.
7. Design the workflow process as described in Designing the Workflow Process.
8. Click Save when your workflow design is complete.
If you have not yet finished designing the workflow, click Save Draft before exiting Workflow Designer.

Designing the Workflow Process
Before you start designing a workflow process, it is best practice to understand all of the tasks you plan to
include, what status a task must reach before its subsequent task can start, and how tasks relate to each
other.
Workflow Designer does not allow you to save partially completed workflows, so make sure a workflow can
meet all the following criteria before saving it:
•

The workflow must have start nodes and end nodes.

•

All of the nodes must connect with a flow widget.

•

All of the connections (flows) must have a status.

Troubleshooting Tip: A flow widget must start from a start, fork, join or a task widget, and it must end at a
fork, join, task or an end widget. If a flow widget starts from a task widget, you must assign one or more
task statuses to the flow widget. This way, the workflow process knows what status(es) a task must reach
before its subsequent task(s) can start.

| Part 3: Configuring Agency Business Objects | 389

To design the workflow process
1. Complete steps 1-6 of the preceding topic, Creating a Workflow.
2. From the Widgets panel, drag and drop a Start node and an End node onto your blank workspace.
Simply click the node (Start, for example) then drag and drop it onto the workspace, leaving space
between the nodes so you can enter details later, as show below. For descriptions of the widgets, see
The Widgets Panel.

3. From the Widgets panel, drag the workflow tasks onto the workspace.

4. To specify the task names, double-click the default task name (Task1, for example) and enter a name
for your task.

5. To connect two tasks, add a flow widget (Straight, Horizontal, or Vertical) as follows:
a. From the Widgets panel, click the appropriate flow widget.
b. Go to the workspace.

| Part 3: Configuring Agency Business Objects | 390

c. Hover the mouse over the center of a task.
d. Wait for the mouse cursor to change from an arrow to a hand:

e. Drag the cursor to the next task and then release the mouse button.

6. To connect one task to two or more parallel tasks:
a. From the Widgets panel, drag a Fork widget between the task and the parallel tasks.
b. From the Widgets panel, drag a Straight widget to connect the task to the fork node.
c. From the Widgets panel, drag a Vertical widget to connect the fork node to each parallel task.

7. To connect two or more parallel tasks to one task:
a. From the Widgets panel, drag a Join widget between the parallel tasks and the individual task.
b. From the Widgets panel, drag a Vertical widget to connect the parallel tasks to the join.
c. From the Widgets panel, drag a Straight widget to connect the join node to the next task.

| Part 3: Configuring Agency Business Objects | 391

8. After you connect all of the workflow tasks to each other, connect the last workflow task to the end node
with the Straight flow widget.

9. To create a workflow status that keeps the workflow on the same task:
a. From the Widgets panel, select Vertical.
b. Hover your mouse over the task; start and end the connection on the same task.

| Part 3: Configuring Agency Business Objects | 392

10.To create a workflow status that loops back to a previous task:
a. From the Widgets panel, select Vertical.
b. Hover your mouse over the task.
c. Drag the connection back to a previous task.

| Part 3: Configuring Agency Business Objects | 393

11.To add a task status:
a. From the workspace panel, select a task connection.
b. From the Flow Properties panel, click Manage Status.
c. Click New.
d. Enter the name of the status.
e. Click Submit.

| Part 3: Configuring Agency Business Objects | 394

12.To define the status settings:
a. Select a task connection.
b. From the Flow Properties panel, click Manage Status.
c. From the Status Setting panel, define the appropriate settings.

13.To set the Workflow Properties for a workflow task:
a. From the workspace panel, select a task.
b. From the Task Properties panel, set the properties for the task.

| Part 3: Configuring Agency Business Objects | 395

14.Click Save when your workflow design is complete.

Editing a Workflow
Regardless of where you created a workflow, whether in the Classic Workflow tool or Workflow Designer,
you can edit it in Workflow Designer.
To edit a workflow
1. Navigate to the Administration portlet (see Navigating to the Setup Portlet).
2. From the Setup portlet, choose Administration > Workflow Designer.
3. Click Open.
Workflow Designer displays the Open Workflow dialog with all the existing workflows in the General tab
and all the draft workflows in the Draft tab. The existing workflows contain all the workflows configured
in either Workflow Designer or the Classic Workflow tool.

| Part 3: Configuring Agency Business Objects | 396

4. Locate the workflow. In the General tab or the Draft tab, you can filter the workflows that display by:
•

Entering text in the Find by field. You can then press Enter or click the Filter button to display only
the workflows whose names start with the text.

•

Clicking the page selection buttons to switch between pages.

5. Select the workflow.
6. Click Open.
Workflow Designer displays the message “Opening workflow, please wait...”
Troubleshooting Tip: If the selected workflow fails to load in Workflow Designer it might be a partially
completed workflow created with the Classic Workflow tool. If this is the case you must return to the
Classic Workflow tool, open the workflow there, and finish configuring the workflow before you can open
it in Workflow Designer.
7. Edit the workflow tasks as appropriate to your business objectives.
8. Save the workflow.

Cloning a Workflow
You can clone a workflow that is currently open in the workspace.
To clone a workflow
1. Navigate to the Administration portlet (see Navigating to the Setup Portlet).
2. From the Setup portlet, choose Administration > Workflow Designer.
3. Open a workflow.
4. Click Clone.
The Work Designer displays the Clone Workflow dialog.

5. Enter the new workflow name.
A warning sign
displays if the new name is in use by an existing workflow or if the new name
contains forbidden characters. You must change the name to dismiss the warning.
6. (Optional) Enter the new process name. If you do not enter a new process name, the cloned workflow
inherits the process of the workflow you are cloning.
Workflow Designer opens the newly-cloned workflow process. The old workflow process automatically
exits in its last-saved state.
7. Modify the workflow according to the objectives you want to achieve.

| Part 3: Configuring Agency Business Objects | 397

8. Click Save.
Note:
If you clone a workflow without saving it first, the newly-cloned workflow contains the changes since the
last save, while the old workflow loses the changes.

The Workflow Designer Menu

Table 70: Workflow Designer Menu Items describes the buttons in the Workflow Designer menu.
Table 70: Workflow Designer Menu Items

Button Name

Description

New

Click this button to start the creation of a workflow.

Open

Click this button to display all the existing workflows (in the General tab) and draft
workflows (in the Draft tab). You can select a workflow or a drat workflow to edit it in the
workspace.

Save

Click this button to save the current workflow, its process and sub processes, and all its
properties.
Note:
You cannot save a workflow if the workflow does not pass validation.

Save Draft

Click this button to save a new workflow as a draft before completing the design of the
workflow process.
Note:
The Save Draft function does not work for general workflows that you already
saved successfully with complete process.

Clone

Click this button to clone the current workflow.
Note:
The Clone function does not work for draft workflows.

Print

Click this button to open the current workflow process or sub process in print layout.

Exit

Click this button to exit Workflow Designer. Remember to click Save first to avoid losing
any changes.

Help

Click this button to view instructions for using Workflow Designer.

The Widgets Panel

Table 71: Workflow Designer Widgets describes the set of widgets in the Workflow Designer menu that
appears in the widgets panel. Each widget displays with a graphical icon that helps you identify it.

| Part 3: Configuring Agency Business Objects | 398

In the widgets panel, the straight, horizontal, and vertical widgets are flow widgets, and the start, task, fork,
join and end widgets are node widgets.
Table 71: Workflow Designer Widgets

Widget Name

Description

Straight

Choose a flow widget (straight, horizontal or vertical) to connect two node widgets. If you
use the straight widget, the connecting line is straight.

Horizontal

Choose a flow widget (straight, horizontal or vertical) to connect two node widgets. If you
use the horizontal widget, the connecting line starts horizontally from a node and ends
horizontally at another node.

Vertical

Choose a flow widget (straight, horizontal or vertical) to connect two node widgets. If you
use the vertical widget, the connecting line starts vertically from a node and ends vertically
at another node.

Start

This node widget indicates the start of a workflow process.

Task

This node widget indicates a task in a workflow process.

Fork

This node widget indicates that multiple tasks are simultaneously active.

Join

This node widget indicates that all the previous tasks must be complete before the next
task can start, or the workflow can end.
If you open a workflow configured in the Classic Workflow tool, the join widget indicates
there are several parallel tasks.

End

This node widget indicates the end of a workflow process.

Workflow Properties

The property sheet resides on the right panel of Workflow Designer, and shows the properties related with
the current workflow. If a widget in the workspace has focus, the property settings of the widget, if any, also
display in the property sheet.
•

A workflow’s properties always display regardless of whether a widget in the workspace has focus. For
a description of workflow properties, see Table 72: Workflow Properties.

•

Task properties display when a task widget in the workspace has focus. For a description of task
properties see Table 73: Task Properties.

•

Flow properties display when a flow widget (straight, horizontal, or vertical) that starts from a task
widget has focus. For a description of flow properties, see Table 74: Flow Properties.
Table 72: Workflow Properties

Property

Description

Workflow Name

This read-only field displays the name of the current workflow.

| Part 3: Configuring Agency Business Objects | 399

Property

Description

Master Process Name

This read-only field displays the name of the master process for the current workflow.

In-process Task
Activation

Select whether to allow users to activate or deactivate tasks in the workflow process for
a record.

Module

Select the module that you want to assign the workflow to.

Status

Select the status of the workflow. If you choose disabled you cannot associate the
workflow with record types.

Table 73: Task Properties

Property

Description

Task Name

Enter the name of the task as you want it to display to users.

Initial Status

Select the task status you want to display when the task first becomes active.
When you first configure a workflow task, the drop-down list is empty. After you adds
a flow widget that suspends the task, the drop-down list displays the task statuses
configured for the flow widget. Here is an example of a flow widget that suspends a
task:

Department

Use the Department drop-down list to select the department that is responsible for the
task.

Staff

Use the Staff button to select a staff member that belongs to the selected department
and is responsible for the task.

Task Specific Info Group Select the specific task information group you want to associate with the current task in
the workflow process. You set up these groups in the Classic Workflow tool.
Duration (Days)

Enter the number of days required to complete this task after it is active.

Estimated Hours

Enter the number of estimated hours required to complete this task.

Hours Spent Required

Choose Yes if you want to require that anyone who works on the task records the
number of hours spent. If you do not want to require the hours spent, choose No.

Workflow Calendar

Use the drop-down list to assign a workflow calendar to the task.

Citizen Access
Displayable

If you want Citizen Access to display the task, select Yes; otherwise, select No.

Skip Tasks

If you click the field entry area, a “Skip Other Tasks” window pops up. You can select
the tasks that users can skip when they complete the current task.
Note:
You cannot configure a task as the skipped task in multiple tasks. If you
configure Task A as the skipped task in task B, and then you open the “Skip
Other Tasks” window for task C, the “Skip Other Tasks” window does not list
task A as an option.

Proximity Alert

If you click the field entry area, a “Proximity Alerts” window pops up. You can select the
GIS proximity alerts to apply during the execution of the task.

Sub Process

Select an existing sub process that you want to add to the current task. You can also
click the icon next to the field to create a new sub process in the current task.

Sub Process Completion If you want the sub process in the current task to complete before moving to the next
Required
task, select Yes; otherwise, select No.

| Part 3: Configuring Agency Business Objects | 400

Table 74: Flow Properties

Property

Description

Task Status

This field displays the status that a task must reach before the activation of its next
task. If there are multiple statuses, a task only need to reach one of the statuses before
the activation of its next task.

Application Status

Enter a status in this field. If the task that the flow widget starts from reaches the Task
Status, the Application Status you enter in this field displays as the Application Status.

Parent Status

This field works with the flow widget that starts from a sub process task. Enter a status
in this field. If the sub process task reaches the Task Status, the parent task that
contain the sub process changes to the status in this field.

Time Tracker Clock
Action

Select the time tracker clock action that triggers when the task reaches the selected
status. The time tracker clock controls how the Time Tracker records In Possession
time for workflow tasks and for applications.

Citizen Access
Displayable

If you want Citizen Access to display the task, select Yes; otherwise, select No.

Email Settings

This field displays the number of notifications to send when the task reaches the
selected status. “0-notification” means there is no notification, “1-notification” means
Civic Platform sends one notification, and so forth.
If you click the field entry area, an “Email Settings” window pops up. You can create,
edit or remove the notifications.

Working with the Classic Workflow Tool
This section provides instructions for using the Classic Workflow tool. However, because most functions
in the Classic Workflow tool are available in Workflow Designer, best practice dictates the use of Workflow
Designer instead of the Classic Workflow tool in most cases. See Deciding Which Tool to Use for more
information.
With the Classic Workflow tool, we highly recommend that you draw a diagram on paper first, and then use
the diagram as a guide when creating your workflow. With Workflow Designer you can create the diagram
directly in the workspace.
Topics
•

Understanding Workflow Tasks

•

Managing Workflow Processes

•

Managing Workflow Hierarchy

Understanding Workflow Tasks
You can set up several different types of tasks in each workflow process:
Parallel. A parallel task is any task in a group of tasks that share the same parallel indicator. You can set
up parallel tasks to activate independently of one another, depending on their task numbers. Workflow
participants must complete all parallel tasks in a single workflow process before the process can move
forward. You can override this constraint with a combination of skip activators and indicators.
Branch. A branch in a workflow process lets users jump to any future task in the workflow process, possibly
bypassing tasks in the process. You can set up a branch by using the next number of the task that you
want to jump from.

| Part 3: Configuring Agency Business Objects | 401

Loop. A loop in a workflow process lets users return and repeat any task that they have already completed.
You can set up a branch by using the next number of the task that you want to return from and the a
number of the task that you want to return to.
Two 15-digit numbers drive any workflow process that you set up: a phase number and a next number.
Topics
•

Understanding Phase Numbers

•

Understanding Next Numbers

Understanding Phase Numbers
A workflow process phase number is a series of five 3-digit numbers that identify the unique position of
this task in the workflow process and its relationship with other tasks. Depending on how you set up this
number, you can determine when a user activates and when it is skipped throughout the workflow process.

Figure 23: Example Phase Number
Table 75: Phase Number Elements

Task Number

Enter a unique 3-digit number that identifies this task and its order in the workflow
process.

Parallel Indicator

If you want to activate this task simultaneously with other tasks, enter the 3-digit number
that matches the 3-digit number in this position for each parallel task.
Enter “000” if this task is not a parallel task.

Skip Indicator

If you want to skip this task at some point during the workflow process, enter a 3-digit
indicator that matches the 3-digit activator of the task that initiates this skip.
Enter “000” if you never want to skip this task.

Loop Indicator

If you need to repeat this task after a user has completed it, enter a 3-digit indicator that
matches the 3-digit activator of the task that initiates this loop.
Enter “000” if you never want to repeat this task.

Place Holder

This component is currently acting as a placeholder. You can enter any 3-digit number, or
simply enter “000”

Understanding Next Numbers
A workflow process next number in is a series of five 3-digit numbers that identify the next task, or tasks, in
the workflow process. Depending on how you set up this number, you can set up the workflow to activate
the next task in the workflow process, jump to a future task, or to return to a completed task after a user
completes this task. You can also set up the workflow to skip another task when a user completes this
task.

| Part 3: Configuring Agency Business Objects | 402

Figure 24: Example Next Number
Table 76: Next Number Elements

Next Task Number

Enter the unique 3-digit number that identifies the next task in the workflow process.
Enter “000” if this task is the final task in the workflow.

Branch Task Number

If you want to jump to a future task without completing other tasks, enter the unique 3-digit
number that identifies the future task in the workflow process.
Enter “000” if you do not want to jump to a future task.

Skip Activator

If you want to skip a task after this task is complete, enter the 3-digit activator that
matches the 3-digit indicator of the task that you want to skip.
Enter “000” if you do not want to skip any tasks.

Loop Activator

If you need to repeat a task after this task is complete, enter the 3-digit activator that
matches the 3-digit indicator of the task that you want to repeat.

Place Holder

Enter “000” if you do not want to repeat any task.
This component is currently acting as a placeholder. You can enter any 3-digit number, or
simply enter “000”.

Managing Workflow Processes
Topics
•

Adding a Workflow Process

•

Editing a Workflow Process

•

Viewing Process Status

•

Viewing Process Status

Adding a Workflow Process
Each workflow process is a series of tasks that a workflow participant must complete before issuing a
certain type of permit or license. When you first implement Civic Platform, you must implement several
workflow processes. As necessary, you can set up additional workflow processes at any time. You can
also add or delete tasks from a process at any time.
In addition, you can put tasks into specific groups so they have the same task-specific information in a
summary that a user can view.
To add a workflow process
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Workflow > Process.
Civic Platform displays the Workflow Process—Edit window.

| Part 3: Configuring Agency Business Objects | 403

3. Click Add.
4. Enter the new process name in the Process field.
5. Click Submit.
Civic Platform supplies the default workflow process.
6. Update the fields for each task in the workflow process. For a description of fields, see Table 77:
Workflow Process Fields.
Note:
Click the yellow light bulb that appears to the left of the task if you want to use the Task Flow Assistant to
help you set up phase and next numbers.

7. Click Update.
Table 77: Workflow Process Fields

Phase #

Enter the 15-digit number that identifies the position of this task in the workflow process
and its relationship to other tasks. For more information about each component of a
Phase number, see Understanding Phase Numbers.

Next #

Enter the 15-digit number that identifies one or more tasks in the workflow process
that you want to activate after this task is complete. For more information about each
component of a Next number, see Understanding Next Numbers.

Task Name

Enter the name of the task as you want it to display to users. This field accommodates
up to 100 characters.

Initial Status

Select the task status you want to display when the task first becomes active.
When you first set up a workflow process, this list is empty. After you set up the
initial process, you must set up each task status. You can then return to the workflow
process and choose an initial status.

Duration

Enter the number of days required to complete this task after it is active.

Estimated Hours

Enter the number of estimated hours required to complete this task.

Citizen Access
Displayable

If you want Citizen Access to display the task, select Yes; otherwise, select No.

Workflow Calendar

Use the drop-down list to assign a workflow calendar to the task.

Department

Use the Department button to search for the department that is responsible for the
task.
Note:
To search for a specific staff member, complete only the Staff field explained
below. Civic Platform automatically populates the Department field with the
corresponding department.

Staff

Use the Staff button to search for a department and a staff member that is responsible
for the task.
If you enter a value in this field, Civic Platform carries this task assignment over to all
new applications that follow this workflow.
After creating a new application, authorized users have the option to change this
assignment.

Task-Specific Info Group Select the specific task information group you want to associate with each task in the
workflow process. Your agency sets up these groups, which allow you to associate
similar tasks in the same group.

| Part 3: Configuring Agency Business Objects | 404

Hours Spent Required

Choose Yes if you want to require that anyone who works on the task records the
number of hours spent. If you do not want to require the hours spent, choose No.

Editing a Workflow Process
After you add a workflow process to Civic Platform, you might need to edit workflow task details. For
example, you might need to change the order of the tasks, or change the person who is responsible for a
task. You can change the details about any task as well as add or delete tasks.
Any changes that you make to a workflow process do not affect existing applications associated with the
process.
To edit a workflow process
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Workflow > Process.
Civic Platform displays the Workflow Process—Edit window.
3. Enter the name of the workflow process that you want to find in the Process field.
4. Click Submit.
Civic Platform displays the Workflow Process browse page.
5. Click the red dot that appears next to the process you want under the Edit column.
6. To edit a task in the process:
a. update the fields for the task in the workflow process.
Note:
Click the yellow light bulb that appears to the left of the task if you want to use the Task Flow
Assistant to help you set up phase and next numbers.

For a description of the fields, see Table 77: Workflow Process Fields.
b. Click Update.
7. To add a new task to the process:
a. Click Add.
Civic Platform displays the Add Task page.
b. Enter the name of the task in the Task Name field.
c. Click Submit.
d. Civic Platform displays the new task at the top of the workflow process.
e. Complete the fields for each new task.
Note:
Click the yellow light bulb that appears to the left of the task if you want to use the Task Flow
Assistant to help you set up phase and next numbers.

For a description of fields, see Table 77: Workflow Process Fields.
f. Click Update.

| Part 3: Configuring Agency Business Objects | 405

Note:
When deleting a task, make sure you delete any references to that task you included in the phase
number or next number of another task.

8. To remove a task from the process:
a. Click Delete to the right of the task that you want.
b. Click OK.

Viewing a Process Diagram
Viewing a workflow process lets you see a visual representation of the process. Civic Platform outlines the
structure of the workflow process for you with a flowchart. Seeing a picture of a process gives you a better
understanding of how each task relates to other tasks. Viewing the process can also help you to catch any
errors in your setup. Refer to the example of a process diagram in Figure 25: Example Workflow Process
Diagram.

Figure 25: Example Workflow Process Diagram
Consecutive tasks appear one after the other. Parallels tasks appear on the same row and they share the
same parallel indicator. Blue arrows indicate branches in the process. Red arrows indicate loops.
To view a process diagram
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Workflow > Process.
Civic Platform displays the Workflow Process—Edit window.
3. Search for the workflow process you want to work with.
4. Do one of the following:
•

Click the red dot that appears to the right of the process name under the View column.

•

Click the red dot that appears in the Edit column next to the process that you want to view; then click
the Diagram View link that appears over the task details.

5. To maximize the view of the process, click Maximize. To restore the size of the window, click Restore.

| Part 3: Configuring Agency Business Objects | 406

6. When you finish viewing the process, click Cancel or close the view window.

Viewing Process Status
You can view the status of every task in a workflow process. The Process Statuses view, lets you see the
relationship between tasks and task statuses, and link to the Task Statuses—Edit window.
To view a workflow process
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Workflow > Process.
Civic Platform displays the Workflow Process—Edit window.
3. Search for the workflow process or task you want to work with.
Civic Platform displays the Workflow Process—Edit window or the Task Status—Edit window.
4. Click the Process Status View link that appears near the top of the window.
5. Click the plus sign that appears to the left of any task to view the statuses defined for that task.
6. Click the link to any task status to edit the status details.

Managing Workflow Hierarchy
A workflow hierarchy is an ordered collection of processes and sub processes. You can use a workflow
hierarchy to manage sophisticated workflows at your agency. In addition to tasks and sub tasks, you can
combine processes and establish sub processes.
Editing a workflow hierarchy involves adding and removing sub processes. A sub process is similar to a
sub task that lets you break down a workflow task into smaller tasks. Sub processes let you break down a
workflow hierarchy into smaller processes. For instructions on editing the tasks in the main process or in a
sub process, see Managing Workflow Processes.
Topics
•

Establishing a Workflow Hierarchy

•

Adding a Workflow Sub Process to a Workflow Hierarchy

•

Removing a Sub Process from a Workflow Hierarchy

Establishing a Workflow Hierarchy
Establishing a workflow hierarchy involves creating several workflow processes and then combining them
in a hierarchical organization. The benefit of establishing a workflow hierarchy is that you can create a
validated set of sub tasks that users must accomplish in a certain order.
When you establish your workflow hierarchy keep in mind that you can add only one sub process to each
task. For information about adding a sub process to the hierarchy, see Adding a Workflow Sub Process to
a Workflow Hierarchy.
To establish a workflow hierarchy
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Workflow > Workflow.
Civic Platform displays the Workflow—Search page.

| Part 3: Configuring Agency Business Objects | 407

3. Click Add.
Civic Platform displays the New Workflow window.

4. Complete these fields:
Workflow

Enter the name of the workflow hierarchy that you want to create.

Master Process

Select the name of the master workflow process to which the sub process belongs.

Inprocess Task Activation Select whether you want to allow in-process task activation for the workflow hierarchy.

5. Click Submit.
Civic Platform displays the Workflow—Edit window

A

Current mode of this workflow hierarchy

B

The master process folder that contains workflow tasks

C

Blue dot, which indicates a task without a sub process

D

Hierarchy command options

Adding a Workflow Sub Process to a Workflow Hierarchy
In a Civic Platform workflow, a sub process is a workflow process that you have already defined and which
you want to add to a task within another process.
Because you are associating an actual workflow process to a task in another workflow process, known
as the master process, you can enforce the tasks that make up the sub process. In other words, you can
determine which tasks a user must complete when, and you can require that the user complete them

| Part 3: Configuring Agency Business Objects | 408

before moving on to other tasks. You can also attach documents, checklists, and comments to these tasks,
just as for a master workflow process.
To add a sub process to a workflow hierarchy
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Workflow > Workflow.
3. Search for the workflow hierarchy you want.
4. Click a task within the master process folder.
Civic Platform displays the selected task in red.

5. Click Add Sub Process.
Civic Platform displays the search window for a workflow process.

6. Enter the name of the sub process that you want to add to the master flow. If you do not know the
complete name of the process, you can enter the first few characters of the name, or click Submit to
see a list of all defined processes.
7. Click Submit.
Civic Platform displays your search results.

8. Click Select to the right of the process that you want to add to your workflow hierarchy.
Civic Platform adds the sub process to the selected task in the master process folder.

A

The plus or minus symbol indicates a task with a sub process

| Part 3: Configuring Agency Business Objects | 409

B

The sub process folder with tasks within it

C

The sub process completion requirement option

9. If you want to require that users complete the new sub process as part of the master process, select
Yes; otherwise, select No.
10.Click Save.

Removing a Sub Process from a Workflow Hierarchy
To remove a sub process from a main process does not delete the process from your system, but does
delete it from the master process.
To remove a sub process from a workflow hierarchy
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Workflow > Workflow.
3. Search for the workflow hierarchy you want.
4. Click a task within the master process folder.
Civic Platform displays the selected task in red.

A

Selected task

B

Civic Platform enables the Remove Sub Process button only when you select a task with a sub
process.

5. Click Remove Sub Process.
6. Click OK.

| Part 3: Configuring Agency Business Objects | 410

Creating Task Statuses
This section describes the process of creating statuses that users can apply to any task in a workflow
process, from the task properties panel. Task statuses tell Civic Platform whether reaching the status
drives the workflow forward or backward, or keeps it the same. Based on the task status, users can choose
to activate the next task, loop back to a completed task, or branch forward to a future task. Users also have
the option to leave the current task active, by setting its status to “No Change.” All other options force the
active task to become inactive to activate another task in the workflow process.
Topics
•

Configuring Agency-defined Fields for Workflows

•

Tracking In-possession Time for a Record

•

Configuring Automatic Email Messages

•

Managing Automatically Printed Reports

To create a workflow task status
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Workflow > Task Status.
3. Click Add.
4. Complete the necessary fields as described in Table 78: Workflow Task Status Fields.
5. Click Save.
Table 78: Workflow Task Status Fields

Process Code

Select an existing workflow process. Civic Platform refreshes the window after
you choose a process code to display the corresponding task descriptions for the
process that you choose.

Task Status Code

Enter a unique code or an abbreviation for the task status.

Task Description

Select the task to which you want to add the status.
This field accommodates up to 100 characters.

Status Description

Enter a brief description that helps you identify the task status as you want it to
display to users.

Resulting Action

Select one of these options to determine the action when the task attains this
status: No ChangeChoose Next TaskChoose Branch TaskChoose Loop Task

Record Date

Enter the date Civic Platform last updated the task status record that you want to
find.

Recorder ID

Enter the user ID of the person responsible for last updating the task status record.

Application Status

Enter the value to update the application to. When Civic Platform updates the task
to the task status you are defining, it then updates the application to the status you
indicate in this field. If you leave this field blank, no update to the application status
occurs.

Parent Status

Enter the status of the parent task.

| Part 3: Configuring Agency Business Objects | 411

Citizen Access Displayable

If you want Citizen Access to display this task status, select Yes; otherwise,
select No. Note: The Citizen Access Displayable setting is on the task and task
status. Only when you set the ACA Displayable field to “Yes” on both the task
and task status, are you able to display the task status Citizen Access. For more
information about task setting, see Table 77: Workflow Process Fields.

Status

If you want to let users start choosing this status for workflow tasks, select Enable;
otherwise, select Disable.

Configuring Agency-defined Fields for Workflows
Task-specific information (TSI) are the agency-defined fields that are unique to workflow tasks. Users
complete these custom TSI fields when they update a workflow task.
Civic Platform workflows leverage TSI using the following organizational hierarchy:
•

Workflow tasks leverage TSI from TSI groups

•

TSI groups contain one or more TSI subgroups

•

TSI subgroups contain one or more TSI fields

Topics
•

Creating a Task-Specific Information Group

•

Editing a Task-Specific Information Group

•

Adding a Field to a Task-Specific Information Group

•

Editing a Field in a Task-Specific Information Group

•

Deleting a Field from a Task-Specific Information Group

•

Setting up Drop-down List Field Values

•

Applying Shared Drop-down Lists

Creating a Task-Specific Information Group
When you create a new Task-Specific Information group, you specify the group code and its name, as
well as the first field that you want to include in the group. You can set up other information about the field,
including the field type and a default value. You can set up additional fields, change the order of fields in
the group, and change any values when you edit the task-specific group.
When you create a Task-Specific Information Group, you must also specify the category that the group
belongs to. You can set up the first field so that it is searchable or required. You can also specify a default
value and a fee indicator.
For example, you can require data entry in the field, but only after the user is ready to move to the next
task. You can then set the Required Flag to No, the No Change to No, the Next Task to Yes, the Branch
to Yes, and the Loop to Yes. When a daily user enters a status that moves an item to the next task, Civic
Platform requires the user enter the Task-Specific Information before moving to the next task.
To add a task-specific information group
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Workflow > Task-Specific Info.

| Part 3: Configuring Agency Business Objects | 412

Civic Platform displays the Task-Specific Information—Search page.
3. Click Add.
Civic Platform displays the Task-Specific Info Group—Add window.

4. Update the fields that display. For a description of the fields, see Table 79: Task-Specific Information
Group Fields.
5. Click Submit.
Table 79: Task-Specific Information Group Fields

Task-Spec Info Group Code

Enter a unique code to identify the category that the Application Specific
Information group belongs to.

Task-Spec Info Group Name

Enter a name to identify the Specific Information group. There can be many
groups in one category. This name only applies when there is more than one
group in a category.

Group Display Order

Enter a number to determine the position of this information group on the
Application Specific Information page in Daily Activities. For example, if you want
this information group to appear second, enter 2.

1st Field Label

Enter the label for the first field you want to add to your Application Specific
Information group. For example, if you want to prompt users to specify a date,
enter “Date.”

Citizen Access Displayable

If you want Citizen Access to display this information, choose Yes; otherwise,
choose No.

Citizen Access Searchable

If you want users to be able to search for task-specific information, select Yes;
otherwise, select No.

Display Len

Specify the maximum number of characters that Civic Platform displays.

| Part 3: Configuring Agency Business Objects | 413

Display Order

Enter a number to determine the position of the first field in your Application
Specific Information group. For example, if you want the field to display before any
other fields, enter 1.

Default Value

If you want to provide a default value for the first field in your Application Specific
Information group, enter it here.
If you are setting up a drop-down list, you can add values to the drop-down list so
that a user has multiple values to choose from. For instructions, see Setting up
Drop-down List Field Values.

Fee Indicator

If you want to use the first field value in a fee calculation, enter the unique 5digit indicator, that you use to identify this application specific variable in the fee
formula. You must use a value between 10100 and 10599 and use the format:
$fixxxxx$For example, enter $fi10101$

Field Type

Choose the type of the first field in your Application Specific Information group.
You can choose from Text, Date, Y/N, Number, Drop-down List, Text Area,
Money, Time, and Check box field types. For more information on field types, see
Adding a Field to a Task-Specific Information Group.

Justification

If you want the field label to be right or left aligned, select the drop-down list to
select either Right Align or Left Align. Justification is useful when you are using a
language other than English that requires justification.

Max Len

Specify the maximum number of characters that the field accepts.

Required Flag

If you want to require the Task-Specific Information on all status actions including
a No Change, Next Task, Loop, and Branch, select Yes; if you want to make the
Task-Specific Information collection optional, select No.

Required with Task Statuses
Branch

If you set the Required Flag to No, but you want to make Task-Specific Information
required when a user selects a status that leads to a task branch, select Yes;
otherwise, select No.

Required with Task Statuses
Loop

If set the Required Flag to No, but you want to make Task-Specific Information
required when a user selects a status that leads to a task loop, select Yes;
otherwise, select No.

Required with Task Statuses
Next Task

If you set the Required Flag to No, but you want to make the Task-Specific
Information required when a user selects a status that leads to the next task,
select Yes; otherwise, select No.

Required with Task Statuses
No Change

If you set the Required Flag to No, but you want to require Task-Specific
Information when there is no change to the task status, select Yes; otherwise,
select No.

Supervisor Edit Only

If you want only a supervisor to be able to edit the group options, select Yes;
otherwise select No.

Searchable Flag

If you want to let users search for applications based on this field, click Yes;
otherwise, click No.

Status

If you want to let users see this field in Civic Platform, select Enabled; otherwise,
select Disabled.

Unit

If you want to attach a unit such as square feet, dollars, or miles to the first field
value, enter it here. You can choose from standard choices, or enter a new unit.

Editing a Task-Specific Information Group
After you create a Task-Specific Information group, you might need to change it. You can update any
fields that belong to the group by changing the field type or any other features about the field, including the
display order. You cannot change the field label, but you can add new fields to the group, and delete fields
that you no longer use.

| Part 3: Configuring Agency Business Objects | 414

To edit a task-specific information group
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Workflow > Task-Specific Info.
Civic Platform displays the Task-Specific Information page.
3. Complete these fields to search for the group that you want to edit:
Task-Specific Info Group
Code

Enter the group code associated with the Application Specific Information group you
want to search for.

Task-Specific Info Group
Name

Enter the name of the group you want to search for. There can be many groups in one
category. This name only applies when there is more than one group in a category.

4. Click Submit.
To see a list of all groups, click Submit without entering details about an individual group.
5. In the list of groups, click the red dot that appears next to the group that you want to edit.
6. Update the fields that display. For a description of the fields, see Table 79: Task-Specific Information
Group Fields.
7. Click Update.

Adding a Field to a Task-Specific Information Group
You can add any number of fields to a Task-Specific Information group. You can choose from any of the
eight basic types of agency-defined fields:
•

Number Field. Lets users enter only numeric characters in a number field. Number fields display the
word number to the right of the field.

•

Text Field. Lets users enter only text characters in a text field. Text fields display the word text to the
right of the field.

•

Text Area. Lets users enter multiple lines of text, such as a three line address.

•

Date Button. Lets users search for a date rather than entering a date manually.

•

Yes/No Radio Buttons. Lets users select one value by selecting Yes or No.

•

Drop-down List. Lets users choose a value from a list of predefined values determined by your agency.

•

Time. Lets users enter a time value.

•

Money. Lets users enter a dollar amount.

•

Check box. Lets users select a check box to select the option.

To add a field to a task-specific information group
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Workflow > Task-Specific Info.
3. Complete these fields to search for the group that you want:
Task-Specific Info Group
Code

Enter the unique code that identifies the category to which the Application Specific
Information group belongs.

| Part 3: Configuring Agency Business Objects | 415

Task-Specific Info Group
Name

Enter the name of the group for which you want to search.

4. Click Submit.
To see a list of all groups, click Submit without entering details about an individual group
Civic Platform displays the Task-Specific Info—Browse page.
5. Click the red dot that appears next to the group to which you want to add a field.
Civic Platform displays the Task-Specific Information page.
6. Click Add.
7. Complete the fields that display. For a description of the fields, see Table 79: Task-Specific Information
Group Fields.
8. Click Submit.

Editing a Field in a Task-Specific Information Group
After you create a Task-Specific Information group, you might need to change it. You can add or delete
fields; change the field type, display order, and the default value. You cannot however change the group
code, group name, or the field labels when you edit the group.
To edit a task-specific information group
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Workflow > Task-Specific Info.
3. Complete these fields to search for the group that you want to edit:
Task-Specific Info Group
Code

Enter the unique code that identifies the category to which the Application Specific
Information group belongs.

Task-Specific Info Group
Name

Enter the name of the group for which you want to search.

4. Click Submit.
To see a list of all groups, click Submit without entering details about an individual group.
Civic Platform displays the Task-Specific Info—Browse window.
5. Click the red dot that appears next to the group that you want.
6. Complete the fields that display. For a description of the fields, see Table 79: Task-Specific Information
Group Fields.
7. Click Update.

Deleting a Field from a Task-Specific Information Group
If you no longer need a field in your Task-Specific Information group, or if you want to change the field
label, you can delete the field.
To delete a field from a task-specific information group
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Workflow > Task-Specific Info.

| Part 3: Configuring Agency Business Objects | 416

3. Complete these fields to search for the group that you want.
Task-Specific Info Group
Code

Enter the unique code that identifies the category to which the Application Specific
Information group belongs.

Task-Specific Info Group
Name

Enter the name of the group for which you want to search.

To see a list of all groups, Click Submit without entering details about an individual group.
4. Click Submit.
5. In the list of groups, click the red dot that appears next to the group from which you want to delete a
field.
6. Click Delete next to the field that you want to delete.
7. Click OK.

Setting up Drop-down List Field Values
After you create a Task-Specific Information group, you can add fields to the group. If you add drop-down
list fields, you must then set up the values that you want to include as options in the list. You can set up the
values individually, or apply a shared drop-down list which has preconfigured values. For more information
on how to apply a shared drop-down list, refer to Applying Shared Drop-down Lists.
Users can choose values when completing an application. For example, if you are adding a field to enter
contact information, you can provide a drop-down list of contact types. Add, modify, or delete drop-down
values to create the desired list.
To set up values for a drop-down list
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Workflow > Task-Specific Info.
3. Complete these fields to search for the group that you want.
Task-Specific Info Group
Code

Enter the unique code that identifies the category to which the Application Specific
Information group belongs.

Task-Specific Info Group
Name

Enter the name of the group for which you want to search.

To see a list of all groups, click Submit without entering details about an individual group.
4. Click Submit.
5. In the list of groups, click the red dot that appears next to the group that you want.
6. Click Edit next to the drop-down field that you want.
Civic Platform displays a page where you can add, edit, or delete drop-down list values.
7. Do one of the following:
•

If you want to add a new value, click Add and enter the value in the Item Value field.

•

To update an existing value, replace the value text, and then Click Update.

•

If you want to delete a value, click Delete.

8. Click Close to return to the list of fields in your group.

| Part 3: Configuring Agency Business Objects | 417

Applying Shared Drop-down Lists
After you create a task-specific information group and add a drop-down field to it, you must add values
to populate the drop-down list. You can set up values individually or apply a drop-down list with preconfigured values, known as a shared drop-down list. This section provides instructions on how to apply
shared drop-down list values to a drop-down list.
For information on how to create a shared drop-down list, refer to the Customizing Menus, Tabs, and Dropdown Lists .
To apply a shared drop-down list
1. Locate the task-specific information group to which you want to apply a shared drop-down list. For
instructions, see Editing a Task-Specific Information Group.
2. Click the red dot next to the subgroup that contains the field for which you want to set drop‑down list
values.
Civic Platform displays the Task-Specific Info page.

3. Click Edit next to the drop-down list you want.
Civic Platform displays the Task-Specific Info Drop-down List—Add page.

4. Select the Use Shared Drop Down Lists option.
5. Do one of the following:
•

Click Search to return all shared drop down lists.

•

Enter the first letter of the drop-down list or any other search criteria, then click Search.
Civic Platform returns the Shared Drop Down List-Browse page.

| Part 3: Configuring Agency Business Objects | 418

6. Click Select next to the drop-down list you want to apply.
Note:
You can only select one shared drop-down list.

Civic Platform returns to the Task-Specific Info Drop-Down List-Add page with the Field Values from the
shared drop down list in blue underlined text.
7. Click Update.

Tracking In-possession Time for a Record
Topics:
•

Setting Up Time Tracking

•

Recording an Estimated Task Duration

•

Setting Up an Estimated Record Due Date

•

Setting a Time Tracker Clock

Setting Up Time Tracking
If you plan to set up time tracking for a record, make sure you configure the required security settings for
the record type:
•

Set the Record Access to Full “Access of application type” for the agency.

•

Set FID 0245 Long Term Time Tracking to Full Access security and apply it to the agency.

•

Set FID 8132 Workflow to Full Access security.

For instructions on configuring record type security, see Adding Record Type Security.
To set up time tracking for a record type
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Application > Application Type, and locate the Application Category—Edit window of the
record type you want to apply time tracking.
Civic Platform Application Category—Edit window displays.
3. Specify a value that indicates the number of days, in the Duration field, to process and complete the
application type.
Duration is the estimated Due Date for each application type. The Duration field records the time
tracking expectation. If this field has no values, the elapsed time does not display within other areas of
Civic Platform, such as the Workflow Task.
The estimated due date is dependent on record clock start date/time and the time tracking expectation
set for the record type.

| Part 3: Configuring Agency Business Objects | 419

Note:
You can link each task status to a Time Tracker clock action. To set this up, you must apply the record
type to a Workflow process. The Workflow process field is also on the Application Category page and
displays in the screenshot below.

4. Click Save.
The Application Category—Edit window stores the expected duration.
5. Set up the on-duty (start time) and off-duty (end time) using the Standard Choice
LONG_TERM_TIME_TRACKING.
Use this Standard Choice to set regular working hours for a typical work day. The Time Tracker function
uses this schedule when calculating In Possession time. The on-duty time sets the time work typically
begins; for example, 8 am. The off-duty time defines the time work typically ends; for example, 5 pm.
You must include the am and pm designations with the 12-hour clock hour in the Value Description
field.
You can only define one set of working hours per agency. You can specify working hours using either
12- or 24-hour clock values. However, work hours must use the same set of clock values for the Value
Descriptions.
Set up the LONG_TERM_TIME_TRACKING Standard Choice using these values, and specify the
appropriate value descriptions.
Standard Choice Values

Value Description

ON_DUTY_TIME

8:00 AM

OFF_DUTY_TIME

5:30 PM

| Part 3: Configuring Agency Business Objects | 420

6. To store the number of days that a task should typically take, Civic Platform uses this number of days
(Duration) along with a workflow calendar to compute the task completion date. To configure the task
status for time tracking, continue with the next set of steps, Setting a Time Tracker Clock.

Recording an Estimated Task Duration
Administrators can use Civic Platform to store the number of days that a task should typically take. Civic
Platform uses this number of days along with a workflow calendar to compute the task completion date.
Using the workflow calendar ensures that the computed due date does not include non-working days such
as weekends and holidays. Civic Platform computes the estimated due date and time of a task as the date
and time a task begins added to the duration of days multiplied by 8 (the number of working hours in a
day).
To record an expected task duration
1. Identify the Workflow process assigned to the record type that you want to track time.
2. Access the Classic Administration page (Accessing Classic Administration).
3. Choose Workflow > Process.
4. Locate the process you want to edit or click Add to create a new process.
Civic Platform displays the Workflow Process—Edit window.
5. Click the Process Status View link.
6. In the Duration (Days) field, enter the number of days you estimate each task should take.

7. Use the drop-down list in the Workflow Calendar field to choose the workflow calendar you want to
associate with the task.
8. Click Update to save the changes made to the Workflow process page.

Setting Up an Estimated Record Due Date
Civic Platform can calculate an estimated record due date based on data that you enter. Administrators
can use Civic Platform to store the number of days that a record type typically takes for the approval
process. When the In Possession Time Clock starts, Civic Platform calculates the estimated due date by
adding the number of duration days multiplied by 8 (the number of working hours in a day) to the field,
“Application Time Start Date.”

| Part 3: Configuring Agency Business Objects | 421

To set up an estimated application due date
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Application > Application Type.
3. Locate the application type you want to edit or click Add to create a new record type.
Civic Platform opens the Application Category-Edit window.
4. In the Duration (Days) field, enter the number of days you estimate the record should take.
5. Click Save.

Setting a Time Tracker Clock
You can link each task to a Time Tracker clock action. Administrators must set Time Tracker Clock Actions
to control how the Time Tracker records In Possession time for workflow tasks and workflow records. The
task involves searching and selecting the workflow process associated with the record type, and to then
configure the task’s Status for time tracking.
The Time Tracker Clock Action field provides four settings you can apply to a Task Description: No Action,
Start, Stop, and Close. Civic Platform triggers the timer when the status of a workflow task changes, starts,
stops, or closes the time tracking, and then calculates the total time accordingly.
For example, set the Task drop-down list to “Application Acceptance” and in the Status Description field
enter “Start of Time Tracking” and set the Time Tracker Clock Action drop-down list to Start.
You can specify other task descriptions, such as “Close” and in the Status Description field enter “End of
Time Tracking” and set the Time Tracker Clock Action for the last task as Stop.
To set a Time Tracker clock on a workflow task
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Workflow > Task Status.
Civic Platform displays the Task Status - Search page.

3. Enter the Task Status Code or the Process Code, using either the full name or a few initial characters of
the name.
This step requires knowing either the Task Status Code or the Process Code. This Process Code is the
code, or abbreviation, of the workflow process to which the task status belongs.
4. Click Submit.
5. Do one of the following:

| Part 3: Configuring Agency Business Objects | 422

•

Locate the Task Description for which you want to set up the time tracking clock, and then click the
red dot next to the Process Code.

•

Click Add to add a new Task Status and Task Description to the Task Status.

6. Set the Time Tracker Clock Action so that, when the task attains this status, one of the options listed
below happens:
No Action

If a task updates to a status that has the Time Tracker Clock set to “No Action” then
there is no effect on the Time Tracker clock.

Start

If a task updates to a status that has the Time Tracker Clock set to “Start” then Civic
Platform starts the time tracker clock for that current task, by using the current date
and time as the start time. This clock time contributes to In Possession time.

Stop

If a task updates to a status that has the Time Tracker Clock set to “Stop” then Civic
Platform halts the time tracker clock for that task. Stop does not reset the clock.

Close

If a task updates to a status that has the Time Tracker Clock set to “Close” then Civic
Platform closes the Time Track Clock record.

7. Click Save.

Configuring Automatic Email Messages
Topics
•

Adding an Email Message

•

Searching for an Email Message

•

Editing an Email Message

•

Establishing Email Settings

•

Specifying Email Settings in an EMSE Script

Adding an Email Message
In addition to establishing the email setting, you must compose the email message Civic Platform sends
based on the email setting. Civic Platform sends the message to a specified recipient when a workflow task
reaches a certain status, which you specify in the email setting.
To add an email message
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Workflow > Email Message.
3. Click Add.
4. Complete the necessary fields as described in Table 80: Email Message Fields.
5. Click Save.
Note:
As an alternative, you can create a new email message by copying an existing one.

| Part 3: Configuring Agency Business Objects | 423

Table 80: Email Message Fields

Contents Code

Enter a unique code, or an abbreviation, to identify the content of the email
message.

Message Type

Enter a unique name for the email message. The email setting references this
name, which determines when to send the message as well as the recipient.

Message Subject

Enter the text that you want to appear in the subject line of the email.

Message Content

Enter the full text message that you want to send to a recipient using email. You
can enter a message up to 2000 characters long.

Status

Select the current mode of the email message. You can enable the message at
this time, or disable it and enable it later.

Searching for an Email Message
To edit an email message, you must first search for the message on your system. You can search for an
email message based on the contents code or the message name—both of which are unique identifiers for
a certain email message.
Note:
To see a list of all messages, click Submit without entering details about an individual message.

To search for an email message
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Workflow > Email Message.
3. Complete the necessary fields as described in Table 80: Email Message Fields.
4. Click Submit.
Civic Platform displays the Email Message browse page.
5. Click the red dot that appears to the left of the email message that you want.

Editing an Email Message
After you compose an email message, you might need to edit the message content. In addition to editing
the content, you can change the message name, subject, and status.
To edit an email message
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Workflow > Email Message.
3. Search for the email message you want. For instructions, see Searching for an Email Message.
4. Click the red dot that appears in the Edit column next to the message that you want.
5. Complete the necessary fields as described in Table 80: Email Message Fields.
6. Click Save.

| Part 3: Configuring Agency Business Objects | 424

Establishing Email Settings
The email setting for each workflow process determines which email message you want to send when
Civic Platform updates the workflow process. For example, after a building review is complete, you can
notify the building supervisor.
Note:
Although you can set up multiple email messages for the same task status, Civic Platform only sends one
email message to a single recipient for each status update. Civic Platform recommends that you set up only
one recipient, one email address, and one message for each task status.

When you first add an email setting, you can specify the combination of a workflow process, task, and
status that generates an email message. You can also choose which email message you want to send
when this combination occurs. You can determine the recipient of the email message later when you edit
the email setting.
To specify email settings for a workflow task
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Workflow > Email Setting.
3. Search for the workflow process with the task to which you want to add an email setting.
4. Click Add.
Civic Platform displays the Email Setting Add page.
5. Complete the necessary fields as described in Table 81: Email Settings Fields.
6. Click Submit.
Table 81: Email Settings Fields

Task

Choose the workflow task. Civic Platform refreshes the window after you choose a
task to display the corresponding statuses for the task that you choose.

Notify Contact Relationship
Type

Choose the type of contact you are notifying from the drop-down list.

Notify Applicant?

If you want to notify the applicant, select the tasks for which you want to send
notifications.

Notify Next Recipient?

If you want to notify someone other than the applicant, choose this option and
enter the next two fields with information about this recipient.

Recipient First/Middle/Last

Enter the name of the recipient.

Email

Enter the email address of the recipient.

Status

Choose the status that you want.

Message Type

Choose the email message that you want to send.

Specifying Email Settings in an EMSE Script
You might have created EMSE scripts to update a workflow process. If you want to send an email
message after a workflow task update by EMSE, you must call the following method in the EMSE script:
Accela
Automation.workflow.sendEmailForWorkflowTaskUpdated(Task,emailFrom,emailTo,emailCC)
The method sets the email addresses from which and to which Civic Platform sends the notification. For
other email notification parameters such as Message Type, Civic Platform reads from the email setting for
the workflow process in Classic Administration. See Table 80: Email Message Fields.

| Part 3: Configuring Agency Business Objects | 425

Managing Automatically Printed Reports
Topics
•

Defining Automatically Printed Reports

•

Associating a Report with a Workflow Task Status

Defining Automatically Printed Reports
You can define the reports that automatically print with workflow task updates. You enter the report
configuration. If you need an example of the report configuration, you can see a template of that displays
how to configure your report.
To define automatically printed reports
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Report Management > Auto Report.
Civic Platform displays the Define Oracle and ARW Report page.

3. Select either Oracle or Accela Report Writer from the Report Type drop-down list.
4. If you want to create your report using the report template, click the Template link and Civic Platform
displays the template.
5. Configure your report in the Report field.
Please note that each report type within your agency must be unique.
6. When you finish configuring the report, click Save.
Civic Platform saves your report.

Associating a Report with a Workflow Task Status
You can create a report that automatically prints when the user changes a workflow task. After you create
and define the report, you can manage the report associations with workflow tasks.
To associate a report to a workflow status, you must add a workflow report setting. This setting identifies
which report to run when a user changes a workflow task.
To add a workflow report setting

| Part 3: Configuring Agency Business Objects | 426

1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Workflow > Report Setting.
Civic Platform displays the Report Setting Search page.

3. If you know the name of the workflow process you want to add a report setting to, enter the name of the
process. If you do not know, you can leave the field blank.
4. Click Submit.
Civic Platform displays the Report Setting Browse page.

5. Click the red dot by the process to which you want to add a report setting.
Civic Platform displays the Report Setting page.

6. Click Add.
Civic Platform displays the Report Setting Add page.

| Part 3: Configuring Agency Business Objects | 427

7. Update the fields as defined in Table 82: Workflow Report Setting Fields.
8. Click Submit.
Civic Platform adds your workflow report setting to the Report Setting page.
Table 82: Workflow Report Setting Fields

Task

Select the workflow task that you want to associate the report with. For example, if you
want to print a building permit at the end of the record acceptance process, you might
select Application Acceptance.

Status

Select the workflow task status that should trigger the report. For example, if you want
to print a building permit at the end of the application acceptance process, you might
select Complete.

Report Type

Select the report type for the report you want to print. The report might be an Oracle
report or an Accela Report Writer report.

Report

Select the report that should that you want to automatically run. For example, if you
want to print a building permit at the end of the record acceptance process, you might
select Building Permit.

Assignments, Skillsets, and Workloads
This section contains the following topics:
Related Information
Setting up an Automatic Assignment
Making Workflow Task Assignments

Setting up an Automatic Assignment
Topics
•

Setting up Workloads

•

Setting up Skillsets

Setting up Workloads
To use Civic Platform’s automatic assignment, you must weight the work performed to resolve certain
types of records. This configuration allows Civic Platform to match the work to the best skillset to perform
the tasks.

| Part 3: Configuring Agency Business Objects | 428

Topics
•

Creating a Workload

•

Editing a Workload

•

Deleting a Workload

Creating a Workload
This section describes how you create workloads that Civic Platform uses to determine which skillset to
assign the work to.
To create a workload object
1. Access the Workload portlet (Accessing the Workload Portlet).
2. Click New.
Civic Platform displays the workload details.
3. Complete the Workload fields that display. For a list of field descriptions, see Table 83: Workload Detail.
4. Click Submit.
Civic Platform creates the workload and adds it to the workload list.
Table 83: Workload Detail

Description

Enter a description of the workload.

Enabled

Select Yes to enable the workload or No to disable the workload. Civic Platform does
not assign disabled workloads to skillsets.

Literal Value

Enter a literal value to compare the object against. The value you enter must exactly
match the values your agency uses. For example, if your agency uses the date format
of MM/DD/YYYY, you must provide the literal date value of 11/16/2007 in this field.

Object

You can associate workloads with specific objects and object properties. Civic Platform
can then allocate the workloads to skillsets associated with these objects. To associate
the workload with an object, select the desired object. For example, a record. Civic
Platform populates the Property drop-down with the properties for the object you
selected.

Operator

Select an operator to compare the object against.

Property

Select a property for the object you selected in the Object drop-down.

Type

From the drop-down, select the type of workload you are creating.

Editing a Workload
This section describes how you edit workload objects.
To edit a workload object
1. Access the Workload portlet (Accessing the Workload Portlet).
2. Click the link in the Workload ID column for the workload you want to edit.
Civic Platform displays the workload details.
3. Update the Workload fields that display. For a list of field descriptions, see Table 83: Workload Detail.
4. Click Submit.
Civic Platform saves your changes and reflects the workload list to reflect them.

| Part 3: Configuring Agency Business Objects | 429

Deleting a Workload
This section describes how you delete workload objects.
To delete a workload object
1. Access the Workload portlet (Accessing the Workload Portlet).
2. Select the workload you want to delete.
3. Click Delete.
Civic Platform removes the workload from the workload list.

Setting up Skillsets
To use Civic Platform’s automatic assignment, you must set up the skillsets available at your agency.
Civic Platform can then assign appropriate workloads to the department or employee with the best skillset
necessary to perform the work.
Topics
•

Creating a Skillset

•

Editing a Skillset

•

Deleting a Skillset

Creating a Skillset
This section describes how you create skillset objects that Civic Platform uses when determining where to
assign workloads.
To create a skillset
1. Access the Skillset portlet (Accessing the Skillset Portlet).
2. Click New.
Civic Platform displays a blank form in the record detail area.

3. Complete the Skillset fields that display. For a list of field descriptions, see Table 84: Skillset Detail.
4. Click Submit.
Civic Platform saves the skillset and updates the skillset list.
Table 84: Skillset Detail

Category

Select the category from the drop-down list. SR Type is the only category currently
available.

Value

Click the Selection icon to select a value from the display.

Department

Select the department where you want to assign the skillset.

User ID

If you are creating a skillset for an individual user, use the drop-down to select the user
ID of the staff member that belongs to the department you selected.

| Part 3: Configuring Agency Business Objects | 430

Expertise

Select the level of expertise the person has in the skills. Civic Platform assigns the
skillset points for the skillset to workload ratio based on this selection. The possible
values are as follows: Novice = 1 pointIntermediate = 5 points Expert = 10 points.

Editing a Skillset
This section describes how to edit skillsets.
To edit a skillset
1. Access the Skillset portlet (Accessing the Skillset Portlet).
2. Click the link in the Category column for the skillset you want to edit.
Civic Platform displays the skillset details.
3. Update the Skillset fields that display. For a list of field descriptions, see Table 84: Skillset Detail.
4. Click Submit.
Civic Platform saves the skillset and updates the skillset list.

Deleting a Skillset
This section describes how to delete skillsets.
To delete a skillset
1. Access the Skillset portlet (Accessing the Skillset Portlet).
2. Select workload you want to delete.
3. Click Delete.
Civic Platform deletes the skillset and updates the skillset list.

Making Workflow Task Assignments
This section describes how to search for and assign workflow tasks.
To make a workflow task assignment
1. Access the Assign Task portlet (Accessing the Assign Task Portlet).
2. Select each task you want to assign or reassign. If you do not see the task you are looking for, Click
Search and complete the resulting fields. For a list of search field descriptions, see Table 85: Workflow
Task Search Fields.
Table 85: Workflow Task Search Fields

Alternate ID

If your agency uses Alternate IDs to display permit application numbers, enter the
alternate identification number for the permit application that contains the workflow task
you want to find.

Record ID

If your agency uses Record IDs to display permit application numbers, enter the record
identification number of the permit application that contains the workflow task you want
to find.

Date

Use the calendar icon to select the date range or exact creation date of the workflow
task. You set the default date range at the Super Agency level in the Workflow Assign
Task Date From Default Value field.

| Part 3: Configuring Agency Business Objects | 431

Department

Use the drop down list to choose the department responsible for the workflow task.

Staff

This drop-down list filters based on the selected department. Select the staff member
responsible for the workflow task from the drop down list.

Task

Enter the name of the workflow task, such as Application Acceptance or Water
Pollution Control.

3. Click Assign.
Civic Platform displays the assignment details.

4. Complete the Workflow Assign Task fields and click Submit. For a complete list of field descriptions,
see Table 86: Workflow Assign Task Fields.
Civic Platform confirms the task assignment.

| Part 3: Configuring Agency Business Objects | 432

Table 86: Workflow Assign Task Fields

Department

Use the drop down list to choose the department responsible for the workflow task.

Due Date

Use the calendar to choose the date by which the workflow task must be complete.

Staff

Use the drop-down menu to select the staff member responsible for the workflow task.
Click Current User to populate this field with the current user’s name.

Workflow Calendar

Use the drop down list to choose the workflow calendar the workflow task applies to.

Table 87: Task Detail Fields

Action By (Department)

The department that last updated the task status.

Action By (Staff)

The individual who last updated the task status.

Assigned Date

The date of the task assignment or the date of changes to the task assignment.

Assigned To
(Department)

The department currently responsible for completing the task.

Assigned To (Staff)

The individual currently responsible for completing the task.

Record ID

The record to which the task belongs.

Record Type

The type of record to which the task belongs.

Comments

Any comments about the current status.

Due Date

The expected completion date for the task. If you are searching for a task, you can click
the calendar icon located next to the From and To fields to specify a date range. Civic
Platform supplies these dates in the corresponding fields.

Duration (Days)

The estimated number of days necessary to complete this task. Your system
administrator determines this value when setting up the standard workflow process.

Parent Task

If the current task is a sub-task, this is a description of the parent task that the sub-task
belongs to.

Status

The current status of the task.

Status Date

The date when the task reached its current status.

Task

The name of the task.

| Part 3: Configuring Agency Business Objects | 433

Managing Activities
Topics
•

Adding an Activity to a Workflow Process

•

Editing a Workflow Process Activity

•

Deleting an Activity from a Workflow Process

Adding an Activity to a Workflow Process
When you add an activity, you must first indicate the process and task to which you are adding. Unlike
other pages in Civic Platform, you cannot search for an activity or a task or a process; you drill in. Then you
enter the activity name and description that you’re adding
To add an activity to a workflow process
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Review > Activity.
Civic Platform displays the Workflow Process List browse page. If Civic Platform displays the Task
List browse page for a process you do not want, click the “browse different workflow process” link that
appears to the right of the process code.
3. Click the red dot that appears next to the process that you want.
Civic Platform displays the Workflow Task List browse page.
4. Click the red dot that appears next to the task that you want.
Civic Platform displays the Task Activity List browse page.
5. Click Add.
6. Complete these fields:
Activity Code

Enter a code, or abbreviation, that identifies the activity.

Activity Description

Enter a brief description to explain what the task involves.

7. Click Submit.

Editing a Workflow Process Activity
After you add an activity to a workflow task, you can edit the activity code and its description. Any changes
you make to an activity (other than adding a new activity) do not affect existing applications. For example,
when you delete an activity it does not delete the sub-task from the application's workflow. Your changes
affect only new applications.
To edit an activity for a workflow process
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Review > Activity.
Civic Platform displays the Workflow Process List browse page. If Civic Platform displays the Task
List browse page for a process you do not want, click the “browse different workflow process” link that
appears to the right of the process code.

| Part 3: Configuring Agency Business Objects | 434

3. Click the red dot that appears next to the process that you want.
Civic Platform displays the Workflow Task List browse page.
4. Click the red dot that appears next to the task that you want
Civic Platform displays the Task Activity List browse page.
5. Click the red dot that appears next to the activity that you want.
6. Update these fields:
Activity Code

Enter a code, or abbreviation, that identifies the activity.

Activity Description

Enter a brief description to explain what the task involves.

7. Click Submit.

Deleting an Activity from a Workflow Process
After you add an activity, you can delete it, as needed. Deleting an activity does not delete the sub-task
from an existing application's workflow. Your changes affect only new applications.
To delete an activity from a workflow process
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Review > Activity.
Civic Platform displays the Workflow Process List browse page.
3. If Civic Platform displays the Task List browse page for a process you do not want, click the “browse
different workflow process” link that appears to the right of the process code.
4. Click the red dot that appears next to the process that you want.
Civic Platform displays the Workflow Task List browse page.
5. Click the red dot that appears next to the task that you want
Civic Platform displays the Task Activity List browse page.
6. Click Delete next to the activity that you want.
7. Click OK.

| Part 3: Configuring Agency Business Objects | 435

Using Expression Builder
Expression Builder provides an easy way to define expressions that perform calculations, provide
drop‑down lists, or auto-populate fields based on the value the user selects. Well-defined expressions help
reduce data entry work and minimize data entry errors.
Click a topic title below for full details.
Related Information
Supported Environments
Sample Use Cases
Creating Expressions
Searching for an Expression
Expression Builder Scenarios

Supported Environments
You can create an expression for either Civic Platform, or Citizen Access, or both. Civic Platform does not
support expressions for Authorized Service Customer and Authorized Service Customer Address. Citizen
Access supports expressions for ASI, ASI Table, Address, Authorized Service Customer, Authorized
Service Customer Address, Contact, Contact 1/2/3, Contact Address, Fee, Professionals, and Reference
Contact Address.
You can use Expression Builder with the following portlets.
•

ASI

•

ASI Table

•

Address

•

Applicant

•

Asset

•

Asset Condition Assessment

•

Authorized Service Customer

•

Authorized Service Customer Address

•

Condition

•

Condition of Approval

•

Contact, Contact 1/2/3

•

Contact Address

•

Fees

•

Parcel

•

Payment

| Part 3: Configuring Agency Business Objects | 436

•

Professional

•

Record Detail

•

Reference Address

•

Reference Condition

•

Reference Contact

•

Reference Parcel

•

Workflow

Sample Use Cases
Building expressions enables you to perform the following types of actions in Citizen Access:
•

Validate fields in licensed professional, ASI, and ASI table components

•

Populate fields that are not visible to public users

•

Gather the sum of field values

•

Update fields that meet the criteria of the expression

•

Populate sections in an online application, and then edit those sections in the review page

Expression Builder User Interface
You can create expressions in either wizard mode or script mode. For an illustration of the expression
creation portlet in script mode, see Figure 26: Expression Creation Portlet.

Figure 26: Expression Creation Portlet

| Part 3: Configuring Agency Business Objects | 437

A

Expression Name. Identifies the expression.

B

Target Scope (Target Portlet, ASI Group, etc). Specify what scope that the expression works in.

C

Execute Order. Specify the order to execute each expression.

D

Execute Expression In. Specify where the expression applies: Citizen Access, Civic Platform, or both.

E

Edit Mode. Specify whether you want to edit the expression in wizard mode or script mode.

F

Status. Specify the status of the expression, active or inactive.

G

Expression Area. If you select Script Mode, write the customized EMSE scripts for the desired expression in
the script entry area. If you select Wizard Mode, enter the expression criteria and the values, as the wizard
guides you through the process. S

H

Error Message. Display the error details if the EMSE scripts fail to pass validation.

I

Execute Fields. Pick one or more fields. When the user tabs or moves focus off of an Execute Field, the
expression executes.

J

Variables. Display available fields in the target scope. You can either select the field you want to populate with
the expression, or use some fields in the criteria. Variables store field information temporarily as a program
runs.

K

Operators. Use these basic mathematical symbols and date values in the expression. The “%” is the modulus,
it divides one operand by another and returns the remainder as its result.

L

Standard Choices. Lists all Civic Platform Standard Choices and their values. Include these values in the
Expressions area.

Topics
•

Creating Expressions

•

Searching for an Expression

•

Expression Builder Scenarios

Creating Expressions
You can create new expressions or modify existing expressions. Expression Builder provides a wizard for
building new expressions. You can also use scripts to build new expressions. Refer to the Accela Civic
Platform Scripting Guide. To learn about specific uses of Expression Builder and its effect on the Civic
Platform daily users, see the several scenarios introduced in Demonstrating Expressions with Scenarios.
Topics
•

Accessing the Expression Creation Portlet

•

Configuring the Expression

•

Building the Expression in Wizard Mode

Accessing the Expression Creation Portlet
You can access the expression creation portlet from the Administration Setup portlet.
To access the expression creation portlet in Expression Builder
1. Go to Administration > Application > Expression Builder.
2. Click New to create a new expression.

| Part 3: Configuring Agency Business Objects | 438

Civic Platform displays the Expression Builder tool.

Configuring the Expression
Before you start to build the expression, configure the expression basics including the expression name,
the target scope, and how to execute the expression.
To configure the expression
1. Enter an Expression Name to describe the purpose of the expression, up to 60 characters including
spaces.
2. Specify the Target Portlet where users access the expression.
3. Specify the Custom Fields Group, Custom List subgroup, or the template attributes associated with
the target portlet, which contain the fields you want use in your expression.
For the types of fields that you can specify with a target portlet, see Associated Field Types for
Expression Creation in Target Portlet.
You can hover over Custom Fields Group to see a list of record types relevant to the group.
4. Define the order in the Execute Order field to trigger the expressions that work on the same field.
5. From the Execute Expression In area, choose what type of user you want to expose the expression
to:
ACA Only

Both registered users and anonymous Citizen Access users can access the
expression.

Civic Platform only

Only Civic Platform users can access the expression.

Both

Exposes the expression to both Citizen Access and Civic Platform users.
Note:
Citizen Access supports expressions for fields from Custom Fields, Custom Lists, Contacts (including
generic template fields, template table fields, and people template fields), Fees, and Licensed
Professionals.

6. Select an Edit Mode. The Edit Mode determines whether you edit the expression by wizard or EMSE
script.

| Part 3: Configuring Agency Business Objects | 439

The Wizard Mode displays the Expressions and Criteria wizard to assist you in building the
expressions. See Building the Expression in Wizard Mode.
The Script Mode displays the Expression script text area in which you can edit the EMSE script
manually. See the Accela Civic Platform Scripting Guide.
You can switch back and forth between modes, as appropriate.
7. Select the Status of the expression. All expressions are active by default. If you set the status of an
expression to inactive, the expression does not execute when the expression criteria are met.
8. Click the Execute Fields picker and select one or more fields. When the user tabs or moves focus off
of an Execute Field, the expression executes.
a. Click the (+) sign to expand the list of items.
The fields within each portlet, the associated fields, and Additional Options for onLoad and onSubmit
display.

b. Click an item to add it to the Execute Fields list.
The selected Custom Fields Group activates and filters the Custom Lists Subgroup drop‑down list.
The Additional Options list provides the possible events that can trigger the expression:
•

onLoad executes the expression when you create a new record that meets the expression criteria.
The onLoad event occurs immediately when a page loads. For example, default the status to
Accepted when a user creates a new Building Record Type.

•

onSubmit executes the expression upon saving a record. The onSubmit event occurs when the
user clicks Submit on the form. For example, if the user changes the status to Accepted by entering
“A” in the appropriate field.

•

onPopulate executes the expression when data in the selected field populates based on a search
result. It is available when Professional, Contact Address, or Reference Contact Address is the
selected target portlet. For example, the following actions can trigger the expression: when the
user searches for and selects a Licensed Professional in an application, or when the user clicks the
Validate button in the contact address form and selects an address to add in the form.
The following Standard Choices must be have the indicated configurations in order for the
onPopulate option to be available for the Professional portlet:

•

NEW_SPEAR_FORM_ENABLE

Enabled

MULTIPLE_LICENSE_PROFESSIONAL

Disabled

MULTIPLE_APO_GIS_SELECTION

Disabled

onASITRowSubmit.This event is available only when Custom Lists is the target portlet, and only
works in Citizen Access. When a public user submits a new or updated Custom List table row
in Citizen Access, if the criteria of an onASITRowSubmit expression are all met, Citizen Access
triggers the expression. If you define an onASITRowSubmit expression which sets the blockSubmit

| Part 3: Configuring Agency Business Objects | 440

property of the Custom List table form to true under certain criteria, Citizen Access can block the
submission of Custom List table rows when the criteria are met.
Table 88: Associated Field Types for Expression Creation in Target Portlet

Target Portlet

Associated Field Types

Executable in
Civic Platform?

Executable in
Citizen Access?

Custom Fields

Custom Fields Group

Y

Y

Custom Lists

Custom Fields Group and Custom List
Subgroup

Y

Y

Address

Custom Fields Group

Y

Y

Applicant

Custom Fields Group, Contact Type,
Contact Template, and Template Table if
any associated with the selected contact
template

Y

N

Asset

Attribute Template, and Attribute Table if
any associated with the selected attribute
template

Y

N

Asset Condition
Assessment

Condition Assessment

Y

N

Authorized Service
Customer

-

N

Y

Authorized Service
Customer Address

-

N

Y

Condition

Custom Fields Group, Template Form, and Y
Template Table if any associated with the
selected template form

N

Condition of Approval

Custom Fields Group, Template Form, and Y
Template Table if any associated with the
selected template form

N

Contact (and Contact
1, 2, 3)

Custom Fields Group, Contact Type,
Contact Template, and Template Table if
any associated with the selected contact
template

Y

Y

Contact Address

Custom Fields Group

Y

Y

Fees

Custom Fields Group

Y

Y

Parcel

Custom Fields Group

Y

N

Payment

Custom Fields Group

Y

N

Professional

Custom Fields Group

Y

Y

Record Detail

Custom Fields Group

Y

N

Reference Address

-

Y

N

Reference Condition

Condition Entity, Template Form, and
Template Table if any associated with the
selected template form

Y

N

Reference Contact

Contact Type, Contact Template, and
Template Table if any associated with the
selected contact template

Y

Y

| Part 3: Configuring Agency Business Objects | 441

Target Portlet

Associated Field Types

Executable in
Civic Platform?

Executable in
Citizen Access?

Reference Contact
Address

-

Y

Y

Reference Parcel

-

Y

N

Workflow

Custom Fields Group, Workflow, Process,
Task Specific Info

Y

N

Building the Expression in Wizard Mode
If you select Wizard Mode to build the expression, you can fill the field names, corresponding expressions,
and criteria values in the Expressions and Criteria areas of the wizard.
To build the expression in wizard mode
1. Use the Expressions area to define the field in the expression, and define the way the expression
works on the field.

Note:
If you specify Custom List as the target portlet for the expression, or select a Custom List Subgroup or
attribute table in the target scope, you can only build the expression for the selected table. For a detailed
use-case of this feature, see Adding a Row in an Asset Attribute Table.

a. Select the field on which the expression affects. You can only select a target portlet field.
b. Expand the plus sign next to the target portlet in the Variables navigation tree to locate a variable.
The variables navigation tree displays the available fields for your selection.

c. Click the variable. The variable populates in the Field Name.
You can select “FORM” to execute the expression on the whole target portlet. You can also select a
field to change the property of the field.
d. Specify a Property type for the field. The Property field identifies the type of expression. For
example, if you set the field to read-only, the Property becomes read-only.
Value

Assigns the value in the Calculate Expression field to the field.

| Part 3: Configuring Agency Business Objects | 442

Required

Sets the field to required. The Calculate Expression field defaults to True, but you
can change it to False.

Read-only

Sets the field to read-only. The Calculate Expression field defaults to True, but
you can change it to False.

Message

If you add “FORM” in the Field Name, displays a message in the target portlet. If
you add a field in the Field Name, displays a message next to the field.

blockSubmit

If you add “FORM” in the Field Name, this property is available for blocking the
submission of the target portlet.

Note:
There is a limitation with contact expressions in Citizen Access. If you are using a contact expression
to display a message on the contact form, the “Execute Fields” box of the expression must contain
the “onSubmit” option for the message to display when users submit the form. Otherwise, the
message cannot display.

e. Click the Calculate Expression field and then, as required for the expression, navigate to the
Variables, Operators, or Standard Choices navigation trees to locate the field, operator, or value to
add to the expression.
The Variables navigation tree includes Session Variables which are the frequently used runtime
variables that are standard with Civic Platform. Session variables are available in the WHERE
clause of a statement. Session variables display between sets of double dollar signs, for example,
[$$capID1$$]
. See Session Variables.
Use the Operators navigation tree to calculate the expression.
Math operators

Lists mathematical symbols [+], [-]. [*], [/] for operation. The “%” is the
modulus, it divides one operand by another and returns the remainder as
its result.

String operators

Joins two strings.

Custom Fields Table-lookup()
Function

Populates fields in the expression with columns from Custom Fields
lookup tables.

Aggregate Function

Aggregates multiple values from the Custom Fields table, fees, the
condition template table, or the asset attribute table.

fireEMSE Function

Fires an EMSE script.

addDate(Date, int) Function

Returns the date appended with a certain date interval.

diffDate(Date, Date)

Returns the interval between two dates.

f. The Standard Choices navigation tree lists each Standard Choice available in Civic Platform along
with its values that you can use in calculating the expression. The navigation tree lists both enabled
and disabled Standard Choices. For example, if you want to create an action based on when the
Status is Completed, locate the Standard Choice “STATUSCOMPLETED” and use its value in your
expression.
g. To add more expression lines click Add Expression Line in the Expressions area.
To remove an expression line, select it, and then click Delete Criteria Line.
2. Use the Criteria area to define the expression criteria.

| Part 3: Configuring Agency Business Objects | 443

a. Click Add Criteria Line in the Criteria area to add criteria lines.
b. Click the Field Name. Civic Platform uses the Field Name in the criteria for the expression.
c. Locate a variable in the Variables navigation tree and then click it. The variable populates in the
Field Name.
d. Select a logical operator from the Operator drop-down list to identify the criteria for the expression.
e. Specify the Value for the criteria. You can set this to a static field value, a value from the Custom
Fields lookup table, a Standard Choice value, or a session variable.
See Creating Custom Fields for information on Custom Fields lookup tables.
You can use Standard Choice values here as static values.
To look up a Session Variable and its value, click the Value field in the Criteria section, navigate to
the Session Variables navigation tree, and then click the value you want. The variable populates in
the Value field for the Criteria.
f. The Prefix is the starting parenthesis in a criteria line (also called “condition”). For Example:
(Due Date <= $$TODAY$$ AND
Status = Approved) OR (Est Date > $$TODAY$$)
Both embedded conditions and parallel conditions work in the criteria. You can type one or more “(“
characters as the prefix, or leave it blank.
Embedded condition: (...(…)…)
Parallel condition: (..)…(..)
g. The Suffix is the end parenthesis in a criteria line (also called “condition”). For Example:
(Due Date <= $$TODAY$$ AND
Status = Approved) OR (Est Date > $$TODAY$$)
You can type one or more “)” characters as the prefix, or leave it blank.
h. Select AND/OR options to connect multiple criteria lines.
3. Click Validate to review the expression for errors.
The Validate button verifies that the syntax is correct. The Validate button does not test field data types
or the fields used in the expression.
4. Click Submit to save the new expression in wizard mode.
Table 89: Session Variables

Variable

Name

Description

$$ID$$

ID1

Retrieves the record ID from a specific portlet.

$$ID$$

ID2

Retrieves a second record ID from a specific portlet.

$$capID1$$

CAPID1

Retrieves the first 5 characters of the record
ID from a specific portlet. Example: CAPID1 =
01BLD-00000-00018

| Part 3: Configuring Agency Business Objects | 444

Variable

Name

Description

$$capID2$$

CAPID2

Retrieves the second 5 characters of the record
ID from a specific portlet. Example: CAPID2 =
01BLD-00000-00018

$$capID3$$

CAPID3

Retrieves the last 5 characters of the record
ID from a specific portlet. Example: CAPID3 =
01BLD-00000-00018

$$department$$

Department

Retrieves the department of the current user.

$$firstName$$, $$lastName$$,
$$middleName$$

First Name

Obtains first, last, middle name.

Last Name
Middle Name

$$gaUserID$$

GA User ID

Retrieves the ID of the current user.

$$module$$

Module

Retrieves the module from a specific portlet.

$$portletID$$

Portlet ID

Retrieves information on a portlet, such as a field
name.

$$publicuser_email$$

The public user email id
used in ACA.

Retrieves the public user email.

$$servProvCode$$

Service Provider Code

Retrieves the ID for the agency.

$$today$$

Today

Retrieves today’s date. The workstation's system
date determines this date. You can use this variable
parameter in calculations to specify a date range.
For example, enter $Today$ -7 to query for all
records over the last week.

$$userfullname$$

User Full Name

Retrieves the user’s full name.

$$userGroup$$

User Group

Retrieves the group of the logged-in user.

$$userID$$

User ID

Retrieves the ID of the logged-in user.

Searching for an Expression
You can search for any existing expression.
To search for an expression
1. Access the Expression Builder portlet (Accessing the Expression Builder Portlet).
2. Click Search.
Civic Platform displays the expression search portlet.
3. Enter search criteria and then click Submit.

| Part 3: Configuring Agency Business Objects | 445

Expression Builder Scenarios
To learn about specific uses of Expression Builder and its effect on the Civic Platform daily user, review the
scenarios in this section. The scenarios include screen shots that depict both the configuration details for
the administrator who creates the expression, and the user’s experience when accessing the fields.
Topics
•

Populating a Field When Creating a Record Type

•

Adding a Row in an Asset Attribute Table

•

Populating Fields in Custom Fields Section

Populating a Field When Creating a Record Type
This scenario explains how to create the expression criteria that automatically set the Status to
“Processing” when a user creates a specific record type. The expression uses the “onLoad” function for the
record type of Building/Plan Review/Zoning Analysis and identifies the Target Portlet of Record Detail.
To build the expression criteria, refer to the steps in How to create the execute fields for onLoad function
for a new record.
To see the effect of this expression from a user experience, refer to Where the Status field populates as
“Processing” for the user.
For an overview of the user interface and its elements, see Figure 26: Expression Creation Portlet.

Where the Status field populates as “Processing” for the user
1. User creates a new record type of Building/Plan Review/Zoning Analysis/Zoning Analysis.
Civic Platform displays the application type picker.

Civic Platform loads the new application type and the status automatically updates to “Processing.”

| Part 3: Configuring Agency Business Objects | 446

How to create the execute fields for onLoad function for a new record
1. Create a New expression and navigate to the Expression Name field.
Civic Platform displays the New Expression fields where you define the criteria.

2. Enter an Expression Name. This scenario uses New Record Status.
3. Select Record Detail from the Target Portlet drop-down list to specify that the expression takes effect
in the Record detail area.

| Part 3: Configuring Agency Business Objects | 447

4. Select BLDG in the Custom Fields Group for this step. Expressions require the Target Portlet and the
respective Custom Fields Group and Custom Lists Subgroup when creating or editing an expression.
5. Hover over the Custom Fields Group field, to display the associated Record type for the selected
Custom Fields Group, for informational purposes.

6. Optionally, use the Execute Order field to define the order you want Civic Platform to process the
expression.
7. Click the Execute Fields picker.
Civic Platform displays the Execute Fields list.

8. Expand Additional Options and click the onLoad function.
Civic Platform loads the onLoad function in the Execute Fields list.
9. In the Expressions area, do the following:
a. Single-click the Field Name to activate it.

| Part 3: Configuring Agency Business Objects | 448

b. Open the Variables list, and expand Record Detail.
c. From the Fields list click the Status field.
The Expressions Field Name populates with the record type and the record Status functions.

10.Click the Calculate Expression field to activate it.
11.In the Calculate Expression field, surround the new status for this record type in double quotes and then
enter this phrase exactly: “Processing”
The “Processing” word is the default value displaying in the Status field when a user creates a new
record type for Building/Building Permit/Residential/New.

Adding a Row in an Asset Attribute Table
This scenario explains how to create the expression that automatically adds a row into an asset attribute
table when a user saves an asset.
To build the expression criteria, refer to the steps in Adding a new attribute table row.
To see the effect of this expression from a user experience, refer to Where to add a new row.
For an overview of the user interface and its elements, see Figure 26: Expression Creation Portlet.

| Part 3: Configuring Agency Business Objects | 449

Where to add a new row
Where to add a new row in the attribute table of an asset
1. User creates a new asset with the asset group as HVAC, and the asset type as Boiler. The asset type
belongs to an asset template Mechanical - Boiler that links to the attribute table Attribute Table_1.

2. The asset saves successfully with a new row automatically added in the attribute table.

Adding a new attribute table row
How to add a new row for the attribute table fields of an asset
1. Create a New expression and navigate to the Expression Name field.
Civic Platform displays the New Expression fields where you define the criteria.
2. Enter an Expression Name. This scenario uses AddRowToTable.
3. Select Asset from the Target Portlet drop-down list, select Mechanical - Boiler from the Attribute
Template drop-down list, and Attribute Table_1 from the Attribute Table drop-down list. The attribute
table drop-down list shows all the attribute tables that associate with the selected attribute template.

| Part 3: Configuring Agency Business Objects | 450

4. Click the Execute Fields list picker to select
Civic Platform displays the Execute Fields list.

5. Expand Additional Options and click the onSubmit function.
Civic Platform loads the onSubmit function in the Execute Fields list.
6. Select Insert Table Row in the Expressions area.

7. Assign values to the attribute table fields in the expression.
a. Single-click the Field Name in the Expressions area to activate it.
b. In the Variables list, expand the Fields under Attribute Table.

c. Click the Acres field.
The Expressions Field Name populates with the field name.

| Part 3: Configuring Agency Business Objects | 451

8. Set the Property in the Expressions area as “value,” and enter the numeric value in the Calculate
Expression field: 220.
9. Click Add Expression Line to add more lines.
10.Select another field from the Variables list, and set its value.
11.Repeat step 10 until you assign values to all the necessary fields in the attribute table.
12.Click Submit to save the expression.

Populating Fields in Custom Fields Section
This section explains how to create the expression criteria that populates read-only fields in the Custom
Fields Section of a record type, based on selections made. This expression uses columns and data from a
Custom Fields Lookup Table named ZA-1. This expression’s name is Zoning Lookup, because it populates
the appropriate references, based on the zones the user selects.
With Expression Builder, you can use the record type of Building/Plan Review/Zoning Analysis, and then
identify the Target Portlet of a Custom Field, which is where the user accesses the fields. To build the
expression criteria, refer to the steps in How to prepare a Custom Fields lookup table for creating the
expression.
To see the effect of this expression from a user experience perspective, refer to How a user completes
Custom Fields that populate messages.
For an overview of the user interface and its elements, see Figure 26: Expression Creation Portlet.

How a user completes Custom Fields that populate messages
1. User creates a record type of Building/Plan Review/Zoning Analysis/Zoning Analysis.
2. Locate the Custom Fields section of the application. An alternate location to modify this information
might be in the Zoning Analysis portlet for the record type.
Civic Platform displays the Custom Fields in the Zoning Analysis section of the record.

3. Enter the value
110
into the Total Area (in square feet) of the Eligible Front Porch Area field.

| Part 3: Configuring Agency Business Objects | 452

4. Select
R4
from the Zone drop-down list.
Civic Platform populates the values for the Principal Frontage, Permit Use, and Front Porch Deduction
fields.

How to prepare a Custom Fields lookup table for creating the expression
This scenario uses data from an existing table called Custom Fields Lookup Table called ZA-1.
The ZA-1 table contains the regulation data for zoning that populates when a user completes the Custom
Fields section as they create a new record type of Building/Plan Review/Zoning Analysis/Zoning Analysis.
Reviewing this table now makes it easier to follow the scenario. Refer to Figure 27: Custom Fields Lookup
Table Structure to see the structure, columns, and data in the ZA-1 table.

Figure 27: Custom Fields Lookup Table Structure

Figure 28: Custom Fields Lookup Table Data

| Part 3: Configuring Agency Business Objects | 453

How to create expression criteria for this Custom Fields target portlet scenario
1. Create a New expression and navigate to the Expression Name field.
Civic Platform displays a new expression fields where you define the criteria.

2. Enter an Expression Name. This scenario uses
BA-Zoning Lookup
.
3. Select Record Detail in the Target Portlet drop down list.
4. In the Custom Fields Group field, select the group that contains the record type and the fields you
want to place an expression in. This scenario uses Custom Fields Group ZA-2, because it requires the
record type
Building/Plan Review/Zoning Analysis/Zoning Analysis
.

5. For these sub-steps, add each of the fields affected within the Target Portlet into the Execute Fields list.
The Execute Fields are the fields where users enter data and Civic Platform populates fields with readonly information based on the user’s selections. This scenario affects these four fields:
ASI::PRINCIPAL USE AND STRUCTURE::Permit Use
ASI::PRINCIPAL USE AND STRUCTURE::Principal Frontage
ASI::ZONING ANALYSIS::Front Porch Deduction
ASI::ZONING ANALYSIS::Zone
a. Click the Execute Fields picker and expand Custom Fields to locate and double-click
ASI::PRINCIPAL USE AND STRUCTURE::Permit Use.

| Part 3: Configuring Agency Business Objects | 454

ASI::PRINCIPAL USE AND STRUCTURE::Permit Use. The Permit Use field populates with data
based on what the user selects from the Zone drop-down list. In this scenario, when the user selects
R4 the Permit Use field populates with specific data from the ZA-1 Custom Fields Lookup Table.
Civic Platform populates the field name Permit Use into the Execute Field list.

b. Locate the other fields for this expression with the Execute Fields picker. Double-click each field
label to add it to the Execute Field list.
ASI::PRINCIPAL USE AND STRUCTURE::Principal Frontage. The Principal Frontage field
populates with data based on what the user selects from the Zone drop-down list. In this scenario,
when the user selects R4 the Principal Frontage field populates with specific data from the ZA-1
Custom Fields Lookup Table.
ASI::ZONING ANALYSIS::Front Porch Deduction. This field populates with data based on the user
who enters the Total Eligible Square Feet Area. See the screenshot below.
ASI::ZONING ANALYSIS::Zone. This field provides the Zone drop-down items that affect what data
populates in the Principal Frontage, Permit Use, and Front Porch Deduction fields.

6. Scroll to the Expressions area. The Expressions area is where you define the lookup criteria for each
Execute Field that calculate or trigger an expression.

7. For each field that calculates an expression, click Add Expression Line to add the field name to the
Field Name field list.

| Part 3: Configuring Agency Business Objects | 455

8. Click the Lookup Criteria search button to locate the table name and the column. Define the lookup
criteria for each Calculated Expression field for this scenario, click Lookup Custom Fields Table.
Civic Platform displays the Lookup Criteria form.

When defining expressions, you can use Custom Fields Lookup Tables. You can add an item to a
Custom List using an expression. You can populate a field with data from the Custom List.
The benefit when using table data is that it eliminates data entry errors that might occur if the permit
intake clerk has to manually open a separate document to locate the correct data and then type it into
specific fields.
a. To define the table and identify which columns to populate the data for the ASI::PRINCIPAL USE
AND STRUCTURE::Principal Frontage field, follow these two sub-steps:
Define the Lookup Table Name for the Principal Frontage field. Choose the Custom Fields Lookup
Table Name ZA?1 for this scenario.
Set the Return Column for Principal Frontage. The Return Column is a column in ZA-1 that
contains the values that should populate data based on the values the permit intake clerk selects.
The Custom Fields Lookup Table columns for the selected Lookup Table display in the drop-down. If
a user selects a column from the Variables list portlet, it defaults into this field.
b. Use the Field Name drop-down list and select the field for Principal Frontage.
c. Set the Operator to equal (=).
d. Click the Value field and then use the Variables to locate and add ASI::PRINCIPAL USE AND
STRUCTURE::Principal Frontage.
e. Click OK on the Lookup Criteria page.
f. Repeat the steps to provide a value for the Front Porch Deduction field with the correct references
and correct value.
9. Click Submit in the Lookup Criteria form to save the expression.
Expression Builder saves the expression criteria.

| Part 3: Configuring Agency Business Objects | 456

| Part 3: Configuring Agency Business Objects | 457

Setting Up Conditions
There are two kinds of conditions: conditions of approval and general conditions. The two classes
share the same logic but you use them for different purposes. Use conditions of approval to define a
list of requirements that citizens must meet to receive the approval for a permit or an inspection. Use a
general condition to indicate a problem on the record, inspection, address, contact, or another application
component. Generally, the condition severity is Lock, Hold, Notice, or Required. Administrators can
manage conditions of approval and general conditions separately through the Conditions Maintenance
portlet. For example, you can create a standard condition of approval for users to apply to a record and you
can define the status options for conditions of approval.
All conditions and condition types support using template fields that you create using application-specific
information (ASI) and application-specific information table (ASI Table) groups. To define an ASI and ASI
Table Groups for a condition template, see the section, Creating a Condition Template.
Administrators establish security policies for condition types, and then set permissions in the Conditions
Administration portlet. You configure the policies in the Security Policies Administration portlet as explained
in Setting Up Security Policies in Setting Up Security Policies. To manage permissions and privileges, use
the Conditions Administration portlet as explained in Assigning Conditions.
Click a topic title below for full details.
Related Information
Managing Condition Groups and Conditions
Establishing Condition Types
Creating a Condition Template
Applying Condition Audit Logs
Assigning Conditions
Maintaining Condition Statuses
Configuring Reference Conditions

Managing Condition Groups and Conditions
When a user applies a condition to a component, the user must supply the condition name and then
choose from a list of pre-defined condition groups, condition types, and statuses that you have set up.
All conditions and condition types support using template fields similar to application-specific information
(ASI) and application-specific information table (ASI Table) fields. For a more detailed explanation, see
Creating a Condition Template.
Topics
•

Adding a Condition Group and Adding a New Condition

•

Searching for a Condition

•

Viewing and Editing a Condition

•

Copying a Condition

| Part 3: Configuring Agency Business Objects | 458

Adding a Condition Group and Adding a New Condition
When users apply conditions to an component, they can choose from a pre-defined list of groups. You can
create as many condition groups necessary. A condition group helps you organize condition types. When
you create a condition group, you can add other condition types and conditions to it.
To add a condition group and create a new condition
1. Access the Conditions Maintenance portlet (Navigating to the Setup Portlet).
2. Click to highlight any of the Condition By categories in the navigation tree. For example, click the
Condition By Type category.

3. Right-click the tree category in the navigation tree. For example, right-click the Condition By Type.
Civic Platform opens the new pop-up window.

4. Click New Group.
Civic Platform opens the New Condition Group pop-up window.

5. Enter the new name for the condition group you need to add and click OK.
Civic Platform adds the new condition group to the Condition By Group tree view list.
6. To add one or more condition types to this group, take the following steps:
a. Right-click the group in the tree view, and click Assign Types.
Civic Platform displays the Select Condition Types form in a pop-up window.

| Part 3: Configuring Agency Business Objects | 459

b. Click the check boxes for the condition types you want to assign, and click OK.
Civic Platform adds the selected condition types to the condition group.
For instructions on how to add a condition type, see Adding a Condition Type.
7. To create a new condition, do one of the following:
•

Click New in the Conditions Maintenance portlet.

•

Right-click the group in the tree view, and click New Condition.
Civic Platform displays the New Condition form in a pop-up window.

8. Complete the Condition Name field.
Condition Name is the name or number for the standard condition.
When a user accesses an application and applies a condition, this is the Condition Name they select.
This field accommodates up to 255 characters.
9. Specify the Condition Group, and then select the Condition Type from the drop-down list.

| Part 3: Configuring Agency Business Objects | 460

The Condition Type drop-down list contains the condition types you assigned to the condition group in .
If the condition type you selected associates with a template, the New Condition form refreshes and
adds the template fields below the system-defined condition fields.
10.Complete the remaining fields in the New Condition form.
For an explanation of system-defined condition fields, see Table 90: New Condition Field Descriptions
and Actions.
For further details on the spelling checker, including how to configure it, see Configuring Standard
Comments. Note that the spelling checker cannot add new words to the dictionary.
11.Click Submit.
Civic Platform saves the completed Condition Group and applies the new condition.
Table 90: New Condition Field Descriptions and Actions

Additional Information

Use this unlimited text field if the body of your comment text exceeds the character
limitations of the Short Comments and Long Comments fields. This unlimited text field
supports the insertion of standard comments via the Standard Comments picker. It also
supports HTML formatting so that text pasted into the field from another source retains
its formatting.
Note:
This field is not searchable. However, the ability to perform tag-based
searches based on key words entered into ASI fields is available. Your agency
can configure the Conditions portlet to include ASI fields for users to enter
important ‘searchable’ words from the Additional Info field.

Condition Group

Select the Condition by Group name for the condition name or condition number you
are creating.
The condition group is an attribute of a condition that helps you organize condition
types.
This field accommodates up to 255 characters.

Condition Name

Condition Name is the name or number for the standard condition name.
When a user accesses an application and applies a condition, this is the Condition
Name they select.
This field accommodates up to 255 characters.

Condition Type

Select the Condition By Type name for the condition name or condition number you
are creating. The condition type is an attribute of a condition that helps you organize
individual conditions. For example, you can create a “Planning” condition type for all
conditions that apply only to components in the planning review stage.
You can associate a template with a condition type, and assign users and user group
permissions to a condition type. For more information about condition types, see
Establishing Condition Types.

Display Notice

Select the options to display the notice in Civic Platform, Citizen Access, or the Citizen
Access Fee Estimate Page when they apply a condition to a record or parcel. When a
user accesses a record, the condition notice displays in the condition status bar. If you
do not select an option, the condition notice does not display. However, the condition is
applied regardless.

Include In Condition
Notice

Select from the options provided to expose the content of the selected fields to agency
users and public users. For example, if you select Short Description, Civic Platform
exposes the Short Comments text.

| Part 3: Configuring Agency Business Objects | 461

Inheritable

Inheritable is a required field. No is the default setting. If this you set this to Yes, when
you associate a child record with a parent record, Civic Platform checks for inheritable
conditions. If found, the inheritable conditions copy to the child record with the Status
of “Applied.” If the parent record condition status updates (Status of “Not Applied”) then
the child record condition status does not update.
If you set this to No Civic Platform does not copy conditions to the child record upon
creating it from a parent record.

Long Comments (4000
char max)

Use this text field if the body of your condition comments exceeds the character
limitations of the Short Comments field, but does not exceed the 4000 character
limitation for this field. The contents of this field are searchable. This field supports the
insertion of standard comments via the Standard Comments picker.

Public Display Message

This field relates only to IVR and Citizen Access.
If you enter text into this field, the result in IVR and Citizen Access is:
a) The text displays in the condition notice or condition status bar for the Condition
Name for the public user.
b) The Condition Name and Short Description do not display for the public user.
If you do not enter text into this field, the result in IVR and Citizen Access is:
a) The Condition Name and/or Short Description displays in the public user Condition
Notice.
b) If Condition Name and Short Description are de-selected, the Condition detail does
not display in the Condition Notice for a public user.

Resolution Action

Enter the actions or set of tasks the user should follow to resolve the condition severity
level so the user can move the application forward.

Short Comments (2000
char max)

Use this text field if the body of your condition comment does not exceed the 2000
character limitation for this field. The contents of this field are searchable. This field
supports the insertion of standard comments via the Standard Comments picker. To
expose the contents of this field to agency and public users, select Short Comments
for the Include in Condition Notice field.

Severity

Choose a level of severity for the condition from the following:
Lock: Prevents almost any operation, except operations that result in removal of the
lock.
Hold: Restricts the addition of an activity and editing of components.
Notice: Includes special instructions to the person completing the application. It does
not impede record processing.
Required: Indicates that a user must complete a specified activity or field before
proceeding to the next step in a workflow.
Note:
The Standard Choice REMOVE_REQUIRED_IN_ADMIN_CONDITIONS
determines whether the Required severity option hides or displays.

Status

Choose either Enabled or Disabled mode for the condition type. Enabled means that
you can apply the Condition Name to the assigned Application Types when a user
creates a new application.
If you disable a condition type, it prevents users from choosing that type when applying
new conditions, it does not disable existing conditions of that type. The Condition Name
is still available in the conditions list for the administrator to Enable at a later date.

| Part 3: Configuring Agency Business Objects | 462

Template

Apply a template to a condition. All template fields and template tables display at the
bottom of the Condition details form. All conditions support the use of template fields
which you configure through application-specific information (ASI) and applicationspecific information table (ASI Table) fields. For instructions on how to create a
condition template, see Creating a Condition Template.
Note:
If the condition type you select has a template, and then you select a different
template in this field, the template you select in this field applies to the
condition, and Civic Platform ignores the template associated with the
condition type.

Searching for a Condition
When you want to edit an existing condition, you first need to search for it. You can also search for a
condition group to view the group details without necessarily editing it. To see a list of all condition groups,
click Condition By Group. All condition groups display in the Condition Administration navigation tree.
To see a list of all condition, click Condition By Name/Number. All conditions and their group information
display in the Condition Administration navigation tree.
To search for a specific Condition
1. Access the Conditions Maintenance portlet (Navigating to the Setup Portlet).
2. Highlight Condition By Group or Condition By Name/Number in the Administration portlet.
3. Click Search in the Condition Administration portlet.
4. Complete any other fields to narrow your search results. For full details of the available fields refer to
Table 90: New Condition Field Descriptions and Actions.
5. Click Submit.
Civic Platform displays all the available condition groups or conditions that meet your search criteria in
Condition Administration.
6. Click the Condition Name of the condition type that you want to modify.
The Condition Name details display in the Condition tab.
7. Make the changes and click Save.

Viewing and Editing a Condition
You can view and edit the details of a condition.
To edit a condition
1. Search for the condition you want to edit (Searching for a Condition).
2. Click the Condition Name that you want to modify.
The condition details display in the Condition tab.
3. Update the necessary fields that display.
For an explanation of system-defined condition fields, see Table 90: New Condition Field Descriptions
and Actions.
4. Click Save.
Civic Platform saves the changes for the condition.

| Part 3: Configuring Agency Business Objects | 463

Copying a Condition
Copy a condition to create a new, duplicate condition in the same condition group. When you copy a
condition, you create a new condition with the same details, including the condition group setting, as
the source condition. You can specify whether to copy the condition assignment options and permission
options.
To copy a condition
1. Search for the condition you want to copy (Searching for a Condition).
2. In the Condition tab, click the Menu button and choose Copy Condition from the drop-down list.
Civic Platform displays the Copy Condition portlet.

3. Complete this field:
Condition Name

Enter a unique name to identify the new condition.

4. Choose the assignment options and permission options (Application Type, Workflow, etc.) you want to
copy from the source condition to the new condition. For more information, see Assigning Conditions).
5. Click Submit.
Civic Platform displays the new condition in the Condition Detail portlet.

Establishing Condition Types
When a user applies a condition to a component, they must provide the condition group and condition type
that the condition belongs to. You must set up the condition groups and condition types in advance, and
associate one or more condition types with each condition group.
Topics
•

Adding a Condition Type

•

Searching for a Condition Type

•

Editing a Condition Type

•

Defining Condition Type Permissions

Adding a Condition Type
You can create as many condition types as necessary. A condition type is an attribute or grouping that
helps you organize individual conditions. After you create condition types, you must associate them with
proper condition groups, so the condition types can display as options in the Condition Type drop-down list
after users select a condition group when creating conditions.

| Part 3: Configuring Agency Business Objects | 464

To add a condition type
1. Access the Conditions Maintenance portlet (Accessing the Conditions Maintenance Portlet).
2. Highlight Condition By Type in the Administration portlet and right-click and select New Type.
3. Enter the new name for the condition type and then click OK.
Civic Platform adds the new condition type to the top of the Condition By Type navigation tree.
4. Optionally, specify the Template type. This applies only if the condition type supports template fields.
You can create a template field using the application-specific information (ASI) and application-specific
information table (ASI Table) fields. For an overview on how to create a condition template, see the
topics in the section, Creating a Condition Template.
5. Click Submit.
Civic Platform saves the condition type.

Searching for a Condition Type
When you want to edit an existing condition type, you first need to search for it. You can also search for a
condition type to view the type details without necessarily editing it.
To see a list of all condition types, click Condition By Type. All condition types display in the Condition
Administration navigation tree.
To search for a condition type
1. Access the Conditions Maintenance portlet (Navigating to the Setup Portlet).
2. Highlight Condition By Type in the Administration portlet.
3. Click Search.
4. Enter the name of the condition type that you want to search for, select the condition template and then
click Submit.
Civic Platform returns a list of condition types that match your search criteria.

Editing a Condition Type
You can edit the details about a condition type.
To edit a condition type
1. Access the Conditions Maintenance portlet (Accessing the Conditions Maintenance Portlet).
2. Locate and select the condition type under the Condition by Type tree node.
You can also search for the condition type and then edit the details. See Searching for a Condition
Type.
Civic Platform displays the condition type details in the Condition Type tab.
3. Select another template for the condition type and then click Save.
Civic Platform saves your changes.

Defining Condition Type Permissions
You can control which user group or user can access standard conditions of a specific condition type by
defining permissions for the condition type. The permissions set for a standard condition always override
the permissions set for the condition type to which it belongs. User level permissions override user-group

| Part 3: Configuring Agency Business Objects | 465

level permissions. For more information about setting permissions for a standard condition, see Assigning
Conditions.
To define condition type permissions
1. Access the Conditions Maintenance portlet (Accessing the Conditions Maintenance Portlet).
2. Locate and select the condition type under the Condition by Type tree node.
You can also search for the condition type and open it. See Searching for a Condition Type.
Civic Platform displays the condition type details in the Condition Type tab.
3. Click the Permissions tab.
Civic Platform displays the Permissions tab on the Condition Type detail portlet.
4. Click Assign.
Civic Platform displays the Assign drop-down menu.
5. Select Assign Group or Assign User.
6. Navigate through the tree view to select the desired user group or user.
7. Click Submit.
Civic Platform lists the user group or user on the Permissions tab and assigns the user group or user
full access permission by default.
8. Use the drop-down next to the user group or user to assign Full Access, Read Only, or No Access.
9. Click Submit.
Civic Platform saves your changes to the permissions of the selected user group or user.

Creating a Condition Template
The condition templates are in fact Custom Fields groups. The options in the Template field of a condition
or a condition type are the Custom Fields that you have configured in your Civic Platform implementation.
The steps to prepare condition templates are the same as preparing Custom Fields groups for records.
This section describes the key tasks you must perform.
Topics
•

Defining Custom Fields Group Data for Conditions

•

Setting Condition Template Permissions

•

Designing a Layout for the Condition Details Portlet

Defining Custom Fields Group Data for Conditions
When you create a template for a condition, you configure the Custom Fields group first. The Custom
Fields group name displays in the Template field when creating a condition or a condition type.
Note:
The template that you specify for a condition overrides the template, if any, that you associated with the
condition type of the condition.

| Part 3: Configuring Agency Business Objects | 466

To define a Custom Fields subgroup in a Custom Lists group for a condition template, asee Creating
Custom Fields.

Setting Condition Template Permissions
Either Custom Fields security settings or a customized Custom Fields form layout can block a user or user
group from viewing certain Custom Fields and Custom Lists on a condition template.
The permissions set for a standard condition always override the permissions set for the condition type
to which it belongs. User level permissions override user-group level permissions. If a user has Custom
Fields security or Custom Fields form layout permission at the same time, the strictest access setting
applies.
There are various methods to control user and group access to condition template fields.
You can assign permissions based on the user login to restrict access to Custom Fields and Custom Lists
data. See Setting Up Security Policies.
Note:
If you do not have access permission to a Custom Fields group, the Custom Fields group can still display as
a condition template option. However, when you select the Custom Fields group as the condition template,
the template field does not display.

You can set the condition template field permissions in the Custom Fields Form Layout Editor and apply
security at the module, group, and user level. See Designing Application Intake Forms.
You can set access within the Condition portlet and layout the design of condition templates. Follow the
see the steps in Designing a Layout for the Condition Details Portlet.

Designing a Layout for the Condition Details Portlet
You can choose which fields you want to show in the Condition Details portlet, and you can customize
those fields. You can add a label for the field, specify its width, apply a mask, and indicate sort order and
display order. You can also specify how many items to display in an expanded and contracted list.
You must separately design the layout of system-defined condition fields and then design the layout of the
condition template fields (Custom Fields and Custom Lists).
•

To design the layout of system-defined condition fields, use the edit view feature in the Condition
Details portlet. See Designing Forms for Portlets.

•

To design the layout of the condition template fields (Custom Fields and Custom Lists), you can create
Custom Fields screens for Custom Fields groups. See Designing Application Intake Forms.
If you defined one or more Custom Fields screens for a Custom Fields group, and you select the
Custom Fields group as the condition template, all the fields and tables in the Custom Fields group
display below the system-defined condition fields, with the layout you designed in the Custom Fields
screens.
If you did not define a Custom Fields screen for a Custom Fields group, or you do not have permissions
for the Custom Fields screen for the Custom Fields group, after you select the Custom Fields group as
the condition template, all the fields and tables in the Custom Fields group display below the systemdefined condition fields, with the default layout.

Applying Condition Audit Logs
As an administrator, you can choose to enable the condition audit log functionality in Civic Platform. You
can also grant yourself and agency users permission to access the condition audit log.

| Part 3: Configuring Agency Business Objects | 467

Viewing and Filtering Condition Audit Logs
Administrators with access to the audit log can review condition the audit log from the condition list portlet
and condition detail portlet. See Figure 29: Condition Audit Logs in Condition List and Detail Portlet.
For instructions on how to access the audit log, see “Viewing Condition Audit Logs” in the Accela Civic
Platform User Guide.

Figure 29: Condition Audit Logs in Condition List and Detail Portlet
To view or filter the condition audit logs
1. Access the Conditions Maintenance portlet (Accessing the Conditions Maintenance Portlet).
2. Click any of the Condition By categories in the navigation tree. For example, click the Condition By
Group category.
Civic Platform displays the conditions in the condition list portlet.
3. Complete one of these options:
•

To view audit logs for multiple conditions, click View Log at the top of the condition list portlet.

•

To view audit logs for one condition, click the desired condition from the condition list and then click
View Log at the top of the condition detail portlet.
Civic Platform displays the Audit Log for the condition.

| Part 3: Configuring Agency Business Objects | 468

4. To narrow down the audit log results, enter one or more filter criteria from the filter criteria fields. See
Table 91: Log Detail Filters and Options.
5. Click Filter.
Table 91: Log Detail Filters and Options

Audit Subtype

Sub types of the Condition audit type. The audit subtypes include Condition Template
Form, Condition Template Table, and Record Condition.

Audit Type

The audit type is Standard Condition.

Condition Group

The condition groups for any one of the conditions.

Condition Name

The name of the condition an administrator created or modified.

Condition Type

The condition types for any one of the conditions.

Entity ID

The identification number of a condition.

Field

The field which had its value modified by an administrator.

Log Action

The action completed, such as Delete. You cannot remove this detail from the log.

Log Time

The date and time of the activity. For example, the date and time an administrator
updated a condition. You cannot remove this detail from the log.

Operator

The user who competed the action. Here it is the Accela administrator.

Product

The product an administrator was using when they made the modification listed in the
log.

Relationship

Displays the source objects associated with the modified field. For example, for
a condition template field, it displays Condition Group, Condition Type, Condition
Template Subgroup, and Condition Name.

Value

The value of the modified field upon completion of the action.

Assigning Conditions
This section contains details about the administrative strategy to assign conditions for all of these areas.
However, the steps to set up and apply conditions to a record type, user group, user, inspection group
or inspection type, or workflow process are very similar. For complete details of permission options, see
Figure 30: Assign Options in Condition by Group.

| Part 3: Configuring Agency Business Objects | 469

Figure 30: Assign Options in Condition by Group
The steps for all of these groups or areas are the steps under this step heading Assigning a Condition to
a Workflow Process. First, you must create the condition, then locate the application type for which you
want to provide a standard condition. Select the condition(s) from a list and save them to that application
type. When a user accesses a record they might see the standard condition message. They can click the
condition link to view or modify the details for that condition as it applies to that record.
Topics
•

Assigning Conditions to a Record Type

•

Assigning a Condition to a User Group

•

Assigning a Condition to an Inspection Group

•

Assigning a Condition to a Workflow Process

Assigning Conditions to a Record Type
You can assign conditions to a record type. When a user creates a new record, the conditions you assign
to the selected Record Type copy to the new application and the Condition Status becomes “Applied.”
For full details refer to: To assign conditions to a record type, user group, inspection group, or workflow.
The conditions assigned to the record type copy over regardless of the user group permissions. The user
group security only determines if the condition displays in the list portlet and if the user can edit or just view
the condition details. This happens after a user clicks Submit on a New Application.
For example, when applying for a building permit for a new development a drainage study must occur prior
to the approval of the permit. This is a standard condition you apply to the Building Permit application.
You can create a standard condition and name it D01 Drainage Study and associate it with the Building/
Building Permit/Drainage/Grading record Type. When the user creates a new application with the Building/
Building Permit/Drainage/Grading record type, the D01 Drainage Study condition copies over to the New
Application record.

Assigning a Condition to a User Group
You can also assign a specific set of conditions to a user group, such as the Building department, whose
users have access to only those conditions that are appropriate for their department’s functions.
For full details refer to: To assign conditions to a record type, user group, inspection group, or workflow.

Assigning a Condition to an Inspection Group
Much like assigning a condition to a record type, you can also assign a set of unique conditions to a
specific inspection group or inspection type. The conditions assigned to the Inspection Type or Group
automatically copy over regardless of the user group permissions.

| Part 3: Configuring Agency Business Objects | 470

Inspectors for each inspection type automatically have a list of conditions available as they process their
inspections. While the inspector follows the inspection flow process (an outline of all the inspections that a
user group must complete between the time that an application is submitted until its issuance) they have
the appropriate access to process any conditions for their inspections.
For full details refer to: To assign conditions to a record type, user group, inspection group, or workflow.

Assigning a Condition to a Workflow Process
Workflow process validation is another aspect of conditions where you can extend the conditions that
currently exist for an application to inhibit the workflow process related to that application. Process
validation lets you determine the validity of the workflow process based on the condition of the application
it belongs to. When an application becomes locked, the workflow process becomes invalid and cannot go
forward.
For full details refer to: To assign conditions to a record type, user group, inspection group, or workflow.
Depending on the status of certain tasks within the workflow, you set up Civic Platform to check the current
condition of the application and inhibit the workflow accordingly. For example, you can lock the workflow
process in the event that an occupancy certificate becomes denied and the application becomes locked.
Note:
If you want to change the workflow process or require that individual tasks reach a certain status, you can
make these changes when you set up the workflow.

You can add process validations, or checkpoints, where you want Civic Platform to check the current
condition of the application and expand those conditions to control the workflow process. For example,
after the workflow reaches the Final phase, you can check to see if the application became locked, on hold,
or has any notices associated with it. You can then determine if you need to stop or adjust the workflow
process.
After you add a process validation, you might need to change the task or task status that you originally
chose to base the validation on. You can also change the application conditions that you want the
validation to check.

To assign conditions to a record type, user group, inspection group, or workflow
1. Access the Conditions Maintenance portlet (Accessing the Conditions Maintenance Portlet).
2. Use the main Administration navigation tree to locate the condition you need. You can locate a
condition by Group, Condition Type, Name/Number, Application Type, Inspection, User Group,
or User. If you cannot locate the condition name you want to apply, you can search for it. Refer to
Assigning Conditions.
•

Highlight the condition you want to apply. Note the following tips:
Click the plus sign (+) that appears to the left of the name to expand a list.
To include all the names within a list, select that name. To include only one name in the list, select
only that name and not the entire list

3. Select the Condition Name in the Condition Administration list.

| Part 3: Configuring Agency Business Objects | 471

4. Click Assign.
Civic Platform displays the Condition Administration, which lists conditions

5. Complete one of these options:
•

To assign the condition to a record type, click Assign and choose Assign Record Type.
Civic Platform displays the a navigation tree of the Record Types within your agency
1. Highlight the Record Types to which you want to apply a condition. Note the following tips:
2. Click the plus sign (+) that appears to the left of the name to expand a list.
To include all the names within a list, select that name.
To include only one Record Type in the list, select only that Record Type alias and not the entire
list.

3. Click Submit.
Civic Platform saves and adds the condition to the Record Type you selected.
4. If you need to further modify the Condition you applied to the Record Type refer to Searching for
a Condition to use the Condition detail portlet.

| Part 3: Configuring Agency Business Objects | 472

•

To assign the condition to a User Group, which might be a department, click Assign and choose
Assign User Group.
Civic Platform displays a User Group navigation tree of the user groups within your agency.
1. Highlight the User Group to which you want to apply a condition. Note the following tips:
Click the plus sign (+) that appears to the left of the name to expand a list.
To include all the names within a list, select that name.
To include only one User Group name in the list, select only that User Group name and not the
entire list.

2. Click Submit.
Civic Platform saves and adds the condition to the User Group you selected previously.
3. If you need to further modify the Condition you applied to the User Group, refer to Searching for a
Condition to use the Condition detail portlet.
•

To assign the condition to an Inspection Group or Inspection Type, click Assign and choose Assign
Inspection.
Civic Platform displays the Inspection Group/Type navigation tree of the inspection types within your
agency.
1. To include only one Inspection Type name in the list, select only that Inspection name and not
the entire list.

| Part 3: Configuring Agency Business Objects | 473

2. Click Submit.
Civic Platform saves and adds the condition to the Inspection Group/Type you selected
previously.
3. If you need to further modify the Condition you applied to the Inspection Group/Type, refer to
Searching for a Condition to use the Condition detail portlet.
•

To assign the condition to a Workflow process, click Assign and choose Assign Workflow.
Civic Platform displays the a navigation tree of the Workflow Process/Task/Status within your
agency.
1. Highlight the Workflow Process or Workflow Task to which you want to apply a condition. Note
the following tips:
2. Click the plus sign (+) that appears to the left of the name to expand a list.
To include all the names within a list, select that name.
To include only one Workflow Process/Task in the list, select only that Workflow name and not
the entire list.

3. Click Submit.
Civic Platform saves and adds the condition to the Workflow Process you selected previously

| Part 3: Configuring Agency Business Objects | 474

4. If you need to further modify the Condition you applied to the Workflow Process/Status/Type refer
to Searching for a Condition to use the Condition detail portlet.

Maintaining Condition Statuses
You can manage the status options for general conditions and conditions of approval separately.
Topics
•

Adding a Condition Status

•

Editing and Deleting a Condition Status

Adding a Condition Status
You can set up custom condition statuses for conditions of approval to outline the condition phases. For
example, for any conditions that become obsolete, you can set up an “expired” phase. Users can choose to
apply any of these custom statuses when a user applies a general condition to a component.
To add a condition status
1. Access the Conditions Maintenance portlet (Navigating to the Setup Portlet).
2. Click Status Maintenance from the Condition navigation tree and then click Conditions of Approval
or General Conditions.
Civic Platform displays the Status Maintenance portlet for conditions of approval.

3. Click New.
Civic Platform adds a new row to the Status Maintenance table.

| Part 3: Configuring Agency Business Objects | 475

4. Complete the following fields.
Status

Enter a descriptive name for the status.

Status Type

Select the Status Type from the drop-down list.Applied indicates that general
conditions are applied to the record, inspection, address, parcel, owner, licensed
professional, structure, establishment, asset, or contact. Or it indicates that conditions
of approval are applied to the record, inspection, or record set. For example, if
the Address has the condition severity level of Hold then the Address retains this
condition until it meets or resolves the condition.Not Applied removes the conditions
restrictions on the record, inspection, or the component. For example, if the Parcel
condition meets or resolves the severity level of Notice then the Parcel can continue
with normal processing.
Note:
Status Type is not configurable in Classic Administration. If you create a
status in Classic Administration or via EMSE without defining its status type,
Civic Platform automatically assigns an “Applied” status type to the Applied
status named, and a “Not Applied” status type to other statuses.
If you configure the Standard Choice
ENABLE_CONDITION_RESOLVED_DATE, when users save Applied
conditions (including conditions of approval), users save them without a
status date. Status date is only saved when a condition (or condition of
approval) is met.

Display Order

Enter the numeric value for the display order of the field as it displays to users as a
condition status drop-down list. If you do not indicate a display order, it defaults to
alphabetical order.

Record Status

Select Enabled or Disabled from the drop-down list. Enabled turns on the status item,
making it available for users to select in the condition status drop-down list.

5. Click Submit.

Editing and Deleting a Condition Status
After you add a condition status, you might need to change the status name or description. You can also
enable any status that has a “disabled” status or vice versa. To delete a condition status, select the status
name and click Delete.
To edit a condition status
1. Access the Conditions Maintenance portlet (Navigating to the Setup Portlet).

| Part 3: Configuring Agency Business Objects | 476

2. Click Status Maintenance from the Condition navigation tree and then click Conditions of Approval
or General Conditions.
Civic Platform displays the Status Maintenance portlet for conditions of approval.

3. Do any of the following:
•

To edit a condition status, edit the fields as necessary and click Submit.

•

To delete a condition status, select the status name and click Delete.

Configuring Reference Conditions
Configuring How Reference Conditions are Updated
Civic Platform organizes conditions in groups called Condition Types. You can configure the behavior of
how Civic Platform updates reference conditions in the Reference Condition portlet.
Configure how to update the reference conditions as applicable to your agency. You can configure Civic
Platform to update all associated records when you sign off on a reference condition for any record with or
without a prompt. You can configure to update the reference condition by signing it off at the record level
without impacting the main parcel condition or any other associated records.
Any time you unlock or override a reference condition status from the record condition notice portlet or
Condition tab, Civic Platform records this action. This results in correct behavior for each record.
To assign a condition type with update reference condition behavior
1. Access the Conditions Maintenance portlet (Accessing the Conditions Maintenance Portlet).
2. Select Reference Conditions from the Condition navigational tree.
Civic Platform displays the Reference Conditions portlet.

| Part 3: Configuring Agency Business Objects | 477

3. Click New.
4. Complete the following fields.
Condition Type

Select the Condition Type from the drop-down list.

Update Reference
Conditions for all
Records.

Select an option from the drop-down list.
Yes - No Prompt If you update a reference condition on a record, it affects all
associated records with that reference condition without a prompt.
No - If you update a reference condition on a record, Civic Platform overrides the
reference on the individual record only. This does not affect the other records with the
reference condition.
Yes - Prompt - When selected, Civic Platform displays, “Would you like to update
Reference Conditions for all Records?” If you choose Yes, Civic Platform updates the
main reference condition and all of its related records.

Record Status

Select to enable or disable the feature from the drop-down list.

5. Click Submit.
6. To delete a Condition Type, select the Condition Type and click Delete.

| Part 3: Configuring Agency Business Objects | 478

Configuring Record-Related Activities
You can create and manage activities that are unique to your agency. When you configure activities as
described in this section, users can assign activities, such as a follow-up inspections or phone-calls, to
other agency staff members.
Click a topic title below for full details.
Related Information
Working with Activity-Specific Information Group Codes
Working with Activity-Specific Information Subgroups
Working with Activity Types

Working with Activity-Specific Information Group Codes
Topics
•

Creating or Editing an Activity-Specific Information Group Code

•

Searching for an Activity-Specific Information Group Code

•

Deleting an Activity-Specific Information Group Code

Creating or Editing an Activity-Specific Information Group Code
Before Civic Platform users can work with activity-specific information, administrators need to create group
codes for the information. Each activity-specific information group code can include many activity-specific
information subgroups. Administrators can also edit activity-specific information group codes, as needed.
You can identify fields as any of the following basic types:
•

Number Field. Lets users enter only numeric characters in a number field. A number field displays the
word “number” to the right of the field.

•

Text Field. Lets users enter only text characters in a text field. A text field displays the word “text” to the
right of the field.

•

Text Area. Lets users enter multiple lines of text, such as a three-line address.

•

Date Button. Lets users search for a date rather than entering a date manually.

•

Yes/No Radio Buttons. Lets users select either a Yes or No value.

•

Drop-down List. Lets users choose a value from a list of predefined values determined by your agency.

•

Time. Lets users enter a time value.

•

Money. Lets users enter a dollar amount.

•

Check box. Lets users click to select the option.

Creating a group code is the first step in the process for working with activity-specific information.
To create or edit an activity-specific information group code

| Part 3: Configuring Agency Business Objects | 479

1. Access the Activity Specific Info portlet (Accessing the Activity Specific Info Portlet).
2. Do one of the following:
•

Click the activity-specific information group code you want to view.

•

Search for the activity-specific information group code you want to view. For instructions, see
Searching for an Activity-Specific Information Group Code.

•

Click New to create a new activity-specific information group code.
Civic Platform displays the Activity Specific Info Group Code detail portlet.

3. Complete the Activity Specific Info Group Code fields that display. For a list of field descriptions, see
Table 92: Activity Specific Info Group Code Fields.
4. Click Submit.
Civic Platform displays a confirmation message.
Table 92: Activity Specific Info Group Code Fields

Activity Specific Info
Group Code

Enter the name of the activity specific group.

Activity Specific Info
Subgroup

Enter the name of the activity specific subgroup. The subgroup identifies the specific
type of information that the agency wants to associate with the activity.

Display Len

Specify the maximum number of characters that the activity-specific information can
display.

Display Order

Enter a number to determine the position of the subgroup field for the group code. For
example, to have the Date subgroup field display before the Reply By subgroup field,
enter “10” for the Date subgroup field and “20” for the Reply By subgroup field.

Default Value

Enter the desired default value for the activity-specific information group code.

Fee Indicator

Enter a unique 5-digit indicator to identify this application-specific variable in the fee
formula. You must use a value between 10100 and 10599 and use the following
format: $fixxxxx$. This field is optional. For example, enter $fi10101$

Field Label

Enter a label for the subgroup field.

Field Type

Choose the type of field in your activity specific group.

Group Display Order

Enter a number to determine the position of the activity-specific information group. For
example, enter “10” to display the Phone Call group code first and “20” to display the
Email group code second.

Max Len

Specify the maximum number of characters that the field accepts.

Required Flag

To require users to enter a value in this field, choose Yes; otherwise, choose No.

| Part 3: Configuring Agency Business Objects | 480

Searchable Flag

To allow users to search for the activity-specific information, choose Yes; otherwise,
choose No.

Status

To allow users to use the activity-specific information field, click Enabled; otherwise,
click Disabled.

Unit

Enter any unit definition that you want to attach to the field value. For example, enter
“square feet,” “dollars,” or “miles.”

Use Shared Drop-down
Lists

Select this option to associate shared drop-down lists with an activity-specific
information group code. When you select this option, a search field enables you to
search for existing shared drop-down lists. If you search for a shared drop-down list
that does not match any existing shared drop-down lists, then the Shared Drop-down
List Search page opens. Use this page to search for existing shared drop-down lists.
If you search for a shared drop-down list that matches one existing shared drop-down
list, then the existing shared drop-down list displays in the Activity Specific Info Group
Code detail portlet.
If you search for a shared drop-down list that matches multiple existing shared dropdown lists, then the Shared Drop-down List Select page opens and you can select
the desired drop-down list.

Searching for an Activity-Specific Information Group Code
This section describes how to locate the activity-specific information group codes in your Civic Platform
system. After you locate a group code, you can view it or edit it. For instructions on editing, see Creating or
Editing an Activity-Specific Information Group Code.
To search for an activity-specific information group code
1. Access the Activity Specific Info portlet (Navigating to the Setup Portlet).
2. Click Search.
Civic Platform displays the Activity Specific Info Group Code search portlet

3. Complete any of the following fields.
Activity Specific Info
Group Code

Enter the activity specific info group code you want to find.

Activity Specific Info
Subgroup

Enter the name of the activity specific info subgroup you want to find.

4. Click Submit.
Civic Platform displays the search results.

Deleting an Activity-Specific Information Group Code
You can delete a group code that has attached subgroups.
Note:
If you delete all associated subgroups, Civic Platform deletes the group code automatically. For more
information, see Deleting a Subgroup from an Activity-Specific Information Group.

| Part 3: Configuring Agency Business Objects | 481

To delete an activity-specific information group code
1. Access the Activity Specific Info portlet (Accessing the Activity Specific Info Portlet).
2. Select the activity specific info group code that you want to delete.
3. Click Delete.
Civic Platform displays a confirmation message.

Working with Activity-Specific Information Subgroups
Subgroups are the activity-specific information data elements that an agency defines and associates with
an activity. Administrators define subgroups as needed. An agency can use subgroups with multiple group
codes. You can copy subgroups from one group code to another as needed.
Topics
•

Creating a New Subgroup for Activity-Specific Information

•

Adding Existing Subgroups to Activity-Specific Info Group Codes

•

Deleting a Subgroup from an Activity-Specific Information Group

Creating a New Subgroup for Activity-Specific Information
Subgroups are the activity-specific information data elements that an agency defines and associates with
an activity. You can define and associate as many subgroups as you need to an activity-defined group
code.
To create a new subgroup for activity-specific information
1. Access the Activity Specific Info portlet (Accessing the Activity Specific Info Portlet).
2. Click the activity-specific information group code for which you want to create a subgroup.
3. Click New.
Civic Platform displays the Activity Specific Info Group Code Subgroup portlet.

4. Complete the Activity Specific Info Group Code fields that display. For a list of field descriptions, see
Table 92: Activity Specific Info Group Code Fields. If you are adding a drop-down list field, you must set
the values that you want to include in the list of the field. See Setting Drop-down List Field Values.
5. Click Submit.
Civic Platform displays a confirmation message.

| Part 3: Configuring Agency Business Objects | 482

Adding Existing Subgroups to Activity-Specific Info Group Codes
Agencies can copy a subgroup and use it with multiple group codes. You must associate a subgroup with
at least one group code before you can copy it.
Some subgroups that you can copy are Date, Reply By, From, and To. You can use all of these subgroups
with group code types such as Phone Call, Email, and Letter.
To add an existing subgroup to an activity-specific information group code
1. Access the Activity Specific Info portlet (Accessing the Activity Specific Info Portlet).
2. Click the group code to which you want to copy existing subgroups.
Civic Platform displays the Activity Specific Info Subgroup list portlet.

3. Click Look Up to locate the subgroup you want to copy.
Civic Platform displays the Activity Specific Info Subgroup detail portlet.

4. Complete any of the following fields.
Activity Specific Info
Group Code

Enter the activity-specific information group code from which you want to copy the
subgroups.

Activity Specific Info
Subgroup

Enter the name of the activity specific info subgroup you want to copy to the group
code.

5. Click Submit.
6. Civic Platform displays the search results.
7. Select the subgroups you want to add to the group code.
8. Click Select.
Civic Platform copies the subgroups to the group code, and then displays the results in the list portlet.

Setting Drop-down List Field Values
If you add a drop-down list field to an activity-specific information subgroup, you must then set the values
that you want to include in the list of the field.
To add drop-down list values to a drop-down list field
1. Access the Activity Specific Info portlet (Accessing the Activity Specific Info Portlet).
2. Click the group code and then the subgroup which contains the drop-down list field.
Civic Platform displays the field list of the subgroup.

| Part 3: Configuring Agency Business Objects | 483

3. Click the link for the drop-down list field you want to work with.
Civic Platform displays the field detail portlet.

4. You can either specify a shared drop-down list, or add the values manually:
•

To specify a shared drop-down list, select Use Shared Drop-down Lists, and follow the instructions
in Table 92: Activity Specific Info Group Code Fields.

•

To add the values manually:
1. Click the Drop-down List tab.
Civic Platform displays the drop-down list detail portlet.
2. Click the New button to add values.
3. If you want to remove a value, select the value and click the Delete button.
Civic Platform displays a confirmation message.

Deleting a Subgroup from an Activity-Specific Information Group
If a subgroup is no longer necessary, you can delete it.
Note:
If you delete all associated subgroups, Civic Platform deletes the group code automatically.

To delete a subgroup from an activity-specific information group
1. Access the Activity Specific Info portlet (Accessing the Activity Specific Info Portlet).
2. Select the activity-specific information subgroup code that you want to delete.

| Part 3: Configuring Agency Business Objects | 484

3. Click Delete.
Civic Platform displays a confirmation message indicating.

Working with Activity Types
After you define an activity-specific information group, and you add activity-specific information subgroups
to the group, you can create one or more activity types to associate with the activity-specific information
group. You can then specify in which portlet users can create activities with the new activity type. When
users create or modify an activity, they can enter activity-specific information related to the activity, based
on the activity type and the activity specific info group.
For example, you could associate a phone call activity type with a licensed professional. When a user sees
the phone call activity type, they know to call the associated licensed professional and add the information
exchanged during the phone call into the activity-specific information fields.
Topics
•

Creating or Updating an Activity Type

•

Searching for an Activity Type

•

Viewing an Activity Type

•

Deleting an Activity Type

Creating or Updating an Activity Type
The Activity Type administration portlet defines the activity types that users can specify when creating
activities in records or reference objects. You can associate an activity type with an activity-specific
information group that defines the fields applicable to the activity creation of the type.
There are 6 portlets that support activities. Each activity type only works for one and only one of these
portlets:
Licensed Professional Portlet

Record Portlet

Reference Address Portlet

Reference Contact Portlet

Reference Owner Portlet

Reference Parcel Portlet

To create or update an activity type
1. Access the Activity Type portlet (Navigating to the Setup Portlet).
2. Do one of the following:
•

Click New to create a new activity.

•

Click the activity you want to update.
Civic Platform displays an Activity detail form portlet.

| Part 3: Configuring Agency Business Objects | 485

3. Complete the necessary fields as described in Table 93: Activity Type Fields.
4. Click Submit to save the changes.
Civic Platform displays a confirmation message.
Table 93: Activity Type Fields

Activity Type

Enter the name of the activity.

Activity Specific Info
Group Code

Select the activity-specific information group code from the drop-down list.

Description

Enter a short summary of the action taken related to the activity.

Reference Type

Select to which portlet (business object) to apply the current activity type definition.

Active

Select Enable if you want to display the activity to users; otherwise, select Disable.

Searching for an Activity Type
To search for an activity type
1. Access the Activity Type portlet (Navigating to the Setup Portlet).
2. Click Search.
Civic Platform displays the Activity Type search form portlet.
3. Complete the necessary fields as described in Table 93: Activity Type Fields.
4. Click Submit.
Civic Platform returns a list of activity types that match the search criteria.

Viewing an Activity Type
To view an activity type
1. Access the Activity Type portlet (Navigating to the Setup Portlet).
2. Click the activity that you want to view.
Civic Platform displays the Activity Type detail form portlet.

Deleting an Activity Type
You can delete any activity that you no longer need.
To delete an activity type
1. Access the Activity Type portlet (Navigating to the Setup Portlet).
2. Select the activity you want to delete.
3. Click Submit.

| Part 3: Configuring Agency Business Objects | 486

Civic Platform displays a confirmation message.

| Part 3: Configuring Agency Business Objects | 487

Configuring Standard Comments
Standard comments are pre-defined comments that users can quickly select in lieu of the time-consuming
task of manually entering comments that they use repeatedly. Standard comments help users complete
tasks quickly and improve the consistency of the information on your system.
Standard comments exist throughout Civic Platform. Specifically, users can add standard comments when
updating workflow tasks, entering inspection results, and placing any type of condition on an object.
System administrators must configure Comment Groups, then add Comment Types to those groups,
and then create Comments for those types. You can assign each Standard Comment Group, with its
associated types and comments, to record types, inspections, workflows, and checklists. You can create
a Comment Group and assign it, then add Comment Types and Comments later; until you add Types and
Comments, the data picker on the user side is empty. You can also create a Comment Group, then add
Types and Comments to it, and then assign the group.
Click a topic title below for full details.
Related Information
Managing Standard Comment Groups
Managing Standard Comment Types
Managing Standard Comments
Enforcement Violation Comments

Managing Standard Comment Groups
The first step in managing comments is to create a comment group. The only information you need to
create a group is a comment group name.
There are two ways of assigning a comment group. You can use the Assign button in the Comment Group
main portlet or the tabs in the record portlet.
Topics
•

Creating a Comment Group

•

Viewing a Comment Group

•

Searching for a Comment Group

•

Deleting a Comment Group

•

Assigning a Comment Group

•

Managing Associated Record Types

•

Managing Associated Inspections

•

Managing Associated Workflow Tasks

•

Managing Associated Checklists

Creating a Comment Group
The only information you need to create a comment group is a comment group name. You can add
comment types and comments to the group later. When you assign a Comment Group to a record type,

| Part 3: Configuring Agency Business Objects | 488

inspection, workflow, or checklist, users can choose from the comments associated to the comment group
to populate their form.
To create a comment group
1. Access the Comment Group Maintenance portlet (Accessing the Comment Group Maintenance Portlet).
2. Click New.
Civic Platform displays the Create Comment Group page.

3. Enter a name in the Comment Group field.
4. Click Submit.
Civic Platform adds the new group to the Comment Group List.

Viewing a Comment Group
To view a comment group
1. Access the Comment Group Maintenance portlet (Accessing the Comment Group Maintenance Portlet).
2. Click the name of the comment group you want to view.
Civic Platform displays the associated Comment Types and Comments.

| Part 3: Configuring Agency Business Objects | 489

Searching for a Comment Group
Search for existing standard comment groups.
To find a comment group
1. Access the Comment Group Maintenance portlet (Accessing the Comment Group Maintenance Portlet).
2. Click Search.
Civic Platform displays the Standard Comment Group Search portlet.

3. Complete any fields that display. For a description of the fields, see Table 94: Standard Comment
Group Search Fields.
4. Click Submit.
Civic Platform returns a list of Standard Comment Groups that meet your search criteria.
Table 94: Standard Comment Group Search Fields

Comment Group

Enter the name of the comment group.

Comment Type

Enter the name of the comment type.

Comment ID

Enter the comment ID.

Comment Name

Enter the comment name.

Permit Type

Enter the name of permit type for the comment group you are searching for.Click the
data picker icon next to this field to choose the Permit Type from a data navigation tree.

| Part 3: Configuring Agency Business Objects | 490

Checklist Group

Enter the name of the checklist group for the comment group you are searching for.

Checklist

Enter the name of the checklist for the comment group you are searching for.

Checklist Item

Enter the name of the checklist item for the comment group you are searching for.

Inspection Group Code

Enter the inspection group code for the comment group you are searching for.

Inspection Type

Enter the name of the inspection type for the comment group you are searching for.

Workflow Process

Enter the name of the workflow process for the comment group you are searching for.

Workflow Task

Enter the name of the workflow task for the comment group you are searching for.

Deleting a Comment Group
You cannot delete a comment group if you assign it to a record type, inspection, workflow, or checklist. You
must first delete the relationship between the comment group and the type and then delete the comment
group.
To delete a comment group
1. Access the Comment Group Maintenance portlet (Accessing the Comment Group Maintenance Portlet).
2. Delete any comment types associated to the comment group. For instructions, see Deleting a Comment
Type.
3. In the Standard Comments portlet, select the Comment Group you want to delete.
4. Click Delete.
Civic Platform deletes the Comment Group.

Assigning a Comment Group
When you assign a comment group to a record type, inspection, workflow, or checklist, you provide users
with a drop-down list of the comments contained in the comment group. When working in the form, users
can choose a standard comment from the drop-down list to populate the Comments field.
There are two ways of assigning a comment group. You can use the Assign button in the Comment Group
main portlet or the tabs in the record portlet. Both paths display a navigation tree with all the record types,
inspection types, workflows, and checklists you can assign to a comment group. Select one or more types
and assign the comment group. Each comment type and comment belonging to the comment group is now
available for users to select when completing forms associated with the record, inspection, workflow, or
checklist type.
You can assign each comment group to multiple types. However, each record type, inspection type,
workflow, and checklist can only have one comment group assigned to it. When you try to assign a
comment group to a type that already has one, Civic Platform displays an error message.
To assign a comment group
1. Access the Comment Group Maintenance portlet (Accessing the Comment Group Maintenance Portlet).
2. Use one of two methods to select the record type, inspection, workflow, or checklist to which you want
to assign the comment group:
a. Mark the check box beside the comment group you want to assign.

| Part 3: Configuring Agency Business Objects | 491

a. Hover over or click Assign.
The Comment Group Assign menu displays under the Assign button.

b. Click one of these four choices:
Assign Record Type
Assign Checklist
Assign Inspection
Assign Workflow
Civic Platform displays a navigation tree with the record types, checklists, inspections, or
workflows.

b. Click the name of the comment group you want to assign.
Civic Platform displays the Comment Types and Comments that belong to the selected Comment
Group.
a. Click one of the following tabs, depending on which type of form you want to assign to the
comment group:
Record Types
Inspections
Workflow
Checklist
Civic Platform displays the list of record types, inspections, workflows, or checklists assigned to
the comment group.

| Part 3: Configuring Agency Business Objects | 492

b. Click Look Up.
Civic Platform displays a navigation tree with the record types, checklists, inspections, or
workflows created for your system.

3. Use the + and - buttons to expand and collapse the tree to find the record type, checklist, inspection, or
workflow to which you want to assign the comment group.

| Part 3: Configuring Agency Business Objects | 493

4. Select the record type, checklist, inspection, or workflow to which you want to assign the comment
group.
You can mark multiple check boxes to assign the comment group to multiple record types, checklists,
inspections, or workflows.
Mark an item on a higher level to select everything below that level. Click the check box to clear marked
items.

5. Click Submit.
Civic Platform assigns the items to the specified comment group.

| Part 3: Configuring Agency Business Objects | 494

Managing Associated Record Types
In this portlet you can view the record types for the standard comment group. You can also assign the
group to record types and delete the assignation.
To manage the record types for the standard comment group
1. Navigate to the comment group that you want to update associated record types.
2. Click the Record Types tab.
Civic Platform displays the Record Type list portlet.
3. Do any of the following:
•

To associate a record type with the standard comment group, see Assigning a Comment Group.

•

To remove a record type from the standard comment group, select the record type and then click
Delete.

Managing Associated Inspections
In this portlet you can view the inspections for the standard comment group. You can also assign the group
to inspections and delete the assignation.
To manage the inspections for the standard comment group
1. Navigate to the comment group that you want to update associated inspections.
2. Click the Inspections tab.
Civic Platform displays the Inspections list portlet.
3. Do any of the following:
•

To associate an inspection with the standard comment group, see Assigning a Comment Group.

•

To remove an inspection from the standard comment group, select the inspection and click Delete.

Managing Associated Workflow Tasks
In this portlet you can view the workflow tasks for the standard comment group. You can also assign the
group to workflow tasks and delete the assignation.
To manage the workflow tasks for the standard comment group
1. Navigate to the comment group that you want to update associated workflow tasks.

| Part 3: Configuring Agency Business Objects | 495

2. Click the Workflow tab.
Civic Platform displays the Workflow Task list portlet.
3. Do any of the following:
•

To associate a workflow task with the standard comment group, see Assigning a Comment Group.

•

To remove a workflow task from the standard comment group, select the workflow task and then
click Delete.

Managing Associated Checklists
In this portlet you can view the checklists for the standard comment group. You can also assign the group
to checklists and delete the assignation.
To manage the checklists for the standard comment group
1. Navigate to the comment group that you want to update associated checklists.
2. Click the Checklist tab.
Civic Platform displays the checklist list portlet.
3. Do any of the following:
•

To associated a checklist with the standard comment group, see Assigning a Comment Group.

•

To remove a checklist from the standard comment group, select the checklist and click Delete.

Managing Standard Comment Types
Topics
•

Creating a Comment Type

•

Adding an Existing Comment Type

•

Deleting a Comment Type

Creating a Comment Type
After you create a comment type, you cannot change its name or the comment group it belongs to. To
change these details, you must delete the comment type, first deleting its relationships with comments, and
then create a new comment type with the name and the comment group you want.
When you create a comment type, you can create one comment along with it or leave it blank and add
comments to it later. To add comments to an existing comment type see Adding a New Comment.
To create a comment type
1. Navigate to the comment group for which you want to create a comment type. For instructions on how
to find a comment group, see Viewing a Comment Group.
2. Click the Comment Type tab.
Civic Platform displays the Comment Type list portlet.

| Part 3: Configuring Agency Business Objects | 496

3. Click New.
Civic Platform displays the New Comment Type portlet.

4. Complete the following required fields:
Comment Type

Enter a name for the comment type. It is a good idea to select comment type names
that correspond with the forms you use them for. For example, you could create Code
Enforcement and Inspection comment types.

Comment ID

Enter a value, either alphabetic or numeric. You can devise your own system for
assigning this value.

5. You can add a comment to this comment type now or wait until later. To add a new comment later, see
Adding a New Comment. To add an existing comment later, see Adding an Existing Comment Type. To
add a comment now, complete the following fields:
Comment Name

Enter a descriptive name for the comment, to help users select the appropriate
comment from a list of available comments.

Comment

Enter the text of the comment. This text is the exact wording that populates user
forms when users select this comment from a list of standard comments.

6. Click Submit.
Civic Platform saves the comment type and any comment created with it.

| Part 3: Configuring Agency Business Objects | 497

Adding an Existing Comment Type
You can include comment types in multiple comment groups. For example, you can use the Violation
comment type for both inspections and for asset condition assessments. You can add the Violation
comment type to comment groups assigned to both record types.
1. Navigate to the comment group to which you want to add a comment type. For instructions on how to
find a comment group, see Viewing a Comment Group.
2. Click the Comment Type tab.
Civic Platform displays the Comment Type portlet.
3. Click Look Up.
Civic Platform displays the Comment Type Look Up portlet.

4. Enter the name of the comment type you want to find in the Comment Type field.
To see a complete list of available comment types, leave the field blank.
5. Click Submit.
Civic Platform returns a list of comment types that matches your search criterion.

6. To add a comment type from the list, mark the check box beside the comment type.
7. Click Submit.
Civic Platform adds the comment type to the current Comment Group.

| Part 3: Configuring Agency Business Objects | 498

Deleting a Comment Type
When you delete a comment type, you are deleting the relationship between the comment group and the
comment type. Civic Platform does not delete the comment type from the database and you can still add it
to comment groups.
You can delete a Comment Type in two ways. Select the comment type record and delete it, or delete all
the comments contained in the comment type. To delete comments from a comment type, see Deleting a
Comment.
To delete a comment type
1. Navigate to the comment group from which you want to delete a comment type. For instructions on how
to find a comment group, see Viewing a Comment Group.
2. Click the Comment Type tab.
Civic Platform displays the Comment Type portlet.
3. Select the comment type you want to delete.
4. Click Delete.
Civic Platform deletes the comment type from the comment group. Civic Platform does not delete the
comment group from the database and you can still add it to comment groups.

Managing Standard Comments
You can add a comment to a comment type when you create the comment type. For information on
creating a comment type, see Creating a Comment Type.
Topics
•

Adding a New Comment

•

Viewing a Comment

•

Editing a Comment

•

Deleting a Comment

| Part 3: Configuring Agency Business Objects | 499

Adding a New Comment
You can add comments to comment types when you create them. You can also add additional comments
to existing comment types.
To add a new comment
1. Navigate to the comment group that contains the comment type to which you want to add a comment.
See Viewing a Comment Group.
2. Click the Comment Type tab.
Civic Platform displays the Comment Type portlet.
3. Click the name of the comment type to which you want to add a comment.
Civic Platform displays the Comment List portlet.

4. Click New.
Civic Platform displays the New Comment portlet.

5. Complete these fields:
Comment ID

Enter a value, either alphabetic or numeric. You can devise your own system for
assigning this value.

Comment Name

Enter a descriptive name for the comment, to help users select the appropriate
comment from a list of available comments.

Comment

Enter the text of the comment. This text is the exact wording that populates user
forms when users select this comment from a list of standard comments.

6. Click Submit.
Civic Platform saves the comment.

Viewing a Comment
To view a comment
1. Access the Comment Group Maintenance portlet (Accessing the Comment Group Maintenance Portlet).
2. Click the name of the comment group you want to view.
Civic Platform displays the Comment Types and Comments that belong to the selected Comment
Group.

| Part 3: Configuring Agency Business Objects | 500

3. Click the Comment Type tab.
Civic Platform displays the Comment Type portlet.
4. Click the hyper linked name of the comment type that contains the comment you want to view.
Civic Platform displays the Comment List portlet.
5. Click the link for the name of the comment you want to view.
Civic Platform displays the Comment Detail portlet.

Editing a Comment
You can change the comment name and the text of the comment after it you create it.
Editing a comment in the Administration portlet does not change the comment as it appears where a user
has loaded it into a form. Users must update each instance of a comment to reflect any administrator edits.
To edit a comment
1. Find the comment you want to edit. For instructions on how to find a comment, see Viewing a
Comment.
2. Edit the Comment Name or Comment field. For a definition of these fields, see step 5 of Adding a New
Comment.
3. Click Submit.
Civic Platform saves the changes to the comment.

Deleting a Comment
Delete a comment that is no longer frequently used from a comment type. When you delete all the
comments contained in a comment type, you also delete the comment type.
To delete a comment
1. Find the comment you want to delete. For instructions on how to find a comment, see Viewing a
Comment.
Civic Platform displays the Comment List portlet.

2. Select the comment you want to delete.

| Part 3: Configuring Agency Business Objects | 501

3. Click Delete.
Civic Platform deletes the comment from the comment type.

Enforcement Violation Comments
This section contains the following topics:
•

Creating a Violation Code Comment Type

•

Adding a Comment to the Violation Comment Type

Creating a Violation Code Comment Type
Before you can create a standard comment for a violation, you must set up a violation code comment
type. If you have already set up the violation code comment type, see Adding a Comment to the Violation
Comment Type.
To create a violation code comment type
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Agency Profile > Standard Comments.
Civic Platform displays the Standard Comment Type List—Browse page.

3. Click Add.
Civic Platform displays the Standard Comment—Add page.

| Part 3: Configuring Agency Business Objects | 502

4. Complete the necessary fields as described in Code Enforcement Standard Comment Details.
5. Click Submit.
Civic Platform adds the violation comment to the list of standard comments.
Table 95: Code Enforcement Standard Comment Details

Comment Type

Enter a Violation Code and the comment appears in the Violation Codes drop-down
list on the Violation—Add page where a user can choose the violation to add it to
a citation. For more information on adding a violation, see “Adding a Violation to a
Citation” in the Accela Civic Platform User Guide.

Comment ID

Enter an identification code for the violation comment. You should enter a code that
helps identify what the code stands for. For example, for “Violation,” you might enter
“VIO.”

Comment Name

Enter a name for the violation comment, such as Violation.

Comment

Enter any additional information you want attached to this violation comment. For
example, if the violation were a payment violation, the comment might say, “Payment
Overdue.”

Adding a Comment to the Violation Comment Type
If you want to add more than one comment or violation to the violation code comment type, you can do so
in the standard comment function.
To add a comment to the violation comment type
1. Access the Classic Administration page (Accessing Classic Administration).
2. Choose Review > Std Comment.
Civic Platform displays the Standard Comment Type List—Browse page.

| Part 3: Configuring Agency Business Objects | 503

3. Click the red dot next to the Comment Type “Violation Code.”
4. Click Add.
Civic Platform displays the Standard Comment—Add page.

5. Complete the necessary fields as described in Code Enforcement Standard Comment Details.
6. Click Submit.
Civic Platform adds the violation comment to the list of standard comments.

| Part 3: Configuring Agency Business Objects | 504

Configuring Global Search
Civic Platform provides a search engine to find information globally throughout the software. Users enter
search criteria and Civic Platform displays results in a global search portlet grouped by information type.

You can configure search to define how many max records return in a global search and how many result
rows to display in a group results list page. For example, record result information is grouped together in
pages and licensed professional result information is grouped together in pages. Within each group, a user
can filter, page through, or sort through the result information.
The global search function works against indexed content in the Civic Platform database. To ensure the
most accurate and up-to-date search results, configure a batch job to regularly index the Civic Platform
database.
To configure global search:
1. Set the following FID(s) and Standard Choices (refer to the Civic Platform Configuration Reference for
full details):
•

8434-Global Search

•

GLOBAL_SEARCH_MAX_COUNT

•

BATCH_JOB_SERVICE_CATEGORY

•

GLOBAL_SEARCH_BUILD_INDEX_ENTITIES

2. Create a Global Search Index Batch Job. See Creating a Global Search Index Batch Job for complete
details.

| Part 3: Configuring Agency Business Objects | 505

| Part 4: Managing Agency Communications and Events | 506

Part 4: Managing Agency Communications and Events
Civic Platform provides functions to configure agency communications.
Related Information
Working with Communication Manager
Setting Up Calendars
Social Media Integrations

| Part 4: Managing Agency Communications and Events | 507

Working with Communication Manager
Communication manager is a centralized communications hub that consolidates Civic Platform’s
notification functionality into a single portlet.
Communication manager integrates with Microsoft Exchange and Outlook, enabling agency users to
send meeting requests that they arrange in the calendar portlet, view the calendar availability of meeting
attendees, and maintain Outlook emails and attachments in the Civic Platform database.
Communication manager also integrates with SMS text messaging services, enabling you to communicate
with agency and public users by text message.
Click a topic title below for full details.
Related Information
Prerequisites
Configuring General Settings
Configuring Account Settings
Viewing the 360-Degree Communications List
Viewing Communications Associated with Records
Manually Sending Emails and Text Messages
Managing Alerts
Managing Alert Rules
Announcements
Notification Templates
Variables
Customizing the Content of Agency Communications

Prerequisites
Before you configure the communication manager settings described in this section, you must have a
functioning installation of Microsoft Outlook/Exchange Server, and an SMS text messaging provider. When
configuring communication manager, Civic Platform prompts you to enter key pieces of information from
those software configurations, which enable Civic Platform to communicate with them. Accela provides an
SMS Adapter to connect your SMS text messaging system with Civic Platform. Refer to the SMS Adapter
section of the Accela Civic Platform Installation Guide for complete details.
You must also configure the Function IDs and Standard Choices related to this feature, before you
configure communication manager settings. Refer to the Communication Manager sections of the Accela
Civic Platform Configuration Reference for complete details.

Configuring General Settings
The general settings area is where you connect your Microsoft Exchange Server to Civic Platform. This
is also where you establish system-level settings that enable agency users to send, receive, and store
emails, calendar items, SMS text messages, and attachments.

| Part 4: Managing Agency Communications and Events | 508

Configure the following general settings first, and then proceed to Configuring Account Settings.
Topics
•

Email Server Settings

•

Calendar Server Settings

•

SMS Server Settings

•

Attachment Settings

Email Server Settings
Follow the instructions in this procedure to enable your Civic Platform system to communicate with your
Microsoft Exchange Server.
To connect Civic Platform to your Microsoft Exchange Server
1. Go to Civic Platform Administration > Communication Manager > General Settings.
Civic Platform displays the general settings window.
2. Click the Email Server Settings tab.

3. Complete these fields:
Email Server

Select the Microsoft Exchange Server version your agency uses. To take
advantage of the functionality Communication Manager provides, you must choose
a Microsoft Exchange Server.
If you do not want to implement Communication Manager, select Standard Email
Server in this field, and the values from your ServerConfig.properties file display in
read-only format.

Email Server URL

Enter the URL to your Microsoft Exchange Server Host, for example: https://
exchange.example.com/EX/Exchange.asmx.

| Part 4: Managing Agency Communications and Events | 509

Default User Account

Enter the user name of an active email account on your Microsoft Exchange Server
to designate it as the default email account.
If an agency user does not specify a display name in the from field, when
Communication Manager sends system-level emails, it uses this default email
account as the “sent from” address.

Password

Enter the password for the default email account.

Confirm Password

Re-enter the password.

4. Click Test to ensure the information you provided successfully connects Civic Platform to your Microsoft
Exchange Server.
A confirmation message displays.

5. If you receive a message indicating that Civic Platform failed to connect to your Exchange Server,
revise your entries and test again until you receive a success message.
6. Click Save.

Calendar Server Settings
To configure calendar server settings
1. Go to Civic Platform Administration > Communication Manager > General Settings.
Civic Platform displays the general settings window.
2. Click the Calendar Server Settings tab.

| Part 4: Managing Agency Communications and Events | 510

3. Complete these fields:
Calendar Server

Select the Microsoft Exchange Server version your agency uses.

Calendar Server URL

Enter the URL to your Calendar Server.

Default User Account

Enter the user name of an active email account on your Microsoft Exchange Server
to designate it as the default email account Civic Platform uses for sending meeting
requests.
When Communication Manager sends system-level emails, it uses this default
email account as the “sent from” address.

Password

Enter the password for the default user account.

Confirm Password

Re-enter the password.

4. Click Test (see for complete details).
5. Click Save.

SMS Server Settings
To configure SMS server settings
1. Go to Civic Platform Administration > Communication Manager > General Settings.
Civic Platform displays the general settings window.
2. Click the SMS Server Settings tab.
Civic Platform displays the SMS Server Settings window.

| Part 4: Managing Agency Communications and Events | 511

3. Complete these fields.
SMS Provider

Choose the SMS text messaging provider your agency uses. Administrators
define the options available in this drop down list in the standard choice
COMMUNICATION_SMS_PROVIDERS Refer to the Civic Platform Configuration
Reference for more information on configuring standard choices.

Adapter URL

Enter the URL for your customized SMS adapter. Accela provides a generic
adapter, which you must configure to reflect the details of your agency's SMS
service provider.
This adapter is a web service that enables Civic Platform to communicate with your
SMS provider.

Account

Enter the user name you use to access your SMS provider’s web service.

Password

Enter the password you use to access your SMS provider’s web service.

Confirm Password

Re-enter the password.

Attachment Settings
To configure attachment settings
1. Go to Civic Platform Administration > Communication Manager > General Settings.
Civic Platform displays the general settings window.
2. Click the Attachment Settings tab.
Civic Platform displays the Attachment Settings window.

| Part 4: Managing Agency Communications and Events | 512

3. Complete these fields:
Attachment Server

Select the EDMS server where you want to store email attachments. Civic Platform
populates the values in this drop-down list from this standard choice: EDMS.
There is a limit of one EDMS server per agency for storing email attachments.

Maximum Size of Total Files To further restrict the maximum allowable size of attachments for a single email,
beyond the scope of Civic Platform’s standard file size restrictions, enter a value in
whole numbers here.
This field works with the two standard settings Civic Platform uses to limit the size
of attachments: First, the standard choice EDMS specifies the maximum allowable
file size for each attachment. Second, the ServerConfig.properties file that resides
on the Civic Platform web server specifies the maximum allowable file size for all
attachments within a single email.
The number you enter in this field must be equal to or less than the file size limit
specified in your ServerConfig.properties file.

4. Click Test (see for complete details).
5. Click Save.

Configuring Account Settings
The account settings area is where you configure:
•

Account details that define the accounts from which agency users send outgoing emails and SMS text
messages.

•

Display names that become available for agency users to choose in the “from” value of all systemgenerated communications. A subset of the display names becomes available in the “from” values of
manually initiated emails, according to the user’s permission level.

•

The option to retrieve all emails for the account from the Microsoft Exchange Server. For example, you
might have a general, department-level email account for which you want to enable the retrieval and
storage of all of the communications from and to the account in the Civic Platform database.

First implement Communication Manager by Configuring General Settings, then configure the following
Account Settings:

| Part 4: Managing Agency Communications and Events | 513

•

Email Account Settings

•

SMS Account Settings

Email Account Settings
Use the procedure below to set up each account that you want to make available for agency users to use
for communicating with the public, and for retrieving emails to attach to records.
To configure email account settings
1. Go to Civic Platform Administration > Communication Manager > Account Settings.
2. Click New.
Civic Platform displays the account settings window.
3. Click the Account Detail tab.

4. Complete the following fields:
Email Account

Enter the user name of the email account. This user name must be a valid user
name of the Microsoft Exchange server that you specify in Configuring General
Settings.

Email Address

Enter the email address for the email account you specified in the previous field.

Display Name

Enter a display name for this account. This display name populates in the “from”
values of notification templates, manual email messages, and manual text
messages. Agency users can specify the display name for their department, which
then displays as the sender of the email.

Password

Enter the password of the email account.

Confirm Password

Re-enter the password.

Retrieve Email from Server Check this option to copy all emails sent from and to this email address to the Civic
Platform database. When you select this option, the contents of this email account
become accessible in the communication manager portlet’s consolidated list of
communications, organized by Inbox, Outbox, Sent Items, and Deleted Items.

5. Click Test to ensure the information you provided successfully connects Civic Platform to your Microsoft
Exchange Server.

| Part 4: Managing Agency Communications and Events | 514

6. If you receive a message indicating that Civic Platform failed to connect to your Exchange Server,
revise your entries and test again until you receive a success message.
7. Click Submit if you are creating a new account; Click Save if you are modifying an existing account.
8. Click the Permissions tab.
Civic Platform displays the Permissions window.
9. Click the Assign buttons to select an appropriate permission level for this account.

These permissions define which users have the ability to send manual emails from this account via a
record’s Communications tab (see Viewing Records-related Communications for more information).
When you grant a user permission, the user's name displays as the “from” value for sending manual
communications.
Refer to Setting Up Security Policies for information about assigning permissions.
10.Click Submit.

SMS Account Settings
Use the procedure below to configure outgoing SMS text messaging accounts.
SMS (Short Message Service) is a communications protocol for sending short text messages from
computers to cellular devices. You must have an active, fully configured account with an SMS service
provider before setting up SMS account settings in Civic Platform.
To configure SMS account settings
1. Go to Civic Platform Administration > Communication Manager > Account Settings.
Civic Platform displays the account settings window.
2. Click SMS Account.
3. Click New.
Civic Platform displays the SMS Accounts window.

4. On the Account Detail tab, complete these fields:
SMS Account

Enter the user name of the SMS account.

| Part 4: Managing Agency Communications and Events | 515

Display Name

Enter the name you want to display with the account when selecting “from”
values for notification templates and communications manually initiated from the
Communications tab of a record. Different departments at an agency can each
have their own text message accounts. Users can select the appropriate “from”
values for text messages sent from their department when you configure the text
message account settings here.

Phone Number

Select the phone number for the SMS account.
The SMS adapter defines the phone numbers available to choose from in this
field. This field retrieves available options from the SMS adapter web service. This
number is the sender number that displays to recipients of SMS messages.

Status

Active/Inactive

5. On the Permission tab, click the Assign buttons to select an appropriate permission level for this
account.

These permissions define which users have the ability to send manual text messages from this account
via a record’s Communications tab. When you grant a user permission, the user's name displays as a
“from” value for sending manual communications.
Refer to Setting Up Security Policies for information about assigning permissions.
6. Click Submit.

Viewing the 360-Degree Communications List
Communication manager maintains a correspondence list that keeps track of all incoming and outgoing
communications (also known as a 360-degree view).
The list initially displays in chronological order, but you can sort, filter, and search the correspondence list
by title, communication type, from, to, sent date, and initiating event. You can use the operands “&” and
“or” when filtering the correspondence list. For example, you can filter all communications of type = email
or of type = SMS.
The correspondence list contains the following types of communications:
•

Emails

•

Text Messages

•

Meeting Requests

To view the 360-degree communications list
1. Access the Communications Manager portlet by clicking the main link in Civic Platform.
If you do not have a main link to the Communications Manager portlet, create one by Setting Up Your
Console and Home Page.
Civic Platform displays the four categories of correspondence.

| Part 4: Managing Agency Communications and Events | 516

2. Click to view any of the following items:
Table 96: The 360-Degree Communications List

Sent Items

Click to view items sent from Civic Platform, including all sent items, items sent
manually, items sent by events and scripts, and notifications.

Outbox

Click to view pending items that you have scheduled but not yet sent, items for which
you have specified a delay time, bounced items, and items that Civic Platform cannot
send due to a failure status.

Inbox

Click to view emails retrieved from external email servers. The Inbox stores
emails only; it does not store text message and it does not store other types of
communications. You must select the option Retrieve Email from Server in Email
Account Settings for emails to display here.

Deleted

Click to view deleted and/or restore deleted items.

Viewing Communications Associated with Records
The Records portlet contains a Communications tab where you can:
•

View all the communications, incoming and outgoing, related to a selected record.

•

Manually initiate communications (emails and text messages) relevant to a particular record. Emails
sent from the Records portlet automatically inherit the record ID, and Civic Platform maintains it as part
of the record.

Viewing Records-related Communications
Use the procedure below to view all communications related to a particular record.
To view communications for a specific record
1. To enable this feature, set this FID to full access: 8492-Communication List.
2. Access the Records portlet by clicking the main link in Civic Platform.

| Part 4: Managing Agency Communications and Events | 517

If you do not have a main link to the Records portlet, create one by Adding a Main Link.
3. Select a record.
4. Click the Communications tab. If you do not have a Communications tab, add it by Adding a Tab Menu
to a Template Menu.
Civic Platform displays the Communications tab.

5. Click a column heading to change the sort order of the communications list.
6. Click a title link to go to the details of the communication.
Civic Platform displays the details of the communication.

Viewing Consolidated Record Activities
Communication manager includes a Consolidated Record Activities tab. This tab enables you to view a
summary list of all communications relevant to a particular record. Relevant communications include: email
messages, SMS text messages, meetings, inspections, documents, activities and workflow history.
To view consolidated record activities
1. To enable this feature, set this FID to full access: 8493-Consolidated Record Activities.
2. Access the Records portlet by clicking the main link in Civic Platform.
If you do not have a main link to the Records portlet, create one by Adding a Main Link.
3. Select a record.
4. Click the Consolidated Record Activities tab. If you do not have a Consolidated Record Activities tab,
add it by Adding a Tab Menu to a Template Menu.
Civic Platform displays the Consolidated Record Activities tab.

| Part 4: Managing Agency Communications and Events | 518

Manually Sending Emails and Text Messages
To initiate communications manually
1. Access the Records portlet by clicking the main link in Civic Platform.
If you do not have a main link to the Records portlet, create one by Setting Up Your Console and Home
Page.
2. Select a record.
3. Click the Communication tab.
4. Click New > Email or New > SMS (Text Message) to manually initiate communication.
Civic Platform displays one of the following.

| Part 4: Managing Agency Communications and Events | 519

| Part 4: Managing Agency Communications and Events | 520

5. Complete these fields:
Table 97: Manually Initiated Email and Text Message Fields

Email Fields:
Title

Enter a subject for the email.

Content

Enter the content of the message. You can use HTML code to create the content.
You can also add parameters and embed hyperlinks to the Record Detail page in this
field. You must define the parameters and URL in the EMSE scripts. For information
on how to define parameters and embed hyperlinks, see Embedding Links to Record
Detail Page.

From

Choose a value from the drop-down list. An administrator defines the values that
populate this field. Refer to the Display Name setting in communication manager
account settings.

To, Cc, Bcc

Enter an email address or click the record selection icons to the right of the fields to
specify the recipient(s) of the message (Contact/Owner/Licensed Professional/ Public
User).

Importance

Select an importance: low, normal, or high. Normal is the default.

Send Date/Send Time

Specify a date and time for Civic Platform to send the communication. This field is
mandatory.

Comments

Enter the purpose of the communication, and any useful context you want to retain
regarding the communication. Civic Platform does not send this information to email
servers.

Send Button

Click to send the email or text message.

| Part 4: Managing Agency Communications and Events | 521

Attach Button

Click to upload documents as attachments to the email. After you attach a document
the name of the document displays. If you want to remove the attachment, click the X
button next to the attachment.

Reset Button

Click to remove all attachments and content from the message and reset all fields to
blank fields.

Text Message Fields:
From

Choose a value from the drop-down list. An administrator defines the display
name values that populate the From field. Refer to the Display Name setting in
communication manager account settings.

To

Enter a cellular phone number or click the record selection icons to the right of
the fields to specify the recipient(s) of the message (Contact/Owner/Licensed
Professional/ Public User).

Content

Enter the content of the message.

Designated Send Date

Specify a date and time for Civic Platform to send the communication. This field is
mandatory.

Comments

Enter the purpose of the communication, and any useful context you want to retain
regarding the communication. Civic Platform does not send this information to SMS
servers.

Send Button

Click to send the text message.

Reset Button

Click to remove all content from the message and reset all fields to blank fields.

6. Click Send.

Managing Alerts
Topics
•

Creating an Alert

•

Editing an Alert

•

Deleting an Alert

•

Managing Alert Recipients

•

Creating a Time Variable Alert

Creating an Alert
Privileged users can create alerts to notify groups at your agency of all kinds of events. After you create an
alert it displays in the Alerts portlet, where you can edit, delete, and manage its recipients.
To create an alert
1. Go to Civic Platform Administration > Communication Manager > Alert.
Civic Platform displays the Alert window.
2. Click New.
Civic Platform displays a Message Type drop-down field in the record tab.
3. Select one of the following options from the Message Type drop-down field:
•

If you want to send the alert as an email message, choose Email.

| Part 4: Managing Agency Communications and Events | 522

•

If you want to post the alert message to the Alert portlet, choose Alert Message.

4. Click Submit.
Civic Platform refreshes the form with fields appropriate for the message type.

5. Complete any of the fields that display.
For a list of field descriptions, see Table 98: Alert Detail.
6. Click Submit.
Civic Platform displays a confirmation message and enables the Recipient and Rules tabs.
7. Choose the alert recipients.
See Managing Alert Recipients.
If you want to apply an alert rule to govern the time frame for sending an alert, see Applying an Alert
Rule to an Alert.
Table 98: Alert Detail

Content

Enter the text of the alert message. In addition to the standard text, you can also enter
parameters for variables. Click the selection icon to select a parameter from a list. See
Filtering the Display of Data for a complete list of variable parameters.
For additional variables that pertain directly to Accela Civic Platform - Asset, see Table
99: Asset Management Alert Message Variables.

Duration

Enter how long the alert message should remain in the Alert portlet.

External Recipients

If you are sending the alert to people outside of your agency, select the kind of external
recipient from the drop-down. For example, Contacts.

Message Type

Indicates whether the alert is in the form of an email or as an alert message in the Alert
portlet. After you create an alert message, you cannot change the message type.

Status

Use the drop-down field to enable or disable the alert. The alert duration does not
begin, nor does the alert display, until you enable the alert.

| Part 4: Managing Agency Communications and Events | 523

Unit

Select the units for the quantity in the Duration field (Days, Hours, Minutes, or
Seconds).

Table 99: Asset Management Alert Message Variables

Variable

Name

Description

$$altID$$

Alt ID

The asset’s alternate ID.

$$wotemplate$$

Work Order Template

Template used to create the asset’s associated work
order.

$$scheduledate$$

Schedule Date

Scheduled asset condition assessment date.

$$estprodunits$$

Est. Prod Units

Estimated production units for a work order.

$$actualprodunits$$

Actual Production
Units

Actual production units for a work order.

$$estcostperunit$$

Est. Cost Per Unit

The estimated cost per production unit for a work
order. System administrators define this value at the
Application Type level.

$$costperunit$$

Cost Per Unit

The cost per unit of production for a work order.

$$estjobcost$$

Est. Job Cost

Estimated total cost for the work order. This value is
the product of the Cost Per Unit and the Est. Prod.
Unit values.

$$totaljobcost$$

Total Job Cost

Total cost of the job, defined by a work order.

$$assetgroup$$

Asset Group

Name of an asset group.

$$assettype$$

Asset Type

Name of an asset type.

$$assetID$$

Asset ID

Asset identification name or number.

$$assetstatus$$

Asset Status

Status of an asset, whether Active or Expired.

$$classtype$$

Asset Class Type

Name of an asset class type.

$$dateofservice$$

Date of Service

Date of an asset's activation or when you placed it
into service.

$$usefullife$$

Useful Life

Number of years you expect to use an asset.

$$assetrecordstatus$$

Asset Record Status

Status of the asset record, whether Active or Inactive.

$$assetdesc$$

Asset Description

Description of an asset.

$$currentvalue$$

Current Value

An asset’s current value.

$$depreciationvalue$$

Depreciation Value

Dollar amount of an asset’s value after depreciation.

$$depreciationamount$$

Depreciation Amount

Dollar amount of an asset’s depreciation.

$$assetstreetnumberstart$$

Street # (start)

Initial street number of a street number range.

$$assetstreetnumberend$$

Street # (end)

Final street number of a street number range.

$$assetstreetprefix$$

Prefix

Any part of an address that comes before the street
name or number, such as North Windsor Dr.

$$assetunitnumberstart$$

Unit # (start)

Initial unit number, for example apartment number, of
a unit number range.

$$assetunitnumberend$$

Unit # (end)

Final unit number, for example apartment number, of
a unit number range.

$$assetunittype$$

Unit Type

Type of unit, for example, apartment or condominium.

$$assetstreetdirection$$

Direction

Street direction that precedes the street name, for
example West Broadway.

| Part 4: Managing Agency Communications and Events | 524

Variable

Name

Description

$$assetstreetname$$

Street Name

Street name of an asset’s address.

$$assetstreettype$$

Street Type

Suffix used for a street, for example Lane or
Boulevard.

$$assetstreetsuffix$$

Street Suffix
(direction)

Street direction that follows the street name, for
example 600 Maple South.

$$assetcity$$

City

City in which an asset resides.

$$assetstate$$

State

State in which an asset resides.

$$assetczip$$

Zip

ZIP code for an asset’s mailing address.

Editing an Alert
This section describes how to edit an alert.
To edit an alert
1. Go to Civic Platform Administration > Communication Manager > Alert.
Civic Platform displays the Alert window.
2. Click the link to the alert you want to edit.
Civic Platform displays the alert details.
3. Edit information in the displayed fields.
For a list of field descriptions, see Table 98: Alert Detail.
4. Click Submit to save your changes.
Civic Platform displays a confirmation message, and updates the alert list.
5. Make any changes to the alert recipients, as needed. See Managing Alert Recipients.
6. Make any changes to the alert rule that governs the alert, as needed. See Applying an Alert Rule to an
Alert.

Deleting an Alert
Make sure the alert you select is the one you want to delete. If you delete the wrong alert, you must
recreate it.
To delete an alert
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Choose Communication Manager > Alert.
3. Select the alert you want to delete.
4. Click Delete.
Civic Platform displays a confirmation message.

Managing Alert Recipients
After you create an alert message, you can determine who should receive it. You can send an alert to your
entire agency or select certain departments, user groups, and even individual users within your agency.
If you no longer need a recipient to receive the alert, you can remove the recipient from the list. Removing
a recipient from this list does not delete the recipient from your system.

| Part 4: Managing Agency Communications and Events | 525

For more information on managing alert recipients, see Setting Up Security Policies.

Creating a Time Variable Alert
Use time variables in alerts to notify specific users when, for example, a user creates a service order and a
specific amount of time elapses before they assign the service order to a user.
You can use the following time variables in alerts:
•

$$Today$$

•

$$Today+N$$

•

$$Today-N$$

To configure an alert with a time variable
1. Navigate to V360 Administration > Communication Manager > Alert Rule.
2. Create a new alert rule with the following parameters:
Type: Alert Message
Rule Items: Record - Open Date <= $$TODAY-2$$ AND Record - Assigned to Staff is null
Enabled: Yes

3. Click Submit.
4. Go to Communication Manager > Alert.
5. Create a new alert with message type AlertMessage.
6. Specify the content, duration, and status (enabled).

| Part 4: Managing Agency Communications and Events | 526

7. Click Submit.
8. Open the alert.
9. On the Recipient tab, click Assign User to specify the user you want to notify.
10.On the Alert Rule tab, click Look Up to specify the alert rule you created in .
To validate that the alert is working
1. Create or modify a test record with an opened date more than 2 days in the past (for example,
10/21/2013) and a scheduled date after the opened date (for example, 10/30/2013).
2. Click the Alerts link at the top of the console in Civic Platform to validate that the alert triggers
successfully:

Managing Alert Rules
For instructions on setting up alert messages and recipients, see Creating an Alert.
Topics

| Part 4: Managing Agency Communications and Events | 527

•

Creating an Alert Rule

•

Editing an Alert Rule

•

Deleting an Alert Rule

•

Working with Alert Rule Associations

Creating an Alert Rule
This section describes how to create an alert rule. You can set up an alert rule with multiple conditions. For
example, you might want to send an alert to a manager if someone creates an item of a certain type and of
a particular priority. You enter each rule item in the same way, combining rules with the appropriate logical
operator. Use the parentheses to group two or more conditions.

Sending a Message Immediately
This rule is the typically the most common rule. When an action happens, the alert rule triggers an
immediate response. For example, you might want to send an alert to a department manager immediately
when someone opens an item with a Priority of “1.”
To send a message immediately
1. Go to Civic Platform Administration > Communication Manager > Alert Rule
Civic Platform displays the Alert Rule window.
2. Click New.
Civic Platform displays a blank form.

3. Complete the following fields:
Name

Enter the name of the alert rule.

Description

Enter a description of what the alert rule does. For example, you can describe the
condition that initiates alert, such as “Service Request Closed,” or describe the kind of
alert rule, such “Close Request Alert.”

Enabled

Select “Yes” to enable the alert rule, making it available to apply to alerts; otherwise,
select “No.” Disabling rules enables you to inactivate them without deleting them from
Civic Platform.

| Part 4: Managing Agency Communications and Events | 528

4. Use theTypedrop-down list to choose the Alert Message option.
5. Define one or more conditions of the alert rule. For each condition, enter information in the appropriate
field.
For definitions of the fields, see Conditions Field Descriptions.
6. If you want to add an additional condition, clickNew Item and complete the fields explained in .
7. If desired, click Show Expression to review the expression Civic Platform uses to evaluate the
condition.
8. Click Submit.
Civic Platform adds the alert rule to the list and enables the Associated Objects tab.
9. To review a list of any associated objects, such as Alerts, click the Associated Objects tab.
For instructions on applying an alert rule to an alert, see Applying an Alert Rule to an Alert.
Table 100: Conditions Field Descriptions

Close Parenthesis

Use the open and closed parentheses to group sets of rule conditions.

Literal Value

Enter a literal value to compare the object property against. For example, enter 1 to
have the alert rule condition evaluate only objects with a priority (property) of 1. Literal
values must match exactly the values your agency uses.

Logical Operator

If the alert rule uses more than one expression, Civic Platform displays a logical
operator drop-down. Select the desired operator to combine the expressions. For more
information about your choices, see Filtering the Display of Data.

Object

Select the object you want to associate with the trigger. For example, select Service
Request if you plan to associate a service request’s attribute with an alert. Civic
Platform populates the Property drop-down field with values that correspond with the
object you select.

Open Parenthesis

Use the open and closed parentheses to group rule conditions together.

Property

Select a property for the object you selected in the Object drop-down. For example,
if you plan to apply this rule to an alert that notifies building supervisors of records
opened on a specific date, select “Opened Date” from the Property drop-down list. Your
agency admin defines the items in this drop-down list. For a list of properties, see Alert
Rule Object Properties.

Relational Operator

Select a relational operator to compare the object property against. For more
information about your choices, see Filtering the Display of Data.

Table 101: Alert Rule Object Properties

Property Name

Definition

after(hour)

Combine this property with others to create a time-lapse for the trigger. For example,
to send an alert one hour after an item closes, set up an alert rule item for Status =
“Closed,” then use the AND operator to combine a second rule item for after(hour)=“1.”

Asset Group

Group to which an asset belongs.

Asset ID

Asset identification.

Asset Type

Type of asset.

Assigned Date

The date a staff member receives an item.

Assigned to Department

The department to which the item belongs.

Assigned to Staff

The agent to which the item belongs.

Channel Reported

The reporting mechanism for an item. For example, “Email,” “Call Center,” “Web.”

| Part 4: Managing Agency Communications and Events | 529

Property Name

Definition

Class Type

Class type to which asset groups and types belong.

Closed By

The person who closed the item.

Closed Date

The date the user closed the item.

Current Value

An asset’s current monetary value.

Date of Service

The date an asset record enters into the database.

Depreciation Amount

Dollar amount an asset has depreciated.

Depreciation Value

Value of an asset after it has depreciated.

End Closed Date

If you are searching for an object, use this field along with the Begin Closed Date to
specify a range of closed dates.

End Open Date

If you are searching for an object, use this field along with the Begin Open Date to
specify a range of open dates.

ID (SR, WO, and so
forth)

The item’s identification code. Civic Platform assigns the item this code at the time of
its creation.

Last Activity Date

The date when the item most recently experienced activity.

Module Name

The module to which the object belongs. For example, “Service Request.”

No Activity

This property enables you to specify a period, in hours, during which the item
experienced no activity. For example, if you want the alert rule to trigger an event for
items that experience no activity for 48 hours, select the “No Activity” property, the “=”
operator, and enter “48” in the Literal Value field.

Opened Date

The date you opened the item.

Priority

The priority of the item. For example, “1” or “2.” Your agency creates priorities in Civic
Platform.

Record Status

Status, whether Active or Inactive, of an asset record.

Severity

The severity of the item. Your agency determines the values you can choose from.

SR Sub Type

A more specific classification for the item.

SR Type

The item’s type or classification. Your agency determines the values you can choose
from.

Staff Full Name

The full name of the staff member who owns the item.

Status

The status of the service item. Your agency determines the values you can choose
from. You might see such statuses as Opened, Closed, or Unassigned.

Sub-Status

The sub-status of the item.

Useful Life

Number of years you expect to use an asset.

Sending a Message after Meeting Rule Conditions
You might want to send an alert to a citizen one hour after you close an item, to allow for a delay in case
you reopen the item for some reason. You can also create time alerts that trigger if an event does not
occur. For example, you can alert the manager of a department if items do not experience any activity, with
the “No Activity” property.
To send an alert upon completion of rule conditions
1. Go to Civic Platform Administration > Communication Manager > Alert Rule
Civic Platform displays the Alert Rule window.
2. Click New.

| Part 4: Managing Agency Communications and Events | 530

Civic Platform displays a blank form in the record tab.

3. Complete the following fields:
Name

Enter the name of the alert rule.

Description

Enter a description of what the alert rule does. For example, you can describe the
condition that initiates alert, such as “Service Request Closed,” or describe the kind of
alert rule, such “Close Request Alert.”

Enabled

Select “Yes” to enable the alert rule, making it available to apply to alerts; otherwise,
select “No.” Disabling rules enables you to inactivate them without deleting them from
Civic Platform.

4. Use the Type drop-down list to choose the Time Alert option.
5. Define the condition rule items:
Note:
This additional rule item specifies the time limit that Civic Platform waits before sending an alert
message, upon completion of rule conditions.
Open Parenthesis

Leave this field blank.

Object

Select the option for the desired item. For example, “Service Request,” “Record,”
or “Inspection.”Civic Platform populates the Property drop-down with the object’s
properties.

Property

Select the after (hour) menu option.

Operator

Select the equal (=) menu option.

Literal Value

Enter the time, in hours, after completion of alert rule conditions that you want Civic
Platform to send the alert. You can use decimals to indicate fractions of an hour. For
example, 0.25 equates to fifteen minutes, 0.50 equates to thirty minutes, and 0.75
equates to forty-five minutes.

Close Parenthesis

Leave this field blank.

Logical Operator

If you are creating a Time Alert, choose “And” from the drop-down list and add a
condition with parameters.

6. If you want to add an additional condition, clickNew Item and complete the fields explained in .

| Part 4: Managing Agency Communications and Events | 531

7. Click Show Expression to view the expression Civic Platform uses to evaluate the condition.
8. Click Submit.
Civic Platform adds the alert rule to the list and enables the Associated Objects tab.
To review a list of any associated objects, such as Alerts, click the Associated Objects tab. For
instructions on applying an alert rule to an alert, see Applying an Alert Rule to an Alert.

Editing an Alert Rule
When you edit an existing alert rule, you automatically affect objects, such as alerts, associated with the
alert rule. You do not need to update associated items individually. For example, if you decide that you
want to send alerts for a different service request type, you can simply edit the alert rule, and automatically
update all alerts associated with the alert rule.
To edit an alert rule
1. Go to Civic Platform Administration > Communication Manager > Alert Rule
Civic Platform displays the Alert Rule window.
2. In the Name column, click the alert rule you want to edit.
Civic Platform displays the alert rule details in the record tab.
3. Update the alert rule conditions as appropriate.
For field descriptions, see Creating an Alert Rule.
4. If you want to add an additional condition, clickNew Item and complete any fields that display. For field
descriptions, see Creating an Alert Rule.
For example, you might want to send an alert to a manager if someone creates an item of a certain type
and of a particular priority. You enter each rule item in the same way, combining rule items with logical
operators. Use the parenthesis to group two or more conditions.
5. If you want to delete a condition, select the condition and click Delete Item.
6. Click Show Expression if you want to view the expression used to evaluate the condition.
7. Click Submit.
Civic Platform adds the alert rule to the list and enables the Associated Objects tab.
8. To review a list of any associated objects, such as Alerts, click the Associated Objects tab.
For instructions on applying an alert rule to an object and disassociating an object from an alert rule,
see Working with Alert Rule Associations.

Deleting an Alert Rule
You can remove an alert rule from Civic Platform. Be sure to review any associated objects before deleting
an alert rule.
To delete an alert rule
1. Go to Civic Platform Administration > Communication Manager > Alert Rule
Civic Platform displays the Alert Rule window.
2. Select each rule you want to remove.
Note:
Make sure the alert rule you select is the one you want to delete. If you remove the wrong Rule, you
must recreate it.

| Part 4: Managing Agency Communications and Events | 532

3. Click Delete.
Civic Platform confirms the deletion and updates the alert rules list.

Working with Alert Rule Associations
After you establish an alert rule, you can associate it with the actual system response. For example, if an
alert rule determines that Civic Platform should send an email message in response to a certain condition,
you then need to identify what email message you want to send. You can subsequently review and make
changes to the objects associated with an alert rule, which is useful if you are editing or removing an alert
rule and need to know which alert objects currently use the alert rule.
Topics
•

Applying an Alert Rule to an Alert

•

Disassociating an Alert Rule

Applying an Alert Rule to an Alert
This section describes how you can apply rules to an alert. For instructions on establishing an alert rule,
see Creating an Alert Rule. For instructions on creating an alert, see Creating an Alert.
To apply an alert rule to an alert
1. Go to Civic Platform Administration > Communication Manager > Alert Rule
Civic Platform displays the Alert Rule window.
2. Click the alert to which you want to apply the alert rule.
Civic Platform displays the alert details in the record portlet.
3. Click the Alert Rule tab.
Civic Platform displays the alert rules assigned to the alert.

4. Click Look Up to search for the alert rule you want to assign.
Civic Platform displays a list of all system rules.
5. Select the alert rule you want to apply.

| Part 4: Managing Agency Communications and Events | 533

6. Click Select.
Civic Platform adds the alert rule to the list of rules currently governing the alert.
7. If you inadvertently add the wrong alert rule, select the alert rule, then click Delete. This disassociates
the alert rule from the alert, but does not delete the alert rule from your system.

Disassociating an Alert Rule
You create rule associations when you set up a particular system response, such as an alert. For
instructions, see Applying an Alert Rule to an Alert. If you have applied the same rule to multiple objects
(alerts or other system responses), you might find it helpful to see a list of all objects associated with the
same rule. You can disassociate an alert rule from one or more objects that use it, as appropriate.
To disassociate an alert rule
1. Go to Civic Platform Administration > Communication Manager > Alert Rule
Civic Platform displays the Alert Rule window.
2. Click the link for the alert rule whose associations you want to view or remove.
Civic Platform displays the alert rule details and associated objects.
3. Click the Associated Objects tab.
Civic Platform displays a list of objects currently associated with the alert rule.

4. Select the object you want to delete.
5. Click Delete.
Civic Platform removes the association.

Announcements
Topics

| Part 4: Managing Agency Communications and Events | 534

•

Creating Announcements

•

Searching for an Announcement

•

Editing an Announcement

•

Deleting an Announcement

•

Managing Announcement Recipients

Creating Announcements
Privileged users can create and post announcements to notify agency users or public users of all kinds of
events. For example, you can announce a change in your agency’s policies, a new employee of the month,
or advise users of a software maintenance window.
You can configure an announcement to display in either Civic Platform, Citizen Access, or both. In
Civic Platform, the announcement displays in the Bulletin Board portlet to the recipients (see Figure
31: Accessing the Announcement in Civic Platform). In Citizen Access, when the recipients click the
Announcement link on the top of the home page, a window displays under the link with the announcement
(see Figure 32: Accessing the Announcement in Citizen Access).
Note:
For the Announcement link to display in the Citizen Access home page, you must configure the
announcement settings in Citizen Access Admin. For more information, see "Announcement Settings" in the
Citizen Access Administrator Guide.

Figure 31: Accessing the Announcement in Civic Platform

Figure 32: Accessing the Announcement in Citizen Access
To create an announcement
1. Go to Civic Platform Administration > Communication Manager > Announcement.
2. Click New.
Civic Platform displays a blank form.

| Part 4: Managing Agency Communications and Events | 535

3. Complete any fields that display.
For a list of field descriptions, see Table 102: Field Reference for Announcement Details.
4. Click Submit to save the announcement.
Civic Platform displays a confirmation and enables the Recipient tab.
5. Click the Recipient tab and specify the audience for your announcement. For instructions, see
Managing Announcement Recipients.
Table 102: Field Reference for Announcement Details

Message Title

Enter a title.

Message Type

Choose a message type.

Content

Enter the text (content) of the announcement. You can enter variables in this field.

Display Message In

Choose where you want to display the announcement: Citizen Access OnlyOnly
public users in Citizen Access can see the announcement.Civic Platform onlyOnly
agency users in Civic Platform can see the announcement. BothExpose the
announcement to both public users in Citizen Access and agency users in Civic
Platform. Note: You can continue to specify who can access the announcement. For
complete details, see Managing Announcement Recipients.

Date (Start)

Click the calendar icon to select the date when the announcement should first appear.
You can continue to specify the time in the Time (Start) field that the announcement
begins to appear.

Time (Start)

Specify the time that the announcement begins to appear.

Date (End)

Click the calendar icon to select the last date that the announcement should appear.
You can use the Time (End) to continue to specify the time that the announcement
should begin to disappear. After the specified time, the announcement no longer
displays in the Bulletin Board portlet.

Time (End)

Specify the time that the announcement begins to disappear.

Status

Choose “Enable” to make the announcement available for distribution. Otherwise,
choose “Disable.”

| Part 4: Managing Agency Communications and Events | 536

Searching for an Announcement
You can search for an announcement and edit it.
To search for an announcement
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Choose Communication Manager > Announcement.
3. Click Search.
Civic Platform displays the search form.
4. Complete any fields that display.
For a list of field descriptions, see Table 102: Field Reference for Announcement Details.
5. Click Submit.
Civic Platform returns a list of announcements that match your search criteria.

Editing an Announcement
This section describes how you can modify an existing announcement.
To edit an announcement
1. Access the Setup portlet (Navigating to the Setup Portlet).
2. Choose Communication Manager > Announcement.
3. Click the link to the announcement you want to edit.
If you need to search for the announcement, click Search.
Civic Platform displays the announcement details.

4. Update any of the fields that display.
For a list of field descriptions, see Table 102: Field Reference for Announcement Details.
5. Click Submit to save the announcement.
Civic Platform displays a confirmation and updates the announcement list.

| Part 4: Managing Agency Communications and Events | 537

6. Change the announcement recipients, as appropriate.
For instructions, see Managing Announcement Recipients.

Deleting an Announcement
When an announcement becomes outdated, you can delete it from your system.
To delete an announcement
1. Go to Civic Platform Administration > Communication Manager > Announcement.
2. Select the announcement you want to delete.
3. Click Delete.
Civic Platform displays a confirmation and updates the announcements list.

Managing Announcement Recipients
After creating an announcement and choosing which users you want to expose the announcement to,
you must determine who should receive the announcement in the Recipient tab of the Announcement
portlet. If you want to post the announcement to your agency users, you can select entire agency or
select certain department, user group, or even individual users within your agency. If you want to post the
announcement to public users, you can select one or more agencies, or select certain public user groups
including anonymous users, registered users, licensed professionals, authorized agents, and authorized
agent clerks.
If a group or individual in your organizational structure or Citizen Access no longer needs to receive an
announcement, you can remove the group or individual from the list of recipients. Removing a recipient
from this list does not delete the recipient from your system.
For more information on managing announcement recipients, see Setting Up Security Policies.

Notification Templates
Topics
•

Working with Notification Templates

•

Embedding Links to Record Detail Page

•

Searching for Notification Template

•

Editing a Notification Template

•

Deleting a Notification Template

Working with Notification Templates
Notification templates are emails, text messages, meeting requests, and Citizen Access announcements,
that Civic Platform sends to public users upon a triggering event or action.
Accela provides stock, pre-defined system-level templates, available out of the box with Civic Platform.
Administrators can create new notification templates, and can customize:
•

The content of the message

| Part 4: Managing Agency Communications and Events | 538

•

Which notification type (email or text message) Civic Platform sends when an action occurs that triggers
communication

•

Delayed sending options

You can add parameters to the subject and body of the message. You must declare and assign parameter
values in the EMSE scripts. When the specified event or a batch job occurs, the email notification
generates and the parameters populate with the matching value passed from the scripts. Parameters
are not case-sensitive, but you must enclose them in a pair of double-dollar signs “$$” for example, $
$ExaminationID$$. Refer to Embedding Links to Record Detail Page for more details.

Viewing the Notification Template List
The notification template list includes custom notification templates, created by administrators for
Civic Platform and Citizen Access. The notification template list also includes pre-defined system-level
templates, available out of the box, which administrators can customize to suit the agency’s business
objectives.
To view the notification template list
1. Go to Civic Platform Administration > Communication Manager > Notification Templates.
Civic Platform displays the Notification Templates window.

System-level Notification Templates
The following is a complete list of system-level Notification Templates available in communication
manager. This includes both Civic Platform Notification Templates and Citizen Access Email Notifications,
formerly accessible in Citizen Access Admin > Email Settings.
Table 103: System-level Notification Templates

AA_MESSAGE_INSPECTION_STATUS_CHANGE
AA_MESSAGE_THRESHOLD_NOTIFICATION
ACA_ACTIVATION_MESSAGE
ACA_AGENCY_ACTIVATION_MESSAGE
ACA_MESSAGE_ACCOUNT_VERIFICATION_BY_HYPERLINK
ACA_MESSAGE_ADD_NEW_LICENSE_NOTICE_AGENCY
ACA_MESSAGE_ADD_NEW_LICENSE_NOTICE_CITIZEN
ACA_MESSAGE_ASSOCIATING_LICENSE_TO_MULTIPLE_ACCOUNTS

| Part 4: Managing Agency Communications and Events | 539

ACA_MESSAGE_ETISALAT_PAYMENT_COMPLETION_FAILED
ACA_MESSAGE_ETISALAT_PAYMENT_COMPLETION_SUCCEEDED
ACA_MESSAGE_ETISALAT_PAYMENT_RECONCILIATION_RESULT
ACA_MESSAGE_ETISALAT_PAYMENT_RECONCILIATION_UPLOAD
ACA_MESSAGE_ETISALAT_PAYMENT_REGISTRATION_SUCCEEDED
ACA_MESSAGE_INSPECTION_STATUS_CHANGE
ACA_MESSAGE_RENEW_LICENSE_AUTO_ISSUANCE
ACA_MESSAGE_RENEW_LICENSE_NEW_APPLICATION_NOTICE_AGENCY
ACA_MESSAGE_RENEW_LICENSE_NO_AUTO_ISSUANCE_APPROVED
ACA_MESSAGE_RENEW_LICENSE_NO_AUTO_ISSUANCE_DENIED
ACA_MESSAGE_RENEW_LICENSE_NO_AUTO_ISSUANCE_PENDING
ACA_MESSAGE_SCORES_UPDATE_NOTICE_AGENCY
ACA_MESSAGE_SCORES_UPDATE_NOTICE_PROVIDER
ACA_MESSAGE_SENDPASSWORD
ACA_INACTIVATION_MESSAGE
ACTIVATION_MESSAGE
MESSAGE_ACA_CONNECT_LICENSE_APPROVE_OWNER
MESSAGE_ACA_CONNECT_LICENSE_APPROVE_USER
MESSAGE_ACA_CONNECT_LICENSE_CONNECT_OWNER
MESSAGE_ACA_CONNECT_LICENSE_CONNECT_USER
MESSAGE_ACA_CONNECT_LICENSE_DISCONNECT_OWNER
MESSAGE_ACA_CONNECT_LICENSE_DISCONNECT_USER
MESSAGE_ACA_CONNECT_LICENSE_REJECT_OWNER
MESSAGE_ACA_CONNECT_LICENSE_REJECT_USER
MESSAGE_ACA_TRADE_NAME_APPROVED
MESSAGE_AUTOMATED_PLANREVIEW
MESSAGE_NOTICE_BUILDING
MESSAGE_NOTICE_ENFORCEMENT
MESSAGE_NOTICE_FIRE
MESSAGE_NOTICE_PLANNING
MESSAGE_NOTICE_PUBLIC WORKS
MESSAGE_NOTICE_LICENSE_EXPIRED
MESSAGE_NOTICE_RESULT_INSPECTION
MESSAGE_PAYMENT_NOTICE_BUILDING
MESSAGE_PAYMENT_NOTICE_LICENSES
MESSAGE_PAYMENT_NOTICE_PERMITS
MESSAGE_PAYMENT_RECEIPT_BUILDING
MESSAGE_PAYMENT_RECEIPT_LICENSES
MESSAGE_PAYMENT_RECEIPT_PERMITS
MESSAGE_RECEIPT_BUILDING

| Part 4: Managing Agency Communications and Events | 540

MESSAGE_RECEIPT_ENFORCEMENT
MESSAGE_RECEIPT_FIRE
MESSAGE_RECEIPT_PLANNING
MESSAGE_RECEIPT_PUBLIC WORKS
MESSAGE_REPORT
MESSAGE_SEND_PASSWORD
ACA_MESSAGE_ACCOUNT_LOCKED_NOTICE_CITIZEN
ACA_MESSAGE_ACA_PROXYUSER_ADD
MESSAGE_NOTICE_MEETING_REMINDER

Creating Notification Templates
Use the procedure below to create templates for outgoing emails, meeting requests, SMS text messages,
and Citizen Access notification emails.
To create notification templates
1. Go to Civic Platform Administration > Communication Manager > Notification Templates.
Civic Platform displays the Notification Templates window.
2. Click New.
3. Click the General Details tab.
Civic Platform displays the General Details window.

4. Complete these fields:
Table 104: Communication Manager, Notification Template, General Details Tab

Template Name

Enter a name for the template.

Description

Enter a description of the template’s purpose.

Delay Time and Delay
Unit

Enter the number of minutes, hours, or days you want to delay sending the message
and choose a time interval (minutes, hours, or days) in the Delay Unit field.
For example, if you want to send inspection results after 14 days, enter a delay time
of 14, and then specify “days” as the delay unit in the next field.

| Part 4: Managing Agency Communications and Events | 541

5. If the notification is for email distribution, click the Email Content tab. If the notification is for text
message distribution, proceed to .
Civic Platform displays the Email Content window.

6. Complete these fields:
Table 105: Communication Manager, Notification Template, Email Content Tab

From

Choose a “from” value indicating who the email is from. This name displays to the
message recipient. Administrators configure the values that display here when setting
up the email account; see Configuring Account Settings.

To, Cc, and Bcc

Enter specific email addresses or enter EMSE parameters such as $$contacts$$ or $
$recordcontactemail$$. You must define these values in the EMSE scripts that initiate
the communication.
In the Cc and Bcc fields, you can enter an agency email address, which is useful for
saving all communications sent to or from a particular department-wide email alias
that you set up to retrieve all emails from the server.
Another use case is to configure a script that attaches all emails sent to a Cc or Bcc to
records in Civic Platform.

Title

Enter an email subject or enter an EMSE parameter. To use parameters you must
define the values in the EMSE scripts that initiate the communication. For complete
details about working with EMSE, refer to the Accela Civic Platform Scripting Guide.

Importance

Select an importance: low, normal, or high. Normal is the default.

| Part 4: Managing Agency Communications and Events | 542

Content

Enter the content of the message. In addition to standard message text, you can:
-- Include variables in the message body. Refer toVariables for a full list.
-- Use HTML code to format the content.
-- Add parameters and embed a hyperlink to the Record Detail page in the message
body. You must define the parameters and URL in EMSE scripts.
For information on how to define parameter and embed a hyperlink, see Embedding
Links to Record Detail Page.

Display in ACA

Only templates related to examinations and EDR (Electronic Document Recognition)
have the Display in ACA field. Select this option to display the notification as
an announcement in Citizen Access. For complete details on how to set up
Announcements, refer to the Citizen Access Administrator Guide, “Global Settings
Configuration” section.

Display as Alert

Select this option to display an alert informing agency users that they successfully
configured the communication.

Save as Attachment

Select this option to enable the attachments settings that define whether and how
Civic Platform attaches notifications to records or email recipients.

Attach To

This setting is only available for system-level templates, and becomes available when
you select the Save as Attachment option.
Select Record in the drop-down list to save the email notification as an attachment to
associated records.
Select Recipient in the drop-down list, Civic Platform saves a notification as an
attachment to the recipients of the notification under the following conditions:
(1) The event that triggers when Civic Platform sends the notification contains script
that calls the EMSE method attachEmailToEntity to attach the email to specific
recipient(s);
(2) The recipient email address specified in the email content is identical with one of
the record-associated contacts or licensed professionals.

Document Group/
Category

This setting is only available for system-level templates, and becomes available
when you select the Save as Attachment option. Categorize the attachment by first
selecting a value from the Document Group drop-down list, then a value from the
Document Category drop-down list. It is important to select the Document Group first,
because the Document Category drop-down list can be different based on which
document group you choose.

EDMS Name

This setting is only available for system-level templates, and becomes available
when you select the Save as Attachment option. Select the Electronic Document
Management System (EDMS) you want to save the notification to.

7. Click Save.
8. If the message is for text message distribution, click the SMS Content tab.
Civic Platform displays the SMS Content window.

| Part 4: Managing Agency Communications and Events | 543

9. Complete these fields:
Table 106: Communication Manager, Notification Template, SMS Content Tab

From

Choose a “from” value indicating who the text message is from. This name displays
to the message recipient. Administrators configure the values that display here when
setting up the email account; see Configuring Account Settings.

To

Enter cellular phone number(s). You can also enter parameters such as $$contacts$
$. You must define these values in the EMSE scripts that initiate the communication.

Content

Enter the content of the text message. This should be a very brief message and can
include agency-defined variables, such as record ID, workflow task name and due
date, and scheduled inspection time, for example.

10.Click Save.

Embedding Links to Record Detail Page
You can embed a hyperlink to the Record Detail page in notification templates. Embedding links enables
public users to instantly access the Record Detail page by clicking the hyperlink from the notification. If you
restrict record detail page access to registered users, the Login screen displays before the record detail
page.
To embed a hyperlink in a notification template to link to the Record Detail page there are four steps:
•

Creating an EMSE script

•

Defining a parameter to assign to returned URL

•

Entering parameter to the template body

•

Mapping the parameter to Record Detail page

For complete details about working with scripts, refer to the Accela Civic Platform Scripting Guide.

Creating an EMSE script
Step 1: Create an EMSE script, in which you create a function to get the Record Detail page URL
The URL returned by the function must be in the pattern as shown below:

| Part 4: Managing Agency Communications and Events | 544

http://$$ACAWebSite$$/urlrouting.ashx?type=1000&Module=$$Module$$&capID1=$$CapID1$$&capID2=
$$CapID2$$&capID3=$$CapID3$$&agencyCode=$$AgencyCode$$
$$ACAWebSite$$

Citizen Access website domain.

$$Module$$

Module to which you associated the records.

$$CapID1$$, $$CapID2$$, $ Record ID fields together with the $$Module$$ and $$AgencyCode$$ to identify a
$CapID3$$
unique record in your agency.
$$AgencyCode$$

Agency code.

The following code snippet is an example of a function returning the URL of the Record Detail page.
function getACAUrl()
{
var acaUrl = “”;
var id1 = Accela Automation.env.getValue(“PermitId1”);
var id2 = Accela Automation.env.getValue(“PermitId2”);
var id3 = Accela Automation.env.getValue(“PermitId3”);
var capResult = Accela Automation.cap.getCap(id1, id2, id3);
if(!capResult.getSuccess())
{
return acaUrl;
}
var cap = capResult.getOutput().getCapModel();
acaUrl = acaWebServiceSite + “/urlrouting.ashx?type=1000”;
acaUrl += “&Module=” + cap.getModuleName();
acaUrl += “&capID1=” + id1 + “&capID2=” + id2 + “&capID3=” + id3;
acaUrl += “&agencyCode=” + Accela Automation.getServiceProviderCode();
return acaUrl;
}

Defining a parameter to assign to returned URL
Step 2: In the EMSE script, define a parameter to assign to the returned URL.
The sample code below defines a parameter called $$Url$$. Civic Platform assigns the returned URL by
function getACAUrl().

| Part 4: Managing Agency Communications and Events | 545

function getParamsForSchedule()
{
…
//Define the parameter
$$Url$$
to assign to the Record Detail page URL.
addParameter(params, “$$Url$$”, getACAUrl());
…
return params;
}

Entering parameter to the template body
Step 3: Enter text or parameter to the template body that you want to map to the Record Detail page
URL.
You can map the URL either to the text or to the parameter in the template body. For each parameter that
you add to the template body or its subject, you must assign and define its value in the EMSE scripts. For
the sample code of defining parameters, see Defining a parameter to assign to returned URL
1. Access the Notification Template portlet (Navigating to the Setup Portlet).
2. Open an existing notification template, or create a new one.
To learn how to create a notification template, see Creating Notification Templates.
3. In the Message Body field, do one of the following:
•

Enter the text you want to map to the URL of the Record Detail page. For example, Click Here.

•

Enter a parameter you want to map to the URL. For example, $$AlternateID$$.

| Part 4: Managing Agency Communications and Events | 546

Mapping the parameter to Record Detail page
Step 4: Map the text or parameter to the Record Detail page URL.
1. Access the template body.
To learn how to access a notification template, see Entering parameter to the template body
2. Highlight the text or the parameter in the Message Body field.
3. Click the hyperlink icon.
Civic Platform displays the Hyperlink window.

4. In the Hyperlink window, select “https” from the Type drop-down list.
5. In the URL field enter the parameter you want to assign to the returned URL in the EMSE scripts ($$Url
$$, from the sample code snippet in Defining a parameter to assign to returned URL).
6. Click Save if you are editing an existing template; click Submit if you are creating a new template.

Searching for Notification Template
To search for a notification template
1. Go to Civic Platform Administration > Communication Manager > Notification Templates.
Civic Platform displays the Notification Templates window.
2. Click Search.
Civic Platform displays the Notification Template Search form.
3. Complete any fields that display.
4. Click Submit.
Civic Platform returns a list of notification templates that match your search criteria.

Editing a Notification Template
To edit a notification template
1. Go to Civic Platform Administration > Communication Manager > Notification Templates.
Civic Platform displays the Notification Templates window.

| Part 4: Managing Agency Communications and Events | 547

2. Click the template name that you want to edit.
If you need to search for the message, Click Search on the top of the list.
Civic Platform displays the template detail portlet.
3. Update any of the fields that display as necessary.
For descriptions of the fields, see Creating Notification Templates.
4. Click Submit.

Deleting a Notification Template
When a notification template becomes outdated, you can delete it from your system. If a batch job uses
the deleted notification template, you cannot delete the template. You also cannot delete system templates
that come standard with the Accela solutions.
To delete a notification template
1. Go to Civic Platform Administration > Communication Manager > Notification Templates.
Civic Platform displays the Notification Templates window.
2. Select the unwanted templates.
3. Click Delete.
Civic Platform warns you that the template might be in use.
4. Click OK if you are sure you want to delete the template.

Variables
The following table lists the variables you can use when you compose system-generated emails, SMS text
messages, and notification templates.
Table 107: Communication Variables

Notification Template or Product
Area

Variable

Description

AA_MESSAGE_INSPECTION_
STATUS_CHANGE

$$InspectorFullName$$

Inspector full name

$$CustomId$$

Customer ID

$$PermitId1$$

Permit ID1

$$PermitId2$$

Permit ID2

$$PermitId3$$

Permit ID3

$$InspectionType$$

Inspection type

$$InspectionStatus$$

Inspection status

$$InspectionDate$$

Inspection date

$$InspectionTime$$

Inspection time

$$InspectionAddress$$

Inspection address

$$RequestedComments$$

Requested comments

$$InspectionEndTime$$

Inspection end time

$$CapID$$

Record ID

AA_MESSAGE_THRESHOLD_
NOTIFICATION

| Part 4: Managing Agency Communications and Events | 548

Notification Template or Product
Area

ACA_ACTIVATION_MESSAGE

Variable

Description

$$AltID$$

Alt ID

$$AccountID$$

Trust account ID

$$ThresholdAmount$$

Trust account threshold
amount

$$Balance$$

Balance

$$Description$$

Trust account description

$$LegerAccount$$

Leger account

$$userID$$

Public user ID

$$servProvCode$$

Agency ID; Service Provider
Code

$$userName$$

Public user’s display name

$$password$$

Public user's password

$$email$$

Public user’s email address

$$firstName$$

First name (middle name,
last name, business name/
organization name, state,
city, address, or zip) of the
public user. Civic Platform
gets the value from the
public user’s account owner
or from a contact associated
with the user account.
For more information, see
Setting an Associated
Contact as the Account
Owner.

$$middleName$$
$$lastName$$
$$businessName$$
$$state$$
$$city$$
$$address$$
$$zip$$

ACA_AGENCY_ACTIVATION_
MESSAGE

$$userID$$

Public user ID

$$servProvCode$$

Agency ID; Service Provider
Code

$$userName$$

Public user’s display name

$$password$$

Public user's password

$$email$$

Public user’s email address

$$firstName$$

First name (middle name,
last name, business name/
organization name, state,
city, address, or zip) of the
public user. Civic Platform
gets the value from the
public user’s account owner
or from a contact associated
with the user account.
For more information, see
Setting an Associated
Contact as the Account
Owner

$$middleName$$
$$lastName$$
$$businessName$$
$$state$$
$$city$$
$$address$$
$$zip$$

ACA_INACTIVATION_MESSAGE

$$userID$$

Public user ID

$$servProvCode$$

Agency ID; Service Provider
Code

$$userName$$

Public user’s display name

| Part 4: Managing Agency Communications and Events | 549

Notification Template or Product
Area

Variable

Description

$$email$$

Public user’s email address

$$firstName$$

First name (middle name,
last name, business name/
organization name, state,
city, address, or zip) of the
public user. Civic Platform
gets the value from the
public user’s account owner
or from a contact associated
with the user account.
For more information, see
Setting an Associated
Contact as the Account
Owner.

$$middleName$$
$$lastName$$
$$businessName$$
$$state$$
$$city$$
$$address$$
$$zip$$

ACA_MESSAGE_ACA_
PROXYUSER_ADD

$$InputName$$

Proxy user's nickname

$$InviterName$$

Public user name

$$PersonalNote$$

Proxy user's invitation
message

$$firstName$$

First name (middle name,
last name, business name/
organization name, state,
city, address, or zip) of the
public user. Civic Platform
gets the value from the
public user’s account owner
or from a contact associated
with the user account.
For more information, see
Setting an Associated
Contact as the Account
Owner.

$$middleName$$
$$lastName$$
$$businessName$$
$$state$$
$$city$$
$$address$$
$$zip$$

ACA_MESSAGE_ACCOUNT_
LOCKED_NOTICE_CITIZEN

$$userID$$

Public user ID

$$servProvCode$$

Agency ID; Service Provider
Code

$$userName$$

Public user’s display name

$$password$$

Public user's password

$$email$$

Public user’s email address

$$UUID$$

UUID (configure in the
hyperlink within the account
activation email).

| Part 4: Managing Agency Communications and Events | 550

Notification Template or Product
Area

Variable

Description

$$firstName$$

First name (middle name,
last name, business name/
organization name, state,
city, address, or zip) of the
public user. Civic Platform
gets the value from the
public user’s account owner
or from a contact associated
with the user account.
For more information, see
Setting an Associated
Contact as the Account
Owner.

$$middleName$$
$$lastName$$
$$businessName$$
$$state$$
$$city$$
$$address$$
$$zip$$

ACA_MESSAGE_ACCOUNT_
VERIFICATION_BY_HYPERLINK

$$userID$$

Public user ID

$$servProvCode$$

Agency ID; Service Provider
Code

$$userName$$

Public user’s display name

$$password$$

Public user's password

$$email$$

Public user’s email address

$$UUID$$

UUID (configure in the
hyperlink within the account
activation email).

$$firstName$$

First name (middle name,
last name, business name/
organization name, state,
city, address, or zip) of the
public user. Civic Platform
gets the value from the
public user’s account owner
or from a contact associated
with the user account.
For more information, see
Setting an Associated
Contact as the Account
Owner.

$$middleName$$
$$lastName$$
$$businessName$$
$$state$$
$$city$$
$$address$$
$$zip$$

ACA_MESSAGE_ADD_NEW_
LICENSE_NOTICE_AGENCY

$$userID$$

Public user ID

$$servProvCode$$

Agency ID; Service Provider
Code

$$userName$$

Public user’s display name

$$email$$

Public user’s email address

$$LicenseNumber$$

License number

$$LicenseType$$

License type

$$mmddyy$$

Current date

| Part 4: Managing Agency Communications and Events | 551

Notification Template or Product
Area

Variable

Description

$$firstName$$

First name (middle name,
last name, business name/
organization name, state,
city, address, or zip) of the
public user. Civic Platform
gets the value from the
public user’s account owner
or from a contact associated
with the user account.
For more information, see
Setting an Associated
Contact as the Account
Owner.

$$middleName$$
$$lastName$$
$$businessName$$
$$state$$
$$city$$
$$address$$
$$zip$$

ACA_MESSAGE_ADD_NEW_
LICENSE_NOTICE_CITIZEN

$$userID$$

Public user ID

$$servProvCode$$

Agency ID; Service Provider
Code

$$userName$$

Public user’s display name

$$email$$

Public user’s email address

$$LicenseNumber$$

License number

$$LicenseType$$

License type

$$mmddyy$$

Current date

$$firstName$$

First name (middle name,
last name, business name/
organization name, state,
city, address, or zip) of the
public user. Civic Platform
gets the value from the
public user’s account owner
or from a contact associated
with the user account.
For more information, see
Setting an Associated
Contact as the Account
Owner.

$$middleName$$
$$lastName$$
$$businessName$$
$$state$$
$$city$$
$$address$$
$$zip$$

ACA_MESSAGE_ASSOCIATING_
LICENSE_TO_MULTIPLE_
ACCOUNTS

$$userID$$

Public user ID

$$servProvCode$$

Agency ID; Service Provider
Code

$$userName$$

Public user’s display name

$$email$$

Public user’s email address

$$LicenseNumber$$

License number

$$LicenseType$$

License type

$$mmddyy$$

Current date

| Part 4: Managing Agency Communications and Events | 552

Notification Template or Product
Area

Variable

Description

$$firstName$$

First name (middle name,
last name, business name/
organization name, state,
city, address, or zip) of the
public user. Civic Platform
gets the value from the
public user’s account owner
or from a contact associated
with the user account.
For more information, see
Setting an Associated
Contact as the Account
Owner.

$$middleName$$
$$lastName$$
$$businessName$$
$$state$$
$$city$$
$$address$$
$$zip$$

ACA_MESSAGE_INSPECTION_
STATUS_CHANGE

ACA_MESSAGE_RENEW_
LICENSE_AUTO_ISSUANCE

$$InspectorFullName$$

Inspector full name

$$CustomId$$

Customer ID

$$PermitId1$$

Permit ID1

$$PermitId2$$

Permit ID2

$$PermitId3$$

Permit ID3

$$InspectionType$$

Inspection type

$$InspectionStatus$$

Inspection status

$$InspectionDate$$

Inspection date

$$InspectionTime$$

Inspection time

$$InspectionAddress$$

Inspection address

$$RequestedComments$$

Requested comments

$$userID$$

Public user ID

$$servProvCode$$

Agency ID; Service Provider
Code

$$userName$$

Public user’s display name

$$email$$

Public user’s email address

$$capID$$

Record ID

$$capType$$

Record type alias

$$mmddyy$$

License expiration date

$$firstName$$

First name (middle name,
last name, business name/
organization name, state,
city, address, or zip) of the
public user. Civic Platform
gets the value from the
public user’s account owner
or from a contact associated
with the user account.
For more information, see
Setting an Associated
Contact as the Account
Owner.

$$middleName$$
$$lastName$$
$$businessName$$
$$state$$
$$city$$
$$address$$
$$zip$$

ACA_MESSAGE_RENEW_
LICENSE_NEW_APPLICATION_
NOTICE_AGENCY

$$userID$$

Public user ID

| Part 4: Managing Agency Communications and Events | 553

Notification Template or Product
Area

Variable

Description

$$servProvCode$$

Agency ID; Service Provider
Code

$$userName$$

Public user’s display name

$$email$$

Public user’s email address

$$capID$$

Record ID

$$capType$$

Record type alias

$$mmddyy$$

License expiration date

$$firstName$$

First name (middle name,
last name, business name/
organization name, state,
city, address, or zip) of the
public user. Civic Platform
gets the value from the
public user’s account owner
or from a contact associated
with the user account.
For more information, see
Setting an Associated
Contact as the Account
Owner.

$$middleName$$
$$lastName$$
$$businessName$$
$$state$$
$$city$$
$$address$$
$$zip$$

ACA_MESSAGE_RENEW_
LICENSE_NO_AUTO_ISSUANCE_
APPROVED

$$userID$$

Public user ID

$$servProvCode$$

Agency ID; Service Provider
Code

$$userName$$

Public user’s display name

$$email$$

Public user’s email address

$$capID$$

Record ID

$$capType$$

Record type alias

$$mmddyy$$

License expiration date

$$firstName$$

First name (middle name,
last name, business name/
organization name, state,
city, address, or zip) of the
public user. Civic Platform
gets the value from the
public user’s account owner
or from a contact associated
with the user account.
For more information, see
Setting an Associated
Contact as the Account
Owner.

$$middleName$$
$$lastName$$
$$businessName$$
$$state$$
$$city$$
$$address$$
$$zip$$

ACA_MESSAGE_RENEW_
LICENSE_NO_AUTO_
ISSUANCE_DENIED

$$userID$$

Public user ID

$$servProvCode$$

Agency ID; Service Provider
Code

$$userName$$

Public user’s display name

$$email$$

Public user’s email address

$$capID$$

Record ID

| Part 4: Managing Agency Communications and Events | 554

Notification Template or Product
Area

Variable

Description

$$capType$$

Record type alias

$$mmddyy$$

License expiration date

$$firstName$$

First name (middle name,
last name, business name/
organization name, state,
city, address, or zip) of the
public user. Civic Platform
gets the value from the
public user’s account owner
or from a contact associated
with the user account.
For more information, see
Setting an Associated
Contact as the Account
Owner.

$$middleName$$
$$lastName$$
$$businessName$$
$$state$$
$$city$$
$$address$$
$$zip$$

ACA_MESSAGE_RENEW_
LICENSE_NO_AUTO_
ISSUANCE_PENDING

$$userID$$

Public user ID

$$servProvCode$$

Agency ID; Service Provider
Code

$$userName$$

Public user’s display name

$$email$$

Public user’s email address

$$capID$$

Record ID

$$capType$$

Record type alias

$$mmddyy$$

License expiration date

$$firstName$$

First name (middle name,
last name, business name/
organization name, state,
city, address, or zip) of the
public user. Civic Platform
gets the value from the
public user’s account owner
or from a contact associated
with the user account.
For more information, see
Setting an Associated
Contact as the Account
Owner.

$$middleName$$
$$lastName$$
$$businessName$$
$$state$$
$$city$$
$$address$$
$$zip$$

ACA_MESSAGE_SCORES_
UPDATE_NOTICE_AGENCY

ACA_MESSAGE_SCORES_
UPDATE_NOTICE_PROVIDER

ACA_MESSAGE_
SENDPASSWORD

$$servProvCode$$

[Case sensitive] Agency ID;
Service Provider Code

$$ProviderName$$

[Case sensitive] Provider
name

$$ProviderNumber$$

[Case sensitive] Provider
number

$$servProvCode$$

[Case sensitive] Agency ID;
Service Provider Code

$$ProviderName$$

[Case sensitive] Provider
name

$$ProviderNumber$$

[Case sensitive] Provider
number

$$userID$$

Public user ID

| Part 4: Managing Agency Communications and Events | 555

Notification Template or Product
Area

Variable

Description

$$servProvCode$$

Agency ID; Service Provider
Code

$$userName$$

Public user’s display name

$$password$$

Public user’s password

$$email$$

Public user’s email address

$$firstName$$

First name (middle name,
last name, business name/
organization name, state,
city, address, or zip) of the
public user. Civic Platform
gets the value from the
public user’s account owner
or from a contact associated
with the user account.
For more information, see
Setting an Associated
Contact as the Account
Owner.

$$middleName$$
$$lastName$$
$$businessName$$
$$state$$
$$city$$
$$address$$
$$zip$$

EMAIL_NOTICE_MEETING_
REMINDER

$$Meeting.Type$$

Meeting type

$$Meeting.RespDept$$

Meeting responsible
person’s department

$$Meeting.RespName$$

Meeting responsible person
name

$$Meeting.Date$$

Meeting date

$$Meeting.Location$$

Meeting location

$$Meeting.StartTime$$

Meeting start time

$$Meeting.EndTime$$

Meeting end time

$$Meeting.IsAllDayEvent$$

All day event

$$Meeting.Subject$$

Meeting subject

$$Meeting.Attendee$$

Meeting attendee

$$Meeting.Body$$

Meeting body

$$Meeting.Comment$$

Meeting comment

$$Meeting.MaxItem$$

Maximum agenda items

$$Meeting.Agenda$$

Meeting agenda ID

$$Meeting.Duration$$

Meeting duration

$$Meeting.NoticeDate$$

Meeting notice date

$$Meeting.Status$$

Meeting status

Hearing Email Notification, defined in $PRIMARYAPPLICANT$
Classic Administration > Workflow >
Messages

Primary applicant

$AGENCY-DEPARTMENT$

Agency department

$HEARING_BODY$

Hearing body

$CALENDARDATEORIG$

Original calendar date

$LOCATIONORIG$

Original location

$STARTTIMEORIG$

Original start time

$CALENDARDATENEW$

New calendar date

| Part 4: Managing Agency Communications and Events | 556

Notification Template or Product
Area

Variable

Description

$LOCATIONNEW$

New location

$STARTTIMENEW$

New start time

$FIRSTNAME$

Agency’s first name

$LASTNAME$

Agency’s last name

$USERTITLE$

User name

Inspection Email Notification, defined $$CAPID$$ / $PERMITID$
in Classic Administration > Workflow
> Messages

MEETING_NEW

MEETING_REJECT

Record or permit ID

$$CAPDETAIL$$ / $PERMITDETAIL$

Record or permit detail

$$CAPAPPTYPE$$ / $PERMITAPPTYP$

Record or permit type

$$CAPNAME$$ / $PERMITNAME$

Record or permit name

$$CAPSTATUS$$ / $PERMITSTATUS$

Record or permit status
value

$$CAPADDR$$ / $PERMITADDR$

Record or permit address

$$CAPPARCEL$$ / $PERMITPARCEL$

Record or permit parcel

$$CAPWRKDESC$$ / $PERMITWRKDESC$

Record or permit work
description

$$INSPITEM$$ / $INSPITEM$

Inspection item

$$INSPRESULT$$ / $INSPRESULT$

Inspection result

$$INSPCOMMENT$$ / $INSPCOMMENT$

Inspection comment

$$Meeting.Type$$

Meeting type

$$Meeting.RespDept$$

Meeting responsible person
department

$$Meeting.RespName$$

Meeting responsible person
name

$$Meeting.Date$$

Meeting date

$$Meeting.Location$$

Meeting location

$$Meeting.StartTime$$

Meeting start time

$$Meeting.EndTime$$

Meeting end time

$$Meeting.IsAllDayEvent$$

All day event

$$Meeting.Subject$$

Meeting subject

$$Meeting.Attendee$$

Meeting attendee

$$Meeting.Body$$

Meeting body

$$Meeting.Comment$$

Meeting comment

$$Meeting.MaxItem$$

Maximum agenda items

$$Meeting.Agenda$$

Meeting agenda ID

$$Meeting.Duration$$

Meeting duration

$$Meeting.NoticeDate$$

Meeting notice date

$$Meeting.Status$$

Meeting status

$$Meeting.Type$$

Meeting type

$$Meeting.RespDept$$

Meeting responsible
person’s department

$$Meeting.RespName$$

Meeting responsible person
name

| Part 4: Managing Agency Communications and Events | 557

Notification Template or Product
Area

MEETING_UPDATE

Variable

Description

$$Meeting.Date$$

Meeting date

$$Meeting.Location$$

Meeting location

$$Meeting.StartTime$$

Meeting start time

$$Meeting.EndTime$$

Meeting end time

$$Meeting.IsAllDayEvent$$

All day event

$$Meeting.Subject$$

Meeting subject

$$Meeting.Attendee$$

Meeting attendee

$$Meeting.Body$$

Meeting body

$$Meeting.Comment$$

Meeting comment

$$Meeting.MaxItem$$

Maximum agenda items

$$Meeting.Agenda$$

Meeting agenda ID

$$Meeting.Duration$$

Meeting duration

$$Meeting.NoticeDate$$

Meeting notice date

$$Meeting.Status$$

Meeting status

$$userID$$

Public user ID

$$servProvCode$$

Agency ID; Service Provider
Code

$$userName$$

Public user name

$$password$$

Public user password

$$email$$

Public user email

$$InputName$$

Proxy user's nickname

$$PersonalNote$$

Proxy user's invitation
message

$$InviterName$$

Public user name

$$userID$$

Public user ID

$$email$$

Public user's email

$$password$$

Public user's password

$$activationURL$$

activation URL

$$Meeting.Type$$

Meeting type

$$Meeting.RespDept$$

Meeting responsible
person’s department

$$Meeting.RespName$$

Meeting responsible person
name

$$Meeting.Date$$

Meeting date

$$Meeting.Location$$

Meeting location

$$Meeting.StartTime$$

Meeting start time

$$Meeting.EndTime$$

Meeting end time

$$Meeting.IsAllDayEvent$$

All day event

$$Meeting.Subject$$

Meeting subject

$$Meeting.Attendee$$

Meeting attendee

$$Meeting.Body$$

Meeting body

$$Meeting.Comment$$

Meeting comment

$$Meeting.MaxItem$$

Maximum agenda items

| Part 4: Managing Agency Communications and Events | 558

Notification Template or Product
Area

MESSAGE_ACA_CONNECT_
LICENSE_APPROVE_OWNER

Variable

Description

$$Meeting.Agenda$$

Meeting agenda ID

$$Meeting.Duration$$

Meeting duration

$$Meeting.NoticeDate$$

Meeting notice date

$$Meeting.Status$$

Meeting status

$$ORIG_Meeting.Type$$

Original meeting type

$$ORIG_Meeting.RespDept$$

Original meeting responsible
person’s department

$$ORIG_Meeting.RespName$$

Original meeting responsible
person’s name

$$ORIG_Meeting.Date$$

Original meeting date

$$ORIG_Meeting.Location$$

Original meeting location

$$ORIG_Meeting.StartTime$$

Original meeting start time

$$ORIG_Meeting.EndTime$$

Original meeting end time

$$ORIG_Meeting.IsAllDayEvent$$

Original meeting all day
event

$$ORIG_Meeting.Subject$$

Original meeting subject

$$ORIG_Meeting.Body$$

Original meeting body

$$ORIG_Meeting.Comment$$

Original meeting comment

$$ORIG_Meeting.MaxItem$$

Original maximum agenda
Items

$$ORIG_Meeting.Agenda$$

Original meeting agenda ID

$$ORIG_Meeting.Duration$$

Original meeting duration

$$ORIG_Meeting.NoticeDate$$

Original meeting notice date

$$ORIG_Meeting.Status$$

Original meeting status

$$publicUserID$$

Public user ID

$$publicUserName$$

Public user Name

$$licenseNumber$$

License number

$$actionType$$

Action type, for example:
approved, rejected,
connected, disconnected.

$$actionDate$$

Action date

$$userId$$

User ID

$$firstName$$

First name (middle name,
last name, business name/
organization name, state,
city, address, or zip) of the
public user. Civic Platform
gets the value from the
public user’s account owner
or from a contact associated
with the user account.
For more information, see
Setting an Associated
Contact as the Account
Owner.

$$middleName$$
$$lastName$$
$$businessName$$
$$state$$
$$city$$
$$address$$
$$zip$$

MESSAGE_ACA_CONNECT_
LICENSE_APPROVE_USER

$$publicUserID$$

Public user ID

| Part 4: Managing Agency Communications and Events | 559

Notification Template or Product
Area

Variable

Description

$$publicUserName$$

Public user name

$$licenseNumber$$

License Number

$$actionType$$

Action type, for example:
approved, rejected,
connected, disconnected.

$$actionDate$$

Action date

$$userId$$

User name

$$firstName$$

First name (middle name,
last name, business name/
organization name, state,
city, address, or zip) of the
public user. Civic Platform
gets the value from the
public user’s account owner
or from a contact associated
with the user account.
For more information, see
Setting an Associated
Contact as the Account
Owner.

$$middleName$$
$$lastName$$
$$businessName$$
$$state$$
$$city$$
$$address$$
$$zip$$

MESSAGE_ACA_CONNECT_
LICENSE_CONNECT_OWNER

$$publicUserID$$

Public user ID

$$publicUserName$$

Public user name

$$licenseNumber$$

License number

$$actionType$$

Action type, for example:
approved, rejected,
connected, disconnected.

$$actionDate$$

Action date

$$userId$$

User ID

$$firstName$$

First name (middle name,
last name, business name/
organization name, state,
city, address, or zip) of the
public user. Civic Platform
gets the value from the
public user’s account owner
or from a contact associated
with the user account.
For more information, see
Setting an Associated
Contact as the Account
Owner.

$$middleName$$
$$lastName$$
$$businessName$$
$$state$$
$$city$$
$$address$$
$$zip$$

MESSAGE_ACA_CONNECT_
LICENSE_CONNECT_USER

$$publicUserID$$

Public user ID

$$publicUserName$$

Public user name

$$licenseNumber$$

License number

$$actionType$$

Action type, for example:
approved, rejected,
connected, disconnected.

$$actionDate$$

Action date

$$userId$$

User ID

| Part 4: Managing Agency Communications and Events | 560

Notification Template or Product
Area

Variable

Description

$$firstName$$

First name (middle name,
last name, business name/
organization name, state,
city, address, or zip) of the
public user. Civic Platform
gets the value from the
public user’s account owner
or from a contact associated
with the user account.
For more information, see
Setting an Associated
Contact as the Account
Owner.

$$middleName$$
$$lastName$$
$$businessName$$
$$state$$
$$city$$
$$address$$
$$zip$$

MESSAGE_ACA_CONNECT_
LICENSE_DISCONNECT_OWNER

$$publicUserID$$

Public user ID

$$publicUserName$$

Public user name

$$licenseNumber$$

License number

$$actionType$$

Action type, for example:
approved, rejected,
connected, disconnected.

$$actionDate$$

Action date

$$userId$$

User ID

$$firstName$$

First name (middle name,
last name, business name/
organization name, state,
city, address, or zip) of the
public user. Civic Platform
gets the value from the
public user’s account owner
or from a contact associated
with the user account.
For more information, see
Setting an Associated
Contact as the Account
Owner.

$$middleName$$
$$lastName$$
$$businessName$$
$$state$$
$$city$$
$$address$$
$$zip$$

MESSAGE_ACA_CONNECT_
LICENSE_DISCONNECT_USER

$$publicUserID$$

Public user ID

$$publicUserName$$

Public user name

$$licenseNumber$$

License number

$$actionType$$

Action type, for example:
approved, rejected,
connected, disconnected.

$$actionDate$$

Action date

$$userId$$

User ID

| Part 4: Managing Agency Communications and Events | 561

Notification Template or Product
Area

Variable

Description

$$firstName$$

First name (middle name,
last name, business name/
organization name, state,
city, address, or zip) of the
public user. Civic Platform
gets the value from the
public user’s account owner
or from a contact associated
with the user account.
For more information, see
Setting an Associated
Contact as the Account
Owner.

$$middleName$$
$$lastName$$
$$businessName$$
$$state$$
$$city$$
$$address$$
$$zip$$

MESSAGE_ACA_CONNECT_
LICENSE_REJECT_OWNER

$$publicUserID$$

Public user ID

$$publicUserName$$

Public user name

$$licenseNumber$$

License number

$$actionType$$

Action type, for example:
approved, rejected,
connected, disconnected.

$$actionDate$$

Action date

$$userId$$

User ID

$$firstName$$

First name (middle name,
last name, business name/
organization name, state,
city, address, or zip) of the
public user. Civic Platform
gets the value from the
public user’s account owner
or from a contact associated
with the user account.
For more information, see
Setting an Associated
Contact as the Account
Owner.

$$middleName$$
$$lastName$$
$$businessName$$
$$state$$
$$city$$
$$address$$
$$zip$$

MESSAGE_ACA_CONNECT_
LICENSE_REJECT_USER

$$publicUserID$$

Public user ID

$$publicUserName$$

Public user name

$$licenseNumber$$

License number

$$actionType$$

Action type, for example:
approved, rejected,
connected, disconnected.

$$actionDate$$

Action date

$$userId$$

User ID

| Part 4: Managing Agency Communications and Events | 562

Notification Template or Product
Area

Variable

Description

$$firstName$$

First name (middle name,
last name, business name/
organization name, state,
city, address, or zip) of the
public user. Civic Platform
gets the value from the
public user’s account owner
or from a contact associated
with the user account.
For more information, see
Setting an Associated
Contact as the Account
Owner.

$$middleName$$
$$lastName$$
$$businessName$$
$$state$$
$$city$$
$$address$$
$$zip$$

MESSAGE_AUTOMATED_
PLANREVIEW

$$planList$$

Plan list

MESSAGE_NOTICE_LICENSE_
EXPIRED

$LICENSETYPE$

[Case sensitive] License
type

$STATELICENSENO$

[Case sensitive] State
license number

$LICENSESTATE$

[Case sensitive] License
state

$LICENSELASTRENEWALDATE$

[Case sensitive] License last
renewal date

$LICENSEEXPIRATIONDATE$

[Case sensitive] License
expiration date

$FIRSTNAME$

[Case sensitive] First name

$MIDDLENAME$

[Case sensitive] Middle
name

$LASTNAME$

[Case sensitive] Last name

$INSURANCECOMPANY$

[Case sensitive] Insurance
company

$POLICYNUMBER$

[Case sensitive] Policy
number

$INSURANCEEXPIRATIONDATE$

[Case sensitive] Insurance
expiration date

$BUSINESSLICENSENO$

[Case sensitive] Business
license #

$BUSINESSLICENSEEXPDATE$

[Case sensitive] business
License expiration date

$CAPID$ / $$CAPID$$

Record ID

$PERMITID$ / $$PERMITID$$

Permit ID

$PERMITAPPTYP$ / $$PERMITAPPTYP$$

Permit type

$PERMITADDR$ / $$PERMITADDR$$

Permit address

$PERMITPARCEL$ / $$PERMITPARCEL$$

Permit parcel

MESSAGE_NOTICE_RESULT_
INSPECTION

$PERMITWRKDESC$ / $$PERMITPARCEL$$ Permit work description
$INSPITEM$ / $$INSPITEM$$

Inspection item

$INSPRESULT$ / $$INSPRESULT$$

Inspection result

$INSPCOMMENT$ / $$INSPCOMMENT$$

Inspection comment

| Part 4: Managing Agency Communications and Events | 563

Notification Template or Product
Area

MESSAGE_PAYMENT_NOTICE_


MESSAGE_REPORT

Variable

Description

$COMPLETEDATE$ / $$COMPLETEDATE$$

Inspection completed on

$$servProvCode$$

Agency ID; Service Provider
Code

$$capID$$

Record ID

$$balance$$

Balance due

$$accelaFee$$

Amount of fee

$$totalFee$$

Total of all fees

$$altID$$

Alt record ID

$$userName$$

User’s display name

$$userID$$

Public user ID

$$servProvCode$$

Agency ID; Service Provider
Code

$$email$$

Public user's email

$$CAPID$$

Record ID

$PERMITID$

Permit ID

$$CAPDETAIL$$

Record detail

$PERMITDETAIL$

Permit detail

$$CAPAPPTYPE$$

Record type

$PERMITAPPTYP$

Permit type

$$CAPNAME$$

Application name

$PERMITNAME$

Application name

$$CAPSTATUS$$

Record status

$PERMITSTATUS$

Permit status

$$CAPADDR$$

Record address

$PERMITADDR$

Permit address

$$CAPPARCEL$$

Record parcel

$PERMITPARCEL$

Permit parcel

$$CAPWRKDESC$$

Record work description

$PERMITWRKDESC$

Permit work description

$$INSPITEM$$ / $INSPITEM$

Inspection item

$$INSPRESULT$$ / $INSPRESULT$

Inspection result

$$INSPCOMMENT$$ / $INSPCOMMENT$

Inspection comment

$$firstName$$

First name (middle name,
last name, business name/
organization name, state,
city, address, or zip) of the
public user. Civic Platform
gets the value from the
public user’s account owner
or from a contact associated
with the user account.
For more information, see
Setting an Associated
Contact as the Account
Owner.

$$middleName$$
$$lastName$$
$$businessName$$
$$state$$
$$city$$
$$address$$
$$zip$$

MESSAGE_SEND_PASSWORD

$$userID$$

Public user ID

| Part 4: Managing Agency Communications and Events | 564

Notification Template or Product
Area

Variable

Description

$$servProvCode$$

Agency ID; Service Provider
Code

$$email$$

Public user's email

$$password$$

Public user's password

$$firstName$$

First name (middle name,
last name, business name/
organization name, state,
city, address, or zip) of the
public user. Civic Platform
gets the value from the
public user’s account owner
or from a contact associated
with the user account.
For more information, see
Setting an Associated
Contact as the Account
Owner.

$$middleName$$
$$lastName$$
$$businessName$$
$$state$$
$$city$$
$$address$$
$$zip$$

NOTICE_OF_BATCH_JOB_
COMPLETED

Workflow Email Notification, defined
in Classic Administration > Workflow
> Messages

$$JobName$$

Batch job name

$$Result$$

Batch job result

$$EndTime$$

Batch job end time

$$CAPID$$ / $PERMITID$

Record or permit ID

$$CAPDETAIL$$ / $PERMITDETAIL$

Record or permit detail

$$CAPAPPTYPE$$ / $PERMITAPPTYP$

Record or permit type

$$CAPNAME$$ / $PERMITNAME$

Record or permit name

$$CAPSTATUS$$ / $PERMITSTATUS$

Record or permit status
value

$$CAPADDR$$ / $PERMITADDR$

Record or permit address

$$CAPPARCEL$$ / $PERMITPARCEL$

Record or permit parcel

$$CAPWRKDESC$$ / $PERMITWRKDESC$

Record or permit work
description

$$TASK$$ / $TASK$

Record or permit task info

$$TASKSTATUS$$ / $TASKSTATUS$

Record or permit task status

$$TASKCOMMENTS$$ / $TASKCOMMENTS
$

Record or permit task
comments

$$TASKACTIONBY$$ / $TASKACTIONBY$

Record or permit task action
by

$$TASKSPECIFICINFO$$ /
$TASKSPECIFICINFO$

Record or permit task
specific info

$$AltID$$

Alt ID

$$RecordID$$

Record ID

$$AgencyComment$$

Agency comment

$$capId1$$

Record ID1

$$capId2$$

Record ID2

$$capId3$$

Record ID3

Record Request Update Comment

| Part 4: Managing Agency Communications and Events | 565

Notification Template or Product
Area

Variable

Description

$$agencyCode$$

Agency code

$$module$$

Module name

Customizing the Content of Agency Communications
You can customize the content of the following communications:
•

Email and SMS text message notifications, meeting and calendar requests, and Citizen Access email
announcements
To customize this type of communication, see Working with Notification Templates.

•

Receipts and endorsements
To customize this type of communication, use the Content Customize portlet, described in this topic.

Civic Platform generates receipts or endorsements after you process a payment. Civic
Platform has default settings for all receipts and endorsements, with the exception of
TRUSTACCOUNT_RECEIPT_SUMMARY. You can use the Content Customize feature to create your own
design for receipts and endorsements. The customized design overrides the default settings with its own
look and level of specificity.
Example Use Case
You design the set payment receipt to include the fee items paid and the remaining set balance, along
with other payment details. After you save the design, all set payment receipts generated in Civic Platform
conform to the new design.
Topics
•

Adding or Updating a Customized Content

•

Working in the Content Editor

Adding or Updating a Customized Content
You can customize the content for several content types. Civic Platform can only apply one design for a
content type. After you create your own design for a content type, you can either update based on the
existing design, or clear the design to return to Civic Platform's original design.
This section describes how to add or update a customized content.
To add or update a customized content
1. Access the Content Customize portlet (Navigating to the Setup Portlet).
2. Complete the fields as necessary (Working in the Content Editor).
3. Click Save.

Working in the Content Editor
Use the WYSIWYG content editor (Figure 33: Content Editor in Content Customize) to design content and
display formats.

| Part 4: Managing Agency Communications and Events | 566

Figure 33: Content Editor in Content Customize
Topics
•

Editing Text in the Editor

•

Using Variables in Customized Content

•

Example Customized Content

Editing Text in the Editor
With the text toolbar in the editor, you can customize fonts and the way to organize your text.
To edit text in the editor
1. Position your cursor where you want in the editor, and then enter the text which you want to add.
2. Highlight the text which you want to edit, and then use the text toolbar to edit text properties such as
font type, font size, font color, and text alignment.
•

You can add variables to include dynamic content in the receipts or endorsement.
For the variables that you can include in the receipt and endorsement content type, refer to Using
Variables in Customized Content.

•

You can add a table in the text area, and organize the payment information in a tabular way.
1. Click the Insert Table button in the toolbar.
Civic Platform displays the Insert Table dialog.

2. Enter the number of rows and columns in the text boxes, and configure the layout and spacing
settings.
3. Click OK.
Civic Platform adds the table at where the cursor was.

| Part 4: Managing Agency Communications and Events | 567

4. Enter the information you want to include in the table, and add variables in the table cells, as
appropriate.
5. Continue editing the remaining content.
3. For edits to the text alignment of invoices, be aware of the following:
•

All fee item variable descriptions use left alignment, except “Total Invoice Amount,” “Total Payment,”
and “Balance.”

•

Descriptions of the other variables (including date, operator ID, permit ID, and so forth) use left
alignment.

•

All fee amounts use right alignment.
Note:
If you add a content type (RECEIPT_SUMMARY, SET_CHECK_ENDORSEMENT,
SET_RECEIPT_SUMMARY, TRANSACTION_CHECK_ENDORSEMENT,
TRANSACTION_RECEIPT_SUMMARY, TRUSTACCOUNT_CHECK_ENDORSEMENT, and
TRUSTACCOUNT_RECEIPT_SUMMARY) as a Standard Choice Value in the Standard Choice
APPLY_SYSTEM_DEFAULT_FORMAT, Civic Platform follows its own default alignment style,
instead of the alignment customized here, to generate the corresponding receipts or endorsements.
The Standard Choice APPLY_SYSTEM_DEFAULT_FORMAT only affects the alignment style of the
receipts, but not the content.

4. Click Save to save your changes.

Using Variables in Customized Content
You can use variables in any position of the customized content. This section provides the lists of variables
that you can include in receipts and endorsement. See the following lists for details:
•

Table 108: APPLICATION_ENDORSEMENT Variables

•

Table 109: CHECK_ENDORSEMENT Variables

•

Table 110: CHECK_RECEIPT Variables

•

Table 111: CREDITCARD_RECEIPT Variables

•

Table 112: RECEIPT_SUMMARY Variables

•

Table 113: SET_CHECK_ENDORSEMENT and SET_RECEIPT_SUMMARY Variables

•

Table 114: TRANSACTION_CHECK_ENDORSEMENT Variables

•

Table 115: TRANSACTION_RECEIPT_SUMMARY Variables

•

Table 116: TRUSTACCOUNT_RECEIPT_SUMMARY and
TRUSTACOUNT_CHECK_ENDORSEMENT Variables

To gain a visual understanding on how the variables affect the generated receipt or endorsement, see
Example Customized Content.
Table 108: APPLICATION_ENDORSEMENT Variables

$businessDate$

The date of payment.

$contactName$

The contact name of the payer who makes the payment.

| Part 4: Managing Agency Communications and Events | 568

$contactType

The contact type of the contact.

$permitNBR$

The record number.

$refContactID$

The reference contact ID number.

$todayDate$

The current date.

$transNBR$

The transaction number.

Table 109: CHECK_ENDORSEMENT Variables

$adminFeeDue$

The administrator fee. This value is always 0.

$balance$

The difference between the amount of money invoiced and the
amount of money paid; the balance due.

$businessDate$

The date of payment.

$cashDrawerID$

The cashier's drawer ID number.

$changeDue$

The balance if the payment amount is more than the amount due.

$checkAmount$

The check amount.

$checkTendered$

The money received from check.

$operateID$

The cashier's user ID.

$payerContactType$

The contact type of the payer.

$payerName$

The payer name.

$payerRefContactID$

The reference contact ID of the payer.

$paymentMethodAndAmount$

The payment method and payment amount.

Pemit Fee Due

The value can be 'Permit', 'Licenses' or 'Gen/Var'.
Note:
Unlike other variables, this variable uses no “$$”
delimiters.

$permitFeeDue$

The fee due in the record.

$permitNBR$

The record number.

$receiptNbr$

The receipt number.

$refNBR$

If the payment method was a check or some other document,
such as a money order, this is the check number or number that
appears on the document.

$sessionNbr$

The cashier session sequence number.

$todayDate$

The current date.

$totalAmtPaid$

The total payment amount.

$totalInvoice$

The total invoice amount.

$totalPaid$

The total amount already paid.

$transNBR$

The transaction number.

Table 110: CHECK_RECEIPT Variables

$authorizationCode$

The check authorization code.

$batchNumber$

The batch number of the invoice.

$businessDate$

The date of payment.

$cashDrawerID$

The cashier's drawer ID number.

| Part 4: Managing Agency Communications and Events | 569

$checkNumber$

The check number.

$checkType$

The check type.

$convenienceFee$

A fee assessed to cover the cost of processing.

$feeDue$

The fee due.

$hostCode$

The authorization code returned from third party

$objectID$

The ID of the record or set for which a user is processing
payment.

$objectType$

The entity type (such as record) for which a user is processing
payment.

$operatorID$

The cashier's user ID.

$processingFee$

The processing fee.

$referenceID$

If the payment method was a check or some other document,
such as a money order, this is the check number or number that
appears on the document.

$totalAmount$

The total payment amount.

$transactionID$

The transaction ID.

Table 111: CREDITCARD_RECEIPT Variables

$authorizationCode$

The credit card authorization code.

$batchNumber$

The batch number of the invoice.

$businessDate$

The date of payment.

$cardNumber$

The credit card number.

$cardType$

The credit card type.

$cashDrawerID$

The cashier's drawer ID number.

$convenienceFee$

A fee assessed to cover the cost of processing.

$feeDue$

The fee due.

$hostCode$

The authorization code returned from third party

$objectID$

The ID of the record or set for which a user is processing
payment.

$objectType$

The entity type for which a user is processing payment. Allowable
values are: SET, Permit, POS, Trust Account, Transaction or
Group.

$operatorID$

The cashier's user ID.

$processingFee$

The processing fee.

$referenceID$

If the payment method was a check or some other document,
such as a money order, this is the check number or number that
appears on the document.

$totalAmount$

The total payment amount.

$transactionID$

The transaction ID.

Table 112: RECEIPT_SUMMARY Variables

$adminFeeDue$

The administrator fee. This value is always 0.

$balance$

The difference between the amount of money invoiced and the
amount of money paid; the balance due.

| Part 4: Managing Agency Communications and Events | 570

$businessDate$

The date of payment.

$cashDrawerID$

The cashier's drawer ID number.

$changeDue$

The balance if the payment amount is more than the amount due.

$checkAmount$

The check amount.
Note:
You can replace “check” with another payment method
in the variable name, for example, $cashAmount$. The
variable stands for the amount by the payment method.

$checkTendered$

The money received from check.

$feeItems$

The fee items.

$operateID$

The cashier's user ID.

$paymentMethodAndAmount$

The payment method and payment amount.

Pemit Fee Due

The value can be 'Permit', 'Licenses' or 'Gen/Var'.
Note:
Unlike other variables, this variable uses no “$$”
delimiters.

$permitNBR$

The record number.

$receiptNbr$

The receipt number.

$receivedType$

The form of payment.

$refNBR$

If the payment method was a check or some other document,
such as a money order, this is the check number or number that
appears on the document.

$sessionNbr$

The cashier session sequence number.

$todayDate$

The current date.

$totalAmtPaid$

The total payment amount.

$totalInvoice$

The total invoice amount.

$totalPaid$

The total amount already paid.

$transNBR$

The transaction number.

Table 113: SET_CHECK_ENDORSEMENT and SET_RECEIPT_SUMMARY Variables

$adminFeeDue$

The administrator fee. This value is always 0.

$balance$

The difference between the amount of money invoiced and the
amount of money paid; the balance due.

$businessDate$

The date of payment.

$cashDrawerID$

The cashier's drawer ID number.

$changeDue$

The balance if the payment amount is more than the amount due.

$checkAmount$

The check amount.

$checkAmount$

The check amount.
Note:
You can replace “check” with another payment method
in the variable name, for example, $cashAmount$. The
variable stands for the amount by the payment method.

$checkTendered$

The money received from check.

| Part 4: Managing Agency Communications and Events | 571

$feeItems$

The fee items.
Note:
This variable is applicable in
SET_RECEIPT_SUMMARY, not in
SET_CHECK_ENDORSEMENT.

$operateID$

The cashier's user ID.

$paymentMethodAndAmount$

The payment method and payment amount.

$permitFeeDue$

The fee due in the record.

$receiptNbr$

The receipt number.

$receivedType$

The form of payment.
Note:
This variable is applicable in
SET_RECEIPT_SUMMARY, not in
SET_CHECK_ENDORSEMENT.

$refNBR$

If the payment method was a check or some other document,
such as a money order, this is the check number or number that
appears on the document.

$sessionNbr$

The cashier session sequence number.

$setId$

The identification number of the set for which you are processing
payment.

$setName$

The name of the set for which you are processing payment.

$todayDate$

The current date.

$totalAmtPaid$

The total payment amount.

$totalInvoice$

The total invoice amount.

$totalPaid$

The total amount already paid towards the set invoice.

$transNBR$

The transaction number.

Table 114: TRANSACTION_CHECK_ENDORSEMENT Variables

$businessDate$

The date of payment.

$cashierDrawID$

The cashier's drawer ID number.

$forPermitNbr$

The record number for which a user is processing payment.

$forPOSTransNbr$

The POS transaction number for which a user is processing
payment.

$paymentMethodAndAmount$

The payment method and payment amount.

$receiptNbr$

The receipt number.

$sessionNbr$

The cashier session sequence number.

$todayDate$

The current date.

$totalAmtPaid$

The total payment amount.

Table 115: TRANSACTION_RECEIPT_SUMMARY Variables

$adminFeeDue$

The administrator fee. This value is always 0.

$ATMTendered$

The money received from ATM.

$balance$

The difference between the amount of money invoiced and the
amount of money paid; the balance due.

| Part 4: Managing Agency Communications and Events | 572

$billedTendered$

The money received from bill.

$businessDate$

The date of payment.

$cashierDrawID$

The cashier's drawer ID number.

$cashTendered$

The money received from cash.

$changeDue$

The balance if the payment amount is more than the amount due.

$checkTendered$

The money received from check.

$couponTendered$

The money received from a coupon.

$creditCardTendered$

The money received from a credit card.

$currentAmtPaid$

The current amount paid.

$debitCardTendered$

The money received from a debit card.

$feeItems$

The fee items.

$forPermitNbr$

The record number for which a user is processing payment.

$forPOSTransNbr$

The POS transaction number for which a user is processing
payment.

$internalTransferTendered$

The money received from internal transfer.

$journalEntryTendered$

The money received from journal entry.

$lockboxTendered$

The money received from a lock box.

$miscCreditTendered$

The money received from miscellaneous credit.

$moneyOrderTendered$

The money received from money order.

$multipleTendersTendered$

The money received from multiple tenders.

$operatorID$

The cashier's user ID.

$otherTendered$

The money received from other payment methods.

$permitFeeDue$

The fee due in the record.

$receiptNbr$

The receipt number.

$receivedType$

The form of payment.

$sessionNbr$

The cashier session sequence number.

$todayDate$

The current date.

$totalAmtPaid$

The total payment amount.

$totalInvoiceAmount$

The total invoice amount.

$totalPayment$

The total amount already paid.

$trustAccountTendered$

The money received from trust account.

$unapplied$

The unapplied credit.

$waiverTendered$

The money received from waiver.

$writeOffTendered$

The money received from write off.

Table 116: TRUSTACCOUNT_RECEIPT_SUMMARY and TRUSTACOUNT_CHECK_ENDORSEMENT Variables

$accountBalance$

The balance of the trust account.

$accountNBR$

The trust account ID number for the trust account.

$amount$

The payment amount.

$businessDate$

The date of payment.

$cashDrawerID$

The cashier's drawer ID number.

| Part 4: Managing Agency Communications and Events | 573

$refNBR$

If the payment method was a check or some other document, such as a money
order, this is the check number or number that appears on the document.

$sessionNbr$

The cashier session sequence number.

$tenderType$

The payment type.

$todayDate$

The current date.

$transComments$

The comments added in the transaction.

$transNBR$

The transaction number.

$transType$

The transaction type.

Example Customized Content
The following code snippet is an example of the content for the RECEIPT_SUMMARY content type:
The functioning variables for RECEIPT_SUMMARY are as following:
--------------Record Receipt Summary Template
Session Nbr: $sessionNbr$
Trans NBR: $transNBR$
For Permit Nbr: $permitNBR$
Business Date: $businessDate$
Today Date: $todayDate$
Permit Fee Due: $permitFeeDue$
Admin Fee Due: $adminFeeDue$
Total Amt Paid: $totalAmtPaid$
Operate ID: $operateID$
CashDrawerID: $cashDrawerID$
Fee Items
$feeItems$
Total Invoice Amount: $totalInvoice$
Total Payment: $totalPaid$
Balance: $balance$
---------------$paymentMethodAndAmount$
Change Due: $changeDue$
Cash Tendered: $cashAmount$
Check Tendered: $checkAmount$ (Ref#$checkTendered$)
Ref: $refNBR$
payor:$payor$
With the previous example, Civic Platform generates the receipt summary for a record, as illustrated in
Figure 34: Example Receipt Summary .

| Part 4: Managing Agency Communications and Events | 574

Figure 34: Example Receipt Summary

| Part 4: Managing Agency Communications and Events | 575

Setting Up Calendars
Civic Platform provides the following four calendar types:
•

Inspection

•

Meeting

•

Agency Holiday

•

User

You can configure these calendars so that agency users can schedule meetings, inspections, and so forth.
Click a topic title below for full details.
Related Information
Configuring Calendars
Working with Calendars
Setting Up and Maintaining Calendars
Setting Up and Maintaining Supervisors
Setting Up and Maintaining Meeting Types
Scenarios
Managing Calendar Items though the Calendar Portlet

Configuring Calendars
Before you can create, access and use calendars, configure the appropriate Function Identifications (FIDs)
and Standard Choices. Refer to the Accela Civic Platform Configuration Reference. Inspection calendars
require additional setup before use.

Working with Calendars
After you configure the calendars, most calendar related operations take place in the calendar
administration portlet.
Topics
•

Finding a Calendar

•

Viewing Daily, Weekly, and Monthly Calendars

•

Printing a Calendar

•

Cloning and Copying Calendars

•

Assigning Daily Units

•

Scheduling Calendar Items

| Part 4: Managing Agency Communications and Events | 576

Finding a Calendar
You can navigate calendars by type, name, permission, or inspection type. You can also search for a
calendar by different search criteria.
You can find an existing calendar by expanding and navigating the calendar portlet search for a user
calendar to modify calendar details and scheduled user leaves.
To find calendar
1. Access the Calendar Administration portlet (Accessing the Calendar Administration Portlet).
Civic Platform displays a portlet for navigating or searching calendars.

•

To navigate to a calendar by type, expand the calendar categories on the left side panel until you
find the calendar.

•

Click Search to find a calendar by specifying search criteria.
Civic Platform displays the Calendar search page.

a. Complete the fields and click Submit. For a complete list of Calendar search fields, see Table 124:
Calendar Search Fields.
Civic Platform displays the calendars that match your search criteria in the Calendar list portlet.
Note:
You can use search to locate inactive holiday calendars.

Viewing Daily, Weekly, and Monthly Calendars
Each calendar provides Daily, Weekly, and Monthly tabs to view different time frames of scheduled
calendar items.
To view a calendar
1. Find the calendar you want to view (Finding a Calendar).
2. Click the Daily tab.
Civic Platform displays start time, end time, the calendar type, and the name of the calendar items
scheduled for the current day.

| Part 4: Managing Agency Communications and Events | 577

•

Click the link in the calendar item column to display the schedule details.

•

Click the New button to schedule a calendar item (Assigning Daily Units).

•

Click the option to select a calendar item and delete the item or perform one Menu button
operations.

3. Click the Weekly tab.
Civic Platform displays calendar items scheduled for the current week.

•

Click the link for the calendar item to display the schedule details.

•

Click the left and right arrows at the top of the calendar to page through the weeks.

•

Click Show all items for calendars to display all calendar items (Creating Master Calendars).

•

Click the New button to schedule a calendar item (Assigning Daily Units).

•

Hover over the Menu button and select one of the operations to perform on the calendar.

4. Click the Monthly tab.
Civic Platform displays calendar items scheduled for the current month.

| Part 4: Managing Agency Communications and Events | 578

•

Click the link for the calendar item to display the schedule details.

•

Click the left and right arrows at the top of the calendar to page through the months.

•

Click the New button to schedule a calendar item (Assigning Daily Units).

•

Click Show all items for calendars to display all calendar items (Creating Master Calendars).

•

Hover over the Menu button and select one of the operations to perform on the calendar.

Printing a Calendar
You can print calendars from the Weekly or Monthly Calendar views. Calendars print exactly as they
display. For example, if you print a calendar from the Weekly Calendar view, then the calendar prints the
week in view. This same logic applies to monthly calendar views.
To print a calendar
1. Find the calendar you want to print (Finding a Calendar).
2. Click the Weekly or Monthly tab.
Based on the tab you click, Civic Platform displays the Weekly or Monthly calendar view.
3. Click Print.
Accela displays a printable version of the calendar in your browser window.
4. Choose File and select Print from your browser menu.

Cloning and Copying Calendars
Use the clone feature and the copy feature to apply standard block-out dates, times, and other calendar
details to multiple calendars. Clone a calendar to create a new, duplicate calendar. When you clone a
calendar, you specify the source calendar content you want to include in the new calendar, including block
out days, holidays, weekends, and other shared information. Copy a calendar to duplicate source calendar
details, such as block out days, holidays, and meetings, to an existing target calendar.

| Part 4: Managing Agency Communications and Events | 579

Use Case Example
You have holidays that apply to all departments in your agency. You can set up holidays in one calendar
and copy this information to other calendars.
To clone or copy a calendar
1. Find the calendar you want to clone or copy (Finding a Calendar).
2. Clone the calendar by completing one of these actions:
•

From the navigation tree, right-click on the calendar you want to clone and choose Clone Calendar
or Copy Calendar from the drop-down list.

•

From the Calendar detail portlet, hover over the Menu button and choose Clone Calendar or Copy
Calendar from the drop-down list.
Civic Platform displays the clone (shown) or copy calendar portlet.

3. Complete Calendar Name (for clone) or Copy To Calendar (for copy) field:
Calendar Name

When cloning a calendar, enter a unique name to identify the new calendar.

Copy To Calendar

When copying a calendar, enter the name of the calendar to which to copy the select
includes.

4. Choose the source items you want to include from the cloned or copied calendar. The type of calendar
that you clone or copy, such as an inspection or meeting, determines the type of information you can
clone or copy (Table 117: Cloning and Copying Calendar Includes).
Table 117: Cloning and Copying Calendar Includes

Block Out Days

Inspection and User calendars.

Districts

Inspection calendars.

Meetings

Meeting calendars.

Meeting Agenda

Meeting calendars.

Meeting Attendees

Meeting calendars.

Holidays

Agency Holiday calendar

Inspection Calendar Items

Inspection calendars.

Inspections

Inspection calendars. Copies or clones inspection block out periods.

Permissions

Inspection and Meeting calendars.

Weekend

Agency Holiday calendar. Copies or clones weekend block out periods.

5. Click Submit.
Civic Platform creates the cloned calendar or copies the included information to the specified calendar.

| Part 4: Managing Agency Communications and Events | 580

Assigning Daily Units
When you create a calendar, you set the default number of time blocks (units) you can schedule per day
in the #Units Allocated per Time Range field (Table 119: Calendar Detail Field Descriptions). This #Units
Allocated per Time Range field gets its default value from the daily unit setting you assign in the calendar.
To assign daily units
1. Find the calendar you want to modify (Finding a Calendar).
2. Click the Daily, Weekly, or Monthly tab.
3. Hover over the Menu button and select Assign Daily Units from the drop-down list.
Civic Platform displays the Assign Daily Units portlet.

4. Select the date for which you want to assign a special unit. The value in the # Units Allocated per Day
field determines the default number of units in a date.
Note:
The portlet lists all the dates in the current month by default. Click the calendar icon above the date list to
retrieve the dates of a different month.

5. Modify the unit value in the Units column, as required.
6. Click the Submit.
Civic Platform updates the daily unit settings.

Scheduling Calendar Items
You can schedule calendar items in the Daily, Weekly, or Monthly tab for any of the calendar types:
•

Inspection

| Part 4: Managing Agency Communications and Events | 581

•

Event

•

Hearing

•

Agency Holiday

•

User

•

Meeting

To schedule a calendar item
1. Find the calendar you want to modify (Finding a Calendar).
2. Click the Daily, Weekly, or Monthly tab.
3. Click the New button.
Civic Platform displays the Calendar Item portlet.
4. Complete the fields that display. For a complete list of the fields that display, see Table 118: Calendar
Item Field Descriptions.
5. Click the Submit button.
Table 118: Calendar Item Field Descriptions

All-Day Event

Mark this check box if you want the calendar item you schedule to occupy the entire
calendar day on which it is scheduled. When you mark this check box, the Start
Time and End Time drop-down lists are greyed out.

Calendar Item

Enter a distinct name for the calendar item you want to schedule.

Comments

Enter comments related to the calendar item you schedule. For example, if you are
scheduling a hearing, you might want to enter a hearing description, such as, “Plan
review for proposed subdivision.”

Date

Use the Date button to choose a day to schedule the calendar item or type in the
calendar item date.

End Recurrence

If you are scheduling a recurring calendar item, indicate when you want to end the
recurring calendar item. To continue a calendar item indefinitely, leave this field
empty.

End Time

Select the calendar item end-time using the drop-down list.

Hearing Body

This field appears only when you schedule a calendar item on a hearing calendar.
Enter the name of the hearing body that will attend the hearing. For example, you
might enter Planning Commission or Land Use Appeals Board. A hearing body
is an individual or a group of people responsible for reviewing applications in a
public setting, such as planning commission or land use appeals board members.
Hearing body members mediate hearings and might be required to reject or accept
applications based on the hearing results.

Location

This field appears only when you schedule a calendar item on a hearing calendar.
Select the hearing location from this drop-down list. The values that populate this
list are determined by the Standard Choice, HEARING LOCATION (see the Accela
Civic Platform Configuration Reference).

Maximum Items

This field appears only when you schedule a calendar item on a hearing calendar.
Enter the maximum number of applications that can be reviewed at the hearing.

Maximum Agenda Items

This field appears only when you schedule a calendar item on a meeting calendar.
Enter the maximum number of agenda items that can be reviewed at the meeting.

| Part 4: Managing Agency Communications and Events | 582

Meeting Body

This field appears only when you schedule a calendar item on a meeting calendar.
Select the meeting body from the drop-down list. The values that populate this list
are determined by the Standard Choice, MEETING BODY (see the Accela Civic
Platform Configuration Reference).

Meeting Status

This field appears only when you schedule a calendar item on a meeting calendar.
Select the status of the meeting, such as Approved or Pending. The displayed
values depend on the status group for the meeting type determined by the Standard
Choice MEETING_TYPE_STATUS_{Group Name} (see the Accela Civic Platform
Configuration Reference).

Meeting Type

This field appears only when you schedule a calendar item on a meeting calendar.
Select the type of the meeting from the drop-down list. Civic Platform only displays
those meeting types for which you have permission.

Organizer

This field appears only when you schedule a calendar item on a meeting calendar.
This field is read-only, and displays the current user as the organizer of the meeting
calendar item.

Recurrence - None

Mark the radio button if you are scheduling a one-time calendar item.

Notice Date

This field appears only when you schedule a calendar item on a hearing calendar.
Enter the date when you want a hearing notice e-mailed to designated recipients.
You determine the hearing notice e-mail recipients in the Send Email Notification To
drop-down list.

Recurrence - Repeat every
day(s)

To repeat a calendar item over a certain number of days, select this option and
enter the number of days between each calendar item.

Recurrence - Repeat every
week(s) on

To repeat a calendar item over a certain number of weeks, select this option, enter
the number of weeks between each calendar item, and choose the day of the week
when you want the calendar item to occur.

Recurrence - Repeat every
month(s) on

To repeat a calendar item over a certain number of months, select this option, enter
the number of months between each calendar item, and choose the day of the
week when you want the calendar item to occur.

Recurrence - Repeat every
year(s)

To repeat a calendar item over a certain number of years, select this option and
enter the number of years between each calendar item.

Reminder

This field appears only when you schedule a calendar item on a meeting calendar.
Specifies the number of days, before the meeting, to send out a reminder
notification.

Responsible Person

This field appears only when you schedule a calendar item on a meeting calendar.
Select the responsible person for the meeting. Click Current User to populate this
field with the current user’s name.

Send E-mail Notification To

This field appears only when you schedule a calendar item on a hearing calendar.
When a hearing is scheduled, a hearing notice can be e-mailed to designated
recipients. Select a value from this drop-down list to determine the hearing notice email recipients. You can choose from these values:
All Licensed Professionals and Contacts
Contacts
Licensed Professionals
Primary Licensed Professional and Contact

Start Time

Select the starting time for the calendar item using the drop-down list.

| Part 4: Managing Agency Communications and Events | 583

Status

This field appears only when you schedule a calendar item on a hearing calendar.
Select a value from this drop-down list to determine the status of the hearing
calendar item, such as Approved or Pending. The values that displays in this dropdown list are determined by the status group you set for the hearing calendar item
type. You associate a status group with a hearing calendar item type in the Event
Type Maintenance portlet.

Subject

This field appears only when you schedule a calendar item on a meeting calendar.
Enter the subject of the meeting.

Type

Select a value from this drop-down list to classify the type of calendar item you
schedule. For example, you might set Inspection, Hearing, Holiday, Block-out, and
Weekend as values in this drop-down list.
You configure the values for this drop-down list in the Event Type Maintenance
portlet. When you set up an event type, you designate the calendar the event type
applies to in the Calendar Type drop-down list.

# Units Allocated Per Time
Range

This field appears only when you schedule a calendar item on an inspection
calendar.
Enter a number to define the maximum number of inspections that users can
schedule within the time range defined in the calendar item.
Note:
The field gets its default value from the daily unit setting (Assigning Daily
Units). If you change the value, the setting in the # Units Allocated Per
Time Range field overrides the daily unit setting.
Regardless of whether FID 8400 is enabled or disabled, when users
schedule an inspection (using or not using the auto-assign functionality),
Civic Platform calculates the available units before scheduling, specifically:

Units Displayed in ACA

•

Calculating the available inspection units against the # Units Allocated
Per Time Range setting;

•

Calculating the available inspector units against the Daily Inspection
Units setting in the inspector user profile.

This field appears only when you schedule an inspection type calendar item. It
identifies the number of time blocks (units) displayed for a daily calendar item in
Citizen Access.
The default value of the field depends on the setting of the ACA Schedule Time
Block of the calendar in which the calendar item is created:
If the ACA Schedule Time Block field is not configured, you can enter the number of
block units to be included in the calendar item in the Units Displayed in ACA field.
If the ACA Schedule Time Block field is configured, the default value of Units
Displayed in ACA = Available time in the calendar item / ACA Schedule Time Block.
For description of the ACA Schedule Time Block field, see Table 119: Calendar
Detail Field Descriptions.

Votes By Body Members

This field appears only when you schedule a calendar item on a hearing calendar.
Mark an option to indicate whether or not the hearing body members who attend
the hearing will vote on the applications they review.

| Part 4: Managing Agency Communications and Events | 584

Setting Up and Maintaining Calendars
Civic Platform manages four calendar types (Inspection, Meeting, Agency Holiday, and User). Civic
Platform uses the same process for setting up different type calendars. Where applicable, the procedures
in this section detail these differences.

Topics:
•

Creating a Calendar

•

Modifying Calendar Details

•

Assigning Calendar Permissions

•

Assigning Districts

•

Assigning and Removing Inspection Types

•

Assigning Inspectors from the Supervisor Calendars

Creating a Calendar
Civic Platform provides the following four calendar types:
•

Inspection

•

Meeting

•

Agency Holiday

•

User

Use this procedure to create instances of any of the calendar types listed.
To create a new calendar
1. Access the Calendar Administration portlet (Accessing the Calendar Administration Portlet).
•

Click New.

•

From the navigation tree, right-click any calendar node and then click New Calendar.
Civic Platform displays the Calendar detail portlet.

| Part 4: Managing Agency Communications and Events | 585

2. Complete the calendar details (Table 119: Calendar Detail Field Descriptions).
Table 119: Calendar Detail Field Descriptions

# Scheduling Attempts*

For inspection calendars. Indicates the number of times Civic Platform attempts to
schedule a calendar event or an inspection before displaying an error message.

# Units Allocated per Day*

For inspection calendars. This field determines the default number of units in the
daily unit setting (see Assigning Daily Units).

ACA Schedule Time Block

For Citizen Access inspection calendars, this field specifies the time of every time
block available for scheduling inspections in an inspection calendar. For example,
if you enter 30 minutes in the field, every inspection unit is 30 minutes by default in
the inspection calendar.
Note:
The time of each time block is not necessarily the same as the time that an
inspection unit takes.

Calendar Name*

Enter a distinct name for the calendar you want to create.

Comments

Enter specific comments related to the calendar, if applicable.

Default Block

For Civic Platform inspection calendars, this field specifies the default block of time
that an inspection unit takes in an inspection calendar. For example, if you enter 30
minutes in the default block field, every inspection unit is 30 minutes by default in
the inspection calendar.

Department

For a user calendar, select the department that the calendar applies to.

Enable for ACA

For an inspection calendar, select this option to enable an inspection calendar for
Citizen Access. If you do not select this option, the calendar is not available for
Citizen Access inspection scheduling.

Meeting Reason

For a meeting calendar, enter the meeting reason, if any, for reference.

Hide Inspection Times in
ACA

For an inspection calendar, select this option if you want inspection time intervals to
be visible to public users with inspection scheduling permissions.

Location

For a meeting calendar, select the location that the meeting takes place.

Priority*

For an inspection calendar, enter a numeric value to designate priority over other
calendars. The lower the number, the higher the priority. Civic Platform searches
calendars, with a 1 priority, for available units before calendars with a priority of 2.

| Part 4: Managing Agency Communications and Events | 586

Schedule # of Days Out

For an inspection calendar, enter the maximum number of future days available
for calendar scheduling. Enter a value of 0 to make the calendar unavailable for
scheduling. For no scheduling restrictions, leave the field blank. You can enter up to
three integers in this field.
For example, if the current date is June 5, 2009 and you enter a value of 10, then
scheduling for the selected calendar is only available from June 5, 2009 to June 15,
2009.Use this feature to limit calendar scheduling.
For example, you might have an inspection calendar set up for electrical inspectors.
If some of the electrical inspectors in your agency plan to be out of the office for
a conference, or if other inspectors have planned vacation days, you can limit
calendar scheduling availability in advance. This prevents users with scheduling
authorization on your agency’s calendars, such as supervisors, inspectors, and
agency employees, from scheduling inspections when inspectors are unavailable.
Similarly, you might limit scheduling availability for event calendars based on the
planned absence of agency personnel.

Schedule Cut-Off Time AM/
PM

For an inspection calendar, use these fields to set a cut-off time for inspection
scheduling. If users make a inspection scheduling request after the cut-off time,
the earliest possible inspection date is one day later than the date counted directly
using the Schedule Days in Advance setting (when they make the scheduling
request before the cut-off time).Table 120: Inspection Date Based on the Schedule
Days in Advance and Schedule Cut-off Time Settings shows an example on how
Citizen Access gets the inspection date based on the Schedule Days in Advance
and Schedule Cut-off Time settings.

Schedule Days in Advance

For an inspection calendar, use this field to configure the preparation time needed
by agency staff for inspections. For example, if you configure the Schedule Days
in Advance as 3 and a user wants to schedule an inspection on July 12, 2014, the
user must make the inspection scheduling request on July 9, 2013, so that the
agency staff have 3 days to prepare for the inspection.
The Schedule Days in Advance setting works jointly with the Schedule Cut-Off
Time setting.
Table 120: Inspection Date Based on the Schedule Days in Advance and Schedule
Cut-off Time Settings shows an example of how Citizen Access gets the inspection
date based on the Schedule Days in Advance and Schedule Cut-off Time
settings.

Status*

Indicates whether the calendar is available for use. The default calendar status is
Active. The status field is inactive for AGENCY HOLIDAY calendars.
This field designates calendar availability on the user side. Enable the calendar to
give users the calendar option in the user daily calendar list. Disable the calendar to
keep the calendar in the administration list, but omit it from the user calendar list.

Type*

Select the type of calendar from the drop-down list, such as AGENCY HOLIDAY,
INSPECTION, MEETING, OR USER.

User

For a user calendar, select the user that the calendar applies to.

3. Click Submit.
Table 120: Inspection Date Based on the Schedule Days in Advance and Schedule Cut-off Time Settings

Example Schedule
Days in Advance
Setting1

Example Schedule
Possible Inspection Date
Cut-off Time Setting1
If scheduled before 2:00 PM

If scheduled after 2:00 PM

-

2:00 PM

The same day or later

1 day later2

5

-

5 days later2

5 days later2

| Part 4: Managing Agency Communications and Events | 587

Example Schedule
Days in Advance
Setting1

Example Schedule
Possible Inspection Date
Cut-off Time Setting1
If scheduled before 2:00 PM

If scheduled after 2:00 PM

5

2:00 PM

5 days later2

6 days later2

-

-

The same day or later

The same day or later

1These settings work in Citizen Access, and do not apply to supervisors.2The block out days in the inspection
calendar are excluded during the counting.

Modifying Calendar Details
To modify calendar details
1. Find the calendar for which you want to set or modify permissions (Finding a Calendar).
2. Click the Details tab.
Civic Platform displays the calendar details portlet.

3. Complete the calendar details (Table 119: Calendar Detail Field Descriptions).
4. Click Submit.

Assigning Calendar Permissions
You can assign permissions to inspection and meeting type calendars. You can assign Full, Read, or None
as the calendar permission for user groups and individual users.
Use Case Example
You hire new agency personnel and add them to an existing Counter Clerk group in the Building module.
You limit calendar access to include only trained personnel.
Use Case Example
You create an inspection type calendar for all the user groups or users that belong to a particular building
district. After you assign permissions to a particular user or user group, the inspectors in those groups have
permission to view, schedule, and reschedule inspections for the associated calendar type.
To assign user permissions or group permissions to a calendar type
1. Find the calendar for which you want to set or modify permissions (Finding a Calendar).
2. Click the Permissions tab.
Civic Platform displays the calendar permissions portlet with current group permissions, if any.

| Part 4: Managing Agency Communications and Events | 588

3. Assign a new permission.
a. Click Assign.
Civic Platform displays the modules for which you can assign group permission.

b. Expand the modules to find the group(s) for which you want to assign a permission.
c. Select the group(s) and select permission from the drop-down list.
d. Click Submit.
Note:
By default, Civic Platform sets the permission to Full for the newly assigned group. You might need to
modify this permission depending on your business requirements.

4. Modify an existing permission.
a. Select the group for which you want to modify a permission.
b. Select a new permission from the drop-down list.
Full

Full grants users access to all functions for the associated calendar.

Read-Only

Read-Only grants users access to view but not modify functions for the associated
calendar.

None

None denies users access to functions for the associated calendar.

c. Click Submit.
5. Delete a group permission.
a. Select the group for which you want to remove all permission.

| Part 4: Managing Agency Communications and Events | 589

b. Click Delete.
Civic Platform removes the group from the list.

Assigning Districts
You can assign districts to inspection type calendars. You can assign different inspection times based on
the district. When users schedule an inspection for a record, the district information in the record address,
together with the settings in the inspection district calendar, determine the date and time availability for
scheduling.
Use Case Example
You create an inspection calendar to arrange inspections in District A on Monday and Tuesday, and create
another calendar to arrange the same types of inspections in District B on Wednesday and Thursday.
To assign districts to a calendar
1. Find the calendar for which you want to set or modify districts (Finding a Calendar).
2. Click the Districts tab.
Civic Platform displays current district associations, if any.

3. Click Assign to add a district association.
Civic Platform displays available districts.

a. Select the district(s).
b. Click Submit.
Note:
If you do not associate an inspection calendar with any district, the inspection calendar applies to all
districts.

4. Delete a district association.
a. Select the district.

| Part 4: Managing Agency Communications and Events | 590

b. Click Delete.

Assigning and Removing Inspection Types
You can assign inspection types and inspection groups to inspection calendars. For example, if you
want to create a calendar for electrical inspections, you can assign an electrical inspection group to the
calendar. Civic Platform associates inspection types included in the electrical inspection group with the
inspection calendar.
Inspection types are also one filtering criterion used for automatic inspection scheduling. For more
information on working with the inspection type calendar filtering criteria, see Setting Up Automatic
Inspection Scheduling.
For instructions on configuring inspections for automatic scheduling see Inspections.
Inspection types distinguish inspections, such as mechanical, electrical, and building inspections. Assign
inspection types to inspection type calendars to define calendar scope. For example, you might want to
associate mechanical inspection types with a mechanical inspection type calendar.
To assign an inspection type to a calendar
1. Find the calendar for which you want to set or modify inspection types (Finding a Calendar).
2. Click the Inspection Types tab from the detail portlet.
Note:
See Inspections for information on setting up inspection types.

Civic Platform displays the inspection types list portlet.

3. Assign a new inspection type.
a. Click Assign.
Civic Platform displays the Civic Platform inspection types.

| Part 4: Managing Agency Communications and Events | 591

b. Select the inspection type(s) you want to assign.
c. Click Submit.
Civic Platform adds the inspection type to the inspection calendar type with default settings.
4. Modify Citizen Access inspection type settings.
a. Select the inspection group for which you want to modify settings.

b. Modify the settings in accordance with (Table 121: Inspection Scheduling Fields for Citizen Access).
Table 121: Inspection Scheduling Fields for Citizen Access

Schedule Inspection in
ACA

Choose one of the available scheduling options in Citizen Access:None - Does
not allow public users to schedule this inspection type online.Request Only pending- only allows public users to request for an inspection online. The agency
coordinates the appointment for the inspection date and time.Request Same Day
Next Day- allows public users to request an inspection for the same day, next
day, or next available day, based on inspection type calendar parameters defined
on the inspection type. For more information about inspection parameters, refer
to Inspections. The inspection cut-off time displays on this page. If you set the
cut-off time as 3:00PM and a public user schedules an inspection at 4:00PM and
selects the Same Day option, Civic Platform schedules the inspection for the first
appropriate inspection slot on the next business day.
Note:
After public users schedule inspection types that you set up for autoassignment using the Request Same Day Next Day option, you cannot
reschedule or cancel the inspections. After public users schedule manual
inspections by using the Request Same Day Next Day option, they can
reschedule and/or cancel them.
Schedule using calendar - Allows public users to schedule inspections based on
the availability on the inspection type calendar.

Cancel Inspection in
ACA

Use the drop-down list to indicate if you want to allow public users to cancel
inspections in ACA. Yes allows public users to cancel inspections online.No restricts
public users from the ability to cancel inspections online.

Reschedule Inspection
in ACA

Use the drop-down list to indicate if you want to allow public users to reschedule
inspections in ACA. Yes allows public users to reschedule inspections online.No
restricts public users from the ability to reschedule inspections online.

Enable Ready Time in
ACA

Use the drop-down list to indicate if you want to allow public users to specify ready
time for inspections in the Ready Time field in the ACA Request page. Yes allows
public users to specify inspection ready time. No restricts public users from the
ability to specify inspection ready time.

c. Click Submit.

| Part 4: Managing Agency Communications and Events | 592

5. Delete an inspection group.
a. Select the inspection group.
b. Click Delete.

Assigning Inspectors from the Supervisor Calendars
Civic Platform integrates inspection calendars and supervisor calendars to facilitate inspection scheduling.
A supervisor manages and assigns inspectors to inspections. A supervisor can change the view in the
supervisor calendar to show assigned inspections for the current calendar, assigned inspections for all
calendars, or unassigned inspections that require inspector assignment. For more information about
assigning inspections, refer to “Inspections” in the Accela Civic Platform User Guide.
To assign inspectors to an inspection from the supervisor calendar
1. Access the Calendar Administration portlet (Accessing the Calendar Administration Portlet).
2. Select the calendar on which you want to act.
3. Click the Monthly tab to select the monthly calendar display.
4. Display supervisor unassigned calendar inspections by selecting the appropriate option from the Show
drop-down list.
Civic Platform displays applicable calendar information based on selection.
5. Select the inspection to assign an inspector.
6. Click the Menu button and select Assign Inspector from the drop-down list.
Civic Platform displays an inspections portlet.
7. Select the Address and/or Parcel for the inspection.
8. Click Submit.
9. Select the inspector.
The inspectors on this page vary depending on the inspection type, district, and available units.
10.Click Submit.
Civic Platform updates the inspection with the inspector.

Setting Up and Maintaining Meeting Types
Meeting types define the different types of meetings that an agency might conduct, such as tax hearings
and plan reviews. You must set up meeting types before you can schedule meetings.
Meeting types regulate meetings by applying a specific group of settings to all meetings of a specific
meeting type. When you schedule a meeting, you specify the meeting type.
The topics in this section involve specifying the settings for the areas comprising a meeting type definition.
Note:
You must create a meeting type before you can modify it to complete the meeting type definition.

Topics

| Part 4: Managing Agency Communications and Events | 593

•

Finding a Meeting Type

•

Creating Meeting Types

•

Modifying Meeting Type Details

•

Setting or Removing Meeting Type Permissions

•

Setting or Removing Record Type Associations

•

Setting or Removing Workflow Task Associations

•

Setting or Removing Attendee Type Associations

•

Setting or Removing District Associations

•

Setting or Removing Vote Result Options

•

Setting Notification Template Associations

•

Deleting Meeting Types

Finding a Meeting Type
You can search for an existing meeting type to modify meeting type settings.
To search for a meeting type
1. Access the Calendar Administration portlet (Accessing the Calendar Administration Portlet).
2. Click the Meeting Type Maintenance navigation tree.
Civic Platform displays the Meeting Type Maintenance list portlet.

3. Click Search.
Civic Platform displays the Meeting Type search page.

| Part 4: Managing Agency Communications and Events | 594

4. Complete the fields. For a complete list of Meeting Type fields, see Table 122: Meeting Type Field
Descriptions.
5. Click Submit.
Civic Platform displays the meeting types that match your search criteria.

Creating Meeting Types
When you set up meeting types, you designate the type and the status group. You must create the meeting
type first, then complete the tabs for the meeting type to complete the meeting type definition.
To create a meeting type
1. Access the Calendar Administration portlet (Accessing the Calendar Administration Portlet).
2. Click the Meeting Type Maintenance navigation tree.
Civic Platform displays the Meeting Type Maintenance list portlet.

3. Choose one of these options:
•

Click New in the Meeting Type Maintenance list portlet.

•

Right-click any Meeting Type Maintenance navigation tree node, and then click New Meeting Type.
Civic Platform displays the Meeting Type detail portlet.

| Part 4: Managing Agency Communications and Events | 595

4. Complete the meeting type field details (Table 122: Meeting Type Field Descriptions).
5. Click Submit.
Civic Platform displays a confirmation message indicating successful creation of the meeting type.
Table 122: Meeting Type Field Descriptions

Label

Description

Description

A description of the meeting type.

Meeting Type*

The name to identify the meeting, such as Staff Meeting or Facility Reservation.

Status

The status of the meeting, active or inactive. If a meeting type is active, it displays in
the Type drop-down list on the Calendar Meeting Scheduling page.

Meeting Type Status
Group

The status group for the meeting type. The values for this drop-down list depend on
the settings in the MEETING_TYPE_STATUS_[STATUS_GROUP_NAME] Standard
Choice, APPROVED, PENDING, or DENIED, for example.

Template

A list of active ASI group codes. The selected template determines additional fields
that display in the details tab for meetings of the specified type.

Modifying Meeting Type Details
You can modify existing meeting types to change the field values.
To modify a meeting type
1. Access the Calendar Administration portlet (Accessing the Calendar Administration Portlet).
2. Select the meeting type you want to modify.
•

Navigate to the meeting type from the navigation tree in the calendar administration portlet.

•

Use search to find the meeting type of interest (Finding a Meeting Type).

3. Modify the meeting type fields as required. For a complete description of meeting type fields, see Table
122: Meeting Type Field Descriptions.
4. Click Submit.

Setting or Removing Meeting Type Permissions
Your ability to view meeting details depends on your group membership, your group’s permission with the
meeting type, for which a particular meeting is an instance, and the calendar used to schedule the meeting
type. Table 123: Meeting Calendar and Meeting Type Permissions summarizes your permissions based on
the interaction of calendar and meeting type permissions.

| Part 4: Managing Agency Communications and Events | 596

Table 123: Meeting Calendar and Meeting Type Permissions

Meeting Calendar
Permission

Meeting Type
Permission

None
Read

Full

User Access
Cannot open meeting.

Full

Open meeting in Read Only mode. User can upload and
download documents, but not delete documents.

Read

Open meeting in Read Only mode. User can upload, download,
and view documents, but not delete documents.

None

Cannot open meeting.

Full

Open meeting and perform all operations.

Read

Open meeting in Read Only mode. User can upload, download,
and view documents, but not delete documents.

None

Cannot open meeting.

To set or modify meeting type permissions
1. Access the Calendar Administration portlet (Accessing the Calendar Administration Portlet).
2. Select the meeting type you want to modify.
•

Navigate to the meeting type from the navigation tree in the calendar administration portlet.

•

Use search to find the meeting type of interest (Finding a Meeting Type).

3. Click the Permissions tab.
Civic Platform displays the meeting permissions portlet with current group permissions.

4. Assign a new permission.
a. Click Assign.
Civic Platform displays the modules for which you can assign group permission.

| Part 4: Managing Agency Communications and Events | 597

b. Expand the modules to find the group(s) for which you want to assign a permission.
c. Select the group(s) and select permission from the drop-down list.
d. Click Submit.
Note:
By default, Civic Platform sets the permission to Full for the newly assigned group. You can modify
this permission depending on your business requirements.

5. Modify an existing permission.
a. Select the group for which you want to modify a permission.
b. Select a new permission from the drop-down list.
c. Click Submit.
6. Delete a group permission.
a. Select the group for which you want to remove all permission.
b. Click Delete.
Civic Platform removes the group from the list.

Setting or Removing Record Type Associations
You can associate or disassociate one or more record types with a meeting type. When you schedule a
meeting of a particular meeting type, you select instances of the associated record types to be the agenda
items for your meeting.
Use Case Example
You create a meeting type named Review and associate building records with that meeting type. When
you schedule a meeting and designate it as a Review meeting type, you can link building records to the
meeting as agenda items.
To set or remove record type associations
1. Access the Calendar Administration portlet (Accessing the Calendar Administration Portlet).
2. Select the meeting type you want to modify.
•

Navigate to the meeting type from the navigation tree in the calendar administration portlet.

| Part 4: Managing Agency Communications and Events | 598

•

Use search to find the meeting type of interest (Finding a Meeting Type).
Note:
If you do not associate a record type with the meeting type, meeting organizers can add any kind of
record type to the meeting.

3. Click the Record Types record tab.
Civic Platform displays current record type associations.

4. Add a new record type association.
a. Click Assign.
Civic Platform displays a list of record types.

b. Select the record types you want to associate with the meeting type.
c. Click Submit.
5. Delete a new record type association.
a. Select the record types you want to disassociate with the meeting type.
b. Click Delete.

Setting or Removing Workflow Task Associations
If you associate a workflow task with a meeting type, you can write an EMSE script that automatically
launches a meeting request upon completion of the associated workflow task. See the Accela Civic
Platform Scripting Guide.
To set or remove a workflow task association

| Part 4: Managing Agency Communications and Events | 599

1. Access the Calendar Administration portlet (Accessing the Calendar Administration Portlet).
2. Select the meeting type you want to modify.
•

Navigate to the meeting type from the navigation tree in the calendar administration portlet.

•

Use search to find the meeting type of interest (Finding a Meeting Type).

3. Click the Workflow record tab.
Civic Platform displays current workflow task associations.

4. Click Assign to add a workflow task association.
Civic Platform displays the navigation tree for the Workflow Process Task Status.

a. Select the workflow items you want to associate with the meeting type.
b. Click Submit.
5. Delete a workflow item association.
a. Select the workflow items you want to disassociate with the meeting type.
b. Click Delete.

Setting or Removing Attendee Type Associations
When you associate attendee types with a meeting type, you specify the contact type(s), licensed
professional type(s), and user disciplines that should attend a meeting.
To set or remove an attendee type association
1. Access the Calendar Administration portlet (Accessing the Calendar Administration Portlet).
2. Select the meeting type you want to modify.

| Part 4: Managing Agency Communications and Events | 600

•

Navigate to the meeting type from the navigation tree in the calendar administration portlet.

•

Use search to find the meeting type of interest (Finding a Meeting Type).

3. Click the Attendee Types tab.
Civic Platform displays current attendee type associations, if any.

4. Click Assign to add an attendee type association.
Civic Platform displays available attendee types.

a. Select the attendee type(s) you want to associate with the meeting type.
b. Click Submit.
5. Delete an attendee type association.
a. Select the attendee type(s) you want to disassociate with the meeting type.
b. Click Delete.

Setting or Removing District Associations
When scheduling meetings, you can filter potential meeting attendees by their district associations.
To set or remove an district association
1. Access the Calendar Administration portlet (Accessing the Calendar Administration Portlet).
2. Select the meeting type you want to modify.
•

Navigate to the meeting type from the navigation tree in the calendar administration portlet.

•

Use search to find the meeting type of interest (Finding a Meeting Type).

3. Click the Districts tab.
Civic Platform displays current district associations.

| Part 4: Managing Agency Communications and Events | 601

4. Click Assign to add a district association.
Civic Platform displays available districts.

a. Select the district(s) you want to associate with the meeting type.
b. Click Submit.
5. Delete a district association.
a. Select the district(s) you want to disassociate with the meeting type.
b. Click Delete.

Setting or Removing Vote Result Options
You can set or remove voting values associated with a meeting type. By default, Civic Platform uses two
vote result options; Accept and Reject.
To set or remove a voting value association
1. Access the Calendar Administration portlet (Accessing the Calendar Administration Portlet).
2. Select the meeting type you want to modify.
•

Navigate to the meeting type from the navigation tree in the calendar administration portlet.

•

Use search to find the meeting type of interest (Finding a Meeting Type).

3. Click the Vote tab.
Civic Platform displays current vote result options.

| Part 4: Managing Agency Communications and Events | 602

4. Click Add to add a voting option.
Civic Platform displays a dialog to enter a voting option.

a. Enter a vote result option.
b. Click Submit.
5. Delete a vote result option.
a. Select the vote result option(s) you want to remove.
b. Click Submit.

Setting Notification Template Associations
Civic Platform supports the ability to send email notifications to contacts on a case or license. You can also
send notifications to internal staff not specifically related to a case, for example, the hearing officer.
To set notification template associations
1. Access the Calendar Administration portlet (Accessing the Calendar Administration Portlet).
2. Select the meeting type you want to modify.
•

Navigate to the meeting type from the navigation tree in the calendar administration portlet.

•

Use search to find the meeting type of interest (Finding a Meeting Type).

3. Click the Notification tab.
Civic Platform displays the dialog to manage notification template associations.

| Part 4: Managing Agency Communications and Events | 603

4. Select the notification template you want to associate with each combination of action and user.
If required, click the View Detail link to view the notification template. See Working with Communication
Manager for information on modifying notification templates.
5. Click Save.

Deleting Meeting Types
You can delete meeting types as necessary. For example, your agency might set up a temporary meeting
type that you delete after the scheduled meeting occurs. When you delete a meeting type, Civic Platform
sets the meeting type to inactive. Civic Platform does not remove the meeting type from the database.
To delete a meeting type
1. Access the Calendar Administration portlet (Accessing the Calendar Administration Portlet).
2. Select the meeting type you want to delete.
•

Navigate to the meeting type from the navigation tree in the calendar administration portlet.

•

Use search to find the meeting type of interest (Finding a Meeting Type).

3. In the top half of the calendar details portlet, select the meeting type you want to delete.
4. Click Delete.

Setting Up and Maintaining Supervisors
You can assign a user supervisory rights. After you assign a user supervisory rights, you can add users to
the supervisor's team and create a master calendar. A master calendar allows supervisors to review team
member assignments and manage workflow.

| Part 4: Managing Agency Communications and Events | 604

If you are a supervisor, you have the ability to view unassigned inspections and make inspection
assignments.
Topics:
•

Assigning or Removing Supervisory Rights

•

Setting Up and Maintaining Supervisor Teams

•

Creating Master Calendars

Assigning or Removing Supervisory Rights
To assign a user supervisory rights
1. Access the Calendar Administration portlet (Accessing the Calendar Administration Portlet).
2. Click the Supervisor Maintenance node from the navigation tree.
Civic Platform displays a list of supervisors.

3. Click Assign to make a user or group a supervisor.
Civic Platform displays the list of users and groups, per module.

a. Select the user(s) and groups (s) you want to make supervisors.
b. Click Submit.
4. Remove a supervisor.

| Part 4: Managing Agency Communications and Events | 605

a. Select the user(s) and groups (s) you want to remove as supervisors.
b. Click Delete.
5. Click Submit.
Civic Platform adds the group(s) or user(s) to the list of supervisors.

Setting Up and Maintaining Supervisor Teams
To set up and maintain a supervisor team
1. Access the Calendar Administration portlet (Accessing the Calendar Administration Portlet).
2. Click the Supervisor Maintenance node from the navigation tree to list all supervisors or navigate the
tree to select a specific user or a specific group supervisor.
Civic Platform displays all the defined supervisors or the specific supervisor selected.

3. Select the supervisor for which you want to add or remove team members.
4. Click My Team tab.
5. Click Assign.
Civic Platform displays the list of users and groups, per module.

| Part 4: Managing Agency Communications and Events | 606

a. Select the user(s) and groups (s) to add to the supervisor team.
b. Click Submit.
Civic Platform adds the selected