You are on page 1of 24

Phire 15.

1
Application Configuration

Copyright © 2020, Phire. All rights reserved.


The Programs (which include both the software and documentation) contain proprietary information; they
are provided under a license agreement containing restrictions on use and disclosure and are also protected
by copyright, patent, and other intellectual and industrial property laws. Reverse engineering, disassembly,
or decompilation of the Programs, except to the extent required to obtain interoperability with other
independently created software or as specified by law, is prohibited. The information contained in this is
subject to change without notice. If you find any problems in the documentation, please report them to us
in writing. This is not warranted to be error-free. Unless permitted in your license agreement for these
Programs, no part of these Programs may be reproduced or transmitted in any form or by any means,
electronic or mechanical, for any purpose.

Defining Application Codes


For each Domain defined in Phire, there is a list of Application Codes that should be configured
according to the customer requirements. Phire comes with the PHIRE domain, which contains
pre-loaded default values for each of these Application Codes. Once you clone the PHIRE domain
to create your Domain, you will be able to add, delete, or modify the code values to meet your
business requirements.

Copyright @ 2020 Phire. All rights reserved. Page 1 of 24


Defining the Application Codes
Step 1: Locate the Domain Application Codes

Phire > Administration > Application Codes

Step 2: Search for the Application Codes

Enter the name of the Domain to be configured in the Domain ID text box (example: HCM) and
click the Search button. This will display all the Application Codes associated with the Domain.

Each code value page contains the following common elements in the heading area:

Field Name Description


Domain ID A read-only field used to show which Domain is being configured
Code Name A read-only field used to show which Application Code is being
configured
Max Length of A read-only field used to show the maximum character length for the
Field Code Value field

Copyright @ 2020 Phire. All rights reserved. Page 2 of 24


Step 3: Configuring the Application Codes

3.1 Change Request Type

To configure the Change Request Type Application Code, click on the link associated with it to
open the Code Values configuration screen. The CR Type Application Code is used to define
which types of CRs can be created. The value of the CR Type drives the workflow associated
with the Change Request and security can be defined for each CR Type. The default values
delivered with Phire can be deleted or customized and entirely new values can be added based
on your requirements.

Note. Some crucial factors depend on the CR Type code value, including the Change Request
Workflow, which determines the steps you must complete to finalize the change request.

Field Name Description


Code Value A field used to define the ID by which the Code Value will be
referenced.
Status A drop-down box used to denote whether the Code Value is active or
inactive.
Code Description A field used to define a brief description for the Code Value.
Default One code value can be selected as a default and will subsequently be
used as the default when opening new items.
Workflow Details Access to the detailed workflow setup for the selected CR Type.
Flex Fields Flex fields provide a mechanism to capture new data elements for each
Issue Type. There are many flexible fields of different data types and
lengths that can be activated, resulting in the field appearing on the
main issue page.
Field Labels Every label on the main Issue page can be changed without coding.
You select the existing label and specify the override label value. For
each Issue Type, you can have a different set of field labels.
Required Fields Fields in the Change Request component can be configured as
“required,” making it necessary to populate them immediately upon
creating a new CR.
Object Type Object Type Restriction rules can be defined to limit the object types
Restrictions that can be added to CRs and migrated. It can be configured to
“Include” only specified types, or to “Exclude” specified types.
Updated By A read-only field used to show which ID last updated the Code Value.

Copyright @ 2020 Phire. All rights reserved. Page 3 of 24


Updated DateTime A read-only field used to show the date/time when the Code Value
was last updated.

3.2 Change Request Task Type

To configure the CR (Change Request) Task Type, click on the link associated with it to open the
Code Values configuration screen. The CR Task Type Application Code is used to define which
types of tasks can be associated with a CR. These values act as a label so that the user viewing a
CR will know which type of task is required depending on where the CR is in the workflow. The
default values delivered with Phire can be deleted or customized and entirely new values can be
added based on your requirements.

Field Name Description


Code Value A field used to define the ID by which the Code Value will be
referenced.
Status A drop-down box used to denote whether the Code Value is active or
inactive.
Code Description A field used to define a short description for the Code Value.
Updated By A read-only field used to show which ID last updated the Code Value.
Updated DateTime A read-only field used to show the date/time when the Code Value
was last updated.

3.3 Issue Type

To configure the Issue Type Application Code, click on the link associated with it to open the
Code Values configuration screen. The Issue Type Application Code is used to define which
types of Issues can be created. The default values delivered with Phire can be deleted or
customized and entirely new values can be added based on your requirements. For each Issue
type, you can define email notifications, the template of the description field, which flexible fields
to activate, and change the field labels on the main Issue page.

