Document toolboxDocument toolbox

.Full List v2.1.4.7

Owned by Jeremiah Sokolowski
Last updated: Jan 08, 2024 by Bianca Rosa (Unlicensed)Version comment
30 min read

Authorization

AUTH_ADAPTER

(DbTable, ActiveDirectory, Ldap, Shibboleth)

This parameter specifies which of the predefined Authentication Adapters is being used. The default is DbTable (which is the native database for PCR-360).

AUTH_LOGOUT_URL

(URL)

This parameter defines the URL that should be redirected to when logging out of PCR-360. Shibboleth usually has a specific URL to complete the logout. The default is "/core/auth/".

AUTH_DEFAULT_ALLOWED

(true or false)

This parameter controls how the system will treat non-permissioned resources. If a specific resource (a link, page or menu item) is not specifically permissioned to Allow or Deny should the system use Allow by default. The default is true.

AUTH_SESSION_EXPIRATION_SECONDS

(seconds)

This parameter controls the web server session timeout. If no activity is logged in this amount of time then the session will expire. This expiration may or may not affect Single Sign On systems. The default is 5400.

AUTH_SESSION_REMEMBER_SECONDS

(seconds)

This parameter controls the session cookie timeout. It specifies the number of seconds that the cookie will exist after the browser is closed, setting this to zero will expire the cookie as soon as the browser closes. The JITC parameter overrides this setting with 0. The default is 0.

AUTH_IDENTITY

(attribute key)

This parameter is used with ActiveDirectory, Ldap or Shibboleth Authentication Adapters. It specifies the bit in the authentication attributes that is the identity of the user. If this bit is missing then the login will fail. The default is "username".

AUTH_CREATE_USERS

(true or false)

This parameter is used with ActiveDirectory, Ldap or Shibboleth Authentication Adapters. It specifies whether or not to create unknown users that successfully login. It requires that the AUTH_ATTRMAP_ config attributes be present in the authentication attributes. If set to true, new users and contacts will be created as they login. The default is true.

AUTH_UPDATE_USERS

(true or false)

This parameter is used with ActiveDirectory, Ldap or Shibboleth Authentication Adapters. It specifies whether or not to update users and their contact records when they login. It requires that the AUTH_ATTRMAP_ config attributes be present in the authentication attributes. If set to true, existing users and contacts will be updated with new/changing information from the AUTH_ATTRMAP_config attributes when they login. The default is true.

AUTH_ROLEMAPPING

(true or false)

This parameter is used with ActiveDirectory, Ldap or Shibboleth Authentication Adapters. It specifies whether or not the system should try to map roles from the AUTH_ATTRMAP config attributes. It requires that the AUTH_ATTRMAP_GROUPS config attribute be present in the authentication attributes. If set to true, the system will associate the user with any roles that match the mapped groups when they login. This also controls the Authentication Mapping field that appears on the Role screen. This field is not displayed when this parameter is set to false. The default is true for installations that use Ldap or Shibboleth, false otherwise.

AUTH_DEFAULT_ROLE

(role name)

This parameter is used with ActiveDirectory, Ldap or Shibboleth Authentication Adapters. It specifies what the default Role should be when creating users from Ldap or Shibboleth whenever a role is not mapped from AUTH_ROLEMAPPING and AUTH_ATTRMAP_GROUPS. The default is “SysAdmin”.

AUTH_ATTRMAP_USERID

(attribute key)

This parameter is used with ActiveDirectory, Ldap or Shibboleth Authentication Adapters. It specifies what key or index in the authentication attributes that map to the userid when creating a user. The default is “uid”.

AUTH_ATTRMAP_FIRSTNAME

(attribute key)

This parameter is used with ActiveDirectory, Ldap or Shibboleth Authentication Adapters. It specifies what key or index in the authentication attributes that map to the first name when creating a user. The default is "givenname".

AUTH_ATTRMAP_LASTNAME

(attribute key)

This parameter is used with ActiveDirectory, Ldap or Shibboleth Authentication Adapters. It specifies what key or index in the authentication attributes that maps to the last name when creating a user. The default is "surname".

AUTH_ATTRMAP_EMAIL

(attribute key)

This parameter is used with ActiveDirectory, Ldap or Shibboleth Authentication Adapters. It specifies what key or index in the authentication attributes that map to the email when creating a user. The default is "email".  

AUTH_ATTRMAP_PHONE

(attribute key)

This parameter is used with ActiveDirectory, Ldap or Shibboleth Authentication Adapters. It specifies what key or index in the authentication attributes that map to the phone number when creating a user. The default is " telephonenumber".

AUTH_ATTRMAP_GROUPS

(attribute key)

This parameter is used with ActiveDirectory, Ldap or Shibboleth Authentication Adapters. It specifies what key or index in the authentication attributes that map to the Authentication Mapping field on Roles when creating a user. The default is "memberOf".

AUTH_PWD_HISTORY_LENGTH

(integer)

This parameter is used to determine how many passwords we want to keep track of. When set, the user will not be able to reuse a password as long as it is logged; after the limit is reached the oldest password is cleared from the list. The default is 10, to disable this functionality, set this parameter to 0.

AUTH_MIN_PWD_LENGTH

(integer)

This parameter is used to let you decide how long a password must be. The default is 15, to disable this functionality, set this parameter to 0.

AUTH_PWD_EXPIRE

(days)

This parameter is used to let you set how long a password should be valid for. The default value is 60, to disable this functionality, set this parameter to 0.

AUTH_PWD_CHANGE_LIMIT

(days)

This parameter is used to determine how long a user must wait before they can change their password. The default is 1, to disable this functionality, set to 0.

PWD_DICTIONARY_CHECK

(true or false)

This parameter determines if you wish to check a password against a list of words found on a dictionary file. The default is false.

DICTIONARY_FILE_PATH

(string)

This is the path to the dictionary file we wish to check against. The default is '/usr/share/dict/words'. Be sure to consult with the documentation for your version of Linux to see where their dictionary file is located. You can also use your own dictionary file if you so desire or in case a dictionary file is not bundled with your version of Linux.

PWD_DIFF_THRESHOLD

(integer)

This parameter determines how many characters must be different from the current password when creating a new password. The default is 4, to disable this functionality, set to 0.

AUTH_PWD_REQ_LALPHA

(true or false)

This parameter determines if a password has to contain a lower case letter. If any other password format rule is enabled, it will append to the enabled rules. The default is false.

