You are on page 1of 21

Implementation Guide

Version 9
XFRACAS 9 Implementation Guide
Part Identification: RPIGXFR9

ReliaSoft Corporation
Worldwide Headquarters
1450 South Eastside Loop
Tucson, Arizona 85710-6703, USA
Tel: 1-520-886-0410 Fax: 1-520-886-0399
Sales and Information: 1-888-886-0410 (Toll-free i the U.S. and Canada
ReliaSoft@ReliaSoft.com http://www.ReliaSoft.com

2006-2015 ReliaSoft Corporation, ALL RIGHTS RESERVED.

Notice of Rights
If you are a licensed user of the software you are hereby granted the right to print this
document in whole or in part, as needed for your exclusive use in conjunction with the use of
the software. Except for the limited print rights outlined above, no part of this document may
be reproduced or transmitted, in any form or by any means, for any purpose, without the
express written permission of ReliaSoft Corporation, Tucson, AZ, USA.

Disclaimer
Information in this document is subject to change without notice and does not represent a
commitment on the part of ReliaSoft Corporation.

Companies, names and data used herein are fictitious unless otherwise noted.

Use of the software and this document are subject to the terms and conditions set forth in
the accompanying License Agreement.

This software and documentation were developed at private expense; no portion was
developed with government funds.

Trademarks
ReliaSoft, Synthesis Platform, Weibull++, ALTA, DOE++, RGA, BlockSim, RENO, Lambda
Predict, Xfmea, RCM++ and XFRACAS are trademarks of ReliaSoft Corporation.

Other product names and services identified in this document are trademarks of their
respective trademark holders, and are used for illustration purposes. Their use in no way
conveys endorsement or other affiliation with ReliaSoft Corporation.

10 9 8 7
XFRACAS 9
Implementation 1
This document provides a brief guide to the process of configuring XFRACAS to meet your
organizations needs, from installation to setup.

1.1 System Requirements and Capabilities


XFRACAS has been designed as a Web-based system to serve the needs of large organizations. It is
based on the .NET Framework and is designed to be n-tier, scalable, distributable, robust and able to
be deployed across multiple servers or on a single computer.

Server:
Windows 2008 R2, Windows 2012 (Note: Windows 2003 is not supported.)
.NET 4.0
IIS with support for serving ASP.NET
SQL Server 2005, 2008, 2008 R2, 2012 OR Oracle 10g, 11g (32-bit and 64-bit versions of all,
full version only)
Clients:
XFRACAS is compatible with any browser that supports the following doctype:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/
xhtml1/DTD/xhtml1-transitional.dtd">
If the clients are using any version of Internet Explorer, then compatibility mode needs to be
turned off for this website to function properly.
XFRACAS supports data import from and export to the following:

XML
Microsoft Excel

XFRACAS Implementation Guide 1


1 XFRACAS 9 Implementation

SQL Server
Oracle
Microsoft Access
Flat file (tab-delimited, comma-delimited, etc.)
Database view
Any database using OLE DB

1.2 Pre-Installation Concerns


If you are setting up for the SQL Server version:
Make sure you have the latest version of SQL Server running. To do this, run the following
query in Query Analyzer: Select @@version. This should return a value like Microsoft
SQL Server 2005 - 9.00.3042 (Intel X86) or Microsoft SQL Server 2008 R2 - 10.50.1617
(X64), depending upon which SQL Server service pack you have installed.
Make sure you know the SQL Server Name. This is a local server name or IP address so the
IIS machine with the .NET application can connect to the database. If you are using an
instance other than the default instance, make sure you know which instance of SQL server
you are using. These instructions assume that you are using a default instance of SQL server to
host the Synthesis repository.
If you are setting up for Oracle:
For easier support, the SQL Worksheet or Oracle SQL Developer should be installed. The
SQL Worksheet is installed with the Enterprise edition of the Oracle installation. The Oracle
SQL Developer and its installation guide can be downloaded from the Oracle Web site.
Your account (i.e., the one that is doing the installation) or the Oracle account you are using
should have permissions to create a database on the database server. Typically, this is a System
Admin account.

1.2.1 IIS Settings


User Account Control (UAC) can either be left on or turned off for installation of XFRACAS.

You will need to install the IIS role.

Open the Server Manager (available in the Administrative Tools list).


In the Roles Summary area, click the Add Roles link on the right side of the window. The Add
Roles Wizard will appear.

2 http://XFRACAS.ReliaSoft.com
1.2 Pre-Installation Concerns

Click Server Roles in the navigation area on the left side of the window and then, on the right side
of the window, select the Web Server (IIS) check box and click Install. Make sure that the
following services are installed when you install the IIS role:
Under Web Services:
Under Common HTTP Features:
Static Content
Default Document
Directory Browsing
HTTP Errors
Under Application Development:
ASP.NET
ASPX
ISAPI Extensions
Server Side Includes
Under Health and Diagnostics:
HTTP Logging
Logging Tools
Request Monitor
Custom Logging
Under Security:
Windows Authentication
Request Filtering
IP and Domain Restrictions
Performance, including:
Static Content Compression
Dynamic Content Compression
Under Management Tools:
IIS Management Console
If you need SSL support, you must have Active Directory Certificate Services installed. Please
consult your network administrator if you have questions about this.

XFRACAS Implementation Guide 3


1 XFRACAS 9 Implementation

1.3 Gather Information


Before you begin configuration, you will need to gather enough information for the minimum
configuration of XFRACAS. This consists of:

System-Wide Preferences
The system-wide preferences, presented in detail in Section 1.6.1, include information such as
server names and file management options. At this point, you should gather the necessary
information for and/or make decisions about the settings for all system-wide preferences. You will
set these in Section 1.6.1.
User Information
A list containing first name, last name, user name (NT login), and e-mail address for each user
is the minimum required.
Additional information at this stage that will be useful later is a preliminary idea of how users
might be grouped. Configuring user groups to assign permissions is much more efficient than
assigning permissions individually to each user.
Although it is not required, you may also wish to have the rest of the user information at this
point. This information may include middle name, city, state, ZIP code, country and employee
ID. Entering all of the information now will avoid any need to go back and add information
later.
System Parts/Templates/B.O.M.
There are a number of different kinds of tracking that XFRACAS can perform. You can perform
either product tracking or process (non part-related) tracking. For product tracking, you can
choose to track serialized or non-serialized systems. The form your system configurations will
take in XFRACAS and, consequently, the information you need for this step depend on the type of
tracking you want to do.
Serialized Systems: XFRACAS bases serialized systems on generic templates. You can think
of each part number as referring to a generic model, or archetype, of a part or system, while
the serial number refers to a single instantiation of its part number. If you plan to track
serialized systems and/or parts, you will need all of the following information:
A list of all parts to be tracked in XFRACAS. This can be assembled as a *.xml file using
the Template/System.DTD, it can be simply a list of parts that need to be created through
the administrative user interface, or it can be a BOM imported from a XMFEA. For each
template part, XFRACAS requires a part number or a part description. For each serialized
part, XFRACAS requires the serial number as well as the part number or part description
of the template for that part.

4 http://XFRACAS.ReliaSoft.com
1.3 Gather Information

A definition of how these parts fit together (i.e. are they all individual parts or, if not, what
is the structure in which they are related?). This is normally part of the list of Templates
and Serialized Parts.
A list of users that will be responsible for each generic part in the system. At least one part
in the system must have a responsible individual. It is recommended, however, that all top-
level parts be assigned a responsible individual.
Non-Serialized Systems: If you plan to track parts and systems that are not serialized, you
only need to create the generic templates. You will need the following information:
A list of all parts to be tracked in XFRACAS. As above, this can be assembled as a *.xml
file using the Template/System.DTD, it can be simply a list of parts that need to be created
through the administrative user interface, or it can be a BOM imported from a XMFEA.
For each template part, XFRACAS requires a part number or a part description.
A definition of how these parts fit together (i.e. are they all individual parts or, if not, what
is the structure in which they are related?).
A list of users that will be responsible for each generic part in the system. At least one part
in the system must have a responsible individual. It is recommended, however, that all top-
level parts be assigned a responsible individual.
Note that the level of detail required for templates can vary depending on how you plan to use
them. You can create and track each part and every part version. Such tracking might be
appropriate for hardware, as it allows tracking of failures for parts based on the version of the
specific part itself, effectively independent of the system the part is in. In other cases, you
might wish to use a dummy template-- a single template for a system, in which part version
is not tracked. For example, in the case of software, the entire system gets a new version
number at each release, but the version number is not specific to individual modules within the
software. You could use a single dummy template and track the software version using a detail
field within each incident and/or problem.
Part Independent: If you plan to use XFRACAS for process-related tracking, in which
incidents refer to tasks or processes rather than to specific parts, you will need only a generic
structure to assign responsible individuals for the various processes.
For product tracking, serialized and non-serialized tracking achieve the same results in terms of
failure analysis and problem resolution. Serialized tracking, by allowing you to track specific
serialized parts, provides the ability to track issues for specific customers and allows you to
collect more accurate reliability data for further analysis. However, the system setup can be
considerably more complicated because of the need to manage all serialized systems.
Your choice of tracking type will also affect the type(s) of incidents you will need to use and,
therefore, your administrative preferences.
Note that, in addition to gathering information on parts and responsible individuals, you should
also gather a list of any distinct failure modes or FMEA information that exist for parts.

XFRACAS Implementation Guide 5


1 XFRACAS 9 Implementation

Sample Data from Any Current FRACAS System or Process


This should be assembled in order to configure XFRACAS to be able to capture appropriate
data. The kind of data captured, any required fields and notes on any additional data that the
current system doesnt capture are useful at this stage.
If the data contain lists of items for selection, assemble those lists and determine whether or
not they interact with each other or with other parts of the system. For example, note any data
that might be selected based on a particular part or any behavior for selection that the current
system (if any) supports. For automated imports, this can be formatted as a *.xml import using
the Issue.DTD as a template.

1.4 Installation
To install XFRACAS, do the following in the order specified.

1. Run XFRACAS9.exe. Follow the steps in the wizard.


2. Run XfracasActivation.exe. You will need to run this as an administrator or allow it to be ele-
vated to administrator. For activation, the new license will follow Synthesis license protocol and
will be registered to a specific e-mail address. This e-mail address will receive notification of the
product license key that will be required to activate the license. Note that if the hardware changes
for any reason, this will change the underlying Machine PIN that is used in encoding the license,
and the license will need to be reactivated to work. Therefore, from a support standpoint, the e-
mail address used should be one that someone who changes the hardware would have access to,
in order to get the system back up and running. This will be the same account for all stages of
license usage from development to production.
3. Run SynthesisAdmin9.exe. You will need to run this as an administrator or allow it to be ele-
vated to administrator. Two steps are involved:
Create a New Version 9 Enterprise Repository. This is the database that all XFRACAS data
will be stored in, along with any associated data for other Synthesis applications. Your account
will automatically be set up as the administrator for the database. You can choose to create the
new database in either Oracle or Microsoft SQL Server.
If you choose SQL Server, you will be required to enter:
Server Name: The name of the Microsoft SQL Server implementation where the new
database will be created.
Database Name: The name of the new database that will be created.
If you choose Oracle, you will be required to enter:
Port, Host and Service identifiers for the Oracle server where the new database will be
created.

6 http://XFRACAS.ReliaSoft.com
1.5 Post-Installation Steps

Schema of the new Enterprise database.


Password for the new enterprise database schema.
The administrative username and password for the Oracle server.
For either server type, select the Import from existing repository check box if you want to
import data from an existing database.
Update XFRACAS Configuration File. This sets up the database connection string and
updates the web configuration file with information about the account that it needs to
impersonate (i.e., the username that XFRACAS will run as). Depending on where the
XFRACAS application is being installed in relation to the database server and what type of
server you are using, this may be a local user account that you set up on the server or an Active
Directory account.
If you are running the system on a SQL Server database using Trusted Authentication:
If the application is running on the same machine as SQL Server, the account you use
can be either local or an Active Directory account.
If the application is running on a different machine from SQL Server, the account must
be an Active Directory account.
You will need to add the account as a User in SQL Server, assign it a public server role
and give it the following database roles: db_datareader, db_datawriter, db_ddladmin,
db_securityadmin.
If you are running the system on an Oracle database, XFRACAS will connect to the
database by supplying a username and password directly to the database, rather than via
Windows authentication. You should set up the local account for the database now. The
username and password are provided during the database creation.
This also sets up the XFRACAS DIU Service to run as this impersonated account. The
XFRACAS DIU service sends out reminder e-mails for past due actions or Problem FRBs.
It also automatically processes any *.xml files that have been imported to the database and
are waiting to be processed.

1.5 Post-Installation Steps


After installation, there are additional settings that you can specify in the IIS Manager.

If .NET 4.0 was pre-existing on the IIS server (i.e., if it was already installed and not installed via
the XFRACAS installation), you may encounter a server error the first time you attempt to access
XFRACAS. If this happens, you will need to give full permissions for the .NET temporary folder
(C:\Windows\Microsoft.NET\Framework\v4.0.30319\Temporary ASP.Net Files\) to the account
that the XFRACAS application is running as (specified in the XFRACAS configuration file). You
may need to take ownership of this folder before you are able to do this.

XFRACAS Implementation Guide 7


1 XFRACAS 9 Implementation

For SSL support, do the following:


In the Connections pane, open the Sites node under the server name. Click the XFRACAS
site.
In the Actions area on the right side of the window, click the Bindings link and then click the
Add button in the Site Bindings window that appears.
Add a site binding of type https and specify your SSL certificate. Close the Site Bindings
window.
Double-click the SSL Settings icon under IIS, then select the Require SSL option and the
Ignore option.
If you are planning to allow attached files to be stored within a folder on the server instead of in
the database (i.e., if the Attachments - Allow Uploaded Files preference will be set to True and the
Attachments - Store Uploaded Files in Database preference will be set to False), then do the
following:
Set up your application pool as follows:
In the Connections pane, click Application Pools.
Add an application pool or modify the default application pool.
Leave the identity as ApplicationPoolIdentity.
Right-click the pool and choose Basic Settings. In the window that appears, for the
managed pipeline mode, choose Classic.
Return to the Connections pane. Set up the Attachments folder as follows:
Create the Attachments folder, if it doesnt already exist, as follows:
In the Connections pane, open the Sites node under the server name.
Right-click the Default Web Site node and choose Add Virtual Directory.
Set the directory alias to Attachments and specify the physical path to be the location
where you want to store the attachments.
Return to the Connections pane. Click the Attachments node and, in the Home Page on
the right, double-click Authentication.
Set Forms Authentication to Disabled.
Return to the Connections pane. Right-click the Attachments node and choose Convert
to Application.
Select the new application pool that you just created.

8 http://XFRACAS.ReliaSoft.com
1.5 Post-Installation Steps

For large systems1: An Out of Memory error can occur when the request for pages exceeds the
systems capability to release and recycle the memory with the default IIS settings. The settings
provided here force IIS to recycle the memory usage and handle the memory usage better so that
the Out of Memor error does not occur. Note that being too aggressive with regard to how
memory is recycled can slow down the response of the system. Typically, memory is recycled
when the application pool and the server are not busy. Forcing memory recycling to happen more
often can take up processor cycle time when the application is still busy, thus slowing down
XFRACAS performance. These settings have been tested to prevent the error occurring while
making the minimum possible impact on performance.
In the Connections pane, click Application Pools.
Right-click the XFRACAS application pool and choose Recycling on the shortcut menu.
In the Application Pool Recycling Settings window that appears, specify the following
settings:
In the Fixed Intervals area, select Regular time intervals and enter 1740.
In the Memory Based Maximums area, select Private memory usage and enter
1,024,000.
Click Next.
Select to log the following events:
Regular time intervals
Private memory usage
Unhealthy ISAPI
In addition, note that the XFRACAS - Enable Spell Checker preference has a large memory
footprint. Therefore, it is recommended that this preference be turned off for high use systems.
This can be turned off within the administrative Preferences page for each entity. Most modern
browsers have built in spell check, so this functionality is actually redundant with the built-in
browser support. It is supplied only for the convenience of customers that are using legacy
browsers (e.g., IE 8) and require spell check.

1.
A large system is any system with over 100 users, or any system that experiences an Out of Memory error
due to high transactional load.

XFRACAS Implementation Guide 9


1 XFRACAS 9 Implementation

In the Configuration Manager, you should specify the maximum files sizes that can be uploaded/
downloaded.
In the Section drop-down list, choose system.webServer/asp.
The maxRequestEntityAllowed value sets the maximum file size that can be uploaded to
the server. The value is set during installation to 4,194,304, or 4 MB; you can, however,
enter another value to suit your needs.
The bufferingLimit value sets the size of the buffer that holds the response sent back to
the client. The value is set during installation to 4,194,304, or 4 MB; you can, however,
enter another value to suit your needs. This value should be changed if you are running
very large reports and find that they do not respond.
In the Section drop-down list, choose system.webServer/caching.
The maxResponseSize value sets the maximum file size that can be returned to the client.
The value is set during installation to 262,144; you can, however, enter another value to
suit your needs.
In the Section drop-down list, choose system.web/httpRuntime.
During installation, the maximum file size that can be uploaded to the server is set to 4
MB; you can, however, enter another value to suit your needs by changing the
maxRequestLength value. This value is given in kilobytes. The default value is 4,096
kilobytes (i.e., 4*1024).

1.6 Initial Configuration


You can now use the information from step 1 to configure XFRACAS. Keep in mind that this is an
initial configuration and can be modified as needed at any time.

1.6.1 System Preferences I


On the administrative Preferences page, configure the System-Wide preferences as follows:

Attachments - Allow Uploaded Files: Indicates whether attachments can be uploaded to the
XFRACAS database via the Attachment Information utility.
Attachments - Store Uploaded Files in Database: Indicates whether attachments will be stored
in the database. If False, files will be stored on the server, in the location specified in the
Attachment - Uploaded Files Filesystem Prefix preference.
Single Sign-On (SSO) Authentication Enabled: Indicates whether single-sign on (SSO)
authentication can be used to control access to XFRACAS. If set to True, the Single Sign-On
(SSO) Server Variable field in the System-Wide Preferences area must be populated.

10 http://XFRACAS.ReliaSoft.com
1.6 Initial Configuration

SSL Server Mode Required: Turns on Secure Sockets Layer support, requiring you to use
XFRACAS on a secure Web server. If your system will be run over the Internet, we recommend
using SSL. In order to use XFRACAS via SSL, the IIS server must be configured to support SSL.
Terms of Use Agreement Page Required: If set to True, a Terms of Use agreement page will be
displayed the first time a user accesses the XFRACAS system each day. Clicking OK redirects the
user to the home page. The content of this page is created and maintained by the system
administrator in the agreement.asp file, which is located in the publishing directory and in the
admin directory within the publishing directory. If the user accesses the application via the main
home page, the version in the publishing directory will be used. If the user access the
administrative side of the application directly, the version in the admin directory will be used.
Report Filter Display Max Rows: Indicates the maximum number of results that a report can
return and still have filtering and grouping capabilities. These capabilities will be turned off if a
report returns more than this number of results.
SMTP connection timeout: The amount of time, in seconds, before the connection to the SMTP
server times out when sending e-mails.
SMTP Port: The port used to connect to the SMTP server. The default value is 25, but this can be
altered to allow for changes in the SMTP server configuration.
DB Version: The database version of the XFRACAS system. This is available for technical
support purposes and cannot be changed.
License Number: The license number used for accessing the XFRACAS system. This is
available for technical support purposes and cannot be changed.
Attachment - Uploaded Files Filesystem Prefix: Specifies the location on the server where
attachments will be stored if they are not stored in the database. This is an absolute path on the
server (e.g. C:\inetpub\wwwroot\XFRACAS\uploads\).
Attachment - Uploaded Files IIS Prefix: The prefix used to build the link for downloading the
uploaded file. This is a path relative to the Web server root on the server (e.g.
\XFRACAS\uploads\).
Single Sign-On (SSO) Server Variable: The variable that will be populated by the single sign-on
(SSO) server. To use SSO authentication, the Single Sign-On (SSO) Authentication Enabled
preference in the System-Wide Preferences area must be set tot True.
SMTP Server: The address of the SMTP server for sending e-mails. This is the mail server that
the application can connect to and relay through.
XFRACAS Server - Filesystem Prefix: The location on the server where the IIS folder is
installed. This is an absolute path on the server (e.g., C:\inetpub\wwwroot\XFRACAS\).
XFRACAS Server - IIS Prefix: The Web server for the XFRACAS system. This is used to create
the html links that appear in e-mails that are automatically sent by the system. The IIS Server

XFRACAS Implementation Guide 11


1 XFRACAS 9 Implementation

Name can be either a static IP address or something that gets looked up through a DNS. It can be
reached either internally or externally, depending on whether your system will be run over an
intranet or over the Internet.
In addition, in the String Preferences area, you will need to ensure that the long date format and the
short date format match the culture setting within IIS in order for dates shown in charts to be
displayed correctly.

1.6.2 Users/Groups
Create or import the users, depending on the format of existing user information.
Confirm that users are able to log in to the system (see the main XFRACAS page).
Configure user groups to organize user permissions and categories before assigning individual
permissions to any users. Once users have been placed in groups, individual users can be assigned
additional permissions as needed. For example, you might want to use groups such as:
Read Only Users: users who can access the system and view records, but cannot create or
change records
Regular Users: users who can view, create and change records but have no administrative
permissions (i.e. they cannot make changes to the system itself)
Administrative Users: users who can view, create and change records and can modify the
system (e.g. add/modify users, work with system configurations, add/remove detail fields,
etc.)
Note that at least one user will need full permissions in order to set up any additional users or
change permissions on other users.

1.6.3 Systems/Parts
Import generic and/or serialized systems/parts into XFRACAS or create them, then review them for
accuracy. Assign responsible individuals where appropriate and create any additional systems or parts
as needed.

If the data being tracked are based on discrete parts, serialized systems should be created or
imported to represent those parts. An example of a situation in which you might use serialized
systems is tracking the maintenance and repair of turbine generators, each of which has a unique
serial number. Each turbine would be entered in the system and incidents could then be filed
directly for each specific turbine commissioned to a customer.
If the data being tracked are not for individual parts, but rather for classes of parts, then system
templates may be sufficient. An example of this is tracking failures for various models of an
appliance. Each individual appliance would not be entered into XFRACAS; rather, the appliance

12 http://XFRACAS.ReliaSoft.com
1.6 Initial Configuration

model would be entered as a system template and incidents could be filed for that system template
instead of for a specific appliance.
Some or all of your parts may have associated failure modes. You can manually create failure modes
and associate them with parts using the Templates page or you can import the failure modes directly
from the Synthesis repository based on Xfmea data that you stored from your FMEA process. In
addition, failure modes can be created on the fly from any Failure Mode field in the user interface if
you have permissions to do so. You can, however, load a predefined list of failure modes and restrict
users to only those failure modes if desired. To do this, you will need to clear the Allow User
Creation check box for failure mode fields.

XFRACAS failure mode information can also be imported into Xfmea/RCM++/RBI.

1.6.4 Determine How the Transaction Records Are Used


If there is an existing system, the records in the existing system need to be mapped to the transaction
records in XFRACAS. For example, trouble tickets describing an individual occurrence of a
problem in an existing system might be mapped to incidents in XFRACAS.

The various transaction records in XFRACAS are related to each other in specific ways. These should
be kept in mind when deciding how to use each record. The broadest type is the project, which can
contain multiple problems. A single problem can contain multiple incidents, and each incident can
contain multiple failure analysis records. These are essentially hard-coded relationships. Projects,
problem and incidents can be created independently of each other and relationships created between
them afterwards. A failure analysis record, however, can only be created from an existing incident
record. A customer support information record (CSI) can also have multiple associated incidents.
CSIs are not required, and are applicable only when serialized systems are tracked in XFRACAS.

1.6.5 Detail Fields


Using the information gathered from the existing system (if any) or from your study on data capture
fields required for your implementation, review the fields on the transaction records in XFRACAS
and map your required fields to default fields shipped with XFRACAS. If the existing fields do not
capture the desired information, create detail fields to capture it. For example, if the original trouble
ticket record captured the number of people affected by the problem, it would be appropriate to add
a numeric detail called People Affected to the XFRACAS Incident page. Note that you can also
delete or retire detail fields to remove them from the user interface if they are not relevant to your
organization.

1.6.6 Criticality Fields


Decide if you want to use criticality fields in the Incident page and/or the Problem page. If so, use the
administrative Criticality page to configure the fields. In the administrative Preferences page, turn on

XFRACAS Implementation Guide 13


1 XFRACAS 9 Implementation

the display of criticality fields for the appropriate page(s) and configure the formulas used to calculate
the criticalities.

1.6.7 Drop-down Lists


Import issues or create issues via the administrative Lists page. This consists of reviewing the default
list contents as well as populating any lists that may have been created when new detail fields were
added.

1.6.8 Action Lists


Review the default XFRACAS action categories to determine if they are sufficient and create
additional sub-categories as needed. Action sub-categories can be used to organize actions of the
same basic type (incident, problem, or project) into smaller groups. Examples of sub-categories under
the Incident Action category might include Investigation and Repair. Sub-categories are optional
and can be added at any time.

1.6.9 Import Data from Existing System


Importing existing data is handled with *.xml imports. There are DTD files that define each type of
data import. You can also export a sample of each *.xml file from the appropriate page if you have
permissions to export.

1.6.10 Other Data


Create companies, contacts, locations, and any other additional data that might be needed. This
information should be available from the sample data collected in step 1.

1.6.11 System Preferences II


Review the behavior of the transaction records (incident, problem, project, failure analysis, CSI) in
XFRACAS and determine how to set the system preferences to achieve the desired behavior. This
may take several iterations in order to determine the proper values for various preferences as you
familiarize yourself with the system and its behavior.

1.6.12 Organization-Specific Text, Queries and Pages


Change any text values in XFRACAS that don't match your organizations needs. This is done
with the Resource Editor.
Modify the sort orders and hide/display attributes of specialized queries. This is done with the
administrative Report Viewer page.

14 http://XFRACAS.ReliaSoft.com
1.6 Initial Configuration

Modify static pages that are not resource-based. These include:


Description criteria link destinations. These files are located in the tips folder on the Web
server where XFRACAS was installed. The location of these pages is configurable via the
administrative Preferences page in XFRACAS.
The What's New page: Whatsnew.html in the main folder on the Web server where XFRACAS
was installed. The location of this page is configurable via the administrative Preferences page
in XFRACAS.
The system general error page: GeneralError.aspx in the main folder on the Web server where
XFRACAS was installed.
The Terms of Use agreement page: Agreement.aspx in the main folder on the Web server
where XFRACAS was installed and in the admin directory within that folder. If the user
accesses the application via the main home page, the version in the publishing directory will
be used. If the user accesses the administrative side of the application directly, the version in
the admin directory will be used.
The Printer Friendly View XSLT files for the Incident, Failure Analysis and Problem Preview
outputs located in the XSLT folder.
Create and deploy to users (i.e. make public) custom queries, custom standard reports, custom
charts or custom dashboard layouts, if needed.
Decide if there are any public links to other systems or announcements that are required and create
and deploy those to all users.

1.6.13 Additional Entities


You can use a single setup of XFRACAS or if needed you can have multiple setups, or entities. Your
organization might have various business units, divisions, departments or functional teams, each of
which has different needs, processes and/or terminologies. In such cases, each group can use a
separate entity within XFRACAS, configured to meet the needs of that group. Entities can be used for
other purposes, as well, such as distinguishing between reliability and safety incidents within the
organization.

Once an initial entity has been configured, it can be used as a base to create additional entities if
additional entities are required. This avoids having to repeat all of the steps given in this chapter for
other entities-- you can simply alter individual entity-specific settings as necessary. All of the steps
given here can be performed on an entity-specific basis, with the exception of the System-Wide
preferences in the administrative Preferences page and all companies, contacts, courses and locations.

XFRACAS Implementation Guide 15


1 XFRACAS 9 Implementation

1.7 Other Configuration Notes

1.7.1 Time Metrics


When creating a serialized incident, users can click the Operational History link to select from
previously entered time metrics for that serial number. By default, this list consists of time metrics
contained within XFRACAS for the serial number. If desired, you can instead pull time metric data
from another database for use during incident creation. XFRACAS supports this by attempting to call
a stored procedure in the XFRACAS database on the fly.

The procedure is named XFRACASGetTimeMetrics and has 4 arguments. The first is an incoming
argument for the serial number (a string) and the second through fourth are return arguments
(numbers) to store the data for the three time metrics. In the default XFRACAS system, the three time
metrics are set to 0. Once the stored procedure is modified, the return_value variable must be set to 1
in order for the values to be used.

As an example, below is a very simple Oracle stored procedure that returns values from tables named
SYSTEM_HOURS, SYSTEM_STARTS, and SYSTEM_KWRUNHRS:

Create OR Replace PROCEDURE XFRACASGetTimeMetrics


(
Sn IN NVARCHAR2;
tm1 OUT NUMBER,
tm2 OUT NUMBER,
tm3 OUT NUMBER
RETURN_VALUE OUT NUMBER)
AS
BEGIN

tm1 := SELECT hours FROM SYSTEM_HOURS WHERE serial_num = SN;


tm2 := SELECT starts FROM SYSTEM_STARTS WHERE serial_num = SN;
tm3 := SELECT kwrunhrs FROM SYSTEM_KWRUNHRS WHERE serial_num =
SN;
RETURN_VALUE := 1;

END;

16 http://XFRACAS.ReliaSoft.com
1.7 Other Configuration Notes

Below is the SQL Server stored procedure that does the same (i.e., returns values from tables named
SYSTEM_HOURS, SYSTEM_STARTS, and SYSTEM_KWRUNHRS):

CREATE PROC XFRACASGetTimeMetrics


(
@SN NVARCHAR(100),
@TM1 FLOAT OUTPUT,
@TM2 INT OUTPUT,
@TM3 FLOAT OUTPUT,
@RETURN_VALUE INT OUTPUT
)
AS
BEGIN
SET @TM1 = SELECT hours FROM SYSTEM_HOURS WHERE serial_num = @SN;
SET @TM2 = SELECT starts FROM SYSTEM_STARTS WHERE serial_num = @SN;
SET @TM3 = SELECT kwrunhrs FROM SYSTEM_KWRUNHRS WHERE serial_num
= @SN;

SET @RETURN_VALUE = 1
END;

When using this functionality, if the stored procedure called succeeds and returns data, the user will
see rows fetched from XFRACASGetTimeMetrics. This row can be selected like any other to use the
listed time metrics in the incident.

1.7.2 Importing via External Process


As mentioned in Section 1.6.9 on page 14, importing existing data is typically handled from within
the XFRACAS interface by means of *.xml imports. If, however, you are using an external process to
bring data into the system, you will use a stored procedure to increment the unique table ID assigned
to each record and the entity display ID for each transactional record.

The procedure is named RS_GetIDValue and has 3 arguments, as follows:

The first argument is an incoming argument for the table name. In Oracle, this must be entered in
ALL CAPITAL LETTERS.
The second argument is an incoming argument for the entity ID. If there is no entity ID, you must
enter NULL for this argument.
The third argument is a return argument that stores the value to a specified variable.

XFRACAS Implementation Guide 17


1 XFRACAS 9 Implementation

A template for calling the stored procedure in SQL Server with an entity ID is given next. Note that
you will replace TABLENAME with the actual table name, and replace XX with the actual entity ID.

DECLARE @NextID int

BEGIN

--table_name, entity_id, @NextID OUTPUT is the variable for the id_num output

EXECUTE RS_GetIDValue 'TABLENAME',XX, @NextID OUTPUT;

PRINT @NextID;

END;

A template for calling the stored procedure in SQL Server without an entity ID is given next. Note
that you will replace TABLENAME with the actual table name.

DECLARE @NextID int

BEGIN

--table_name, @NextID OUTPUT is the variable for the id_num output

EXECUTE RS_GetIDValue 'TABLENAME', NULL, @NextID OUTPUT;

PRINT @NextID;

END;

A template for calling the stored procedure in Oracle with an entity ID is given next. Note that you
will replace XXX with the table name in ALL CAPS, and replace x with the entity ID.

SET SERVEROUTPUT ON;

VARIABLE NEWID NUMBER;

EXEC RS_GetIDValue('XXX',x, :NEWID);

BEGIN
DBMS_OUTPUT.PUT_LINE(:NEWID);
END;

18 http://XFRACAS.ReliaSoft.com
1.7 Other Configuration Notes

A template for calling the stored procedure in Oracle without an entity ID is given next. Note that you
will replace XXX with the table name in ALL CAPS.

SET SERVEROUTPUT ON;

VARIABLE NEWID NUMBER;

EXEC RS_GetIDValue('XXX',NULL, :NEWID);

BEGIN
DBMS_OUTPUT.PUT_LINE(:NEWID);
END;

XFRACAS Implementation Guide 19