Copyright @ 2020 Phire. All rights reserved. Page 4 of 24


Field Name Description
Code Value A field used to define the ID by which the Code Value will be
referenced.
Status A drop-down box used to denote whether the Code Value is active or
inactive.
Code Description A field used to define a short description for the Code Value.
Default One code value can be selected as a default and will subsequently be
used as the default when opening new items.
Notifications Email notifications are configured for each Issue Type. You can define
the event to trigger the email, email template, and recipients from the
notifications page.
API The API feature allows customers to configure a custom program to be
called at pre-defined exit points to solve custom requirements. For
more information refer to the document entitled
API_Configuration.pdf.
Description The description field on the main Issue page can be configured to
Template auto-populate from a template for each Issue Type. You can have
structured questions or labels that will auto-load each time a new issue
is created.
Flex Fields Flex fields provide a mechanism to capture new data elements for each
Issue Type. There are many flexible fields of different data types and
lengths that can be activated, resulting in the field appearing on the
main issue page.
Field Labels Every label on the main Issue page can be changed without coding.
You select the existing label and specify the override label value. For
each Issue Type, you can have a different set of field labels.
Required Fields Fields in the Issue component can be configured as “required,”
making it necessary to populate them immediately upon creating a
new Issue.
Updated By A read-only field used to show which ID last updated the Code Value.
Updated DateTime A read-only field used to show the date/time when the Code Value
was last updated.

Copyright @ 2020 Phire. All rights reserved. Page 5 of 24


3.4 Attachment Type

To configure the Attachment Type code values, click on the link associated with it to open the
Code Values configuration screen. The Attachment Type is used to define which types of
attachments a user is associating to a Change Request or an Issue. The default values delivered
with Phire can be deleted or customized and entirely new values can be added based on your
requirements.

Field Name Description


Code Value A field used to define the ID by which the Code Value will be
referenced.
Status A drop-down box used to denote whether the Code Value is active or
inactive.
Code Description A field used to define a short description for the Code Value.
Default One code value can be selected as a default and will subsequently be
used as the default when opening new items.
Updated By A read-only field used to show which ID last updated the Code Value.
Updated DateTime A read-only field used to show the date/time when the Code Value
was last updated.

Copyright @ 2020 Phire. All rights reserved. Page 6 of 24


3.5 File Type

To configure the File Type Application Code, click on the link associated with it to open the Code
Values configuration screen. The File Type Application Code is used to determine which file
types can be versioned and migrated automatically. The default values delivered with Phire can
be deleted or customized and entirely new values can be added based on your requirements.

Field Name Description


Code Value A field used to define the ID by which the Code Value will be
referenced.
Status A drop-down box used to denote whether the Code Value is active or
inactive.
Code Description A field used to define a short description for the Code Value.
Convert Name to If selected, this option will convert the name of the file to lowercase
Lower Case when added to the Object List in the Change Request. Selecting this
option is useful if you want the filenames to be consistent (all
lowercase regardless of what was specified by the developer). This
option should not be selected for file types that are case sensitive as in
operating systems like UNIX and Linux.
Compare Allowed If selected, the ability to run compare reports from the CR Objects page
will be enabled. This option should only be selected for text-based file
types such as SQR. Binary file types such as Crystal Reports are not
comparable using Phire.
Directory Details Access to the detailed file directory setup for the selected File Type.
Updated By A read-only field used to show which ID last updated the Code Value.
Updated DateTime A read-only field used to show the date/time when the Code Value
was last updated.

Copyright @ 2020 Phire. All rights reserved. Page 7 of 24


3.6 Functional Area / Module

To configure the Functional Area Application Code, click on the link associated with it to open
the Code Values configuration screen. The Functional Area Application Code is used to define
the types of functional areas that can be associated with Change Requests and Issues. The default
values delivered with Phire can be deleted or customized and entirely new values can be added
based on your requirements.

Field Name Description


Code Value A field used to define the ID by which the Code Value will be
referenced.
Status A drop-down box used to denote whether the Code Value is active or
inactive.
Code Description A field used to define a short description for the Code Value.
Default One code value can be selected as a default and will subsequently be
used as the default when opening new items.
Updated By A read-only field used to show which ID last updated the Code Value.
Updated DateTime A read-only field used to show the date/time when the Code Value
was last updated.

3.7 Note Type