AUTH_PWD_REQ_UALPHA

(true or false)

This parameter determines if a password has to contain an upper case letter. If any other password format rule is enabled, it will append to the enabled rules. The default is false.

AUTH_PWD_REQ_NUMBER

(true or false)

This parameter determines if a password has to contain a number. If any other password format rule is enabled, it will append to the enabled rules. The default is false.

AUTH_PWD_REQ_SPECIAL_CHAR

(true or false)

This parameter determines if a password has to contain a special character. If any other password format rule is enabled, it will append to the enabled rules. The default is false.

AUTH_THRESHOLD_BADPASSWORD

(count)

This parameter determines the number of failed login attempts with in a specific time frame before accounts are disabled. Set to false to disable this threshold. The default is 5.

AUTH_BADPASSWORD_TIMEFRAME

(seconds)

This parameter determines the time frame between bad password attempts required to disable the account. The default is 3600 (1 hour).

MAX_USER_SESSIONS

(integer)

This parameter is used to determine how many sessions one user can have open at any given time. The default value is 3, to allow an unlimited number of user sessions set this parameter to BOOLEAN_FALSE

MAX_TOTAL_SESSIONS

(integer)

This parameter is used to determine how sessions can be open in the application at any given time. The default value is BOOLEAN_FALSE which allows an unlimited number of sessions. Set this value to an integer to limit the total number of sessions

AUTH_THRESHOLD_LOGINFAILED

(count)

This parameter controls the number of login attempts from the same IP address that will trigger a block on that IP address, set to false to disable this check. The default is 100.

AUTH_ACCOUNT_EXPIRE_SECONDS

(seconds)

This parameter defines the number of seconds after creation/reactivation when accounts expire, expired accounts are set to inactive, if expired, activating an account will restart the expiration date, false for no account expiration. The default is false.


[Table of Contents]


Backend Content

BACKEND_HEADTITLE

(plain text)

This parameter is the application title displayed in the browser header or browser tab. The default is "PCR-360".

BACKEND_LOGIN_HDR_RIGHT

(plain text)

This parameter is the header text on the login page to the right of the Username/Password fields. This only applies to systems that do not use single sign-on authentication like Shibboleth. The default is "Need Help?"

BACKEND_LOGIN_PARAGRAPH_RIGHT

(html text)

This parameter is the paragraph text on the login page to the right of the Username/Password fields. This only applies to systems that do not use single sign-on authentication like Shibboleth. The default is "If you need assistance or have any questions, please contact help@pcr.com or visit the PCR-360 User Guide"

BACKEND_HOMEPAGETITLE

(plain text)

This parameter is the text displayed at the top of the back-end homepage. The default is "Welcome to PCR-360".


[Table of Contents]


Billing

BILL_DAY_OF_MONTH_START

(day of the month)

This is the default day of the month that will be pre-populated in the date fields when generating a bill. There is also a Tenant specific override for this parameter called Default Bill Day of Month. The default is 1.

BILL_ZERO_COST

(true of false)

This parameter specifies whether the bill process will or will not include zero cost items in the bill. Specifying True will cause zero cost items to show up in the bill and False will exclude them. The default is True.

BILL_MRC_CHANGE_FORCE_PRORATE

(true or false)

This parameter specifies whether a monthly recurring charge that has been changed (stopped and started with a new charge) should be prorated even if the charge catalog item is not set to be prorated. The default is False.

BILLING_ROUND_METHOD

(options: ceil, floor, roundup or rounddown)

During billing the process sometimes needs to round amounts. When this happens there are 4 (four) types of rounding that can be used:

  • Ceil – (Ceiling) a mathematical form of rounding that always goes up to the nearest whole number.
  • Floor – a mathematical form of rounding that always goes down to the nearest whole number.
  • Roundup – typical rounding method to round everything above .5 up and everything below .5 down and then round .5 (specifically) up.
  • Round down – typical rounding method to round everything above .5 up and everything below .5 down and then round .5 (specifically) down.

This parameter specifies the rounding method. The default is "Ceil".

VIEW_BILL_FILTER_TENANT

(true or false)

This flag controls whether to (True) or not (False) apply Tenant filters when viewing the formatted interactive bill. The tenant filters will only allow you to see bill data for your tenants. The default is True.

View Bill - Service ID Masking

These options control how Service IDs, like Auth Codes or Calling Cards, are displayed on the billing invoices (View Bill).

Option

Description

Default Setting

formatting.bill.AUTH_CODE.label

An option specifying the Text to display when outputting the Service ID for this item type.

The default for Auth Codes is "Auth Code".

formatting.bill.AUTH_CODE.side

An option that controls which side of the Auth Code to show either "front" or "back".

The default for Auth Codes is "back".

formatting.bill.AUTH_CODE.length

An option that controls how many characters of the Service ID to display.

The default for Auth Codes is 3.

formatting.bill.AUTH_CODE.mask

An option specifying the Mask character that will replace the removed characters in the Service ID.

The default for Auth Codes is "*"

Calling Card Example:

formatting.bill.PHONE_CALLING_CARD.label = "Calling Card"
formatting.bill.PHONE_CALLING_CARD.side = "front"
formatting.bill.PHONE_CALLING_CARD.mask = "*"
formatting.bill.PHONE_CALLING_CARD.length = 5

CREATE_GLA_INVOICE_NUMBERS

(true or false)

This flag controls whether or not new invoice numbers will be generated and assigned for each unique GLA number during a billing run.

CALCULATE_TAXES

(BOOLEAN_TRUE or BOOLEAN_FALSE)

This flag controls whether or not taxes are calculated and displayed on the bill. All taxes are calculated based on the Billing Group tax rate. Additionally Taxes will only be calculated if the "Taxable" flag is set on the GLA, Department Hierarchy, and Charge Catalog. The default is false and DOES NOT calculate taxes.

TAX_ROUND_METHOD

(options: ceil, floor, roundup or rounddown)

When calculating taxes the process sometimes needs to round amounts. When this happens there are 4 (four) types of rounding that can be used:

  • Ceil – (Ceiling) a mathematical form of rounding that always goes up to the nearest whole number.
  • Floor – a mathematical form of rounding that always goes down to the nearest whole number.
  • Roundup – typical rounding method to round everything above .5 up and everything below .5 down and then round .5 (specifically) up.
  • Round down – typical rounding method to round everything above .5 up and everything below .5 d¬¬own and then round .5 (specifically) down.

