Permits Implementing Oracle Public Sector · This topic provides the list of required tasks for the...

Oracle

Implementing Oracle Public SectorPermits

October 2018

Implementing Oracle Public Sector Permits

Contents

Preface .................................................................................................................. i

1 Implementing Permits Using Functional Setup Manager 1Using Functional Setup Manager ............................................................................................................................... 1

Setting Up Permits Using Functional Setup Manager ................................................................................................. 1

2 Setting Up Your Agency 5Setting Up Agencies .................................................................................................................................................. 5

Setting Up Countries .................................................................................................................................................. 8

Setting Up States ....................................................................................................................................................... 9

Setting Up Cities ...................................................................................................................................................... 10

Setting Up Counties ................................................................................................................................................. 11

Setting Up Currencies .............................................................................................................................................. 12

Setting Up Holiday Calendars .................................................................................................................................. 13

Setting Up Work Schedules ..................................................................................................................................... 14

Setting Up Ownership Types .................................................................................................................................... 16

Setting Up Property Types ....................................................................................................................................... 17

Setting Up Property Conditions ................................................................................................................................ 18

Setting Up Units of Measure .................................................................................................................................... 19

Setting Up Unit of Measure Conversions .................................................................................................................. 20

Setting Up Conditions .............................................................................................................................................. 21

Setting Up Autonumbering ....................................................................................................................................... 23

Setting Up Contact Types ........................................................................................................................................ 26

Setting Up Code Types ............................................................................................................................................ 27

Setting Up Code References .................................................................................................................................... 28

Setting Up Public Users ........................................................................................................................................... 30

Setting Up Public User Roles ................................................................................................................................... 31

Setting Up Terms of Use ......................................................................................................................................... 33

Setting Up Communication Events ........................................................................................................................... 35

Setting Up Reports .................................................................................................................................................. 39

Setting Up Lookups ................................................................................................................................................. 40


3 Setting Up Your Agency Staff 45Setting Up a Fusion Business Unit and Legal Entity ................................................................................................. 45

Defining Job Titles .................................................................................................................................................... 48

Setting Up Agency Staff ........................................................................................................................................... 48

Configuring Agency Job Groups .............................................................................................................................. 50

Managing Agency Staff Profiles ................................................................................................................................ 50

4 Setting Up Property Information 55Setting Up District Types ......................................................................................................................................... 55

Setting Up Districts .................................................................................................................................................. 56

Setting Up Parcels ................................................................................................................................................... 57

Setting Up Parcel Addresses ................................................................................................................................... 58

Setting Up Parcel Owners ........................................................................................................................................ 60

Associating Parcels with Districts ............................................................................................................................. 62

Setting Up Parcel Values .......................................................................................................................................... 63

5 Setting Up Permits 65Setting Up Plan Review Statuses ............................................................................................................................. 65

Setting Up Record Groups ....................................................................................................................................... 66

Setting Up Record Categories ................................................................................................................................. 67

Setting Up Record Subcategories ............................................................................................................................ 67

Setting Up Record Statuses ..................................................................................................................................... 68

Integrating With the Oracle Integration Cloud ........................................................................................................... 71

Setting Up Permit Workflow ..................................................................................................................................... 82

Setting Up Fee Items ............................................................................................................................................... 95

Creating Decision Models for Fees ........................................................................................................................... 96

Setting Up Fee Schedules ...................................................................................................................................... 100

Setting Up Document Categories and Subcategories ............................................................................................. 103

Setting Up Permit Types ........................................................................................................................................ 103

Setting Up Permit Display Groups .......................................................................................................................... 106

6 Creating Application Forms 109Permit Designer Topics .......................................................................................................................................... 109

Using the Permit Designer ...................................................................................................................................... 109

Working with Sandboxes ........................................................................................................................................ 113

Working with Pages ............................................................................................................................................... 114


Working with Predefined Form Elements ................................................................................................................ 115

Using Predefined Form Elements ........................................................................................................................... 118

Working with Group Boxes .................................................................................................................................... 121

Working with Fields ................................................................................................................................................ 129

Defining Fields Displaying a List of Values .............................................................................................................. 133

Adding Contextual Help to Forms .......................................................................................................................... 137

Setting Form Options ............................................................................................................................................. 139

Mapping Permit Fields to the Fee Schedule ........................................................................................................... 140

Considering User Experience ................................................................................................................................. 141

Testing Application Forms ...................................................................................................................................... 143

Publishing Application Forms .................................................................................................................................. 144

Cloning Permit Definitions ....................................................................................................................................... 145

7 Setting Up Inspections 151Setting Up Inspection Statuses .............................................................................................................................. 151

Inspection Evaluation Overview .............................................................................................................................. 151

Setting Up Inspection Assessment Types .............................................................................................................. 153

Setting Up Rating Methods .................................................................................................................................... 156

Setting Up Passing Rules ....................................................................................................................................... 158

Setting Up Checklist Item Categories ..................................................................................................................... 159

Setting Up Inspection Checklists ............................................................................................................................ 161

Setting Up Inspection Checklist Groups ................................................................................................................. 164

Setting Up Inspection Types .................................................................................................................................. 165

Setting Up Inspection Groups ................................................................................................................................ 169

Setting Up Inspection Calendars ............................................................................................................................ 170

Setting Up Inspection Scheduling ........................................................................................................................... 172

8 Setting Up Billing 177Setting Up Invoice Forms ....................................................................................................................................... 177

Setting Up Bill Types .............................................................................................................................................. 177

9 Setting Up Payments 179Managing Security and Payment Endpoints ........................................................................................................... 179

Managing Payment Gateways ................................................................................................................................ 180

Setting Up Payment Adapters ................................................................................................................................ 180

Setting Up Agency Payment Options ..................................................................................................................... 182


Setting Up Department Payment Options .............................................................................................................. 183

Setting Up Cash Drawers ....................................................................................................................................... 184

10 Setting Up Help Management 187Setting Up Contextual Help .................................................................................................................................... 187

11 Setting Up GIS 189Setting Up Map Profiles ......................................................................................................................................... 189

Setting Up GIS Attribute Mapping .......................................................................................................................... 192

12 Setting Up Accounting 195Managing Accounting Events ................................................................................................................................. 195

Setting Up Accounting Rules ................................................................................................................................. 195

Setting Up Accounts .............................................................................................................................................. 198

Setting Up Departments ......................................................................................................................................... 200

Setting Up Divisions ............................................................................................................................................... 201

Setting Up Programs .............................................................................................................................................. 202

Setting Up Funds ................................................................................................................................................... 203

Setting Up Functions .............................................................................................................................................. 204

Setting Up Ledgers ................................................................................................................................................ 205

Setting Up Monthly Accounting Calendars ............................................................................................................. 205

13 Setting Up Comments 207Managing Comments ............................................................................................................................................. 207

Setting Up Standard Comment Categories and Subcategories .............................................................................. 208

Viewing, Adding, Modifying, and Deleting Standard Comments .............................................................................. 209

14 Configuring Navigation 211Configuring Menu Structure .................................................................................................................................... 211

Using the Page Finder ............................................................................................................................................ 215

Viewing the Menu Structure in the Navigator ......................................................................................................... 218

Configuring Header and Footer Navigation Features .............................................................................................. 219

Back Button Behavior ............................................................................................................................................ 221

Mobile Applications Navigation Considerations ....................................................................................................... 222

Configuring the Actions Menu ................................................................................................................................ 222


15 Branding 225Branding Public Sector Cloud Services .................................................................................................................. 225

Managing Themes .................................................................................................................................................. 225

Managing Theme Attributes ................................................................................................................................... 226

Configuring Theme Attributes ................................................................................................................................. 230

Applying Branding Images ...................................................................................................................................... 232

Assigning Themes .................................................................................................................................................. 235

16 Setting Up the Landing Pages and Agency Springboard 237Landing Pages Overview ........................................................................................................................................ 237

Setting Up the Agency Springboard ....................................................................................................................... 238

Setting Up the Landing Page for Anonymous Users .............................................................................................. 242

Setting Up the Landing Page for Registered Users ................................................................................................ 245

Setting Up the Permit Guide .................................................................................................................................. 247

Defining Summary Details ....................................................................................................................................... 248

Defining Tiles .......................................................................................................................................................... 251

Defining Alerts ........................................................................................................................................................ 252

17 Configuring Security 255Using the Security Console .................................................................................................................................... 255

Managing Implementation Users ............................................................................................................................ 263

Managing Users in Public Sector Compliance and Regulation ................................................................................ 271

Setting the Next URL for the Default User Category .............................................................................................. 273

Managing Roles in Public Sector Compliance and Regulation ................................................................................ 273

Working with Roles in the Security Console ........................................................................................................... 281

Managing Data Security Policies ............................................................................................................................ 291

Creating Custom Roles for the Permits Service ...................................................................................................... 294

18 Configuring Oracle Policy Automation 299Overview of Oracle Policy Automation Configuration .............................................................................................. 299

Setting Up Entity Models ........................................................................................................................................ 299

Setting Up Metadata Models .................................................................................................................................. 301

Setting Up Enumerations ........................................................................................................................................ 303

Mapping Enumerations to Metadata Models .......................................................................................................... 304

Managing Proxy Users ........................................................................................................................................... 305

Managing OPA Hub ............................................................................................................................................... 306


Managing OPA Policies for Agency ........................................................................................................................ 308

Implementing Oracle Public Sector Permits Preface

Preface

This preface introduces information sources that can help you use the application and this guide.

Using Oracle Applications This topic explains the text conventions used in this guide and points you to where you can find more information about usingOracle applications.

ConventionsThe following table explains the text conventions used in this guide.

Convention Meaning

boldface

Boldface type indicates user interface elements, navigation paths, or values you enter or select.

monospace

Monospace type indicates file, folder, and directory names, code examples, commands, and URLs.

>

Greater than symbol separates elements in a navigation path.

Additional Resources• Community: Use Oracle Cloud Customer Connect to get information from experts at Oracle, the partner

community, and other users.

• Guides and Videos: Go to the Oracle Help Center to find guides and videos.

• Training: Take courses on Oracle Cloud from Oracle University.

Documentation Accessibility This topic covers accessibility concepts for this guide.

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website.

Videos included in this guide are provided as a media alternative for text-based help topics also available in this guide.

Contacting Oracle This topic explains how to contact Oracle for support and to provide feedback.

i

https://appsconnect.custhelp.com/

http://docs.oracle.com/

http://education.oracle.com/pls/web_prod-plq-dad/db_pages.getpage?page_id=906

https://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc

Implementing Oracle Public Sector Permits Preface

Access to Oracle SupportOracle customers that have purchased support have access to electronic support through My Oracle Support. Forinformation, visit My Oracle Support or visit Accessible Oracle Support if you are hearing impaired.

Comments and SuggestionsPlease give us feedback about Oracle Public Sector Compliance and Regulation applications help and guides! You can sendan e-mail to: [email protected].

ii

https://www.oracle.com/pls/topic/lookup?ctx=acc&id=info%0A%09

https://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs%0A%09

mailto:[email protected]


Part Number: E94035-01

Copyright © 2018, Oracle and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected byintellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast,modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, ordecompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them tous in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then thefollowing notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulationand agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operatingsystem, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictionsapplicable to the programs. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use inany inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerousapplications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. OracleCorporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks orregistered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks ofAdvanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information about content, products, and services from third parties. OracleCorporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, andservices unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for anyloss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreementbetween you and Oracle.

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers that have purchased support have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.

http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc

http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc

http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info

http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info

http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs

Implementing Oracle Public Sector Permits Chapter 1Implementing Permits Using Functional Setup Manager

1 Implementing Permits Using FunctionalSetup Manager

Using Functional Setup Manager This topic discusses how to use the Functional Setup Manager.

Oracle Functional Setup Manager provides an integrated, end-to-end process for functional administrators to manage theimplementation and maintenance of Oracle Public Sector Services.

Business users configure features and manage setup data using the Functional Setup Manager. Subscription to offerings,enabling functional areas, opting in features, and setting up guided end-to-end tasks pertaining to the offerings are all driventhrough the Functional Setup Manager.

For a detailed understanding of the Functional Setup Manager, see the documentation on Using Functional Setup Manager.

Setting Up Permits Using Functional Setup Manager This topic provides the list of required tasks for the implementation of Public Sector Permits, which are organized under thefunctional areas in the Functional Setup Manager (FSM).

You must complete these tasks to set up the forms and processes that your agency will use across all Oracle Public Sectorproducts:

1. Initial Setup:

◦ Run User and Roles Synchronization Process

◦ Update Next URL of Default User Category

2. Agency Profile:

◦ Manage Geographies

◦ Manage Territories

◦ Manage Address Formats

◦ Manage Phone Numbering Plans

◦ Manage Countries

◦ Manage States

◦ Manage Counties

◦ Manage Cities

◦ Manage Public Sector Currencies

◦ Manage Agencies

◦ Manage Public Sector Departments

1

http://www.oracle.com/pls/topic/lookup?ctx=en/cloud/saas/applications-common/18c&id=OAFSM521803


◦ Manage Ownership Types

◦ Define Units of Measure for Public Sector

◦ Manage UOM Conversions

◦ Manage Property Types

◦ Manage Property Conditions

◦ Manage Autonumber Rules

◦ Manage Contact Types

◦ Manage Parcels

◦ Manage Parcel Owners

◦ Manage Parcel Addresses

◦ Manage Parcel Values

◦ Manage District Types

◦ Manage Districts

◦ Manage Parcel Districts

◦ Manage Code Types

◦ Manage Code References

◦ Manage Public User Setup

◦ Manage Terms of Use

◦ Manage Fee Items

◦ Manage Public Sector Work Schedules

3. Fees and Payments:

◦ Manage Autonumber Rule for Invoice

◦ Manage Invoice Forms

◦ Manage Bill Types

◦ Enable Payment Gateway

◦ Manage Security Endpoint

◦ Manage Payment Endpoint

◦ Manage Payment Adapters

◦ Manage Autonumber Rule for Receipt

◦ Manage Autonumber Rule for Cashier Session

◦ Configure Agency Payment Processing Options

◦ Configure Department Payment Processing Options

4. Inspections:

◦ Manage Inspection Statuses

◦ Manage Inspection Assessment Types

◦ Manage Rating Methods

2


◦ Manage Passing Rules

◦ Manage Checklist Categories

◦ Manage Inspection Checklists

◦ Manage Checklist Groups

◦ Manage Inspection Types

◦ Manage Inspection Groups

◦ Manage Inspection Calendars

5. Plan Review:

◦ Manage Plan Review Statuses

◦ Manage Plan Review Decisions

6. Permit Types:

◦ Manage Record Statuses

◦ Manage Workflow Communication Events

◦ Create Process Cloud Service Proxy User

◦ Manage Fee Schedules

◦ Manage Custom Role for Permit Access

◦ Manage Permit Types

◦ Manage Permit Type Display Groups

7. Accounting:

◦ Manage Ledgers

◦ Manage Funds

◦ Manage Accounts

◦ Manage Accounting Rules

◦ Manage Monthly Accounting Calendars

8. Agency Staff:

◦ Manage Reference Data Sets

◦ Manage Business Unit

◦ Manage Legal Addresses

◦ Manage Legislative Data Groups

◦ Manage Legal Entity

◦ Manage Legal Entity Registrations

◦ Manage Legal Entity HCM Information

◦ Manage Agency Job Titles

◦ Manage Agency Staff

◦ Manage Agency Staff Access

3


9. Public Users:

◦ Manage Terms of Use

◦ Manage Public User Setup

◦ Manage Public User Roles

◦ Manage Business Type Lookups

◦ Manage Public Access User

10. GIS

◦ Manage Map Profiles

◦ Manage GIS Attribute Mapping

11. System Administration:

◦ Manage Communication Events

◦ Manage Lookups

12. Branding:

◦ Manage Themes

◦ Manage Appearance

◦ Assign Themes

◦ Manage Tiles for Registered User Landing Page

◦ Manage Tiles for Anonymous User Landing Page

◦ Manage Tiles for Agency Springboard

◦ Manage Summary Details

◦ Manage Generic Alerts

Note: In addition to the above, there are optional tasks available under the functional areas in FSM.

4

Implementing Oracle Public Sector Permits Chapter 2Setting Up Your Agency

2 Setting Up Your Agency

Setting Up Agencies An agency is an organization that offers a range of services to its constituents, including issuing permits and licenses.

Administrators add and modify agency information using the Agency page.

Adding an Agency1. Select Common Setup > Agency .2. On the Agency Information tab, click Add.3. On the Agency Information - Details page, enter values for the following fields:

Page Elements Definition

Agency ID

Select a unique ID for the agency.

Name and Description

Enter a name and a short description for the agency.

Country

Enter the country in which the agency is located.

Currency

Enter the currency that the agency uses for financial transactions.

Time Zone

Enter the time zone in which the agency is located.

Parcel Owner Format

Specify whether your agency uses one or two fields to identify parcel owners.

4. Click Save.

Modifying an Agency1. Select Common Setup > Agency .2. Click a row on the Agency Information tab.3. Update the agency information field values.4. Click Save.

Adding an Agency Address1. Select Common Setup > Agency .2. Click a row on the Agency Information page.3. Select the Addresses tab, and click Add.4. On the Addresses - Details page, enter values for the following fields:

5



Address ID

Enter a unique ID for the address.

Primary

Select to indicate that this is the primary address for the agency. An agency may have onlyone primary address.

From Date and To Date

Enter the date range for which the address is valid.

Zip Code

If you know the zip code for the address, enter it here. The system automatically populatesthe City and State based on the zip code you enter. If you don’t know the zip code, click the don’t know link to narrow down your choice of zipcodes by entering a city and state.

Address Line 1 and Address Line2

Enter the street number or post office box number, along with any additional addressinformation such as apartment or suite number.

City and State

Enter the city and state for the address.

Postal Code

Enter the postal code for the address. The available values for this field are filtered based onthe city and state that you select.

5. Click Save.

Modifying an Agency Address1. Select Common Setup > Agency .2. Click a row on the Agency Information tab.3. Select the Addresses tab.4. Click a row on the Addresses tab. You can:

◦ Update the agency address field values.

Note: You cannot change a primary address row to non-primary. Instead, when you update a non-primary row to primary, all other address rows are saved as non-primary.

◦ Delete the address. You will be prompted to confirm the permanent deletion.

Note: You cannot delete primary address rows.

5. Click Save.

Deleting an Agency Address1. Select Common Setup > Agency .2. Click a row on the Agency Information tab.3. Select the Address tab.

6


4. Click Edit.5. Select the check boxes next to all the agency addresses that you want to delete.6. Click Delete. You will be prompted to confirm the permanent deletion.

Note: You cannot delete primary address rows. To delete an address row that is designated as primary, youmust first designate a different address row as primary. This changes the previously primary row to non-primary,allowing it to be deleted.

Modifying Permit Options1. Select Common Setup > Agency .2. Click a row on the Agency Information tab.3. Select the Features tab, and click Options for the Permits offering.4. On the Permit Options page, you can update values for the following fields:


Oracle Policy Automation ID

Enter the unique identifier for the agency’s Oracle Policy Automation definition.

Message Title

Enter a short text version of the landing page message in a title format. If you leave thisfield blank, the value in the Label field on the Link Details page for the menu navigation linkOnline Permits is displayed.

Message Summary

Enter a longer version of the landing page message title in a sentence format. If you leavethis field blank, the value in the Description field on the Link Details page for the menunavigation link Online Permits is displayed.

Button Content URL

Enter a content URL for the Read More button. Public users click this button to access theagency’s own permit information page, outside of Oracle Public Sector Permits. If you leavethis field blank, the Read More button opens a dialog box that displays the Landing PageMessage.

Note:If you want to link to a page outside of Oracle Public Sector Permits, you must entera URL here.

Landing Page Message

Enter a welcome message in rich text to appear in a dialog box on the landing page, if aURL to access the agency’s page is not defined.

For more information on Oracle Policy Automation, see Overview of Oracle Policy Automation Configuration.

For more information on the Landing Page Message Definition, see Defining Summary Details.

Enabling and Disabling the Permits Offering1. Select Common Setup > Agency .2. Click a row on the Agency Information tab.3. Select the Features tab to view the Permits offering for an agency.4. Enable or disable the Permits offering using the Enable switch.

7


Setting Up Countries A country definition includes the country name and various identifying codes.

You add, modify, and delete countries on the Country page.

Adding a Country1. Select Common Setup > Country .2. On the Country page, click Add.3. On the Country Details page, enter values for the following fields:

Page Element Description

Country Code

Enter a the unique code that your system uses for the country. For example, you might enterFRA for France.

ISO Alpha 2 Code

Enter the two-letter International Organization of Standardization (ISO) code for the country.For example, you would enter FR as the code for France.

ISO Numeric 3 Code

Enter the three-digit United Nations (UN) M.49 code for the country. For example, you wouldenter 250 as the code for France.

Country Name

Enter the name of the country as it appears in your system.

4. Click Save.

Modifying a Country1. Select Common Setup > Country .2. Click a row on the Country page.3. On the Country Details page you can:

◦ Update the country field values.

Note: You cannot edit the Country Code.

◦ Delete the country. You will be prompted to confirm the permanent deletion.

4. Click Save.

Deleting Countries1. Select Common Setup > Country .2. Click Edit.3. Select the check boxes next to all the countries you want to delete.4. Click Delete. You will be prompted to confirm the permanent deletion.

8


Setting Up States A state definition includes information such as the state name, country, and various ID codes.

You add, modify, and delete states on the State page.

Adding a State1. Select Common Setup > State .2. On the State page, click Add.3. On the State Details page, enter values for the following fields:


Country

Enter the code for the country that the state is in.

State Code ISO

Enter the International Organization of Standardization (ISO) code for the state.

Code

Enter the unique code that your system uses for the state.

State Name

Enter the name of the state.

Type

Enter the subdivision type.

GNIS ID

Enter the Geographic Names Information System (GNIS) ID for the state’s location.

4. Click Save.

Modifying a State1. Select Common Setup > State .2. Click a row on the State page.3. On the State Details page you can:

◦ Update the state field values.

Note: You cannot edit the Country or State Code ISO fields.

◦ Delete the state. You will be prompted to confirm the permanent deletion.

4. Click Save.

Deleting States1. Select Common Setup > State .2. Click Edit.

9


3. Select the check boxes next to all the states you want to delete.4. Click Delete. You will be prompted to confirm the permanent deletion.

Setting Up Cities A city definition includes information such as the city name, country, state, and certain ID codes.

You add, modify, and delete cities on the City page.

Adding a City1. Select Common Setup > City .2. On the City page, click Add.3. On the City Details page, enter values for the following fields:


Country Code and State Code

Enter the codes for the country and state in which the city is located.

County

Enter the five-digit International Committee for Information Technology Standards (INCITS)code for the county in which the city is located.

FIPS Code

Enter the seven-digit Federal Information Processing Standard (FIPS) code for the city.

City Name

Enter the name of the city.

GNIS ID

Enter the Geographic Names Information System (GNIS) ID for the city’s location.

4. Click Save.

Modifying a City1. Select Common Setup > City .2. Click a row on the City page.3. On the City Details page you can:

◦ Update the city field values.

Note: You cannot edit the Country Code, State Code, or County fields.

◦ Delete the city. You will be prompted to confirm the permanent deletion.

4. Click Save.

Deleting Cities1. Select Common Setup > City .

10


2. Click Edit.3. Select the check boxes next to all the cities you want to delete.4. Click Delete. You will be prompted to confirm the permanent deletion.

Setting Up Counties A county definition includes information such as the county name, country, state, and certain ID codes.

You add, modify, and delete counties on the County page.

Adding a County1. Select Common Setup > County .2. On the County page, click Add.3. On the County Details page, enter values for the following fields:


Country and State

Enter the codes for the country and state that the county is in.

INCITS Code

Enter the five-digit International Committee for Information Technology Standards (INCITS)code for the county.

County Name

Enter the name of the county.

FIPS Code

Enter the seven-digit Federal Information Processing Standard (FIPS) code for the county.

GNIS ID

Enter the Geographic Names Information System (GNIS) ID for the county’s location.

4. Click Save.

Modifying a County1. Select Common Setup > County .2. Click a row on the County page.3. On the County Details page you can:

◦ Update the county field values.

Note: You cannot edit the Country, State, or INCITS Code fields.

◦ Delete the county. You will be prompted to confirm the permanent deletion.

4. Click Save.

Deleting Counties1. Select Common Setup > County .

11


2. Click Edit.3. Select the check boxes next to all the counties you want to delete.4. Click Delete. You will be prompted to confirm the permanent deletion.

Setting Up Currencies A currency definition includes currency codes, a description, and the number of decimals that can be used to represent anamount in the currency.

You add, modify, and delete currencies on the Currency page.

Adding a Currency1. Select Common Setup > Currency .2. On the Currency page, click Add.3. On the Currency Details page, enter values for the following fields:


Currency Code

Enter a the unique code that your system uses for the currency.

ISO Code

Enter the three-digit International Organization of Standardization (ISO) 4217 numeric codefor the currency. For example, you would enter 840 for the US dollar.

Description

Enter a short description of the currency.

Decimal Position

Enter the number of decimal places that can be used to represent an amount for thecurrency. For example, the United States dollar uses two decimal positions.

4. Click Save.

Modifying a Currency1. Select Common Setup > Currency .2. Click a row on the Currency page.3. On the Currency Details page you can:

◦ Update the currency field values.

Note: You cannot edit the Currency Code field.

◦ Delete the currency. You will be prompted to confirm the permanent deletion.

4. Click Save.

Deleting Currencies1. Select Common Setup > Currency .

12


2. Click Edit.3. Select the check boxes next to all the currencies you want to delete.4. Click Delete. You will be prompted to confirm the permanent deletion.

Setting Up Holiday Calendars Holiday calendars establish the days that agency offices are closed and no field service operations are offered.

These days appear as unavailable, non-working days in calendar views throughout the system such as for public userand inspector calendars. Non-working days in holiday calendars apply to all employees and do not need to be defined foremployee profiles.

Each holiday calendar spans a date range that you define. Within that date range, you define individual events for each non-working holiday.

Administrators add, modify, and delete holiday schedules and events on the Holiday Calendar page.

Adding a Holiday Calendar1. Select Common Setup > Holiday Calendar .2. On the Holiday Calendar page, click Add.3. On the Holiday Calendar Details page, enter values for the following fields:


Calendar ID and Description

Enter a unique ID and description for the calendar. For example, you might enter an ID of2019 and a description of Holiday Calendar 2019.

Valid from Date and Valid to Date

Enter the date range for the holiday calendar. For example, you might enter a Valid fromDate of 2019–01–01 and a Valid to Date of 2019–12–31 to represent a calendar thatspans the entire 2019 calendar year.

4. Add an event.

Note: You must have values defined for all required holiday calendar fields before you can add an event.

5. Click Save.

Note: When you click Save, the Holiday Calendar page closes.

Adding an Event1. Select Common Setup > Holiday Calendar .2. Click a row on the Holiday Calendar page.3. On the Holiday Schedule Details page, click Add.4. On the Event Details page, enter an Event ID, an Event Date, and a Description for the event. For example, you

might enter an ID of MD, a date of May 29, 2017, and a description of Memorial Day.

13


5. Click Save.

Modifying a Holiday Calendar1. Select Common Setup > Holiday Calendar .2. Click a row on the Holiday Calendar page.3. On the Holiday Calendar Details page you can:

◦ Update the holiday schedule field values.

Note: You cannot edit the Calendar ID.

◦ Delete the holiday calendar. You will be prompted to confirm the permanent deletion.

◦ Add, modify, or delete events.

4. Click Save.

Note: When you click Save, the Holiday Calendar page closes.

Modifying an Event1. Click a row on the Holiday Calendar Details page.2. On the Event Details page you can:

◦ Update the event date or description.

◦ Delete the event. You will be prompted to confirm the permanent deletion.

3. Click Save.

Deleting Holiday Calendars1. Select Common Setup > Holiday Calendar .2. Click Edit.3. Select the check boxes next to all the holiday schedules you want to delete.4. Click Delete. You will be prompted to confirm the permanent deletion.

Deleting Events1. Click Edit on the Holiday Calendar Details page.2. Select the check boxes next to all the events you want to delete.3. Click Delete. You will be prompted to confirm the permanent deletion.

Setting Up Work Schedules Work schedules establish the days of the week and daily hours of operation for agency employees.

Create schedules based on the type of employee and work location. Calendar views, such as inspector calendars, referencework schedules to determine the time slots that are displayed on the calendar as available for scheduling. Algorithms for

14


assigning resources also use work schedules to determine availability. You assign work schedules to employee profiles usingthe Agency Staff page. See Setting Up Agency Staff.

Administrators and business analysts add, modify, and delete work schedules on the Work Schedule page.

Adding a Work Schedule1. Select Common > Work Schedule .2. On the Work Schedule page, click Add.3. On the Work Schedule Details page, enter values for the following fields:


Schedule ID and Description

Enter a unique ID and description for the schedule. For example, you might enter an ID ofOFFICESAT and a description of Saturday Office Schedule.

Start Date

Enter the first day of the schedule.

End Date

Enter the last date of the schedule. You can leave this field blank to give the schedule anopen end date.

Work Start Time and Work EndTime

Enter the start and end time for the schedule. For example, you might enter a work start timeof 09:00 AM and a work end time of 05:00 PM.

Break Start Time and Break EndTime

Enter the start and end time for a break within the schedule. For example, you might enter abreak start time of 12:00 PM and a break end time of 01:00 PM.

Note:These fields are optional, but if you enter a break start time, you must also enter abreak end time.

Recurrence and Weeks BetweenOccurrences

Select whether the schedule reoccurs weekly and how many weeks are between eachoccurrence. For example, if you select a recurrence of Weekly with 1 week betweenoccurrences, the schedule repeats every week.

Work Days

Select the days of the weeks to which the schedule applies.

4. Click Save.

Note: For overnight work shifts that go past 12 am (midnight), you must create two schedules: one for the timeperiod up until midnight, and one for the time period after midnight. For example, to create a weekday overnightshift that starts at 09:00 pm and ends at 06:00 am the following day, the first schedule would have a start time of09:00 pm and an end time of 12:00 am on Monday, Wednesday, and Friday. The second schedule would havea start time of 12:00 am and an end time of 06:00 am on Tuesday, Thursday, and Saturday.

Modifying a Work Schedule1. Select Common > Work Schedule .2. Click a row on the Work Schedule page.

15


3. On the Work Schedule Details page you can:

◦ Update the work schedule field values.

Note: You cannot edit the Schedule ID field.

◦ Delete the schedule. You will be prompted to confirm the permanent deletion.

4. Click Save.

Deleting Work Schedules1. Select Common > Work Schedule .2. Click Edit.3. Select the check boxes next to all the work schedules you want to delete.4. Click Delete. You will be prompted to confirm the permanent deletion.

Setting Up Ownership Types Ownership type indicates how a business was established; for example, a corporation or a nonprofit. You set up ownershiptypes for your agency on the Ownership Type page.

Adding an Ownership Type1. Select Common Setup > Ownership Type .2. On the Ownership Type page, click Add New to add an ownership type.3. On the Ownership Type Details page, enter a name for the ownership type.4. Enter a description.5. Verify that the Enabled switch is turned on. The switch is turned on by default for a new ownership type.6. Click Save.

Modifying an Ownership Type1. Select Common Setup > Ownership Type e.2. On the Ownership Type page, click the row for the ownership type that you want to modify.3. On the Ownership Type Details page you can:

◦ Modify the ownership type description. You cannot change the name.

◦ Click the Enabled switch to enable or disable the ownership type.

4. If you made any changes, click Save.

Deleting an Ownership Type1. Select Common Setup > Ownership Type e.2. On the Ownership Type page, click the row for the ownership type that you want to delete.3. On the Ownership Type Details page, click Delete.

16


4. If you want to delete multiple ownership types, you can delete them from the Ownership Type page:

a. Click Edit.b. Select the check boxes for the ownership type rows to delete.c. Click the Delete icon.

Setting Up Property Types Property type categorize properties according to criteria such as how the property is used or the type of dwelling.

You add, modify, and delete property types on the Property Type page.

Adding a Property Type1. Select Common Setup > Property Type.2. On the Property Type page, click Add.3. On the Property Type Detail page, enter values for the following fields:


Property Type

Enter the type of property, such as Residential or Commercial.

Description

Enter a property type description.

4. Verify that the Enabled switch is turned on.

The switch is on by default for a new property type.5. Click Save.

Modifying a Property Type1. Select Common Setup > Property Type.2. Click a row on the Property Type page.3. On the Property Type Detail page you can:

◦ Update the property type description.

◦ Turn off the Enabled switch to deactivate the property type.

4. Click Save.

Deleting Property Types1. Select Common Setup > Property Type.2. To view a definition before deleting it, click the row to be deleted, then click the Delete button on the Property Type

Details page.3. To delete one or more definitions without viewing details:

a. Click Edit.b. Select the check boxes next to the definitions that you want to delete.

17


c. Click Delete.

You will be prompted to confirm the permanent deletion.

Setting Up Property Conditions A property condition identifies the general condition of the property. This value is used to indicate the general age of aproperty, a property’s physical condition, or other condition.

You add, modify, and delete property conditions on the Property Condition page.

Adding a Property Condition1. Select Common Setup > Property Condition.2. On the Property Condition page, click Add.3. On the Property Condition Detail page, enter values for the following fields:


Property Condition

Enter the property condition, such as Poor or Good.

Description

Enter a description of the property condition.


The switch is on by default for a new property condition.5. Click Save.

Modifying a Property Condition1. Select Common Setup > Property Condition.2. Click a row on the Property Condition page.3. On the Property Condition Detail page you can:

◦ Update the property condition description.

◦ Turn off the Enabled switch to deactivate the property type.

4. Click Save.

Deleting Property Conditions1. Select Common Setup > Property Condition.2. To view a definition before deleting it, click the row to be deleted, then click the Delete button on the Property

Condition Details page.3. To delete one or more definitions without viewing details:

a. Click Edit.b. Select the check boxes next to the definitions that you want to delete.c. Click Delete.

18



Setting Up Units of Measure Units of measure are used to express measurements such as quantity or duration. Each unit of measure must have a unittype such as Length, Area, or Time.

You add, modify, and delete units of measure on the Unit of Measure page.

Adding a Unit of Measure1. Select Common Setup > UOM.2. On the Unit of Measure page, click Add.3. On the Unit of Measure Details page, enter values for the following fields:


Unit of Measure

Enter a unique unit of measure ID.

Description

Enter a description of the unit of measure.

Unit Type

Select one of these unit types: Length, Area, Angle, Volume, or Time.

ISO Code

Enter the ISO unit of measure code.

4. Click Save.

Modifying a Unit of Measure1. Select Common Setup > UOM.2. Click a row on the Unit of Measure page.3. On the Unit of Measure Details page, make the necessary modifications.4. Click Save.

Deleting Units of Measure1. Select Common Setup > UOM.2. To view a definition before deleting it, click the row to be deleted, then click the Delete button on the Unit of

Measure Details page.3. To delete one or more definitions without viewing details:



19


Setting Up Unit of Measure Conversions A unit of measure (UOM) conversion definition specifies the factor for converting a unit of measure to an equivalent amount ofa different unit of measure.

You add, modify, and delete unit of measure conversions on the UOM Conversion page.

Adding a UOM Conversion1. Select Common Setup > UOM Conversion.2. On the UOM Conversion page, click Add.3. On the UOM Conversion Detail page, enter values for the following fields:


UOM

Select the unit of measure that is the starting unit for the conversion.

UOM To

Enter the target unit of measure. This unit of measure must be the same type as the originalunit of measure. For example, you can convert a unit of length to another unit of length, butyou can’t convert a unit of length to a unit of weight.

Conversion Rate

Enter the conversion factor used to convert the original unit of measure to the target unit ofmeasure. For example, to convert minutes to hours, enter a conversion rate of 60.


The switch is on by default for a new UOM conversion.5. Click Save.

Modifying a UOM Conversion1. Select Common Setup > UOM Conversion.2. Click a row on the UOM Conversion page.3. On the UOM Conversion Detail page you can:

◦ Update the UOM conversion field values.

◦ Disable the UOM conversion by turning the Enabled switch off.

4. Click Save.

Deleting UOM Conversions1. Select Common Setup > UOM Conversion.2. To view a definition before deleting it, click the row to be deleted, then click the Delete button on the Unit of

Measure Conversion Details page.3. To delete one or more definitions without viewing details:

a. Click Edit.

20


b. Select the check boxes next to the definitions that you want to delete.c. Click Delete.


Setting Up Conditions A condition indicates a dependency or contingency for completing the permit process. You set up conditions on theConditions page.

You add, modify, and delete conditions on the Conditions page.

Condition OverviewA condition indicates a status, criterion, or action that can apply to an object in the system, such as a permit.

Conditions are defined with a severity that might affect operations when applied. Condition rules with a Hold severity preventone or more of the operations that are selected at the time of applying the condition. Condition rules with a Lock severityprevent all operations as described in the table here.

Rule Applicable Objects Usage

Prevent Workflow Advancing

Permit

Agency staff applies a condition to apermit record that prevents workflow fromadvancing. The permit workflow tasks cannotbe completed until the condition is resolved.

Restrict Payment

Permit

Agency staff applies a condition to a permitrecord that prevents a user from processinga payment.

Prevent Inspection Schedule

Permit

This condition rule prevents agency staff fromscheduling a new inspection. It does notaffect existing inspections that have alreadybeen scheduled.

Prevent Inspection Result

Permit

This condition rule prevents agency staff fromfinalizing the inspection results.

Adding Conditions1. Select Common Setup > Condition .2. On the Condition page, click the Add New button.3. On the Condition Details page, enter values for the following fields:


Condition Name

Enter a unique condition name.

21



Object Type

Select an object type to categorize the condition, based on the object type to which it isapplied, such as Permit.

Display Message

Enter a message that will be displayed to external users, up to 150 characters.

Severity

Select a severity level for each condition from these options:

◦ Lock

At the most severe level, the Lock condition suspends all operations, includingworkflow advancing, payment processing, inspection scheduling, and inspectionresults.

◦ Hold

Agency staff can select which rules to apply to conditions with the Hold level ofseverity.

◦ Notice

The Notice level functions as an alert and has no effect on operations.For more information, see the Oracle Public Sector Permits documentation, “ApplyingConditions to Permit.”

Description

Enter a description.

4. Verify that the Enabled switch is turned on. New conditions are active by default.5. Click Save.

Modifying Conditions1. Select Common Setup > Condition .2. Click a row on the Condition page.3. On the Condition Details page you can update the display message, severity, description, and the Enable switch.4. Click Save.

Deleting Conditions1. Select Common > Condition2. Click a row on the Condition page.3. On the Condition Details page, click Delete to delete the condition.

Note: You can delete a condition only if it is not applied to a permit. If you try to delete a condition that isapplied to a permit, you will see an error message stating that you cannot remove the condition because it hasalready been applied.

See the documentation for Applying Conditions to Permit.

22


Setting Up Autonumbering Set up autonumber rules to increment identifying numbers for documents such as permits and invoices. The identifyingnumbers can include multiple parts, and each part can represent either a sequential number, static text, or a date.

You add, modify, and delete autonumber rules on the Autonumber page.

This example illustrates the Autonumber Details page.

Adding an Autonumber Rule1. Select Common Setup > Autonumber.2. On the Autonumber page, click Add.3. On the Autonumber Details page, enter values for the fields in the Rule Header section:


Rule Name

Enter a unique name for the rule.

Copy Existing Rule

Click this link to copy the rule definition from an existing autonumber rule. The copy actioncopies the number type and the reset frequency as well as the actual rule definition.

23



Clicking the link opens a a modal window with a list of existing autonumber definitions.Locate the definition you want to copy, then click the Select button for that definition

Description

Enter a description for the autonumber rule.

Maximum Size

Indicate the maximum length of the generated number.

Note:As you set up your autonumber rule, take care that the maximum size of theautonumber accommodates the maximum length of each part of the identifier plusany separators that you define.

Number Type

Select the type of object to that can use this autonumber rule:

◦ Cashier Session

Note:If you select this number type, make sure that the parts that you define for the rulehave a part type of Sequential only.

◦ Inspection

◦ Invoice

◦ Permit

◦ Project

◦ Receipt

These values are defined on the Lookup Type Details page for theORA_PSC_CC_AUTONUM_TYPE lookup type.

Reset Sequential Number

The identifier that an autonumber rule generates can include a mix of static text, a date, anda sequential number. Select how often the sequential number portion of the identifier is resetto zero:

◦ None: Sequential numbers continue to increment as defined without resetting.

◦ Monthly: The sequential number portion of the identifier resets to zero at the beginningof each month.

◦ Yearly: The sequential number portion of the identifier resets to zero at the beginningof each year.

4. In the Rule Definition section of the page, enter the number of parts, or segments, for the rule:


Number of Parts

Select the number of parts, or segments, comprising the rule, up to 5 parts. Segments canbe static text, a date, or a sequential number. For example, the identifier IVC-0000010067-OCT10 is made of 3 segments (static text,then a sequential number, then a date) separated by hyphens. The identifier INVOICE_001is made of 2 segments (static text and a sequential number) separated by an underscore.

24



When you select the number of parts, the corresponding number of rows appear in the ruledefinition grid. For example, if there are two parts, then rows labeled Part 1 and Part 2appear.

5. In the rule definition grid, select the part type for each row, then enter the related information in the additional fieldsthat appear.

Part Type Related Information

Static Text

In the unlabeled field that appears next to the part type, enter text that remains the same forall identifiers. For example, enter IVC or INVOICE. Cashier session IDs must be numeric, so don't include any static text in an autonumberdefinition with the Cashier Session number type.

Sequential

a. In the unlabeled field that appears next to the part type, enter the next documentnumber to use. The number must be 1 or greater. The system increases this numberby one each time a new identifier is generated and saved.

b. In the Maximum Length field, Enter the maximum number of digits for the sequentialnumber. Select a number from one to ten.

c. Select the Zero Padding check box to add zeros before the generated number tomake up the number of digits in the definition. For example, if the maximum length ofthis part is 5 digits, and the current number is 15, zero padding formats this part as00015.

Date

In the unlabeled field that appears next to the part type, select the date format. The available date formats are made of these date codes in various combination:

◦ Years: YYYY represents the year with its full four digits, and YY represents the year byits last two digits.

◦ Months: MM represents the month as a two-digit number, and MMM represents themonth as a three-character abbreviation such as JAN for January.

◦ Days: DD represents days as two-digit numbers. This is the only option for days.

◦ Quarters: Q represents quarters. For example, the code for the first quarter of the yearis 1.

Cashier session IDs must be numeric, so don't include any dates in an autonumberdefinition with the Cashier Session number type.

6. In the rule grid, select a Separator to appear after each part except the last.

Select from the following separators:

◦ (None)

◦ - (hyphen)

◦ / (forward slash)

◦ * (asterisk)

7. Verify the generated number for the selected date format and separators in the Next Number Preview field.8. Click Save.

An error appears if the overall maximum size of the autonumber doesn’t accommodate the maximum lengths of all ofthe parts and separators that you define.

25


Modifying an Autonumber Rule1. Select Common Setup > Autonumber.2. On the Autonumber page, click the row you want to modify.3. Update the rule header and rule definition fields on the Autonumber Details page.4. Click Save.

Deleting an Autonumber Rule1. Select Common Setup > Autonumber.2. Click the row you want to modify.3. On the Autonumber Details page, click Delete.

Setting Up Contact Types A contact type describes the role or position of a contact person for a permit.

Contact types apply only to permit contacts, not to profile contacts. Permits have contacts if the Contact List element isincluded in the permit application.

You add, modify, and delete contact types on the Contact Type page.

Adding a Contact Type1. Select Common Setup > Contact Type.2. On the Contact Type page, click Add.3. On the Contact Type Detail page, enter values for the following fields:


Contact Type

Enter the type of contact, such as Business Owner, Individual, or Emergency Contact.

Description

Enter a description of the contact type.

4. Verify that the Enabled switch is turned on.The switch is on by default for a new contact type.

5. Click Save.

Modifying a Contact Type1. Select Common Setup > Contact Type.2. Click a row on the Contact Type page.3. On the Contact Type Detail page you can:

◦ Update the contact type description. Only the Description field can be changed.

◦ Turn off the Enabled switch to deactivate the contact type.

4. Click Save.

26


Deleting Contact Types1. Select Common Setup > Contact Type.2. To view a definition before deleting it, click the row to be deleted, then click the Delete button on the Contact Type

Details page.3. To delete one or more definitions without viewing details:



Setting Up Code Types Code types are specific published codes, guidelines, ordinances, and so forth. Examples might include the InternationalBuilding Code, published by the International Code Council (ICC), and the National Fire Code, published by the National FireProtection Association (NFPA).

You add, modify, and delete code types on the Code Type page.

Adding a Code Type1. Select Common Setup > Code Type.2. On the Code Type page, click Add.3. On the Code Type Detail page, enter values for the following fields:


Code Type ID

Enter a unique code type ID for a specific code type. For example, enter IFC for InternationalFire Code.

Name

Enter the complete name of the code type.

Description

Enter a description of the code type.

4. Click Save.

Modifying a Code Type1. Select Common Setup > Code Type.2. Click a row on the Code Type page.3. On the Code Type Detail page you can update the code name and description.4. Click Save.

Deleting Code Types1. Select Common Setup > Code Type.

27


2. To view a definition before deleting it, click the row to be deleted, then click the Delete button on the Code TypeDetails page.

3. To delete one or more definitions without viewing details:



Setting Up Code References Code references provide detailed specifications that come from a broad range of codes, guidelines, ordinances, and so forth.Even if the source document does not use the word “code,” use the Code References pages to enter the information into thesystem. A code reference maps to a specific section in the source document.

You add, modify, and delete code references on the Code Reference page.

This example illustrates the Code Reference Details page.

28


PrerequisitesBefore you set up code references, you must define:

• Code types, which represent specific published documents that contain codes, guidelines, and so forth.

See Setting Up Code Types.

• Standard types, which describe the different fields or disciplines that codes relate to. Examples might include firesafety or electrical systems.

Set up standards types by defining values for the ORA_PSC_CC_STD_CODE_TYPE lookup type. Define thesevalues on the Lookup Type pages. See Setting Up Lookups.

Adding a Code Reference1. Select Common Setup > Code Reference.2. On the Code Reference page, click Add.3. On the Code Reference Detail page, enter values for the following fields:


Standard Type

Select the type of standard that the code falls under. Standard types represents fields ordisciplines such as Materials, Engineering, or Installation.

Standard Name

Enter the title of the section that contains this code reference. This title comes from thesource document.

Code Section

Enter the section number for this code reference. The number uniquely identifies thisreference within the source document.

Effective Start Date and EffectiveEnd Date

Enter the official effective start date of the code reference, and optionally enter an end date.

Code Type

Select a code type from the values that you defined on the Code Type page. The code typeidentifies the source document. See Setting Up Code Types

Description

Enter a description of the reference.

URL

Enter a URL link to the source document.

Content

Enter detailed content copied from the source document.

4. Click Save.

Modifying a Code Reference1. Select Common Setup > Code Reference.2. Click a row on the Code Reference page.

29


3. On the Code Reference Detail page, make any necessary changes.4. Click Save.

Deleting a Code Reference1. Select Common Setup > Code Reference.2. Click a row on the Code Reference page.3. On the Code Reference Detail page, click Delete.


Setting Up Public Users Public user setup includes configuration options related to public user registration and account management.

This image illustrates the Public User Setup page.

To set up public users:

1. Select Common Setup > Public User Setup.2. In the Registration section of the page, configure these options related to the public user registration process:


Require the user to accept theterms of use before registering

Select this check box if public users must accept your terms of use as part of theregistration process.

30



Terms of Use ID

If you require public users to accept your terms of use during registration, select the terms ofuse definition for the registration process. This field is visible only if the Require the user to accept the terms of use beforeregistering check box is selected.

Note:If you change the Terms of Use ID, users who have already registered are requiredto accept the new terms the next time they sign in. In this scenario, a window withthe new terms opens as soon as the public user signs in. The user must select theagreement check box in order to continue.

Ask if the user is a member oflaw enforcement or a judicialagency

Select this check box if public users must answer a question that asks if the user is amember of the specified groups. If this option is active, name and contact information forusers who are members of these groups are masked from public view.

Verify the law enforcement orjudicial agency status

Select this check box if individuals are considered members of law enforcement or a judicialagency only after agency staff verifies the user’s information. If this check box is not selected, no further verification is required when users self-identify asmembers of these groups. This check box is visible only if the Ask if the user is a member of law enforcement or ajudicial agency check box is selected.

3. In the Account Management section of the page, select the check boxes for any profile information that agencystaff must verify.


Contractor status

Select this check box if agency staff must verify the contractor status of a public user whoself-identifies as a contractor.

License

Select this check box if agency staff must verify all licenses that are added to a user profile.Public users can add one license during the registration process. Public users and agencystaff can add additional licenses using account management functionality.

Payment account

Select this check box if agency staff must verify all payment accounts (also called trustaccounts) that are added to a user profile. Public users and agency staff can add additionalpayment accounts using account management functionality.

4. Click Save.

Setting Up Public User Roles To ensure that registered public users have appropriate system access, you must define which role is assigned to the userIDs that are created during the registration process.

31


When a public user registers, the Oracle system assigns a single role to the new user. Because the user is assigned just onerole, access to different areas of the system is established through a role hierarchy. In this hierarchy, the various roles thatprovide access to different areas of the system are all children of a single parent role that you create.

Setting up public user roles involves these steps:

1. Use the Security Console to create a specific set of roles for public user:

This step is explained in detail in the topic Creating Custom Roles for the Permits Service. It consists of thesetasks:

a. Create custom roles that provide access to permit-related functionality.b. Create the single role assigned during user registration, and set up its role hierarchy.

In the hierarchy, the child roles include the delivered PSC Registered Public User role as well as the additionalroles that you created for permit access.

Note: Do not use the delivered PSC Registered Public User as your single role for registered publicusers. This role does not provide access to permit-related functionality.

2. Use the Public User Roles page to identify the role to be assigned during user registration.

Identifying the Single Role to be Assigned During Public User RegistrationTo identify the single role to be assigned during public user registration:

1. Select Common Setup > Public User Roles.2. If the Public User Roles page already lists a role, delete it before you add the new role.

CAUTION: Although this page will allow you to add multiple roles, only a single role can be assigned tothe public user. You cannot modify existing rows on this page, so you must instead delete the existing rowbefore you add a new one.

To delete an existing row:

a. Click the row to access the Role Details page.b. Click Delete.

3. On the Public User Roles page, click Add.4. On the Role Details page, use the Role ID field to select the single role to be assigned during the public user

registration process.

The Role ID is the only enterable field on the Role Details page. To select a role based on the descriptive role namerather than the numerical role ID, use the prompt button for the Role ID field, then expand the Search Criteriasection of the lookup page so you can search by role name.

Note: If you correctly followed the instructions for creating the single role to be assigned toregistered public users, the role name is PSC Custom Registered Public User and the role code isCUSTOM_PSC_REGISTERED_PUBLIC_USER.

5. Click Save.

32


Setting Up Terms of Use The Terms of Use page stores rules and guidelines to which user must agree as a condition of using a service. The terms actas a legal contract. They are also known as Terms and Conditions or Terms of Service. When you set up terms of use, youcan make the terms available to the public user registration process, to the permit application process, or to both.

You add, modify, and delete terms of use definitions on the Terms of Use page.

This example illustrates the Terms of Use Details page.

Adding Terms of Use1. Select Common Setup > Terms of Use.2. On the Terms of Use page, click Add.3. On the Terms of Use Details page, enter values for the following fields.


Terms of Use ID

Enter an identifier for the terms of use definition. If a definition changes over time, create multiple definitions with the same ID and neweffective dates. The effective dates of the different versions must not have gaps or overlap.

33




Enter effective date information for your definition. The start date is the first day the definitionis valid. You can enter a fixed end date if the terms expire on a known date. You can also leave theend date Open if the definition does not have a known expiration date. After a definition is saved, the end date becomes read-only. To update the terms, create a new definition with the same Terms of Use ID and a neweffective start date. The system provides logic to prevent gaps or overlaps in the effective-dated history. For example, if the original definition has an Open end date, then when youcreate the new definition, the old definition’s end date changes to the day before the newdefinition goes into effect. When multiple effective-dated versions of a definition exist, the Terms of Use page lists onlythe current version. To access other versions, click the row to access the Terms of UseDetails page, then click the All Dates button to view all versions of the definition and tocreate new effective-dated versions. The All Dates button is not active when you add a new terms of use.

Description

Enter a description of the terms of use. This is not part of the Terms of Use text that publicusers see.

Usage

Select the Permits check box to make this terms of use available for permits functionality.This option makes the definition available to the Terms of Use ID field on the Permit Detailspage. Note that it is also necessary to add the Terms of Use element to the permit form. Select the Registration check box to make this terms of use available for registrationfunctionality. This option makes the definition available to the Terms of Use ID field on thePublic User Setup page. See Setting Up Public Users. You must select at least one check box.

Content

Enter and format the detailed content of the terms to which a user must agree. This is thetext that users see when they are asked to agree to the terms.

4. Click Save.

Modifying Terms of Use1. Select Common Setup > Terms of Use.2. Click a row on the Terms of Use page.3. On the Terms of Use Details page, you can update the effective start date, description, usage and content.4. Click Save.

Managing Effective-Dated Terms of Use DefinitionsThis example illustrates the Terms of Use Details modal page that displays the effective-dated history of a terms of usedefinition.

34


1. Select Common Setup > Terms of Use .2. Click a row on the Terms of Use page to open the Terms of Use Details page.3. Click the All Dates button to view the effective-dated history of the definition you opened.4. Expand the Common Data section to see the Terms of Use ID.5. Expand the History section to see a list of all versions of this terms of use definition.

Click a history row to open the Terms of Use Details page for the specific row.6. Click the Add button in the History section to create a new version of the definition.

In the new definition, you can modify any of the data except for the Terms of Use ID. You must enter new effectivedates that do not create gaps or overlaps in the definition history.

Deleting Terms of Use1. Select Common Setup > Terms of Use.2. Click a row on the Terms of Use page.3. On the Terms of Use Details page, click Delete.

You are prompted to confirm the permanent deletion.

Setting Up Communication Events Oracle Public Sector Compliance and Regulation delivers a robust registry of communication events that are triggered bytransactions and processes within the application. For example, scheduling an inspection triggers the Inspection Scheduledcommunication event.

While these communication events are delivered, agency users define the content and recipients of the communications thatthe events generate using communication templates. Agency users add, modify, and delete communication templates on theCommunication Event Details page.

Adding Communication Templates1. Select Communication Center > Events .

35


2. Click the row on the Communication Event page for which you want to add a template.3. On the Communication Event Details page, click Add in the Communication Template grid.4. On the Communication Template Details page, enter values for the following fields:


Code

Enter a unique identifier code for the communication template.

Note:To make the code unique, Oracle recommends that you create it using a portionof the communication event name. For example, you might use SUB01 for theemail template of the Application Submit communication event. This is becausecommunication template codes must be unique across all communication events.If you create a communication template for one event that has the same code as atemplate for another event, you will receive an error when you try to save it.

Name

Enter a name for the communication template.

Channel Type

Specify the type of communication that this template generates. Values are:

◦ Alert: Generates text that is displayed to users when they log in to the application.

◦ Email: Generates an email that is sent to users.

◦ Notification: Generates a notification that appears when users click the notificationicon in the application.

Note:The fields that are available to define on this page vary depending on the channeltype that you select.

Visibility

Select which type of user can see this communication. Values are:

◦ Account owner

◦ Public user

◦ Agency staff only

Enabled

Turn this switch on to activate the communication template. When this switch is turnedoff, the application does not generate the communication when the associated event istriggered.

Start Date Time and End DateTime

Enter the time period for which the alert is displayed.

Note:These fields appear only for the Alert channel type.

MIME Type (Multipurpose InternetMail Extensions type)

Select the format of the email that this communication template generates. Values are:

◦ HTML

◦ Text

36



Note:This field appears only for the Email channel type.

Notification Priority

Turn this switch on to display notifications generated by this communication template at thetop of the notification list.

Note:This field appears only for the Notification channel type.

User Can Delete

Turn this switch on to enable users to delete notifications generated by this communicationtemplate from their notification lists.

Note:This field appears only for the Notification channel type.

Select and Insert

These fields enable you to insert variable attributes into your communications. You select thefield and the attribute that you want to insert in that field, and click Insert to enter a variablefor that attribute.

For example, if you select the Body field and the Permit ID attribute, and click Insert,the ${Permit ID} variable is inserted into the Message Body field of the communicationtemplate.

Whenever the application generates a communication using this template, it inserts thepermit ID that is associated with the triggered communication event into the body text.

37



Remarks

Enter any additional information about the communication template. These remarks are notincluded in the generated communication.

From

Enter the email address of the person or organization who is sending the generated email.

To

Enter the email addresses or user IDs of the people or organizations that you want to receivethe communication.

Note:Enter email addresses for the Email channel type, and user IDs for the Alert andNotification channel types.

Cc and Bcc

Enter the email addresses of the people or organizations that you want to receive a copy orblind copy of the communication.

Note:These fields appear only for the Email channel type.

Subject

Enter a brief description of the purpose and content of the communication.

Note:This field appears only for the Email and Notification channel types.

Message Body

Enter the main body text of the communication. For the Alert channel type and the Email channel type with the Text MIME type, you canenter only plain, unformatted text. For the Notification channel type and the Email channel type with the HTML MIME type, youcan enter rich text, links, and images.

5. Click Save.

Modifying Communication Templates1. Select Communication Center > Events .2. Click the row on the Communication Event page for which you want to modify a template.3. Click the row in the Communication Template grid that you want to modify.4. On the Communication Template Details page you can:

◦ Click Clone to create a copy of the communication template.

◦ Update the communication template field values.

Note: You cannot edit the Code or Channel Type fields.

38


5. Click Save.

Deleting Communication Templates1. Select Communication Center > Events .2. Click the row on the Communication Event page for which you want to delete templates.3. Click Edit in the Communication Template grid.4. Select the check boxes next to all of the communication templates that you want to delete.5. Click Delete. You will be prompted to confirm the permanent deletion.

Setting Up Reports Oracle Public Sector Compliance and Regulation delivers four reports. The report parameters that you define filter the datathat is generated for the reports.

You add, modify, and delete report parameters on the Report Configuration Details page.

Adding Report Parameters1. Select Common Setup > Report Configuration .2. Click the report row on the Report Configuration page for which you want to add a parameter.3. On the Report Configuration Details page, click Add in the Parameters grid.4. Enter values for the following fields:


Parameter ID and ParameterName

Enter a unique ID and name for the report parameter.

Parameter Data Type

Enter the data type for the report parameter.

Control Object and Control Name

Enter a field from which the report receives data along with a name for that field.

5. Click Save.

Modifying Report Parameters1. Select Common Setup > Report Configuration .2. Click the report row on the Report Configuration page for which you want to modify a parameter.3. Click the row in the Parameters grid that you want to modify.4. You can:

◦ Update the report parameter field values.

◦ Delete the report parameter. You will be prompted to confirm the permanent deletion.

5. Click Save.

39


Deleting Report Parameters1. Select Common Setup > Report Configuration .2. Click a row on the Report Configuration page.3. Click Edit in the Parameters grid.4. Select the check boxes next to all of the report parameters that you want to delete.5. Click Delete. You will be prompted to confirm the permanent deletion.

Setting Up Lookups This topic describes how to add and change values that appear in lookup lists. Lookup lists are referenced by various fields inthe application that display a static set of values from which the end user can select a value.

Lookup Types and Lookup Values OverviewLookup types in applications are used to represent a set of codes and their translated meanings. To the end users, a lookuptype displays a list of values from which they select values.

You use the Lookup Types page to access lookup types, and you use the Lookup Type Details page to modify lookup types,add lookup values, and add lookup types, where authorized.

When working with lookups, you deal with lookup types and lookup values.

Lookup Element Description

Lookup Type

A lookup type is a static list of values users view to make entries in the application. The applicationreferences a lookup type to display its list of values.

Lookup Value

A lookup value is a single item contained within a lookup type. For example, Paid is a lookup valuefor the Fee Status lookup type. Lookup types typically contain numerous lookup values.

Lookup types are delivered as seed data for your service. You can only modify selected lookup types, such as BusinessType, UOM Type, Standard Code Type, and so on. Most lookup types are read-only.

40


Modifying Lookup Types

To modify a lookup type:

1. Select Common Setup > Lookups.2. On the Lookup Types page use the Search box to filter the lookup types by keyword.

For example, to view the Business Type lookup type, enter business in the Search box.3. Click on the row for the lookup type you want to view.4. View the contents of the Lookup Type Details page.


Lookup Type

Identifies the lookup type within the application.

Application

Identifies the application that uses the lookup type. For example, Permits, CommonComponents, and so on.

Meaning

The actual UI display name used to represent the list of values contained in the lookup type.

Configuration Level

Indicates at what level the lookup can be modified. Options are:

◦ System: Only Oracle development teams can modify lookup types at this configurationlevel.

◦ Extension: Customers can perform minimal tasks, such as add lookup values.

◦ User: Customers can add lookup values, delete lookup values, update the meaning,and update the description.

Module

The internal application module using the lookup type, such as Billing Entry, Billing Setup,and so on.

Description

Identifies the purpose and use of the lookup type.

5. If you need to add lookup values, refer to the following section for steps for that task.

41


6. Click Cancel to close the lookup type, or click Save if you made any changes.

Adding Lookup Values

You can add lookup values to lookup types with a configuration level set to User or Extension.

To add lookup values:

1. Select Common Setup > Lookups.2. On the Lookup Types page use the Search box to filter the lookup types by keyword.

For example, to view the Business Type lookup type, enter business in the Search box.3. Click on the row for the lookup type you want to view.4. On the Lookup Type Details page, click Add under Lookup Value Type.5. On the Lookup Value Details page, enter these values:

42



Lookup Code

An internal application code for each lookup value that is not visible to users. It is typicallya shorter, less user-friendly representation of the item. For example, ORA_DRIVER_LIC forState Driver’s License, or LEN for Length, if listing units of measurement.

Display Sequence

Control in what sequence the lookup value appears in the list displayed to users, where 2appears above 3. If you do not specify a sequence, the application displays the items in theorder they were entered.

Enabled

Turn on to make a lookup value active. If a lookup value is not enabled, then the applicationdoes not display it to the end user in the list of values for that lookup type.

Start Date

Set a start date for the lookup value to become active. Even if the lookup value is enabled,if a start date is set, the application does not display the lookup value until the start date isreached.

End Date

Set an end date for a lookup value to no longer be displayed in a list of values.

Meaning

The display name for the lookup value. End users see this value in the list of values displayedat run time. They do not see the Lookup Code value.

Description

Provide any additional information to help identify the purpose of the lookup value orclarification regarding what it represents.

Tag

Tags allow you to add a label to your lookup codes. A tag can be used to categorizelookups based on facilitating searches or guiding how a lookup should be used.

6. Click Save.

Working with Configuration LevelsThe configuration level attribute determines who can modify a lookup type and what can be modified. The configuration levelsare:

• System: Only Oracle development teams can modify lookup types at this configuration level.

• Extension: Customers can perform minimal tasks, such as add lookup values.

• User: Customers can add lookup values, delete lookup values, update the meaning, and update the description.

Task User Extension System

Add a lookup type

Yes

No

No

Delete a lookup type

Yes

No

No

Modify lookup type meaning

Yes

No

No

Modify lookup type description

Yes

No

No

43


Task User Extension System

Add lookup values

Yes

Yes

No

Delete lookup values

Yes (if you created it)

Yes (if you created it)

No

Modify lookup value attributes

Yes (except for Lookup Code)

Yes (if you created it, and exceptfor Lookup Code)

No

Adding Lookup TypesTo add a lookup type:

1. Select Common Setup > Lookups.2. On the Lookup Types page click Add for the Lookup Type grid.3. On the Lookup Type Details page, enter these values:

◦ Lookup Type (The value you enter must be uppercase and cannot begin with the prefix ORA_, which is usedto distinguish your custom lookup types from delivered lookup types.)

◦ Meaning

◦ Module

◦ Description

4. Click Add for the Lookup Value grid for each lookup value you need to add to the lookup type.5. Click Save.

44

Implementing Oracle Public Sector Permits Chapter 3Setting Up Your Agency Staff

3 Setting Up Your Agency Staff

Setting Up a Fusion Business Unit and Legal Entity This topic discusses the one-time setup for Public Sector Compliance and Regulation administrators who are not usingFusion Human Capital Management (HCM), Enterprise Resource Planning (ERP), and Sales Cloud.

The following setup steps are prerequisites for creating an agency staff in the system.

Note: For Fusion HCM, ERP, and Sales Cloud customers, these steps are not required as the business unit andlegal entity are already set up.

Configure the following tasks in the order mentioned here:

1. Setting up reference data sets (to create a Set ID)2. Creating a business unit3. Creating a legal address4. Creating a Legislative Data Group5. Creating a Legal Entity6. Registering a Legal Entity7. Creating Legal Entity HCM Information

Setting up Reference Data Sets1. Navigate to the Setup: Public Sector Permits page and select the Agency Staff functional area.2. On the right panel locate the Manage Reference Data Sets task and click the row to open the Manage Reference

Data Sets page.3. On the Manage Reference Data Sets page, click the New button and include values for the fields:


Set Code

Enter a code value that represents your agency.

Set Name

Enter a name that represents your agency.

Description

Enter a description about your agency.

4. Click Save and Close to save the newly created SetID.

Creating a Business Unit1. Navigate to the Setup: Public Sector Permits page and select the Agency Staff functional area.2. On the right panel locate the Manage Business Units task and click the row to open the Manage Business Units

page.3. On the Manage Business Unit page, click the New button and include values for the fields:

45



Name

Enter a name for the business unit.

Default Set

Select the SetID you created in the previous section

4. Click Save and Close to save the newly created business unit.

Creating a Legal Address1. Navigate to the Setup: Public Sector Permits page and select the Agency Staff functional area.2. On the right panel, locate the Manage Legal Addresses task and click the row to open the Manage Legal Addresses

page.3. On the Manage Legal Addresses page, click the New button and enter the agency address in the Agency Line 1

field. The other fields are optional.4. Click OK to return to the Manage Legal Addresses page and click Save and Close to save the newly created

address.

Creating a Legislative Data Group1. Navigate to the Setup: Public Sector Permits page and select the Agency Staff functional area.2. On the right panel, select the task named Manage Legislative Data Group and click Select to open the Manage

Legislative Data Groups page.3. On the Manage Legislative Data Groups page, click Create to enter the new legislative data group details.4. Enter your legislative data group name in the Name field. Search and select your country from the Country field.5. Click Submit to save and return to the Manage Legislative Data Group page.6. Click Done.

Creating a Legal Entity1. Navigate to the Setup: Public Sector Permits page and select the Agency Staff functional area.2. On the right panel, locate the task named Manage Legal Entity and click to open the Select Scope page.3. On the Select Scope page select the Manage Legal Entity task radio button.4. Click the Legal Entity drop-down and select Create New. Click Apply and Go to Task button to open the manage

Legal Entities page.5. On the Manage Legal Entities page, click the New button to open the Create Legal Entity page and enter values for

the fields:


Country

Select the country (United States is the default selection)

Name

Enter the name of your agency

Legal Entity Identifier

Enter a code for your agency

Payroll Statutory Unit

Select the checkbox

Legal Employer Select the checkbox

46



Legal Address

Select the legal address (created in the previous section) using the Search and Select page.

EIN or TIN

Enter your agency’s EIN or TIN value. You can enter a value of your choice if you do nothave EIN or TIN for your agency.

Note:If you are using Fusion HCM or Fusion ERP, the value you enter here must belegitimate. It is recommended that you refer to Fusion documentation to know aboutthe required value for entry in the field.

Legal Reporting Unit RegistrationNumber

Enter your agency’s legal reporting unit registration number. You can enter a value of yourchoice if you do not have a registered number for your agency.

Note:If you are using Fusion HCM or Fusion ERP, the value you enter here must belegitimate. It is recommended that you refer to Fusion documentation to know aboutthe required value for entry in the field.

6. Click Save and Close to save the newly created legal entity.

Registering a Legal Entity1. Navigate to the Setup: Public Sector Permits page and select the Agency Staff functional area.2. On the right panel, select the task named Manage Legal Entity Registration and click Select to open the Select

Scope page.3. On the Select Scope page select the Manage Legal Entity Registrations task radio button.4. Click the Legal Entity drop-down and choose Select and Add. Select Click Apply and Go to Task button to open the

Manage Legal Entities page.5. On the Manage Legal Entities page expand the Search section and enter the legal entity name you created in the

previous section. Click Search.6. Select the row from the search results and click Save and Close, to save the entity and open the Manage

Registrations page.7. View your values on the new Manage Registrations page and click Done to confirm and complete the registration

process.

Creating Legal Entity HCM Information1. Navigate to the Setup: Public Sector Permits page and select the Agency Staff functional area.2. On the right panel, select the task named Manage Legal Entity HCM Information and click Select to open the Select

Scope page.3. On the Select Scope page select the Manage Legal Entity HCM Information task radio button.4. Click the Legal Entity drop-down and choose Select and Add. Click Apply and Go to Task button to open the

Manage Legal Entities page.5. On the Manage Legal Entities page expand the Search section and enter the legislative data group you created in

the previous section. Click Search.6. Select the row from the search results and click Save and Close, to save the entity and open the Legal Entity page.

47


7. On the Legal Entity page, click Edit and then click Update to open the Update Legal Entity page to enter an actionreason.

8. On the Update Legal Entity page, select Action Reason drop-down button and select the option Reorganization.Click OK to save and return to the Legal Entity page.

9. On the Legal Entity page, select the Payroll Statutory tab to associate the data group to the HCM legal entity.10. Under the Payroll Statutory Information section select the Associated Legislative Data Group drop-down. Search and

select the legislative data group you created using the previous section.11. Click OK to return to the Edit Legal Entity page. Click Submit and then click Done to complete the creation of a

Legal Entity HCM Information.

For information on creating an employee record, refer to the documentation on Managing Agency Staff Profiles.

Defining Job Titles This topic discusses how to define job titles for agency staff.

Defining Job TitlesAdministrators define new job titles using the Job Titles page:

1. Agency Staff > Job Title .2. The Job Title page lists all the job titles defined.3. Click the chevron for a row to open the Job Title Detail page and view and edit the details of the job title.4. Click Add to open the Job Title Detail page and define a new job title.5. Enter various details and click Save to save the new job title and return to the Job Title page.

Setting Up Agency Staff This topic provides an overview of job functions along with a list of delivered Job Functions, and discusses the how to set upFusion Business Units and Legal Entities for Oracle Public Sector Permits services.

Job Function OverviewJob functions are assignments made to staff members using the Manage Agency Staff page. Job Function helps you inassigning job specific attributes to an agency staff member. For example, you can assign the job function of a BuildingInspector to an agency staff member and set up attributes such as Inspector District and Schedule.

Job Function Section and Usage

Building Inspector

• Work Schedule — Inspections: Determine the work schedule of the Inspector.

• Inspection Districts — Inspections: Determine the districts an inspector is assigned to.

• Inspection Types — Inspections: Determine if the inspector can be assigned to a given typeof inspection.

• Permit Types

Business Analyst

• Inspection Districts

48


Job Function Section and Usage

• Inspection Types

• Permit Types

Chief Building Officer



• Permit Types

Inspector Supervisor

• Work Schedule — Inspections: Determine the work schedule of an Inspector supervisor.

• Inspection Districts — Inspections : Determine the districts an inspector is assigned to.

• Inspection Calendar


• Permit Types

Economic Development Officer

Permit Types

Finance Administrator



• Permit Types

Permit Technician



• Permit Types

Plan Coordinator

Permit Types

Plan Reviewer

Permit Types

Principal Planner

Permit Types

Cashier

• Permit Types

• Cashier ID — Cashiering: Determine Cashier ID of the Cashier

Setting Up Fusion HCM Business Units and Legal Entities for Public SectorCompliance and Regulation ServicesIf you are an existing Fusion customer and if you have already set up business units and legal entity, then you can assign thesame for your Agency Staff. However, if you are a new Public Sector Compliance and Regulation-only customer then as aprerequisite for entering Agency Staff data, you need to create one business unit and one legal entity that can be used foryour agency staff.

See Setting Up a Fusion Business Unit and Legal Entity

49


Configuring Agency Job Groups This topic provides an overview of the Agency Staff Group Configuration and discuss the procedure to configure agency jobgroups.

You can use the Agency Staff Groups for identifying a common set of Job attributes that can be applied to a group ofEmployees.

Groups provide the flexibility to assign attributes at various levels. You can define a group for a given department, division, orfor specific districts based on the commonalities of the job attributes.

Examples of Groups are:

1. Inspectors working in District A2. Permit Technicians responsible for Fence Permits

You can configure a group with default Job Functions and their attribute values for your users.

Users entering their employee profile information can select a group job function, which results in loading default job functionsand their attribute values automatically populated.

Note: Users cannot edit the job function attribute values on the Agency Staff page when using the Job Groupfunction.

Configuring Agency Job GroupsAdministrators set up and configure the agency staff group on the Job Group page. Agency users can select a group on theAgency Staff Profile page, and a default set of job functions and attribute values are assigned to the employee. To set up thejob functions and attributes for a group:

1. Select Agency Staff > Job Group .2. On the Job Group page, click Add to add a new group or Edit to change the group attributes. Click Add.3. Enter the details of the job group on the Job Group Details page.4. Verify that the Enabled switch is turned on if you want to enable this group when you save. This switch is turned on

by default for a new group.5. Under the Job Function section, click Add to select job functions and include their attributes.6. Click Save to return to the Job Group page.

Note: Agency users select the group from a list on the Agency Staff page. The job functions and theircorresponding attributes cannot be changed by users.

Managing Agency Staff Profiles This topic discusses how to manage agency staff profiles.

50


Managing Agency Staff ProfileAdministrators set up the agency staff profile on the Agency Staff page. Select Agency Staff.

1. Select Agency Staff2. On the Agency Staff page, click Add to add a new agency staff member – employee.3. On the Agency Staff Profile page, you add values to the various fields. For the Business Unit and the Legal Entity,

see the Setting Up a Fusion Business Unit and Legal Entity section of documentation.


Select Existing Fusion Worker

Turn on the switch to allow the search and selection of an existing Fusion employee. Thefollowing fields are display only, populating details from Fusion information:

◦ Person ID

◦ Person Number

◦ Hire Date

◦ Business Unit

◦ Legal Entity

◦ Generated User Account

◦ Send Credential Email

◦ User name

Worker ID

Enter an ID or click the prompt to open the Look Up page and search for the Fusionemployees. You can sort the search results by any of these:

◦ Worker ID

◦ First Name

◦ Last Name

◦ Email Address

◦ Hire Date

◦ Phone Number

◦ Business Unit Name

◦ Legal Employer

◦ Manager Person ID

Select an employee row from the search result on the Look Up page and the details arepopulated on the Agency Staff page.

Person Type

Select a type of staff member from the options: Employee

Enabled

Set a status for the staff member from the options:

◦ Active

◦ Inactive

51



Note:You set the status to Inactive when the employee is inactivated in your HR system.If you are a Fusion HCM/ERP/Sales Cloud customer then the inactivation ofEmployees in HCM will not automatically inactivate the Employee data in PublicSector Cloud. You must manually update this field.

Is a Supervisor

Turn on the switch if the employee is a supervisor.

Job Group

Select a group to assign a job group section with the relevant job functions. Accordingly, thesystem populates the Job Group Assignments section.

Note:You cannot make any changes to the values in the job group assignments on thispage. To update the values, navigate to the Job Group page.

4. Click Save to save the agency staff profile and return to the Agency Staff page.

Job Function Assignment without using Agency Job GroupsYou can assign job functions to employees directly, without having to use Job Groups.

1. On the Agency Staff page search and select the employee that you want to add job functions to.2. Under the Job Function section, click Add to select job functions and include their attributes.3. Click Save and return to the Agency Staff page to view the job function assignments.

To include job functions using Agency Job Groups, see the section Configuring Agency Job Groups.

Assigning Agency Security AccessAdministrators assign roles to various staff members. The security roles assigned to an employee determine the navigationsand data that the user can access.

1. Select Agency Staff and then select Agency Staff Access. The Agency Staff Access page lists all the agency staffmembers.

2. You can click the chevron for a row to view the employee access details. This page lists all the security rolesassigned to the employee user. You can add new security roles to the employee on this page.

3. Click the Add New Role button to open the Role Detail page and assign a role for the user.4. Click Save to save your changes and return to the Agency Staff Access page.5. Click Save to save the changes you made to the Agency Role details of the staff member.6. You can add or delete the security roles assigned to the user on this page.

Note: All Agency users must be assigned the PSC Agency Staff role. Additionally job specific roles can beassigned to the user. For the complete list of security roles, you can refer to the Security Reference Manual. Alsorefer to Using the Security Console.

52


Note: For users requiring access to Permits, in addition to the PSC Agency Staff and job specificroles such as PSC Permit Technician, PSC Plan Reviewer and others, you must assign thefollowing roles to the users: CUSTOM_MANAGE_PERMITS, CUSTOM_MANAGE_PERMITS, andCUSTOM_PSC_MANAGE_PERMITS_AGENCY.

53


54

Implementing Oracle Public Sector Permits Chapter 4Setting Up Property Information

4 Setting Up Property Information

Setting Up District Types You add, modify, and delete district types on the District Type page.

Adding a District Type1. Select Common Setup > District Type .2. On the District Type page, click Add.3. On the District Type Details page, enter values for the following fields:


District Type

Enter a unique identifier for the district type.

Description

Enter a description of the district type.

District Category

Select a category for the district type from the system-defined values:

◦ Inspection

◦ Economic Development

◦ Council

◦ Zoning

◦ General

4. Turn the Enabled switch on to make the row available as a lookup value on other pages.5. Click Save.

Modifying a District Type1. Select Common Setup > District Type .2. Click a row on the District Type page.3. On the District Type Details page you can:

◦ Update the district type field values.

Note: You cannot edit the District Type field.

◦ Enable or disable the district type using the Enabled switch. Only enabled district types are available to selectas values on other pages.

◦ Delete the district type. You will be prompted to confirm the permanent deletion.

55


Note: You cannot delete a district type that is already associated with a district or an inspectiontype.

4. Click Save.

Deleting District Types1. Select Common Setup > District Type .2. Click Edit.3. Select the check boxes next to the district types you want to delete.4. Click Delete. You will be prompted to confirm the permanent deletion.

Note: You cannot delete a district type that is already associated with a district or an inspection type.

Setting Up Districts You add, modify, and delete districts on the District page.

Adding a District1. Select Common Setup > District .2. On the District page, click Add.3. On the District Details page, enter values for the following fields:


District

Enter a unique identifier for the district.

Description

Enter a description of the district.

District Type

Select a district type from the agency-defined values. See Setting Up District Types.

4. Click Save.

Modifying a District1. Select Common Setup > District .2. Click a row on the District page.3. On the District Details page you can:

◦ Update the district field values.

Note: You cannot edit the District field.

56


◦ Delete the district. You will be prompted to confirm the permanent deletion.

4. Click Save.

Deleting Districts1. Select Common Setup > District .2. Click Edit.3. Select the check boxes next to the districts you want to delete.4. Click Delete. You will be prompted to confirm the permanent deletion.

Setting Up Parcels A parcel of real estate is a tract or plot of land.

A parcel that is held by an owner is a property. A parcel location can be found on a map and is associated with a physicaladdress. An owner or a contracted business can apply for a permit to develop or modify a structure on a parcel.

You add and modify parcels on the Parcel page.

Adding a Parcel1. Select Property Information > Parcel .2. On the Parcel page, click Add.3. In the Basic Information section of the Parcel Details modal page, enter information in the following fields:


Parcel Number

Enter the assessor’s parcel number (APN) for the parcel. The APN is a number assigned to parcels of real property by the tax assessor of a particularjurisdiction for identification and record-keeping purposes. The APN is unique within thejurisdiction, and may conform to certain formatting standards that convey basic identifyinginformation such as the property type or the location on a map.

Parcel Type

Enter a parcel type such as Condo or Single Family Home.

Enabled

Turn the Enabled switch on to make the parcel available as a lookup value on other pages.

4. In the Land Information section of the Parcel Details modal page, enter details about the land associated with theparcel using the following fields:

◦ Jurisdiction

◦ Property Description

◦ Primary Zoning ID

◦ Zoning Description

◦ Land Use Code

◦ Boundary Description

57


◦ Subdivision

5. In the Location Information section of the Parcel Details modal page, enter details about the parcel’s location usingthe following fields:

◦ Block Number

◦ Unit Number

◦ Lot Number

◦ Section Number

6. In the Map Information section of the Parcel Details modal page, enter mapping details for the parcel using thefollowing fields:

◦ Map Name

◦ Map Book Page

◦ Book Number

◦ Page Number

◦ Latitude

◦ Longitude

◦ X Coordinate

◦ Y Coordinate

7. Click Save.

Modifying a Parcel1. Select Common > Parcel .2. Select a parcel on the Parcel page.3. On the Parcel Details page you can:

◦ Update the parcel field values.

◦ Enable or disable the parcel using the Enabled switch. Only enabled parcels are available as lookup values onother pages.

4. Click Save.

Setting Up Parcel Addresses You add, modify, and delete parcel addresses on the Parcel Address page.

Adding a Parcel Address1. Select Property Information > Parcel .

Select a parcel on the Parcel page.

Click Parcel Address in the navigation bar.2. On the Parcel Address page, click Add.

58


3. In the Basic Information section of the Parcel Address Details page, you can:

◦ Turn the Enabled switch on to make the row available as a lookup value on other pages.

◦ Turn the Primary switch on to indicate that this is the primary address associated with the parcel. A parcelmay have only one primary address.

4. In the Address Information section of the Parcel Address Details page, enter the following information:


Zip Code

If you know the zip code for the address, enter it here. The system automatically populatesthe City and State based on the zip code you enter. If you don’t know the zip code, click the don’t know link to narrow down your choice of zipcodes by entering a city and state.



City and State

Enter the city and state for the address.

Postal Code

Enter the postal code for the address. The available values for this field are filtered based onthe city and state that you select.

5. In the Contact Information section of the Parcel Address Details page, enter the contact information details for theparcel address using the following fields:

◦ Name 1 and Name 2

◦ Email Address

◦ Home Phone Number

◦ Work Phone Number

◦ Cell Phone Number

◦ Fax Number

6. Click Save.

Modifying a Parcel Address1. Select Property Information > Parcel .


Click Parcel Address in the navigation bar.

Select an address associated with the parcel.

Note: Select Property Information > Property Address to select a parcel address to modify from alist of all parcel addresses.

59


2. On the Parcel Address Details page you can:

◦ Update the parcel address field values.

◦ Enable or disable the parcel address using the Enabled switch. Only enabled parcel addresses are availableas lookup values on other pages.

◦ Indicate whether this is the primary address associated with the parcel using the Primary switch.

3. Click Save.

Deleting Parcel Addresses1. Select Property Information > Parcel .


Click Parcel Address in the navigation bar.2. On the Parcel Address page, click Edit.3. Select the check boxes next to the parcel addresses that you want to delete.4. Click Delete. You will be prompted to confirm the permanent deletion.

Setting Up Parcel Owners You add, modify, and delete parcel owners on the Parcel Owner page.

Adding a Parcel Owner1. Select Property Information > Parcel .


Click Parcel Owner in the navigation bar.2. On the Parcel Owner page, click Add.3. In the Basic Information section of the Parcel Owner Details page, enter information in the following fields:


Enabled

Turn the Enabled switch on to make the row available as a lookup value on other pages.

Primary

Turn the Primary switch on to indicate that this is the primary owner associated with theparcel. A parcel may have only one primary owner.

Owner and Secondary Owner

Enter the names of the owner and secondary owner of the parcel.

Owner Type

Enter the type of owner for the parcel such as Personal or Town.

4. In the Location Information section of the Parcel Owner page, enter details about the location associated with theparcel owner using the following fields:

60



Zip Code

If you know the zip code of the owner’s address, enter it here. The system automaticallypopulates the City and State based on the zip code you enter. If you don’t know the zip code, click the don’t know link to narrow down your choice of zipcodes by entering a city and state.



City and State

Enter the city and state of the owner’s address.

Postal Code

Enter the postal code for the owner’s address. The available values for this field are filteredbased on the city and state that you select.

Street Number, Street Direction,Street Name, and Street Type

Enter the street information for the parcel owner.

Building Type

Enter the type of building associated with the parcel owner.

Floor

Enter the floor of the building for the parcel owner.

Unit Number

Enter the unit number for the parcel owner.

5. In the Contact Information section of the Parcel Owner Details page, enter the contact information details for theparcel owner using the following fields:

◦ Email Address

◦ Home Phone Country Code

◦ Home Phone Number

◦ Work Phone Country Code

◦ Work Phone Number

◦ Cell Phone Country Code

◦ Cell Phone Number

◦ Fax Country Code

◦ Fax Number

6. In the Transfer Information section of the Parcel Owner Details page, enter transfer details for the parcel owner usingthe following fields:

◦ Last Transfer Type

◦ Document Number

7. Click Save.

61


Modifying a Parcel Owner1. Select Property Information > Parcel .


Click Parcel Owner in the navigation bar.

Select an owner associated with the parcel.

Note: Select Property Information > Property Owner to select a parcel owner to modify from a list ofall parcel owners.

2. On the Parcel Owner Details page you can:

◦ Update the parcel owner field values.

◦ Enable or disable the parcel owner using the Enabled switch. Only enabled parcel owners are available aslookup values on other pages.

◦ Indicate whether this is the primary owner associated with the parcel using the Primary switch.

3. Click Save.

Deleting Parcel Owners1. Select Property Information > Parcel .


Click Parcel Owner in the navigation bar.2. On the Parcel Owner page, click Edit.3. Select the check boxes next to the parcel owners that you want to delete.4. Click Delete. You will be prompted to confirm the permanent deletion.

Associating Parcels with Districts You add, modify, and delete relationships between parcels and districts on the Parcel District page.

The association of parcels with districts is required setup for inspection scheduling. For more information, see Setting UpInspection Scheduling.

Adding a Parcel District Relationship1. Select Common > Parcel .


Click Parcel District in the navigation bar.2. On the Parcel District page, click Add.3. On the Parcel District Details page, enter the district you want to associate with the parcel in the District field.

62


4. Click Save.

Modifying a Parcel District Relationship1. Select Common > Parcel .


Click Parcel District in the navigation bar.2. Select a district on the Parcel District page.3. On the Parcel District Details page you can:

◦ Select a different district to associate with the parcel.

◦ Delete the parcel district relationship. You will be prompted to confirm the permanent deletion.

4. Click Save.

Deleting Parcel District Relationships1. Select Common > Parcel .


Click Parcel District in the navigation bar.2. Click Edit.3. Select the check boxes next to the parcel district relationships you want to delete.4. Click Delete. You will be prompted to confirm the permanent deletion.

Setting Up Parcel Values You add, modify, and delete parcel values on the Parcel Value page.

Adding a Parcel Value1. Select Common > Parcel Value .2. On the Parcel Value page, click Add.3. On the Parcel Value Details page, enter information in the following fields:


Parcel ID

Enter the ID of the parcel for which you are defining an address. For more information on parcels, see Setting Up Parcels.


Enter the date range for which the parcel value is valid.

Note:You can leave the Effective End Date field blank to give the parcel an open enddate.

63



Parcel Size 1 and Parcel Size 1UOM (parcel size 1 unit of measure)

Enter a numeric value and a unit of measure to define the size of the parcel.

Parcel Size 2 and Parcel Size 2UOM (parcel size 2 unit of measure)

Enter a numeric value and a unit of measure to define an additional size for the parcel.

Land Value

Enter the monetary value of the land associated with the parcel.

Improvement Value

Enter the monetary value of any improvements made to the parcel.

Personal Property Value

Enter the monetary value of any personal property associated with the parcel.

Fixtures

Enter the monetary value of any fixtures associated with the parcel.

Owner Exemption, FixtureExemption, and Other Exemption

Enter the monetary value of any exemptions associated with the parcel.

Net Assessed Value

Enter the assessed monetary value of the parcel.

Currency Code

Enter the currency that applies to the parcel value.

Property Use Code

Enter the property use code associated with the parcel.

Parcel Number

Displays the parcel number associated with the Parcel ID that you selected.

4. Click Save.

Modifying a Parcel Value1. Select Common > Parcel Value .2. Click a row on the Parcel Value page.3. On the Parcel Value Details page you can:

◦ Update the parcel value field values.

Note: You cannot edit the Parcel ID and Effective End Date fields.

◦ Delete the parcel value. You will be prompted to confirm the permanent deletion.

4. Click Save.

64

Implementing Oracle Public Sector Permits Chapter 5Setting Up Permits

5 Setting Up Permits

Setting Up Plan Review Statuses Use delivered plan review statuses to identify the progression through a plan review cycle. You can review the statuses on thestatus definition pages.

You review the plan review statuses on the Plan Review Status and Decision Status pages. You cannot delete the system-defined statuses or add new statuses, but you can modify the descriptions. The descriptions allow you to enter a differentstatus name to be displayed to agency staff.

The system derives the overall plan review status from the individual plan reviewer decisions, and updates the overall planreview with the most severe decision status. The system-defined decision statuses are listed here from most to least severe:Rejected, Revision Required, Approved with Comments, Approved, and Not Required. If plans have one or more rejections,or revisions are required, the applicant must correct the plans and resubmit them for another review cycle.

Modifying Plan Review Cycle StatusesYou can edit only the Description field on the Plan Review Status Details page. The agency-defined description is exposedto agency staff and public users on the plan review pages in the permit record detail.

1. Select Permit Setup > Define Status .2. Select the Plan Review Status tab.3. You can review the delivered review cycle statuses in the Review Status column:

◦ In Progress

◦ Canceled

◦ Completed

4. Select the row for the review status that you want to modify.5. On the Plan Review Status Details page you can edit only the description.6. Click Save to save any changes.

Modifying Plan Review Decision StatusesYou can edit only the Description field on the Decision Status Details page. The agency-defined description is exposed toagency staff and public users on the plan review pages in the permit record detail.

1. Select Permit Setup > Define Status .2. Select the Plan Review Decision tab.3. You can review the delivered plan review decision statuses in the Decision Status column:

◦ Approved

◦ Approved with comments

◦ Revision required

◦ Rejected

◦ Not required

65


The plan review decision statuses are delivered as enabled. The only review decision status that you can disable isApproved with comments.

4. Select the row for the decision status that you want to modify.5. On the Decision Status Details page you can edit only the description.6. Click Save to save any changes.

Setting Up Record Groups Record groups are the first level of categorization that you can select when you define your permit types.

If desired, you can set up permit record groups. This setup is not required.

Adding Record GroupsYou add record groups for permits on the Record Group page.

1. Select Permit Setup > Application Group .2. On the Record Group page, click Add New to add a new record group.3. On the Record Group Details page, enter a name for the record group.4. Enter a description.5. In the Available For field, select the check box for the permits product area.6. Verify that the Enabled switch is turned on. The option is active by default for a new record group.7. Click Save.

Modifying Record GroupsYou can modify or delete record groups for permits on the Record Group page.

1. Select Permit Setup > Application Group .2. On the Record Group page, select the row for the record group that you want to modify.3. On the Record Group Details page you can:

◦ Edit the description. You cannot change the record group name.

◦ Select the Available For check box for permits.

◦ Click the Enabled switch to enable or disable the record group.

4. Click Save to save any changes.5. If you want to delete the record group, click Delete.6. If you want to delete multiple record groups, you can delete them from the table on the Record Group page:

a. Click Edit.b. Select the check boxes for the record group rows to delete.c. Click Bulk Delete.

66


Setting Up Record Categories Record categories are the second level of categorization that you can select when you define your permit types.

If desired, you can set up permit record categories. This setup is not required.

Adding Record CategoriesYou can add record categories for permits on the Record Category page.

1. Select Permit Setup > Category .2. On the Record Category page, click Add New to add a new record category.3. On the Record Category Details page, enter a name for the record category.4. Enter a description.5. Select the Available For check box for permits.6. Verify that the Enabled switch is turned on. The option is active by default for a new category.7. Click Save.

Modifying Record CategoriesYou can modify or delete record categories for permits on the Record Category page.

1. Select Permit Setup > Category .2. On the Record Category page, select the row for the record category that you want to modify.3. On the Record Category Details page you can:

◦ Edit the description. You cannot change the category name.


◦ Click the Enabled switch to enable or disable the record category.

4. Click Save to save any changes.5. If you want to delete the record category, click Delete.6. If you want to delete multiple record categories, you can delete them from the table on the Record Category page:

a. Click Edit.b. Select the check boxes for the record category rows to delete.c. Click Bulk Delete.

Setting Up Record Subcategories Record subcategories are the third level of categorization that you can select when you define your record types.

If desired, you can set up permit record subcategories. This setup is not required.

67


Adding Record SubcategoriesYou can add record subcategories for permits on the Record Subcategory page.

1. Select Permit Setup > Subcategory .2. On the Record Subcategory page, click Add New to add a new record subcategory.3. On the Record Subcategory Details page, enter a name for the record subcategory.4. Enter a description.5. Select the Available For check box for permits.6. Verify that the Enabled switch is turned on. The option is active by default for a new subcategory.7. Click Save.

Modifying Record SubcategoriesYou can modify or delete record subcategories for permits on the Record Subcategory page.

1. Select Permit Setup > Subcategory .2. On the Record Subcategory page, select the row for the record subcategory that you want to modify.3. On the Record Subcategory Details page you can:

◦ Edit the description. You cannot change the subcategory name.


◦ Click the Enabled switch to enable or disable the record subcategory.

4. Click Save to save any changes.

Deleting Record Subcategories1. Select Permit Setup > Subcategory .2. On the Record Subcategory page, select the row for the record subcategory that you want to delete.3. On the Record Subcategory Details page, click Delete to delete the record subcategory.4. If you want to delete multiple subcategories, you can delete them from the grid on the Record Subcategory page:

a. Click Edit.b. Select the check boxes for the record subcategory rows to delete.c. Click Bulk Delete.

Setting Up Record Statuses Oracle provides a set of statuses for permit records to control system events. Some system statuses can be mapped to auser-defined record status.

Your agency assigns record statuses for permit records. You cannot delete the system-delivered record statuses, but youcan modify the description. You can also define additional record statuses, but you must associate any new record statuswith one of the system-delivered statuses to ensure correct processing.

Using Delivered Permit Record StatusesThis table lists the system-delivered permit record statuses and indicates whether they can be associated with a user-definedrecord status.

68


Record Status System Status Code Can be mapped to a user-defined recordstatus?

About to expire

ATE

No

Completed

CMP

Yes

Certificate of Occupancy

COO

Yes

Delinquent

DLQ

No

Denied

DNI

Yes

Expired

EXP

No

Inspection

INS

Yes

In Process

IPC

Yes

Payment Pending

PAY

No

Plan Review

PLR

Yes

Pending

PND

No

Pending Submittal

PDS

No

Permit Issued

PTI

Yes

Submitted

SUB

No

Voided

VOD

Yes

Withdrawn

WTH

No

When a guest submits a permit application, the record status is updated as follows:

Record and System Status Description

Pending (PND)

Applied when the guest saves an application.

Pending Submittal (PDS)

Applied when the guest submits an application.

Payment Pending (PAY)

Applied when fees are due.

Submitted (SUB) • Applied when no fees are due.

69


Record and System Status Description

• Applied after successful payment.

Adding Record StatusesDefine any additional statuses that your agency will use for permit records on the Define Status page. You must associate anew record status with a system status.

1. Select Permit Setup > Define Status .2. Select the Record Status tab.3. Click Add New to define a new record status.4. On the Record Status Details page, enter a name for the record status.5. Enter a description.6. Select the record status that you want to use from the drop-down list:

◦ Completed

◦ Certificate of Occupancy

◦ Denied

◦ Voided

◦ In Process

◦ Inspection

◦ Permit Issued

◦ Plan Review

7. Verify that the Enabled switch is turned on. The switch is turned on by default for a new record status.8. Click Save.

Modifying Record StatusesYou can modify the record statuses that you have defined for your agency’s permit records on the Define Status page.

1. Select Permit Setup > Define Status .2. Select the Record Status tab.3. Select the row for the record status that you want to modify.4. On the Record Status Details page you can:

◦ For user-defined record statuses, edit the description or the system status that you want to set on a recordwith this record status. You cannot edit the Record Status field.

◦ For system-delivered statuses, you can only edit the description. You cannot edit the Record Status field.

◦ Click the Enabled switch to enable or disable a user-defined record status. You cannot disable system-delivered statuses.

5. Click Save to save any changes.

Deleting Record StatusesYou can delete the record statuses that you have defined for your agency’s permit records on the Define Status page. Youcannot delete the system-delivered statuses; you can only modify their descriptions.

1. Select Permit Setup > Define Status .

70


2. Select the Record Status tab.3. Select the row for the record status that you want to modify.4. On the Record Status Details page, click Delete.

Note: You cannot delete system-delivered record statuses.

5. If you want to delete multiple record statuses, you can delete them from the table on the Record Status page:

a. Click Edit.b. Select the check boxes for the record status rows to delete.

Note: You can only select the record statuses that you have defined. You cannot select thesystem-delivered record statuses.

c. Click Bulk Delete.

Integrating With the Oracle Integration Cloud Oracle Autonomous Integration Cloud (OIC) provides the tools for setting up permit workflow processes. This topic providesinformation about setting up the integration between OIC and Oracle Public Sector Compliance and Regulation.

First you’ll use the Security Console to set up a proxy user that the public sector system uses to access OIC. Next you’ll go toOIC to set up two integration connectors: one for sending information to the public sector communications center, and onefor sending and receiving permit data.

The procedures that follow are for entering the specific information that is required by the Public Sector system. These arenot a substitute for familiarizing yourself with OIC. For more information about setting up integrations in OIC, refer to your OICdocumentation at https://docs.oracle.com/en/cloud/paas/integration-cloud/user-processes/integrating-applications-and-services.html.

The procedures related to setting up integration connectors require you to import code using files that you download from MyOracle Support (MOS). Each procedure includes a step for downloading specific files. It’s easier, however, if you downloadall of the files from the MOS document at once rather than returning to the document multiple times. To download the files,access the MOS document called Public Sector Compliance and Regulation: JSON Files for Permit Integration.

Note: Oracle provides a Solution Package with sample configurations for the integration connectors. You canclone these samples and use them as starting points for your own connectors, but the procedures in this topicexplain how to set the connectors up from scratch.

Creating an OIC Proxy Role and UserIn this procedure, you create a custom role, then you create a user manually and assign your custom role to that user. Youuse the Security Console to complete this task.

For more information on using the Security Console, see Working with Roles in the Security Console.

CAUTION: The role you create in this step should not be assigned to any user other than the OIC proxy user.

71

https://docs.oracle.com/en/cloud/paas/integration-cloud/user-processes/integrating-applications-and-services.html

https://docs.oracle.com/en/cloud/paas/integration-cloud/user-processes/integrating-applications-and-services.html


To create the OIC proxy user role:

1. Navigate to the Security Console.To navigate to the Security Console, you have these options:

◦ In Functional Setup Manager, click the task: Create Process Cloud Service Proxy User.

◦ Click Setup and Maintenance on the Agency Springboard, and on the Fusion Applications home page, select Navigator > Tools > Security Console.

2. On the Roles tab of the Security Console, click Create Role.3. On the Create Role: Basic Information page, enter PSCR Proxy User for OIC. in the Role Name field.4. In the Role Code field enter CUSTOM_PSCR_OIC_PROXY_USER.5. In the Role Category field, select Financials - Job Roles.6. In the Description field, enter This role should NOT be assigned to any user other than the OIC Proxy User.7. Click Next until you reach the Role Hierarchy page, and add these roles as child roles:

◦ ORA_PSC_UPDATE_PERMIT_STATUS_ALL_AGG

◦ CUSTOM_PSC_MANAGE_PERMITS

◦ CUSTOM_PSC_MANAGE_PERMITS_AGENCY

8. Click Next until you reach the Summary page.9. Click Save and Close.

To create the OIC proxy user:

1. Click the Users tab.2. On the Use Accounts page, click Add User Account.3. On the Add User Account page in the User Information section, enter a Last Name and User Name of your choice.4. Enter a Password of your choice and confirm it.5. Click Add Role for the Roles grid, and assign this role to your proxy user: CUSTOM_PSCR_OIC_PROXY_USER.6. Click Save and Close.

Note: You will add this proxy user to OIC process definitions.

Setting Up the Communication Connector and its POST OperationThe communications connector enables OIC to send data to the communications center in the Oracle Public Sector systemusing a POST operation. This connector is used when a workflow process definition includes a communication task such assending a permit applicant an email when the permit status changes.

To set up the communication connector and its POST operation:

1. Go to My Oracle Support, access the document called Public Sector Compliance and Regulation: JSON Files forPermit Integration, and download the following files that you will use later in this procedure:

◦ RequestCommunications.json

◦ ResponseCommunications.json

2. Access the main console in OIC.3. In the list of OIC applications, click the application with your permit workflow.4. Click the Integrations option in the left frame.5. Click the Create button, then in the pop-up menu under the Create button, select External > REST6. In the Create REST Connector window, enter the following:

72



Name

Enter a descriptive name such as CommunicationsConnector for the communicationsintegration.

Base URL

Enter the URL for your Oracle Public Sector Cloud REST API resources. The URL followsthis pattern, where ServerName is the server name for your instance of the application: https://ServerName/fscmRestApi/resources/11.13.18.05

Open Immediately

Select this check box if it is not already selected.

7. Click Create.

The Rest Connector Editor opens.8. To set up security for this integration, click the Edit link for the Configuration section.

Note: If you prefer to set up security when you activate the permit workflow application, you can skip thesecurity-related steps in this procedure and skip ahead to step 13. Setting up security now simplifies theapplication activation steps.

9. Click the Security tab.10. In the Security Type field, select APP Id - Basic Authentication.11. Complete these additional fields that appear after you select the Security Type:


Keystore Credential

If you previously created a keystore credential, select it. Otherwise, leave this field setto [New Key] so that the system will create the keystore credential when you apply yourchanges.

Key Name

If you selected [New Key] as the keystore credential, enter the name to give to the newkeystore. If you selected an existing keystore credential, this field is read-only and displays the keyname.

Username

Enter the user name for the process cloud proxy user that you previously created. If you’re using an existing keystore credential, that credential supplies a default username.

Password

Enter the password for the process cloud proxy user that you previously created. If you’re using an existing keystore credential, that credential supplies a default password.

12. Click Apply to save the security information and close the Configuration section.13. In the Resources section of the Rest Connector Editor, click Add.14. Expand the new Resource section that appears, and enter the following values:

73


Field Value

Name

OutboundCommunications

Path

publicSectorCommunicationRequests When added to the base URL, this completes the path to the communications-related RESTAPIs.

15. In the Operations section, click the Add button and then select POST operation from the drop-down menu.16. Click the new POST operation.17. Enter Trigger permit communications in the Documentation field.

You can leave the default values in the other fields, including leaving the Path field blank.18. Click Request19. Click the + icon next to the Body field to open the Import Business Object from JSON window.20. Enter RequestCommunications in the Name field.21. Click Schema.22.

Click the Import from File icon next to the Schema button.23. Locate and upload the RequestCommunications.json file that you downloaded from My Oracle Support.

The imported JSON code appears in the Import Business Object from JSON window.24. Click the Import button at the bottom of the window to save the code and close the window.25. Ensure that the following values now appear for the POST operation request:

Page Element Value

Body

BusinessData.RequestCommunications

Media Type

Custom

Media Type details

application/vnd.oracle.adf.resourceitem+json

26. Click Response.27. Click the + icon next to the Body field to open the Import Business Object from JSON window.28. Enter ResponseCommunications in the Name field.29. Click Schema.30.

Click the Import from File icon next to the Schema button.31. Locate and upload the ResponseCommunications.json file that you downloaded from My Oracle Support.

The imported JSON code appears in the Import Business Object from JSON window.

74


32. Click the Import button at the bottom of the window to save the code and close the window.33. Ensure that the following values appear for the POST operation response:

Page Element Value to Enter

Body

BusinessData.ResponseCommunications

Media Type

application/JSON

34. Click Apply.35. Click Save.

Setting Up the Permits ConnectorThe permits connector enables OIC to exchange permit-related information with Public Sector Compliance and Regulation.

Note: This procedure explains how to create the permits connector. Additional procedures that follow this oneexplain how to set up the operations for this connector.

To set up the permits connector:

1. Access the main console in OIC.2. In the list of OIC applications, click the application for your permit workflow.3. Click the Integrations option in the left frame.4. Click the Create button, then in the pop-up menu under the Create button, select External > REST5. In the Create REST Connector window, enter the following:


Name

Enter a descriptive name such as PermitsConnector for the permits integration.

Base URL

Enter the URL for your Oracle Public Sector Cloud REST API resources. The URL followsthis pattern, where ServerName is the server name for your instance of the application: https://ServerName/fscmRestApi/resources/11.13.18.05

Open Immediately

Select this check box if it is not already selected.

6. Click Create.

The Rest Connector Editor opens.7. If you want to set up security for this integration now, click the Edit link for the Configuration section.

Note: If you prefer to set up security when you activate the permit workflow application, you can skipthe security-related steps in this procedure and skip ahead to step 13, where you begin setting up theoutbound communications resource in this integration. Setting up security now simplifies the applicationactivation steps.

8. Click the Security tab.9. In the Security Type field, select APP Id - Basic Authentication.

75


10. Complete these additional fields that appear after you select the Security Type:


Keystore Credential

If you previously created a keystore credential, select it. Otherwise, leave this field setto [New Key] so that the system will create the keystore credential when you apply yourchanges.

Key Name

If you selected [New Key] as the keystore credential, enter the name to give to the newkeystore. If you selected an existing keystore credential, this field is read-only and displays the keyname.

Username

Enter the user name for the process cloud proxy user that you previously created. If you’re using an existing keystore credential, that credential supplies a default username.

Password

Enter the password for the process cloud proxy user that you previously created. If you’re using an existing keystore credential, that credential supplies a default password.

11. Click Apply to save the security information and close the Configuration section.12. Click Save

Adding the PATCH Operation for Permit Statuses

Note: Before starting this procedure, be sure to complete the procedure “Setting Up the Permits Connector.”

Permit workflow in OIC uses the PATCH operation to update the status of a permit.

To set up the PATCH operation:


◦ RequestPermitStatusUpdate.json

◦ ResponsePermitStatusUpdate.json

2. Access the main console in OIC.3. In the list of OIC applications, click the application for your permit workflow.4. Click the Integrations option in the left frame.5. Click the PermitsConnector integration.6. In the Resources section of the Rest Connector Editor, click Add.7. Expand the new Resource section that appears, and enter PermitResources in the Name field.8. In the Operations section, click the Add button and then select PATCH operation from the drop-down menu.9. Click the new PATCH operation.

10. Enter the following information:

Page Element Value

Name

patchPermitStatus

76


Page Element Value

Path

{permitResource}/{permitRecordKey} Although you can choose different names for the resource name and record keyparameters, this procedure assumes that you use the given values.

Documentation

Update permit status.

11. Click Request12. Click the + icon next to the Body field to open the Import Business Object from JSON window.13. Enter RequestPermitStatusUpdate in the Name field.14. Click Schema.15.

Click the Import from File icon next to the Schema button.16. Locate and upload the RequestPermitStatusUpdate.json file that you downloaded from My Oracle Support.

The imported JSON code appears in the Import Business Object from JSON window.17. Click the Import button at the bottom of the window to save the code and close the window.18. Ensure that the following values now appear for the PATCH operation request:


Body

BusinessData.RequestPermitStatusUpdate

Media Type

Custom

Media Type details

application/vnd.oracle.adf.resourceitem+json

19. In each row of the Parameters list, click the Enter a description text and enter a description.These are example descriptions:

Parameter Description

permitResource

Permit Resource Name

permitRecordKey

Permit Record Key

20. Click Response.21. Click the + icon next to the Body field to open the Import Business Object from JSON window.22. Enter ResponsePermitStatusUpdate in the Name field.23. Click Schema.24.

77


Click the Import from File icon next to the Schema button.25. Locate and upload the ResponsePermitStatusUpdate.json file that you downloaded from My Oracle Support.

The imported JSON code appears in the Import Business Object from JSON window.26. Click the Import button at the bottom of the window to save the code and close the window.27. Ensure that the following values appear for the PATCH operation response:

Field Value

Body

BusinessData.ResponsePermitStatusUpdate

Media Type

application/JSON


Adding GET Operations for Permit Data

Note: Before starting this procedure, be sure to complete the procedure “Adding a PATCH Operation for PermitStatuses.”

In this procedure, you will set up two GET operations for fetching permit data.

• GetPermitBaseData gets general permit data that is found in all permits, such as the permit type, the permit status,and the permit applicant.

• GetPermitFieldsData gets information from the permit application (the intake form whose fields are configured usingthe permit designer).

To set up the GET operations for permit data:


◦ ResponsePermitBase.json

◦ ResponsePermitFields.json

2. Access the main console in OIC.3. In the list of OIC applications, click the application for your permit workflow.4. Click the Integrations option in the left frame.5. Click the PermitsConnector integration.6. Expand the PermitResources resource.7. In the Operations section, click the Add button and then select GET operation from the drop-down menu.8. Click the new GET operation.9. Enter the following information:

Field Value

Name

getPermitBaseData

Path

{permitResource}/{permitRecordKey}

78


Field Value

Although you can choose different names for the resource name and record keyparameters, this procedure assumes that you use the given values.

Description

Get base permit data, such as applicant information

10. Click Request11. In each row of the Parameters list, click the Enter a description text and enter a description.

These are example descriptions:


permitResource


permitRecordKey

Permit Record Key

12. Click Response.13. Click the + icon next to the Body field to open the Import Business Object from JSON window.14. Enter ResponsePermitBase in the Name field.15. Click Schema.16.

Click the Import from File icon next to the Schema button.17. Locate and upload the ResponsePermitBase.json file that you downloaded from My Oracle Support.

The imported JSON code appears in the Import Business Object from JSON window.18. Click the Import button at the bottom of the window to save the code and close the window.19. Ensure that the following values appear for the GET operation response:


Body

BusinessData.ResponsePermitBase

Media Type

application/JSON

20. Click Apply.This completes creation of the GetPermitBaseData operation.

21. In the Operations section, click the Add button and then select GET operation from the drop-down menu.22. Click the new GET operation.

The new GET operation has the default name is GetPermitResources23. Enter the following information:

Field Value

Name getPermitFieldsData

79


Field Value

Path

{permitResource}/{permitRecordKey}/child/FieldGroups Although you can choose different names for the resource name and record keyparameters, this procedure assumes that you use the given values.

Description

Get specific permit data, such as job cost

24. Click Request.25. In each row of the Parameters list, click the Enter a description text and enter a description.

These are example descriptions:


permitResource


permitRecordKey

Permit Record Key

26. Click Response.27. Click the + icon next to the Body field to open the Import Business Object from JSON window.28. Enter ResponsePermitFields in the Name field.29. Click Schema.30.

Click the Import from File icon next to the Schema button.31. Locate and upload the ResponsePermitFields.json file that you downloaded from My Oracle Support.



Body

BusinessData.ResponsePermitFields

Media Type

application/JSON


Adding a GET Operation for Permit Type Data

Note: Before starting this procedure, be sure to complete the procedure “Adding GET Operations for PermitData.”

80


The GetPermitTypeData operation gets data that is associated with the permit type definition rather than with an individualpermit. For example, this operation can get the fee structure for a permit, because the fee structure is associated with thepermit type.

To set up the GET operations for permit type data:

1. Go to My Oracle Support, access the document called Public Sector Compliance and Regulation: JSON Files forPermit Integration, and download the ResponsePermitType.json file that you will use later in this procedure.

2. Access the main console in OIC.3. In the list of OIC applications, click the application for your permit workflow.4. Click the Integrations option in the left frame.5. Click the PermitsConnector integration.6. In the header of the Resources section, click Add to create a new permit type resource.7. Expand the new Resource section that appears, and enter the following information:

Field Value

Name

PermitTypeResource

Path

publicSectorRecordTypes

8. In the Operations section, click the Add button and then select GET operation from the drop-down menu.9. Click the new GET operation.

10. Enter the following information:

Page Element Value

Name

getPermitTypeData

Path

{permitResource}

Documentation

Get permit type setup data

11. Click Request12. In the Parameters list, click the Enter a description text and enter a description.

Here is an example description:


permitResource


13. Click Response.14. Click the + icon next to the Body field to open the Import Business Object from JSON window.15. Enter ResponsePermitType in the Name field.16. Click Schema.17.

81


Click the Import from File icon next to the Schema button.18. Locate and upload the ResponsePermitType.json file that you downloaded from My Oracle Support.



Body

BusinessData.ResponsePermitType

Media Type

application/JSON


Setting Up Permit Workflow Permit workflow provides a defined flow for the permit lifecycle. This flow can include system tasks, human tasks, anddecision gateways. You define your flow using the Process feature in Oracle Autonomous Integration Cloud (OIC). TheProcess feature provides a visual design environment to help you create easily understood workflow process definitions.

Permit workflow manages permit status updates throughout the permit lifecycle and is an essential part of your permit setup.

Note: The procedures in this topic relate to the specific requirements of permit workflow. To create your permitworkflow, you first need to become familiar with OIC and, in particular, the process builder in OIC. For moreinformation, refer to your OIC documentation at https://docs.oracle.com/en/cloud/paas/integration-cloud/user-processes/developing-structured-processes.html.

OIC Hierarchy for a Process DefinitionTo associate workflow with a permit type, you identify the OIC process definition using a path that includes these hierarchicalobjects:

Object Description

Space

An organizational tool similar to a folder. Your agency chooses the spaces that make sense for yourorganization. For example, you can create separate spaces for different categories of permits.

Application

Applications are functional areas in OIC. Within an application, you can access a variety of features,including processes (workflow) and integrations. Certain configurations, including integrations and roles, are defined at the application level andshared by all of the application’s process definitions. Therefore, you can simplify the setup processby grouping related process definitions into a single application.

Version

When you activate an application to make it available for use, you choose a version number toassign. New and modified process definitions can’t be associated with a permit type until youactivate a version of the application that includes your changes.

82

https://docs.oracle.com/en/cloud/paas/integration-cloud/user-processes/developing-structured-processes.html

https://docs.oracle.com/en/cloud/paas/integration-cloud/user-processes/developing-structured-processes.html


Object Description

If you reuse the same version number when you activate an application, all open process instancesusing that version are terminated. To prevent this, use a new version number and then update anypermit types that need to use the new version.

Process Definition

A specific workflow process to be associated with a permit type. When different permit types havethe same workflow, they can use the same process definition. Process definitions for permit workflow must be of the type Message.

Setting Up Process DefinitionsOracle provides a Solution Package with sample configurations. You can clone these samples and use them as startingpoints for your own process definitions. You can also create process definitions from scratch.

The OIC documentation provides complete information on creating process definitions, but these are the high level steps withsome additional information that is specific to permit workflow:

1. Create the process definition.

For permit workflow, create the process definition using the type Message.2. Set up swimlanes.

Swimlanes are equivalent to roles in Public Sector Compliance and Regulation.3. Design your process flow, which includes start and end events, human tasks, system tasks, gateway decision

points, and arrows that define the flow through these objects.

Your OIC documentation includes generic information about creating a process flow. This topic provides additionalinformation for the following permit workflow topics:

◦ Setting Up Data Definitions for a Process

◦ Defining Arguments for the Start Event

◦ Defining Data Associations for the Start Event

◦ Defining Data Associations for Sending Notifications

◦ Defining Data Associations for Sending Permit Status Updates

◦ Defining Data Associations for Retrieving Permit Base Data

◦ Defining Data Associations for Retrieving Permit Field Data

◦ Defining Data Associations for Retrieving Permit Type Data

◦ Defining Statuses (Outcomes) for Human Tasks

◦ Using the PSC_LIST_ORDER Custom Property to Order Human Tasks

◦ Defining Conditional Logic for Gateways

4. Activate your application and assign it a version number.

Activating an application makes its new and modified process definitions available to associate with a permit type. Ifyou reuse the same version number when you activate the application, all open process instances using that versionare terminated. To prevent this, use a new version number and update any impacted permit types so that theyreference the new version number.

83


5. If this is the first time that the application has been activated, use the Manage Roles functionality in OIC to mapswimlanes to roles.

Swimlanes cannot be mapped until the application has been activated. The mapping applies to all processdefinitions in the application.

A swimlane can be associated with multiple roles. It can also be associated with one or more individual users.

Reviewing a Sample Process DefinitionLet’s look a a sample process definition for a building permit.

This image shows the first half of the sample process, from the time the permit is submitted until it is issued.

The following table identifies the types of objects shown in the illustration:

Object Description

Swimlanes

Horizontal bands in the process map represent the roles involved in the process.

Start and End Events

All paths through the workflow process must begin at the Start event and finish at the End event.

Human tasks

Green boxes with an image of a person represent tasks that are performed by humans.

System tasks

Blue boxes with an image of a cloud represent tasks that the system performs.

Gateways

White diamonds represent decision points, where the process flow can branch based on criteria youdefine.

84


Object Description

Arrows

One-directional arrows define flows through the process. Gateways are the only objects that have multiple exit arrows. The exit arrow with a slash through itrepresents the default option after a gateway. All other exit arrows contain business logic for definingthe conditions when the arrow is used.

With these definitions in mind, let’s look at the sample process flow:

1. Start: The process starts when a permit application is submitted, which sends a message to OIC to instantiate theworkflow process.

2. Accept Application: A human performs the task of accepting the application and selecting a task status thatrepresents the task outcome.

3. Get Permit Fields Data: This system task retrieves permit field data to be used later in the process, when it’s timeto determine whether a plan review is required.

4. Application Decision: Exit arrows from this gateway determine the next step based on the outcome of the AcceptApplication human task.

a. If more information is needed, the application acceptance task is reinstantiated. This loop continues until thetask has a different outcome.

b. If the application is rejected, a system task updates the permit status to Denied, then another system tasksends the applicant an email notification that the permit was denied, then the process ends.

c. If the outcome is anything else, the process continues.5. Update Status = In Process: This system task updates the permit status to In Process.6. Email - Application Accepted: This system task notifies the applicant that the permit was accepted.7. Plan Review: Exit arrows from this gateway determine the next step based on the outcome of the Accept

Application task and based on the job cost that was retrieved by the Get Permit Fields Data task:

a. If the Accept Application outcome indicates that a plan review is required, or if the job cost is greater than10,000, the Update Status = Plan Review system task updates the permit status to Plan Review, then ahuman completes the Complete Plan Review human task. When the Complete Plan Review is complete,the process continues.

b. If a plan review is not required, the process continues.8. Issue Permit: A human performs the task of issuing the permit and enters a task status that represents the task

outcome (whether the permit was issued or rejected).

The following image shows the remainder of the sample workflow, after a human completes the Issue Permit task.

85


These steps describe the remainder of the workflow process, after the human task for issuing a permit:

1. Issue Permit: Exit arrows from this gateway determine the next step based on the outcome of the task for issuing apermit:

a. If the permit is rejected, the Update Status = Denied This system task updates the permit status to Denied,then the Email - Permit Denied system task notifies the applicant that the permit was denied, then theprocess ends.

b. If the outcome is anything else, the process continues.2. Update Status = Issued Permit: This system task updates the permit status to Issued Permit.3. Email - Permit Issued: This system task notifies the applicant that the permit was issued.4. Get Permit Type Data: This system task retrieves permit type information for use in determining whether an

inspection is needed.5. Inspection: Exit arrows from this gateway determine whether an inspection is needed:

a. If the permit type includes an inspection group, the Update Status = Inspection system task updates thepermit status to Inspection. A human then completes the Approve Final Inspection task and enters the taskoutcome. The process then continues.

b. If an inspection is not required, a human performs the Complete Permit task and enters the task outcome.The process then continues.

6. Update Status = Complete: this system task updates the permit status to Complete.7. The process ends.

86


Setting Up Data Definitions for a ProcessData definitions provide a structure for storing data from the permit system. Every process definition that you create needs thesame data definitions, including:

• Simple string data definitions to store identifying information about the permit and permit type.

• Business object data definitions to store permit base data, permit field data, and permit type data.

The data definition for permit fields includes all possible fields on the permit intake form, even though permits useonly the subset of fields that are appropriate for the type of permit. Any fields that are not part of a specific permitremain blank when the workflow process retrieves the permit field data.

You must set up your data definitions before you continue to this topic’s additional procedures for defining data associations.

Note: Before you set up your data definitions, you must to set up the permit connector for the application. Thisis because the permit connector’s three GET operations have the schema for the data. Setting up the permitconnector is described in the topic Integrating With the Oracle Integration Cloud.

To set up data definitions in a process definition:

1. Access the process definition in OIC.2. Click Data Objects.3. Set up the data definition for permit base data:

a. In the Data Objects window, click Add.b. In the Create Process Data Object window, enter the following information:

Page Element Value

Name

permitBaseData

Data Type

Business

The drop-down list for data types

BusinessData.ResponsePermitBase

c. Click Create to create the data definition and return to the Data Objects window.4. Set up the data definition for permit field data:

a. Click Add.b. Enter the following information:

Page Element Value

Name

permitFieldsData

Data Type

Business


BusinessData.ResponsePermitFields

87


c. Click Create.5. Set up the data definition for permit type data:

a. Click Add.b. Enter the following information:

Page Element Value

Name

permitTypeData

Data Type

Business


BusinessData.ResponsePermitType

c. Click Create.6. Create simple string data objects for the permit fields that contain identifying information about permits and permit

types:

To create these strings:

a. Click Add.b. Set up the string using the values in this table, where each row represents a separate data definition that you

need to create:

Name Data Type Drop-down list for the data type

recordKey

Simple

String

recordTypeKey

Simple

String

ExternalBaseURL

Simple

String

resourceName

Simple

String

c. Click Create.d. Repeat for all additional rows in the table.

7. Click Close to close the Data Objects window.8. Click Save.

Defining Arguments for the Start EventWhen a permit instantiates its workflow process, it passes parameters such as the permit ID to the workflow system. TheStart event must have arguments for these parameters.

To set up the arguments for the start event:

1. Open the process definition and select the Start event.2. Open the event properties.

The default view is the General section of the Implementation Properties.

88


3. In the How do you want to implement it? section, select Define Interface as the Type.4. Click the pencil icon next to the Type field to open the Configure window.5. Add the following rows to the Arguments Definition.

Name Type

RecordKey

String

RecordTypeKey

String

ExternalBaseURL

String

ResourceName

String

6. Click OK.7. Close the properties panel and click Save.

Defining Data Associations for the Start EventThe data associations for the Start event capture identifying information about the permit..

To set up the data associations:

1. Open the process definition and select the Start event.2. Click the Data Association button.3. Set up the following input data associations.

Source Data(Left side of the map)

Target Data(Right side of the map)

Description

RecordKey

recordKey

The permit ID.

RecordTypeKey

recordTypeKey

The permit type ID.

ExternalBaseURL

url

The URL for the permits system.

ResourceName

resourceName

The name of the REST API resource forpermits.


Defining Data Associations for Sending NotificationsThe data associations for a notification task define the information that the task sends to the public sector communicationscenter.

Note: Create your email templates in the communications center before you set up integration for notificationworkflow tasks.

89


For more information about the communications center, see Setting Up Communication Events.


1. Access the process definition and select the system task.2. Click the Data Association button.3. Set up the following input data associations:



Description

[event name] For example, "LNP_WORKFLOW_001"

body.eventCode

The event as defined in theCommunications Center in the publicsector system. The source data string must be inquotation marks, and it must exactlymatch the identifier of an event. Oracle delivers five communicationevents, LNP_WORKFLOW_001 throughLNP_WORKFLOW_005.

[template name] For example, "Application_Accepted"

body.templateCode

The identifier for the template to be usedfor the email. The source data string must be inquotation marks, and it must exactlymatch the name of a template in thepermit application.

"LnpRecordKey"

body.recordFirstKeyName

The name of the key field for permits

recordKey

body.recordFirstKeyValue

The permit ID.

true or false

body.email

This Boolean field indicates whether thenotification is sent as an email. Enter true only if the template is an emailtemplate.

true or false

body.notification

This Boolean field indicates whetherthe notification is sent as an in-productnotification. . Enter true only if the template is an in-product notification template.

CAUTION: Templates are associated with either email or in-system notifications. Be sure to set up thebody.email and body.notification values properly. Exactly one of the values must be true. If you want tosend both types of notifications, you need to create two notification tasks.


90


Defining Data Associations for Sending Permit Status UpdatesThe data associations for a permit status update task define the information that the task sends to the permit system.


1. Access the process definition and select the system task that updates the permit status.2. Click the Data Association button.3. Set up the following input data associations:



Description

resourceName

resourceName

The unique system identifier for the permittype.

recordKey

recordKey

The permit ID

[new permit status] For example: "Accepted"

body.status

The status to be assigned to the permit. The source data string must be inquotation marks, and it must exactlymatch one of the valid statuses in thepermit application.


Defining Data Associations for Retrieving Permit Base DataThe data associations for a task that retrieves permit base data provides a structure for storing the retrieved data. In this taskyou create both input and output data associations.


1. Access the process definition, and select the system task that retrieves permit base data.2. Click the Data Association button.3. Set up the following input data associations:



Description

resourceName

permitResource


recordKey

permitRecordKey

The permit ID

4. Click Output.5. Set up the following output data associations:

91




Description

body

permitBaseData

This business object contains all of thepermit base data. Mapping individual fields would be muchmore complex and is not necessary.


Defining Data Associations for Retrieving Permit Field DataThe data associations for a task that retrieves permit field data provides a structure for storing the retrieved data. In this taskyou create both input and output data associations.


1. Access the process definition, and select the system task that retrieves permit field data.2. Click the Data Association button.3. Set up the following input data associations:



Description

resourceName

permitResource


recordKey

permitRecordKey

The permit ID




Description

body

permitFieldsData

This business object contains all of thepermit fields. This includes all fields thatcan be included on the permit intakeform, whether or not the field exists for aspecific permit. Individual fields are nested within theitems object. You can’t expand the itemsobject on this page, but they are availablein the expression editor that you usewhen creating business logic based onpermit data. Mapping individual fields would be muchmore complex and is not necessary.

6. Click Apply.

92


7. Click Save.

Defining Data Associations for Retrieving Permit Type DataThe data associations for a task that retrieves permit type data provides a structure for storing the retrieved data. In this taskyou create both input and output data associations.


1. Access the process definition, and select the system task that retrieves permit type data.2. Click the Data Association button.3. Set up the following input data associations:



Description

resourceName

permitResource





Description

body

permitTypeData

This business object contains all permittype fields.


Defining Statuses (Outcomes) for Human TasksThe Action property for a human task lists the possible outcomes of the task. The actions you define appear as values inthe Status drop-down list box on the Workflow page where agency staff manages workflow tasks. When the task status isupdated on the Workflow page, OIC recognizes it as the task outcome and continues to the next step or gateway.

To define status values representing the outcomes of human tasks::

1. Access the process definition and select the human task.2. Open the task properties.3. In the Action field, enter a comma-delimited list of status values.

Do not put a space before or after the comma. For example, if the status are Accept, Reject, and More Information,enter Accept,Reject,More Information in the Action field.

4. Close the properties window and save.

Defining and Using a Custom Property to Order Human TasksThe Workflow page for a permit includes an option to view a list of all past, present, and not started human tasks for thepermit. The list displays past and present tasks in chronological order. However, the chronology for tasks that haven’t beenstarted is not necessarily fixed. The branching logic in a process means that some tasks might be omitted or might occur in adifferent order depending on permit data or on the outcome of previous tasks.

93


To control the order in which not started human tasks appear, use the PSC_LIST_ORDER custom property. On the Workflowpage’s list view, tasks that have not yet started are listed in the order you specify. If multiple not started tasks have the samenumber, they appear in the list in random order.

Before you can use the property to assign an order number to each human task, you need to add the property to the processdefinition.

To add the PSC_LIST_ORDER custom property to a process definition:

1. Access the process definition and click the # (Custom Properties) toolbar icon.2. Enter the following values in the Custom Properties list:

Page Element Value

Property Name

PSC_LIST_ORDER

Note:Use this exact value.

Description

Human tasks display order

3. Click OK.4. Click Save.

To assign order numbers to human tasks:

1. Analyze all human tasks in the process and decide on the appropriate order.

Tasks appear in ascending numerical order. You assign order numbers one task at a time, so if you later decide tochange the order, you have to update each affected task individually.

2. Access the process definition and select a human task.3. Open the task properties.4. Select the Business Properties icon in the icon bar, then select Custom Properties from the list of options that

are associated with that icon.5. Enter a number in the PSC_LIST_ORDER custom property.6. Close the Properties window and save.7. Repeat for all human tasks in the process definition.8. Click Save.

Defining Conditional Logic for GatewaysIn a process map, gateways represent decision points where there is a branch in the process flow. The logic for takingdifferent paths after the gateway is associated with the arrows to the possible subsequent tasks.

An arrow that represents a default branch does not require any logic.

For all other arrows, you need to set up the conditions under which the branch is used. To do this:

1. Access the process definition and select the arrow.2. Click the pencil icon for the arrow to open the arrow properties.3. Select the Conditional Flow check box.

94


This check box is selected for all arrows other than the default arrow after a gateway.4. Click the pencil icon for the Condition field.5. Use the Expression Editor window to specify the conditions for using this branch.

The Data Objects tab provides access to the data elements that you can evaluate. Permit field data (the data fromthe intake form) is nested within the items element under PermitFieldsData.

In expressions that look for an exact match, take extra care with the spelling, capitalization, and punctuation ofvalues that the expression evaluates.

6. Select the gateway and open the gateway properties.7. Use the Order property to specify the order in which the previous task’s outcomes are evaluated for purposes of

determining which arrow to follow.

Setting Up Fee Items The fee items table lists the fees that will be assessed by your agency. You set up fee items for your agency on the Fee Itemspage.

The fee items table is used to validate the fees created in the Oracle Autonomous Integration Cloud (OIC) decision model. Youdefine the fee items before setting up decision models and fee schedules.

For information about setting up decision models and fee schedules, see Creating Decision Models for Fees and Setting UpFee Schedules.

Adding Fee Items1. Select Common Setup > Fee Items .2. On the Fee Items page, click Add to add a fee item.3. On the Fee Item Details page, enter a name for the fee item.4. Enter a description.5. In the Department field, you can select a department to associate with the fee.

Note: The department associated with the fee overrides the department specified on the permit type.

6. Verify that the Enabled switch is turned on. The switch is turned on by default for a new fee item.7. Click Save.

Modifying Fee Items1. Select Common Setup > Fee Items .2. On the Fee Items page, click the row for the fee item that you want to modify.3. On the Fee Item Details page you can:

◦ Modify the fee item description. You cannot change the name.

◦ Change the department associated with the fee item.

◦ Click the Enabled switch to enable or disable the fee item.


95


Deleting Fee Items1. Select Common Setup > Fee Items .2. On the Fee Items page, click the row for the fee item that you want to delete.3. On the Fee Item Details page, click Delete.4. If you want to delete multiple fee items, you can delete them from the Fee Items page:

a. Click Edit.b. Select the check boxes for the fee item rows to delete.c. Click Delete.

Creating Decision Models for Fees This topic describes the requirement of creating a decision model after creating fee items and before creating a fee schedule.You use Oracle Autonomous Integration Cloud to create decision models.

PrerequisitesBefore you create a decision model, you need to create any required fee items that will be associated with the decisionmodel.

Decision Model OverviewYou create decision models using the Oracle Autonomous Integration Cloud (OIC) decision modeling feature. Use this featureto create decision models to automate the decision logic in your business processes. As part of creating a decision model,add and order decisions, define decision inputs, and model the logic. The decision model editor supports the DecisionModeling and Notation (DMN) standard for you to create your models.

For more information on decision models refer to your Oracle Autonomous Integration Cloud documentation at: https://docs.oracle.com/en/cloud/paas/integration-cloud/user-processes/creating-decisions.html.

In the permits service, a decision model enables you to automate the calculation of fees based on your business processcriteria.

For example, assume your agency applies varying fees based on the total cost of a building project for which a permit isbeing requested. A decision model enables you to automate this business logic:

• If the project value is less than or equal to $500, then the application fee is $50.

• If the project value is more than $500 but less than or equal to $1,000, then the application fee is $75.

• If the project value is more than $1,000 and $5,000, then the application fee is $125.

• For any project value over $5,000, then the application fee is $200.

Before you create a decision model, you must first create a fee item. After creating the decision models, you can thenassociate the decision model with a fee schedule. The fees workflow generally follows these main steps and events:

1. Create fee item(s).2. Create decision model based on existing fee item(s).3. Create a fee schedule incorporating fee items and decision model.

96

https://docs.oracle.com/en/cloud/paas/integration-cloud/user-processes/creating-decisions.html

https://docs.oracle.com/en/cloud/paas/integration-cloud/user-processes/creating-decisions.html


4. Associate a fee schedule with a permit type.5. Map permit fields to decision model in the Permit Designer.6. When an end user is submitting an application for a permit, the permit service applies fees and fee logic based on

input.

Configuring Decision Models for Oracle Public Sector PermitsYou can set up inputs and decisions any way you like following the guidelines provided in the documentation for OIC.However, the configuration here for output data types is required for setting up the fee schedule in Oracle Public SectorPermits.

To configure decision models for Oracle Public Sector Permits:

1. Create a fees list of values (LOV) with the fee item names.

Currently, there is no direct integration of configuration data, such as fee items, between OIC and Oracle PublicSector Permits. Although creating an LOV is optional, any fee item names added to a decision model output needto be entered exactly as they appear in Oracle Public Sector Permits. When you use the LOV and enter values in adecision output. OIC validates the entry and displays a warning if your entry does not match an item in the LOV.

This example illustrates the list of values setup in OIC used to validate fee items entered in the Decision Table.Select list of values in the Constraint options when you’re adding the data type definition.

2. (Required) Set up the complex data type output to include these attributes: FeeItem and FeeAmount.

97


The FeeItem attribute should use the fees LOV that you created. The FeeAmount attribute uses numbers that youenter on the decision model.

Note: This step is important because the FeeItem and FeeAmount attributes are used to map the feeitems on the Oracle Public Sector Permits fee schedule to the decision model.

This example illustrates the complex data type output that you set up in OIC for your decision model. You mustdefine FeeItem and FeeAmount attributes.

3. (Required) Add the output data type name to every decision and use allowed values in the Decision Table grid.

To edit a decision, click the decision menu button and select Edit.

Select the defined output type from the Output Type list.

This example illustrates the output data type name Fees added to the Residential_Alteration decision. The outputtype provides constraints on which values are allowed in the decision model.

98


This is an example of the final decision values based on the output type.

The decision output type in the Residential_Alteration decision is Fees. The validation ran on the Fees values enteredin the Decision Table, and no errors were returned.

99


4. (Required) You must also configure the services in the Services panel to the left of the decisions, and activate themodel. For more details, see the documentation for OIC, Creating a Service.

When the permit application submits a request to the OIC, after running the request against the decision model, theapplication returns the fee item name and the fee item amount.

Related Topics

• Setting Up Fee Items

• Setting Up Fee Schedules

Setting Up Fee Schedules Define fee schedules for permit applications to associate with the permit record types. A fee schedule can be associated withmultiple permit types.

You set up your fee schedules and fee lines or items on the Fee Schedule page. The fee model defined on the fee items isassociated with a decision model set up in the Oracle Autonomous Integration Cloud (OIC).

Before you can set up your fee schedules, you must do the following:

• Set up the fee items on the Fee Item page.

You must define the items that require a fee to be displayed in the prompt list for the Default Fee Item field. SeeSetting Up Fee Items.

• Set up decision models in OIC. For more information, see Creating Decision Models for Fees in this guide and thedocumentation for Oracle Autonomous Integration Cloud.

Adding Fee Schedules1. Select Permit Setup > Fee Schedule .2. On the Fee Schedule page, click Add New to add a new fee schedule.3. Enter values on the Fee Schedule Details page:


Fee Schedule

Enter an ID for the fee schedule.

Description

Enter a description for the fee schedule.

Default Fee Item

Enter a fee item as the default for this fee schedule. The default fee item is used for the fee schedule if there is no matching fee item in thedecision model.

All Dates

Click this button to review effective date history and add a new effective start date andeffective end date for the fee schedule. An end date is not required.

4. Click Save.

100

https://docs.oracle.com/en/cloud/paas/integration-cloud/user-processes/create-service.html

https://docs.oracle.com/en/cloud/paas/integration-cloud/user-processes/ready-create-decision-model.html


Adding Fee ItemsYou set up fee lines or items for a fee schedule on the Fee Item Details page.

1. On the Fee Schedule Details page, click Add in the Fee Items section.2. Enter values on the Fee Item Details page:


Space Name

Enter the space name. The space is where the fee decision model is stored. You sharedecision models created in OIC at the space-level.

Model Name

Enter the name of the fee decision model.

Version

Enter the version number of the fee decision model you want to activate.

Service Name

Enter a service name to integrate the fee decision model with the fee schedule.

Map Fee Item

Associate the fee with the fee item data object in the fee decision model.

Map Fee Amount

Associate the fee amount with the data object in the fee decision model.

Currency

Displays the default currency that was set up for your agency.

Applies to Type

Select Original. The fee item is used for the fees associated with the original permitapplication.

Pay Now

Move the switch to activate the pay now option if you want the fees to be payable uponsubmission of the application.

3. Click Save.

The fee item appears as a new row in the Fee Items grid and is automatically assigned the next fee item number.

Modifying or Deleting Fee SchedulesYou can modify or delete fee schedules and fee lines or items on the Fee Schedule page. Fee schedules and fee items areassociated with record types such as permit applications. Be aware of all associated record types before you delete or modifyfee schedules or fee items.

Note: When adding a new fee item to the fee schedule, you must verify the fee mapping for all affected permittypes.

1. Select Permit Setup > Fee Schedule .2. On the Fee Schedule page, select the row for the fee schedule that you want to modify.3. On the Fee Schedule Details page you can:

◦ Modify the fee schedule description. You cannot change the ID.

◦ Enter a new default fee item.

101


This default fee item is used for the fee schedule if there is no matching fee defined in the fee decision model.

◦ Change the effective start date or effective end date. Click the Select Date icon in the Effective Start Datefield or Effective End Date field and select a new date.

4. If you made any changes, click Save.5. To view the history of effective dates for the fee schedule, click All Dates.

The All Dates page displays all effective-dated rows in descending order. From the All Dates page you can:

◦ Delete an effective-dated row. Click Delete at the end of the row.

◦ Add an effective-dated row. Click Add.

Note: Fee schedules with multiple effective dates appear only once on the Fee Schedule page.

6. If you want to delete the fee schedule, click Delete on the Fee Schedule Details page.

Note: When you delete a fee schedule, all associated fee items are also deleted.

7. If you want to delete multiple fee schedules, you can delete them from the Fee Schedule page:

a. Click Edit.b. Select the check boxes for the fee schedule rows to delete.c. Click Delete.

Modifying or Deleting Fee Items1. If you want to modify a fee item, you can:

a. Select the fee schedule associated with the fee item to open the Fee Schedule Details page.b. Under Fee Items, select the fee item to open the Fee Item Details page.c. Select different decision model mapping values for the fee from the drop-down lists.d. Click the Pay Now switch to turn it on or off to indicate whether the fees must be paid upon submission of the

application.2. If you made any changes, click Save.3. If you want to delete the fee item, click Delete.

Note: When you delete a fee item, the decision model mappings are deleted from all associated recordtypes.

4. If you want to delete multiple fee items, you can delete them from the Fee Schedule Details page:

a. Click Edit.b. Select the check boxes for the fee item rows to delete.c. Click Delete.

102


Setting Up Document Categories and Subcategories You set up document categories and subcategories on the Document Category pages to organize the various types of permitattachments.

Adding Document Categories and Subcategories1. Select Permit Setup > Document Category .2. On the Document Category page, click Add to add a new document category.3. On the Document Category Details page, enter a name for the document category and a description.4. Click Save.5. If you want to add a subcategory, click Add in the Document Subcategory section.6. On the Document Subcategory Details page, enter a name for the subcategory and a description.7. Click Save.

Modifying or Deleting Document Categories and Subcategories1. Select Permit Setup > Document Category .2. On the Document Category page, select the row for the category that you want to modify.3. On the Document Category Details page, you can only modify the category description.4. Click Save to save any changes.5. If you want to delete the document category, click Delete.

Note: When you delete a document category, all associated subcategories are also deleted.

6. If you want to delete multiple document categories, you can delete them from the Document Category page:

a. Click Edit.b. Select the check boxes for the document category rows to delete.c. Click Delete.

7. To modify a document subcategory:

a. Select the associated category to open the Document Category Details page.b. Select the subcategory that you want to modify.c. Make any changes on the Document Subcategory Details page.d. Click Save.

8. To delete the document subcategory, click Delete on the Document Subcategory Details page.9. If you want to delete multiple subcategories, you can delete them from the Document Category Details page using

the Edit and Delete buttons.

Setting Up Permit Types Define the type of permit supported by an agency by setting up a permit type. You add a permit type and associate workflowprocess definitions on the Permit Type definition page.

103


Adding Permit Type Definitions1. Select Permit Setup > Permit Type > Permit .2. On the permit types page, click the Add button.3. In the Permit Type Definition section on the details page, enter values for the following fields:


Classification

Displays the type of application. The classification for this page indicates this is a Permitapplication.

Permit Type

Enter a name for the type of permit record.

Permit Type Code

Enter a unique alphanumeric code for the permit record type, or a short name. Do not usespecial characters or spaces, including symbols or punctuation.

Permit Type Status

Select from the following to indicate the permit type status:

◦ Preliminary: The permit type is being defined but is not available for use.

◦ Ready: The permit type is enabled for immediate use.

Note:The permit design must be published in the Permit Designer prior to setting thepermit type status to Ready.

◦ Void: The permit type is no longer available.

Autonumber Rule

Select the autonumbering rule to increment numbers for permits. For more information, see Setting Up Autonumbering.

Valid from Date and Valid to Date

Enter a range of dates when this permit type is valid. The default from date is the currentdate. The default end date is Open. You can update these dates as needed.

Public User Enabled

Select from the following to indicate whether this permit type is enabled for public users:

◦ Enabled for all users

◦ Enabled for registered users

◦ Not enabled for public users (default)

Department

Select a department that you want to associate with the permit type. A department isrequired if you add a Fee Schedule ID to the permit type. If a department is specified on the Fee Item setup page, the fee item department overridesthe department specified here on the permit type. For more information, see Setting Up Departments.

Permit Group

Select a permit group that you want to associate with the permit type. For more information, see Setting Up Record Groups.

104



Category

Select a category that you want to associate with the permit type. For more information, see Setting Up Record Categories.

Subcategory

Select a subcategory that you want to associate with the permit type. For more information, see Setting Up Record Subcategories.

Fee Schedule

Select a fee schedule that you want to associate with the permit type. A department isrequired if the permit type has a fee schedule ID. For more information, see Setting Up Fee Schedules.

Inspection Group

Select an inspection group to associate with the permit type. The inspection group identifiesall inspections necessary for the permit. For more information, see Setting Up Inspection Types.

Bill Type

Select a bill type to associate with the permit type. The billing type identifies the type of invoice that can be generated from the record. The billtype is required. For more information, see Setting Up Bill Types.

Terms of Use ID

Select a terms of use definition to associate with the permit type. When you set up terms ofuse, you can make the terms available to the public user registration process, to the permitapplication process, or to both. The user must accept the terms and conditions for usingonline permits. For more information, see Setting Up Terms of Use.

Setting Up Workflow for a Permit TypeYou set up workflow using the Oracle Process Cloud Service before associating the workflow with the permit type.

For more information, see Setting Up Permit Workflow.

1. Select Permit Setup > Permit Type > Permit .2. On the permit type definition page, click the Add button.3. In the Workflow Setup section on the Details page, enter values for the following fields:


Workflow Space Name

Enter the space where the workflow process application is stored. You can group relatedapplications in a space as well as enable users to collaborate when developing applications.

Workflow Application

Enter the name of the workflow process application in Oracle Autonomous Integration Cloud(OIC). For more information, see Creating and Managing Applications.

Workflow Application Version Enter the version of the workflow process application.

105

https://docs.oracle.com/en/cloud/paas/process-cloud/user/creating-and-managing-applications.html



Workflow Process Definition

Enter the name of the workflow process definition that applies to this particular permit.

Note: Different permit types can utilize the same workflow definition.

See also the documentation for Integrating With the Oracle Integration Cloud.

Cloning PermitsClick Clone to create a clone of the current permit type, which you can then use to create a different permit or to create adifferent version of the current permit.

For more information on cloning permits, see Cloning Permit Definitions.

Designing Permit Application FormsAfter you have entered the appropriate initial information for a permit, you can then begin to design the application form thatend users will use to submit an online application for a permit. You create an application form using the Permit Designer.

For more information on designing application forms for permits, see Using the Permit Designer.

Setting Up Permit Display Groups A permit display group identifies a meaningful grouping of permit types displayed as a list.

Before setting up permit display groups, you must set up permit types for your agency. See Setting Up Permit Types.

Adding Permit Display GroupsYou add permit display groups for your agency on the Record Type Display Group page.

1. Select Permit Setup > Permit Display Group .2. On the Record Type Display Group page, click Add to add a new group.3. On the Record Type Display Group Details page, enter a name for the group.4. Enter a description.5. Select the check box to indicate the permit classification.6. Verify that the Enabled switch is turned on. The switch is turned on by default for new permit display groups.7. To add a display group line, under Display Group Lines, click Add New and set up a line on the Display Group Lines

Details page. The display group lines make up the list of permit types in the new display group.


Display Order

Enter a numerical value in this field to specify the order in which you want the record type tobe displayed, if desired. The default value is 0 and upon saving it automatically assigns thenext value.

Record Type Code Select an existing record type code.

106



The description for the code you enter appears in the Record Type field.

Record Type Classification Group Category Subcategory

Review the description, classification, application group, category, and subcategory for therecord type to verify you have selected the correct record type code.

8. On the Record Type Display Group Details page, click Save.

Modifying Record Type Display Groups and LinesYou can modify record type display groups and lines on the Record Type Display Group Details and Display Group LinesDetails pages, respectively.

1. Select Permit Setup > Permit Display Group .2. On the Record Type Display Group page, select the row for the permit group that you want to modify.3. On the Record Type Display Group Details page, you can:

◦ Modify the description. You cannot change the group name.

◦ Click the Enabled switch to enable or disable the display group.

4. If you made any changes, click Save.5. To modify the display group lines (the list of permits in a display group), select the row for the permit group that you

want to modify on the Record Type Display Group page.6. On the Record Type Display Group Details page, select a display group line in the Display Group Lines grid.7. On the Display Group Lines Details page, you can change the values in these fields:

a. Update the Display Order field to change the order in which the lines appear.b. Update the Record Type Code field with another existing record type code.


Deleting Record Type Display Groups and Lines1. Select Permit Setup > Permit Display Group .2. On the Record Type Display Group page, select the row for the permit group that you want to modify.3. If you want to delete the display group, click Delete on the Record Type Display Group Details page.4. If you want to delete multiple display groups, you can delete them from the Record Type Display Group page:

a. Click Edit.b. Select the check boxes for the display group rows to delete.c. Click Delete.

5. To delete a display group line, go to the Record Type Display Group Details page and select a display group line inthe Display Group Lines grid.

6. On the Display Group Lines Details page, click Delete.

107


7. If you want to delete multiple display group lines, you can delete them from the Record Type Display Group Detailspage:

a. Click Edit.b. Select the check boxes for the display group line rows to delete.c. Click Delete.

108

Implementing Oracle Public Sector Permits Chapter 6Creating Application Forms

6 Creating Application Forms

Permit Designer Topics The following topics apply to using Permit Designer to create and publish permit application forms.

• Using the Permit Designer

• Working with Sandboxes

• Working with Pages

• Working with Predefined Form Elements

• Using Predefined Form Elements

• Working with Group Boxes

• Working with Fields

• Defining Fields Displaying a List of Values

• Adding Contextual Help to Forms

• Setting Form Options

• Mapping Permit Fields to the Fee Schedule

• Considering User Experience

• Testing Application Forms

• Publishing Application Forms

• Cloning Permit Definitions

Using the Permit Designer This topic describes the purpose of the Permit Designer, lists the prerequisites that must be completed prior to creating aform, and introduces you to the designer interface.

For any municipality that grants permits to citizens, an application form needs to be submitted by the citizen that captures theinformation required as prerequisites to granting the permit. The application can be a paper form or an online web page. WithOracle Public Sector Compliance and Regulation Cloud, you will use Permit Designer to create application forms your citizenscan access through the cloud.

Oracle does not deliver a predefined form for each type of permit because for each form and for each municipality, theinformation required will be unique.

For example, for a fence permit, the City of San Diego may require only basic information about the material to be used andthe measurements. On the other hand, the City of Sacramento may require the same information as San Diego, but alsorequire the contact information of the contractor building the fence, the exact location of the fence, the area enclosed by thefence, and so on. Each municipality has its own set of requirements so you need to be able to tailor the forms to reflect yourcity’s requirements.

Oracle provides the Permit Designer, which enables you to create unique online application forms for each permit yourmunicipality grants. The Permit Designer provides modular sets of common fields, called predefined form elements, which

109


you can use like building blocks to assemble the online application form. If a predefined form element does not contain fieldsyou require, you can add user-defined form elements to meet your requirements.

Once you have created, configured, and tested your form, you can publish the form for end users to access, complete, andsubmit for review and approval.

Completing PrerequisitesBefore creating an online form, you need to:

• Create a permit type.

For more information on creating a permit type, see Setting Up Permit Types.

• Set up any fees associated with the form.

For more information on fees, see Setting Up Fee Items and Setting Up Fee Schedules.

Accessing the Permit DesignerBefore you can create an application form, you must first create a permit type on the Permit Type page.

From the Permit Type Definition page, select the Design Form button.

Working with the Permit Designer InterfaceThis example illustrates the interface of the Permit Designer when you begin creating an application form. The elements of theuser interface are described below the image.

110



Status

Indicates the status of the current design.

• Draft: the form is in sandbox mode, which means only the implementation team can access,view, and change the form design.

• Published: the form is available to end users on the landing page.

For more information on form status, see Working with Sandboxes.

Preview

Enables you to preview your form to test layout, design, and data entry.

Save

Saves changes made to the form design.

Publish

Publishes the completed form design so that end users can access it from the landing page andsubmit applications.

Next

Takes you to the Fee Mapping page. For more information on mapping fees, see Mapping Permit Fields to the Fee Schedule.

Form Options

Click to display the Form Options dialog box where you can set options that apply to the entire form. For more information on form options, see Setting Form Options.

Elements panel

Contains lists of all pre-defined and user-defined elements you can add to your form design. TheElements panel contains all of the items that you use to build a permit application.

Add Tab

Adds additional pages to your form. You navigate between the pages by using the page tab foreach page.

Workspace

The area where you drag and drop form elements from the Elements panel and configure them. Thisis the main area used for creating and configuring your forms.

Attributes panel

Displays the available attributes that you can configure for the currently selected form element. Forexample, if you have a field selected, the attributes panel reads "Field Attributes,” and it containsattributes specific to fields. If you have a group box selected, the attributes panel reads "Group BoxAttributes,” and it contains attributes specific to group boxes.

Viewing the Tasks for Creating FormsThis section provides the core set of tasks to complete when creating an intake form. The remaining topics in this chapterdiscuss the details of each task.

Step Link

Add page tabs.

Working with Pages

Add predefined form elements.

Working with Predefined Form Elements

Modify field attributes. Working with Fields

111


Step Link

Add group boxes.

Working with Group Boxes

Add user-defined form elements.

Working with Fields

Making Changes to Labels for Application Form ElementsWhen making changes to the labels for elements within your application form, you need to consider what type of element it is.

Form Element Label Change Considerations

Predefined

Making changes to the labels of the delivered, predefined form element titles or field labels cancreate unexpected results. When making a change to the title of a predefined form element or a field label, the change couldbe reflected in every instance of the predefined element (a global change), or the change could onlyaffect the current permit application form (a local change). For example, if you change a field label in the Applicant predefined element used in the fence permitapplication form, that change could be reflected in the Applicant predefined element used in theelectrical permit application form (and any other application form using the Applicant predefinedelement). Currently, there is no indication whether a label change will be reflected globally or locally.

User-Defined

You can change the labels for fields that you add to your application forms, such as text fields,number fields, drop-down lists, and so on. Because you add these fields manually to yourapplication form, you can change the default labels as needed to suit your business requirements.The scope of any changes to the label for user-defined fields apply only to the current permit.

Note:If you change the label of a field after a form has been published and used in the productionsystem, keep in mind this can affect reporting and the storage of historical data. You mayhave multiple labels representing the same data.

HTML Constructs

You can change the labels for form pages and group boxes as needed to suit your businessrequirements. The scope of the field and any changes to the label apply only to the current permit.

Note:If you change a label for a form page or a group box used on a form page after the formhas been published and used in the production system, make sure that to update anyinstructions or documentation that may reference the previous label.

112


Working with Sandboxes This topic provides an overview of the concept of sandboxes within the Permit Designer and describes sandbox usage andbehavior.

Most modern development environments typically require several different individuals to work simultaneously on applicationchanges while sharing the same data model and configuration starting point. The Permit Designer utilizes the Oracle FusionApplications technology referred to as sandboxes to enable form developers to work on projects simultaneously, and saveand test their work without affecting other developers or the production environment..

The sandbox acts as the development and test mode of your application form. During sandbox mode, the form design canbe viewed only internally by application developers or business analysts. In sandbox mode you can create your form, addrequired form elements, add UI elements, and test your changes. When you have completed all of your design, development,and test work, you can then publish the form so it can be accessed by end users.

Starting a Sandbox Instance for a New Application FormBefore you can create an application form in Permit Designer, you must first create the permit type. For example, for thepermit service, the permit type is a permit type. When you save a permit type, the application creates a sand box instance.From that point, the permit type and the associated form design exist within the newly created sandbox instance.

Each form your implementation is currently developing exists within its own, separate sandbox instance.

Note: The Permit Designer handles the creation of a sandbox, you do not need to create a sandbox manually.

Until you publish the application form, the permit type and the form design remain in the sandbox instance. When you publishan application form, the system eliminates its sandbox instance, and the form is available to users outside the sandbox.

Starting a Sandbox Instance for a Published Application FormAfter an application form has been published, you can initiate sandbox instances to make any required changes discoveredafter the initial publication.

To initiate a sandbox for a published form:

1. Open the permit type for the application form.2. Select Design Form.3. Begin making the desired changes.4. Click Save.

By clicking Save, the Permit Designer creates a new sandbox instance to store the current changes.

Viewing an Application Form’s Sandbox StatusYou can determine if a form is in sandbox mode using the Status indicator located in the top left-hand corner of the PermitDesigner. The Status indicator appears when you are creating the form or previewing the form. The sandbox status does notappear on the published version of the form.

113


Status Description

draft

The application form is in sandbox mode. All changes exist in the sandbox instance only.

published

The application form is not in sandbox mode. The form is available to the production environment,where end users can access the application form, complete it, and submit it.

Refreshing a SandboxEach application form is assigned to its own sandbox. Because permits share underlying metadata resources, if during thedevelopment of a permit some of the shared metadata resources get updated, each permit also using the shared metadataresources needs to be synchronized with the most recent metadata updates.

To synchronize the metadata between permits, you need to refresh the sandbox for unpublished application forms. If yoursandbox is out of sync and needs to be refreshed, you will see an error message displayed when you attempt to publish thepermit.

To refresh a sandbox:

1. Navigate to the Fusion Applications homepage by selecting Setup and Maintenance from the Navigator.2. In the Fusion Applications, click the Navigator again, and select Sandboxes under Configuration.3. On the Sandboxes page locate the sandbox where your permit resides.

The sandbox naming convention is: <Permit Type Code>__sb_<number of publications>.

For example, if on the Permit page, the Permit Type Code value is REMODEL, and the sandbox has been publishedonce previously, the sandbox for that permit is named REMODEL__sb_1.

4. Click on the sandbox you need to refresh.5. On the Sandbox Detail page review the messages related to the status of your sandbox.

You may notice the Current Status reads Refresh needed and the following note:

This sandbox is not synchronized with the mainline environment. You can refresh the sandbox before making anyfurther changes.

6. On the Sandbox Detail page, click Refresh.7. Click Yes on the prompt indicating you are about to refresh your sandbox and that you can’t make changes to the

sandbox during the refresh.

This returns you to the Sandboxes page.8. View the Status column on the Sandboxes page, which indicates your sandbox is refreshing.9. Click on the sandbox again to access the Sandbox Detail page to confirm your sandbox Current Status is Up to

date.

You may need to review the merge log and accept changes manually if needed.10. Once your sandbox is refreshed, close the Sandboxes page, and return to the Permit Designer.

Working with Pages This topic describes how to add pages to your application form and how to modify page attributes.

114


An application form can include one or more pages to contain the form elements and fields that you want to add to your form.

Adding PagesWhen you create a form, by default, the application includes one page for your form. To add additional pages to your form,click the Add Tab button at the top of the workspace.

Setting Page Attributes


Label

The name of the page that appears on the page tab. The default name is Page1, Page2, and so on.Change the name to your desired label, and tab out of the field.

Hide From Public User

Hides the page tab and all the elements on the page from the public user at runtime. Only agencystaff can view and update information for a page with Hide From Public User turned on. In additionto hiding the UI element from the public user in the interface, the application also secures the backend for that specific UI element, such as preventing any unauthorized access to the fields within theUI element using a REST API, for example.

Help

Click to launch the Contextual Help page, which you can use to add help information to aid endusers in completing the application form. Page-level help should provide information pertaining to the overall page content. If the informationapplies to a specific UI element on the page, such as a component, group box, or field, consideradding help directly to that UI element. For more information on adding contextual help, see Adding Contextual Help to Forms.

Deleting PagesIf you delete a page from your form, keep in mind that any UI elements you have added to the page, such as predefined formelements, group boxes, and fields will also be removed from your form.

To delete a page from your form:

1. Click the Remove button on the tab (the ‘x’ on the right side of the page tab.2. On the Confirm dialog box, click OK.3. Save your changes.

Working with Predefined Form Elements This topic provides an overview of form elements and how you use them to build your application forms.

Oracle provides a set of predefined form elements to help you build application forms easily. Each predefined form elementcontains a collection of fields commonly used to describe a particular facet of the license or permit. Using predefined formelements, you can assemble simple online application forms in a matter of minutes.

115


Predefined form elements are:

• Pre-mapped to attributes in the application view object (VO), which ultimately are mapped to fields in the SQL tablesin the application database.

• Grouped logically to provide descriptive metadata for a particular element of a permit, such as Applicant, ElectricalEquipment, Pool Information, and so on.

You drag the desired predefined element from the Elements panel onto the workspace. You use various combinations ofpredefined and user-defined form elements to assemble your application forms.

For example, assume that you need to create a form for citizens to apply for a roofing permit. In this case, you can drag theApplicant element and the Re-roof Information element onto the workspace to build your form.

Page Section Example Page Section Fields

Applicant

Name Address Phone

Re-roof Information

Roof Size Roof Type Roof Material Pitch

For more information on the delivered predefined elements, see Using Predefined Form Elements.

Adding Predefined ElementsTo add a predefined form element to your form:

1. Make sure the page to which you want to add the predefined form element is the active page.2. Expand the Predefined Elements list in the Form Elements panel to the left of the workspace.3. Click on the desired element to activate.4. Select the element to drag and drop the it in the workspace.

Note: Permit Designer places the predefined elements in the workspace in the same order in which they aredropped, in sequence, from top to bottom.

Note: The Applicant predefined form element is required to be added to your application forms. The internalsave logic checks for a valid applicant address when an end user attempts to save or submit an applicationform. It is recommended to include also the Application Information predefined element, which displays usefulinformation, including the permit ID, permit status, description, important dates related to the permit application,and so on. If the permit requires fees, then the Fee Summary predefined element should also be added to yourapplication form.

116


Deleting Predefined ElementsTo delete a predefined element, click the Remove button (the ‘x’) in the upper, right-hand corner.

Setting Predefined Element Attributes


Label

The name of the predefined form element. Initially displays an internal reference for the default label.When modified, the new label displays.

Note:Changing the label for predefined form elements can cause unexpected results. Currently,there is no way to indicate if a change will be local to the permit or global, for every instanceof the predefined element.

Show Label

Control whether to show the label. By default, the system shows labels for predefined form elements(Show Label is on). To hide the label, turn off Show Label. When turned off, the system hides the label at both design-time and runtime. Typically, you’d want the label to be visible to describe the logical grouping of the fields in the formelement. In some cases, the page tab name and the predefined element label might be redundant, in whichcase you may opt to hide the label. You may also want to group multiple predefined form elements within a single group box. In thiscase, you can hide the individual predefined element labels within the group box container, using thegroup box label to represent the combined set of fields.

Note:When you turn off Show Label, the system disables the collapsible feature for a predefinedform element.

Note:If the predefined element is delivered without a label, the Show Label attribute does notappear when you select that form element.


Hides the predefined form element and all the fields and controls it contains from the public user atruntime. Only agency staff can view and update information for a predefined form element with HideFrom Public User turned on. In addition to hiding the UI element from the public user in the interface, the application also securesthe back end for that specific UI element, such as preventing any unauthorized access to fieldscontained within the UI element using a REST API, for example.

Help

Click to launch the Contextual Help dialog box, which you can use to add help text to a predefinedform element for assisting users with interacting with your intake form. When adding help for apredefined form element, the help text should apply to the overall contents of the predefined form

117



element. You can add help also at the page level and the field level, depending on the scope of thehelp text. For more information on adding contextual help to your intake form, see Adding Contextual Help toForms.

Adding a Predefined Form Element Multiple Times to the Same FormThe same predefined form element can be dragged into your form multiple times. This is referred to as a multiple-instanceelement. How you adjust the Multi-Instance Options attribute determines how the application stores the data for thatpredefined element.

Note: The Multi-Instance Options attribute appears only for the Comments and the Attachments elements.

If you make no changes to the Multi-Instance Options attribute, the data entered within that predefined element correspondsto one row of data only. In this case, the system duplicates the display of the data in each area of the form it is displayed. Thisoption enables you to show the same data on a different tab within the form, if necessary. Updating the data in one instanceof the predefined element updates the data displayed in the other instances as well.

For example, assume you want the same comment text to appear on multiple pages in your form. You can do this by addingthe Comments element to the desired pages without making any updates to the Value field in the Multi-Instance Optionsattribute.

If you make changes to the Multi-Instance Options attribute, the application considers each instance of the predefinedelement unique, and then each individual occurrence of the predefined element is associated with its own row of data.

For example, assume you wanted to incorporate multiple comment sections in your form. In this case, you can add theComments element to multiple locations of your form, and then you set the Multi-Instance Options attribute to differentvalues. One might relate to fencing comments while another might relate to contractor comments. Another example would beto enable the end user to upload multiple attachments that apply to separate documents. One attachment might be photos ofa property while another attachment might be blueprint or design documents.

Using Predefined Form Elements This topic lists and describes the set of predefined form elements delivered to help you build forms quickly and consistently.

Predefined form elements are prebuilt user interface modules that you can use as building blocks for assembling forms. Eachelement contains a set of fields and functionality specific to various sections of an application form.

Common Predefined Elements

Form Element Description

Applicant

Identification and contact information for the citizen filling out the form, including name, address,phone, and email.

Application Information

Displays information about the form itself, such as status, relevant dates, and descriptions.

118



Attachments

Enables you to attach and download files, such as documents or images. You determine documentproperties displayed in the list of attachments and during upload. Contains multiple instance options to create unique instances of the attachment element.

Business Information

Captures information to help describe the business, such as name, description, number ofemployees, industry, and so on.

Comment

Enables you to enter additional comments or descriptions pertaining to information on the form.

Contact List

Enables you to add information for individuals or organizations that are contacts for a permit.

Fee Summary

Lists the items selected, the cost for each item, and the total amount to be paid when submittingthe form.

Note:This does not include additional inspection or other fees which may be assessed at a latertime.

Terms of Use

Provides access to the terms and conditions regulating the usage of the online form, and provides away for the user to accept the terms. This element does not identify which Terms of Use definition touse, so if you add this element to a permit form, you need to also add a Terms of Use definition onthe Permit Details page. The Display Mode property has these options:

• Link: the form displays a Terms and Conditions link that the user clicks to open a windowwith the full terms and the check box for accepting the terms.

• Embedded: the full text of the terms appears directly on the form.

If the display mode is Link, these two additional properties are available:

• Help Text: Enter informational text that appears on the form along with the Terms andConditions link.

• Display Label: Enable this option to display the description of the Terms of Use definition onthe form along with the Terms and Conditions link.

Note:This element is not used to set up public user registration terms and conditions. The PublicUser Setup page includes all registration-related configuration.

Attachments ElementYou can configure the attachments element and add it into your form multiple times. Attachments provide supportingdocumentation needed by agency staff to determine if a permit can be issued.

Configurable Features Description

Component Attributes You can name the attachments component title in the Label field.

119


Configurable Features Description

Component Multi-Instance Options

Use these multiple instance options to create unique instances of the attachment element:

• ID

• Value

For more information about multiple instance options, see Working with Predefined FormElements.

Attachment Columns:

You can configure these attachment properties in the attachments list:

• File Name: Display the file name of the uploaded file.

• Description: Display the user-entered description.

• File Size: Display the size of the uploaded file.

Business Columns:

• DocumentCategory

• DocumentSubcategory

Agency-defined document categories and document subcategories enable you to organizethe various types of attachments. You can configure these fields for document categories anddocument subcategories:

• Label: Change the field name.

• Show in List: Display the field in the attachments grid.

• Show in Detail: Display the field in the attachment detail information.

• Show in Upload: Display the field on the modal page for uploading an attachment.

• Searchable: Enable search on the document category or document subcategory field.

• Sortable: Enable sorting for the document category or document subcategory field.

Predefined Permit Elements


Construction Information

Captures information regarding the current construction site and the proposed construction project.

Demolition

If demolition is required as part of the job, this element captures information related to the scope ofthe demolition and if hazardous materials or utilities need to be considered, such as electricity, gas,water, and so on.

Electrical Equipment

Describes a structures electrical features, such as outlet types, amps, voltage, and electricappliances.

Fence Information

Describes the proposed fence attributes, such as type, material, dimensions, location, and so on.

Grading Information

Describes the scope of grading work, such as the acreage affected, materials to be used and theamount of material.

Insurance

Provides a contractor’s insurance type and policy information.

License Qualification Enables a contractor to add any state licences they have.

120



Mechanical Equipment

Describes features of the job site related to ventilation, heating, cooling, fire safety, and so on.

Photovoltaic Information

Describes attributes of a site’s solar energy configuration, such as roof area, coverage area, inverterinformation, and so on.

Plumbing Equipment

Describes attributes of a site’s plumbing configuration.

Pool Information

Describes attributes of a pool, such as type, depth, location, surrounding fencing, and so on.

Property Information

Describes the parcel as it is registered with the municipality, such as the parcel ID, parcel type, andso on.

Regulated Business Activity

Enables you to specify any regulated activity or controlled substances allowed on the premises,such as alcohol, carnival rides, casino games, and so on.

Right of Way Use

Enables you to provide any details related to the use of a right-of-way on the property or to gainaccess to the property, such as traffic, parking, or pedestrian impact.

Roof Information

Describes features of a structure’s roof, such as existing roof type, proposed roof type, number oflayers, and so on.

Site & Zoning

Describes features of the property related to acreage, flood preparedness, as well as zoning andland usage information.

Special Event

Enables you to specify information about an event, including the safety plan, concessions, facilities,potential impacts, and traffic plans.

Yard Sale

Enables you to specify yard sale information, such as the start time, end time, and the number ofdays.

Working with Group Boxes This topic describes how to add group boxes to your form and discusses group box layout options and attributes.

Use group boxes as containers to indicate the items contained within a group box are grouped logically. Once you add agroup box to a page, you can drag these items into the group box:

• Predefined elements

• User-Defined elements

• Other group boxes (nested group boxes)

121


Adding Group BoxesTo add a group box:

1. Select the UI Elements tab in the Form Elements panel.2. Click and hold on the Group Box option.3. Drag and drop the group box into the workspace.

Deleting Group BoxesTo delete a group box, click the Remove button in the upper right-hand corner of the group box.

Note: If you remove a group box from a page, the system removes all of the contents of that group box also.

Setting Group Box AttributesSelect a group box to view the Group Box Attributes panel.

122



Label

Add a name for the group box, describing the collection of items within it.

Collapsible

Turn on to enable the group box to be collapsed when an end user clicks it, hiding items it contains.If not turned on, the group box is always expanded and its items are always visible.

Flexbox Layout

With Flexbox Layout enabled, the system displays as many controls within the group box in one lineuntil all of the space is utilized, then the system wraps the row, beginning a new line. With Flexbox Layout disabled, the controls within the group box display as stacked items, with eachadditional control displaying directly beneath the previous control.

Show Label

Select to hide the group box label (specified in the Label field).

Note:You can add help only to group boxes with Show Label turned on. If Show Label is turnedoff, the Help button does not appear on the attributes panel and any help icons associatedwith any previously added help no longer appear.

Hide Border

Hides the group box border. When turned on, the border is not visible.


Hides the group box and all the elements in the group box container from the public user at runtime.Only agency staff can view and update information within a group box with Hide From Public Userturned on. In addition to hiding the UI element from the public user in the interface, the applicationalso secures the back end for that specific UI element, such as preventing any unauthorized accessto the fields contained within that UI element using a REST API, for example.

Help

Click to launch the Contextual Help page, which you can use to add help information to aid citizensin completing the intake form. The Help button appears only if Show Label is turned on. Help textadded for group boxes should apply to the overall group box content. Help can be added also atthe page level, predefined element level, and user-defined element level depending on the scope ofthe help text. For more information on adding Contextual Help, see Adding Contextual Help to Forms.

Nesting Group BoxesThe following example illustrates nested group boxes, which you achieve by dropping group boxes within group boxes.Nested group boxes can be used to represent subcategories of information and to enhance layout options, such as creatingcolumns for form elements.

123


Note: The system does not impose a limit to the depth of nested group boxes you can insert. For morecomplicated pages, for example, you may find that group boxes could be nested to 4–5 levels deep. Make sureto consider how a page with multiple levels of nested group boxes will render on all the devices you intend tosupport for your user base.

Using the Flexbox Layout AttributeUse the Flexbox Layout attribute to establish a group box container based on the CSS flexible box layout model. In theflexible box layout model, the items contained within the parent container assume a layout position automatically, based onspace in the container. As the available unused space grows or shrinks, the items in the container grow to fill the unusedspace or shrink to avoid overflowing the parent.

With Flexbox Layout on, the system displays as many controls within the group box in one line until all of the space is utilized,then the system wraps the row, beginning a new line.

With Flexbox Layout off, the controls within the group box display as stacked items, with each additional control displayingdirectly beneath the previous control.

124


Example: Using Group Boxes to Combine Predefined ElementsIn some cases you may want to give the appearance of multiple predefined elements being combined. You can do this usinga group box to act as the outer container for the set of predefined elements. When using a group box to contain predefinedelements, consider the following items:

• The collapsible attribute of the group box container controls the visibility of the contained predefined elements. If thegroup box container is set to be collapsible, when the user collapses that group box, all of the elements (predefinedand user-defined) within that group box will be hidden.

• If you want the predefined elements within the group box to be categorized under just the label of the group box,turn off the Show Label attribute of the contained predefined elements.

In the following example, assume you want to combine the Fence Information and Comment predefined elements, giving theappearance that Fence Information element contains a Comment field.

To combine predefined elements within a group box container:

1. From the user-defined elements list, drag and drop a group box into the workspace.2. Select the group box and make these changes on the Group Box Attributes panel:

Group Box Attribute Sample Value

Label

Fence Information

Flexible Box Layout

Off

3. From the predefined elements list, drag and drop the Fence Information element into the group box4. Select the Fence Information element, and turn off Show Label on the Attributes panel.5. From the predefined elements list, drag and drop the Comment element into the group box.

125


6. Select the Comment element, and turn off Show Label on the Attributes panel.7. Save your changes.

At runtime, the example steps above produce a single, collapsible section in the form that includes both the FenceInformation and the Comment predefined elements.

This example illustrates the collapsed Fence Information group box.

This example illustrates the expanded Fence Information group box containing multiple predefined elements.

126


Example: Using Group Boxes to Combine a Predefined Elements and UserDefined ElementsSimilar to combining predefined elements within a single group box container, you can also combine predefined elementsand user-defined elements within a single group box container creating the appearance of user-defined fields being part of adelivered predefined element.

In the following example, assume you need to associate a field with the Fence Information element to capture the color of aproposed fence.

To combine predefined elements and user-defined elements with group boxes:

1. From the user-defined elements list, drag and drop a group box into the workspace.2. Select the group box and make these changes on the Group Box Attributes panel:

Group Box Attribute Sample Value

Label

Fence Information

Flexible Box Layout

Off

3. From the predefined elements list, drag and drop the Fence Information element into the group box4. Select the Fence Information element, and turn off Show Label on the Attributes panel.5. From the user-defined elements list, drag and drop a text field into the Fence Information group box.6. Select the text field, and enter Color for the Label in the Field Attributes panel.

127


7. Save your changes.

The following example illustrates how at runtime, the group box containing the predefined element and the user-definedelement create the appearance of the manually created field being part of the delivered predefined element.

128


Working with Fields This topic describes how add fields to your forms, modify field attributes, and hide fields.

When end users are completing an application for a permit, they enter the required information in fields. Fields can be addedto forms by:

• Adding predefined elements to your form. Each predefined element is delivered with a set of fields.

• Adding user-defined elements (fields) to your form.

The fields that come with a delivered predefined elements are referred to as predefined element fields, while the individualfields you add manually to your form are referred to as user-defined element fields.

Note: The user-defined fields that you create cannot be used across multiple permits. Currently, a user-definedfield can be used only within the local permit.

Setting Field AttributesPredefined and user-defined element fields have the same set of attributes. Select a field to view the Field Attributes panel.

129



Label

Add a custom label to the field.

Note:In the case of a custom field, the system forces the Map Field value to match the Labelvalue, but removes any spaces. The map field represents how the field appears inthe underlying data model. For example, a custom field with the label AdditionalRequests, will have a Map Field value of AdditionalRequests.

Placeholder

Add descriptive text to aid the user in entering data. For example, the placeholder text could read:Enter date in this format” MM/DD/YY.

Default Value

Enter any default value required for the field.

Required

Enable if this is a required field.

130



Hidden

Hides the field from the user. If a predefined element contains fields that you do not need, select thisoption so the user does not have access to the field.

Open Additional Attributes

Used to add values for fields containing a list of values. For more information, see Defining Fields Displaying a List of Values.

Add Help

Click to launch the Contextual Help page, which you can use to add help information to aid citizensin completing the intake form. Help text added at the field level should apply specifically to that field.You can also add help to predefined elements, group boxes, and pages, depending on the scope ofthe help text. For more information on adding Contextual Help, see Adding Contextual Help to Forms.

Adding User-Defined Fields

Note: You can add user-defined fields to group boxes only. You can’t add user-defined fields directly to a pageor a predefined element.

To add a user-defined field:

1. Add a group box to the current page.2. Click the UI Elements tab in the Form Elements panel to display the types of fields to add to your form.3. Select the type of field you want to add to the page.4. Once the field type is selected, drag it to the page and drop the field into the desired group box.

Note: User-defined fields must be contained by a group box.

5. Select the user-defined field you added to the page, and use the Field Attributes panel to configure your field.

Note: User-defined fields and component fields use the same set of attributes.

6. Save your changes.

Once saved, the system applies your user-defined field to the application data model so field data can be captured,stored, and retrieved.

Choosing User-Defined Field Types

Field Type Description

Input Text

Character field.

Input Number

Number field.

Input Date & Time

Date-time field.

131


Field Type Description

Switch

On-off field.

Text Area

Long Character field.

Radio Set

A set of radio buttons, from which the end user can make a single selection.

Check Box Set

A set of check boxes, from which the end user can make multiple selections.

Combo Box

A drop-down list allowing the user to select a single item.

Multi-Select Combo Box

A drop-down list allowing the user to select multiple items.

Hiding FieldsIn some cases, you may not want to display all of the fields associated with the predefined element you've added to a form.You can hide unneeded fields so they do not appear to the user at runtime.

To hide fields:

1. Place your cursor in the field to select it.2. Turn on the Hidden switch on the Field Attributes panel.

Once you have hidden a field, the design-time interface continues to display the field, but places a darkened backgroundaround the field to indicate it is a hidden field. The application does not display the field at runtime.

In this example of the design-time interface, Location and Material are not set to be hidden, but Corner Lot and Other Materialare. Notice that the hidden fields display with the darkened background.

The following example of the runtime illustrates that the hidden fields do not display when an end user access the form. OnlyLocation and Material render on the form at runtime, while Corner Lot and Other Material are not rendered.

132


Note: At runtime, the system applies this style to the hidden field:style=”display: none;”. This style preventsthe field from being visible on the page.

Note: Required fields can’t be hidden fields. If you set a field to be required, the Hidden switch becomesdisabled. If a field is set to be hidden, and you set it to be required, the system sets the Hidden switch to offautomatically and disables the Hidden switch.

Defining Fields Displaying a List of Values This topic describes how to add a list-of-values to user-defined fields you add to your application forms manually.

Some of the user–defined fields that you can add to your form are considered “list-of-value” fields. List-of-value fields enableend users to select field values from a predefined set of values (a list) to populate the field when entering data on the form. Forexample, radio sets and drop-down lists are list-of-value fields.

You can only add and modify the list of values associated with user-defined fields, which are the specific fields you haveadded to your application form manually. You can’t add or modify a list of values for a field contained within a predefinedelement, such as the Fence Information element.

A a list of values is a set of fixed field values defined within the field attributes.

• Is not expected to change over time. Removing items from the list, for example, would make previously saved datainvalid.

• Should consist of reasonable number of items. Lists with larger numbers of items should be addressed with adynamic list.

An example of a field with a list of values could be the Property Zone Type field, where the pre-defined values for a user toselect are: Business, Residential, and Agricultural.

List of Value Type FieldsYou associate a list of values with these field types:

• Radio button set

• Check box set

• Drop-down list

• Multi-select list

The following example illustrates a radio set, which is a set of radio buttons allowing a user to select a single value from thelist of values.

133


The following example illustrates a check box set, which is a list of multiple items allowing a user to select multiple values fromthe list of values.

The following example illustrates a drop-down list, which is a list allowing a user to select a single value from the list of values.

The following example illustrates a multi-select list, which is a drop-down list allowing a user to select multiple values from thelist of values.

134


Adding a List of Values1. Select the user–defined field.2. Click the Open Additional Attributes button in the Field Attributes panel.3. In the Field Option Values grid, select the default row (the row with the Default Label and Default Value).4. With the row selected, enable the row for editing by:

◦ Double-clicking.

◦ Pressing F2.

◦ Pressing ENTER.

5. For Label, enter the value that the end user will see in the list of values in the user interface.

For example, if the field is Fence Materials the list of value labels could be: Wood, Stone, Metal, and so on.

Note: Each label must be unique and must not be Default Label.

6. For Value, enter a numeric value or an abbreviated character value representing the label value.

The brevity of the value can make it easier when referring to a specific value when executing business logic orspecifying the default value of the field. The end user will not see this value.

For example, if the field is Fence Materials, and the list of value labels are: Wood, Stone, and Metal, the abbreviatedvalues could be WD, ST, and ML.

Note: Each value must be unique and must not be Default.

7. Press TAB or click outside the current row to display the Add button and Delete button for that row.

Note: While editing the row, the Add and Delete buttons are hidden.

8. Click the Add button in the current row to add a new row beneath it.9. Repeat these steps until you’ve entered all the items in your list of values.

10. When you have added all of the items of the list of values, click Done.

135


11. Save your form design.

Updating a List of Values

Note: After a form has been published and accessed by end users, you should not update items in a static list.Doing so can invalidate historical data.

1. Select the user–defined field.2. Click the Open Additional Attributes button in the Field Attributes panel.3. In the Option Value List grid, select the item in the list you want to update.4. With the row selected, enable the row for editing by:

◦ Double-clicking.

136


◦ Pressing F2.

◦ Pressing ENTER.

5. Enter the required changes in the Label or Value columns.6. Click Done.7. Save your form.

Deleting an Item from a List of Values

Note: After a form has been published and accessed by end users, you should not delete items from a staticlist. Doing so can invalidate historical data.

1. Select the user–defined field.2. Click the Open Additional Attributes button in the Field Attributes panel.3. In the Option Value List grid, locate the item in the list of values that you want to delete.4. Click the Delete button in the row for that item.

Note: The Option Value List grid must contain at least one row. You can’t delete the last remaining item inthe grid, leaving no rows.

5. Click Done.6. Save your form.

Adding Contextual Help to Forms This topic describes how to add help text to various parts of your intake forms to aid citizens when they are filling out anapplication form.

Working with Contextual HelpIf you determine that the end user needs additional information to understand a user-interface element (field, page control,or page) in your intake form, you can add contextual help text to that user-interface element. If you add contextual help toa user-interface element in your intake form design, the system displays a Help icon next to the label of that user-interfaceelement.

You can see the Help icon in both the design and runtime mode. At runtime, end users click the Help icon to display yourhelp text in a popup, without leaving the page.

Note: At design time, the Help icon does not display the help text popup when clicked.

You can add contextual help text to these intake form elements:

• Page tabs

• Components

• Group boxes

• Fields (component fields and custom fields)

137


Note: For group boxes and components, you can add help only when with the Show Label attribute turned on.

You can’t add contextual help text to these intake form elements:

• Radio sets

• Check box sets

If you need to add help for radio sets or check box sets, use a group box to surround the radio items or check box items andadd the help text to the group box.

Adding Contextual HelpTo add contextual help:

1. Select the page element to which you want to add contextual help.

Note: You cannot add help text directly to radio sets and check box sets. Add help text to a group boxsurrounding the radio sets or check box sets.

2. Click the Help button in the attributes panel.3. On the Contextual Help Setup page, note the Type Code, Page Name, and Page Object values.

These values uniquely identify the page element to which you are associating the contextual help. You can’t changethese values; they are read-only and maintained by the application.

Item Value

Type Code

An automatically generated value consisting of the internal product code and the permit typecode derived from the permit type definition.

Page Name

The name of the page tab on which you are adding help. Regardless of what the page labelis on the tab, the application displays each tab using the default name in sequence, such astabs1, tabs2, and so on. For example, the second page tab in an intake form may have the name Fence Information,however in the Page Name field it will appear as tabs2.

Page Object

Identifies the page element for which you are adding help. Regardless of the page element’slabel, the application displays the internal naming convention as the field value, which is thepage element type code + sequence added. For example, for the second field added to the form the field value is fields2, which indicatesthe element is a field and it is the second field added to the form. The page element type codes are:

◦ Components: ccas

◦ Group Boxes: widgets

◦ Component Fields: <component>_<internal field name> (such as ccas2_ReleaseDate)

◦ Custom Fields: fields

138


4. In the Description field, add text to describe the purpose of the help text so other implementation team members canunderstand the content.

5. Click the Add New button in the Contextual Help Details grid to display the Add Context Help Details dialog box.6. Select Agency Defined from the Type drop-down list.

Note: Help topics of type System Defined are provided by Oracle and should not be altered orremoved. Customers should use the Agency Defined help topic type to add help topics specific to yourimplementation. If you want your custom help text to display instead of delivered help text, disable theSystem Defined help topic, create your custom topic, and enable it.

7. Activate the Help Content edit box by clicking to the right of the Help Content field label.8. In the Help Content edit box, enter your help text.

The system provides rich-text editing features, which enables you to implement limited formatting options, asneeded.

9. When you’ve added the content, and you are ready for it to be viewed by end users, turn on the Enabled switch.

Note: To prevent the help content from displaying at run time, turn off the Enabled switch.

10. Click Save on the Contextual Help Details page.11. Click Save on the Contextual Help page.12. Confirm that the help icon appears on the page tab or next to the page control label in your intake form design.

For more information on contextual help, see Setting Up Contextual Help.

Setting Form Options This topic describes the options you can set for the entire form to control the ways citizens interact with the form.

Enabling the Review PageThe review page presents all the fields of a multi-tab form on a single, scrollable page for efficient review of the entered dataprior to submitting the form.

By default, the review page displays:

• Form fields as read-only, but the end user can click the Edit button to modify the fields per predefined element asneeded.

• All predefined elements expanded.

• For multi-page view or single-page view.

• For all forms, unless disabled.

To disable the review page:

1. In the Permit Designer, click the Layout Settings link.2. On the Layout Settings dialog box, turn off Show Review Page.3. Click OK.

139


Setting a Confirmation StepYou can enable one of the pages in a form as a confirmation page to display after the end user has filled in the informationand submitted the form. You create the confirmation step in the designer and then set it to be the confirmation step in theLayout Settings.

When set as the Confirmation Step, the page displays:

• At design time with the page tab filled in grey to indicate it is the confirmation step.

• At runtime as the last page in the train stop drop-down list.

Note: The confirmation step does not display as part of the single page view.

To enable the review page:

1. In the designer, click the Form Options link.2. On the Form Options dialog box, select the desired page from the Confirmation Step drop-down list.3. Click OK.4. Click Save.

Mapping Permit Fields to the Fee Schedule This topic describes how the fields added to a permit in the Permit Designer are mapped to the fee schedule associated withthe permit type.

To access the Fee Mapping page in the Permit Designer click Next while in the layout design step.

140


Page Elements Description

Model Attribute

The name of the attribute as it appears in the decision model in Oracle Autonomous IntegrationCloud. Not all model attributes must be mapped. Because fee schedules can be reused by multiple permittypes, only the model attributes required for fee calculations for the current permit type need to bemapped. All other model attributes can be left blank.

Attribute Type

The data type of the model attribute, such as string, number, boolean, and so on.

Record Type Attribute

The field added to the permit layout either contained in a predefined form element or a user definedelement you have added manually.

You assign a fee schedule to a permit type on the Permit Type page using the Fee Schedule field. You map attributes fromthe fee schedule’s underlying decision model created in Oracle Autonomous Integration Cloud to the fields you have added toyour permit application either through predefined elements or by adding fields manually.

Note: Not all model attributes need to be mapped. Because a fee schedule can be reused by multiple permittypes, only the model attributes required for fee calculations for the current permit type need to be mapped. Allother model attributes can be left blank.

For more information on setting up fee schedules, see Setting Up Fee Schedules.

For more information on decision models, see Creating Decision Models for Fees.

Considering User Experience This topic describes concepts related to using forms that implementation teams need to consider when designing forms.

Required FieldsThe system validates that required fields contain values prior to a save request.

If a required field is empty the system displays the following error message on the page.

In addition to the message, the system disables the Save button until the required field values have been provided.

141


Runtime Application Form Save BehaviorWhen an end user navigates to another page in the application form using either the train stop drop-down list or the Nextbutton, the system automatically:

• Saves the currently entered data.

• Performs data validation on the current page.

If the end user attempts to navigate away from the application form page using, for example, the back button, entering adifferent URL, or reloading the page, the system checks for any unsaved changes or new data. If the changes or new datahave not been saved, the system displays a message to the user indicating that if they continue, unsaved changes and newdata will be lost. The user can elect to leave the page or remain on the page to save.

Runtime Train Stop Drop-Down BehaviorThe train stop drop-down list, appears in the center of the application form header to provide:

Feature Description

Context

The system automatically prepends the appropriate step number to the application form pagename. The step numbers are assigned in the order the pages appear in the designer (from left-to-right). For example, assume you have three pages in your form: Application Details, Fence Details,Property Details. The train-stop drop-down list displays the pages as:

• Step 1: Applicant Details

• Step 2: Fence Details

• Step 3: Property Details

Current Page

To show the current page the user is viewing, the system displays a single, right-pointing, chevroncharacter (>) to the left of page label in the drop-down list.

Navigation

Select any page in the application form, including the review page, to access it immediately.

Switch to Single/Multi-page view

Toggle between the multi-page view or the single-page view.

Using the Single-Page ViewWhen accessing the single-page view in review or advanced-edit mode, end users will notice these characteristics of thepage elements.

Page Element Behavior

Edit button

Enables the end user to activate the form fields for editing. Initially, the system displays them in read-only mode. Once clicked, the system toggles the Edit button to the Done button.

Done button

Once the end user completes any changes, clicking Done:

1. Performs any configured data validation.2. Saves changes to the database.

142


Page Element Behavior

3. Returns the form fields to read-only.4. Toggles the button back to read Edit.

Group Boxes

If a group box contains multiple group boxes, only the outer (parent) group box displays an Edit/Done button.

Predefined elements

If there are multiple predefined elements in a group box, they will appear to be a single page section,with one Edit/Done button controlling all the predefined elements within the parent group box. Otherwise, if the predefined elements are on the page tab separately (not within the same parentgroup box container), then the system displays an Edit/Done button for each predefined element.

Expand All/Collapse All

Expands or collapses all the elements on the page, including group boxes and predefined elementswithin parent group boxes.

Note: The Edit button and the Done button do not appear on a page rendered in advanced edit mode if theform is displayed in a read-only context. For example, if the user viewing the form does not have sufficientprivileges or if the user has already submitted the form, the fields in the form will be disabled and the Edit buttonand Done button will not be rendered on the page.

Advanced-Edit ModeIf needed, agency staff members can update a form after a citizen has submitted the form. Agency staff members access thesubmitted form using the Permit Details page in the Permit List or by deep linking. Editing a form after a citizen has submittedit is referred to as advanced-edit mode.

When in advanced-edit mode, the system:

• Displays only the predefined elements enabled for advanced-edit mode.

• Presents the form in the single-page view.

Agency staff members click the Edit button to activate fields and update data, and they click Done to save changes.

Note: Customers cannot configure whether a predefined element appears in advanced-edit mode. Predefinedelements enabled for advanced-edit mode are controlled and delivered by Oracle development. Only thepredefined elements that are appropriate for agency staff members to update are enabled for advanced-editmode.

Testing Application Forms This topic describes the methods and considerations involved with testing your application forms.

You design, create, and test application forms on your test database. You can test forms both inside and outside sandboxmode.

143


Once your forms have been created and thoroughly tested on your test database, you then migrate the newly created formsto your production system for public access.

Testing Forms Inside the SandboxYou can test draft application forms in the sandbox using the Permit Designer’s preview mode. To enter preview, click thePreview button.

In preview mode, you can test the layout of the user interface and the tab flow in a simulated runtime scenario, however, thepreview mode does not enable you to enter data and save it. To test the full functionality and data validation of your permitapplication, you must first publish the form in your test database, as described in the following section.

Note: The Permit Designer does not activate the Save button in preview mode.

Testing Forms Outside the SandboxOnce you are done testing the design of your form and the layout of the user interface using preview mode, you can begintesting your form in scenarios that end users will encounter when they apply for permits. To do this, you need to publish yourform on the test database.

For more information on publishing forms, see Publishing Application Forms.

Note: The testing data you enter and save during testing in preview mode remains in the underlying databasetables after the form is migrated to the production system.

Migrating Application Forms from the Test Database to the ProductionDatabaseAfter you have completed your testing of the application form on the test database, follow the procedure in Functional SetupManager for migrating permit metadata and permit layout metadata from the test database to the production database.

Publishing Application Forms This topic describes the steps to complete to publish a permit application form.

To make your application forms available on public landing pages, you need to publish your form.

To publish a form:

1. Confirm that you have saved and tested all changes made to your form.2. In the Permit Designer, click Publish.3. Navigate to the Permit Type page:

To navigate to the Permit Type page you can either click Back in the global header, or select Permit Setup >Permit Type.

4. On the Permit Type page, open the appropriate permit type, and set these values:

◦ Record Type Status: Ready

144


◦ Public User Enabled: Enabled for all users or Enabled for registered users.

5. Click Save.

Note: After publishing a permit, if you attempt to access the permit from a landing page and the applicationdisplays an error, make sure the Record Type Status and Public User Enabled attributes are set correctly.

Cloning Permit Definitions This topic describes how to clone a permit record definition and the associated application form design. It also covers theattributes that will be shared between the source and clone definition and the attributes you will need to modify on the cloneddefinition.

You can clone a permit type to:

• Save time when creating a similar permit type, rather than creating a new permit type from scratch.

• Create a new version of a currently published permit after making a significant correction or addition to the permitdefinition.

In some cases, it may be more efficient to create a new permit type and form, while in other cases, it may be more efficient toclone an existing permit type and form.

When you clone a permit type, you make a cloned copy of:

• Most of the permit type metadata, such as the specified Classification, Auto Number Rule, Department, FeeSchedule, and so on. Some of the metadata is not cloned, such as Permit Type, Permit Type Code, Permit TypeStatus, Help Text and so on, as you’ll need to modify those values for the cloned copy.

• All of the application form layout in the Permit Designer, including pages, group boxes, predefined form elements,and user-defined fields you have added to your application form.

When deciding to clone a permit type, you may consider:

• The number of fields and pages within the existing application form layout that you’d need to change.

• Similarity between the existing permit type and new permit.

• Number of shared attributes.

Note: In general, if you intend to make numerous modifications to the cloned copy, it may be more efficient tostart a new permit from scratch.

When cloning to make a new permit type, you will want to make sure you are aware of:

• The attributes that will be shared between the source definition and the clone.

• The attributes you need to modify to create unique values between the source definition and the clone.

When cloning a permit type, make sure you are aware of the metadata attributes that are carried into the cloned definitionand the attributes that are not.

Note: All modifications you make to a permit should be done in your test environment and not on yourproduction environment. After you have thoroughly tested your changes in the test environment, yourmodifications should be migrated using the Functional Setup Manager task flows.

145


Permit Type Metadata ConsiderationsAll of the field values on the Permit page will appear in the cloned permit type, except for selected field values listed in thefollowing table.

Make sure to update any of the copied information on the Permit page to reflect the requirements of the new permit. Forexample, if the Department, Fee Schedule, or Workflow information, should be different, make sure to update it for the newpermit so it is associated with the correct items.


Permit Type

Update for a new permit type, or enter the same value as the source permit type if you are creatinga new version of the same permit type.

Permit Type Code

Update for a new permit type, or enter the same value as the source permit type if you are creatinga new version of the same permit type.

Permit Type Status

Initially, for a newly created permit this is always set to Preliminary. When you are ready to publishthe new permit, update this value.

Valid From Date

The application inserts the current date for the cloned permit.

Valid To Date

Update to reflect your business requirements.

Public User Enabled

Initially, for a newly created permit this is always set to Not enabled for public users. When you areready to publish the new permit, update this value.

For more information on the fields on the Permit page, see Setting Up Permit Types.

Permit Type Permit Designer Layout Attribute ConsiderationsThe following table addresses specific considerations for UI elements in your application form layout with respect to clonedpermit types and application forms and how any changes you make to the cloned definition may affect the source definition.

Element Description

Predefined Elements

The cloned copy of the permit contains the same layout as the source permit definition. If the application form utilized any of the delivered, predefined elements, the application copiesthe predefined elements into the cloned copy of the permit, using the same layout as the sourcedefinition. For example, if you added the Fence Information predefined element to the source permitdefinition to the second page tab, the Fence Information element would appear in the cloned copyof the permit on the same page tab.

Labels

The labels for fields and UI elements, such as pages, group boxes, predefined elements, and so on,are the same between the source and cloned definition.

User-defined fields

Any fields you have added manually to the source will be copied, as is, to the cloned definition. For any fields that you have defined a list of values, make sure it applies to your new permit.

146


Element Description

Security

The cloned definition will have the same security configuration as the source definition for:

• Data security for column authorization and data redaction.

• Cases where Hide from public user has been implemented.

Help

If any help has been added to the form for a page, predefined element, group box, or field, for thesource definition, the application does not copy help references into the cloned definition.

Note:You can remove the help references from the cloned form, but do not delete the help textfrom the Contextual Help page if other forms are still using that help text.

You are also cloning the fee mapping, which is defined in the second step of the Permit Designer.

Cloning a Permit Type to Create a New Permit TypeWhen you clone a permit type, you also clone the associated form design. You cannot clone just a permit type or just an formdesign; the application clones both definitions.

To clone a permit type:

1. Select Permit Setup > Permit Type.2. Open the desired permit type.3. Click the Clone button.4. Enter a unique Record Type.5. Enter a unique Record Type Code.

Note: Providing a unique permit type and permit type code are the required changes to make the recordunique.

6. Save the cloned definition.

Note: When saving the cloned definition, the application places the cloned definition within a sandbox.

7. Make any other required changes to the cloned definition permit type and form design.

See the previous sections for more information regarding what items to check.

Note: If there are numerous custom fields in the application form, when you have the layout open inPermit Designer, it can take several minutes to perform the initial save. While saving, the application iscreating all of the custom fields, creating the other elements, and running validation.

8. Publish the cloned definition.

For more information on publishing a permit, see Publishing Application Forms.

147


Considerations for Creating a New Version of a Permit Type Using CloningIn some cases, you may want create a new version of an existing, published permit to correct an error or make a change.

If the change made is insignificant, as in it does not change the meaning of a field or page element, then in most casescloning is not required, and you can simply make the change directly to the permit definition. For example, assume you havea field for an email address on your form, and it had been requested to change the label from E-mail to Email (removing thehyphen). In this case, the change can be made directly to the form and republishing it.

However, in other situations, the change may be significant, in that it affects reporting associated with permit, alters historicaldata, makes future data out of sync with historical data, and so on.

Significant changes where cloning a permit is recommended include:

Permit Element Examples of Significant Changes

Predefined form elements

• Changing the label of a predefined form element.

• Adding

• Removing

• Updating the security (Hide from public user)

• Changing the label, hidden, or required setting of a field within a predefined form element.

User-defined form elements

• Adding

• Removing

• Setting to required

• Updating a default value

• Updating the security (Hide from public user)

HTML UI constructs

• Adding page tabs

• Removing page tabs

• Adding group boxes

• Removing group boxes

Creating a New Version of a Permit Type Using CloningCreating a new version of a permit using the cloning feature involves:

• Deactivating the published version of the permit.

• Cloning the published version of the permit.

• Activating the cloned copy of the permit.

To deactivate a published permit:

1. Select Permit Setup > Permit Type.2. Open the definition for the published permit.3. Set the Permit Type Status field to Void.4. Click Save.

148


To clone the published permit:

1. With the permit still open from the previous steps, click Clone.2. Enter the same Permit Type value as used for the recently deactivated permit.3. Enter a unique Record Type Code.

Note: Providing a unique permit type and permit type code are the required changes to make the recordunique. To keep track of versions, you can add v2, v3, v4 to the name, for example.

4. Save the cloned definition.

Note: When saving the cloned definition, the application places the cloned definition within a sandbox.

5. Make any other required changes to the cloned definition permit type and form design.

See the previous sections for more information regarding what items to check.6. Click Publish in the Permit Designer to publish the cloned definition.

For more information on publish a permit, see Publishing Application Forms.

To activate the new permit:

1. Select Permit Setup > Permit Type or press Back from the Permit Designer interface.2. Open the definition for the published permit.3. On the Permit page, set these values:

◦ Permit Type Status: Ready.

◦ Public User Enabled: Enabled for all users or Enabled for registered users.

4. Click Save.

149


150

Implementing Oracle Public Sector Permits Chapter 7Setting Up Inspections

7 Setting Up Inspections

Setting Up Inspection Statuses Oracle delivers inspection statuses for use during the inspection process. You review the statuses on the Inspection Statuspage.

You review inspection statuses during permit setup on the Inspection Status page. You cannot delete the system-definedstatuses or add new statuses, but you can modify the associated inspection status names and descriptions.

Modifying Inspection Statuses1. Select Permit Setup > Define Status .2. Select the Inspections tab.3. You can review the delivered inspection statuses in the System Status column:

◦ Pending

◦ Requested

◦ Scheduled

◦ Completed

◦ Canceled

◦ Deleted

4. Select the row for the inspection status that you want to modify.5. On the Inspection Status Details page you can edit the inspection status name and description.

The status name is used as the display status for the inspection in the permit application.6. Click Save to save any changes.

Inspection Evaluation Overview The inspector evaluates a building site for adherence to codes and regulations required for a permit. The example hereprovides information about an inspection set up to use automatic score calculation with the bottom up scoring method.

A permit might require one or more inspections, each inspection might have one or more checklists, and each checklist mighthave checklist items or not, depending on the inspection configuration. The inspector performs an inspection by assessingthe checklist items, if any, then checklists, and up to the inspection level. The evaluation results that the inspector enters arerolled up to the next level until a final inspection score is calculated.

The following example describes the setup and results of performing an inspection using the bottom up method of scoring.Scoring bottom to top indicates that the inspector starts with a zero score and adds points for each criterion that is met.

151


Example: Using the Bottom Up Scoring MethodBefore you begin, set up the assessment type, rating method, passing rule, scoring method, and checklist, which includesthe checklist items. In this case, you don’t need to set up the checklist group, because checklist and checklist group aremutually exclusive of each other.

This example illustrates setup for an inspection on the Inspection Type Details page. Details are in the surrounding text.

The setup includes the following:

1. Assessment Method

The assessment method is defined on the assessment type page and used in the inspection type definition. Duringthe inspection, the inspector selects an available assessment which is associated with a system result. The systemresult determines the scoring calculation as follows:

Displayed Assessment System Result Scoring Calculation

Pass

Pass

Score = All Points

Corrected on Site

Corrected

Score = All Points

Fail

Fail

Score = No Points

NA (not applicable)

Other

Score = No Points

Note: Only the displayed assessment value is configurable by the agency. The available system resultsare Pass, Fail, Corrected, and Other. You must have one assessment with a system result of Pass andone assessment with a system result of Fail. You can define multiple assessments with system results ofCorrected and Other.

152


See Setting Up Inspection Assessment Types.2. Inspection Scoring Method

The scoring method is defined on the inspection type. In this example, the scoring method is Bottom Up.

See Setting Up Inspection Types.3. Rating Method

When you use a scoring method, you also must set up a rating method. The rating method defines the range ofscores used at the inspection type level.

See Setting Up Rating Methods.4. Checklist

The checklist used in the inspection is defined on the inspection type. For example, the checklist could be Electricalfor a residential addition. For multiple checklists, you enter a checklist group name. A checklist group can havedifferent inspection checklists, such as both Electrical and Plumbing for a residential addition.

See Setting Up Inspection Checklists.5. Checklist Item

The inspection score is defined in the inspection checklist details. In this example, each checklist item is set up witha possible score of 25. The inspector’s assessment determines how many points are applied to the checklist. Whenthe inspection result is Pass, the item receives the complete score.

See checklist details in Setting Up Inspection Checklists.

Based on the setup, an example inspection evaluation might look like this:

Checklist Item Possible Score Inspector’sChecklist ItemResult (Assessment)

Assessment SystemStatus

Calculated Score Checklist TotalScore

1

25

Pass

Pass

25

Item 1 = 25

2

25

Pass

Pass

25

Item 1 + Item 2 = 50

3

25

Corrected on Site

Corrected

25

Item 1 + Item 2 +Item 3 = 75

4

25

Fail

Fail

0

Item 1 + Item 2 +Item 3 + Item 4 = 75

For multiple checklists, the sum of the checklist scores determines the inspection score.

Setting Up Inspection Assessment Types Assessment types identify the results available for assessing an inspection, for example, Pass and Fail. You add, modify, ordelete assessment types and codes for inspections on the Assessment Type pages.

153


An assessment type includes one or more assessment codes, which identify the possible results for the inspection type.Assessment types are also used for inspection checklist and checklist item results.

Assessment types function independently of the scoring method, maximum score, and minimum score, for example:

• If the system result is Pass or Corrected, the full score is assigned.

• If the system result is Other or Fail, the score is 0.

Scoring for each system result is predefined in the system for inspections.

This example illustrates the Assessment Type Details page containing the field values described in the following table.

Adding Inspection Assessment Types1. Select Inspection Setup > Assessment Type .2. On the Assessment Type page, click Add to add an assessment type.3. On the Assessment Type Details page, enter an assessment type name and description.4. In the Assessment Details section, click Add in the assessment code row.5. Enter values in the fields of the assessment code row:


Assessment

Enter a code name.

Description

Enter descriptive text for the code.

System Result

Select the system-defined result value that you want to set for this assessment code:

◦ Other

◦ Pass

◦ Fail

◦ Corrected

You must map each assessment code to a system result value. Each assessment type mustinclude a system result of Pass and a system result of Fail. The default value is Other.

Note:You must assign Fail to only one code. Likewise, you must assign Pass to only onecode.

154



The system result is used in the inspection result processing. If scoring is used, the systemresult of Pass and Corrected receive the maximum score. The system results Other and Failreceive no score. The system result is also used to determine whether an inspection result is pass (systemresult Pass) or fail (system result Fail). For example, the Inspection Summary report includesviolation information when a checklist or checklist item result is associated with the systemresult Fail.

6. Click the Add icon at the end of the row to add another assessment code row.7. Click Save.

Modifying Inspection Assessment Type Details1. Select Inspection Setup > Assessment Type .2. Select the row for the assessment type you want to modify.3. In the header fields on the Assessment Type Details page, you can only modify the assessment type description.

You cannot change the name.4. In the Assessment Details section, you can:

◦ Change the description of an assessment code. You cannot change the code name.

◦ Select a new value in the System Result column. Available values are Pass, Fail, Corrected, or Other. Eachassessment code must be mapped to a system-defined result value. The default value is Other. You can onlyuse Pass and Fail once.


Deleting Inspection Assessment Types1. Select Inspection Setup > Assessment Type .2. On the Assessment Type page, click the Edit icon.3. Select one or more check boxes for the assessment type rows you would like to delete.

Note: When you delete an assessment type, you also delete the associated details.

4. Click the Delete icon.

Deleting Inspection Assessment Type Details1. Select Inspection Setup > Assessment Type .2. On the Assessment Type page, select the row for the assessment type you are working with.3. On the Assessment Type Details page, click the Delete icon at the end of the assessment code row you would like

to delete. You delete details one row at a time.4. Click the Save button.

155


Setting Up Rating Methods A inspection rating method may have one or more rating ranges, which an inspector uses to evaluate the object of aninspection. You add, modify, or delete rating methods and rating details for inspections on the Rating Method page.

If you are using scoring for inspections, you must also set up rating methods. Rating methods are used at the inspection typelevel and are not required at the checklist or checklist item levels.

Adding Rating MethodsYou add an inspection rating method by setting up the rating method code with a description and rating details. For example,an agency might use GRADES as the rating method code, with a description of Standard Grades. The rating details mightinclude grades such as A (high) to F (low), and provide a range of scores to each rating. If the rating for an A grade is definedby 90-100 points, an inspection score of 95 would receive an A.

1. Select Inspection Setup > Rating Method .2. On the Rating Method page, click Add to add a rating method.3. On the Rating Method Details page, enter a rating method name and description. The description is a user-friendly

name for the inspection rating method.4. To add rating method values, click the Add button for the first row in the detail grid, and the Add icon for the next

rows.5. Enter values for the rating method:


Rating

Enter a short name for the rating.

Minimum Score and MaximumScore

Enter minimum and maximum numerical values to specify the range for this rating. Do notuse decimals. The range for this rating cannot overlap the range for another rating.

6. Click Save.

For example, if your rating method uses grades A through F, you specify the rating range for each grade in the RatingMethod Values table. The range for each rating cannot overlap the range for another rating.

Rating Minimum Score Maximum Score

A

91

100

B

81

90

C

71

80

D

61

70

F 0 60

156


Rating Minimum Score Maximum Score

Modifying Rating Methods1. Select Inspection Setup > Rating Method .2. On the Rating Method page, select the row for the rating method you want to modify.3. In the header fields on the Rating Method Details page, you can only modify the rating method description. You

cannot change the name of the rating method.4. Click Save.

Modifying Rating Method ValuesYou can change the minimum and maximum scores for a rating on the Rating Method Details page.

1. Select Inspection Setup > Rating Method .2. On the Rating Method page, select the row for the rating method you want to modify.3. On the Rating Method Details page, select the rating row in the values grid that you want to modify.4. Change the values in the Minimum Score or Maximum Score fields for this rating on the Rating Method Value

Details page. You can use the arrow icons to increase or decrease the score values. The range for this rating cannotoverlap the range for another rating. You cannot change the name of the rating.

5. Click Save.

Deleting Rating Methods1. Select Inspection Setup > Rating Method .2. On the Rating Method page, select the row for the rating method you want to delete.3. On the Rating Method Details page, click Delete.

Note: When you delete a rating method, all associated rating details are also deleted.

4. To delete multiple rating methods, click the Edit icon on the Rating Method page.5. Select the check boxes for the rating methods you want to delete.6. Click the Delete icon.

Note: When you delete multiple rating methods, all associated rating details are also deleted.

7. Click Save.

Deleting Rating Method Values1. Select Inspection Setup > Rating Method .2. On the Rating Method page, select the row for the rating method you want to modify.3. On the Rating Method Details page, select the ratings row in the value grid that you want to delete.4. On the detail page for the individual rating, click Delete.5. To delete multiple rating method values, click the Edit icon in the Rating Method Values section.6. Select the check boxes for the rating method values you want to delete.7. Click the Delete icon.

157


8. Click Save.

Setting Up Passing Rules A passing rule identifies the different ways an inspection can be scored. You add, modify, and delete passing rules forinspections on the Passing Rule page.

Passing rule definitions provide the criteria for determining whether an inspection passes or fails. If the scoring method is notused in the inspection type definition, a passing rule is not required.

Adding Passing RulesA passing rule may have one or more scoring ranges that you specify in the passing rule details.

1. Select Inspection Setup > Passing Rule .2. On the Passing Rule page, click Add to add a new passing rule.3. On the Passing Rule Details page, enter a unique code for the passing rule and a description.4. To add scoring ranges, click Add in the Passing Rule Criteria section.5. Enter values in the fields on the rule details page:


Description

Enter a description for the scoring range.

Minimum Score and MaximumScore

Enter minimum and maximum numerical values to specify the scoring range. You cannot usedecimals.

Number of Major Violations

Enter a value for the maximum number of major violations allowed.

Pass

Turn on the Pass switch if the specified scoring range combined with the number ofviolations results in a passing inspection. If the specified range and violations do not result ina passing inspection, leave the option disabled.

Note:For passing inspections that are based on a passing rule with the Pass switch on,the inspection result displays the assessment name that is defined with the systemstatus Pass. If the Pass switch is off, the inspection result displays the assessmentname that is defined with the system status Fail. The system uses the assessmenttype that is associated with the inspection type.

6. Click Save.

Modifying Passing Rules1. Select Inspection Setup > Passing Rule .2. On the Passing Rule page, select the row for the passing rule you want to modify.3. In the header fields on the Passing Rule Details page, you can only modify the passing rule description. You cannot

modify the passing rule code.

158


4. Click Save.

Modifying Passing Rule DetailsYou can change the scoring range for a passing rule on the Passing Rule Details page.

1. Select Inspection Setup > Passing Rule .2. On the Passing Rule page, select the row for the passing rule you want to modify.3. On the Passing Rule Details page, select the scoring row in the details grid that you want to modify.4. You can change the following scoring details:

a. Description of the scoring range.b. Minimum and maximum scores to update the scoring range. Use the arrow icons to increase or decrease the

score values.c. Number of major violations allowed.

You can also indicate that the specified scoring range combined with the number of violations can result in a passinginspection, by clicking the Pass slider. Turn off the option using the slider if the scoring range combined with theviolations does not result in passing an inspection,

5. Click Save.

Deleting Passing RulesWhen you delete a passing rule, all associated passing rule criteria are also deleted.

1. Select Inspection Setup > Passing Rule .2. On the Passing Rule page, select the row for the passing rule you want to delete.3. On the Passing Rule Details page, click Delete.4. If you want to delete multiple passing rules, you can delete them from the Passing Rule page:

a. Click the Edit icon.b. Select the check boxes for the passing rule rows to delete.c. Click the Delete icon.

Deleting Passing Rule Criteria1. Select Inspection Setup > Passing Rule .2. On the Passing Rule page, select the row for the passing rule with the passing rule criteria you want to delete.3. In the Passing Rule Criteria section, select the row for the passing rule criteria you want to delete.4. On the Passing Rule Criteria Details page, click the Delete button.5. If you want to delete multiple scoring ranges, you can delete them from the Passing Rule Details page:

a. Click the Edit icon.b. Select the check boxes for the passing rule criteria rows to delete.c. Click the Delete icon.

Setting Up Checklist Item Categories Use checklist categories and subcategories organize the various types of checklists items for inspections.

159


You set up inspection checklist categories and subcategories on the Inspection Checklist Category page.

Use the checklist categories and subcategories for categorizing checklist items when you set up inspection checklists on theInspection Checklist Item Details page. See Setting Up Inspection Checklists.

Adding Checklist Item Categories1. Select Inspection Setup > Checklist Category .2. On the Checklist Category page, click Add to add a checklist category.3. On the Checklist Category Details page, enter a category ID and description.4. If you want to add a subcategory, click the Add button to add the first subcategory in the Checklist Subcategory

section. Click the Add icon for additional subcategories.5. On the Checklist Subcategory Details page, enter a subcategory ID and a description.6. Click Save.

Modifying Checklist Item Categories1. Select Inspection Setup > Checklist Category .2. On the Checklist Category page, select the row for the category that you want to modify.3. On the Checklist Category Details page, you can only modify the category description. You cannot change the

category ID.4. Click Save.

Modifying Checklist Item Subcategories1. Select Inspection Setup > Checklist Category .2. On the Checklist Category page, select the row for the category with the subcategory that you want to modify.3. Select the subcategory that you want to modify in the Checklist Subcategory section.4. You can only change the description on the Checklist Subcategory Details page.5. Click Save.

Deleting Checklist Item CategoriesWhen you delete a checklist category, all associated subcategories are also deleted.

1. Select Inspection Setup > Checklist Category .2. On the Checklist Category page, select the row for the category that you want to delete.3. On the Checklist Category Details page, click Delete.4. If you want to delete multiple checklist categories, you can delete them on the Checklist Category page:

◦ Click the Edit icon.

◦ Select the check boxes for the category rows to delete.

◦ Click the Delete icon.

Deleting Checklist Subcategories1. Select Inspection Setup > Checklist Category .2. On the Checklist Category page, select the row for the category with the subcategory that you want to delete.3. On the Checklist Category Details page, select the row for the subcategory that you want to delete.4. Click the Delete button on the Checklist Subcategory Details page.

160


5. If you want to delete multiple subcategories, you can delete them on the Checklist Category Details page:

◦ Click the Edit icon.

◦ Select the check boxes for the subcategory rows to delete.

◦ Click the Delete icon.

Setting Up Inspection Checklists Inspection checklists identify all the items that the inspector must assess during an inspection. You set up inspectionchecklists and checklist items on the Inspection Checklist pages.

Before adding inspection checklists, you set up:

• Inspection assessment types for your agency, if you want to associate a checklist with an assessment type.See Setting Up Inspection Assessment Types.

• Inspection checklist categories and subcategories, if you want to categorize your checklist items.See Setting Up Checklist Item Categories.

You add, modify, and delete checklists and checklist items in the inspection setup pages. The checklist and checklist itemsare copied to the inspection when the inspection schedule is created, and appear on the Inspection Checklist page, theChecklist Items page, and the Checklist Item Result page.

Note: When you modify an inspection checklist or checklist item, the updated checklist is applied to newinspections using the checklist. Existing inspections use the version of the checklist definition in use when theinspection was scheduled.

You identify the checklist or checklist group to use for an inspection on the Inspection Type page. To set up a checklist groupafter setting up checklists, see Setting Up Inspection Checklist Groups.

This example illustrates the Inspection Checklist Details page containing the field values described in the preceding table.

161


Adding Inspection Checklists1. Select Inspection Setup > Inspection Checklist .2. On the Inspection Checklist page, click Add to add a checklist.3. On the Inspection Checklist Details page, enter a checklist ID and description.4. Verify that the Enabled switch is turned on. The switch is turned on by default for new checklists.5. You can also enter values for these fields:


Assessment Type

Enter an assessment type. The system determines a passing result based on the assessment type defined for thechecklist. The assessment that is defined with system status Pass is used for the passingresult. Otherwise, the assessment that is defined with the system status Fail is used. Assessment types function independently of the scoring method, maximum score, andminimum score. See Setting Up Inspection Assessment Types.

Maximum Score

Enter the maximum score possible for the checklist. his value is required if the scoringmethod is Top down, which will be available in a future release.

Minimum Passing Score

Enter a minimum score for a passing grade. This value is required if the scoring method isBottom up or Top down. If the total score for the checklist is equal to or greater than the minimum passing score, thechecklist receives a passing result.

Scoring Method

Select a scoring method to be used for the checklist:

◦ Bottom up: Scoring from the bottom up indicates that the scoring starts with zero andthe inspector adds points for the criteria that are met.

◦ Top down: Scoring from the top down indicates that the scoring starts with the totalpossible points and the inspector subtracts points for each infraction. This option willbe available in a future release.

◦ Not used: This is the default value and indicates that no scoring method is used forthis checklist.

Comment

Enter any additional information.

6. Click Save.

Adding Inspection Checklist Items1. Select Inspection Setup > Inspection Checklist .2. On the Inspection Checklist page, select the row for the checklist to which you want to add checklist items.3. On the Inspection Checklist Details page, click the Add button in the Checklist Items section to add the first

checklist item. Click the Add icon for additional checklists.4. Enter values for fields on the Checklist Item Details page. Required fields include the checklist item ID and

description.

162



Checklist Item and Description

Enter an ID and description for the checklist item.

Score

Enter the score the item receives if it passes the inspection.

Major Violation

Turn on the switch to indicate that this checklist item is considered a major violation if it doesnot pass inspection.

Category and Subcategory

Enter a category and subcategory for the checklist item. See Setting Up Checklist ItemCategories.

Instructions

Click the Add button in the Instructions section to add instructions for inspecting thechecklist item. Add instructions on the Instruction Details page, including an instructions ID and theinstructional text.

5. The Required switch is turned on by default to indicate that the inspection of the item is required. The inspectorcan’t submit the inspection result until all required checklist item and checklist results are complete.If the checklist item is not required, you can turn off the switch.

6. Click Save.

Modifying or Deleting Checklists1. Select Inspection Setup > Inspection Checklist .2. On the Inspection Checklist page, select the row for the checklist you want to modify.3. On the Inspection Checklist Details page, you can change the values for all fields except for the checklist ID.4. If you made any changes, click Save.5. If you want to delete the checklist, click Delete.

Note: When you delete a checklist, all associated checklist items are also deleted.

6. If you want to delete multiple checklists, you can delete them from the Inspection Checklist page:a. Click the Edit icon.b. Select the check boxes for the checklist rows to delete.c. Click the Delete icon.

Modifying or Deleting Checklist Items1. Select Inspection Setup > Inspection Checklist .2. On the Inspection Checklist page, select the checklist row associated with the checklist item.3. On the Inspection Checklist Details page, select the row for the checklist item in the Checklist Items section.4. On the Checklist Item Details page, you can change the values for all fields except for the checklist item ID.5. If you made any changes, click Save.6. If you want to delete the checklist item, click Delete.7. If you want to delete multiple checklist items, you can delete them from the Inspection Checklist Details page using

the Edit and Delete icons.

163


8. Click Save.

Modifying or Deleting Checklist Item Instructions1. Select Inspection Setup > Inspection Checklist .2. On the Inspection Checklist page, select the checklist row.3. On the Inspection Checklist Details page, select the row for the checklist item that contains the instructions.4. On the Checklist Item Details page, select the row for the instructions that you want to modify or delete.5. Change the instructional text on the Instruction Details page. You can’t change the instructions ID.6. If you made any changes, click Save.7. If you want to delete the instructions, click Delete.8. If you want to delete multiple instructions, you can delete them from the Checklist Item Details page using the Edit

and Delete icons.9. Click Save.

Setting Up Inspection Checklist Groups A checklist group comprises inspection checklists that you can associate with a permit. You define a checklist group byselecting one or more inspection checklists.

You set up inspection checklist groups on the Checklist Group page.

Before setting up inspection checklist groups, you must set up your checklists on the Inspection Checklist page. See SettingUp Inspection Checklists.

Adding Inspection Checklist Groups1. Select Inspection Setup > Checklist Group .2. On the Checklist Group page, click Add to add a checklist group.3. On the Checklist Group Details page, enter a name and a description for the group of inspection checklists.4. Click Save.5. To add an inspection checklist to the group, click Add in the Checklists section.6. On the Checklist Details page, enter the ID for an existing checklist in the Checklist field.

The description for the checklist ID you entered appears in the Description field.7. Click Save.

Modifying Inspection Checklist GroupsYou can modify or delete checklist groups and lines on the Inspection Checklist Group page.

1. Select Inspection Setup > Checklist Group .2. On the Checklist Group page, select the row for the checklist group that you want to modify.3. On the Checklist Group Details page, you can only modify the checklist group description. You cannot change the

group name.4. Click Save to save any changes.

Deleting Inspection Checklist Groups1. Select Inspection Setup > Checklist Group .

164


2. On the Checklist Group page, select the row for the checklist group that you want to delete.3. On the Checklist Group Details page, click Delete.4. If you want to delete multiple checklist groups, you can delete them from the Checklist Group page:

a. Click the Edit icon.b. Select the check boxes for the checklist group rows to delete.c. Click the Delete icon.

Removing Inspection Checklist from an Inspection Checklist Group

Note: You cannot modify inspection checklists on the Inspection Checklist Group pages; you can only removethem from the group.

1. Select Inspection Setup > Checklist Group .2. On the Inspection Checklist Group page, select the row for the checklist group from which you want to remove one

or more inspection checklists.3. On the Inspection Checklist Group Details page, select the row for the inspection checklist that you want to remove

from the group.4. On the Inspection Checklist Details page, click Delete.5. If you want to remove multiple inspection checklists from the group, you can delete them from the Inspection

Checklist Group Details page:

a. Click Edit in the Inspection Checklists section.b. Select the check boxes for the inspection checklist rows to delete.c. Click Bulk Delete.d. Click Save.

Setting Up Inspection Types Define inspection types used by your agency to identify the requirements and options for different types of inspections. Youset up information such as scheduling, assessments, checklists, billing, signatures required, and comments on the InspectionType pages.

The inspection type is associated with the permit for the scheduled inspection and defines the different attributes forperforming the inspection.

This example illustrates the Inspection Type Details page containing the field values described in the following table.

165


Note: When you modify an inspection type, the updated values are applied to new inspections using theinspection type. Existing inspections use the original inspection type definition.

Adding Inspection TypesYou add inspection types for your agency on the Inspection Type page. You must set up the attributes for the inspection typebefore you begin.

1. Select Inspection Setup > Inspection Type .2. On the Inspection Type page, click Add New to add a new inspection type.3. Enter values for fields on the Inspection Type Details page. Required fields include Inspection Type and

Description, Estimated Duration in Hours, and Autonumber Rule.


Inspection Type and Description

Enter a unique ID and description for the inspection type.

Estimated Duration in Hours

Enter the estimated number of hours this type of inspection will take. This field is required for scheduling. For more information, see Setting Up InspectionScheduling.

Scheduling Method

Select the Schedule method. When you select Schedule in the setup, the user schedules theinspection by entering the inspection date and time on the Inspection List page. The methodRequest will be available in a future release. For more information, see Setting Up Inspection Scheduling.

Assessment Type

Enter an assessment type, which is used in the inspection result processing. For more information, see Setting Up Inspection Assessment Types.

166



Passing Rule

Enter a passing rule, which defines the criteria for determining whether an inspection passesor fails. For more information, see Setting Up Passing Rules.

Rating Method

Enter a rating method, which defines the scoring ranges used by the passing rule todetermine whether an inspection passes or fails. You must set up a rating method if you are using scoring. For more information, see SettingUp Rating Methods.

Scoring Method

Select a scoring method from these options:

◦ Bottom up: Scoring bottom to top indicates that the inspector starts with zero andadds points for each criterion that is met. You must set up a passing rule for bottomup scoring.

◦ Top down: Scoring from the top down indicates that the scoring starts with the totalpossible points and the inspector subtracts points for each infraction. This option willbe available in a future release.

◦ Not used: This is the default value and indicates that no scoring method is used forthis inspection type.

Note:If your inspection does not use checklist items, you must select a scoring method.If your inspection uses checklist items, the system calculates the total score of theinspection by adding the scores of all checklists.

Maximum Score

Enter the maximum number of points. The maximum score applies to all the checklist itemsassigned to a checklist. This value is required only if the scoring method is Top down, which will be available in afuture release.

Autonumber Rule

Enter the ID for the automatic numbering rule to use for generating the inspectiontransaction key. For more information, see Setting Up Autonumbering.

Checklist Group

You can enter a checklist group. If you enter a checklist group, you cannot also enter achecklist ID. For more information, see Setting Up Inspection Checklist Groups.

Checklist

You can enter the ID for a single checklist. You cannot enter both a checklist group and achecklist ID. For more information, see Setting Up Inspection Checklists.

Billable

Click this slider if this inspection type is billable. When you turn on this switch, the Bill Typefield becomes required.

Bill Type

Enter a bill type. This field is required if the Billable switch is turned on. For more information, see Setting Up Bill Types.

167



Policy Name and Policy Version

Enter the name of the template and version number the OPA (Oracle Policy Automation)policy. For more information, see Overview of Oracle Policy Automation Configuration.

Inspector Signature Owner Signature Contractor Signature

Select a signature option for the inspector, owner, and contractor associated with theinspection type:

◦ Required: The signature field appears on the Inspection Results page.

Note:Inspectors can’t submit a completed inspection if required signatures are missing.

◦ Not Required: The signature field does not appear on the Inspection Results page.

◦ Optional: A signature is optional for this inspection type.

The default value for the Inspector Signature is Required. The default value for the Owner Signature and Contractor Signature is Optional.

Schedule Cutoff Time

Enter the time when scheduling requests for the following day end. For example, if the cutoff is 3:00 PM and current time is 4:30 PM, the agency or permit applicant can’t select aninspection time for tomorrow. This field is required for scheduling. For more information, see Setting Up InspectionScheduling.

Inspection District Type

Enter the inspection district type for this inspection, for example a building, electrical, orplumbing inspection district. When the inspection with this inspection type is scheduled, thesystem finds the inspector who is assigned to a district belonging to the inspection districttype defined on the inspection type. This field is required for scheduling. For more information, see Setting Up InspectionScheduling.

Schedule Change Policy

Enter the acceptable number of hours prior to the inspection that the user can change theschedule. For more information, see Setting Up Inspection Scheduling.

Hide Inspector Comments

Turn on this switch if you want to hide inspector comments from public users. The defaultvalue for this switch is off so that inspector comments are visible.

4. Verify that the Enabled switch is turned on if you want to enable this inspection type when you save it. The switch isturned on by default for a new inspection type.

5. Click Save.

168


Modifying or Deleting Inspection TypesYou can modify or delete inspection types on the Inspection Type page.

1. Select Inspection Setup > Inspection Type .2. On the Inspection Type page, select the row for the inspection type you want to modify.3. On the Inspection Type Details page, you can change the values for all fields except for the inspection type code.4. If you made any changes, click Save.5. To delete the inspection type, click Delete.6. If you want to delete multiple inspection types, you can delete them from the Inspection Type page:

a. Click the Edit icon.b. Select the check boxes for the inspection type rows to delete.c. Click the Delete icon.

Setting Up Inspection Groups An inspection group identifies a group of inspection types associated with a permit. You can set up inspection groups on theInspection Group page.

The inspection group includes one or more inspection types. You can define inspection groups separately from permit typedefinitions.

Before setting up inspection groups, you must set up inspection types for your agency on the Inspection Type page. SeeSetting Up Inspection Types.

Adding Inspection Groups1. Select Inspection Setup > Inspection Group .2. On the Inspection Group page, click Add to add a new inspection group.3. On the Inspection Group Details page, enter a name and a description for the inspection group.4. Click the Enabled switch to enable the new inspection group.5. To add inspection types to include in the group, click Add in the Inspection Types section.6. Enter values in the columns of the inspection type row:

a. Inspection Type: Enter an existing inspection type.

The description for the inspection type you entered will appear in the Description field.b. Required: Click the switch if the inspection type is required for the inspection group.

Note: Even if an inspection type is not required, it may become required based on business rulesduring processing.

c. Final Inspection: Click the switch if this inspection type is the final inspection. One and only one row must beset as the final inspection.

d. Click the Add icon to add another type; otherwise, click Save.7. On the Inspection Group Details page, click Save.

169


Modifying or Deleting Inspection GroupsYou can modify or delete inspection groups on the Inspection Group page.

1. Select Inspection Setup > Inspection Group .2. On the Inspection Group page, select the inspection group that you want to modify.3. On the Inspection Group Details page, you can only modify the inspection group description. You cannot change the

group name.4. Click the Enabled switch to enable or disable the inspection group.5. If you want to delete the inspection group, click Delete on the Inspection Group Details page.6. Click Save to save any changes.7. If you want to delete multiple inspection groups, you can delete them from the Inspection Group page:

a. Click Edit.b. Select the check boxes for the inspection group rows to delete.c. Click Delete.

8. In the inspection types grid, you can:a. Click the Required switch to enable or disable an inspection type.b. Click the Final Inspection switch to set an inspection type as the final inspection. One and only one row

must be set as the final inspection.c. Click Add to add a new inspection type row.d. Click the Delete icon at the end of the row to remove an inspection type from the group.

Note: You cannot change the inspection type ID or description, but you can remove an inspection typeand add another.

9. Click Save to save any changes.10. If you want to remove an inspection type from the group, click Delete.11. If you want to remove multiple inspection types from the group, you can delete the rows from the Inspection Group

Details page:a. Click Edit.b. Select the check boxes for the inspection type rows to delete.c. Click Delete.d. Click Save.

Setting Up Inspection Calendars Inspection calendars establish the days of the week and daily hours that are available for scheduling specific types ofinspections.

Administrators add, modify, and delete inspection calendars on the Inspection Calendar page.

Adding an Inspection Calendar1. Select Inspection Setup > Inspection Calendar .2. On the Inspection Calendar page, click Add.3. On the Inspection Calendar Details page, enter values for the following fields:

170



Calendar ID

Enter a unique ID for the calendar.

Inspection Type

Select the type of inspection to which this calendar applies. For more information on inspections types, see Setting Up Inspection Types.

Inspection District

Select the district to which this calendar applies.

Note:A small municipality may have only one defined district ID that includes its entireinspection area. A large municipality may have multiple defined district ID. Thisenables you to create inspection calendars for different areas to optimize yourdistribution of resources.

For more information on districts, see Setting Up Districts.

Description

Enter a description for the calendar. For example, you might enter Final fence inspectioncalendar.

Start Date

Enter the first day of the calendar.

End Date

Enter the last date of the calendar. You can leave this field blank to give the calendar anopen end date.

Start Time and End Time

Enter the start and end time for the calendar. For example, you might enter a start time of09:00 and an end time of 16:00.

Recurrence

Select whether the calendar reoccurs weekly. If you select Weekly recurrence, enter thenumber of weeks between occurrence in the Weeks Between Occurrences field.

Weeks Between Occurrences

Enter how many weeks are between each occurrence. For example, if you select arecurrence of Weekly with 1 week between occurrences, the calendar repeats every week.

Note:When the recurrence frequency for an inspection calendar is greater than 1, thefirst week of scheduling is the week that contains the start date, where Sunday isconsidered the first day of the week. Therefore, it is recommended that you set thestart date to the Sunday of the first week in which you want to schedule inspections. For example, you create an inspection calendar for Mondays and Fridays wherethe recurrence frequency is 2, alternating weeks. Setting the calendar start dateto January 1, 2019 causes January 4, 2018 to be available for scheduling but notDecember 31, because it is before the start date. Also, January 7 and 11 are inthe alternate week, so the next days available for scheduling are January 14 and18. If you set the start date to January 5, which is still part of the first week that thecalendar is active, the system considers this same week as the start week, but nodays are available until January 14 and 18.

Inspection Days Select the days of the week that are available for inspection scheduling.

171



4. Click Save.

Note: For overnight inspection calendars that go past 12 a.m. (midnight), you must create two calendars:one for the time period up until midnight, and one for the time period after midnight. For example, to create aweekday overnight calendar that starts at 09:00 p.m. and ends at 05:00 a.m. the following day, the first calendarwould have a start time of 09:00 p.m. and an end time of 12:00 a.m. on Monday, Wednesday, and Friday. Thesecond calendar would have a start time of 12:00 a.m. and an end time of 05:00 a.m. on Tuesday, Thursday,and Saturday.

Modifying an Inspection Calendar1. Select Inspection Setup > Inspection Calendar .2. Click a row on the Inspection Calendar page.3. On the Inspection Calendar Details page you can:

◦ Update the inspection calendar field values.

Note: You cannot edit the Calendar ID.

◦ Delete the calendar. You will be prompted to confirm the permanent deletion.

4. Click Save.

Deleting Inspection Calendars1. Select Inspection Setup > Inspection Calendar .2. Click Edit.3. Select the check boxes next to all the inspection calendars you want to delete.4. Click Delete. You will be prompted to confirm the permanent deletion.

Setting Up Inspection Scheduling When agency users and registered public users schedule an inspection, the system is actually determining which inspectorsare available and qualified to perform the inspection. Therefore, to schedule inspections, it is necessary to define all of theappropriate employee data for inspectors.

Inspectors are considered qualified if they have been assigned the inspection type and district associated with the inspection.The availability of inspectors is based on their work schedules and whether they have been assigned to other inspectionspreviously.

In addition, the time slots that are available for scheduling are impacted by inspection calendars and holiday calendars, whichdefine when inspections can and can’t be performed, respectively.

The system determines which inspectors can be scheduled to perform an inspection based on two sets of criteria.

1. Qualifications: To be qualified to perform an inspection, agency staff must be defined as inspectors, and assigned toinspection types, districts and work schedules.

172


2. Availability: Agency holidays and inspection calendars, inspector work schedules, and existing inspector assignmentsdetermine the availability of inspectors.

The following table lists the different types of data that need to be defined so that the system can determine inspectorqualifications and availability. The Frequency column lists how many instances of the data type can be defined. The Requiredcolumn lists whether a data type is required for time slots to appear on the Scheduling modal page during inspectionscheduling.

Criteria Type Data Type Frequency Required Impact of Missing Data

Qualification

Inspection Type

One per inspection

Yes

Only defined inspectiontypes are available toselect when requestinginspections.

Qualification

District

One per inspection Note that the addressselected for theinspection needs to beassociated to a parcelfor which there is anassigned inspectiondistrict.

Yes

No scheduling timesare available on theScheduling modal page. Note that the inspectiontype and a parcelassociated with thepermit must have thesame district type. If theydon’t, the Select a Timebutton is unavailable forthe inspection request.

Qualification

Inspectors

One per employee whoperforms inspections

Yes

No scheduling timesare available on theScheduling modal page.

Qualification

Assigned Inspection Type

One or more perinspector

Yes


Qualification

Assigned InspectionDistrict


Yes

No scheduling timesare available on theScheduling modal page. Note that the assignedinspection district and theparcel associated withthe permit must have thesame district type. If theydon’t, the Select a Timebutton is unavailable forthe inspection request.

Availability

Work Schedule

One or more for eachperiod of the dayinspectors work; mayinclude one break

Yes


Availability

Assigned Work Schedule


Yes


173


Criteria Type Data Type Frequency Required Impact of Missing Data

Availability

Inspection Calendar

One or more for eachcombination of inspectiontype and district

No

The inspection can bescheduled at any timeof day (or wheneverinspectors are available).

Availability

Assigned Inspection

Automatically createdwhen an inspection isassigned

No

No time slots areunavailable for schedulingdue to previouslyassigned inspections.

Availability

Holiday Calendar

On per agency

No

No days are unavailablefor scheduling due toholidays or other agencynon-working days.

Inspection TypesYou define inspection types using the Inspection Type page. The system uses the estimated duration to determine whetheran inspector is available for the entire time required to complete an inspection. The inspection district type is a pre-defineddistrict type with the category of Inspection.

For more information on inspection types, see Setting Up Inspection Types.

Inspection DistrictsYou must create an inspection district and assign it to inspectors to enable qualified inspectors and make time slots availablewhen scheduling inspections. The district for the inspection is based on the district type assigned to the inspection type.The system uses this district type to determine the district ID associated with the parcel for which an inspection is beingscheduled. A parcel may have more than one district type associated with it, but only one of them has a district type categoryof Inspection.

The system determines the parcel for the inspection based on the inspection address. The address for a new inspectiondefaults to the primary address of the primary parcel associated with the permit for which you are scheduling an inspection.You may select other addresses that are associated with the permit. If no address is associated with an inspection, thesystem can’t determine the district for the inspection so the Select a Time and Select a Different Time buttons are disabled.

For more information on district types, districts, parcels, and addresses see:

• Setting Up District Types

• Setting Up Districts

• Associating Parcels with Districts

• Setting Up Parcel Addresses

Work SchedulesYou must create work schedules and assign them to inspectors to make the inspectors available for inspection scheduling.

Note: If the recurrence for a work schedule is Weekly, and the weeks between occurrences is greater than 1,the system uses the week of the valid from date as the starting point for scheduling.

174


For more information on work schedules, see Setting Up Work Schedules.

InspectorsTo make inspectors available for inspection scheduling, you must perform the following steps on the Agency Staff page:

• Assign the ORA_BUILDING_INSPECTOR job function to the inspector.

• Assign inspection types to the inspector by adding job attributes to the ORA_BUILDING_INSPECTOR job function.

• Assign inspection districts to the inspector by adding job attributes to the ORA_BUILDING_INSPECTOR job function.

• Assign work schedules to the inspector by adding job attributes to the ORA_BUILDING_INSPECTOR job function.

For more information on assigning job functions and job attributes to agency staff, see Setting Up Agency Staff.

Inspection CalendarsSetting up inspection calendars is optional for scheduling inspections. Without inspection calendars, however, the system canpotentially allow inspections to be scheduled for any time during a 24 hour period, if there are work schedules that compriseall 24 hours.

You define inspection calendars for a specific combination of inspection type and district. You can define more than onecalendar for the same inspection type and district.

For more information on inspection calendars, see Setting Up Inspection Calendars.

Holiday CalendarSetting up holiday calendars is optional for scheduling inspections. Holiday calendars establish the days that agency officesare closed and no field service operations are offered. The dates established as events on the holiday calendar are notavailable for inspection scheduling regardless of how the inspection calendars or work schedules are defined.

For more information on holiday calendars, see Setting Up Holiday Calendars.

175


176

Implementing Oracle Public Sector Permits Chapter 8Setting Up Billing

8 Setting Up Billing

Setting Up Invoice Forms You add, modify, and delete invoice forms on the Invoice Form page.

Adding an Invoice Form1. Select Billing Setup > Invoice Form .2. On the Invoice Form page, click Add.3. On the Invoice Form Details page, enter a name and description for the invoice form.4. Click Save.

Modifying an Invoice Form1. Select Billing Setup > Invoice Form .2. Click a row on the Invoice Form page.3. On the Invoice Form Details page you can:

◦ Update the invoice form description.

◦ Delete the invoice form. You will be prompted to confirm the permanent deletion.

4. Click Save.

Deleting Invoice Forms1. Select Billing Setup > Invoice Form .2. Click Edit.3. Select the check boxes next to all the invoice forms you want to delete.4. Click Delete. You will be prompted to confirm the permanent deletion.

Setting Up Bill Types You add, modify, and delete bill types on the Bill Type page.

Adding a Bill Type1. Select Billing Setup > Bill Type .2. On the Bill Type page, click Add.3. On the Add Bill Type page, enter information for the following fields:


Bill Type Enter a name for the bill type.

177

Implementing Oracle Public Sector Permits Chapter 8Setting Up Billing


Description

Enter a short description for the bill type.

Invoice Form

Select the invoice form you want to use for this bill type. See Setting Up Invoice Forms.

Invoice Series

Select an invoice autonumbering rule for the bill type. For more information on autonumbering, see Setting Up Autonumbering.

4. Click Save.

Modifying a Bill Type1. Select Billing Setup > Bill Type .2. Click a row on the Bill Type page.3. On the Bill Type Details page you can:

◦ Update the bill type field values.

Note: You cannot edit the Bill Type field.

◦ Delete the bill type. You will be prompted to confirm the permanent deletion.

4. Click Save.

Deleting Bill Types1. Select Billing Setup > Bill Type .2. Click Edit.3. Select the check boxes next to all the bill types you want to delete.4. Click Delete. You will be prompted to confirm the permanent deletion.

178

Implementing Oracle Public Sector Permits Chapter 9Setting Up Payments

9 Setting Up Payments

Managing Security and Payment Endpoints This topic discusses how to manage security and payment endpoints.

Security and payment endpoints allow you to set up your system for the transactions you handle through an Oracle deliveredpayment gateway.

You configure the security and payment gateways using the following dynamically generated pages:

• Manage Security Endpoint

• Manage Payment Endpoint

Configuring the Manage Security Endpoint1. Select Public Sector Permits > Fees and Payment > Manage Security Endpoint .2. On the Manage Security Endpoint page, enter information for the following fields:

Menu Item Description

URL

Enter the URL to access the payment gateway’s token endpoint. This should include thehost and the context root information. Use the sandbox endpoint for testing and then usethe live URL when you go live.

Security Policy

Select the applicable token from the drop-down list.

Username

Enter the API client_id value for your payment endpoint account.

Password

Enter the payment endpoint API secret code for your payment endpoint account.

3. Click Save and Close to save the configuration and return to the Setup page.

Configuring the Manage Payment Endpoint1. Select Public Sector Permits > Fees and Payment > Manage Payment Endpoint .2. On the Manage Payment Endpoint page, enter information for the following fields:


URL

Enter the URL to access the payment endpoint payment page. This should include the hostand the context root information.

Security Policy

Select the applicable token from the drop-down list.

Username

Enter the merchant or seller user name you have set up with your delivered paymentendpoint.

179



Password

Enter the merchant or seller password you have set up with your delivered paymentendpoint.

3. Click Save and Close to save the configuration and return to the Setup page.

The newly created configuration names will now be listed in the Gateway Details page, under Configuration Properties.

See Managing Payment Gateways.

Managing Payment Gateways Payment gateways facilitate payment transactions by authorizing the payment between you and your customer.

You can view, enable, and disable pre-configured payment gateways on the Gateway page.

Viewing Gateways1. Select Payment Setup > Payment Gateway .2. Click a row on the Gateway page to review the details for a payment gateway.

On the Summary tab, you can enable and disable the payment gateway using the Enabled switch.

Note: Disabling a payment gateway also disables any payment adapters associated with it. See SettingUp Payment Adapters.

Setting Up Payment Adapters Payment adapters enable you to define attributes for your payment gateway that are used during payment processing. Youshould define a separate payment adapter for each merchant ID associated with a payment gateway. You add, modify, anddelete payment adapters on the Payment Adapter page.

Adding a Payment Adapter1. Select Payment Setup > Payment Adapter .2. On the Payment Adapter page, click Add.3. On the Adapter Summary tab, enter information for the following fields:


Adapter Name

Enter a name for the payment adapter.

Gateway Name Select the delivered payment gateway that you want to use for this payment adapter.

180



Adapter Mode

Select whether the payment adapter is in Live or Test mode.

4. Turn the Enabled switch on to make the row available as a lookup value on other pages.5. Access the Adapter Configuration tab and click Add to add a configuration for the payment adapter.6. Enter an ID, name, and value for the configuration.7. Access the Adapter Method tab and click Add to add a payment method for the payment adapter.8. Enter information for the following fields:


Payment Method

Enter a name for the payment method.

Service Charge Percent

Enter the percentage of the payment that is added as a service charge for this paymentmethod.

Service Charge Amount

Enter a flat service charge amount for the payment method.

Service Charge Currency

Enter the currency of the service charge.

Service Charge Description

Enter a description of the service charge.

Special Instructions

Enter any special instructions associated with the payment method.

Redirect

9. Click Save.

Modifying a Payment Adapter1. Select Payment Setup > Payment Adapter .2. Click a row on the Payment Adapter page.3. You can:

◦ Update the field values on the Adapter Summary.

Note: You cannot edit the Adapter Name field.

◦ Enable or disable the payment adapter using the Enabled switch. Only enabled payment adapters areavailable on other pages.

◦ Access the Adapter Configuration tab and click a row to update the configuration value, or delete aconfiguration.

◦ Access the Adapter Method tab and click a row to update the payment method field values, or delete apayment method.

◦ Delete the payment adapter. You will be prompted to confirm the permanent deletion.

4. Click Save.

181


Deleting Payment Adapters1. Select Payment Setup > Payment Adapter .2. Click Edit.3. Select the check boxes next to all the payment adapters you want to delete.4. Click Delete. You will be prompted to confirm the permanent deletion.

Setting Up Agency Payment Options You add, modify, and delete agency payment options on the Agency Payment Options page.

Adding Agency Payment Options1. Select Payment Setup > Agency Payment Options .2. On the Agency Payment Options page, click Add.3. Enter information for the following fields:


Agency ID

Select the ID of the agency for which you are adding a payment option.

Payment Method

Select the payment method for this payment option.

Payment Adapter ID

Select the payment adapter you want to use for this payment option. See Setting Up Payment Adapters.

Cashier Session Number Ruleand Cash Receipts Number Rule

Select the autonumbering rules that you want to use to generate numbers for cashiersessions and cash receipts. For more information on autonumbering, see Setting Up Autonumbering.

Payment Reference Prefix

4. Click Save.

Modifying Agency Payment Options1. Select Payment Setup > Agency Payment Options .2. Click a row on the Agency Payment Options page.3. You can:

◦ Update the payment option field values.

Note: You cannot edit the Agency ID and Payment Method fields.

182


◦ Delete the payment option. You will be prompted to confirm the permanent deletion.

4. Click Save.

Deleting Agency Payment Options1. Select Payment Setup > Agency Payment Options .2. Click Edit.3. Select the check boxes next to all the agency payment options you want to delete.4. Click Delete. You will be prompted to confirm the permanent deletion.

Setting Up Department Payment Options You add, modify, and delete department payment options on the Department Payment Options page.

Adding Department Payment Options1. Select Payment Setup > Department Payment Options .2. On the Department Payment Options page, click Add.3. Enter information for the following fields:


Agency ID

Select the ID of the agency for which you are adding a department payment option.

Department

Select the department for which you are adding a payment option. For more information on departments, see Setting Up Departments.

Payment Method

Select the payment method for this payment option.

Payment Adapter ID

Select the payment adapter you want to use for this payment option. See Setting Up Payment Adapters.

Cashier Session Number Ruleand Cash Receipts Number Rule

Select the autonumbering rules that you want to use to generate numbers for cashiersessions and cash receipts. For more information on autonumbering, see Setting Up Autonumbering.

Payment Reference Prefix

Specify the prefix that is used when generating the payment reference value. This four-character prefix forms part of the 30-character payment reference that is generated for everypayment transaction. The default value is EPAY but you can modify it.

4. Click Save.

Modifying Department Payment Options1. Select Payment Setup > Department Payment Options .

183


2. Click a row on the Department Payment Options page.3. You can:

◦ Update the payment option field values.

◦ Delete the payment option. You will be prompted to confirm the permanent deletion.

4. Click Save.

Deleting Department Payment Options1. Select Payment Setup > Department Payment Options .2. Click Edit.3. Select the check boxes next to all the department payment options you want to delete.4. Click Delete. You will be prompted to confirm the permanent deletion.

Setting Up Cash Drawers Cash drawers enable you to logically separate cash and checks handled by your cashiers. They are not linked to a physicalcash drawer. You add and modify cash drawers using the Cash Drawer page.

Adding a Cash Drawer1. Select Payment Setup > Cash Drawer .2. On the Cash Drawer page, click Add.3. On the Cash Drawer Details page, enter values for the following fields:


Cash Drawer ID and Description

Enter a unique ID and description for the cash drawer.

Currency

Select the currency that the cash drawer accepts.

Tolerance Amount

Define the acceptable amount of overage or shortage during the cash drawer reconciliationprocess. If the amount that the cash drawer is over or under is within the tolerance amount,then the cashier can complete the reconciliation process without intervention from amanager.

Cash Reconciliation

Select how cash is reconciled for the cash drawer. Options are:

◦ One Cashier Session per Cash Drawer: Select to allow only one cashier session perday for this drawer. Once a cashier session associated with it has been closed, thedrawer can be associated with a new session on a new date.

◦ Multiple Cashier Sessions per Cash Drawer: Select to allow multiple cashier sessionsto be open per day for this drawer.

Only one cashier session can be open at a time. If there is an existing session openfor a drawer, you can’t open a new session until the existing session is closed.

4. (Optional) Turn the Enabled switch off to make the row unavailable as a value on other pages.

New rows are enabled, by default.

184


5. Click Save.

Modifying a Cash Drawer1. Select Payment Setup > Cash Drawer .2. Click a row on the Cash Drawer page.3. On the Cash Drawer Details page you can:

◦ Update the cash drawer field values.

Note: You cannot edit any of the fields for a cash drawer that is assigned to an open cashiersession.

◦ Enable or disable the cash drawer. You can use only enabled cash drawers on other pages.

◦ Delete the cash drawer. You will be prompted to confirm the permanent deletion.

Note: The Delete button is unavailable for a cash drawer that is assigned to a cashier session.

4. Click Save.

Note: The Save button is unavailable for a cash drawer that is assigned to an open cashier session.

185


186

Implementing Oracle Public Sector Permits Chapter 10Setting Up Help Management

10 Setting Up Help Management

Setting Up Contextual Help Contextual help provides customized guidance for users at the page, section, and field level. Contextual help content isstored in your database and accessed through icons that appear on the associated pages.

You add, modify, and delete contextual help entries on the Contextual Help page.

Note: Use the Contextual Help page to create contextual help for static pages delivered by Oracle. You can alsocreate contextual help using the Permit Designer. For more information, see Adding Contextual Help to Forms.

Adding a Contextual Help Entry1. Select Help Management > Contextual Help .2. On the Contextual Help page, click Add.3. On the Contextual Help page, enter values for the following fields:


Type Code

Enter a unique identifier for the contextual help entry.

Page Name

Enter the name of the page for which you are adding contextual help.

Page Object

Enter the page element for which you are adding contextual help.

Description

Enter a description of the contextual help entry.

4. Add contextual help details.5. Click Save.

Adding Contextual Help Details1. On the Contextual Help page, click Add.2. On the Add Contextual Help Details page, enter values for the following fields:


Enabled

Click to make this contextual help content available on the associated page.

Help Content

Enter the contextual help content using formatted text, images, and links.

3. Click Save.

187

Implementing Oracle Public Sector Permits Chapter 10Setting Up Help Management

Modifying a Contextual Help Entry1. Select Help Management > Contextual Help .2. Click a row on the Contextual Help page.3. On the Contextual Help page you can:

◦ Update the contextual help description.

◦ Add, modify, or delete contextual help details.

4. Click Save.

Modifying Contextual Help Details1. Click a contextual help details row on the Contextual Help page.2. On the Contextual Help Details page you can:

◦ Disable the help content. Disabled help content no longer appears for the associated page.

◦ Edit the contextual help content.

◦ Delete the help details. You will be prompted to confirm the permanent deletion.

Note: You can modify and delete only agency-defined contextual help details.

3. Click Save.

Deleting Contextual Help Details1. Click Edit for the Contextual Help Details grid on the Contextual Help Details page.2. Select the check boxes next to all the rows of help details you want to delete.3. Click Delete. You will be prompted to confirm the permanent deletion.

Note: You can delete only agency-defined contextual help details.

188

Implementing Oracle Public Sector Permits Chapter 11Setting Up GIS

11 Setting Up GIS

Setting Up Map Profiles Use map profiles to configure specific instances of map functionality in the system. Profiles set the default extent for the mapas well as controlling the availability of certain map options.

Mapping capabilities depend on integration with a map service such as Esri’s Geographic Information Systems (GIS). Beforeyou set up map profiles, publish your map service so that it can be referenced from within the Oracle system.

Required Map ProfilesMaps appear on various pages in the Oracle system. To configure each map, you need to set up its map profile.

The following tables describe the map profiles that you need to set up and identify the related maps for each profile.

CAUTION: Each map is hard-coded to use a map profile with a specific name. So when you set up your mapprofiles, you must use the exact names given below.

This table lists map profiles for the main maps that appear outside the context of a specific permit. There are separate mapprofiles depending on who accesses this map.

Map Profile Related Map

PSC_AGENCY_MAIN_MAP

The main map that appears when an agency staff member clicks the Main Map icon in the pageheader.

PSC_GUEST_MAIN_MAP

The main map that appears when an anonymous user clicks the Explore Your City tile on thelanding page.

PSC_PUBLIC_MAIN_MAP

The main map that appears when a public user who is signed in clicks the Explore Your City tileon the landing page. Registered users and anonymous users see different maps because the map for registered usershas an additional Show Only My Permits check box for limiting searches to just the user’s ownpermits. This check box is not configured on the map profile, but the existence of two separatemaps means that you must set up two separate map profiles.

This table lists additional maps that support permits and inspections.


PSC_APO

The property picker map. This map appears in a modal window that is accessed from a permitapplication or from the permit details Property Information page.

PSC_DEFAULT_EXTENT

The map that appears at the top of the permit detail pages, the parcel details pages, the addressdetail pages, and the owner detail pages.

189



PSC_MOBILE_INSPECTION

The map that inspectors see when using mobile inspection functionality.

PSC_PERMIT_LIST

The map that appears on the permit list pages when they are in map view. Agency staff viewspermits lists on the Permits page, and registered public users see permit lists on the My Permitspage. Both pages have List View and Map View buttons for toggling between views.

Adding a Map Profile1. Select GIS Setup > Map Profile.2. Click Add.3. Enter the profile name in the Map Profile field.

CAUTION: You must use the exact names that are listed above. Each page that displays a map is hard-coded to look for a specific map profile name.

4. Enter the URL for your map service in the Map Service URL field.

When you enter the URL, the system asks if you want to use the default map extent from your map service. Typicallyyou will answer Yes.

The URL itself is not required in the map profile, and saving it to the profile can impact performance. However, forprofiles other than PSC_DEFAULT_EXTENT, saving the map URL and turning on the Enable Layers switch enablesthe Identify GIS Information icon on the map toolbar. Users who switch on the Identify GIS Information toggle canclick map objects such as parcels to display a pop-up window with object information.

Tip: Entering the Map Service URL to bring in the default map extent and then clearing the field willimprove performance. This is a good option for the PSC_DEFAULT_EXTENT map profile. For other mapprofiles, you need to weigh the performance impact against the value of giving uses the Identify GISInformation option on the maps.

5. Verify or modify the default map extent supplied by the map service URL.

If it’s necessary to use values other than the default values that come from the map service, your GIS analyst, whounderstands the map service data, should provide the new values.

Note: If the PSC_DEFAULT_EXTENT map profile (for maps that appear in the header area of variouspages) is able to show a marker related to the map context, it ignores the default map extent from themap profile. For example, in the permit detail pages, the map displays a marker for the permit location, ifavailable, rather than showing the default extent from the map profile.

These fields define the default map extent:


X-Min of Default Map View

The top-left X-coordinate of the initial map view extent.

X-Max of Default Map View The bottom-right X-coordinate of the initial map view extent.

190



Y-Min of Default Map View

The bottom-left Y-coordinate of the initial map view extent.

Y-Max of Default Map View

The top-right Y-coordinate of the initial map view extent.

Spatial Reference

The geographic coordinate system or map projection used by the mapping service todisplay the map.

6. Configure the map’s user controls.

Note: Most of these settings do not affect the maps that are controlled by the PSC_DEFAULT_EXTENTmap profile. The only setting that is relevant to this profile is the Base Map field.

Maps can include various widgets that let users manipulate the appearance of the map . These fields let you choosewhich options are available to users:


Enable Default Map View

Indicate whether to display the icon for restoring the map to its initial extent. A user who haszoomed or panned the map clicks this icon to restore the default map area. When this option is enabled, the Show Default Map View icon is included on the map toolribbon.

Base Map

Select the default type of base map. The options are:

◦ Dark gray canvas

◦ Light gray canvas

◦ Imagery with labels

◦ National Geographic

◦ Topographic

◦ Open Street Map

◦ Imagery

◦ Streets

◦ Terrain with labels

◦ Oceans

Enable Base Map Gallery

Indicate whether users are allowed to switch to a different base map. When this option is enabled, the Select Base Map icon is included on the map tool ribbon.

Enable Map Layers

Indicate whether the user is allowed to see the list of layers and switch layer visibility on andoff. Examples of layers include environmental, zoning, or infrastructure information providedby the map service. When this option is enabled, the Select Layers icon is included on the map tool ribbon.

191



When this option is enabled and you save a map service URL to the profile, the Identify GISInformation icon is included on the map tool ribbon.

Enable Detail Window Docking

Indicate whether the map detail window is docked to the side of the view. The detail windowis the pop-up window that appears when a user clicks a map marker or other GIS featuresuch as a parcel.

Detail Window Dock Position

Specify the position where the map detail window is initially docked: Auto, Bottom left,Bottom center, Bottom right, Top left, Top center, or Top right.

7. Click Save.

Modifying a Map Profile1. Select GIS Setup > Map Profile .2. On the Map Profiles page, click the row for the profile that you want to modify.3. To change the default map extent, enter a new map service URL and answer Yes when asked whether to use the

associated default extent.

Alternatively, a GIS analyst can manually update the fields related to the default map extent.4. As needed, update the settings related to user controls on the related map.5. Click Save.

Deleting Map ProfilesNormally the only reason to delete a map profile is if you accidentally create one with the wrong map name. The correctly-named profiles are required, so you will normally modify the profiles rather than delete them.

To delete a single map profile:

1. Select GIS Setup > Map Profile.2. On the Map Profiles page, click the row for the profile that you want to delete.3. On the Map Profile Details page, click Delete.

To delete multiple map profiles

1. Select GIS Setup > Map Profile.2. Click the Edit icon.3. Select the check boxes for the map profiles to delete.4. Click the Delete icon.

Setting Up GIS Attribute Mapping Use Global Information Systems (GIS) attribute mapping to specify information about your map service parcel layer.

192


PrerequisitesBefore you enter the information about your map service parcel layer, you must:

• Publish the map service.

• Ensure that the map service has a parcel layer.

• Ensure that the parcel layer has a field with parcel IDs that match the parcel IDs in the Oracle system.

Parcel IDs must match exactly, with no formatting differences.

Setting Up the Parcel Layer Service URLTo set up the parcel layer service URL:

1. Select GIS Setup > Attribute Mapping.2. Enter the following information on the GIS Attribute Mapping page:


Parcel Layer Service URL

Enter the URL for your parcel layer feature service. The URLs for the different layers of an Esri map service have numeric identifiers. The URLthat you enter here ends with the number for the parcel layer as in the example https://servername/arcgis/rest/services/Your_City/MapServer/4 You must publish your parcel layer feature service before you enter the URL here.

Parcel Number

Select the parcel layer GIS attribute that provides the unique identifier for each parcel. The values in the drop-down list come from the parcel layer that you specify. Select the GISattribute that provides the same identifiers that are used in the parcel table in the Oraclesystem. For information about setting up the parcel table, see Setting Up Parcels. On maps used as property pickers, clicking a parcel on a map retrieves the parcel identifierfrom the map service. This value is used as criteria for searching the Parcel table, and thesearch results appear in a modal window. As long as the same parcel number exists in theParcel table, the search results include just one value, representing the selected parcel.

3. Click Save.

193


194

Implementing Oracle Public Sector Permits Chapter 12Setting Up Accounting

12 Setting Up Accounting

Managing Accounting Events Each delivered accounting event represents a specific type of agency transaction for which accounting entries are required.An accounting event specifies the source transaction table and the conditional fields that the Generate Accounting processuses to determine which accounting rule to apply.

You can view, enable, and disable accounting events on the Accounting Event page.

View Accounting Events1. Select Accounting Setup > Accounting Event .2. Click a row on the Accounting Event page to review the details for an accounting event.

You can enable and disable the accounting event using the Enabled switch.

Setting Up Accounting Rules Accounting rules define how accounting journal entries are created for a specific type of agency transaction.

An accounting rule contains the debit and credit distributions lines that are generated including the accounting segmentvalues that are used and the percentage of the accounting transaction amount that is distributed to each line. Only one rulemay be applied to a given accounting transaction unless you specify an accounting rule group.

You add, modify, and delete accounting rules on the Accounting Rule page.

Adding Accounting Rules1. Select Accounting Setup > Accounting Rule .2. On the Accounting Rule page, click Add.3. On the Accounting Rule page, enter values for the following fields:


Accounting Event

Enter the accounting event to associate with this accounting rule. The event identifies the agency transaction to which the rule applies. It also determines thefields that are available when you define the criteria that are used to select the accountingtransactions that the rule processes.

Accounting Rule

Enter a unique ID for the accounting rule.

Accounting Rule Group

Optionally, enter the group that the accounting rule belongs to. When this rule is applied toan accounting transaction, any other rules referencing this group will also be applied.

195



When multiple accounting rules are assigned to the same group, transactions meeting theselection criteria are processed by each rule in the group.

Description

Enter a description of the accounting rule.

Start Date and End Date

Enter the date range during which the accounting rule can be used.

All Dates

Click to access the History Data page where you can update existing effective dated rows,and add new ones.

Validate

Click to validate the entered data and ensure that the rule is valid for processing.

4. Add distribution lines and criteria.

Note: You must have values defined for all required accounting rule fields before you can add distributionlines and criteria.

5. Click Save.

Adding Distribution Lines1. On the Accounting Rule Details page, click Add on the Distribution Lines tab.2. On the Distribution Lines page, enter values for the following fields:


Line Number

Enter a number for the distribution line to determine the order in which it is processed.

Debit or Credit

Specify whether this line is a debit or a credit.

Note:You must define at least one debit line and one credit line for each fund.

Account, Division, Department,Fund, Function, and Program

Enter values for the six segments (fields) that are appropriate for the line. These segmentsclassify a transaction for financial and operational reporting purposes.

Note:Account and Fund are required.

Percent

Specify the percentage of the accounting transaction amount that is distributed to this line.The total debit and credit percentages must equal 100 percent for the rule. In addition, thetotal debit percentages must equal the total credit percentages for each fund.

Rounding Adjustment

Use this switch to identify one debit line as a rounding adjustment line. The applicationuses this line to balance the distributed debit total to the accounting transaction amount, ifnecessary.

196



In addition, use this switch to identify one credit line as a rounding adjustment line for eachfund. The application uses this line to balance each fund's credit total to its debit total, ifnecessary.

Note:You can enable this switch for only one debit line and one credit line for anaccounting rule.

3. Click Save.

Adding CriteriaYou define field criteria to determine the accounting transactions to which this rule applies. The fields that are available toselect as criteria are determined by the accounting event that is associated with the rule.

1. On the Accounting Rule Details page, access the Criteria tab and click Add.2. On the Criteria page, enter values for the following fields to create a criterion:


Field Name

Select the field on which you are basing this criterion.

Logical Operator

Specify whether the field must be equal or not equal to a specific value.

Field Value

Enter the field value on which the criterion is based.

For example, if you create a criterion with the TRANSACTION_TYPE field being equal to BUILDING, this accountingrule will apply only to building transactions.

3. Click Save.

Modifying Accounting Rules1. Select Accounting Setup > Accounting Rule .2. Click a row on the Accounting Rule page.3. On the Accounting Rule Details page you can:

◦ Update the accounting rule field values.

Note: You cannot update the Accounting Event or End Date fields.

◦ Delete the accounting rule. You will be prompted to confirm the permanent deletion.

◦ Add, modify, or delete distribution lines and criteria.

4. Click Save.

197


Modifying Distribution Lines1. Select Accounting Setup > Accounting Rule .2. Click a row on the Accounting Rule page.3. Click a row in the Distribution Lines tab on the Accounting Rule page.4. On the Distribution Lines page you can:

◦ Update the distribution line field values.

Note: You cannot update the Line Number field.

◦ Delete the distribution line. You will be prompted to confirm the permanent deletion.

5. Click Save.

Modifying Criteria1. Select Accounting Setup > Accounting Rule .2. Click a row on the Accounting Rule page.3. Click a row in the Criteria tab on the Accounting Rule page.4. On the Criteria page you can:

◦ Update the logical operator and field value.

◦ Delete the criterion. You will be prompted to confirm the permanent deletion.

5. Click Save.

Deleting Distribution Lines1. Select Accounting Setup > Accounting Rule .2. Click a row on the Accounting Rule page.3. Click Edit for the Distribution Lines tab on the Accounting Rule page.4. Select the check boxes next to all of the distribution lines that you want to delete.5. Click Delete. You will be prompted to confirm the permanent deletion.

Deleting Criteria1. Select Accounting Setup > Accounting Rule .2. Click a row on the Accounting Rule page.3. Click Edit for the Criteria tab on the Accounting Rule page.4. Select the check boxes next to all of the criteria that you want to delete.5. Click Delete. You will be prompted to confirm the permanent deletion.

Setting Up Accounts An account identifies the type of economic activity represented by an accounting transaction. Examples of accounts arePermit Revenue or Advertising Expense.

198


Account is one of the six segments (fields) that may be specified for each accounting rule distribution line to classify thetransaction for financial and operational reporting purposes.

Note: You must specify an account value on every distribution line.

You add, modify, and delete accounts on the Account page.

Adding an Account1. Select Accounting Setup > Account .2. On the Account page, click Add.3. On the Account Details page, enter values for the following fields:


Account

Enter a unique identifier for the account.

Description

Enter a description of the account.

Account Type

Select a type for the account. Valid values are:

◦ Assets

◦ Liability

◦ Equity

◦ Expenses

◦ Revenue


Enter the date range for which the account is valid.

4. Click Save.

Modifying an Account1. Select Accounting Setup > Account .2. Click a row on the Account page.3. On the Account Details page you can:

◦ Update the account field values.

Note: You cannot edit the Account field.

◦ Delete the account. You will be prompted to confirm the permanent deletion.

4. Click Save.

Deleting Accounts1. Select Accounting Setup > Account .

199


2. Click Edit.3. Select the check boxes next to the accounts you want to delete.4. Click Delete. You will be prompted to confirm the permanent deletion.

Setting Up Departments A department identifies the financial entity or management unit that is responsible for an accounting transaction. Examples ofdepartments are Building Department or Police.

Department is one of the six segments (fields) that may be specified for each accounting rule distribution line to classify thetransaction for financial and operational reporting purposes.

You add, modify, and delete departments on the Department page.

Adding a Department1. Select Accounting Setup > Department .2. On the Department page, click Add.3. On the Department Details page, enter values for the following fields:


Department

Enter a unique identifier for the department.

Description

Enter a description of the department.


Enter the date range for which the department is valid.

4. Click Save.

Modifying a Department1. Select Accounting Setup > Department .2. Click a row on the Department page.3. On the Department Details page you can:

◦ Update the department field values.

Note: You cannot edit the Department field.

◦ Delete the department. You will be prompted to confirm the permanent deletion.

4. Click Save.

Deleting Departments1. Select Accounting Setup > Department .2. Click Edit.

200


3. Select the check boxes next to the departments you want to delete.4. Click Delete. You will be prompted to confirm the permanent deletion.

Setting Up Divisions A division represents a sub-grouping within a department for an accounting transaction.

Division is one of the six segments (fields) that may be specified for each accounting rule distribution line to classify thetransaction for financial and operational reporting purposes.

You add, modify, and delete divisions on the Division page.

Adding a Division1. Select Accounting Setup > Division .2. On the Division page, click Add.3. On the Division Details page, enter values for the following fields:


Division

Enter a unique identifier for the division.

Description

Enter a description of the division.


Enter the date range for which the division is valid.

4. Click Save.

Modifying a Division1. Select Accounting Setup > Division .2. Click a row on the Division page.3. On the Division Details page you can:

◦ Update the division field values.

Note: You cannot edit the Division field.

◦ Delete the division. You will be prompted to confirm the permanent deletion.

4. Click Save.

Deleting Divisions1. Select Accounting Setup > Division .2. Click Edit.3. Select the check boxes next to the divisions you want to delete.

201


4. Click Delete. You will be prompted to confirm the permanent deletion.

Setting Up Programs A program identifies a set of activities performed by an agency to accomplish a specific goal associated with an accountingtransaction line. Examples of programs are Downtown Revitalization or Pet Licensing.

Program is one of the six segments (fields) that may be specified for each accounting rule distribution line to classify thetransaction for financial and operational reporting purposes.

You add, modify, and delete programs on the Program page.

Adding a Program1. Select Accounting Setup > Program .2. On the Program page, click Add.3. On the Program Details page, enter values for the following fields:


Program

Enter a unique identifier for the program.

Description

Enter a description of the program.


Enter the date range for which the program is valid.

4. Click Save.

Modifying a Program1. Select Accounting Setup > Program .2. Click a row on the Program page.3. On the Program Details page you can:

◦ Update the program field values.

Note: You cannot edit the Program field.

◦ Delete the program. You will be prompted to confirm the permanent deletion.

4. Click Save.

Deleting Programs1. Select Accounting Setup > Program .2. Click Edit.3. Select the check boxes next to the programs you want to delete.4. Click Delete. You will be prompted to confirm the permanent deletion.

202


Setting Up Funds A fund identifies the source of the amount specified on an accounting transaction line. Examples of funds are General Fund ora Library Fund.

Fund is one of the six segments (fields) that may be specified for each accounting rule distribution line to classify thetransaction for financial and operational reporting purposes.

Note: You must specify a fund value on every distribution line.

You add, modify, and delete funds on the Fund page.

Adding a Fund1. Select Accounting Setup > Fund .2. On the Fund page, click Add.3. On the Fund Details page, enter values for the following fields:


Fund

Enter a unique identifier for the fund.

Description

Enter a description of the fund.


Enter the date range for which the fund is valid.

4. Click Save.

Modifying a Fund1. Select Accounting Setup > Fund .2. Click a row on the Fund page.3. On the Fund Details page you can:

◦ Update the fund field values.

Note: You cannot edit the Fund field.

◦ Delete the fund. You will be prompted to confirm the permanent deletion.

4. Click Save.

Deleting Funds1. Select Accounting Setup > Fund .2. Click Edit.3. Select the check boxes next to the funds you want to delete.

203


4. Click Delete. You will be prompted to confirm the permanent deletion.

Setting Up Functions A function identifies a public service for which an agency is responsible and is associated with an accounting transaction line.Examples of functions are Public Safety or Utilities.

Function is one of the six segments (fields) that may be specified for each accounting rule distribution line to classify thetransaction for financial and operational reporting purposes.

You add, modify, and delete functions on the Function page.

Adding a Function1. Select Accounting Setup > Function .2. On the Function page, click Add.3. On the Function Details page, enter values for the following fields:


Function

Enter a unique identifier for the function.

Description

Enter a description of the function.


Enter the date range for which the function is valid.

4. Click Save.

Modifying a Function1. Select Accounting Setup > Function .2. Click a row on the Function page.3. On the Function Details page you can:

◦ Update the function field values.

Note: You cannot edit the Function field.

◦ Delete the function. You will be prompted to confirm the permanent deletion.

4. Click Save.

Deleting Functions1. Select Accounting Setup > Function .2. Click Edit.3. Select the check boxes next to the functions you want to delete.4. Click Delete. You will be prompted to confirm the permanent deletion.

204


Setting Up Ledgers A ledger stores financial balances for an agency. Each accounting journal is associated with a single ledger.

You add, modify, and delete ledgers on the Ledger page.

Adding a Ledger1. Select Accounting Setup > Ledger .2. On the Ledger page, click Add.3. On the Ledger Details page, enter values for the following fields:


Ledger

Enter a unique identifier for the ledger.

Description

Enter a description of the ledger.

4. (Optional) Turn the Enabled switch off to make the row unavailable as a value on other pages.New rows are active, by default.

5. Click Save.

Modifying a Ledger1. Select Accounting Setup > Ledger .2. Click a row on the Ledger page.3. On the Ledger Details page you can:

◦ Update the ledger description.

◦ Enable for disable the ledger.

◦ Delete the ledger. You will be prompted to confirm the permanent deletion.

4. Click Save.

Deleting Ledgers1. Select Accounting Setup > Ledger .2. Click Edit.3. Select the check boxes next to the ledgers you want to delete.4. Click Delete. You will be prompted to confirm the permanent deletion.

Setting Up Monthly Accounting Calendars Monthly accounting calendars are required for journal generation.

205


Each accounting transaction contains an accounting date that determines the monthly accounting period to which theapplication posts the transaction. To generate a journal for an accounting transaction, you must first open the associatedmonthly accounting period.

You create and open accounting periods on the Monthly Accounting Calendar page.

Creating Accounting Periods1. Select Accounting Setup > Monthly Calendar .2. On the Monthly Accounting Calendar page, click Create Periods.3. On the Create Periods modal page, enter the calendar year for which you want to create accounting periods.4. Click Create Periods to create an accounting period for each month of the calendar year you entered. The grid on

the Monthly Accounting Calendar page displays all of the created accounting periods.

Note: All newly created accounting periods are closed until you open them.

Opening Accounting Periods1. Select Accounting Setup > Monthly Calendar .2. On the Monthly Accounting Calendar page, click Open Periods.3. In the From Period and To Period fields, enter the range of accounting periods that you want to open.4. Click Open Periods to change the status of the selected range of accounting periods from Closed to Open. The

grid on the Monthly Accounting Calendar page displays the status for accounting periods.

206

Implementing Oracle Public Sector Permits Chapter 13Setting Up Comments

13 Setting Up Comments

Managing Comments This topic provides an overview about Standard Comments and discusses how to manage Comments.

Standard Comments: OverviewStandard comments are pre-defined comments that users can easily and quickly use, instead of manually entering the text.Standard comments are generic and complete, which make them reusable.

Users can use Standard Comments across the Public Sector Permits offering. You can use Standard Comments whileupdating permits, workflow, inspection, and plan reviews.

System Administrators set up application categories and subcategories using the Application Category page, based on thetype of comments you wish to have. Standard Comments are set up using the Standard Comments page.

Managing CommentsYou manage the Comments by setting up how you want the comments to be available for the agency staff members.

1. Select Comments > Manage Comments .2. On the Manage Comments page, you add values to all these fields:


Number of days comment isrecent

Enter a numeric value or use the increment/decrement buttons. The number of days acomment is listed as Recent is based on the value in this field.

Rich Text Editor

Use the switch to enable or disable Rich Text Editor formatting for comments.

Comment Summary Length

Enter a numeric value or use the increment/decrement buttons. This value determines themaximum number of characters that can be displayed in the Comment Summary field.

Note:The system allows a maximum length of two hundred (200) characters in thecomment summary.

3. Click Save to save the changes.

207


Setting Up Standard Comment Categories andSubcategories This topic discusses how to set up Standard Comment Categories and Subcategories.

Setting Up Standard Comment Categories and SubcategoriesYou set up the comments categories and subcategories on the Application Category page.

1. Select Comments Setup > Comment Categories .On the Application Category page, click Add to add a new category.

2. On the Application Category Details page, you add values to all these fields:

Field Name Description

Application Category

Enter a category.

Description

Enter a description for the category. This description displays detailed information about thecategory when searching for categories.

3. Turn on the Enabled switch if you want to enable this category when you save it. The switch is turned off by defaultfor a new category.

4. In the Application Groups section, you can include application groups that you want this category to be available for.Click Add to open the Application Group Details page, select the application group.

5. Turn on the Enabled switch if you want to enable the selected group when you save the page.6. Click Save to save the newly added application group and return to the Application Category Details page.7. To add an application subcategory, select the Application Subcategories section and click Add.8. On the Application Subcategory Details page, you add values to all these fields:

Field Name Description

Application Subcategory

Enter a subcategory

Description

Enter a description for the subcategory. This description displays detailed information aboutthe subcategory when searching for subcategories.

9. Turn on the Enabled switch if you want to enable this subcategory when you save it. The switch is turned off bydefault for a new subcategory.

10. Click Save to save the newly added application subcategory and return to the Application Category Details page.11. Click Save to save the record and return to the Application Category page.

Modifying Standard Comment Categories and SubcategoriesYou modify the comments categories and subcategories on the Application Category Details page.

1. Select Comments Setup > Comment Categories .

208


2. On the Application Category page, click the chevron on a category line to select and modify the category.3. On the Application Category Details page, enter new values in the Application Category and Description fields.4. Verify that the Enabled switch is turned on if you want to enable this category when you save it.5. Use the Application Groups section to select the application group that you want this category to be available for.6. In the Application Subcategories section, you can edit the application subcategories.7. Click Save to save the changes. You can use the Delete button to delete the category.

Viewing, Adding, Modifying, and Deleting StandardComments This topic discusses how to view, add, modify, and delete Standard comments.

Viewing Standard CommentsYou search and view Standard Comments on the Standard Comments page.

1. Select Comments Setup > Standard Comments .2. Use the application category or application subcategory fields to filter comments on the Standard Comments page.

Adding Standard CommentsYou add comments using the Addbutton on the Standard Comment page.

1. Select Comments Setup > Standard Comment2. On the Standard Comments page, click Add to open the Standard Comment Details page and add a new

comment.3. On the Standard Comment Details page, enter values for these fields:


Comment Code

Enter a comment code.

Application Category

Enter an application category

Application Subcategory

Enter an application subcategory

Description

Enter a comment.

4. Verify that the Enabled switch is turned on if you want to enable this comment when you save.5. Click the Save button to save the new comment and return to the Standard Comment page.

Modifying Standard CommentsYou modify comments on the Standard Comment Details page.

1. On the Standard Comments page, click the chevron on a comment line to select and modify the comment.

209


2. To modify the comment, you can change the values entered in the Application Category and ApplicationSubcategory fields, and edit the description.

3. Verify that the Enabled switch is turned on if you want to enable this modified comment when you save.4. Click Save.

Deleting Standard CommentsYou delete comments on the Standard Comment Details page.

1. On the Standard Comments page, click the chevron on the comment line which you want to delete.2. On the Standard Comment Details page, click the Delete button to delete the comment.3. Click Yes on the confirmation page to delete the comment and return to the Standard Comments page.

210

Implementing Oracle Public Sector Permits Chapter 14Configuring Navigation

14 Configuring Navigation

Configuring Menu Structure This topic describes the elements of the delivered menu structure, and describes how to change labels for menu folders andmenu links.

You can open delivered menus and make minor changes to menu items to meet your needs. A menu is delivered with apredefined set of menu items.

Public Sector Compliance and Regulation delivers these menus with the Permits service:

• Product setup: a list of all setup pages, the list of links for Mobile, and then all the

• Products: General links considered to be widely used by agency staff members.

• Mobile: Links related to the delivered mobile applications.


Root Folder

The root of the menu structure. It contains all menu folders and menu links within the menu. A menuhas only one root folder.

Menu Folder

Enables you to group menu links. A menu folder can contain one or more menu links. There is onlyone layer of menu folders within a root folder.

Menu Link

Represents the actual link to the underlying application page. An end user clicks the menu link toaccess the associated page.

Note: Currently, you can change menu folder names and menu link labels. You cannot add your own menufolders or menu links.

Working with MenusTo open a menu:

1. Select Navigation > Menu Configurations.2. On the Configure Menu Structure page, select a menu from the Menu drop-down list.3. Click Open Menu.

To close a menu, click Close Menu.

To view changes to the menu structure, click Refresh.

Selecting a Menu ItemWhen working with menu items, you have a graphical representation of the structure on the left-hand side of the page,showing all the menu folders and menu links within the menu structure.

211


Select an item in the menu structure to view the details related to that menu item. Depending on the item selected, you havethese options for configuring the menu.


Refresh

Refreshes the menu view to incorporate any recent changes you have made.

Close Menu

Closes the menu currently open.

Edit

Modify an existing menu folder or menu link.

Configuring Menu Item PropertiesMenus contain menu items, which can be menu folders or menu links. Most of the properties you can view and set for menufolders and menu links are the same. Properties specific to a particular menu item type are noted below.

212



Name

Identifies the name of the menu item, as it is identified within the application. You cannot change thisvalue.

Type

Indicates the type of menu item, which can be: root folder, folder, or link.

Parent Folder

Indicates which root folder a menu folder or menu link exists within.

Note:Applies only for menu folders and menu links, not root folders.

Label Identifies the menu item as it appears in the interface.

213



Description

Enter any descriptive text to help document the purpose of the menu item to other administrators.

Icon

Select an image from the drop-down list to display as an icon for the menu item.

Note:This icon appears on these navigation features: the Navigator menu, the springboard,and the page finder. However, the icon may be a different size and display different colorcombinations depending on the navigation feature being used.

Sequence

In the case of multiple folders or menu links within a folder, set the order a menu item shouldappear in relation to the others. Any menu items sharing the same sequence number are arrangedalphabetically. Otherwise, you can set the sequence: 0, 1, 2, 3, and so on.

Note:The delivered menus use hundreds as sequence values for menus and tens for sequencevalues for menu items. For example, the eighth menu folder in the menu structure has asequence value of 800, and the second menu link within that menu folder has a sequencevalue of 20.

Show On

Select the device sizes for which the application displays the menu item. This option enables you toexpose or hide menu items, as needed, depending on the device size. For example, some pagesmay be more suitable for larger devices, while others may have been developed specifically forsmaller devices.

• All devices: Displays on all devices accessing the system, including desktops, laptops,tablets, and smartphones.

• Tablets and larger: Displays on all devices, except smartphones.

• Smartphones only: Displays only on smartphones.

• None: Hides the menu item from the navigation features for any device.

Note:The application doesn’t determine the actual device type, but uses the viewport size for theShow On option.

Show on Springboard

Turn on to have the icon for the menu link appear on the springboard, which can be accessed byagency staff only.

Note:Applies only to menu links.

For more information on springboards, see Setting Up the Agency Springboard.

Show in Page Finder

Turn on to have the icon for the menu link appear in the page finder navigation feature.

214



Note:Applies only to menu links.

For more information on the page finder, see Using the Page Finder.

Page Content

Enables you to manage content links that appear on a landing page or springboard. Enter acomma-separated list of menu link names. For example: PSC_IWANTTO_ACTIONS, PSCHM_AGENCY_ALERTS,PSC_AGENT_TASK_DTL The menu link names added to the list appear on the landing page or springboard. The Page Content edit box appears only for these menu items:

• Anonymous User Landing page

• Registered User Landing Page

• Agency Springboard

Note:Delivered menu items for landing pages or springboards can refer to a single menu foldercontaining menu links, which will include all of the links within that folder on the landing pageor springboard. This is an option only delivered definitions.

Context Menu

Enables you to manage content links that appear on a drop-down list for various controls in the userinterface, such as the I Want To drop-down list or the Actions list. Enter a comma-separated list ofmenu link names. For example: PSCPBL_SETUP_MANAGEACCOUNT, PSCSECUTIL_WIDGET_SIGNIN,PSCNV_HEADER_ORACLE_HELP, The menu link names added to the list appear in the list for that page control or widget. The Page Content edit box appears only for these menu items:

• Switch Profile

• I Want To

• Actions

Using the Page Finder This topic provides an overview of the navigation feature named page finder, and it describes how to use its features.

The Page Finder is a navigation feature an agency user accesses by clicking the Page Finder button in the header.

215


The Page Finder displays icons:

• For all the pages to which a user has access. Users can click the icon to navigate directly to the page.

• In alphabetical order.

• In a “flattened” format, meaning each page link appears on its own — not within the menu folder/menu itemhierarchy like you see in the Navigator menu. The Page Finder does not display menu folders.

This example illustrates the Page Finder interface with a description surrounding the image.

216


Note: The system does not display the Page Finder on smartphones (small form factor devices).

Note: The screen size and/or browser window size determines the number of icons in each row, displaying amaximum of five icons across with a minimum of four.

Note: The Page Finder is available only for agency users, not for citizen users.

217


Searching within the Page FinderDepending on the number of pages to which a user has access, the Page Finder may contain numerous icons within it. Tofind icons in the Page Finder:

• Use the scroll bar on the right-hand side of the Page Finder (when displayed).

• Type the full or partial name of the page into the Search field at the top of the Page Finder to reduce the number ofpage links displayed.

Closing the Page FinderOnce opened, you can dismiss the Page Finder by:

• Clicking the Close Page Finder button in the upper-right-hand corner.

• Clicking on an icon.

Viewing the Menu Structure in the Navigator This topic describes how the structure in the menu definition is represented in the navigation feature named the Navigator.

The Navigator menu, displays when the user clicks

the Navigation button in the global header.

The Navigator menu displays the menu content in the same hierarchy defined for menu folders and menu items in the menustructure displayed in the Configure Menu Structure page.

The following example illustrates menu folders containing menu items in the Configure Menu Structure page with descriptionsurrounding the image.

218


At runtime, the Navigator displays the menu items within the menu folder as defined on the Configure Menu Structure page.

Configuring Header and Footer Navigation Features This topic describes how to modify your header to include additional features in the header or footer widgets, which canprovide more flexible navigational options for end users.

219


Overview of Header and Footer Navigation FeaturesThe global header and footer run along the top of the page and the bottom of the page, respectively. The header is deliveredwith a set of default navigation widgets, such as the Home button. If needed you can modify delivered widgets.

The header and footer navigation widgets definitions are stored within the navigation framework in the Products menu.Header widgets are stored in the Header Widgets menu folder, and footer widgets are stored in the Footer Widgets folder.

A widget can be a singular button taking the user to a destination, such as the home page or another custom location.Widgets can also be lists of multiple related links that display when clicked. You can add custom attributes to the menu itemdefinition to customize the display of the link.

Link Destination Description

URL

Targets an outside URL, such as http://oracle.com or http://facebook.com. Rendered as a button or a link in a related link list.

Delivered page

Specify the name for the page as it appears in the menu item definition on the Configure MenuStructure page.

In the current release, you cannot create new, custom widgets, but you can modify existing widgets. You can insert links intoan existing widget, and you can modify other attributes, such as the label, on what devices it displays, and so on. You canmodify these attributes on the Configure Menu Structure page.

For more information on the Configure Menu Structure page, see Configuring Menu Structure.

Inserting Links into an Existing Related Links Widget1. Select Navigation > Configure Menu Structure.2. On the Configure Menu Structure page, select Products from the Menu drop-down list.3. Click Open Menu.4. Locate the Header Widgets folder or Footer Widgets folder, depending if you are modifying the header or the footer

navigation widgets.5. Select the menu item you want to modify in either the Header Widgets folder or the Footer Widgets folder.

For example, select the Switch Profile menu item in the Header Widgets folder.6. Click Edit.

220


7. In the Context Menu attribute, add a comma, and enter the name content reference associated with link you want toadd to the current link list.

For example, to add the My Account link, add the content reference name PSC_MY_ACCOUNT.8. Save your changes.9. Confirm the link appears in the related link list.

Back Button Behavior This topic describes how to use and what to expect when using the back button in Public Sector Cloud services.

Public Sector Cloud applications display a Go Back button (back button) in the global header just to the left of the GlobalNavigation button. The following list describes the characteristics and behavior of the Go Back button.

The Go Back button:

• Displays on all form factors, from small (smartphone) to large (desktop computer).

• Can be identified by the chevron image, pointing left, just to the left of the Global Navigation button.

• When displayed on a small form factor (smartphone), the system does not display the Global Navigation button,when the back button is displayed.

• Displays on the header for all application pages, but does not on the springboard or landing page (the first pagedisplayed when accessing the system).

• Stores history for end user page-to-page navigation by means of the provided navigation devices (navigator menu,springboard, search, and so on).

• Does not store history for in-page navigation (except in certain cases where delivered pages have been specificallydesigned to track in-page history). For example, the system does not maintain history of switching between varioustabs on a single page or drilling into a detail pane from a master list in a single page, and so on.

221


Mobile Applications Navigation Considerations This topic discusses topics related to implementing navigation for the Public Sector Cloud mobile application and how youcan plan for future mobile applications as they are released.

Public Sector Cloud provides a mobile application for agency staff to download and install on their mobile devices. The mobileapplication is not intended to be used by citizens. While the Public Sector Cloud mobile application is mainly intended forsmartphones, you can download the app to other mobile devices, such as tablets.

You download the Public Sector Cloud mobile application from the App Store for iOS devices and Google Play for Androiddevices. Mobile devices must download the Public Sector Cloud mobile app and install it on the mobile device in order toaccess the native mobile app menu. Accessing the main Public Sector service using a browser does not display the mobileapp, but only the main Public Sector service rendered on the mobile device's browser, not necessarily optimized for themobile device.

Initially, the Public Sector Cloud mobile application consists of the Mobile Inspections menu items, but as additionalfunctionality becomes available, such as Code Enforcement, more menu items will accessible from the downloaded mobileapp.

Each mobile application has its own entry point into the system, and accesses a unique menu definition, specific to that app.The menu definition and the menu items for a mobile application are defined internally by Public Sector Cloud developmentteams. The menu items displayed in the mobile application may be a subset of the menu items displayed in the main PublicSector service, and some menu items may display only in the mobile app, not in the main Public Sector menu structure.

If you intend to modify menu items displayed on a mobile application menu, you need to make sure you are updating thespecific menu for that mobile application menu, such as MOBILE_INSPECTIONS or MOBILE_CODE_ENFORCEMENT.

As far as security is concerned, administrators must explicitly grant access to the mobile app menu to the necessary mobileuser roles.

The navigation items in that menu can then be further filtered by user permissions. You can also apply specific brandingthemes to the mobile application if you want it to appear differently than the main Public Sector Cloud service.

Configuring the Actions Menu This topic provides an overview and describes how to configure the Actions menu for a small device, such as a smartphone.

The system displays the Actions menu only on the small form factor. The Actions menu appears on the right side of the globalheader displaying three-vertical dots. Selected buttons, such as the shopping cart button, remain displayed on the globalheader for the small form factor device. Other buttons, such as the Home button display on the Actions menu for the smallform factor device, along with the Manage Account and Sign Out button. Moving the buttons to the Action menu saves spaceon the global header.

If you add any custom navigation widgets to the global header, it is recommended to configure the Actions menu to displaythe custom navigation widgets on the small form factor device. You will need to create one header navigation widget for thesmall form factor and one for the larger form factors (tablets and larger).

To configure the Actions menu:

1. Select Navigation, Define Menu Structure, and open the Products menu.

222


2. Create a menu item in the Header Widgets (Hidden) folder for the navigation header widget that the system willdisplay for tablets and larger devices, setting the Display property on the General tab to Medium and Over Only.

3. For the header navigation widget for the small form factor devices (smartphones), create a menu item in the WidgetLinks (Hidden) folder, setting the Display property on the General tab to Small Form Factor Only.

This menu item for the Actions menu should open the full transaction page, not a pop-up page (like the Notificationsbutton does when hovering).

4. Modify the Actions menu item in the Header Widgets (Hidden) folder and add the small form factor menu item nameto the RELATED_LINKS attribute.

223


224

Implementing Oracle Public Sector Permits Chapter 15Branding

15 Branding

Branding Public Sector Cloud Services This topic describes branding themes and attributes so you can understand the elements available to you when you brandyour Public Sector Cloud service.

You can apply the unique branding theme for your organization to your Public Sector Compliance and Regulation Cloudservices. Oracle provides a default theme, but you can create your own themes to match your organizations color choicesand labeling.

A branding theme defines the collection of a set of branding attributes. Examples of branding attributes include logo image,application label, page background color, and so on.

Initially, Oracle applies a default branding theme with a set of default theme attributes and attribute values. If you apply acustom default system branding theme, any theme attribute you include in your default branding theme overrides the Oracledefault for that theme attribute. For example, assume you specify a custom logo image and application label in a custombranding theme that you set as the system default. In this case, the application will display your custom logo and applicationname, but all other theme attributes, such as header background color, header text color, and so on, will continue to assumeOracle default values.

You cannot modify the delivered branding theme. To make changes, you need to create your own branding theme, andadd the attributes you wish to modify. After creating your branding theme, you then assign your branding theme to yourimplementation. The attributes you add to your own branding theme override the equivalent attributes in the default brandingtheme once you assign your own theme.

Managing Themes This topic describes how to access, create, modify, and delete branding themes.

This section describes the tasks related to managing themes.

Accessing ThemesTo access theme definitions, select Branding > Themes.

From the Manage Themes page you create, modify, and delete theme definitions.

Creating a ThemeYou can create multiple themes as needed for your implementation. Themes can be assigned to the system, application, androle level.

1. On the Manage Themes page, click the Add button.2. On the Theme Details page, modify these attributes:

225



Theme ID

System identification for the theme. Use upper case letters, numbers, or underscores only.The Theme ID has a 30–character limit.

Label

The functional display label that you see when selecting a theme.

Description

Provides additional information to describe the purpose of the theme to systemadministrators implementing your organization’s branding.

3. Click Save.

Modifying a Theme1. On the Manage Themes page, click on the row of the existing theme you want to modify.2. On the Theme Details page you modify:

◦ Label

◦ Description

◦ Branding Images

◦ Attributes

3. Click Save.

Deleting ThemesYou delete themes from the Manage Themes page.

1. On the Manage Themes page, click the Edit button to put the grid in edit mode.2. Select the row(s) of the theme(s) you want to delete.

Notice the row becomes selected.

Note: To select all rows, click the check box in the upper-left-hand corner of the themes grid.

3. Click the Delete button.4. Click OK to confirm you want to delete the selected items.5. Click the Edit button to exit edit mode.

Managing Theme Attributes This topic describes the tasks related to adding and modifying theme attributes, which define the appearance and brandingof your Oracle Public Sector Cloud service. A theme can contain one or more configured theme attributes.

226


Working with Theme AttributesA branding theme represents the collection of elements giving your application your customized user experience. Themeattributes represent the particular element that you want to customize within your branding theme, such as the logo image,the application name, or the header font color.

A theme can contain one more theme attributes. A theme attribute is not a standalone definition; it must be associated with atheme.

Each theme attribute is comprised of these properties:

• Theme Name: The theme to which you add the theme attribute.

• Name: A predefined set of attributes, selected from a drop-down list.

• Value: You customized value (label text, color, and so on).

Adding a Theme AttributeYou can add theme attributes when creating or modifying themes.

1. Select Branding > Themes.2. In the themes grid, click the theme to which you want to add an attribute.3. On the Theme Details page, click the Add button in the Attribute List grid.4. On the Theme Attribute Details page, select the attribute you want to add from the Name drop-down list.

For descriptions of each attribute type, see Configuring Theme Attributes.

For example:

227


5. In the Value field for the theme attribute, enter the required value for that attribute.

For example, if you selected Application label, enter your custom label text, or if you selected Header backgroundcolor, enter the color, a HEX value, or an RGB value.

6. Click Save.

Previewing a Theme AttributeFor color attributes, the system displays a preview of the color value you’ve provided.

This example illustrates previewing a color attribute:

This example illustrates the preview feature for color theme attributes where below the Value field the application displays asquare showing the specified color.

228


Deleting a Theme AttributeYou can delete theme attributes when modifying themes or when modifying a theme attribute.

1. Select Branding > Themes.2. Open the theme from which you want to remove attributes.3. On the Theme Details page, click the Edit button in the Attribute List grid to put the grid into edit mode.4. Select the row(s) of the theme attribute(s) you want to delete.

Notice the row becomes selected.

Note: To select all rows, click the check box in the upper-left-hand corner of the theme attributes grid.

5. Click Delete.6. Click OK to confirm deleting the selected item(s).7. Click the Edit button to exit edit mode.

Note: You can also delete attributes from the Theme Attribute Details page open when you have a singleattribute open.

Related Topics

• Configuring Theme Attributes

229


Configuring Theme Attributes This topic lists and describes all of the theme attributes you can add to a theme to define the appearance and behavior ofyour Public Sector Cloud service.

Working with Theme AttributesThe following table contains descriptions of the theme attributes you can add and configure to adjust the display and userexperience of the service.

Theme Attribute Description

Application Label

Enter the title for your application. The Application Label appears to the right of the ApplicationLogo, by default, except on the small device where it appears in the center of the header. Forexample: City of Carlsbad Licenses and Permits

Copyright text

Enter text displayed in the footer for copyright purposes.

Page Background Color

Specify the main color for the page. For example: #111

Header Background Color

Specify the main color for the header color. For example: #a0a0a0

Content Area Border Color

Specify the main color for the border of the content area. For example: #eeeeee

Header Text Color

Specify the color of the header text, as well as the color of the Application Navigation button and theSearch button.

Header Icon Color

Specify the color of the header icons, such as Home, Page Finder, Alerts, and so on.

Footer Text Color

Enter the color for the text appearing in the footer.

Footer Background Color

Specify the main color for the footer color. For example: #a0a0a0

Welcome Banner Text Color

Enter the color of the text you want to appear in the welcome banner on the public landing pages.

Welcome Banner Background Color

Specify the background color you want to set for the welcome banner on the public landing pages.

Welcome Banner Text Enter the text you want to appear in the welcome banner on the public landing pages.

230


Theme Attribute Description

Theme Style Sheet

Specify the stylesheet containing the style classes you reference in the theme properties on thispage.

Freeform Styles

Add any additional Cascading Style Sheet (CSS) style class definitions to further brand yourimplementation if needed. The styles you add can be used to override styles applied to delivereditems not associated with a specific branding attribute, such as landing page tiles. See the following section for descriptions of the elements to which you can apply freeform CSS.

Note: You do not select branding images using the Theme Attribute Details page. You use the Oracle FusionApplications Appearance tool to upload branding images.

For more information on branding images, see Applying Branding Images.

Modifying Delivered Style Classes with Freeform CSS StylesSome elements in the interface are not represented by a theme attribute that you can modify using the Theme AttributeDetails page. If needed you can add your own CSS to the Freeform Style theme attribute to override the CSS style applied bydefault. The following table lists UI elements and their associated style class that you can override with your own CSS.

UI Element Style Class Override Example

Background color of the AnonymousUser Landing page

.pscts-theme-page .PSCHM_GUEST_LINK{background-color: silver;}

Background color of the Search box onthe Anonymous User Landing page

.pscts-theme-page .PSCHM_SEARCH{background-color: gray;}

Background color of the tiles on:

• Anonymous User Landing page

• Registered User Landing page

.pscts-theme-page .psc-citizen-svg{background-color: green;}

Background color of Registered UserLanding page

.pscts-theme-page .PSCHM_PUBLIC_LINK{background-color: #00FFFF;}

Background color of Agency UserLanding page

.pscts-theme-page .PSC_AGENCY_HOME{background-color: #00FFFF;}

“I Want To” section on the AgencyHome Page

.pscts-theme-page .psc-home-two-column{background-color: silver;}

231


Applying Branding Images This topic describes how your Public Sector Cloud service utilizes the Fusion Applications Appearance page to upload andstore branding images, such as logo, cover image, and background image.

You use the Oracle Fusion Application Appearance page to upload and store the branding images that you will use for yourPublic Sector Cloud services. The Public Sector Cloud service, retrieves the uploaded images from the Appearance page atruntime. No other branding attributes, other than the specific branding images discussed in this topic, are retrieved from theAppearance page.

Image Description

Logo

Unique logo for your municipality, which appears in the top left of the header.

Note:A logo image should not exceed a height of 50 px or a width of 200 px.

Background Image

Defines the background border surrounding the content area of the HTML page.

Cover Image

On a homepage, the cover image spans the page from side-to-side, just below the header, as abanner image. Typically, this image depicts scenic views of the municipality, such as the skyline, aniconic neighborhood, and so on.

232


Image Description

Note:The cover image should be 200 px in height. Images exceeding 200 px in height will notdisplay the full image, while images under 200 px in height will display empty space (black)in the area between the current image height and 200 px.

When using the Appearance page to upload images for your Public Sector Cloud service, make sure to keep these items inmind:

• The Appearance page is used only for uploading the logo, background image, and the cover image.

• No other branding attributes in the Appearance page are referenced by Public Sector Cloud.

• To create or modify a theme in the Appearance page requires you to first create a sandbox.

• The name of the theme to which you add the Public Sector Cloud branding images in the Appearance page, mustexactly match the name of the corresponding theme name in Public Sector Cloud. For example, if your theme inPublic Sector Cloud is CHICAGO, then the theme to which you add images to in the Appearance page must also beCHICAGO, using the same spelling and case.

• You do not need to set the theme as active by applying the theme from the Appearance page. However, you needto publish the theme, from the Appearance page in order to make it available to your Public Sector Cloud service.

Accessing the Appearance Page from Public Sector CloudYou can access the Appearance page by:

• Select Navigator, Branding, Appearance.

• When editing a theme, click the Upload Branding Images link on the Theme Details page.

Activating a Sandbox1. On the Appearance page, click Edit.2. On the Sandbox Required dialog box, click Activate Sandbox.3. On the Manage Sandboxes dialog, click Actions, New.4. On the Create Sandbox dialog box enter values for the Sandbox Name and Description fields.5. Click Save and Close.6. On the Confirmation dialog box click OK to acknowledge your sandbox was created.7. On the Manage Sandbox page, select the row for your sandbox.8. Click Set as Active button.9. On the Warning dialog box, click Yes to indicate you will be taken to the Fusion Applications homepage.

10. After activating a sandbox, select Navigator and select Appearance to return to the Appearance page.

Note: Each time you make a new change to a theme, you must create a new sandbox.

Creating a ThemeThe theme you use in the Appearance page to store your Public Sector Cloud branding images must match exactly the nameof the theme defined in Public Sector Cloud.

233


To create a theme:

1. After activating the sandbox, select a theme to clone by clicking the drop-down list next to the Themes pageheading.

2. Click Actions, Save As.3. On the Save As dialog box, deselect the Apply this theme check box, and enter the name of the corresponding

Public Sector Cloud theme that will use the graphics you will be uploading with the Appearance page.

Note: The theme name must be exactly the same as the theme name defined within the Public SectorCloud service Manage Themes page, in both case and spelling.

Note: You must not apply the theme defined in the Fusion Appearance page. Public Sector Cloudservices only use the Appearance page to upload and store images for internal reference at runtime. Ifyou apply the theme from the Appearance page, that theme will become the active theme used by theFusion applications after you publish the sandbox. The theme storing the branding images just needs toexist within the Fusion theme collection; it does not need to be applied in order for the Public Sector Cloudservice to access the image attributes.

Uploading ImagesTo upload branding images:

1. In the General section of the Appearance page, modify one or all of these image types:

◦ Logo

◦ Background Image

◦ Cover Image

2. When adding an image, select one of these options:

◦ File: Browse and select a file from your local computer.

◦ Predefined: Select a file from the list of predefined images delivered by Oracle.

◦ URL: Enter a full URL for the logo or the watermark.

234


Publish Your ChangesItems in a sandbox can’t be accessed or referenced at runtime until you publish the sandbox.

To publish your changes:

1. When you have uploaded the desired images, click the sandbox banner at the top of the browser window.2. On the Sandbox Details page, review the list of changes, and click Publish.3. Return to your Public Sector Cloud service, and review your changes.

Assigning Themes This topic describes how to assign branding themes at various levels, such as system, application, and by role.

The service is delivered with a default branding theme that applies to all levels of the application. If you need to apply differentbranding attributes, you create your own themes which incorporate your modified theme attributes. After defining the themesto be used in your system, you then need to assign themes. The themes you provide override the default theme attributeswhere specified. Where no user-defined theme or user-defined theme attribute exist, the attributes defined in the defaulttheme take precedent.

You can assign themes at these levels:

Theme Level Description

System

Applies system-wide. If you do not specify an application-level theme, the interface displays onlythe attributes of the system theme for all applications and roles. This is typically the Oracle DefaultTheme. A system-wide theme is required.

Application

Applies only to a specific application menu, such as Default or Mobile. Default applies to the typicalinterface, while Mobile refers to mobile applications, such as Oracle Inspector. Application-level themes are optional. A system can have multiple application themes assigned asneeded.

Role

Extends the application-level theme assignment to apply to specific user roles. Using role-based themes you can provide different experiences for public users and your agencystaff, for example. Role-based themes are optional. An application-level theme can have multiple role-level themesassigned as needed.

The following sections describe the options for assigning themes at each level.

Note: During development and testing, make sure to refresh your browser for the new theme settings

Note: When you assign a custom theme, the theme attributes that you’ve added override the delivered Oracledefaults for that theme attribute. Otherwise, the system displays Oracle default theme attributes.

235


Viewing System-Level Themes1. Select Branding > Assign Themes .2. On the Assign Themes page, note the Application Default Theme field value.

This is the system-wide default theme, such as Oracle Default Theme.

Assigning Application-Level Themes1. Select Branding > Assign Themes .2. On the Assign Themes page, click Add under Theme Assignments.3. On the Theme Assignment Details page, specify these items:


Application

Select the application menu.

◦ Default: Use to apply to the general application (not the specific mobile applications).

◦ Mobile: Use to apply a theme to mobile applications, such as Oracle Inspector.

Description

Enter a description of the theme assignment.

Default Theme

Select the branding theme to apply to this application.

4. Click Save and Close.

Assign Role-Based ThemesYou can define different themes for various user roles in your system, such as public users, agency users, and so on. Thisway, you can control the user experience for the various roles in your system.

1. Select Branding > Assign Themes .2. On the Assign Themes page, locate the application theme to which you want to add a role-based theme.3. Click Edit.4. Click Add under Role-Based Assignment List.5. For the role-based theme, specify these items:


Priority

In the case of multiple user roles assigned to a user, specify a priority between the role-based themes. The system applies the role-based theme with the lowest priority (closestto 1). For example, assume Role A Theme has a priority of 10, and Role_B_Theme has apriority of 20. In this case, if both of those roles are assigned to the current user, the systemapplies the Role_A_Theme.

Role

Select the user role to which this theme applies.

Theme

Select the branding theme to apply to the selected role.

6. Click Save & Close.

236

Implementing Oracle Public Sector Permits Chapter 16Setting Up the Landing Pages and Agency Springboard

16 Setting Up the Landing Pages and AgencySpringboard

Landing Pages Overview The landing pages provide access to the permit service on the Oracle Public Sector Compliance and Regulation Cloud.

There are three landing pages that the agency can configure: Agency Springboard, Anonymous User Landing Page, andRegistered User Landing Page. This topic summarizes them and their purpose.

Page Description

Agency Springboard

Provides a starting point for agency staff to manage permits and support permit applicantsthroughout the permit lifecycle, including plan reviews and inspections. The Agency Springboardoffers access to task lists and specific pages based on the user’s role in the agency, fromsupervisors and accounting staff to permit technicians and inspectors. For more information about the elements on the Agency Springboard, see Setting Up the AgencySpringboard.

Anonymous User Landing Page

Also known as guests, anonymous users are residents, business owners, contractors, and so on,who have not signed in or are not registered. From the landing page, users can view an interactivemap of the city, browse types of permits, apply for a permit, and access the Permit Guide, which isa questionnaire users can fill out to find and save recommended permits for their project. For more information about the elements on the landing page for guests, see Setting Up theLanding Page for Anonymous Users.

Registered User Landing Page

Registered users are residents, business owners, contractors, and so on, who are registered in thesystem. From the landing page for registered users, permit applicants can apply for permits, payfees, view their permit applications and details, request inspections, apply for additional permits, andmanage their own user account from the landing page. For more information about the elements on the landing page for applicants who are registered inthe system, see Setting Up the Landing Page for Registered Users.

Agencies can configure the look and feel of the landing pages by changing these elements:

• Banner Image

• Welcome Message

• Summary Message

• Tile Labels

• Tile Image

• Color Theme for Background, Image Background, and Text of Each Section

For more information about setting up the landing pages, see Branding Public Sector Cloud Services.

237


Setting Up the Agency Springboard You set up the Agency Springboard by defining the different elements on the page for administration and management ofpermits, from application through issuance.

You can add these elements to the Agency Springboard by configuring the menu navigation attributes:

• Alerts banner

• I Want To actions bar

• Task lists element

• Springboard area with tiles

For information about setting up the banner image see Applying Branding Images.

For information about the global header and the page footer, see Configuring Header and Footer Navigation Features.

Defining Alerts for Agency StaffYou can display alert messages on the Agency Springboard in an alerts banner.

For more information about setting up alerts messages, see Defining Alerts.

Configuring the I Want To Actions BarThe I Want To actions bar is a drop-down action list that provides links to access to permit pages and functionality. You canshow or hide the I Want To bar and include the links provided in the I Want To Content folder.

This example illustrates the I Want To bar on the Agency Springboard described in the surrounding text.

Note: You can use the actions bar and tiles independently of each other or in combination. Both the actions barand selected tiles can access the same pages.

To show the I Want To actions bar on the Agency Springboard:

1. Select Navigation > Menu Configurations .2. On the Configure Menu Structure page, select the Products menu.3. Click Open Menu.4. Expand the Agency Springboard Data folder.5. Select the I Want To link:

238


Menu Link Description

I Want To

Show available actions for agency staff in the I Want To actions bar. For example, agencystaff can apply for a permit on behalf of the public user using the delivered action link, Applyfor a Permit.

6. Select the desired menu item and click the Edit button.7. On the Link Details page, go to the Show On field and select an option:

◦ All devices, Tablets and larger, or Smartphones only - Displays the I Want To actions bar.

◦ None - Hides the I Want To actions bar.

Note: When you configure the I Want To actions bar to appear on the Agency Springboard, it alsoappears on the Registered User Landing Page.

8. Click Close.

Configuring the Task List ElementThe Task List element provides access to different lists of assigned tasks for agency staff.

This example illustrates the task list element on the Agency Springboard described in the surrounding text.

To show the Task List element on the Agency Springboard:

1. Select Navigation > Menu Configurations .2. On the Configure Menu Structure page, select the Products menu.3. Click Open Menu.4. Expand the Agency Springboard Data folder.5. Select the Agency Task List link:


Agency Task List

Select to display the element that contains delivered links to the Task Management page,where a predefined filter is applied. The delivered links include:

◦ My Tasks

◦ Group Tasks

◦ My Workflow Tasks

◦ My Inspections

◦ My Plan Reviews

239



A number appears next to the link to display the task count for the applied filter.

6. Select the desired menu item and click the Edit button.7. On the Link Details page, go to the Show On field and select an option:

◦ All devices, Tablets and larger, or Smartphones only - Displays the Task List element.

◦ None - Hides the Task List element.

8. Click Close.

Configuring the Tiles on the SpringboardYou can show or hide tiles, or modify the tile labels on the springboard, but you cannot delete delivered menu links. For moreinformation about configuring tiles and the menu navigation, see Configuring Menu Structure.

This example illustrates tiles on the Agency Springboard described in the surrounding text.

To configure the tiles on the springboard area of the Agency Springboard:

1. Select Navigation > Menu Configurations .2. On the Configure Menu Structure page, select the Products menu.3. Click Open Menu.4. Expand the Agency Springboard Data folder.5. To create the springboard area for the tiles, click the Agency Springboard menu link.6. Click the Edit button.7. On the Link Details page, go to the Show On field and select an option:

◦ None - Hides the springboard area.

◦ All devices, Tablets and larger, or Smartphones only - Shows the springboard area.

8. To add individual tiles to the springboard, select from delivered menu links in a variety of folders.

240


9. Select the desired menu item and click the Edit button.10. On the Link Details page, turn on the Show on Springboard switch.

For example, when you enable the Show on Springboard property for the Permit List menu link, the Permit Listtile with a link to the associated page—the Permits page—appears in the springboard area.

241


Note: The tile appears only on the Agency Springboard and not on any other landing pages when youselect this option.

11. You can change the delivered label on the tile by editing the value in the Label field on the Link Details page.12. Click Close.

Setting Up the Landing Page for Anonymous Users You set up the landing page for anonymous or guest users by defining the different elements that help public users get permitinformation before they register.

You can configure these elements on the Anonymous User Landing Page:

• Banner image

• Welcome message

• Alerts banner

• Banner summary

• Search field

• Tiles

Setting Up the Banner ImageYou use the Oracle Fusion Application Appearance page to upload and store the branding images that you will use for yourPublic Sector Permits service. For information about setting up the banner image see Applying Branding Images.

242


Setting Up the Welcome MessageYou modify the Welcome Message with the other theme attributes. The Welcome Message is text in a large font and cansimply be “Welcome,” as shown in the sample landing page. For more information, see Managing Theme Attributes.

You enable the Welcome Message section using the Welcome menu link.

To enable the Welcome Message section in the menu navigation:

1. Select Navigation Menu Configurations2. On the Configure Menu Structure page, select the Products menu.3. Click Open Menu.4. Expand the Anonymous Landing Page Data folder.5. Select the Welcome menu link:


Welcome

Displays a section for the page title, such as Welcome, below the banner image. You canchange the menu link label to display your choice of text.

6. Click the Edit button.7. On the Link Details page, go to the Show On field and select an option:

◦ None - Hides the Welcome Message section.

◦ All devices, Tablets and larger, or Smartphones only - Shows the page title section.

Note: You must select an option to show on a device for the Welcome Message to appear,whether you define it at the branding level or here in the menu navigation configuration.

8. On the Link Details page, the text Welcome in the Label field is the default only when the Welcome Message hasn’tbeen defined at the theme level.

9. Click Close.

Defining AlertsYou display alert messages on the Anonymous User Landing Page in an alerts banner.

For information about setting up alert messages, see Defining Alerts.

Setting Up the Banner SummaryYou provide welcome information on the landing page for anonymous users and registered users in the banner summaryelement. You can also link to a page outside of Oracle Public Sector Permits from the banner summary.

For information about setting up welcome information, see Defining Summary Details.

Setting Up the Permit SearchYou provide anonymous users with a search field for permits by permit number, permit type, property address, description, orapplicant.

243


Note: Search for registered users is only available in the global header. For information about the global header,see Configuring Header and Footer Navigation Features.

To set up the Search element on the Anonymous User Landing Page:

1. Select Navigation Menu Configurations2. On the Configure Menu Structure page, select the Products menu.3. Click Open Menu.4. Expand the Anonymous Landing Page Data folder.5. Select the Search menu link:


Search

Displays a search element under the banner summary.

6. Click the Edit button.7. On the Link Details page, go to the Show On field and select an option:

◦ None - Hides the search element.

◦ All devices, Tablets and larger, or Smartphones only - Shows the search element.

8. Click Close.

Managing Tiles on the Anonymous User Landing PageYou can show or make small modifications to tiles on the landing page for anonymous users, but you cannot delete deliveredmenu links. For more information about modifying tiles, see Configuring Menu Structure.

To manage tiles on the Anonymous User Landing Page:

1. Select Navigation Menu Configurations2. On the Configure Menu Structure page, select the Products menu.3. Click Open Menu.4. Expand the Anonymous Landing Page Data folder.5. You can show or hide the delivered tiles:


Apply for a Permit

Provides a tile that links to the permit application.

My Applications

Provides a tile for users to navigate to their saved applications. From the Anonymous UserLanding Page, the user must log in before viewing saved permit applications.

Permit Guide

Provides a tile that links to a guided permit questionnaire used to find the type of permit theuser needs for a particular project. This tile links to a permit questionnaire set up with Oracle Policy Automation (OPA). SeeSetting Up the Permit Guide.

244



Note:If your agency is not using OPA, you must hide this tile by selecting None in theShow On field on the Link Details page for the Permit Guide menu link.

Explore Your City

Provides a tile that links to a map where the guest user can search for and find property andpermit details.

6. On the Link Details page for a tile, you can change the tile image by selecting any delivered image from the Icondrop-down options.

Setting Up the Landing Page for Registered Users You set up the public landing page for registered users who have entered credentials into the service.

You can configure these elements on the Anonymous User Landing Page:

• Banner image

• Alerts banner

• Banner summary

• I Want To actions bar

• Tiles

245


Setting Up the Banner ImageYou use the Oracle Fusion Application Appearance page to upload and store the branding images that you will use for yourPublic Sector Permits service. For information about setting up the banner image see Applying Branding Images.

Defining AlertsYou display alert messages on the Registered User Landing Page in an alerts banner.

For information about setting up alert messages, see Defining Alerts.

Setting Up the Banner SummaryYou provide welcome information on the landing page for anonymous users and registered users in the banner summaryelement. You can also link to a page outside of Oracle Public Sector Permits from the banner summary.

For information about setting up welcome information, see Defining Summary Details.

Configuring the I Want To Actions BarThe I Want Toactions bar is a drop-down action list on the Registered User Landing Page and Agency Springboard thatprovides links to access permit pages and functionality. You can show or hide the I Want To bar and include the link providedin the I Want To Content folder.

Note: You can use the I Want To actions bar and tiles independently of each other or in combination. Both theactions bar and selected tiles can access the same pages.

To show the I Want To actions bar:

1. Select Navigation > Menu Configurations .2. On the Configure Menu Structure page, select the Products menu.3. Click Open Menu.4. Expand the Agency Springboard Data folder.5. Select the I Want To menu link:


I Want To

Show available actions for agency staff in the I Want To actions bar. For example, aregistered user can apply for a permit on behalf of the public user using the delivered actionlink, Apply for a Permit.

6. Select the desired menu item and click the Edit button.

246


7. On the Link Details page, go to the Show On field and select an option:

◦ All devices, Tablets and larger, or Smartphones only - Displays the I Want To actions bar.

◦ None - Hides the I Want To actions bar.

Note: When you configure the I Want To actions bar to appear on the Agency Springboard, the actionsbar also appears on the Registered User Landing Page.

8. Click Close.

Managing Tiles on the Registered User Landing PageYou can show or make small modifications to tiles on the landing page for registered users, but you cannot delete deliveredmenu links. For more information about modifying tiles, see Configuring Menu Structure.

To manage tiles on the Registered User Landing Page:

1. Select Navigation Menu Configurations2. On the Configure Menu Structure page, select the Products menu.3. Click Open Menu.4. Use the menu links for the tiles in the Anonymous Landing Page Data folder.5. You can show or hide the delivered tiles:


Apply for a Permit

Provides a tile that links to the permit application.

My Applications

Provides a tile for users to navigate to their saved applications. From the Anonymous UserLanding Page, the user must log in before viewing saved permit applications.

Permit Guide

Provides a tile that links to a guided permit questionnaire used to find the type of permit theuser needs for a particular project. This tile links to a permit questionnaire set up with OraclePolicy Automation (OPA).

Note:If your agency is not using OPA, you must hide this tile by selecting None in theShow On field on the Link Details page for the Permit Guide menu link.

Explore Your City

Provides a tile that links to a map where the guest user can search for and find property andpermit details.

6. On the Link Details page for a tile, you can change the tile image by selecting any delivered image from the Icondrop-down options.

Setting Up the Permit Guide You enter an Oracle Policy Automation definition for the Permit Guide on the Permit Options page.

247


Use the Permit Options page during agency setup to add feature options for permits, including the Oracle Policy AutomationID to use for the Permit Guide. The Permit Guide is a questionnaire that helps public users determine which permit isappropriate for a project. Public users do not need to register before answering the permit questionnaire.

For information about adding Welcome Information for anonymous and registered users on the Permit Options page, seeDefining Summary Details.

Adding the Oracle Policy Automation DefinitionAs a part of setting up the landing page for public users, you enter an Oracle Policy Automation ID associated with the PermitGuide.

1. Select Common Setup > Agency > Agency ID > Features .2. Click the Options link in the row for your enabled offering.3. On the Permit Options page, enter a value for the following field in the Oracle Policy Automation Definition

section:

Page Element Usage


(Optional) Associate this agency implementation with a set of rules defined for the permitquestionnaire. The questionnaire ensures that the applicant selects the correct permit fortheir project. Predefined Oracle Policy Automation rules are delivered as samples, but using OPA forfinding the permits needed for a project is optional.

4. Click Save.

Defining Summary Details You set up the banner summary section on the public landing pages for anonymous and registered users by defining asummary title and text. You can also link to an agency page outside of the Oracle Public Sector Compliance and RegulationCloud.

The Banner Summary section includes a summary title and text as well as a Read More button that links to either a URLoutside of the Oracle Public Sector Compliance and Regulation Cloud or a longer message that you define. You define thesummary details for the Banner Summary section in the menu navigation configuration and on the Permit Options page.

This example illustrates the Banner Summary section containing the fields described in the surrounding text.

248


Setting Up Summary Details in the Menu Navigation ConfigurationYou set up summary details for the Anonymous User Landing Page and the Registered User Landing page in the menunavigation configuration. You must enable the Online Permits menu link for the Banner Summary section to appear on thelanding pages.

1. Select Navigation > Menu Configurations .2. On the Configure Menu Structure page, select the Products menu.3. Click Open Menu.4. Expand the Anonymous Landing Page Data folder.5. Select the Online Permits menu link:


Online Permits

Displays the summary title, summary text, and Read More button below the banner image.You can change the menu link label and description to display your choice of text.

6. Click the Edit button.7. On the Link Details page, update these fields:


Show On

Select from these options:

◦ None - Hides the page title section.

◦ All devices, Tablets and larger, or Smartphones only - Shows the page title section.

249



Note:You must select an option to show on a device for the banner summary to appear,whether you define the summary details information here in the menu navigationconfiguration or in the agency setup.

Label

Update the delivered title text, Online Permits.

Description

Update the delivered summary text, Streamline the application and review process for yourproject.

8. Click Close.

Setting Up Summary Details in the Permit Options SetupYou set up the summary title and text for the Anonymous User Landing Page and the Registered User Landing page on thePermit Options page during agency setup.

Note: You can define the summary details here in the agency setup or in the menu navigation configuration.But you must enable the Online Permits menu link in the navigation configuration for the banner summary toappear.

1. Select Common Setup > Agency > Agency ID > Features > Options .2. On the Permit Options page, enter values for the following fields in the Landing Page Message Definition section:

Page Elements Usage

Message Title

Enter a short text version of the landing page message in a title format. If you leave thisfield blank, the value in the Label field on the Link Details page for the menu navigation linkOnline Permits is displayed.

Message Summary

Enter a longer version of the landing page message title in a sentence format. If you leavethis field blank, the value in the Description field on the Link Details page for the menunavigation link Online Permits is displayed.

Button Content URL

Enter a content URL for the Read More button. Public users click this button to access theagency’s own permit information page, outside of Oracle Public Sector Permits. If you leavethis field blank, the Read More button opens a dialog box that displays the Landing PageMessage.

Note:If you want to link to a page outside of Oracle Public Sector Permits, you must entera URL here.

Landing Page Message

Enter information in rich text that appears in a dialog box when the user clicks the ReadMore button. If a URL to access the agency’s page is defined, you don’t need thismessage.

250


3. Click Save.

Defining Tiles You define tiles by configuring a set of menu links that represent the tiles on landing pages and springboards.

The tiles and elements that you see on landing pages and springboards are treated as menu links that you configure duringimplementation. They give you access to specific pages and functionality within a product, such as permitting.

Your agency decides which tiles and elements to display on these home pages:

• Anonymous User Landing Page

• Registered User Landing Page

• Agency Springboard

You can open delivered menus and make minor changes to menu items to meet your agency needs.

For more information about managing menu items, see Configuring Menu Structure.

Modifying TilesYou can make minor changes to tiles on the Link Details page for the selected tile. You can hide or rename tiles, but notdelete them.

1. Click the menu link in the selected folder.2. Click the Edit button.3. On the Link Details page, you can make these changes:


Label and Description

Enter text for the tile label and description.

Icon

Select an icon for the tile from the available options in the drop-down list.

Sequence

Change the sequence or order in which the tile appears.

Show On

Select a device type from these options:

◦ All devices

◦ Tablets and larger

◦ Smart phones only

◦ None

Show on Springboard

Turn on the switch to display the tile with a link to an associated page on the AgencySpringboard, which is for agency staff only.

Note:The tile appears only on the Agency Springboard and not on any other landingpages when you select this option.

251



Show in Page Finder

Turn on the switch to display the link in the Page Finder, which is a navigation featureaccessed by agency staff by clicking the Page Finder button in the global header.


Defining Alerts You set up and enable alerts for the Agency Springboard and public landing pages using the delivered communicationresource for general alerts.

You can add, modify, and enable alert messages using the communication framework.

For more information about communications, see Setting Up Communication Events.

Adding Alerts1. Select Communication Center > Events .2. Click the event row for general alerts: PSC_GENERIC_ALERT.3. Click the Add button in the Communication Template section.4. On the Communication Template Details page, select Alert in the Channel Type field. The page refreshes to show

the fields required for defining an alert.5. In the Template Attributes section, enter information for the required fields:


Code and Name

Enter a code and descriptive name for the alert.

Start Date Time and End DateTime

Enter when the alert is valid, including when to start and when to stop showing the alert.

Visibility

Select from these options, depending on where you want the alert message to appear:

◦ Account owner

◦ Public user

◦ Agency staff only

Enabled

Turn on the switch to activate the alert.

6. In the Compose section, enter information in these fields:


To

Enter a value to generate alerts for the target recipients:

◦ Individual Registered Users

252



Enter comma-separated user IDs for the registered users, for example,SYSTEM_ADMIN,BUSINESS_ANALYST.

◦ All Registered Users

Enter this attribute: ${User}. The Communication Alerts framework provides thealert information when the registered user logs in.

◦ All Anonymous Users

Enter this attribute: ${Anonymous}.

◦ A Combination of Users

Enter a string including comma-separated user IDs for the registered users, ${User}for all registered users, and ${Anonymous} for all anonymous users.

Message Body

Compose the message for your alert here. For the Alert channel type, you can enter onlyplain, unformatted text.

Select and Insert

Insert variable attributes into your communications. You select the field and the attribute thatyou want to insert in that field, and click Insert to enter a variable for that attribute. For example, if you select the Body field and the Permit ID attribute, and click Insert,the ${Permit ID} variable is inserted into the Body field of the communication template.Whenever the application generates a communication using this template, it inserts thepermit ID that is associated with the triggered communication event into the body text.

Remarks

Enter any additional information about the communication. These remarks are not includedin the generated communication.

7. Click Save.8. On the Communication Event Details page, turn on the Enabled switch.9. Click Save.

Modifying Alerts1. Select Communication Center > Events .2. Click the event row for general alerts: PSC_GENERIC_ALERT.3. In the Communication Template section, click the row for the alert you want to modify.4. On the Communication Template Details page, you can enable or disable the alert message, change the recipient of

the alert in the To field, and update the message text in the message body.5. Click Save.6. On the Communication Event Details page, you can turn on or turn off the Enabled switch.7. Click Save.

Enabling Alerts1. Select Navigation > Menu Configurations .2. On the Configure Menu Structure page, select the Products menu.3. Click Open Menu.4. Expand the folder for the desired alert location:

◦ Agency Springboard Data

253


◦ Anonymous Landing Page Data

◦ Registered Landing Page Data

5. Select the Alerts item in the folder.6. On the Link Details page, change the Show On field to All devices.7. Click Save and Close.

254

Implementing Oracle Public Sector Permits Chapter 17Configuring Security

17 Configuring Security

Using the Security Console Use the Security Console to manage application security in your Oracle Applications Cloud service. Use the IT SecurityManager role to perform security-related tasks pertinent to role management, role analysis, user-account management, andcertificate management.

Security Console TasksYou can perform these tasks in the Security Console:

Security Area Tasks

Roles

• Create job, abstract, and duty roles.

• Edit custom roles.

• Copy roles.

• Compare roles.

• Visualize role hierarchies and assignments to users.

• Review Navigator menus available to roles or users, identifying roles that grant access toNavigator items and privileges required for that access.

Users

• Create user accounts.

• Review, edit, lock, or delete existing user accounts.

• Assign roles to user accounts.

• Reset users' passwords.

Analytics

• Review statistics concerning role categories, the roles belonging to each category, and thecomponents of each role.

• View the data security policies, roles, and users associated with each database resource.

Certificates

• Generate, export, or import PGP or X.509 certificates, which establish encryption keys fordata exchanged between Oracle Cloud applications and other applications.

• Generate signing requests for X.509 certificates.

Administration

• Establish rules for the generation of user names.

• Set password policies.

• Create standards for role definition, copying, and visualization.

• Review the status of role-copy operations.

• Define templates for notifications of user-account events such as password expiration.

255


Security Console AccessYou must have the IT Security Manager role to use the Security Console. This role inherits the following duty roles:

• Security Management

• Security Reporting

Running Security Background ProcessesTo prepare the Security Console for use, arrange to run background processes that replenish security data. Also use SecurityConsole Administration pages to select general and role-oriented options, track the status of role-copy jobs, and select, edit,or add notification templates. These generate messages to notify users of events that concern them, such as password-expiration warnings.

Run two background processes:

• The Retrieve Latest LDAP Changes process copies data from the LDAP directory to Oracle Cloud ApplicationsSecurity tables. Run it once, during implementation. Select Setup and Maintenance from the Navigator. In the Setupand Maintenance work area, search for and select the Run User and Roles Synchronization Process task.

• The Import User and Role Application Security Data process copies users, roles, privileges, and data security policiesfrom the identity store, policy store, and ApplCore grants schema to Oracle Cloud Applications Security tables.Schedule it to run regularly to update those tables: Select Scheduled Processes in the Tools work area, and thenselect the process from the Schedule New Process option.

General Administration OptionsSelect the Security Console Administration tab, and then the General tab on the Administration page, to set these options:

• User Preferences

◦ Select the format of the User Name, the value that identifies a user as he signs in. It is generated automaticallyin the format you select. Options include first and last name delimited by a period, email address, first-nameinitial and full last name, and person or party number.

◦ Select the check box labeled "Generate system user name when generation rule fails" to enable the automaticgeneration of User Name values if the selected generation rule cannot be implemented.

• Password Policy

◦ Establish the number of days a password remains valid. Set the number of days before expiration that a userreceives a warning to reset the password. And define the period in which a user must respond to a notificationto reset his password ("Hours Before Password Reset Token Expiration").

◦ Select a password format.

◦ Determine whether a previous password may be reused.

◦ Determine whether an administrator can manually modify passwords in the Reset Password dialog, availablefrom a given user's record in the Users tab. This option applies only to the manual-reset capability. Anadministrator can always use the Reset Password dialog to initiate the automatic reset of a user's password.

• Certificate Preferences: Set the default number of days for which a certificate remains valid. (Certificates establishkeys for the encryption and decryption of data that Oracle Cloud applications exchange with other applications.)

256


• Synchronization Process Preferences: Specify a number of hours since the last run of the Import User and RoleApplication Security Data process. When a user selects the Security Console Roles tab, a warning message appearsif the process has not been run in this period.

Role Administration OptionsSelect the Security Console Administration tab, and then the Roles tab on the Administration page, to set these options:

• Role prefixes and suffixes: Create the prefix and suffix added to the name and code of role copies. Each role hasa Role Name (a display name) and a Role Code (an internal name). A role copy adopts the name and code of thesource role, with this prefix or suffix (or both) added. The addition distinguishes the copy from its source. By defaultthere is no prefix, the suffix for a role name is "Custom," and the suffix for a role code is "_CUSTOM."

• Graph node limit: Set the maximum number of nodes a visualization graph can display. When a visualization graphwould contain a greater number of nodes, the visualizer displays a message advising the user to select the tableview.

• Enable edit of data security policies: Determine whether users can enter data in the Data Security Policies page ofthe role-creation and role-edit trains available from the Roles tab.

• Enable edit of user role membership: Determine whether users can enter data in the Users page of the role-creationand role-edit trains available from the Roles tab.

• Enable default table view: Determine whether visualizations generated from the Roles tab default to the table view or,if this option is cleared, the radial graph view.

Role Copy StatusSelect the Security Console Administration tab, and then the Role Copy Status tab on the Administration page, to viewrecords of jobs to copy roles. These jobs are initiated in the Roles page. Job status is updated automatically until a finalstatus, typically Completed, is reached. You can delete the row representing a copy job; click its x icon.

Running Retrieve Latest LDAP ChangesInformation about users and roles in your LDAP directory is available automatically to Oracle Cloud Applications. However, inspecific circumstances you're recommended to run the Retrieve Latest LDAP Changes process. This topic describes whenand how to run Retrieve Latest LDAP Changes.

You run Retrieve Latest LDAP Changes if you believe data-integrity or synchronization issues may have occurred betweenOracle Cloud Applications and your LDAP directory server. For example, you may notice differences between roles on theSecurity Console and roles on the Create Role Mapping page. On-premises customers should also run this process afterapplying monthly updates.

Sign in with the IT Security Manager job role and follow these steps:

1. Open the Scheduled Processes work area.2. Click Schedule New Process in the Search Results section of the Overview page.

The Schedule New Process dialog box opens.3. In the Name field, search for and select the Retrieve Latest LDAP Changes process.4. Click OK to close the Schedule New Process dialog box.5. In the Process Details dialog box, click Submit.6. Click OK, then Close.7. On the Scheduled Processes page, click the Refresh icon.

Repeat this step periodically until the process completes.

257


Note: Only one instance of Retrieve Latest LDAP Changes can run at a time.

Security VisualizationsA Security Console visualization graph consists of nodes that represent security items. These may be users, roles, privileges,or aggregate privileges. Arrows connect the nodes to define relationships among them. You can trace paths from any item ina role hierarchy either toward users who are granted access or toward the privileges roles can grant.

You can select either of two views:

• Radial: Nodes form circular (or arc) patterns. The nodes in each circular pattern relate directly to a node at thecenter. That focal node represents the item you select to generate a visualization, or one you expand in thevisualization.

• Layers: Nodes form a series of horizontal lines. The nodes in each line relate to one node in the previous line. This isthe item you select to generate a visualization, or the one you expand in the visualization.

For example, a job role might consist of several duty roles. You might select the job role as the focus of a visualization (andset the Security Console to display paths leading toward privileges):

• The Radial view would initially show nodes representing the duty roles encircling a node representing the job role.

• The Layers view would initially show the duty-role nodes in a line after the job-role node.

You can then manipulate the image, for example by expanding a node to display the items it consists of.

As an alternative, you can generate a visualization table that lists items related to an item you select. For example, a table maylist the roles that descend from a role you select, or the privileges inherited by the selected role. You can export tabular datato an Excel file.

Working with a Visualization GraphWithin a visualization graph, you can select the Radial or Layers view. In either view, you can zoom in or out of the image.You can expand or collapse nodes, magnify them, or search for them. You can also highlight nodes that represent types ofsecurity items.

To select one of the views, click Switch Layout in the Control Panel, which is a set of buttons on the visualization. Then selectRadial or Layers.

Node LabelsYou can enlarge or reduce a visualization, either by expanding or collapsing nodes or by zooming in or out of the image. Asyou do, the labels identifying nodes change:

• If the image is large enough, each node displays the name of the item it represents.

• If the image is smaller, symbols replace the names: U for user, R for role, S for predefined role, P for privilege, and Afor aggregate privilege.

• If the image is smaller still, the nodes are unlabeled.

Regardless of labeling, you can hover over a node to display the name and description of the user, role, or privilege itrepresents.

Nodes for each type of item are visually depicted such that item types are easily distinguished.

258


Expanding or Collapsing NodeTo expand a node is to reveal roles, privileges, or users to which it connects. To collapse a node is to hide those items. Toperform these actions:

1. Select a node and right-click.2. Select one of these options:

◦ Expand reveals nodes to which the selected node connects directly, and Collapse hides those nodes.

◦ Expand All reveals all generations of connecting nodes, and Collapse All hides those nodes.

Alternatively, double-click a collapsed node to expand it, or an expanded node to collapse it.

Using Control Panel ToolsApart from the option to select the Radial or Layers view, the Control Panel contains these tools:

• Zoom In: Enlarge the image. You can also use the mouse wheel to zoom in.

• Zoom Out: Reduce the image. You can also use the mouse wheel to zoom out.

• Zoom to Fit: Center the image and size it so that it is as large as it can be while fitting entirely in its display window.(Nodes that you have expanded remain expanded.)

• Magnify: Activate a magnifying glass, then position it over nodes to enlarge them temporarily. You can use themouse wheel to zoom in or out of the area covered by the magnifying glass. Click Magnify a second time todeactivate the magnifying glass.

• Search: Enter text to locate nodes whose names contain matching text. You can search only for nodes that theimage is currently expanded to reveal.

• Control Panel: Hide or expose the Control Panel.

Using the LegendA Legend lists the types of items currently on display. You can:

• Hover over the entry for a particular item type to locate items of that type in the image. Items of all other types aregrayed out.

• Click the entry for an item type to disable items of that type in the image. If an item of that type has child nodes, it isgrayed out. If not, it disappears from the image. Click the entry a second time to restore disabled items.

• Hide or expose the Legend by clicking its button.

Using the OverviewOn the image, click the plus sign to open the Overview, a thumbnail sketch of the visualization. In it, click any area of thethumbnail to focus the actual visualization on that area.

As an alternative, click the background of the visualization, and move the entire image in any direction.

Refocusing the ImageYou can select any node in a visualization as the focal point for a new visualization: Right-click a node, then select Set asFocus.

259


Note: You can review role hierarchies using either a tabular or a graphical view. The view you see by defaultdepends on the setting of the Enable default table view option on the Administration tab.

Working with a Visualization TableA visualization table contains records of roles, privileges, or users related to a security item you select. The table displaysrecords for only one type of item at a time:

• If you select a privilege as the focus of your visualization, select the Expand Toward Users option. Otherwise thetable shows no results. Then use the Show option to list records of either roles or users who inherit the privilege.

• If you select a user as the focus of your visualization, select the Expand Toward Privileges option. Otherwise the tableshows no results. Then use the Show option to list records of either roles or privileges assigned to the user.

• If you select any type of role or an aggregate privilege as the focus of your visualization, you can expand in eitherdirection.

◦ If you expand toward privileges, use the Show option to list records of either roles lower in hierarchy, orprivileges related to your focus role.

◦ If you expand toward users, use the Show option to list records of either roles higher in hierarchy, or usersrelated to your focus role.

Tables are all-inclusive:

• A Roles table displays records for all roles related directly or indirectly to your focus item. For each role, inheritancecolumns specify the name and code of a directly related role.

• A Privileges table displays records for all privileges related directly or indirectly to your focus item. For each privilege,inheritance columns display the name and code of a role that directly owns the privilege.

• A Users table displays records for all users assigned roles related directly or indirectly to your focus item. For eachuser, Assigned columns display the name and code of a role assigned directly to the user.

Use a field on a column to enter search text, then press Enter. The table displays records whose column values contain textmatching your search text.

You can export a table to Excel. Click the Export to Excel button. You may either open the Excel file directly or save it. If youopt to save the file, you're prompted to define a path.

Generating a VisualizationTo generate a visualization:

1. Select the Roles tab in the Security Console.2. Search for the security item on which you want to base the visualization.

◦ In a Search field, select any combination of item types, for example job role, duty role, privilege, or user.

◦ In the adjacent field, enter at least three characters. The search returns items of the types you selected, whosenames contain the characters you entered.

◦ Select one of those items. Or, click the Search button to load all the items in a Search Results column, andselect an item there.

3. Select either a Show Graph button or a View as Table button.

260


Note: In a page for role administration, you can determine which of these is the default view.

4. In the Expand Toward list, select Privileges to trace paths from your selected item toward items lower in its rolehierarchy. Or select Users to trace paths from your selected item toward items higher in its hierarchy.

5. If the Table view is active, select an item type in the Show list: Roles, Privileges, or Users. (The options available toyou depend on your Expand Toward selection.) The table displays records of the item type you select. Note that anaggregate privilege is considered to be a role.

Security Console Analytics for RolesYou can review statistics about the roles that exist in your Oracle Cloud instance. Select the Analytics tab, and then the Rolestab on the Analytics page. Then view these analyses:

• Role Categories. Each role belongs to a category that defines some common purpose. Typically, a category containsa type of role configured for an application, for example "Financials - Duty Roles."

For each category, a Roles Category grid displays the number of:

◦ Roles

◦ Role memberships (roles belonging to other roles within the category)

◦ Security policies created for those roles

In addition, a Roles by Category pie chart compares the number of roles in each category with those in othercategories.

• Roles in Category. Click a category in the Role Categories grid to list roles belonging to that category. For each role,the Roles in Category grid also shows the number of:

◦ Role memberships

◦ Security policies

◦ Users assigned the role

• Individual role statistics. Click the name of a role in the Roles in Category grid to list the security policies and usersassociated with the role. The page also presents collapsible diagrams of hierarchies to which the role belongs.

Click Export to export data from this page to a spreadsheet.

Data Security PoliciesYou can review information about data security policies that grant access to a database resource, or about roles and usersgranted access to that resource.

To begin, select the Analytics tab, and then the Database Resources tab on the Analytics page. Select the resource you wantto review in the Database Resource field. Then click Go. Results are presented in three tables.

The Data Security Policies table documents policies that grant access to the selected database resource.

Each row documents a policy, specifying by default:

• The data privileges it grants.

• The condition that defines how data is selected from the database resource.

261


• The policy name and description.

• A role that includes the policy.

For any given policy, this table may include multiple rows, one for each role in which the policy is used.

Authorized RolesThe Authorized Roles table documents roles with direct or indirect access to the selected database resource. Any given rolemay:

• Include one or more data security policies that grant access to the database resource. The Authorized Roles tableincludes one row for each policy belonging to the role.

• Inherit access to the database resource from one or more roles in its hierarchy. The Authorized Roles table includesone row for each inheritance.

By default, each row specifies:

• The name of the role it documents.

• The name of a subordinate role from which access is inherited, if any. (If the row documents access provided by adata security policy assigned directly to the subject role, this cell is blank.)

• The data privileges granted to the role.

• The condition that defines how data is selected from the database resource.

Note: A role's data security policies and hierarchy may grant access to any number of database resources.However, the Authorized Roles table displays records only of access to the database resource you selected.

Authorized UsersThe Authorized Users table documents users who are assigned roles with access to the selected database resource.

By default, each row specifies a user name, a role the user is assigned, the data privileges granted to the user, and thecondition that defines how data is selected from the database resource. For any given user, this table may include multiplerows, one for each grant of access by a data security policy belonging to, or inherited by, a role assigned to the user.

Manipulating the ResultsIn any of these three tables, you can:

• Add or remove columns. Select View - Columns.

• Search among the results. Select View - Query by Example to add a search field on each column in a table.

• Export results to a spreadsheet. Select the Export to Excel option available for each table.

Types of Secured InformationInformation can be private, personally identifiable, or sensitive information.

Private information is confidential in some contexts.

Personally identifiable information (PII) identifies or can be used to identify, contact, or locate the person to whom theinformation pertains.

262


Some PII information is sensitive.

A person's name is not private. It is PII but not sensitive in most contexts. The names and work phone numbers of employeesmay be public knowledge within an enterprise, so not sensitive but PII. In some circumstances it is reasonable to protect suchinformation.

Some data is not PII but is sensitive, such as medical data, or information about a person's race, religion or sexual orientation.This information cannot generally be used to identify a person, but is considered sensitive.

Some data is not private or personal, but is sensitive. Salary ranges for grades or jobs may need to be protected from view byusers in those ranges and only available to senior management.

Some data is not private or sensitive except when associated with other data the is not private or sensitive. For example, dateor place of birth is not a PII attribute because by itself it cannot be used to uniquely identify an individual, but it is confidentialand sensitive in conjunction with a person's name.

Managing Implementation Users This topic describes the tasks associated with the initial users of the implementation team.

Implementation UsersThe initial user can perform all the necessary setup tasks. She can also perform security tasks, including resetting passwordsand the granting of additional privileges to herself and to others. After you sign in the first time, you can create additionalimplementation users with the same broad setup privileges that Oracle provides to the initial user. If you prefer, you canrestrict the privileges of these implementation users based on your own setup needs.

The setup or implementation users are typically different from the Oracle Applications Cloud application users. For example:

• Setup users are usually not part of your Oracle Applications Cloud organization.

• You don't assign them product-specific work or make it possible for them to view product-specific data.

You do, however, have to give them the necessary privileges they require to complete application setup. You provide theseprivileges through role assignment.

Your application includes several types of roles. A job role, such as the IT Security Manager role, corresponds to a specificjob that a person does in the organization. An abstract role, such as the Employee role, corresponds to general categories ofpeople in an organization. You assign both types of roles to users in the security console. For the setup users, these roles are:

• Application Diagnostic Administrator

• Application Implementation Consultant

• Employee

• IT Security Manager

Note: The Application Implementation Consultant role has unrestricted access to large amounts of data. Limitassignment of the Application Implementation Consultant abstract role to implementation users who perform awide range of implementation tasks and move the setup data across environments. Use other administrator rolessuch as the Financials Applications Administrator for users required to perform specific implementation tasks.

263


There is nothing to stop you from providing the same setup permissions to users that are part of the organization, if you needto. Highly privileged implementation users are not the only users who can do setup. You can create administrative users whodon't have such broad permissions, yet can configure product-specific structures and perform other related setup tasks

Managing User AccountsThe User Accounts page of the Security Console provides summaries of user accounts that you select to review. For eachaccount, it always provides:

• The user's login, first name, and last name, in a User column.

• Whether the account is active, whether it is locked, and the user's password-expiration date, in a Status column.

It may also provide:

• Associated worker information, if the user account was created in conjunction with a worker record in Human CapitalManagement. This may include person number, manager, job title, and business unit.

• Party information, if the user account was created in conjunction with a party record created in CRM. This mayinclude party number and party usage.

The User Accounts page also serves as a gateway to account-management actions you can complete. These include:

• Reviewing details of, editing, or deleting existing accounts.

• Adding new accounts.

• Locking accounts.

• Resetting users' passwords.

To begin working with user accounts:

1. Select the Users tab in the Security Console.2. In a Search field, select any combination of user states and enter at least three characters.

The search returns user accounts at the states you selected, whose login, first name, or last name begins with thecharacters you entered.

Reviewing and Editing User AccountsTo review full details for an existing account, search for it in the User Accounts page and click its user login in the Usercolumn. This opens a User Account Details page.

These details always include:

• User information, which consists of user, first, and last name values, and an e-mail address. It also includes anexternal identifier if one has been created. This is an external-system identifier, such as a single sign-on account ID ifsingle sign-on is enabled.

• Account information, which comprises the user's password-expiration date, whether the account is active, andwhether it is locked.

• A table listing the roles assigned to the user, including whether they are autoprovisioned or assignable. A role isassignable if it can be delegated to another user.

The page may also include an Associated Worker Information region or an Associated Party Information region. The formerappears only if the user account is related to a worker record in Human Capital Management, and the latter if the useraccount is related to a party record in CRM.

264


To edit these details, click Edit in the User Account Details page. Be aware, however:

• You can edit values only in the User Information, Account Information, and Roles regions.

• Even in those regions, you can edit some fields only if the user is not associated with a worker or a party. If not,for example, you can modify the First Name and Last Name values in the User Information region. But if the user isassociated with a worker, you would manage these values in Human Capital Management. They would be grayedout in this Edit User Details page.

• In the Roles table, Autoprovisioned check boxes are set automatically, and you cannot modify the settings. The boxis checked if the user obtained the role through autoprovisioning, and cleared if the role was manually assigned. Youcan modify the Assignable setting for existing roles.

Click Add Autoprovisioned Roles to add any roles for which the user is eligible. Or, to add roles manually, click Add Role.Search for roles you want to add, select them, and click Add Role Membership.

You can also delete roles. Click the x icon in the row for the role, and then respond Yes to a confirmation message.

Adding User AccountsThe ability to add user accounts in the Security Console is intended for the creation of implementation users. The expectationis that an implementation user would set up Oracle Human Capital Management (HCM). You would then use HCM to createaccounts for application users.

To add a user account in the Security Console:

1. Select the Users tab in the Security Console to open the User Accounts page.2. Click the Add User Account button.3. Select a value for Associated Person Type: Worker if this account is to be linked to a worker record in HCM, or None

if not.4. By default, the account is set to be active and unlocked in the Account Information area. Typically these values are

appropriate, but you may modify them.5. Select the User Category with which you want to associate the user.

Note: If you are not sure which user category to select, you may leave it unchanged. All new users are automaticallyassigned to the Default user category.

6. Enter name, e-mail, and password values in the User Information region as per the following guidance.

◦ You need not enter a User Name value. It is generated automatically according to the user-name-generationrule selected in the General Administration page.

◦ The First Name value is not required. However, you are expected to enter one if the selected user-name-generation rule makes use of the first name or the first-name initial.

◦ The Password value must conform to the password policy established in the General Administration page.The Confirm Password value must match the Password value.

◦ An external identifier is the user's ID in another system, such as a single sign-on account ID if single sign-on isenabled.

7. Click Add Autoprovisioned Roles, to assign roles for which role-provisioning rules make the user eligible.8. Click Add Roles to assign other roles. Search for roles you want to assign, select them, then click Add Role

Membership. Select Done when you are finished.9. In the Roles table, select Assignable for any role that can be delegated to another user.


265


Resetting PasswordsAn administrator may use the Security Console to reset other users' passwords. That action triggers an e-mail notification toeach user, informing him or her of the new password.

A new password must conform to your password policy. You establish this policy in the General Administration page. Thepage in which you reset the password displays the policy.

To reset a password:

1. In the User Accounts page, search for the user whose password you want to change.2. In that user's row, click the Action icon, then Reset Password.

As an alternative, open the user's account for editing: click the User Login value in the User Accounts page, thenEdit in a User Account Details page. In that page, select Reset Password.

3. In a Reset Password dialog, select whether to generate the password automatically or change it manually. For amanual change, also enter a new password value and a confirmation value, which must match the new value.

Note: The option to reset a password to an automatically generated value is always available. For the manual-resetoption to be available, an "Administrator can manually reset password" option must be selected on the GeneralAdministration page.

4. Click the Reset Password button.

Locking and Unlocking User AccountsAn administrator may use the Security Console to lock users' accounts. When an account is locked, its user cannot sign in.He or she must either use the "forgot password" flow to reset the password or contact the help desk to have the accountunlocked.

You can lock a user account in either of two ways. In either case, open the User Accounts page and search for the userwhose account you want to lock.

To complete the first procedure:

1. In the user's row, click the Action icon, then Lock Account.2. Respond Yes to a confirmation message.

To complete the second procedure:

1. Open the user's account for editing: click the User Login value in the User Accounts page, then Edit in a UserAccount Details page.

2. In the Edit User Account page, select the Locked check box in the Account Information region.3. Select Save and Close.

You can unlock the account only from the Edit User Account page, by clearing the Locked check box.

Deleting User AccountsAn administrator may use the Security Console to delete users' accounts.

1. Open the User Accounts page and search for the user whose account you want to delete.2. In the user's row, click the Action icon, then Delete.3. Respond Yes to a confirmation message.

266


Defining Notification TemplatesUsers may receive Email notifications of user-account events, such as account creation or password expiration. Thesenotifications are generated from a set of templates, each of which specifies an event. A template generates a message to auser when that user is involved in the event tied to the template.

To work with templates, click the User Categories tab in the Security Console. Then select a user category and on the UserCategory: Details page, click the Notifications tab. You must click the Edit button to make any changes.

There are eight events, and a predefined template exists for each event. Only one template linked to a given event canbe enabled at a time. To use notification templates, ensure that notifications are enabled. To do that, select the EnableNotifications check box in the Notification Preferences region.

Even so, you can enable or disable templates, edit them, or create templates to replace existing ones. To create a template:

1. On the User Category: Notifications page, click Add Template.2. Enter a name for the template and, optionally, a description.3. Select an event. When you do, values for Message Subject and Message are copied from an already-configured

template for which the same event is selected.4. Edit the message subject, message text, or both. Note that message text may include tokens, which are replaced in

runtime by literal values appropriate for a given user or account.5. Select the Enabled check box to use the template immediately. If you do, the application automatically disables the

template that had been enabled for that event. Or, leave the check box cleared to hold the template in reserve.6. Click Save and Close.

To edit a template, select it from the templates listed in the Notification Templates table. Then follow essentially the sameprocess as you would to create a template. Note, however, that you cannot modify the event selected for a template that hasbeen saved. You may enable or disable an individual template by selecting or clearing its Enabled check box as you edit it.

Note: You can't edit or delete predefined templates that begin with the prefix name ORA. You also can't modifythe message subject or the message. However, you can only enable or disable the predefined templates.

You can delete the templates you created. Select the template row in the table and click Delete.

The following table lists the tokens you can use in the message text for a template

Token Meaning

${userLoginId}

The user name of the person whose account is being created or modified.

${firstName}

The given name of the person whose account is being created or modified.

${lastName}

The surname of the person whose account is being created or modified.

${managerFirstName}

The given name of the person who manages the person whose account is being created ormodified.

${managerLastName}

The surname of the person who manages the person whose account is being created or modified.

${loginUrl}

The web address to sign in to Oracle Cloud. The user can sign in and use the Preferences page tochange a password that is about to expire. Or, without signing in, the user can engage a forgot-password procedure to change a password that has already expired.

267


Token Meaning

${resetUrl}

A one-time web address expressly for the purpose of resetting a password, used in the PasswordGenerated, Password Reset, New Account, and New Account Manager templates.

${CRLFX}

Insert line break.

${SP4}

Insert four spaces.

Synchronizing User and Role InformationYou run the process Retrieve Latest LDAP Changes once during implementation. This process copies data from the LDAPdirectory to the Oracle Fusion Applications Security tables. Thereafter, the data is synchronized automatically. To run thisprocess, perform the task Run User and Roles Synchronization Process as described in this topic.

Follow these steps:

1. Sign in to your Oracle Applications Cloud service environment as the service administrator.2. Select Navigator Others Setup and Maintenance to open the Setup and Maintenance work area.3. In the Setup and Maintenance work area, select the Run User and Roles Synchronization Process task in the Initial

Users functional area.

The process submission page for the Retrieve Latest LDAP Changes process opens.4. Click Submit.5. Click OK to close the confirmation message.

Resetting the Cloud Service Administrator Sign-In DetailsOnce you have set up your implementation users, you can reset the service administrator sign-in details for your OracleApplications Cloud service. You reset these details to avoid problems later when you're loaded to the service as an employee.This topic describes how to reset the service administrator sign-in details.

Sign in to your Oracle Applications Cloud service using the TechAdmin user name and password and follow these steps:

1. In the Setup and Maintenance work area, select the Create Implementation Users task in the Initial Users functionalarea.

The User Accounts page of the Security Console opens.2. Search for your service administrator user name, which is typically your email. Your service activation mail contains

this value.3. In the search results, click your service administrator user name to open the User Account Details page.4. Click Edit.5. Change the User Name value to ServiceAdmin.6. Delete any value in the First Name field.7. Change the value in the Last Name field to ServiceAdmin.8. Delete the value in the Email field.9. Click Save and Close.

10. Sign out of your Oracle Applications Cloud service.

After making these changes, you use the user name ServiceAdmin when signing in as the service administrator.

268


Managing User CategoriesYou can categorize and segregate users based on the various functional and operational requirements. A user categoryprovides you with an option to group a set of users such that the specified settings apply to everyone in that group. Typicalscenarios in which you may want to group users are:

• Users have different preferences in receiving automated notifications from the Security Console. For example,employees of your organization using the organization's single sign-on don't require notifications from the SecurityConsole about creating new users, password expiry, or password reset. However, the suppliers of your organizationwho aren't using the organization's single sign-on, must receive such notifications from the Security Console.

• You have built an external application for a group of users using the REST APIs of Oracle Fusion Applications. Youintend to redirect this user group to the external application when using the Security Console to reset passwords orcreate new users.

On the Security Console page, click the User Category tab. You can perform the following tasks:

Task Description

Segregate users into categories

Create user categories and add existing users to them. All existing users are automatically assignedto the Default user category unless otherwise specified. You may create more categories dependingupon your requirement and assign users to those categories.

Note:You can assign a user to only one category.

Specify Next URL

Specify a URL to redirect your users to a website or an application instead of going back to the SignIn page, whenever they reset their password. For example, a user places a password reset requestand receives an Email for resetting the password. After the new password is authenticated, the usercan be directed to a website or application. If nothing is specified, the user is directed to OracleApplications Cloud Sign In page. You can specify only one URL per user category.

Enable notifications

Notifications are enabled by default, but you can disable them if required. You can also enable ordisable notifications separately for each user category. If users belonging to a specific categorydon't want to receive any notification, you can disable notifications for all life cycle events.Alternatively, if users want to receive notifications only for some events, you can selectively enablethe functionality for those events. Notifications are sent for a set of predefined events. To trigger a notification, you must create anotification template and map it to the required event. Depending on the requirement, you can addor delete a template that is mapped to a particular event.

Note:You can't edit or delete predefined notification templates that begin with the prefix ORA.You can only enable or disable them. However, you can update or delete the user-definedtemplates.

User Category feature supports both SCIM protocol and HCM Data Loader for performing any bulkupdates.

269


Using the Security Console, you can add existing users to an existing user category or create a new category and add them.When you create new users, they are automatically assigned to the default category. At a later point, you can edit the useraccount and update the user category. You can assign a user to only one category.

Note: If you are creating new users using Security Console, you can also assign a user category at the time of creation.

You can add users to a user category in three different ways:

• Create a user category and add users to it

• Add users to an existing user category

• Specify the user category for an existing user

Note: You can create and delete a user category only using the Security Console. Once the required user categories areavailable in the application, you can use them in SCIM REST APIs and data loaders. You can't rename a user category.

Adding Users to a New User CategoryTo create a user category and add users:

1. On the Security Console, click User Categories Create.2. Click Edit, specify the user category details, and click Save and Close.3. Click the Users tab and click Edit.4. On the Users Category: Users page, click Add.5. In the Add Users dialog box, search for and select the user, and click Add.6. Repeat adding users until you have added the required users and click Done.7. Click Done on each page until you return to the User Categories page.

Adding Users to an Existing User CategoryTo add users to an existing user category:

1. On the Security Console, click User Categories and click an existing user category to open it.2. Click the Users tab and click Edit.3. On the Users Category: Users page, click Add.4. On the Add Users dialog box, search for and select the user, and click Add.5. Repeat adding users until you have added the required users and click Done.6. Click Done on each page until you return to the User Categories page.

Specifying the User Category for an Existing UserTo add an existing user to a user category:

1. On the Security Console, click Users.2. Search for and select the user for whom you want to specify the user category.3. On the User Account Details page, click Edit.4. In the User Information section, select the User Category. The Default user category remains set for a user until you

change it.5. Click Save and Close.6. On the User Account Details page, click Done.

You can delete user categories if you don't require them. However, you must ensure that no user is associated with that usercategory. Otherwise, you can't proceed with the delete task. On the User Categories page, click the X icon in the row todelete the user category.

270


Managing NotificationsUsing the Security Console, you can determine whether to turn notifications on or off for the users.

1. On the Security Console, click User Categories and from the list, select the specific user category.2. Click the Notifications tab and click Edit.3. Select the Enable Notifications check box to enable notifications for all users of that user category. To disable

notifications, deselect the check box.4. Click Done.

To determine which notifications to send, you have to enable the notification template for each required event.

Managing Users in Public Sector Compliance andRegulation This topic provides an overview of the types of users working in the permits service and describes how users are created andmanaged within Public Sector Compliance and Regulation.

Overview of User Types in Public Sector Compliance and RegulationIn the Public Sector Compliance and Regulation service, there are these types of users:

• Anonymous Users

• Registered Users

An anonymous user:

• Accesses the permits site, but either has not registered with the application, or they have not signed in.

• Could be an unregistered citizen, a business owner, a contractor, and so on.

• Can access the public landing page, view all permit application types, use a GIS map, self-register, run specificreports, and so on.

Note: You do not create anonymous users or assign roles to them. For any user who is not registered andsigned in, the application automatically assigns them the anonymous user role and privileges. The anonymoususer role is a Fusion Applications role, and cannot be modified or cloned.

A registered user can be can be a:

• Registered public user.

• Agency staff member.

A registered public user:

• Could be a citizen, a contractor, a business owner, and so on.

• Can access the registered user landing page, view all permit applications, apply for permits, pay fees, manage theirown user account, and so on.

271


An agency staff member:

• Could be a permit technician, plan reviewer, plan coordinator, building inspector, and so on.

• Can access the Agency Springboard, view assigned tasks, view all permit application types, plus they can accessadditional job-specific functions and data.

Note: For the Public Sector Compliance and Regulation Cloud service, you do not create users through theSecurity Console interface. You create them using Public Sector Compliance and Regulation service pagesdescribed in the following sections.

Creating Registered Public UsersWhen an unregistered user, clicks the Register button in the global header, and successfully completes the registrationprocess, the application creates a user account for that user.

System administrators can define the information the anonymous user must provide during the registration process using thePublic User Setup page.

For more information on the Public User Setup page, see Setting Up Public Users.

In addition to defining the options on the user registration page, system administrators can also define the roles that willautomatically be assigned to the users upon registration using the Public User Roles page.

A registered public user would typically have a set of roles assigned to them, for example:

• The PSC Registered Public User abstract role to provide all the default access for a citizen, contractor, and so on.

• The custom roles created during implementation to provide access to permits, such asCUSTOM_PSC_MANAGE_PERMITS and CUSTOM_PSC_VIEW_PERMITS.

For more information on the Public User Roles page, see Setting Up Public User Roles.

Creating Agency Staff UsersThe agency staff user is employed by the agency in the capacity of administering or processing the permit process.

You create agency staff users on the Agency Staff page, where you can create and manage the agency staff profile.

For more information, on the Agency Staff page, see Managing Agency Staff Profiles.

An agency staff member would typically have a set of roles assigned to them. For example, the following list illustrates aminimum set of roles:

• The PSC Agency Staff abstract role to provide all the default access for an agency employee.

• At least one of the delivered job roles, such as PSC Permit Technician, to provide access to the functions and datarequired to complete job tasks.

• The custom roles created during implementation to provide access to permits, such asCUSTOM_PSC_MANAGE_PERMITS and CUSTOM_PSC_VIEW_PERMITS.

272


Setting the Next URL for the Default User Category This topic describes how to set the Next URL property for the default user category so that the current user is directed tothe Public Sector Compliance and Regulation application after registering in the system and setting up user credentials andpasswords.

This setup task only needs to be completed once for all users because all users are associated with the DEFAULT usercategory.

1. Navigate to the Security Console.2. Select the User Categories tab.3. Click the DEFAULT user category link.4. On the DEFAULT User Category: Details page update the Next URL edit box to reflect the URL for your Oracle

Public Sector Compliance and Regulation implementation.

https://yourdomain.us.oracle.com/fscmUI/pscrAuthentication.html5. Save your changes.

Note: The URL entered using the previous steps, such as https://yourdomain.us.oracle.com/fscmUI/pscrAuthentication.html should only be used for setting the Next URL value. The URL that can bepublished for external public users is to access the service is: https://yourdomain.us.oracle.com/fscmUI/publicSector.html Users can bookmark the URL for accessing the Public Sector Community Developmenthomepage.

Managing Roles in Public Sector Compliance andRegulation This topic introduces roles are use to implement security and the general Oracle Cloud security role types. It also highlightskey roles and configuration considerations to keep in mind when implementing Public Sector Compliance and Regulation.

Role-Based Access ControlWhen you receive your Oracle Cloud application, access to its functionality and data is secured using the industry-standardframework for authorization, role-based access control. In a role-based access control model, users are assigned roles, androles are assigned access privileges to protected resources. The relationship between users, roles, and privileges is shown inthe following figure.

273


Users gain access to application data and functions when you assign them roles, which correspond to the job functions inyour organization or the functions a citizen in your municipality may perform.

Users can have any number of different roles concurrently, and this combination of roles determines the user's level of accessto protected system resources. For example, a user might be assigned the Agency Staff role, the Permits Supervisor role, andthe Permits Application Administrator role. In this case, the user has the following access:

• With the Agency Staff role, the user can access functions and data suitable for agency staff members.

• With the Permits Supervisor role, the user can access permits manager functions and data, and access and correctpermit technician functions and data.

• With the Permits Application Administrator role, the user can access permit configuration settings and makenecessary changes.

When the user logs into Oracle Cloud and is successfully authenticated, a user session is established and all the rolesassigned to the user are loaded into the session repository. Oracle Cloud determines the set of privileges to applicationresources that are provided by the roles, then grants the user the most permissive level of access.

Role TypesOracle Cloud defines the following types of roles:

Role Type Description

Job Roles

Job roles represent the jobs that users perform in an organization. General Accountant andAccounts Receivables Manager are examples of predefined job roles. You can also create job roles.

Abstract Roles

Abstract roles represent people in the enterprise independently of the jobs they perform. Somepredefined abstract roles in Oracle Applications Cloud include Employee and Transactional BusinessIntelligence Worker. You can also create abstract roles. All users are likely to have at least one abstract role that provides access to a set of standardfunctions. You may assign abstract roles directly to users.

Duty Roles

Duty roles represent a logical collection of privileges that grant access to tasks that someoneperforms as part of a job. Budget Review and Account Balance Review are examples of predefinedduty roles. You can also create duty roles. Other characteristics of duty roles include:

• They group multiple function security privileges.

• They can inherit aggregate privileges and other duty roles.

• You can copy and edit them.

274


Role Type Description

Job and abstract roles may inherit duty roles either directly or indirectly. You don't assign duty rolesdirectly to users.

Aggregate Privileges

Aggregate privileges are roles that combine the functional privilege for an individual task or duty withthe relevant data security policies. Functions that aggregate privileges might grant access to includetask flows, application pages, work areas, dashboards, reports, batch programs, and so on. Aggregate privileges differ from duty roles in these ways:

• All aggregate privileges are predefined. You can't create, modify, or copy them.

• They don't inherit any type of roles.

You can include the predefined aggregate privileges in your job and abstract roles. You assignaggregate privileges to these roles directly. You don't assign aggregate privileges directly to users.

Duty Role ElementsFunctional security privileges and data security policies are granted to duty roles. Duty roles may also inherit aggregateprivileges and other duty roles.

Elements Description

Data Security Policies

For a given duty role, you may create any number of data security policies. Each policy selects a setof data required for the duty to be completed and actions that may be performed on that data. Theduty role may also acquire data security policies indirectly from its aggregate privileges. Each data security policy combines:

• A duty role, for example Expense Entry Duty.

• A business object that's being accessed, for example Expense Reports.

• The condition, if any, that controls access to specific instances of the business object. Forexample, a condition may allow access to data applying to users for whom a manager isresponsible.

• A data security privilege, which defines what may be done with the specified data, forexample Manage Expense Report.

Function Security Privileges

Many function security privileges are granted directly to a duty role. It also acquires function securityprivileges indirectly from its aggregate privileges. Each function security privilege secures the code resources that make up the relevant pages, suchas the Manage Grades and Manage Locations pages.

Tip:The predefined duty roles represent logical groupings of privileges that you may want tomanage as a group. They also represent real-world groups of tasks. For example, thepredefined General Accountant job role inherits the General Ledger Reporting duty role. Tocreate your own General Accountant job role with no access to reporting structures, youcould copy the predefined job role and remove the General Ledger Reporting duty role fromthe role hierarchy.

275


Aggregate PrivilegesAggregate privileges are a type of role. Each aggregate privilege combines a single function security privilege with related datasecurity policies. All aggregate privileges are predefined. This topic describes how aggregate privileges are named and used.

• Aggregate Privilege Names

An aggregate privilege takes its name from the function security privilege that it includes. For example, the ManageAccounts Payable Accounting Period Status aggregate privilege includes the Manage Accounting Period Statusfunction security privilege.

• Aggregate Privileges in the Role Hierarchy

Job roles and abstract roles inherit aggregate privileges directly. Duty roles may also inherit aggregate privileges.However, aggregate privileges can't inherit other roles of any type. As most function and data security in job andabstract roles is provided by aggregate privileges, the role hierarchy has few levels. This flat hierarchy is easy tomanage.

• Use of Aggregate Privileges in Custom Roles

You can include aggregate privileges in the role hierarchy of a custom role. Treat aggregate privileges as role buildingblocks.

• Creating, Editing, or Copying Aggregate Privileges

You can't create, edit, or copy aggregate privileges, nor can you grant the privileges from an aggregate privilege toanother role. The purpose of an aggregate privilege is to grant a function security privilege only in combination with aspecific data security policy. Therefore, you must use the aggregate privilege as a single entity.

If you copy a job or abstract role, then the source role's aggregate privileges are never copied. Instead, rolemembership is added automatically to the aggregate privilege for the copied role.

Understanding Role Hierarchies and InheritanceAlmost every role is a hierarchy or collection of other roles.

• Job and abstract roles inherit aggregate privileges. They may also inherit duty roles.

In addition to aggregate privileges and duty roles, job and abstract roles are granted many function security privilegesand data security policies directly. You can explore the complete structure of a job or abstract role in the SecurityConsole.

• Duty roles can inherit other duty roles and aggregate privileges.

When you assign roles, users inherit all of the data and function security associated with those roles.

In Oracle Cloud, each role can be linked to other roles in a parent-child format to form a hierarchy of roles. As illustrated in thefollowing figure, users are assigned job and abstract roles, which inherit duty roles and their associated privileges. Duty rolesin turn can inherit privileges from subordinate duty roles. You can explore the complete structure of a job or abstract role onthe Security Console.

276


Role hierarchies allow privileges to be grouped to represent a feature set in Oracle Cloud, which simplifies featuremanagement. Role hierarchies also provide privilege granularity and facilitate role reuse. For example, each role hierarchybeneath the job role represents a feature that is available through the job role to the user. Roles at lower levels of thehierarchy represent functionality that the feature requires. If this functionality is required by other features, the role thatprovides the functionality can be shared across roles.

Note: Having many levels in a role hierarchy is not recommended. Deep role hierarchies are difficult to manage,and modification of the privileges in roles that are heavily reused can cause undesired consequences in otherfeatures.

277


In the previous example, assume an inspection supervisor, Grady Parker.

• Because Grady is employed by the agency, he is assigned the Agency Staff abstract role, and at least one job role,which is in the is case Inspection Supervisor.

• Through the Inspection Supervisor job role, Grady inherits a set of duty roles, including the Inspection RequestManagement duty role. There is also a privilege unique to inspection supervisors, Access Supervisor Calendar, whichis assigned directly to the job role.

• The Inspection Request Management duty role contains other duty roles as well as a set of inherited aggregateprivileges, including Cancel Inspection Requests and Schedule Inspections.

• The Cancel Inspection Requests aggregate privilege is comprised of both a function security policy and data securitypolicy.

Predefined Roles for Public Sector Compliance and RegulationPublic Sector Compliance and Regulation provides a set of predefined top-level roles that you can assign to users or clone tocreate additional roles. Oracle Cloud refers to the top-level roles in the system as top roles, because these are the roles at thetop of the role hierarchy. Top roles can be job roles or abstract roles.

The following table lists the top roles in the Public Sector Compliance and Regulation service.

Role Role Type Description

PSC Agency Staff

Abstract

Provides default privileges for any agencystaff employee.

PSC Registered Public User

Abstract

Provides default privileges for any end userwho has completed the self registrationprocess.

278



PSC Building Inspector

Job

An agency staff position responsible forinspecting sites for permit approval.

PSC Business Analyst

Job

A staff member that supports the agencyin implementing and maintaining theapplications.

PSC Cashier

Job

Responsible for the sale and record keepingfor various licenses and permits.

PSC Chief Building Officer

Job

Manages a staff of permit technicians andinspectors. Oversees that the staff processespermits expeditiously and accurately and thatall fees are collected and accounted.

PSC Economic Development Officer

Job

Maintains various ledgers, registers,and journals according to establishedaccount classifications. Audits feesagainst department activity, researchesdiscrepancies, and performs accountingclerical work.

PSC Finance Administrator

Job

Reviews all incoming permit applicationsfor accuracy and checks for any neededsupporting documentation. Reviews thechecklist to determine if they need furtherreview or routing to other departments.

PSC Geographical Information SystemAdministrator

Job

Uses Geographical Information Systemsoftware and related programs for provisionof maps, charts, graphs, and other relatedinformation for visual displays, presentationsor reports.

PSC Inspections Supervisor

Job

Manages the workflow and staff to getthrough inspection jobs everyday. Keepstrack of inspectors, districts and workload.

PSC Permit Technician

Job

Performs permit technician duties, whichincludes processing applications, feeassessments, fee collections, documents,standardization, and permit issuance.

PSC Permits Application Administrator

Job

An agency staff position that oversees thepermit application.

PSC Permits Supervisor

Job

Manages the workflow and staff to ensurethat the permit applications are assigned andprocessed by the permit technicians.

PSC Plan Reviewer

Job

Reviews plans for development, modification,alteration and demolition of commercial andresidential properties. Checks compliancewith applicable state and local zoning and

279



building codes and related regulations.Calculates fees required for issuance ofpermits.

PSC Planning Coordinator

Job

Coordinates plan review, permitting, andinspection of private construction projectsin accordance with municipal ordinancesand adopted building codes and codeenforcement.

PSC Principal Planner

Job

Reviews construction plans for compliancewith all state and local development andzoning codes, regulations, and requirements.

PSC System Administrator

Job

An agency staff position that has all accessto configuration settings, security settings,and is able to access and solve issues forother users.

The remainder of the delivered roles are lower-level child roles that group privileges and link privileges to the top-level roles.

Key Duty Roles in Public Sector Compliance and RegulationThe following table highlights a set of key duty roles to illustrate some delivered, predefined duty roles.

Duty Role Description

PSC Apply Permit

Provides all the access required for an applicant, such as being able to access a permit, fill in andsubmit a permit application, add comments to the permit during the application process, and so on.

PSC Agency Permits Inquiry

Provides the read only access for the agency staff members so that they can review and processpermit applications.

PSC Anonymous Permit ApplicationInquiry

Provides read-only access for viewing a permit application.

Note:Oracle Fusion Applications do not allow modification of any anonymous roles.

Working with Aggregate Privileges in Public Sector Compliance andRegulationAll aggregate privileges are predefined. Aggregate privileges combine a single functional security privilege with related datasecurity policies.

In many cases with roles in the Public Sector Compliance and Regulation Cloud, you see a pattern, where one aggregaterole provides the general, default behavior, such as allowing a user to insert comments and update only their own comments.

280


Then there is a counterpart aggregate role that would provide more far reaching privileges, such as updating the commentsfor others.

For example, consider these aggregate roles:

• PSC Update Inspection Comments added by self

• PSC Update Inspection Attachments added by self

• PSC Update Inspection Comments added by others and self

• PSC Update Inspection Attachments added by others and self

For example, with the comments and attachments, most roles provide you with the ability to add comments or attachmentsand update comments or attachments inserted by yourself. However, by assigning to the user another aggregate role(with the phrase “by others and self” in the role title), that user could update comments or attachments added by others. Asupervisor in the permit processing department could update comments in a permit added by one of their permit techniciansif they have the following role assigned to their user account: PSC Update Inspection Comments added by others and self.

By default, the ”by others and self” aggregate privileges are assigned only to system administrators.

Modifying Delivered RolesIf the delivered top roles do not meet your business requirements, you can create custom roles by cloning a delivered job orabstract role, and then modifying you custom role as needed. When cloning a role, this also copies the role hierarchy, whichyou can modify as needed by either adding or removing elements of the hierarchy.

CAUTION: If you find you want to update a delivered role, it is not recommended to modify the role itself.

When creating custom roles, it is highly recommended to modify a role’s access through aggregate privileges, rather thanattempting to modify a job, abstract, or duty role manually. Modifying access using aggregate privileges is efficient and amore robust approach. Keep in mind that aggregate privileges contain both the functional security and the data securitypolicy for an action. By adding or removing an aggregate privilege, you make one change, but adjust both aspects of securitysimultaneously. If you update a duty role manually, you will need to always make sure you’ve added or removed the functionaland data security counterparts. Otherwise, you may not be providing or restricting the access you intend, while in othercases, you may be creating security holes, unintentionally.

Related Topics

• Working with Roles in the Security Console

Working with Roles in the Security Console This topic describes the tasks associated with roles that you complete using the Security Console.

You can use the Security Console to perform a variety of tasks related to roles, including:

• View the roles assigned to a user.

• Identify users who have a specific role.

• Copying existing roles.

• Create duty, job, or abstract roles.

281


You must have the IT Security Manager job role to perform these tasks.

Viewing the Roles Assigned to a User1. Open the Security Console.2. On the Roles tab, search for and select the user.

Depending on the enterprise setting, either a table or a graphical representation of the user's role hierarchy appears.Switch to the graphical representation if necessary to see the user and any roles that the user inherits directly. Userand role names appear on hover. To expand an inherited role:

a. Select the role and right-click.b. Select Expand. Repeat these steps as required to move down the hierarchy.

Tip: Switch to the table to see the complete role hierarchy at once. You can export the details to MicrosoftExcel from this view.

Identifying Users Who Have a Specific Role1. On the Roles tab of the Security Console, search for and select the role.2. Depending on the enterprise setting, either a table or a graphical representation of the role hierarchy appears. Switch

to the graphical representation if it doesn't appear by default.3. Set Expand Toward to Users.

Tip: Tip: Set the Expand Toward option to control the direction of the graph. You can move either upthe hierarchy from the selected role (toward users) or down the hierarchy from the selected role (towardprivileges).

In the refreshed graph, user names appear on hover. Users may inherit roles either directly or indirectly from otherroles. Expand a role to view its hierarchy.

4. In the Legend, click the Tabular View icon for the User icon. The table lists all users who have the role. You canexport this information to Microsoft Excel.

Reviewing Role HierarchiesOn the Security Console you can review the role hierarchy of a job role, an abstract role, or a duty role.

1. On the Roles tab of the Security Console, ensure that Expand Toward is set to Privileges.2. Search for and select the role. Depending on the enterprise setting, either a table or a graphical representation of the

role appears.3. If the table doesn't appear by default, click the View as Table icon. The table lists every role inherited either directly

or indirectly by the selected role. Set Show to Privileges to switch from roles to privileges.

Tip: Enter text in a column search field and press Enter to show only those roles or privileges that containthe specified text

Click Export to Excel to export the current table data to Microsoft Excel.

282


Comparing RolesYou can compare any two roles to see the structural differences between them. As you compare roles, you can alsoadd function and data security policies existing in the first role to the second role, providing that the second role is not apredefined role.

For example, assume you have copied a role and edited the copy. You then upgrade to a new release. You can compareyour edited role from the earlier release with the role as shipped in the later release. You may then decide whether toincorporate upgrade changes into your edited role. If the changes consist of new function or data security policies, you canupgrade your edited role by adding the new policies to it.

1. Select the Roles tab in the Security Console.2. Do any of the following:

◦ Click the Compare Roles button.

◦ Create a visualization graph, right-click one of its roles, and select the Compare Roles option.

◦ Generate a list of roles in the Search Results column of the Roles page. Select one of them, and click its menuicon. In the menu, select Compare Roles.

3. Select roles for comparison:

◦ If you began by clicking the Compare Roles button, select roles in both First Role and Second Role fields.

◦ If you began by selecting a role in a visualization graph or the Search Results column, the First Role fielddisplays the name of the role you selected. Select another role in the Second Role field.

For either field, click the search icon, enter text, and select from a list of roles whose names contain that text.4. Select two roles for comparison.5. Use the Filter Criteria field to filter for any combination of these artifacts in the two roles:

◦ Function security policies

◦ Data security policies

◦ Inherited roles

6. Use the Show field to determine whether the comparison returns:

◦ All artifacts existing in each role

◦ Those that exist only in one role, or only in the other role

◦ Those that exist only in both roles

7. Click the Compare button.

You can export the results of a comparison to a spreadsheet. Select the Export to Excel option.

After you create the initial comparison, you can change the filter and show options. When you do, a new comparison isgenerated automatically.

Adding Policies to a Role1. Select two roles for comparison.

◦ As the First Role, select a role in which policies already exist.

◦ As the Second Role, select the role to which you are adding the policies. This must be a custom role. Youcannot modify a predefined role.

283


2. Ensure that your selection in the Filter Criteria field excludes the Inherited roles option. You may select Datasecurity policies, Function security policies, or both.

3. As a Show value, select Only in first role.4. Click the Compare button.5. Among the artifacts returned by the comparison, select those you want to copy.6. An Add to Second Role option becomes active. Select it.

Custom Role ConsiderationsIn many cases, an efficient method of creating a role is to copy an existing role, then edit the copy to meet your requirements.Typically, you would create a role from scratch if no existing role is similar to the role you want to create.

To create a role from scratch, select the Roles tab in the Security Console, then click the Create Role button. Enter values in aseries of role-creation pages, selecting Next or Back to navigate among them.

Providing Basic InformationOn a Basic Information page:

1. In the Role Name field, create a display name, for example North America Accounts Receivable Specialist.2. In the Role Code field, create an internal name for the role, such as

AR_NA_ACCOUNTS_RECEIVABLE_SPECIALIST_JOB.

Note: Do not use "ORA_" as the beginning of a role code. This prefix is reserved for roles predefined byOracle. You cannot edit a role with the ORA_ prefix.

3. In the Role Category field, select a tag that identifies a purpose the role serves in common with other roles. Typically,a tag specifies a role type and an application to which the role applies, such as Financials - Job Roles.

If you select a duty-role category, you cannot assign the role you are creating directly to users. To assign it, youwould include it in the hierarchy of a job or abstract role, then assign that role to users.

4. Optionally, describe the role in the Description field.

Adding Function Security PoliciesA function security policy selects a set of functional privileges, each of which permits use of a field or other user-interfacefeature. On the Function Security Policies page, you may define a policy for:

• A duty role. In this case, the policy selects functional privileges that may be inherited by duty, job, or abstract roles towhich the duty is to belong.

• A job or abstract role. In this case, the policy selects functional privileges specific to that role.

As you define a policy, you can either add an individual privilege or copy all the privileges that belong to an existing role:

1. Select Add Function Security Policy.2. In a Search field, select the value Privileges or types of role in any combination and enter at least three characters.

The search returns values including items of the type you selected, whose names contain the characters youentered.

3. Select a privilege or role. If you select a privilege, click Add Privilege to Role. If you select a role, click Add SelectedPrivileges.

284


The Function Security Policies page lists all selected privileges. When appropriate, it also lists the role from which a privilege isinherited. You can:

• Click a privilege to view details of the code resource it secures.

• Delete a privilege. You may, for example, have added the privileges associated with a role. If you want to use onlysome of them, you must delete the rest. To delete a privilege, click its x icon.

Note: Do not add data security policies manually to the Public Sector Compliance and Regulation services.

Configuring the Role HierarchyA Role Hierarchy page displays either a visualization graph, with the role you are creating as its focus, or a visualization table.Select the Show Graph button or View as Table button to select between them. In either case, link the role you are creating toother roles from which it is to inherit function and data security privileges.

• If you are creating a duty role, you can add duty roles or aggregate privileges to it. In effect, you are creating anexpanded set of duties for incorporation into a job or abstract role.

• If you are creating a job or abstract role, you can add aggregate privileges, duty roles, or other job or abstract rolesto it.

To add a role:

1. Select Add Role.2. In a Search field, select a combination of role types and enter at least three characters. The search returns values

including items of the type you selected, whose names contain the characters you entered.3. Select the role you want, and click Add Role Membership. You add not only the role you have selected, but also its

entire hierarchy.

In the graph view, you can use the visualization Control Panel, Legend, and Overview tools to manipulate the nodes thatdefine your role hierarchy.

Adding Users to RolesOn a Users page, you can select users to whom you want to assign a job or abstract role you are creating. (You cannotassign a duty role directly to users.)

Note: For the Users page to be active, you must select an "Enable edit of user role membership" option. Tolocate it, select the Administration tab, and then the Roles tab on the Administration page. If this option is notselected, the Users page is read-only.

To add a user:

1. Select Add User.2. In a Search field, select the value Users or types of role in any combination and enter at least three characters. The

search returns values including items of the type you selected, whose names contain the characters you entered.3. Select a user or role. If you select a user, click Add User to Role. If you select a role, click Add Selected Users; this

adds all its assigned users to the role you are creating.

The Users page lists all selected users. You can delete a user. You may, for example, have added all the users associatedwith a role. If you want to assign your new role only to some of them, you must delete the rest. To delete a user, click its xicon.

285


Copying and Editing RolesRather than create a role from scratch, you can copy a role, then edit the copy to create a new role. Or you can edit existingcustom roles.

Note: Do not edit roles delivered by Oracle.

Initiate a copy or an edit from the Roles tab in the Security Console. Do either of the following:

• Create a visualization graph and select any role in it. Right-click and select Copy Role or Edit Role.

• Generate a list of roles in the Search Results column of the Roles page. Select one of them, and click its menu icon.In the menu, select Copy Role or Edit Role.

If you are copying a role, select one of two options in a Copy Option dialog:

• Copy role: You copy only the role you have selected. The source role has links to roles in its hierarchy, and the copyinherits links to the original versions of those roles. If you select this option, subsequent changes to the inheritedroles affect not only the source highest role, but also your copy.

• Copy role and inherited roles: You copy not only the role you have selected, but also all of the roles in itshierarchy. Your copy of the highest role is connected to the new copies of subordinate roles. If you select this option,you insulate the copied role from changes to the original versions of the inherited roles.

Next, an editing train opens. You follow the same process in editing a role as you would to create one. However, note thefollowing:

• In the Basic Information page, a Predefined role box is checked if you selected the Edit Role option for a roleshipped by Oracle. In that case, you can:

◦ Add custom data security policies. Modify or remove those custom data security policies.

◦ Add or remove users if the role is a job, abstract, or discretionary role.

You cannot:

◦ Modify, add, or remove function security policies.

◦ Modify or remove data security policies provided by Oracle.

◦ Modify the role hierarchy.

The Predefined role check box is cleared if you are editing a custom role or if you have copied a role. In that case,you can make any changes to role components.

• By default, the name and code of a copied role match the source role's, except a prefix, suffix, or both areappended. In the Roles Administration page, you can configure the default prefix and suffix for each value.

• A copied role cannot inherit users from a source job or abstract role. You must select users for the copied role. (Theymay include users who belong to the source role.)

• When you copy a role, the Role Hierarchy page displays all roles subordinate to it. However, you can add roles onlyto, or remove them from, the highest role you copied.

To monitor the status of a role-copy job, select the Administration tab, and then the Role Copy Status tab of theAdministration page.

286


Copying a Top RoleWhen you copy a role on the Security Console, you select one of the following options:

• Copy top role

• Copy top role and inherited roles

If you select the Copy top role option, then only the top role from the selected role hierarchy is copied. Memberships arecreated for the copy in the roles of which the original is a member. That is, the copy of the top role references the inheritedrole hierarchy of the source role. Any changes made to those inherited roles appear in both the source role and the copy.Therefore, you must take care when you edit the role hierarchy of the copy. You can:

• Add roles directly to the copy without affecting the source role.

• Remove any role from the copy that it inherits directly without affecting the source role. However, if you remove anyrole that's inherited indirectly by the copy, then any role that inherits the removed role's parent role is affected.

• Add or remove function and data security privileges that are granted directly to the copy of the top role.

If you copy a custom role and edit any inherited role, then the changes affect any role that inherits the edited role.

The option of copying the top role is referred to as a shallow copy, where the copy references the same instances of theinherited roles as the source role. No copies are made of the inherited roles.

The option of copying the top role is referred to as a shallow copy. This figure summarizes the effects of a shallow copy.It shows that the copy references the same instances of the inherited roles as the source role. No copies are made of theinherited roles.

You're recommended to create a shallow copy unless you must make changes that could affect other roles or that youcouldn't make to predefined roles. To edit the inherited roles without affecting other roles, you must first make copies of thoseinherited roles. To copy the inherited roles, select the Copy top role and inherited roles option.

Tip: The Copy Role: Summary and Impact Report page provides a useful summary of your changes. Reviewthis information to ensure that you haven't accidentally made a change that affects other roles.

Copy a Top Role and the Inherited RolesSelecting Copy top role and inherited roles is a request to copy the entire role hierarchy. These rules apply:

• Inherited aggregate privileges are never copied. Instead, membership is added to each aggregate privilege for thecopy of the source role.

• Inherited duty roles are copied if a copy with the same name doesn't already exist. Otherwise, membership is addedto the existing copies of the duty roles for the new role.

When inherited duty roles are copied, custom duty roles are created. Therefore, you can edit them without affecting otherroles. Equally, changes made subsequently to the source duty roles don't appear in the copies of those roles. For example,if those duty roles are predefined and are updated during upgrade, then you may have to update your copies manually afterupgrade.

This option is referred to as a deep copy, where copies of the inherited duty roles with the same name don't already exist.Therefore, the inherited duty roles are copied when you copy the top role. Aggregate privileges are referenced from the newrole.

287


Copying Job and Abstract RolesYou can copy any job role or abstract role and use it as the basis for a custom role. Copying roles is more efficient thancreating them from scratch, especially if your changes are minor.

1. On the Roles tab of the Security Console, search for the role to copy.2. Select the role in the search results. The role hierarchy appears in tabular format by default.

Tip: Tip: Click the Show Graph icon to show the hierarchy in graphical format.

3. In the search results, click the down arrow for the selected role and select Copy Role.4. In the Copy Options dialog box, select a copy option.5. Click Copy Role.6. On the Copy Role: Basic Information page, review and edit the Role Name, Role Code, and Description values,

as appropriate.

Tip: The role name and code have the default prefix and suffix for copied roles specified on the Rolessubtab of the Security Console Administration tab. You can overwrite these values for the role that you'recopying. However, any roles inherited by the copied role are unaffected by any name changes that youmake on the Copy Role: Basic Information page.

7. Click the Summary and Impact Report train stop.8. Click Submit and Close, then OK to close the confirmation message.9. Review the progress of your copy on the Role Copy Status subtab of the Security Console Administration tab. Once

the status is Complete, you can edit the copied role.

If you prefer, you can visit the intermediate train stops after the Copy Role: Basic Information page and edit yourcopy of the role before you save it.

Editing Job and Abstract RolesYou can create a role by copying a predefined job role or abstract role and editing the copy.

Note: It is not recommended to create job or abstract roles from scratch in the Public Sector Compliance andRegulation services, except for any custom roles specifically documented in Functional Setup Manager. Copyexisting roles and modify as needed.

1. On the Roles tab of the Security Console, search for and select your custom role.2. In the search results, click the down arrow for the selected role and select Edit Role.3. On the Edit Role: Basic Information page, you can edit the role name and description, but not the role code.4. Click Next.

On the Edit Role: Functional Security Policies page, any function security privileges granted to the copied role appear on thePrivileges tab. Select a privilege to view details of the code resources that it secures in the Details section of the page.

To remove a privilege from the role, select the privilege and click the Delete icon. To add a privilege to the role:

1. Click Add Function Security Policy.2. In the Add Function Security Policy dialog box, search for and select a privilege or role.3. If you select a role, then click Add Selected Privileges to add all function security privileges from the selected role

to your custom role. If you select a single privilege, then click Add Privilege to Role.

288


4. Click OK to close the confirmation message.5. Repeat from step 2 for additional privileges.6. Close the Add Function Security Policy dialog box.7. Click Next.

Note: If a function security privilege forms part of an aggregate privilege, then add the aggregate privilege to therole hierarchy. Don't grant the function security privilege directly to the role. The Security Console enforces thisapproach.

The Resources tab, which is read-only, lists any resources granted to the role directly rather than through function securityprivileges. As you can't grant resources directly to roles on the Security Console, only resource grants created before Release12 could appear on this tab. You can't edit these values.

Make no changes on the Copy Role: Data Security Policies page.

Note: Whether this page is enabled for edit depends on the current setting of the Enable edit of data securitypoliciesoption. Set this option on the Roles subtab of the Security Console Administration tab.

Click Next.

The Edit Role: Role Hierarchy page shows the copied role and its inherited aggregate privileges and duty roles. The hierarchyis in tabular format by default. You can add or remove roles.

To remove a role:

1. Select the role in the table.2. Click the Delete icon.3. Click OK to close the confirmation message.

To add a role:

1. Click the Add Role icon.2. In the Add Role Membership dialog box, search for and select the role to add.3. Click Add Role Membership.4. Click OK to close the confirmation message.5. Repeat from step 2 for additional roles.6. Close the Add Role Membership dialog box.

The Edit Role: Role Hierarchy page shows the updated role hierarchy.7. Click Next.

To provision the role to users, you must create a role mapping. Don't provision the role to users on the Security Console.

Note: Whether this page is enabled for edit depends on the current setting of the Enable edit of user rolemembershipoption. Set this option on the Roles subtab of the Security Console Administration tab.

Click Next.

Copying and Editing Duty RolesYou can copy a duty role and edit the copy to create a duty role. Copying duty roles is the recommended way of creatingduty roles.

1. On the Roles tab of the Security Console, search for the duty role to copy.

289


2. Select the role in the search results. The role hierarchy appears in tabular format by default.

Tip: Click the Show Graph icon to show the hierarchy in graphical format.3. In the search results, click the down arrow for the selected role and select Copy Role.4. In the Copy Options dialog box, select a copy option.5. Click Copy Role.6. On the Copy Role: Basic Information page, edit the Role Name, Role Code, and Description values, as

appropriate.

Tip: The role name and code have the default prefix and suffix for copied roles specified on the Roles subtab ofthe Security Console Administration tab. You can overwrite these values for the role that you're copying. However,any roles inherited by the copied role are unaffected by any name changes that you make on the Copy Role: BasicInformation page.

7. Click the Summary and Impact Report train stop.8. Click Submit and Close, then OK to close the confirmation message.9. Review the progress of your copy on the Role Copy Status subtab of the Security Console Administration tab. Once

the status is Complete, you can edit the copied role

To edit the role:

1. On the Roles tab of the Security Console, search for and select your copy of the duty role.2. In the search results, click the down arrow for the selected role and select Edit Role.3. On the Edit Role: Basic Information page, you can edit the role name and description, but not the role code.4. Click Next.

On the Edit Role: Functional Security Policies page, any function security privileges granted to the copied role appear on thePrivileges tab. Select a privilege to view details of the code resources that it secures.

To remove a privilege from the role, select the privilege and click the Delete icon. To add a privilege to the role:

1. Click Add Function Security Policy.2. In the Add Function Security Policy dialog box, search for and select a privilege or role.3. If you select a role, then click Add Selected Privileges to grant all function security privileges from the selected role

to your custom role. If you select a single privilege, then click Add Privilege to Role.4. Click OK to close the confirmation message.5. Repeat from step 2 for additional privileges.6. Close the Add Functional Security Policies dialog box.7. Click Next.

Note: If a function security privilege forms part of an aggregate privilege, then add the aggregate privilege to therole hierarchy. Don't grant the function security privilege directly to the role. The Security Console enforces thisapproach.

The Resources tab, which is read-only, lists any resources granted to the role directly rather than through function securityprivileges. As you can't grant resources directly to roles on the Security Console, only resource grants created before Release12 could appear on this tab. You can't edit these values.

Make no changes on the Edit Role: Data Security Policies page.

Note: Whether this page is enabled for edit depends on the current setting of the Enable edit of data securitypoliciesoption. Set this option on the Roles subtab of the Security Console Administration tab.

Click Next.

290


The Edit Role: Role Hierarchy page shows the copied duty role and any duty roles and aggregate privileges that it inherits.The hierarchy is in tabular format by default. You can add or remove roles.

To remove a role:

1. Select the role in the table.2. Click the Delete icon.3. Click OK to close the information message.

To add a role:

1. Click Add Role.2. In the Add Role Membership dialog box, search for and select the role to add.3. Click Add Role Membership.4. Click OK to close the confirmation message.5. Repeat from step 2 for additional roles.6. Close the Add Role Membership dialog box.

The Edit Role: Role Hierarchy page shows the updated role hierarchy.7. Click Next.

On the Edit Role: Summary and Impact Report page, review the summary of changes. Click Back to make corrections.Otherwise:

1. Click Save and Close to save the role.2. Click OK to close the confirmation message.

The role is available immediately.

Managing Data Security Policies This topic provides an overview of data security and discusses concepts related to how you secure data by provisioning rolesthat provide the necessary access.

Comparing Function Security and Data SecurityFunction security is a statement of what actions you can perform in which user interface pages.

Data security is a statement of what action can be taken against which data.

Function security controls access to user interfaces and actions needed to perform the tasks of a job. For example, anaccounts payable manager can view invoices. The Accounts Payable Manager role provisioned to the accounts payablemanager authorizes access the functions required to view invoices.

Data security controls access to data. In this example, the accounts payable manager for the North American CommercialOperation can view invoices in the North American Business Unit. Since invoices are secured objects, and a data roletemplate exists for limiting the Accounts Payable Manager role to the business unit for which the provisioned user isauthorized, a data role inherits the job role to limit access to those invoices that are in the North American Business Unit.Objects not secured explicitly with a data role are secured implicitly by the data security policies of the job role.

Both function and data are secured through role-based access control.

291


Implementing Data SecurityBy default, users are denied access to all data.

Data security makes data available to users by the following means.

• Policies that define grants available through provisioned roles

• Policies defined in application code

You secure data by provisioning roles that provide the necessary access.

Note: Public Sector Compliance and Regulation does not employ the use of data roles.

When you provision a job role to a user, the job role limits data access based on the data security policies of the inheritedduty roles. When you provision a data role to a user, the data role limits the data access of the inherited job role to adimension of data.

Data security consists of privileges conditionally granted to a role and used to control access to the data. A privilege is asingle, real world action on a single business object. A data security policy is a grant of a set of privileges to a principal onan object or attribute group for a given condition. A grant authorizes a role, the grantee, to actions on a set of databaseresources. A database resource is an object, object instance, or object instance set. An entitlement is one or more allowableactions applied to a set of database resources.

Data security features include:

• Data security policy: Defines the conditions in which access to data is granted to a role.

• Role: Applies data security policies with conditions to users through role provisioning.

The sets of data that a user can access are defined by creating and provisioning roles. Oracle data security integrates withOracle Platform Security Services (OPSS) to entitle users or roles (which are stored externally) with access to data. Users aregranted access through the privilege assigned to the roles or role hierarchy with which the user is provisioned. Conditions areWHERE clauses that specify access within a particular dimension, such as by business unit to which the user is authorized.

Data Security PoliciesData security policies articulate the security requirement "Who can do what on which set of data."

For example, accounts payable managers can view AP disbursements for their business unit.

A data security policy is a statement in a natural language, such as English, that typically defines the grant by which a rolesecures business objects. The grant records the following.

• Table or view

• Entitlement (actions expressed by privileges)

• Instance set (data identified by the condition)

For example, disbursement is a business object that an accounts payable manager can manage by payment function for anyemployee expenses in the payment process.

Note: Some data security policies are not defined as grants but directly in applications code. The securityreference manuals for Oracle Fusion Applications offerings differentiate between data security policies that definea grant and data security policies defined in Oracle Fusion applications code.

292


A data security policy identifies the entitlement (the actions that can be made on logical business objects or dashboards),the roles that can perform those actions, and the conditions that limit access. Conditions are readable WHERE clauses. TheWHERE clause is defined in the data as an instance set and this is then referenced on a grant that also records the tablename and required entitlement.

Working with Database Resources and Data Security PoliciesA data security policy applies a condition and allowable actions to a database resource for a role. When that role isprovisioned to a user, the user has access to data defined by the policy. In the case of the predefined security referenceimplementation, this role is always a duty role.

The database resource defines an instance of a data object. The data object is a table, view, or flexfield.

The following figure shows the database resource definition as the means by which a data security policy secures a dataobject. The database resource names the data object. The data security policy grants to a role access to that databaseresource based on the policy's action and condition.

A database resource specifies access to a table, view, or flexfield that is secured by a data security policy.

• Name providing a means of identifying the database resource

293


• Data object to which the database resource points

Note: If the data security policy needs to be less restrictive than any available database resource for a dataobject, define a new data security policy.

Actions correspond to privileges that entitle kinds of access to objects, such as view, edit, or delete. The actions allowed by adata security policy include all or a subset of the actions that exist for the database resource.

A condition is either a SQL predicate or an XML filter. A condition expresses the values in the data object by a searchoperator or a relationship in a tree hierarchy. A SQL predicate, unlike an XML filter, is entered in a text field in the data securityuser interface pages and supports more complex filtering than an XML filter, such as nesting of conditions or sub queries. AnXML filter, unlike a SQL predicate, is assembled from choices in the UI pages as an AND statement.

Note: An XML filter can be effective in downstream processes such as business intelligence metrics. A SQLpredicate cannot be used in downstream metrics.

Creating Custom Roles for the Permits Service This topic describes how to create custom roles required to enable design-time and runtime access for various features ofthe permit service. These custom roles are required for permits, and they are not delivered, predefined roles. They must becreated manually.

In this task you need to create the following roles in the Security Console exactly as they appear in the following table.

Note: The Role Category for Public Sector Compliance and Regulation roles is Financials - Job Roles.

Role Code Role Name Description

CUSTOM_PSC_MANAGE_PERMITS

PSC Custom Manage Permits

Allows users to apply for permits and updatepermits.

CUSTOM_PSC_VIEW_PERMITS

PSC Custom View Permits

Allows users to view the permit detail tab inthe permits application.

CUSTOM_PSC_APPLY_PERMITS_DATA

PSC Custom Permit Applicant Data Access

Allows users to apply for permits and updatetheir own permits in while in the status ofpending.

CUSTOM_PSC_REGISTERED_PUBLIC_USER

PSC Custom Registered Public User

Custom role for grouping all the registeredpublic user access.

294


Role Code Role Name Description

Note:While creating theCUSTOM_PSC_REGISTERED_PUBLIC_USERrole, in the Role Hierarchy tabadd as child roles the deliveredrole, PSC Registered PublicUser, and these custom roles:CUSTOM_PSC_MANAGE_PERMITS,CUSTOM_PSC_VIEW_PERMITS, andCUSTOM_PSC_APPLY_PERMITS_DATA

CUSTOM_PSC_MANAGE_PERMITS_AGENCY

PSC Custom Permit Data Access for Agency

Allows users to apply for permits and updatepermits that have not been closed.

Note:While creating theCUSTOM_PSC_MANAGE_PERMITS_AGENCYrole, in the Role Hierarchy tab addas child roles these custome roles:CUSTOM_PSC_MANAGE_PERMITSand CUSTOM_PSC_VIEW_PERMITS.

Creating Roles for Permit AccessTo create a role:

1. Navigate to the Security Console.2. On the Roles tab of the Security Console, click Create Role.3. On the Create Role: Basic Information page, enter the role's display name in the Role Name field.

This is the label for the role displayed in the interface when implementation teams set up security. Use the rolename listed in the previous table. For example, enter PSC Custom Manage Permits or PSC Custom View Permits,depending on the role you are creating.

4. In the Role Code field enter exactly the role code value of the role you are creating, as it appears in the previoustable.

For example, enter CUSTOM_PSC_MANAGE_PERMITS.5. In the Role Category field, select Financials - Job Roles.6. Review the table above, and only for those roles that will contain child roles, click the Role Hierarchy tab, and add

the child roles specified in the table above.7. Save your changes.8. When setting up security assignments for your user profiles, assign the roles to all of the appropriate users in the

system to ensure the necessary access to permits.

See the following section for details.

For more information on using the Security Console, see Working with Roles in the Security Console.

For information on configuring security assignments for agency staff users, see Managing Agency Staff Profiles.

295


For information on configuring security assignments for public users, see Setting Up Public User Roles.

Assigning RolesYou assign roles to users in the system using delivered setup pages. For public users, you use the Public User Roles pageand for agency staff members, you use the Agency Staff Access page.

User Type Role Assignments Setup Page

Anonymous User

This is the default access available to allusers, including users who have not signedin. You do not assign roles to this user type.

None.

Registered Public User

CUSTOM_PSC_REGISTERED_PUBLIC_USER

Public User Roles page

System Administrator

• PSC Agency Staff

• PSC System Administrator

• Custom Objects Administration (Thisrole will be available for assignmentonly after the first permit type iscreated.)


• CUSTOM_PSC_MANAGE_PERMITS_AGENCY

• Create the user with the Agency Staffpage.

• Add roles using the Agency StaffAccess page.

Business Analyst


• PSC Business Analyst






Branding Administrator


• PSC System Administrator





296


User Type Role Assignments Setup Page

• Application Implementation Consultant

• PSC Registered Public User


Note:Typically, it is not recommended toassign PSC Registered Public Userto any of the agency staff users,including the administrators. This userconfiguration should be used only forcompleting branding activities, such asupdating themes and menu navigation.If the same user is required to performany of the permit related transactionsor setup, then the PSC RegisteredPublic User role should be removedfrom the user.

Other agency staff members (such asPermit Technician, Building Inspector, PlanReviewer, and so on).



• <Specific Job Role> (such as PSCPermit Technician, PSC Plan Reviewer,and so on)



Adding Roles to Agency Users for Creating Permit TypesUsers requiring administrative access to create permit types need to be assigned these roles:

• CUSTOM_PSC_MANAGE_PERMITS_AGENCY (which includes CUSTOM_PSC_MANAGE_PERMITS andCUSTOM_PSC_VIEW_PERMITS)

• ORA_CRM_EXTN_ROLE (This role will be available for assignment only after the first permit type is created.)

• ORA_FND_IT_SECURITY_MANAGER_JOB

• ORA_ASM_APPLICATION_IMPLEMENTATION_CONSULTANT_JOB

Related Topics

• Managing Roles in Public Sector Compliance and Regulation


• Managing Agency Staff Profiles

• Setting Up Public Users

• Setting Up Public User Roles

297


298

Implementing Oracle Public Sector Permits Chapter 18Configuring Oracle Policy Automation

18 Configuring Oracle Policy Automation

Overview of Oracle Policy Automation Configuration This topic provides an overview of how Oracle Policy Automation is used within Public Sector Compliance and Regulation andhow it is configured.

If your site already has an installation of Oracle Policy Automation, you can integrate its functionality with the permits service.The policy models created in Oracle Policy Automation can act as the logic models running behind questionnaires thatcitizens fill out to determine which permits they need to apply for depending on the nature of the project they are planning.

The topics in this chapter describe the setup pages that an administrator would view and use to configure the mapping ofmetadata between the permits service and the Oracle Policy Automation application.

Note: Most of the data displayed on the pages within the Policy Modeling menu folder are read-only. Inthe current release, you do not create or update the definitions such as entity models, metadata models, orenumerations. These definitions are provided for your implementation in the form of delivered seed data. Thisdocumentation is provided to describe the visible information related to the policy modeling feature. Only theMetadata Models page contains fields that can be updated.

Setting Up Entity Models This topic describes the settings used to configure entity models used when implementing Oracle Policy Automation for usewith the permits application.

Adding an Entity Model


1. Select Policy Modeling > Entity Models .2. Click Add.3. On the Entity Model Details page, enter these values:


Name

Enter a name to identify the model within the application.

Description

Provide additional information regarding the purpose of the model.

Enabled Use to enable or disable a model by turning the control on or off.

299



4. Click Add in the Entities grid.5. On the Entity Details page, enter these values:


Name

Name of the entity.

Description

Additional information to identify the entity and describe its purpose.

Hidden from Policy Modeling

If set to true, then this entry will not be present in the Get MetaData response to OraclePolicy Automation.

Top-Level Entity

Indicates if the object is the highest level entity object.

Policy Modeling Name

The functional name for an entity or attribute as it appears within Oracle Policy Automation.

Use as Mapped in Entity

Defines if the entity object can be selected as an input entity.

Use as Mapped Out Entity

Determines if the entity object can be selected as an output entity.

Parent Entity Name

The name of the parent entity object of a child object.

Cardinality with Parent Entity

Indicates the cardinality relationship with the parent entity object, such as one-to-one, one-to-many, many-to-one, or many-to-many.

Policy Modeling RelationshipName

The name of the relationship between two entities as it appears in Oracle Policy Automation.

Supports Attachment

Determines if attachments can be collected for rows of the entity object.

6. Click Add in the Entity Attributes grid to add attributes for the entity.7. On the Entity Attribute Details page, enter these values:


Name

The system name of the entity attribute.

Data Type

The data type of the attribute as it is defined in Oracle Policy Automation. For example:

◦ java.lang.String

◦ java.lang.Long

Primary Key

The primary key of the underlying view object.

Policy Modeling Name

The functional display name for an entity or attribute as it appears in Oracle PolicyAutomation.

300



Hidden from Policy Modeling

If set to true, then this entry will not be present in the Get MetaData response to OraclePolicy Automation.

Mandatory

Determines if the field must be mapped from an attribute in a policy model.

Policy Modeling Data Type

Describes the data type of the field defined in Oracle Policy Automation. It must be specifiedif no enumeration-type attribute is provided, and it cannot be specified if an enumeration-type attribute is provided. Options are:

◦ String

◦ Boolean

◦ Decimal

◦ Date

◦ Date-time

◦ Time-of-day

Use as Mapped In Attribute

Determines if the field can mapped from an attribute for the purpose of submitting data.

Use as Mapped Out Attribute

Determines if the field can mapped from an attribute for the purpose of submitting data.

Default Value

Enter a default value for this attribute. If added, the application includes the value in the loadresponse to Oracle Policy Automation.

Enumeration Name

Specifies the ID of the enumeration that defines a field's data type.

8. Click Save.9. Click Save on the Entity Details page.

10. Click Save on the Entity Model Details page.

Setting Up Metadata Models This topic describes how to set up Oracle Policy Automation metadata models and define entity relationships.


To set up Oracle Policy Automation metadata models:

1. Select Policy Modeling > Metadata Models .

301


2. Click Add for the Metadata Models grid.3. On the Metadata Models Details page, add enter these values:

Note: You can update the following fields for a metadata model definition: Supports Policy ModelingCheckpoints, Anonymous Users Can Save Data, and Active Model. By default these fields areturned-off. You can turn them on according to your business requirements.


Name

Enter the functional display name of the metadata model.

Description

Provide additional description to identify the purpose of the metadata model.

Supports Policy ModelingCheckpoints

Turn on to indicate that the metadata model is designed to support checkpoints.

Anonymous Users Can Save Data

Turn on to enable the anonymous (non-signed-in user) to save data.

Active Model

Turn on to activate or deactivate the model.

4. Click Add for the Metadata Entity Relationships grid, and enter these values:


Name

Enter the entity relationship name.

Mark as Global Entity

Turn on if the entity is global.

Cardinality with Global Entity

Indicate the cardinality with the global entity (one-to-many, many-to-one, and so on).


The name of the relationship between two entities as it defined within in Oracle PolicyAutomation.

5. Click Add for the Metadata Entity Links grid, and enter these values:


Source Entity Policy ModelingName

Represents the policy modeling name for the entity in the source entity model.

Target Entity Model Name

Enter the target entity model.

Target Entity Policy ModelingName

Represents the policy modeling name for the entity in the target entity model for this link.

Description

Provide any additional details to describe the purpose of metadata entity link.

302



Cardinality with Target Entity

Indicate the cardinality with the target entity (one-to-many, many-to-one, and so on).



6. Click Save.7. Click Save on the Metadata Entity Relationship Details page.8. Click Save on the Metadata Model Details page.

Setting Up Enumerations This topic describes how to configure enumerations for policy modeling. An enumeration is a tool for managing lists ofpotential values for a non-boolean attribute in your policy model. Enumeration are also referred to as value lists.


To add an enumeration:

1. Select Policy Modeling > Enumerations .2. On the Enumerations page, click Add.3. On the Enumerations Details page, enter these values:


Enumeration Name

The functional display name of the enumeration.

Enumeration Type

The data type of the enumeration, such as:

◦ String

◦ Number

◦ Boolean

◦ Time

Description

Provide additional information to help describe the purpose of the enumeration.

Child Enumeration Name

Specify the name of a linked child enumeration, as needed.

4. Click Add for the Enumeration Values grid.5. On the Enumeration Value Details page, enter these values:

303



Enumeration Value

Enter the function display name of the enumeration value.

Description

Provide additional information to describe the purpose of the enumeration value.

6. Click Add for the Child Enumeration Values grid for any child enumeration values.


Child Enumeration Value

Enter the function display name of the child enumeration value.

Description

Provide additional information to describe the purpose of the child enumeration value.

7. Click Save.8. Click Save on the Enumeration Value Details page.9. Click Save on the Enumeration Details page.

Mapping Enumerations to Metadata Models This topic describes how to map defined enumerations to existing metadata models.


To map an enumeration to a metadata model:

1. Select Policy Modeling > Enumeration Mapping.2. Click Add for the Metadata Models grid.3. On the Metadata Models Details page, enter the name of the existing metadata model to which you want to map the

enumeration.

Note: Once added, the remaining attributes, such as Supports Policy Modeling Checkpoints, are readfrom the metadata model definition.

4. Click Add for the Metadata Entity Relationships grid.5. On the Metadata Entity Relationship Details page, enter these values:


Name

Enter a name for the relationship.

Mark as Global Entity

Indicates if this is a global entity for this metadata model.

304



Cardinality with Global Entity

Specify the cardinality relationship that this entity has with the global entity identified for thismetadata model, such as one-to-one, one-to-many, and so on.



6. Click Add for the Metadata Entity Links grid.7. On the Metadata Entity Link Details page, enter these values:


Source Entity Policy ModelingName

Enter the policy modeling name for the entity in the source entity model for this link.

Target Entity Model Name

Enter the target entity model for this link.

Target Entity Policy ModelingName

Enter the policy modeling name for the entity in the target entity model for this link.

Description

Provide any additional information to describe the purpose of this metadata entity link.

Cardinality with Target Entity

Specify the cardinality relationship that this entity has with the target entity model nameidentified for this metadata link, such as one-to-one, one-to-many, and so on.



8. Click Save.9. Click Save on the Metadata Entity Relationship Details page.

10. Click Save on the Metadata Model Details page.

Related Topics

• Setting Up Metadata Models

• Setting Up Enumerations

Managing Proxy Users This topic describes how to manage proxy users for enabling integration between Oracle Policy Automation and your PublicSector Compliance and Regulation service.

Oracle Policy Automation connects to your Public Sector Compliance and Regulation service through a provided web serviceconnector named pscOpaWSConnector.

305


This connector requires proper WS-Security credentials to handle the transactions between the Public Sector Complianceand Regulation service and the Oracle Policy Automation service.

When configuring the connection within the OPA hub, in the WS-Security section of the New Connection page, a user ID andpassword is required.

The user ID entered must have the following role within their role hierarchy:

PSC Oracle Policy Automation Proxy User (ORA_PSC_OPA_PROXY_USER_DUTY)

This duty role contains the following privilege:

Access Oracle Policy Automation Web Service Connector Privilege (PSC_OPA_WSC_PRIV)

This privilege allows the proxy user to integrate Oracle Policy Automation with your Public Sector Compliance and Regulationservice.

By default, the delivered SYSTEM_ADMIN has the PSC System Administrator job role, which inherits the PSC Oracle PolicyAutomation Proxy User duty role. Any custom (cloned) role or created user must have PSC Oracle Policy Automation ProxyUser duty role if you intend to use that user ID as the proxy user for the Oracle Policy Automation WS-Security credentials.

Related Topics


• Managing Roles in Public Sector Compliance and Regulation

Managing OPA Hub Administrators set up the Oracle Policy Automation required to integrate with Public Sector Compliance and Regulationservices.

OPA Setup for Integrating with Public Sector Compliance and RegulationThis is a two-step process:

1. Authorizing Embedded Interviews2. Creating Connections

Authorizing Embedded Interviews1. Log in to the Policy Automation Hub web interface with the user credentials of Deploy Admin.2. Click the Deployment tile to open the Deployment page. The page lists all the projects currently deployed. Click

Actions and select the Authorize Embedded Interviews button to open the Authorize Hosts page.3. On the Authorize Hosts page, click the Add a Host Address button and enter the Public Sector Compliance and

Regulation application host address in the Host address field.4. Click Apply.

Creating Connections1. Log in to the Policy Automation Hub web interface with the user credentials of Deploy Admin.2. Click the Connections button on the banner to open the Connections page.

306


3. On the Connections page, click the Actions drop-down menu and select Create a new Connection option to openthe New Connection page and enter values for the various fields:


Name

Enter a name for the connection.

Type

Select Web service.

Collection Access

Select the collection that you have created, to gain access to the connection. Click Allow. The default value for this field is Default Collection. You can include any additionalcollections that you want to allow access to.

URL

Enter the URL of the connector, which is deployed with other services – the FSCM base URIfrom the topology manager. Append the below string to the URL of the connector as shownhere: <FSCM base URI>/fscmPojoService/pscOpaWSConnector?MDMN=OPAResult

Use Custom Certificate (optional)

Select to use a custom certificate defined in Policy Automation Hub. These customcertificates will be recognized by outbound https calls made by a Policy Automation site. Ifnot selected, the connection will only trust the built-in root certificates.

Version

Select the following web service version: http://xmlns.oracle.com/policyautomation/hub/12.2.5/metadata/types

SOAP ActionPattern (optional)

Specify the soap:operation soapAction name expected by the web service.

OAUTH for Data Operations:


Provide OAUTH bearer token inHTTP header on Load and Saveactions

Select to allow you to enter a URL parameter and enter the value jwt in the URL Parameterfield. The token's value is passed by specifying the parameter in the query string of the interview'sstartsession URL. This value is then passed to the Web Service connector as an OAuth 2.0HTTP Authorization header whenever a Load or Save request is sent.

WS-Security:


Provide WS-Security Usernametoken in SOAP actions.

Select the option to allow you to enter values for the fields in the section.

Applies to

Select applies to All.

307



Username

Enter a username for the purpose of connecting securely to the web service. Note that thisis not related to the username of the logged-in Policy Automation Hub user. If you have installed OPA, then as part of the Fusion Onboarding processyou must have created a user having the following OPA proxy user Duty role:ORA_PSC_OPA_PROXY_USER_DUTY. Use the same user name in this field.

New Password

Enter a password.

Include timestamp with a 5 minuteexpiration (optional).

Select to include a timestamp with a validity of 5 minutes. Note: The web service connectortime must be synchronized to OPA server.

4. Click Save and Close to complete the process of creating a new connection.

Managing OPA Policies for Agency This topic describes how to set up OPA Policies for your Agency.

1. Navigate to the Agency Information page.2. Search and select your agency row to open the Agency Information – Details page. Click the Features tab.3. You will see that your offering is enabled; click the Options link on the row to open the Permit Options page.4. On the Permit Options page, under the Oracle Policy Automation Definition section enter a value for:



Enter the deployment name listed in the Deployment page. The Deployment page is wherethe deployment and activation of policy models is managed.

Note:To access the Deployment page, log in to the Policy Automation Hub web interfacewith a user role of Policy Author or Deploy Admin. On the Dashboard page, clickthe deployments tile to open the Deployments page. From the list of all projectscurrently deployed, select the desired deployment name.

5. Click Save.

Note: You must repeat the steps outlined in this topic and in the Setting Up Metadata Models topic when youare moving the content from the Test environment to your Production environment.

308

Permits Implementing Oracle Public Sector · This topic provides the list of required tasks for the...

Documents

Transcript of Permits Implementing Oracle Public Sector · This topic provides the list of required tasks for the...