To configure the Note Type Application Code, click on the link associated with it to open the
Code Values configuration screen. The Note Type Application Code is used to define which types
of Notes can be added to a Change Request or Issue. The default values delivered with Phire can
be deleted or customized and entirely new values can be added based on your requirements.

Copyright @ 2020 Phire. All rights reserved. Page 8 of 24


Field Name Description
Code Value A field used to define the ID by which the Code Value will be
referenced.
Status A drop-down box used to denote whether the Code Value is active or
inactive.
Code Description A field used to define a short description for the Code Value.
Updated By A read-only field used to show which ID last updated the Code Value.
Updated DateTime A read-only field used to show the date/time when the Code Value
was last updated.

3.8 Notification Method

To configure the Notification Method Application Code, click on the link associated with it to
open the Code Values configuration screen. The Notification Application Code is used to define
which types of Notification methods a user can define as their preferred contact method in their
User Preferences. The default values delivered with Phire can be deleted or customized and
entirely new values can be added based on your requirements.

Copyright @ 2020 Phire. All rights reserved. Page 9 of 24


Field Name Description
Code Value A field used to define the ID by which the Code Value will be
referenced.
Status A drop-down box used to denote whether the Code Value is active or
inactive.
Code Description A field used to define a short description for the Code Value.
Updated By A read-only field used to show which ID last updated the Code Value.
Updated DateTime A read-only field used to show the date/time when the Code Value
was last updated.

3.9 Database Type

To configure the Database Type Code, click on the link associated with it to open the Code Values
configuration screen. The Database Type Code is used to provide information about the purpose
of the database. There are no technical database requirements associated with this Application
Code; instead, the values act as a general label so that the user creating or viewing a database will
know which type of database they are working with. The default values delivered with Phire can
be deleted or customized and entirely new values can be added based on your requirements.

Copyright @ 2020 Phire. All rights reserved. Page 10 of 24


Field Name Description
Code Value A field used to define the ID by which the Code Value will be
referenced.
Status A drop-down box used to denote whether the Code Value is active or
inactive.
Code Description A field used to define a short description for the Code Value.
Updated By A read-only field used to show which ID last updated the Code Value.
Updated DateTime A read-only field used to show the date/time when the Code Value
was last updated.

3.10 iForm

To configure the iForm Application Code, click on the link associated with it to open the Code
Values configuration screen. The iForm application codes are used to define iForms. The online
forms can be used to replace manual forms such as PeopleSoft User Access Forms and
Configuration Data Change Requests (new vendors, new accounts, etc.). For a detailed
description of how to create iForms, refer to document entitled iForm_Builder.pdf.

Copyright @ 2020 Phire. All rights reserved. Page 11 of 24


Field Name Description
Code Value A field used to define the ID by which the Code Value will be
referenced.
Status A drop-down box used to denote whether the Code Value is active or
inactive.
Code Description A field used to define a short description for the Code Value.
Issue iForm Detail This value references an Application Designer page definition that will
Page be used to display the associated form within the Issue component.
The delivered default page definition is: PHI_IS_DOC_DTL.
CR iForm Detail This value references an Application Designer page definition that will
Page be used to display the associated form within the CR component. The
delivered default page definition is: PHI_CR_DOC_DTL.
iForm Fields This button opens a secondary page where the detailed fields are
activated and configured for the form.
Updated By A read-only field used to show which ID last updated the Code Value.
Updated DateTime A read-only field used to show the date/time when the Code Value
was last updated.

3.11 CR Task Failure Reason

To configure the Failure Reason Application Code, click on the link associated with it to open the
Code Values configuration screen. The Failure Reason application codes are referenced when
tasks are failed or denied in the CR workflow and are used to describe the reason for the failure.

Copyright @ 2020 Phire. All rights reserved. Page 12 of 24


Field Name Description
Code Value A field used to define the ID by which the Code Value will be
referenced.
Status A drop-down box used to denote whether the Code Value is active or
inactive.
Code Description A field used to define a short description for the Code Value.
Default One code value can be selected as a default and will subsequently be
used as the default when opening new items.
Updated By A read-only field used to show which ID last updated the Code Value.
Updated DateTime A read-only field used to show the date/time when the Code Value
was last updated.

3.12 CR Task Skip Reason

To configure the CR Task Skip Reason Application Code, click on the link associated with it to
open the Code Values configuration screen. The CR Task Skip Reason Application Code is used
to define the reason for skipping an optional CR task. The default values delivered with Phire
can be deleted or customized and entirely new values can be added based on your requirements.

Copyright @ 2020 Phire. All rights reserved. Page 13 of 24