This parameter specifies the rounding method. The default is "Ceil".


[Table of Contents]


Call Processing and Imports

IMPORT_FILES_PATH

The parameter defines the directory path location of incoming import files. Typically set to the customers home directory: /home/customer/pcr360/data/inbound/

CALL_USAGE_RATING_IMMEDIATE

(true or false)

This parameter sets when calls and usage will be rated after processing. Specifying True will cause the rating event to run every minute, while False will run the event once daily. The default is False.

CALL_USAGE_RATING_TIME_OF_DAY

(number of seconds after midnight)

If CALL_USAGE_RATING_IMMEDIATE is set to False, this parameter specifies the time of day at which the calls and usage rating event runs. The default is 10800, which is 3:00 a.m.

CALL_USAGE_RATING_COST_ROUND_METHOD

(Options: ceil, floor, roundup, rounddown, none)

During rating the call/usage processing module sometimes needs to round fractions of cost. When this happens there are 5 (five) types of rounding that can be used:

  • Ceil – (ceiling) a mathematical form of rounding that always goes up to the nearest whole number.
  • Floor – a mathematical form of rounding that always goes down to the nearest whole number.
  • Roundup – typical rounding method to round everything above .5 up and everything below .5 down and then round .5 (specifically) up.
  • Round down – typical rounding method to round everything above .5 up and everything below .5 d¬¬own and then round .5 (specifically) down.
  • None – no rounding.

This parameter specifies the rounding method. The default is "Ceil".

CALL_USAGE_RATING_DURATION_PRECISION

(number of seconds)

During rating the call/usage processing module can maintain durations to the nearest specified precision. This precision is defined in a number of seconds. To maintain this precision the process will sometimes round the duration to the nearest precision. The default is 1. (See CALL_RATING_DURATION_ROUNDING_METHOD below)

CALL_USAGE_RATING_DURATION_PRECISION_ROUND_METHOD

(options: ceil, floor, roundup, rounddown, none)

During rating the call/usage processing module sometimes needs to round fractions of duration to the nearest precision number of seconds. When this happens there are 5 (five) types of rounding that can be used:

  • Ceil – (Ceiling) a mathematical form of rounding that always goes up to the nearest whole number.
  • Floor – a mathematical form of rounding that always goes down to the nearest whole number.
  • Roundup – typical rounding method to round everything above .5 up and everything below .5 down and then round .5 (specifically) up.
  • Round down – typical rounding method to round everything above .5 up and everything below .5 d¬¬own and then round .5 (specifically) down.
  • None – no rounding.

This parameter specifies the rounding method. The default is "Ceil".

CALL_USAGE_RATING_DURATION_ROUND_METHOD

(options: ceil, floor, roundup, rounddown, none)

During rating the call/usage processing module sometimes needs to round fractions of duration to the nearest rate interval. When this happens there are 5 (five) types of rounding that can be used:

  • Ceil – (Ceiling) a mathematical form of rounding that always goes up to the nearest whole number.
  • Floor – a mathematical form of rounding that always goes down to the nearest whole number.
  • Roundup – typical rounding method to round everything above .5 up and everything below .5 down and then round .5 (specifically) up.
  • Round down – typical rounding method to round everything above .5 up and everything below .5 d¬¬own and then round .5 (specifically) down.
  • None – no rounding.

This parameter specifies the rounding method. The default is "Ceil".

IMPORT_REPROCESS_NUM_DAYS

(number of days)

Whenever the import file processing module fails to process a specific record it will hold onto that record for later reprocessing. At a specific time each day it will attempt to reprocess errors for a specified number of days. If the reprocess succeeds then the error status is removed. This parameter specifies that number of days. There is also a Tenant specific override for this parameter called Call Error Aging. The default is 30.

IMPORT_REPROCESS_TIME_OF_DAY

(number of seconds after midnight)

Whenever the import file processing module fails to process a specific record it will hold onto that record for later reprocessing. At a specific time each day it will attempt to reprocess errors for a specified number of days. If the reprocess succeeds then the call error status is removed. This parameter specifies the time each day that the reprocess runs. The default is 9000, which is 2:00 a.m.

USE_RATING_GROUP

(true or false)

If set to true, then the Rating Group field will appear on Phone Services form and on the Call Rate form and grid. The rating process will use the Rating Group in addition to the Billing Group to find the correct Call Rate. The default is false.


[Table of Contents]


CustomerCenter

CC_NEWUSER_ROLE

(role name)

Default: "CustomerCenter"

This parameter is used when the User Management module is enabled on CustomerCenter. New users created from CustomerCenter will be assigned this Role.

CC_NEWUSER_TENANT_LIMIT

(number)

Default: 10

This parameter sets a limit on the number of users that can be created from CustomerCenter within each tenant.

CC_EMAIL_REQUIRED

(true or false)

Default: TRUE

This parameter specifies if the Contact Email field on CustomerCenter is required.

CC_PHONE_REQUIRED

(true or false)

Default: TRUE

This parameter specifies if the Contact Phone field on CustomerCenter is required.

CUSTOMER_CENTER_MODULE_NAME

(module name)

Default: "cc"

This parameter specifies the internal module name of the CustomerCenter. The default value should not be changed unless the internal structure of the application has been changed to reflect the same.

CC_CATALOG_DEFAULT_CATEGORY_VIEW_TYPE

("grid" or "list")

Default: "grid"

This parameter controls the default view presented when a user visits a category page in the shopping catalog.

CC_CATALOG_DEFAULT_CATEGORY_SORT

(column_name "ASC" or "DESC")

Default: "DESCRIPTION ASC"

This parameter controls the default sort order that items are presented in when viewing a category page in the shopping catalog.

CC_CATALOG_DEFAULT_ITEMS_PER_PAGE

(number)

Default: 8

This parameter controls how many items are shown per page in the category pages of the shopping catalog.

CC_GRID_DEFAULT_ITEMS_PER_PAGE

(number)

Default: 8

This parameter shows how many items are shown in data grids throughout the CustomerCenter. ie Directory listing.

CC_KNOWLEDGEBASE_COMMENTS

(true or false)

Default: TRUE

This parameter controls if comments are allowed in the knowledgebase in CustomerCenter

CC_SHOW_CABLING_PICKER