Field Name Description
Code Value A field used to define the ID by which the Code Value will be
referenced.
Status A drop-down box used to denote whether the Code Value is active or
inactive.
Code Description A field used to define a short description for the Code Value.
Default One code value can be selected as a default and will subsequently be
used as the default when opening new items.
Updated By A read-only field used to show which ID last updated the Code Value.
Updated DateTime A read-only field used to show the date/time when the Code Value
was last updated.

3.13 Hyperlink Type

To configure the Hyperlink Type Application Code, click on the link associated with it to open
the Code Values configuration screen. The Hyperlink Type Application Code is used to define
categories of Hyperlinks that will be made available. The default values delivered with Phire can
be deleted or customized and entirely new values can be added based on your requirements.

Copyright @ 2020 Phire. All rights reserved. Page 14 of 24


Field Name Description
Code Value A field used to define the ID by which the Code Value will be
referenced.
Status A drop-down box used to denote whether the Code Value is active or
inactive.
Code Description A field used to define a short description for the Code Value.
Default One code value can be selected as a default and will subsequently be
used as the default when new hyperlink is created.
Updated By A read-only field used to show which ID last updated the Code Value.
Updated DateTime A read-only field used to show the date/time when the Code Value
was last updated.

3.14 Resolution Code

To configure the Resolution Code, click on the link associated with it to open the Code Values
configuration screen. This code value is used to populate the drop-down representing the
resolution on the main CR and Issue pages. The default values delivered with Phire can be
deleted or customized and entirely new values can be added based on your requirements.

Copyright @ 2020 Phire. All rights reserved. Page 15 of 24


Field Name Description
Code Value A field used to define the ID by which the Code Value will be
referenced.
Status A drop-down box used to denote whether the Code Value is active or
inactive.
Code Description A field used to define a short description for the Code Value.
Updated By A read-only field used to show which ID last updated the Code Value.
Updated DateTime A read-only field used to show the date/time when the Code Value
was last updated.

3.15 Resource Type

To configure the Resource Type Application Code, click on the link associated with it to open the
Code Values configuration screen. The Resource Type Application Code is used to define
categories of Resources that can be assigned to the Change Request. The default values delivered
with Phire can be deleted or customized and entirely new values can be added based on your
requirements.

Copyright @ 2020 Phire. All rights reserved. Page 16 of 24


Field Name Description
Code Value A field used to define the ID by which the Code Value will be
referenced.
Status A drop-down box used to denote whether the Code Value is active or
inactive.
Code Description A field used to define a short description for the Code Value.
Updated By A read-only field used to show which ID last updated the Code Value.
Updated DateTime A read-only field used to show the date/time when the Code Value
was last updated.

3.16 Migration Information

This configuration populates a list of values available on the Migration Note page in the Change
Request component. This can be used to add custom information to that page without modifying
the page directly through PeopleTools.

Field Name Description


Code Value A field used to define the ID by which the Code Value will be
referenced.

Copyright @ 2020 Phire. All rights reserved. Page 17 of 24


Status A drop-down box used to denote whether the Code Value is active or
inactive.
Code Description A field used to define a short description for the Code Value.
Updated By A read-only field used to show which ID last updated the Code Value.
Updated DateTime A read-only field used to show the date/time when the Code Value
was last updated.

Copyright @ 2020 Phire. All rights reserved. Page 18 of 24


Appendix A: Configuring Notifications for Issue Type
Open Code Name = Issue Type
To access the Notification configuration screen for Issues, click the Notification icon for the
associated Code Value.

Notifications are used to automatically notify a person or a mailing list via email when an Issue
of a specific type has been modified in some way. These are the different events that can trigger
an automatic notification:

1. Issue Opened
2. Change in Issue Assignee
3. New Note Entered
4. Status Changed
5. Issue Closed
6. Issue Priority Set to Highest Priority

Note. SMTP needs to be configured on the Phire application server to utilize email
Notifications.

Copyright @ 2020 Phire. All rights reserved. Page 19 of 24