(true or false)

Default: TRUE

This parameter controls whether or not the cabling equipment picker is shown in the CustomerCenter request billing details forms.

CC_DESTINATION_EQUIPMENT_FORM_LABEL

(cabling equipment picker label)

Default: "Jack Number"

This parameter controls what label is applied to the cabling equipment picker in CustomerCenter request billing details forms. If CC_SHOW_CABLING_PICKER is FALSE, this parameter is ignored.

CC_CATALOG_SHOW_INVALID_LOCATION_ITEMS

(true or false)

Default: FALSE

This parameter controls whether or not to show service and equipment items, in the catalog pages, that are restricted to certain locations and either a location is not selected or an invalid location is selected. If FALSE, these items are not shown in results. If TRUE, these items show, but can not be requested.

CC_VERSION

(1 or 2)

Default: 2

This parameter tells the system which menu system to use when a user is in CustomerCenter. If using the legacy CustomerCenter, then this should be set to 1. However, the default value of 2 should always be used when the new CustomerCenter version is being used. *The legacy CustomerCenter is slated to be removed in the near future, at which point this option will also be removed.

CC_DEFAULT_BILL_VIEW

("/bill/" + "gla-view", "owner-view" or "bg-view")

Default: "/bill/gla-view"

This parameter controls which bill view type is used when viewing a bill from CustomerCenter.

CC_CALL_DETAILS

("OWNER" or "ALL")

Default: "OWNER"

This parameter controls which calls are shown when a CustomerCenter user views their call details. "OWNER" shows only calls owned by the users whereas "ALL" shows all calls in the system.

CC_REQUEST_SHOW_PRIMARY_SECONDARY_CONTACTS

(boolean)

Default: "True"

This parameter controls whether the Primary and Alternate On-Site selectors are available on the Order Contacts section of the Order Details before submitting a Request. Setting to False will hide these values at all times.


[Table of Contents]


Database Connection Parameters

MySQL Default Connection

resources.multidb.default.adapter = Pdo_Mysql
resources.multidb.default.host = mysql5.pcr.com
resources.multidb.default.username = dev360
resources.multidb.default.password = thisisapassword

MySQL Metadata Connection

resources.multidb.metadata.adapter = Pdo_Mysql
resources.multidb.metadata.host = mysql5.pcr.com
resources.multidb.metadata.username = dev360
resources.multidb.metadata.password = thisisapassword

Oracle Default Connection

resources.multidb.default.adapter = Oracle
resources.multidb.default.host = oracle.pcr.com
resources.multidb.default.username = pcr360
resources.multidb.default.password = thisisapassword
resources.multidb.default.schema = PCR360
resources.multidb.default.dbname = "//oracle.pcr.com:1521/pcr"
resources.multidb.default.caseInsensitive = true

Oracle Metadata Connection

resources.multidb.metadata.adapter = Oracle
resources.multidb.metadata.host = oracle.pcr.com
resources.multidb.metadata.username = pcr360meta
resources.multidb.metadata.password = thisisapassword
resources.multidb.metadata.schema = PCR360META
resources.multidb.metadata.dbname = "//oracle.pcr.com:1521/pcr"
resources.multidb.metadata.caseInsensitive = true


[Table of Contents]


Email Accounts

Master Default

(one unique account specified for entire application)

Master Default Email Account is used for sending all non Service Desk emails if there is not a Tenant Default account entered; and also, for All Service Desk emails if there is neither a Tenant Service Desk email nor Tenant Default specified.

Tenant Default

(one Default account specified per tenant)

Tenant Default Email Account is used for sending all non Service Desk emails and all Service Desk emails if there is no Tenant Service Desk email specified. The Default Account never receives email so the incoming settings are not available.

Tenant Service Desk

(one Service Desk account specified per tenant)

Service Desk Email Account is used to for sending and receiving all Service Desk emails. If there is not a Service Desk account specified then service desk emails will be sent with the Tenant Default Account (or the Master Default Account) but, service desk email will not be received.

Outgoing Transport Type

(required)

The method used for sending outgoing email. Options: “SMTP”, “SENDMAIL” or “FILE” Note: if SENDMAIL or FILE is specified some other options are not required.

Outgoing Server

(required if SMTP)

The server/host used for the outgoing email account. Example: "smtp.gmail.com"

Outgoing Port

(required if SMTP)

The port used for the outgoing email account. Example: 465

Outgoing SSL

Whether or not to use SSL encryption for the outgoing email account, not including this parameter indicates a non-secure connection. Options: "SSL" or ""  

Incoming Mailbox Type

(required)

The method used for retrieving incoming email. Options: “IMAP”, “POP3”, “MAILDIR”, “MBOX” Note: MAILDIR and MBOX are local mail storage systems – the mail and web servers must share the same machine.

Incoming Server

(required)

The server/host used for the incoming email account. Example: "imap.gmail.com"

Incoming Port

(required)

The port used for the incoming email account. Example: 993

Incoming SSL

Whether or not to use SSL encryption for the incoming email account. Options: "SSL" or ""

Email

(required)

The from email address used for outgoing messages. Example: "address@gmail.com"

Login

(required)

The login/username used to access the incoming and outgoing accounts. "address@gmail.com"

Password

(required)

The password used to access the incoming and outgoing accounts. Example: "pcrpassword"

Name

The from display name used for outgoing emails. Example: "PCR-360 Admin"

SysAdmin

A system wide email address used when sending messages and alerts about errors and problems. This account is currently only used when the application fails to process an incoming email to Service Desk.


[Table of Contents]


Equipment Parameters

MODIFY_SERIAL_NUMBER

(ADMINISTRATIVE_USERS, ALL_USERS)

This parameter determines if the system allows users to modify Equipment Serial Numbers. It can be used to define who has the authority to modify Equipment Serial Numbers. The default is ADMINISTRATIVE_USERS.

SHOW_CONSUMED

(true or false)

The equipment catalog allows for types of equipment to be marked as Consumable. This type of equipment when used on a Service Desk will be marked as CONSUMED in the data. This parameter specifies whether to (True) or not (False) display the CONSUMED equipment on the equipment grids. The default is True.

PO_RECEIVE_ALLOW_SURPLUS

(TRUE or FALSE)

This config option will prevent or allow a Purchase Order from receiving more Inventory then was requested from the Vendor. Some Vendors might allow for additional units to be shipped as bonus items, rewards, or last minute changes to the PO. The default setting is FALSE, which will prevent additional inventory from being received.


[Table of Contents]


Front End Content

FRONTEND_ LOGIN_ PARAGRAPH_RIGHT

(html text)

This parameter is the paragraph text on the front-end login page to the right of the Username/Password fields. This only applies to systems that do not use single sign-on authentication like Shibboleth. The default is "If you need assistance or have any questions, please check the Frequently Asked Questions page or contact us at help@pcr.com"

FRONTEND_ HOMEPAGETITLE

(plain text)

This parameter is the text display at the top of the WebCenter homepage. The default is "Welcome to PCR-360 CustomerCenter".


[Table of Contents]


GLA Parameters

FORCE_GLOBAL_GLA

(BOOLEAN_TRUE or BOOLEAN_FALSE)

This parameters specifies whether or not to force all GLA records into the Global tenant. If set to True then all GLA records will automatically be set to Global Tenant and cannot be changed. The default is False.

GLA_CONCATENATOR

(plain text)

The parameter defines a short series of characters that is used when displaying GLA Components together. The pieces of the GLA are concatenated together with this text between each. The default is " > ".

GLA_FORM_WIDTH

The parameter defines the pixel width of the GLA form. The default is 915.

GLA_FORM_HEIGHT

The parameter defines the pixel height of the GLA form. The default is 260.

USE_CATALOG_REVENUE_GLA

(BOOLEAN_TRUE or BOOLEAN_FALSE)

If true, Revenue GLA from Service Catalog or Equipment Catalog is used, else Revenue GLA from Billing Group is used. The default is true.

GLA_FORMAT_DEFAULT

(default GLA format)

Formats can not be more than 14 characters in length
The default GLA will be what any picker or grid should default to if a GLA is not explicitly selected
Example: constants.GLA_FORMAT_DEFAULT = "ADMIN"

GLA_PRICING_MODEL

Determines which GLA Pricing model to use. There are three options: Billing Group, GLA Component, or None. If set, by default the amount of a charge will be set to the matching GLA Pricing in the model.

GLA_PRICING_COMPONENT

Defines which component to use for GLA Component Pricing when the GLA_PRICING_MODEL is set to GLA Component.

GLA Format(s)

FOAPAL Levels are: Fund, Org., Account, Program, Activity, Location

// Example Admin GLA Format
gla.ADMIN.description = "GLA Format for Admin Billing Group"
gla.ADMIN.numItems = 4
gla.ADMIN.items.1.name = "Fund"
gla.ADMIN.items.1.required = true
gla.ADMIN.items.2.name = "Org"
gla.ADMIN.items.3.name = "Department"
gla.ADMIN.items.4.name = "SubDept"
// Example Resale Account GLA Format
gla.ACCOUNT.description = "GLA Format for Account Billing Group"
gla.ACCOUNT.numItems = 1
gla.ACCOUNT.items.1.name = "Account"
gla.ACCOUNT.items.1.required = true

The GLA segments can be customized with these options: (Where X is the segment number and FORMAT is the format name)

  • gla.FORMAT.numItems (The number of Components in the GLA Format)
  • gla.FORMAT.description (The description of the GLA format)
  • gla.FORMAT.items.X.name (The name of this component)
  • gla.FORMAT.items.X.required (Optional attribute, whether or not this component is required and cannot be null; true or false )
  • gla.FORMAT.items.X.maxLength (Optional attribute, for setting the max character length for this component; example: 4 )
  • gla.FORMAT.items.X.minLength (Optional attribute, for setting the min character length for this component; example: 4 )

GLA_SPLIT_ROUND_METHOD

(options: ceil, floor, roundup or rounddown)

Whenever the system needs to calculate the specific changes in a GLA split it sometimes needs to round amounts. When this happens there are 4 (four) types of rounding that can be used:

  • Ceil – (Ceiling) a mathematical form of rounding that always goes up to the nearest whole number.
  • Floor – a mathematical form of rounding that always goes down to the nearest whole number.
  • Roundup – typical rounding method to round everything above .5 up and everything below .5 down and then round .5 (specifically) up.
  • Round down – typical rounding method to round everything above .5 up and everything below .5 d¬¬own and then round .5 (specifically) down.
    This parameter specifies the rounding method. The default is "roundup ".


[Table of Contents]


Legacy

Legacy Format

PCR-360 is capable of creating a fully configurable Legacy table, by defining a set of parameters in a configuration file before creating the legacy table.

The legacy form can support two tabs. On the first tab up to 4 groups are supported, and a single large text field is supported on the second tab. The second tab is typically used to display long form data, such as emails or remarks.

The Legacy table can be customized with these options: (Where X is the group number and COLUMN_NAME is the name of the column in the database table)

  • legacy.groupX.name (The name of the group )
  • legacy.groupX.width(The width, in pixels, of the group on the legacy screen)
  • legacy.groupX.fields.COLUMN_NAME.name (The field label on the legacy form correlating to the column in the database)
  • legacy.groupX.filds.COLUMN_NAME.type (This is the data type for the database column, VARCHAR(100) for example)

legacy.comments.field (The column name in the Legacy table for the long form text) legacy.comments.name (The name of the label on the Legacy form) legacy.comments.type (The data type of the data stored in the Legacy table, i.e. "CLOB") legacy.remarks (Designates if the format on the second tab is for remarks, this value is boolean true or false)

// Example Legacy Format for group1
legacy.group1.name = "Ticket"
legacy.group1.width = 200
legacy.group1.fields.TICKET_NUMBER.name = "Ticket Number"
legacy.group1.fields.TICKET_NUMBER.type = "VARCHAR(100)"
legacy.group1.fields.SOURCE.name = "Source"
legacy.group1.fields.SOURCE.type = "VARCHAR(100)"
legacy.group1.fields.STATUS.name = "Status"
legacy.group1.fields.STATUS.type = "VARCHAR(100)"
legacy.group1.fields.REF_NUM.name = "Ref Num"
legacy.group1.fields.REF_NUM.type = "VARCHAR(100)"
legacy.group1.fields.PRIORITY.name = "Priority"
legacy.group1.fields.PRIORITY.type = "VARCHAR(100)"

//Example Format for second tab on Legacy form
legacy.comments.field = "EMAIL"
legacy.comments.name = "Email"
legacy.comments.type = "CLOB"
legacy.remarks = false