Field Name Description
Issue Type A read-only field used to show which Code Value is being configured.
Event A field used to define what type of Event is going to trigger a
Notification to be sent.
Note. Use the search icon (magnifying glass) to select the type of
Event that will be defined. This field must be filled with one of the
Event types that appear when the search icon is selected.
Status as of A drop-down box used to denote whether the Flex Field is active or
Effective Date inactive.
Note. Any changes to the Status of an Effective Date field are not
reflected in any Issues created prior to the change.
Email Template ID A field used to define which email template will be used when the
Notification is sent.
Note. Refer to the Phire Email Templates administrative document for
details on Email Templates.
Reply to Email A field used to define the “reply to” email address that will be used
Address when the Notification is sent (optional field).
Send to Opened by A check box used to determine if the user who opened the Issue will
User be included when the Notification is sent.
Send to Assigned A check box used to determine if the user to which the Issue is
User currently assigned will be included when the Notification is sent.
Send to Customer A check box used to determine if the customer defined in the Issue will
be included when the Notification is sent.
Sent to Notify A check box used to determine if the notify user/role on the main
Issue page should be copied on the email.
Additional To Additional email addresses can be entered in this area and included on
the email notifications. Multiple addresses can be listed, separated by
semi-colons. The “USER: <user>” and “ROLE: <role>” convention
can also be used to automatically resolve to the named user id, or all
members of the named role.
Additional CC Additional email addresses can be entered in this area and included on
the email notifications. Multiple addresses can be listed, separated by
semi-colons. The “USER: <user>” and “ROLE: <role>” convention
can also be used to automatically resolve to the named user id, or all
members of the named role.
Additional BCC Additional email addresses can be entered in this area and included on
the email notifications. Multiple addresses can be listed, separated by
semi-colons. The “USER: <user>” and “ROLE: <role>” convention
can also be used to automatically resolve to the named user id, or all
members of the named role.

Copyright @ 2020 Phire. All rights reserved. Page 20 of 24


Appendix B: Configuring Description Templates for Issue Type
To access the Description Templates configuration screen, click the Description Template icon for
the associated Code Value you wish to update. The icon is pictured below:

Description Templates are used to provide guidance for what information a user should include
in the Issue Description based upon the Issue Type. The Description Template will appear in the
Description field for all the Issues created with the Issue Type and defined by the Description
Template.

Copyright @ 2020 Phire. All rights reserved. Page 21 of 24


Appendix C: Configuring Flex Fields for CR and Issue Type
To access the Flex Fields configuration screen, click the Flex Fields icon for the associated Code
Value you wish to make changes for. The icon is pictured below:

Flex Fields are used to add nonstandard fields to a Change Request or Issue. Any fields defined
in this way will appear in a Change Request or an Issue when the CR or Issue Type Application
Code is set to the Code Value for which you define the Flex Field.

Field Name Description


CR (or Issue) Type A read-only field used to show which Code Value is being configured.
Name A field used to define what type of Flex Field is going to be configured
Note. Use the search icon (magnifying glass) to select the type of Flex
Field that will be defined. This field must be filled with one of the Flex
Field types that appear when the search icon is selected.
Field Type A read-only field used to show the type of field that is being defined
based upon which Name was selected.
Length A read-only field used to show the length of the field that is being
defined based upon which Name was selected.
Decimal Positions A read-only field used to show the number of decimal positions
contained in the field that is being defined based upon which Name
was selected.
Status A drop-down box used to denote whether the Flex Field is active or
inactive.
Label A field used to define the label which will be shown in the Change
Request or Issue next to the field to allow the user to realize what that
Flex Field should be used for.
Prompt Record A field used to query against a specific record stored in the database.
Required A check box used to determine whether the Flex Field will be required
to have an entry before the Change Request or Issue can be created.

Copyright @ 2020 Phire. All rights reserved. Page 22 of 24


Appendix D: Configuring Field Labels for CR and Issue Type
To access the Field Label configuration screen, click the Field Labels icon for the associated Code
Value you wish to make changes for. The icon is pictured below:

The Field Labels feature is used to override the default page label for the standard fields on the
Change Request or Issue.

Field Name Description


CR (or Issue) Type A read-only field used to show which Code Value is being configured.
Default Label This is the delivered default label in Phire. Select the label that you
wish to override.
Override Label This value is the label you wish to use in place of the delivered default
label.
Status A drop-down box used to denote whether the Flex Field is active or
inactive.

Copyright @ 2020 Phire. All rights reserved. Page 23 of 24


Appendix E: Configuring Required Fields in CR and Issue Type
To access the Required Field configuration screen, click the Required Field icon for the associated
Code Value you wish to make changes for. The icon is pictured below:

The Required Field feature is used to enforce a rule that requires configured fields in either the
CR or Issue module. The value must be populated immediately when saving the item the first
time.

Field Name Description


CR (or Issue) Type A read-only field used to show which Code Value is being configured.
Original Field This is the delivered Phire field name which is being configured to be
Name required.
Status A drop-down box used to denote whether the Flex Field is active or
inactive.

Copyright @ 2020 Phire. All rights reserved. Page 24 of 24

You might also like