[Table of Contents]


Misc Parameters

JITC

(true or false)

This parameter determines if the application is running in JITC mode a setting here may override some other parameters forcing JITC specific settings. The default is false.

JITC_MESSAGE

(text)

Message displayed on the login and home screens for JITC systems. The JITC parameter is required to enable this message. The default is:

"You are accessing a U.S. Government (USG) Information System (IS) that is provided for USG-authorized use only. By using this IS (which
includes any device attached to this IS), you consent to the following conditions:

The USG routinely intercepts and monitors communications on this IS for purposes including, but not limited to, penetration testing,
COMSEC monitoring, network operations and defense, personnel misconduct (PM), law enforcement (LE), and counterintelligence (CI)
investigations. At any time, the USG may inspect and seize data stored on this IS. Communications using, or data stored on, this IS
are not private, are subject to routine monitoring, interception, and search, and may be disclosed or used for any USG authorized purpose.
This IS includes security measures (e.g., authentication and access controls) to protect USG interests--not for your personal benefit
or privacy. Notwithstanding the above, using this IS does not constitute consent to PM, LE or CI investigative searching or monitoring
of the content of privileged communications, or work product, related to personal representation or services by attorneys,
psychotherapists, or clergy, and their assistants. Such communications and work product are private and confidential. See User
Agreement for details.”

(text)

Message displayed in the footer of every page. The JITC parameter is required to enable this message. The default is: “OFFICIAL USE ONLY”

HIERARCHYPATH_CONCATENATOR

(plain text)

The parameter defines a short series of characters that is used when displaying Hierarchical Tree data. The levels of the hierarchy are concatenated together with this text between each. The default is " > ".

MAX_FILE_SIZE

(number of bytes)

The parameter defines the maximum file size that the application will allow to be uploaded. This setting must be less than or equal to the Apache and PHP settings that control upload size. The default is 10000000.

LOCATION_PICK_LOWEST_ONLY

(true or false)

This parameter determines the behavior of the location selectors/pickers throughout the application. If specified as True, locations can only be picked at the bottom level – e.g., only rooms could be selected when assigning services/equipment. But if False is specified, any location level can be selected. The default is False.

DATETIME_FORMAT

(plan text format)

This parameter specifies the display format with which all date/time data is displayed. It uses standard PHP date/time format characters that can be found at http://php.net/manual/en/function.date.php . The default is "M j, Y, g:i a".

DATE_FORMAT

(plan text format)

This parameter specifies the display format with which all date data is displayed. It uses standard PHP date/time format characters that can be found at http://php.net/manual/en/function.date.php . The default is "M j, Y".

MIN_INTEGER

(integer)

This parameter defines the minimum allowed number that can be stored in an integer field. This can be changed if the database allows for larger integers, changing this value requires the database to be rebuilt. The default is -2147483648.  

MAX_INTEGER

(integer)

This parameter defines the maximum allowed number that can be stored in an integer field. This can be changed if the database allows for larger integers, changing this value requires the database to be rebuilt. The default is -2147483648.

MAX_FLOAT_DIGITS_LEFT_OF_DECIMAL

(number of digits)

This parameter defines the maximum number of digits that can be stored left of the decimal in a decimal number. This can be changed if the database allows for more digits, changing this value requires the database to be rebuilt. The default is 13.

MAX_FLOAT_DIGITS_RIGHT_OF_DECIMAL

(number of digits)

This parameter defines the maximum number of digits that can be stored right of the decimal in a decimal number. This can be changed if the database allows for more digits, changing this value requires the database to be rebuilt. The default is 5.

MAX_AUTOCOMPLETE_RESULTS

(number of results)

This parameter defines the maximum number of results that an autocomplete gui element will return. Increasing this value may affect performance of autocomplete elements. The default is 500.

USERGUIDE_WIKI_URL

(URL)

The parameter defines the URL that is used to link to the Wiki User Guide. The default is http://wiki360.pcr.com .

USERGUIDE_WIKI_CC_URL

(URL)

The parameter defines the URL that is used to link to the Wiki User Guide CustomerCenter section. This link is on CustomerCenter. The default is http://wiki360.pcr.com/index.php/Category:CustomerCenter .

CONTACT_EMAIL_REQUIRED

(true or false)

This flag controls whether or not the Contacts Email is required on the Contact form and other places it appears. The default is false.

DEPARTMENT_EMAIL_REQUIRED

(true or false)

This flag controls whether or not the Department Email is required on the Department form. The default is false.

SEND_EMAIL

(true or false)

This flag determines if the application will send email. Normally the application will send emails for notifications and other events, if set to false, all notifications can only be sent to internal users.

DEFAULT_PASSWORD

(false or password)

This parameter specifies if new users are created with a default password and specifies what the password should be. The default is false.

CHECK_MESSAGE_INTERVAL

(number of seconds)

This parameter defines the number of seconds the application will wait between requests to check messages. This pertains only to the internal messaging system. The default is 120.

CHECK_DASHBOARD_INTERVAL

(number of seconds)

This parameter defines the number of seconds the application will wait between requests to check dashboard status. The default is 60.  

REMARKS_EDITABLE

(ADMINISTRATIVE_USERS, ALL_USERS, NO_USERS)

This parameter determines if the system allows users to modify remarks. It can be used to define who has the authority to edit remarks. The default is ADMINISTRATIVE_USERS.

UPDATE_SERVICE_CONTACT_FROM_CONTACT_PHONE

(true or false)

This flag controls whether or not adding/updating a Contact Phone record will add the contact to a Service when the Contact's Phone number matches the Service ID. This applies to the Contact Import process as well as saving the Contact Phone record from the Contact Phone screen. The default is true.

USER_INFO_ACTIVITY_LOG_LIMIT

(false or integer value)

This parameter limits the "log in" activity displayed in the user details widget on the 360 dashboard. To limit the activity displayed to ten entries, set the flag value to 10. If this flag is set to false, then the number of entries displayed will not be limited.

USER_INFO_ACTIVITY_SINCE

( number of days or months )

This parameter defines the number of days or months of recent "log in" activity that will be displayed in the user details dashboard widget. Example values include 1D, 2D, 1M, etc. where 1D is one day, 2D is two days and 1M is one month. When this value is set to 2D, the activity log will show the last two days worth of "log in" information; including successful and failed "log in" attempts.

DEPT_HIERARCHY_DEFAULT_OWNER

(true or false)

This parameter determines if the the default Owner type (Contact or Department) to be used on Services, Equipment and Service Desk is set to Department. The default is true.

DELETE_CHARGES_DURING_AGING

(true or false)

This parameter determines whether or not charges will be deleted from the phone service during the aging process. The default value is true.

USE_E911_NENA2_FIELDS

(true or false)

This parameter controls whether the NENA2 standard fields are shown on the Building Address tab. When they are the fields are used to generate E911 standard compliant files for the 911 file export. When true the fields will be included. The default value is false.


[Table of Contents]


Reports

REPORT_DATA_HEADER_BGCOLOR

(HTML color or hex value)

This configuration option sets the background color of the top Report header. If Hex is specified include the '#' to start the value, any valid hex value is recognized. Default is a blank entry.

REPORT_DATA_HEADER_TEXTCOLOR

(HTML color or hex value)

This configuration option sets the color of text in the Report data header cells. If Hex is specified include the '#' to start the value, any valid hex value is recognized. Default is a blank entry.

REPORT_DATATD_BORDERCOLOR

(HTML color or hex value)

This configuration option sets the border color of Report data cells. If Hex is specified include the '#' to start the value, any valid hex value is recognized. Default is a blank entry.

REPORT_HEADER_ALT

(string)

This configuration option set the ALT tag of the top header image. This tag is used to identify what the Image represents for sight impaired browsing and/or will output in event the browser cannot read the image. This text should be descriptive of what the image shows.

Default entry is "PCR-360".

REPORT_HEADER_IMG

(image location and filename as string)

This configuration option identifies the image to be used in the top report header. Since directory structures are subject to change check with PCR for proper directory placement. Default is "pdf_hdr_1-2_10-7inch.jpg".

REPORT_HEADER_INFOCOLOR

(HTML color or hex value)

This configuration option sets the color of all text in the Report header. If Hex is specified include the '#' to start the value, any valid hex value is recognized. Default is a blank entry.

REPORT_HEADER_LINKCOLOR

(HTML color or hex value)

This configuration option sets the color of all links in the report header. If Hex is specified include the '#' to start the value, any valid hex value is recognized. Default is a blank entry.

(css pixels)

This configuration option sets the width of the header link, useful when you add a custom header image and have to resize the header link. The default value a blank entry.

REPORT_SECTION_DESCBAR_BGCOLOR

(HTML color or hex value)

This configuration option sets the background color of the main data headers. If Hex is specified include the '#' to start the value, any valid hex value is recognized. Default is a blank entry.

REPORT_THEAD_TH_BGCOLOR

(HTML color or hex value)

This configuration option sets the background color of the report data description cells. If Hex is specified include the '#' to start the value, any valid hex value is recognized. Default is a blank entry.

REPORT_TITLE_BGCOLOR

(HTML color or hex value)

This configuration option sets the background color of the top Report header. If Hex is specified include the '#' to start the value, any valid hex value is recognized. Default is a blank entry.

REPORT_TITLE_BGIMAGE

(Valid image location and filename string.)

This configuration option identifies the image to be used in the top Report header. Since directory structures could change see PCR for the correct location to place the image. Default is "pdf_hdr_1-2_10-7inch.jpg".

REPORT_TOTALTD_BGCOLOR

(HTML color or hex value)

This configuration option sets the background color of the "total" data cells. If Hex is specified include the '#' to start the value, any valid hex value is recognized. Default is a blank entry.

REPORT_TREVEN_TD_BGCOLOR

(HTML color or hex value)

This configuration option sets the background color of even-numbered data cells. If Hex is specified include the '#' to start the value, any valid hex value is recognized. Default is a blank entry.


[Table of Contents]


Service Desk

DUEDATE_APPROACHING

(seconds)

As a due date nears the system will flag it as approaching – this parameter specifies the number of seconds before the due date when this happens. The default is 172800 seconds which is 48 hours.

WORKDAY_HOUR_START

(military time hour)

This parameter is used to specify the hour at which each workday begins. This is used when calculating due dates. The default is 08 for 8:00 a.m.

WORKDAY_HOUR_STOP

(military time hour)

This parameter is used to specify the hour at which each workday stops. This is used when calculating due dates. The default is 17 for 5:00 p.m.

ALLOW_CSR_REASSIGNMENT

(true or false)

This flag is used in Service Desk to restrict the capability of reassigning CSR’s on SD items. If this parameter is set to True then Service Desk will allow CSRs to be reassigned / changed. If set to false then Service Desk will NOT allow reassignment. The default is true.

SERVICEDESK_ANNUAL_NUMBER_RESET

(true or false)

This flag is used in an annual process that resets the Service Desk item numbers. It is common for Service Desk numbers to restart at 1 at the beginning of each year and this would automatically accomplish the reset. This should not be used if the SD item numbers are not prefixed with the current year. SD number prefixes are managed from the Admin menu. The default is true.

USE_QR_CODE

(true or false)

This flag specifies whether the Service Desk printout will use a QR code or a barcode. When set to true the printout uses a QR code; false indicates the printout will use a barcode. The default is true.

FORCE_AVAILABLE_SERVICE

(true or false)

This flag is used to force Service Order Actions for new phone services to ALWAYS require available services. When selecting the Service ID for the new phone service this will force the user to select an available phone service from the list and not allow them to enter one manually. Currently only applies to phone service. The default is false.

VIP_URGENCY_CODE_DEFAULT

(HIGH, MEDIUM, LOW)

This parameter defines the default Urgency code for VIPs whenever Urgency is not defined on the Tenant. The default is HIGH.

IMPACT_CODE_DEFAULT

(HIGH, MEDIUM, LOW)

This parameter defines the default Impact code for Incidents whenever Impact is not defined on the Incident Code. The default is MEDIUM.

EMAIL_BLOCKED_MARKAS_READ

(true or false)

This flag is used to determine how to treat blocked emails when Service Desk is creating Inquiries. If a blocked address or subject is found the system will either mark that message as read (true) or leave it as unread (false). The default is false.

MODIFY_CHARGES_WITHOUT_SERVICE_DESK

(ADMINISTRATIVE_USERS, ALL_USERS, NO_USERS)

This parameter determines if the system allows users to modify charges and override billing groups outside of Service Desk. Only allowing Service Desk to modify charges on Services ensures that proper procedures are followed when modifying those charges. This parameter can be used to define who has the authority to manually edit Service Charges outside of Service Desk. The default is ADMINISTRATIVE_USERS.

INCIDENT_EXPORT_EQP_TO_SERVICE

(true or false)

This parameter is used to allow Incidents to update the Service Equipment when the Incident is completed.

SD_EQP_LOWSTOCK_THRESHOLD

(integer >= 0, default: 0)

This value acts as a way to warn of low-stock Equipment being added to Service Desk items. A column on the Service Desk form's Equipment grid will indicate the Availability of stock for "Add" actions that are status "Pending".

The system first looks for the Equipment Catalog Inventory "Reorder" value, which allows independent values for different Catalogs based on their Location. If no value is set there, this value is used as a fall-back.

For instance, if the result of Reorder or SD_EQP_LOWSTOCK_THRESHOLD is 10, you'll see a  message in the Availability column when stock falls below 10. This is the cue to order more of that Equipment. If the default (0) is set (assuming no Reorder point is set),  will only appear when the available quantity IS 0. When requested Equipment exceeds what is available, you'll see  . Adequate supply will show  . Bear in mind, these are calculated indicators. As stock changes throughout the system, these indicators will also change.

SD_LABOR_BILLABLE

(true or false)

This parameter is used to default the Billable selection for new Service Desk Labor items. The default is false.

SDA_ALLOW_MULTIPLE_DEFAULT_GLAS

(true or false)

This parameter will enable the ability to set multiple Default Action GLA's on the Service Order GLA tab when it is set to "true". When set to "false", only a single Default Action GLA may be set on the Service Order. The default is false.

SD_WORKFLOW_PERMISSIONS

(bitmask integer dictating permission level)

Possible permission levels:

Everyone = 16
Administrator = 8
CSR = 4
Manager = 2
Assigned Worker = 1
None = 0

Dictates permission levels for completing or deleting workflows. Assigned worker and manager will be the contact assigned the workflow and the manager of the workgroup assigned to the workflow. The CSR is the Service Rep assigned to the Service Desk Order and the administrator permission will give all sysadmins the ability to complete/delete workflows. Permission levels may be combined, if you wanted for example the assigned worker (1) and a sysadmin (8) to be able to complete/delete workflow SD_WORKFLOW_PERMISSIONS would need to be set to 9.

TECH_SCHEDULING_MODE

(FORWARD or BACKWARD)

This parameter toggles between scheduling technicians forward in time or backwards from the due date. Backwards is the default.

SD_WORKFLOW_DEFAULT_CUSHION

(integer indicating hours)

Sets a cushion between either the current time and the first schedule attempt (in forward scheduling) or between the due date and the first schedule attempt (in backward scheduling). Default is 1 hour.

RETURN_VOIDED_EQUIPMENT

(true or false)

This parameter determines whether or not "Staged", "Picked Up" and "Completed" equipment on a service order will automatically be returned. Equipment will be returned to the "From" location or warehouse on the Service Desk Equipment record. When turned off, a message will be displayed warning the user that the order or action cannot be voided because it contains "Staged", "Picked Up" or "Completed" equipment. The user still has the ability to use the "Warehouse Actions" grid to return equipment. The default setting for this parameter is true.

USE_COMBINED_INCIDENT_CODES

(true or false) Default is false.

Description: Controls the combined displaying of General Incident Codes with Equipment or Service specific Incident Codes in the Incident Code drop down on the Service Desk Incident form. When set to BOOLEAN_FALSE, only Equipment/Service specific Incident Codes will be displayed in the field when an Equipment/Service is specified on an Incident. When set to BOOLEAN_TRUE, both Generic Incident Codes and Equipment/Service specific Incident Codes will be displayed in the drop down.

[Table of Contents]


Service Desk Numbers

These formats are controlled from the menu: Admin > Service Desk > Number Config. This form controls the possible formats for Service Desk Numbers and allows for manual number reset.

Available Formats:

  • None (Just a sequence number)

  • 2-digit year YY

  • 4-digit year YYYY

  • 2-digit Year - 2-digit Month YYMM

  • 4-digit Year - 2-digit Month YYYYMM

  • 2-digit Year - 2-digit Month - 2-digit Day YYMMDD

  • 4-digit Year - 2-digit Month - 2-digit Day YYYYMMDD

  • Fiscal Year YYYY

More specialized formats can be added on an individual basis. After the prefix, the SD number consists of a sequential number starting at 1 – this sequence can be reset to one manually or on a scheduled basis. If an automatic reset is required it must be setup in advance.

SD_NUMBER_FORMAT

(sprintf format string)

This format parameter controls the minimum number of digits in the sequence number. If the sequence number ever exceeds this number of digits The number of digits additional digits are added. The default is "%05s".

Tenants

USE_MULTI_TENANTS

(true or false)

This parameter is used to enable the multi-tenant capability or force all data to be categorized into the one tenant. The default is true which enables multiple tenants.


[Table of Contents]

Tenant Specific Parameters

All tenants must specify each of these parameters – including the single tenant if USE_MULTI_TENANTS is set to false.

Default NPA

(3 digits)

This parameter specifies the default phone number NPA for the specified tenant. This number is used when creating new Phone Service records, the value will be pre-populated in the phone number field. Example: “616”

Default NXX

(3 digits)

This parameter specifies the default phone number NXX for the specified tenant. This number is used when creating new Phone Service records, the value will be pre-populated in the phone number field. Example: “554”

Default State

(required)

This parameter specifies the default state for the specified tenant. Example: “Michigan”

Auth Code Num Digits

(number of digits)

Optional parameter that specifies the number of digits that auth codes should contain. Example: 5.

Auth Code Aging

(number of days)

Optional parameter that specifies the number of days after an authcode is set to inactive before it can be reclaimed and set back to available. This option is only used when the Service Catalog option is not set.

Phone Service Aging

(number of days)

Optional parameter that specifies the number of days after a phone service is set to inactive before it can be reclaimed and set back to available. This option is only used when the Service Catalog option is not set.

Default VIP Urgency

(High, Medium, Low or None)

This parameter specifies the default Urgency for VIP contacts. Certain contacts are flagged as VIP and when Service Desk items are created for those contacts in this Tenant, the Service Desk item Urgency will be set with this default value. The default is None.


Help Desk Portal - Email: help@pcr.com - Phone: 616.259.9242