Sei sulla pagina 1di 848

iWorks Prophet

Enterprise-wide Actuarial Modelling

Prophet Professional User Guide

Release 8.2 Update 3

2014 SunGard
This document and the software described within are copyrighted with all rights reserved. No part of this document may be reproduced, transcribed, transmitted, stored
in an electronic retrieval system, or translated into any language in any form by any means without the prior written permission of SunGard. SunGard makes no
warranties, express or implied, in this document. In no event shall SunGard be liable for damages of any kind arising out of the use of this document or the information
contained within it.
This document contains information that is confidential or proprietary to SunGard (or its direct and indirect subsidiaries). By accepting this document you agree that:
1. If there is any pre-existing contract containing disclosure and use restrictions between you and SunGard or your company and SunGard, you and your company will
use this information in reliance on and subject to the terms of any such pre-existing contract;
2. This document is only provided to customers who have licensed or are evaluating the Prophet Professional software. If you have received this documentation and
are not licensed or currently evaluating the Prophet Professional software, you must immediately destroy this document or, if it is in electronic format, permanently
delete it.
3. If there is no contractual relationship between you and SunGard or your company and SunGard, you and your company agree to protect this information and not to
reproduce, copy, disclose to any third party or use the information in any way without SunGards prior written consent, except as may be required by law. You
acknowledge that if you or your company breach this provision, then SunGard shall be entitled to take legal action against you.
TRADEMARK INFORMATION
SunGard, the SunGard logo, iWorks and Prophet are trademarks or registered trademarks of SunGard Data Systems Inc. in the U.S. and other countries. All other trade
names are trademarks or registered trademarks of their respective holders. Trademarks that are known and mentioned in this manual have been appropriately
capitalised. However, SunGard cannot vouch for the accuracy of the information.Use of such terms in this manual should not be regarded as affecting the validity of any
trademark.
SunGard iWorks Prophet,

Telephone:

+44 (0)1932 757 575

Eastworth House,

Prophet Helpdesk:

+44 (0)1932 757 555

Eastworth Road,

Fax:

+44 (0)1932 757 518

Chertsey, Surrey, KT168SH,

Email:

prophet.helpdesk@sungard.com

United Kingdom

Website:

www.prophet-web.com

Document No: PR821-1001-0413

1440726/06/2014 : 20:14:08

CONTENTS

Welcome to iWorks Prophet

User manuals
Getting help and information
About SunGard iWorks

6
9
11

What's new in this Release

13

System Support
Prophet Professional 8.2 Update 3: Enhancements
Prophet Professional 8.2 Update 3: Addressed Issues
Prophet Professional 8.2 Update 3: Known Issues and Limitations

Product and Library Naming Conversion Guide


About the guide
Long Product Names
Letter Link of a Library and Product

14
18
24
27

29
30
31
35

Part 1 - Prophet basics

41

Uses of Prophet

43

About the uses of Prophet


Asset / liability modelling
Model office projections
Profit testing
Statutory valuation
Profit recognition
Analysis of actual financial performance
Experience analysis
General Insurance applications

44
45
47
48
49
50
51
52
53

ii

Getting Started
Starting Prophet
What is a workspace?
Opening or creating a workspace
A Tour of Prophet Professional 8
The main modelling process
Quitting Prophet

Prophet concepts and terminology


Prophet Objects and Actions
Prophet system structure
Inside libraries and products
Types of tables
Data Conversion

Part 2 - Product design


Setting up products
What are products?
Product design process
Creating a product
Variable definition options
Managing products
Printing product details
Auto-scan and Regeneration options
Comparing products
Product Schedule

Setting up tables
What is the Table editor?
Types of table supported by the Table Editor
Creating a table
Generic tables
Global files
Model point files

55
56
60
61
72
86
89

91
92
114
115
124
133

137
139
140
141
142
169
194
202
203
205
217

231
233
234
236
255
263
265

iii

Mortality tables
Parameter files
Sales files
Segment table
Stochastic tables
Stochastic File Convertor utility
Table of Tables
Unit Prices files
Year dependent mortality tables
Year index tables
Managing tables and model point files
Printing tables and model point files

Running products
What is involved in running products?
Setting up a run for one or more products
Running one or more products

Displaying results
How are results displayed?
Sets of results displayed in a Results window
Formatting results in a Results window
Copying results in a Results window
Printing results in a Results window

Diagram view
What is Diagram view?
About Diagram view
Working in Diagram view
Displaying public variable members
Diagram view settings

268
269
271
272
273
274
276
278
279
280
281
284

287
288
289
298

303
304
306
308
310
311

313
314
315
321
333
335

iv

Part 3 - Model Office and Valuation


Accumulations
What are accumulations?
Managing accumulations
Editing the contents of an accumulation
Running an accumulation
Printing accumulations

Structures
What are structures?
Managing structures
Structure options
Structure view

Run Settings
What are run settings?
Managing run settings
Run setting options
Printing run settings

Runs
What is a run?
Running one or more run pairings
What happens during a run?
Parallel PC mode
Minimising the run time
Example Model Office

Results
What results are generated by a run?
Displaying results
Types of results
Managing results

337
339
340
341
349
352
352

355
356
358
365
391

403
404
406
413
449

451
452
453
466
470
481
483

491
492
493
497
501

Results Viewer Viewing run logs


About Results ViewerViewing the run log
Prophet Run Details view
Runlogs pane
Definition folder
Preparation folder
Execution folder
Audit folder
Printing a run log
Navigating run logs
Filter toolbar

Queries
What are queries?
An overview of queries
Managing queries
Charting queries
Previewing and printing a query

Part 4 - Libraries and workspaces


Libraries
What is a library?
Library objects
Managing libraries
Managing the variables in a library
Managing variable definitions
Variable codes and categories
Managing indicators
Indicator codes and categories
Validating libraries
Comparing libraries
Exporting and importing from within a library comparison

503
504
508
509
510
518
520
522
528
530
533

535
536
537
539
552
556

559
561
562
563
565
576
593
609
612
614
616
618
625

vi

Welcome to Library Shield


Using Library Shield
Licensing pre-release 8.0 workspaces
An introduction to licensing

Actuarial documentation
What is actuarial documentation?
Using actuarial documentation
Managing actuarial documentation
Comparing actuarial documentation
Printing actuarial documentation
Exporting actuarial documentation
Importing actuarial documentation

Import and export


What can be imported and exported?
Importing Prophet objects
Exporting Prophet objects

Workspace objects
What are workspace objects?
Enumerations
Dimensions
Specifying variable groups and categories

Prophet options
What Prophet options are available?
Workspace options settings
Compiler settings
Descriptions settings
File Locations settings
Plugins setting
Language settings
Memory settings
Product Links setting

628
629
631
632

633
634
635
642
650
653
658
659

661
662
664
673

679
680
681
686
689

699
701
702
704
706
707
709
712
714
716

vii

Prophet Enterprise Settings


Run log settings
Table details
Variables settings
Workspace Permissions settings
Workspace Properties settings
Machine options settings
Calculation engine settings
Customize GUI settings
Miscellaneous settings
Table Options setting
Diagram view settings
Formula Options setting
Tree Options
Machine selection setting
Quick Access Toolbar
Worker logging

Using Prophet Enterprise Resources


Overview
Push to PE - Prophet Professional settings
Push to PE - Prophet Enterprise settings
Running a model using Prophet Enterprise resources

Workspace utilities
What workspace utilities are available?
How workspaces are organised
Backing up a workspace
Restoring a workspace
Compacting a workspace file
Creating a template workspace

User permissions
What are user permissions?
Using Prophet Administration

717
719
725
729
731
738
739
741
746
748
750
752
754
760
763
765
767

771
772
773
774
776

777
778
779
782
785
787
788

791
792
795

viii

Managing workspace permissions

811

Part 5 - Plugins Reference

813

Prophet plugins
What is a plugin?
Installing plugins
Configuring plugins
Using plugins
Using plugins at runtime

Index

815
816
818
820
822
824

827

Welcome to iWorks Prophet

iWorks Prophet is a leadingrisk management platform used by the financial services industry around the world to
model companies financial business. The Prophet enterprise architecture provides the power and performance for
models to run in a secure and controlled environment. It is used by more than 8500 customers, in more than 650
sites worldwide in more than 55 countries.
ProphetProfessional
Prophet Professional is the actuarial application that manages and stores code written by actuaries to define
business-critical calculations. An extensive range of facilities for all types of actuarial calculations are supplied that
include:
n

Product pricing and design

Budgeting and planning

Statutory valuations

Embedded value, IFRS, US GAAP and other types of financial reporting

Asset/liability modelling and cash flow testing

Stochastic projections for risk based capital, European embedded values and Solvency II

Prophet Professional can be considered as two separate components that communicate with each other to produce
end results:

Chapter 1 Welcome to iWorks Prophet

Actuarial Models are developed in the User Interface using a rich front end.

The Calculation Engine sits behind the User Interface and converts the actuarial code stored in a database into
machine code which is then processed.

Prophet is part of the SunGard iWorks business-driven IT product family for the insurance industry. In particular,
Prophet is used by life, pensions, property & casualty and other financial services companies to enable profit
testing, financial projections, reserving, financial reporting, asset liability modelling and stochastic modelling to be
carried out within a single application.

About this manual


This is the Prophet User Guide. You should refer to this whenever you need to:
n

Understand the system aspects and terminology used in Prophet

Find out how to use a particular system feature

Find out how to use the various Prophet modelling features

Other manuals
All Prophet manuals in addition to this one, are supplied in Adobe Acrobat format and can be accessed by clicking
User Manuals on the Support tab. See the section User manuals on page6.

Prophet Professional Overview


Refer to this manual whenever you need to determine the features and capabilities of Prophet.

Prophet Developer guide


The Prophet Developer guide describes how to use the Prophet features to perform actuarial calculations. In
particular, the guide provides information on:
n

The Prophet programming language

New business processing

Goal seeking and Rebasing

Calculation looping

Dynamic run processing

Stochastic modelling

Data grouping

Chapter 1 Welcome to iWorks Prophet

In addition, the guide describes how to use and access the supplied Microsoft Excel based templates for reporting
and the generation of sales and other types of related tables.

Actuarial libraries
The following manuals describe the actuarial libraries that are available for Prophet Professional:
n

ALS Reference and Tables Guide

Conventional Library - User Reference

Unit Linked Library - User Reference

Permanent Health Insurance Library - User Reference

International Library - User Reference

Financial Services Library - User Reference

Group Pensions Library - User Reference

Asset Liability Modelling Manual - User Reference

Analysis of Movements manuals

US GAAP - User Reference

Prophet tutorial and user reference manuals


Prophet tutorial and user reference manuals provide a tutorial which in some cases is supplemented with related
reference information. Once you have completed the tutorial you can then subsequently refer to the related
reference information.
The following tutorial and user reference manuals are available for Prophet:
n

Introduction to Prophet Tutorial

Model Office Manual - Tutorial and User Reference

Data Conversion System and Viewer User's Guide

ALS Quick Start Guide for Internal liabilities

ALS Quick Start Guide for External liabilities

Glean User's Guide

Group Pensions Tutorial

Application Programming Interface User Reference

Prophet Professional Bulletins


In addition to these manuals, a number of Prophet Professional Bulletins and support notes are supplied. These
provide the latest information on all aspects of Prophet.

Chapter 1 Welcome to iWorks Prophet

User manuals
Prophet documentation is available online as a set of PDF files that can be viewed by a number of applications
including the freely available Adobe Acrobat Reader. To open and read a manual from within Prophet do the
following:
1. From the Support tab click User Manuals. The Select Manual dialog box appears.

2. In the tree structure double-click a manual to open it in a PDFreader.


3. To close the dialog box, click the Close icon.
The supplied manuals are displayed as a tree and can be organised by category from the right-click context menu.
You can also add other PDF manuals in other locations by clicking Browse and adding the locations using the
Manuals Location dialog box.
Note: The dialog is modal and remains open to allow one or more files to be opened. It is closed by clicking the
Close window icon.

User manuals

Organising manuals in the tree


You can group the manuals in the tree by selecting a folder and from the right click context menu choosing a
grouping setting from the Group By sub menu. You can group files in the following ways:
n

Path

Category

Type

No grouping

To place each PDF file into a category an XML file is supplied that accompanies the PDF. The XML file has the
same name as the PDF file but with an xml extension and contains the name of the manual and its category value.
If a PDF does not have an accompanying XML file then it is displayed by its filename in the Default category folder.
The content of a typical XML file that would accompany a PDF file would appear similar to the following:
<?xml version="1.0" encoding="UTF-8" ?>
<configuration>
<!-- Items to be displayed within getting started on the start page -->
<Description>Prophet Professional User Guide</Description>
<Category>Prophet System</Category>
</configuration>

The pertinent elements are:


n

Description element - This contains the description of the manual as it appears in the tree.

Category element - This contains the name of the Category folder as it appears in the tree. The folder is used to
hold and display the PDF file together with other PDF files in the same category.

Note the following:

Chapter 1 Welcome to iWorks Prophet

Category folders in the tree do not physically exist but are used to display PDF files belonging to the same
category.

Category folders are only displayed in the tree if the manuals are grouped by category.

The name of the XMLfile must be the same as that of the PDF it accompanies but having an XML extension. For
example, MyPDF.pdf should have an accompanying XMLfile named MyPDF.xml.

Online Help
Prophet Online Help provides all the information supplied in this manual with additional information about:
n

Programming functions available in the Prophet programming language

Programming functions available in the Data Conversion System

Reference material

Help also contains detailed information on the standard mortality tables supplied with Prophet and the formats
which can be used for external tables.

Getting help and information

Getting help and information


In addition to the supplied documentation you have the following options:
n

Context-sensitive help
When you need immediate access to information on a specific item, on the Support tab click Help, or press F1.

iWorks Prophet website


The iWorks Prophet website provides the latest information and updates on Prophet including details of training
courses, related products, services and events. Our website address is: www.prophet-web.com.

iWorks Prophet Helpdesk Online


Helpdesk Online is a web-based service which provides immediate access to published solutions and enables
you to log calls directly with the Prophet Helpdesk. It enables you to:

Search and view the Helpdesk solutions database

Enter calls directly into the Helpdesk system

View the progress of submitted calls

Worldwide support
Prophet is supported by a network of trained and experienced support personnel. For details of the support
centre that serves your country visit the Prophet website: www.prophet-web.com.

Prophet website
The Prophet website provides information on Prophet that includes details of updates and any related events.
If you have access to the internet on your computer then you can access the Prophet website from within the
Prophet application.
Note: To gain access to the Prophet Support section of the website you need to register as a user. Please
contact the Main Helpdesk if you need any help with this.

10

Chapter 1 Welcome to iWorks Prophet

Contacting your local support centre


If you encounter difficulties and cannot find a solution then contact the support centre that serves your country.
Contact details of all support centres are available from the Prophet website at www.prophetweb.com/support/helpdesk.
When you contact a support centre you should mention the following:
n

Which version and update of the software you are using

Which version of Windows you are using

A description of what happened when the problem occurred

The wording of any messages that appeared on your screen

A description of how you attempted to resolve the problem

Issues that cannot be resolved by the local support centre can be passed on to the main helpdesk in the UK. You
can contact the Main Helpdesk by phone, fax or email.

Main Helpdesk
If you are still unable to resolve your issue, then please contact the main helpdesk:
Telephone:
Fax:

+44 (0)1932 757 555


+44 (0)1932 757 785

Email:

prophet.helpdesk@sungard.com

Write to:

SunGard iWorks Prophet


Eastworth House
Eastworth Road
Chertsey, Surrey KT16 8SH
United Kingdom

Website:

www.prophet-web.com

About SunGard iWorks

11

About SunGard iWorks


SunGards iWorks is a business-driven IT product suite for the insurance industry in each of the following major
business lines:
n

Life/health/annuities/pensions

General insurance

Reinsurance

iWorks offers a range of products and services including front-office tools, policy administration, reinsurance,
actuarial calculations, financial accounting, investment accounting, and reporting. SunGard partners with customers
to deliver products and services that align with changing business and regulatory needs.
For more information visit www.sungard.com/iworks.

12

13

What's new in this Release

System Support

14

Prophet Professional 8.2 Update 3: Enhancements

18

Prophet Professional 8.2 Update 3: Addressed Issues

24

Prophet Professional 8.2 Update 3: Known Issues and Limitations

27

14

What's new in this Release

System Support
The following provides information on the versions of compiler, plug-ins and other external applications that are
supported by this release.

Compiler support
Prophet Professional, DCS and Prophet Enterprise 8.2 Update 3 now support the Microsoft 2013 and Intel 14
compilers. The full list of compilers supported in Prophet Professional 8.2 Update 3 is as follows:
l

Microsoft C++ Compiler 2010 installed with Microsoft Windows SDK for Windows 7 and .NET Framework 4 (7.1)

Microsoft C++ Compiler 2010 installed with Microsoft Visual Studio 2010 (including Express Edition)

Microsoft C++ Compiler 2012 installed with Microsoft Visual Studio 2012 (including Express Edition)

Microsoft C++ Compiler 2013 installed with Microsoft Visual Studio 2013 (including Express Edition)

Intel C++ Compiler 12.1 installed with version 7 of the Intel Composer XE. A pre-requisite for Prophet is the
Microsoft Windows SDK 7.1. DCS requires a version of Microsoft Visual Studio 2010 (all versions are supported
including the Express Edition)
Intel C++ Compiler 13.2 installed with the Intel Composer XE 2013. A pre-requisite for Prophet is the Microsoft
Windows SDK 7.1. DCS does not support this version, please use Intel C++ Compiler 13.5 or later
Intel C++ Compiler 13.5 installed with the Intel Composer XE 2013. A pre-requisite for Prophet is the Microsoft
Windows SDK 7.1. DCS requires a version of Microsoft Visual Studio 2012 (all versions are supported including
the Express Edition)
Intel C++ Compiler 14.0 installed with the Intel Composer XE 2013 SP1. A pre-requisite for Prophet is the
Microsoft Windows SDK 7.1. DCS requires a version of Microsoft Visual Studio 2012 (all versions are supported
including the Express Edition)

Note the following:

System Support

15

As part of our efforts to keep Prophet compatible with current technology, this release - Prophet Professional 8.2
Update 3 and Prophet Enterprise 8.2 Update 3 - will be the last release to offer support for the Microsoft C++
2010 compiler.
Prophet Professional 8.2 Update 3 and Prophet Enterprise 8.2 Update 3 will be the last release to offer support
for the Intel Compilers. Over recent releases, testing has shown that the performance of the Intel Compiler is no
better than the Microsoft Compiler. If you are a user of the Intel Compiler, we suggest that you move to the most
recent Microsoft Compiler instead.
With Microsoft's more aggressive release policy, we will no longer give notice that we will stop supporting a
particular version of the compilers. Instead we will ensure that between one Prophet release and the next, there
is at least one supported compiler in common.
Note that Visual Studio 2012 is not compatible with Windows Server 2008 operating system.

Andrew Davidson support


Prophet 8.2 Update 3 supports the following versions of Andrew Davidson:
l

5.2h_p2

5.2i_p1

LDM v2.0.2
Note: Only the Andrew Davidson dlls listed above are supported in this update. Users are advised to update
their plugins to the latest versions available. Also note that in LDM v2.0.2 the new Loan Dynamics functionality
is not available. Prophet will return values from the old prepayment model which Andrew Davidson has
embedded inside LDM.

Intex support
Prophet 8.2 Update 3 and DCS 8.2 Update 3 support the following versions of Intex:

16

What's new in this Release

3.3c_p1

3.3d_p1

3.3e_p2
Note: Only the Intex Subroutines listed above are supported in this update.
Users are advised to update their plugins to the latest versions available. For example, Prophet users using
Intex 3.3c_p1 released with Prophet 8.2 Update 2 are advised to upgrade to the Intex 3.3c_p1 plugin released
with Prophet 8.2 Update 3.

Operating system support


Release 8.2 Update 3 supports the following desktop operating systems:
l

Microsoft Windows 8.1

Microsoft Windows 8

Microsoft Windows 7

Microsoft Windows Vista

In addition, the following Windows Server operating systems are supported:


l

Windows Server 2012 R2

Windows Server 2012

Windows Server 2008 R2

Windows Server 2008


Note: This release will be the last to support Windows Vista.

System Support

Excel support
Prophet 8.2 Update 3 supports the following versions of 32-bit Microsoft Office:
l

Microsoft Excel 2010

Microsoft Excel 2013

Prophet Excel Reporting no longer supports results from Prophet 7.


Note: Prophet Excel Reporting only supports 32-bit Microsoft Office.

Questions
If you have any questions regarding this Bulletin, contact the Prophet Helpdesk:
prophet.helpdesk@sungard.com

17

18

What's new in this Release

Prophet Professional 8.2 Update 3: Enhancements


The following enhancements have been made in Prophet Professional 8.2 Update 3.

Key features
l

Easier deployment of Prophet Libraries and workspaces

Support for the new General Insurance Solution

Enumeration descriptions within tables

Further improvements to the find and search

Improved preparation performance for models containing large numbers of arrays

Prophet Solution Installer


The Prophet Installer has been split into two parts. The system installer installs the Prophet system components in
the same way as it did before. However, the standard workspaces are no longer included in the system installer.
Instead, they are supplied in a separate installation package, which also includes other workspace templates such
as ALS and General Insurance, other data such as Excel templates, example-specific DCS scripts, General
Insurance Forms packs and documentation relating to specific Prophet libraries and solutions.
After installing the system you will need to run the Solution Installer.
In the future we will supply new and updated Prophet libraries and workspaces, including other supporting data
and documentation, as part of a separate installation package.

Prophet Professional 8.2 Update 3: Enhancements

19

Note: You will only be able to install and use items for which you have licences.
Once installed, workspaces are added to your Prophet Templates. These templates work in a similar way to the
Example Model Office. That is, when you create a new workspace you can choose to create a new workspace
based on that workspace. For instance you could choose to create an ALS workspace if you have a licence for ALS.
As a consequence to this change we have altered where user defined templates are stored. In Update 2 these
were stored under C:\Program Files (x86)\SunGard\Prophet Professional\STD Workspaces. They are now stored
under C:\ProgramData\SunGard\User Defined Templates. For continued availability users should either add the
templates back in through Prophet or copy the files to this new location.

20

What's new in this Release

General Insurance Solution


Release 8.2 Update 3 provides full support for a new General Insurance Solution. This includes three General
Insurance libraries included in the Solution Installer. Details of these can be found in the General Insurance
bulletins.
This release also includes 2 new modules - Prophet Forms and Prophet Forms Designer. These can be used to
support the General Insurance Solution or any other workspace providing a definable user interface to Prophet,
particularly around the entry and control of Prophet tables. An example General Insurance Forms Pack is also
included. For more details please see the Prophet Forms Bulletin.
Supporting the General Insurance Reserving workspace is a General Insurance Reserving Interface. This Interface
does not perform any calculations but displays results and assumptions for the user to interrogate and amend as
required. For more details please see the General Insurance Reserving Bulletin and other user guides. This
interface can be accessed from the General Insurance section of the Excel Reporting Templates under the Prophet
menu.
To support these workspaces full documentation is also provided for each of the General Insurance libraries.

Enumerations
Tables that use enumerations as an index can now show the description of the enumeration value rather than the
value itself. This improves clarity as the enumeration value is just a numeric representation and generally is not
very descriptive or meaningful.

Prophet Professional 8.2 Update 3: Enhancements

21

API
The maximum spcode in a dynamic run and the FastRuntime, FastCompile options can now be controlled via the
Prophet API.

Find Enhancements
The following enhancements have been made to the Find and Replace functionality for the 8.2 Update 3 release of
Prophet Professional. This continues the enhancements already delivered in Update 2:
l

The item being searched for is now shown for clarity on the Search results tab. Additionally, when searching for
strings the results are shown in double sets of quotes to indicate that the quote marks were included in the
search.
Searching for part of the product will now return the product as well as where the product is referenced.

22

What's new in this Release

Searching for a message is now clearer as it clearly shows in the search results with quote marks (" ) around
the text being searched for.
Searching for a variable within a library previously would only show references to that variable. You now get all
references plus the variable itself.

Compare
The comparison function has a new option for added flexibility. This option is under the advanced compare options
and is called Ignore Leading Whitespace. This option ignores differences where the content is the same but there
is a different level of indentation before the start of the line of code.
Additionally, if this option is cleared, any differences in leading white space is treated as a minor difference and can
be filtered out using the Show Major Differences option on the Compare tab of the ribbon.

Calculation Engine
We have made some optimisations to the preparation of models that contain array variables. This is of particularly
significant for models with large numbers of arrays that do not affect the calculation order of the model and simply
exist to ease the number of variables that are needed for reporting purposes.

User Interface
A number of other minor improvements have been made to the user interface:
We have a new right click option on the structure tree to be able to remove multiple products or accumulations at
once and without having to open the structure.
Within the structure window we have now included the level number of the products and accumulations where they
are shown. We have also added the library name associated to the product. This should help to identify which
products or accumulations need to be added or removed when users are altering the structure. Within these
screens it is also possible to order by any of the headers such as level, name, etc.

Prophet Professional 8.2 Update 3: Enhancements

23

It has been possible for accumulation ranges to use wildcards. However this was not documented nor well known
functionality. We have now added full descriptions to the documentation. An example of this functionality is that
referring to 1??? as the accumulation spcode range will accumulate spcodes 1000 to 1999.

Reserved Words
The following additional reserved words cannot be used as Prophet variables or other references - Boolean, True,
False, Integer and Number.

24

What's new in this Release

Prophet Professional 8.2 Update 3: Addressed Issues


The following issues from Release 8.2 Update 2 have been addressed.

PQA
We now have consistency between results differences for stochastic and projection results. Previously missing
variables were treated as warnings for projection results and errors for stochastic. In 8.2 Update 3 all missing
variables will be treated as warnings as it may be intentional between runs that you have excluded some variables.
An inconsistency where a file comparison was missing from the summary but shown in the full listing has been
corrected.

Queries
When using the variable as the column and the product as the row the query would incorrectly show a value of 0.
This has been corrected.

Diagram View
Diagram View now correctly shows links between accumulations and long product names. Previously the longer
product names were not being shown.
An issue when Diagram View showed a constant value of 0 for some revenue account items has been corrected.

API
The method DynamicProjectionPeriod now correctly sets the value of the dynamic projection period. Previously
setting this would not affect the run when the Prophet workspace had a setting of 'Same as Future Accumulation
Period'.

Runlogs
The Prophet runlog xml and xps version are now consistent when showing the number of errors and warnings.
The formatting of runlogs has been changed to allow text-wrapping for long path names.

Prophet Professional 8.2 Update 3: Addressed Issues

25

User Interface
Printing the accumulation list correctly applies the Prophet filtering to the print out.
Clicking on the display button in the run pair dialog caused an invalid pointer error. This has been fixed.
Annual results were incorrectly only shown for the value of the setting 'Number of Years Monthly Results Retained'.
This has been addressed.

Installation
An issue where Prophet requires a missing mfc110.dll file has been addressed. Prophet will now install it as a prerequisite if it finds that the file is missing from the installation.

Calculation Engine
Some of the advanced settings in the structure did not force regeneration if they were altered. This has been
corrected.
Previously it was not possible to produce intermediate dynamic results files for anything other than simulation 1. It
is now possible to produce these for any simulation.
A missing variable in the results issue has been corrected when accumulating products with reduced variable set
and where the results set is different between the products.
An unhandled exception has been corrected when using the Worker test button in Prophet Options when
workspace is shared or nested.
Incorrect results were shown in the accumulation when using the advanced setting 'First level number for which
cumulative variables are included in Results Files if selected variables chosen'. Specifically this was an issue
when accumulating a number of products but when one or more products were excluded by the level of this setting.
Incorrectly all products were accumulated.
An issue where Prophet produced an undiagnosed compilation failure has been fixed. This was caused when
using individual model point output and some specific first model point code.

26

What's new in this Release

An issue which caused an Undeclared Udentifier error when non-t-dependent variables are in the individual model
point output has been addressed.
An improved error message is reported when the maximum projection term is not large enough for the data being
run. Various other error messages have been improved to give the user more help when trying to diagnose run or
compilation failures.
An issue where READ_RESULTS_LEGACY is used on upgrade and the model fails has been addressed.
An issue where a constant array variable caused a structured exception has been addressed. A workaround to
change to set the array to be a formula is a suitable alternative.
In 8.2 Update 2 Prophet incorrectly produced no results when the first model point failed. This has been fixed.
Problems when running models using base or full optimisations have been addressed. This would result in a
structured exception or compilation failure message.

Prophet Professional 8.2 Update 3: Known Issues and Limitations

27

Prophet Professional 8.2 Update 3: Known Issues and Limitations


A list of known issues and possible workarounds for all versions of Prophet and its related products can be found
on the Prophet website.
http://www.prophet-web.com/support/known-issues/

28

29

C H A P T E R

Product and Library Naming Conversion Guide

TOPICS IN THIS CHAPTER


About the guide

30

Long Product Names

31

Letter Link of a Library and Product

35

30

Product and Library Naming Conversion Guide

About the guide


A number of significant changes have been implemented with Prophet Release 8.2 Update 2. The changes that are
covered in this guide are:
n

Support for long product names


Product names are no longer restricted to a length of 6 characters, they can now have any length name of
between 2 and 22 characters. Similarly, the length of an accumulation name has been increased to a maximum
of 24 characters.
This has introduced a number of other changes as a consequence, these include changes to the names of
results files and how results are read.

Changes linking products and libraries


With the release of Prophet 8.2 Update 2 a product name no longer needs to begin with the same letter as the
library it uses. As a consequence of this, it is no longer necessary to begin each library with a different letter and
you can now have multiple libraries that begin with the same letter in the same workspace, this adds extra
flexibility.

Each of these items is covered in more detail in the following sections.

Long Product Names

31

Long Product Names


This Long Product Names Conversion Guide provides information on the application of Long Product Names to
your workspaces.
Prophet 8.2 Update 2 introduces the ability to create product names with more than 6 characters. You can now
create products with any length name from 2 to 22 characters. Similarly we have also increased the maximum
length of accumulation names to 24 characters.
In this document, when we refer to Long Product Names, we are also including cases where product or
accumulation names are less than 6 characters in length.
The Long Product Names enhancements to Prophet have meant that we have made a number of changes to the
names of the Prophet results file format. In particular, the file extensions are now shorter. We have also split the
product name from the Sub Product Code. As a consequence, if your company performs any tasks at a file level
then you will need to review these enhancements before upgrading to ensure that your processes adapt
accordingly.
Note: If you make use of longer product names, you should be careful you do not exceed the Windows file path
limit of 256 characters. This is likely if you nest your workspaces. If you did exceed this limit then Prophet will not
be able to handle it and will likely fail in an uncontrolled manner.

Results file name changes


The file extensions of projection and stochastic results have been shortened.
Projection results files previously had an extension of .projection, the extension has been changed to .proj.
Stochastic results files previously had an extension of .stochastic, the extension has been changed to .stoch.
Sub product numbers have been separated from the Product name with '#'. This has been done to avoid confusion
where the system might be unable to identify whether the last 2 characters were part of the product name or were
the sub product code.
For example, the projection results file of the C_WEND product with sub product code 51 will be called C_
WEND#51.proj.

32

Product and Library Naming Conversion Guide

READ_RESULTS function
As a consequence of the increased limit to Product and Accumulation name length, changes have been made to
the READ_RESULTS function.
The previous READ_RESULTS function has been renamed to READ_RESULTS_LEGACY. This function combines
the product and sub product code as the first parameter. In addition to the sub product code the results type could
be specified in the first parameter by including an extension of .PRJ for projection results or .NBP for new business
results. With long product names, the system would be unable to identify whether the last 2 characters were part of
the product name or were the sub product code, so the new READ_RESULTS function has separate parameters for
product and sub product code to avoid confusion. There is also a new results type parameter where the user can
specify "P" to read projection results or "N" to read new business results.
The previous READ_RESULTS_TEXT function has been renamed to READ_RESULTS_TEXT_LEGACY. This
function was used when the result being read had a text data type. The new READ_RESULTS function has an new
data type parameter where the user can specify if the data being read is a number or text. This has removed the
need to have a separate READ_RESULTS_TEXT function to read text data specifically.
When you upgrade your models to 8.2 Update 2, Prophet will attempt to automatically change your code to this new
syntax. If it is unable to ascertain what the format should be, it will change the function to be READ_RESULTS_
LEGACY or READ_RESULTS_TEXT_LEGACY. During the upgrade process two text files will be produced
detailing the number of changes made and where these changes have occurred.
The LEGACY functions will follow the same syntax as the previous READ_RESULTS and READ_RESULTS_TEXT
functions. Code that has not been upgraded to the new syntax should be manually changed to use the new READ_
RESULTS function.
Note: READ_RESULTS_LEGACY and READ_RESULTS_TEXT_LEGACY will only be supported for a few
releases, and will eventually be phased out. You should make sure that your code is upgraded to the new
READ_RESULTS functionality as soon as possible.
A comparison of the old and new syntax is shown below.
LEGACY Syntax:
READ_RESULTS_LEGACY(product, variable, first_loop, error,[offset])

Long Product Names

33

READ_RESULTS_TEXT_LEGACY(product, variable, first_loop, error,[offset])

New Syntax:
READ_RESULTS(product, spcode, resultstype, variable, datatype, first_loop, error, [offset])

Sales File
As product names can now be of variable length, '#' is used to separate the product name and sub product code in
the sales file header. If you do not use the '#' format Prophet will give you an error when trying to save the table,
saying that the sub product code is invalid.
If you use a 6 character product name then the old Sales File format, of appending the sub product code directly to
the end of the product name, will still work, although we suggest changing your files to use the new '#' format.
The Excel sales file generator has been changed to use the new format.
A comparison of the old and new formats is shown below.
Old format:

New format:

34

Product and Library Naming Conversion Guide

Letter Link of a Library and Product

35

Letter Link of a Library and Product


This Library Letter Link Conversion Guide provides information on the changes made to the naming conventions of
products and libraries in Prophet 8.2 Update 2.
Previously, the first letter of a product had to be the same as the first letter of the Library that it used, for example, all
of the products that used the Conventional library had to begin with the letter C. This link between a product and the
library has been removed. As a consequence of this, it is no longer necessary to begin each library with a different
letter and you can now have multiple libraries that begin with the same letter in the same workspace, this adds extra
flexibility.
Note: With this extra flexibility, greater care needs to be taken when naming products, accumulations and
libraries. Changing naming conventions may be confusing to Prophet users who would expect a C product to
be linked to the Conventional library.

Creating a product
When you create a new product, the library is no longer automatically populated depending on the name of the
product. The user must select the library from the drop down list.

36

Product and Library Naming Conversion Guide

Duplicating a library
When you duplicate a library, all of the products within that library are copied as well. In previous versions of
Prophet the new library would need to begin with a unique letter, so duplicating the C library to a new D library
would copy all of the products but replace the letter C with D as it did so. If the D library already existed the copy
would have been be prevented.
Because it is now possible for a library to begin with the same letter as another library and for product names to
start with a different letter from the library they are associated with, you must take care not to create duplicate
product names when you copy a library. To help with this there is now a new Product Prefix group, which appears
on the General tab of the Library Properties dialog box when duplicating a library.

Letter Link of a Library and Product

37

To proceed, you will need to change the library name to something unique. In the example above, the Conventional
Library is going to be duplicated. The duplicate will be called AnotherConventional. If the library you are duplicating
previously had a prefix and you wish to remove it, type this prefix in the Remove Prefix box. If you wish to add a
prefix to all of the product names that use the newly created library, type this in the Add Prefix box. In the example
above the C prefix will be removed and a D prefix added.
The Conventional Library will now be duplicated, and all products beginning with the C prefix, will be renamed to
begin with a D prefix, as pictured below:

38

Product and Library Naming Conversion Guide

Note: If you leave these fields blank or if the product names already exist Prophet will attempt to resolve any
duplicated product names by appending a number to each of the duplicated products.

Importing a product or library


Care needs to be taken when merging two workspaces that follow different naming conventions. Some changes
have been made to the import process to help with this.
Importing a product or library into a workspace largely works as it did before. If the product C_GIB_ is linked to a
Conventional library in each of two different workspaces then importing from one to the other will raise conflicts and
the user can choose to replace or retain the existing product as well as the indicators it uses.

Letter Link of a Library and Product

39

In 8.2 Update 2, if the product C_GIB_ is linked to a Conventional library in one workspace and the Unit Linked
library in another then it is possible to import C_GIB_ into the Conventional library of the other workspace. In this
scenario you will see the following dialog box where you can rename the imported product. By default the product
being imported will be imported with an appended _1 to its name. If that name already exists it will be given _2 and
so on, alternatively you can choose to give it a different name. It is not possible to have two products with the same
name in a workspace; therefore you will not be allowed to choose a name that already exists.

Prod_Detail
As before, the Excel Reporting function, Prod_Detail, has three parameters: Workspace, Product and Aspect and
will return the Aspect detail of the product or accumulation specified.
This function has been enhanced in Prophet 8.2 Update 2 to include an extra Aspect called "Library" which will
return the library to which the product belongs. The other available aspects are the same as before: DateTime,
Desc, Level and Same_As.

40

41

Part 1 - Prophet basics

This section provides an overview of Prophet. Topics that are described include:
n

Uses of Prophet

Getting started

Prophet concepts and terminology

42

43

C H A P T E R

Uses of Prophet

TOPICS IN THIS CHAPTER


About the uses of Prophet

44

Asset / liability modelling

45

Model office projections

47

Profit testing

48

Statutory valuation

49

Profit recognition

50

Analysis of actual financial performance

51

Experience analysis

52

General Insurance applications

53

44

Chapter 1 Uses of Prophet

About the uses of Prophet


The projections and valuations performed by Prophet fulfil a number of important actuarial functions. Prophet:
n

Takes data, typically of an insurance company's policies

Applies calculations to project that data into the future

Uses the projection to place a value on the data

This chapter outlines the following main life insurance applications:


n

Asset / liability modelling

Model office projections

Profit testing

Statutory valuation

Profit recognition

Analysis of actual financial performance

Experience analysis

It also covers the use of Prophet for general insurance business.

Asset / liability modelling

45

Asset / liability modelling


The uses of Prophet outlined in the previous sections are all primarily concerned with the liabilities of the insurance
company, with a simple approach being adopted for modelling the investment return earned.
In asset/liability modelling, in addition to this model of the liabilities, a projection of the assets is also made and the
relationships between the two are explored. This enables projections of a complete revenue account and balance
sheet for the company to be made.
Traditionally, asset/liability modelling has primarily been concerned with cash flow matching. This is the testing of
the degree to which asset proceeds match liability outgo, both by amount and by timing. In some countries it has
developed further to include resilience (or stress) testing. This type of investigation looks at the consequences of a
rise or fall in asset yields and/or values. In particular it investigates whether the company should set up additional
reserves against this eventuality, taking into account that it might need to change its liability valuation basis in these
circumstances to demonstrate solvency.
In recent years the term asset/liability modelling has come to be associated with dynamic and stochastic
projections.

Dynamic projections
In a dynamic projection, the behaviour of the assets has an effect on the projection of the liabilities and, conversely,
the behaviour of the liabilities has an effect on the projection of the assets. These relationships are specified within
the model office as rules which are evaluated as the projection evolves rather than being entered as predetermined
values. In Prophet we use the terms "linkages" and "decisions" for these rules; linkages because they link
components of the model together and decisions because in some circumstances they model management
decisions that might be taken in the emerging circumstances.
Typical decisions that might be modelled include the bonus rates declared each year, the statutory valuation and
embedded value bases used at each year end and the investment strategy adopted, taking into account the
investment performance achieved.

46

Chapter 1 Uses of Prophet

Stochastic projections
A stochastic projection is a projection in which some of the assumptions, typically those which model future
investment or economic performance, are generated using a statistical model. This generates a series of sets of
assumptions, called simulations, each of which has the same probability of being achieved. Together they
represent a probability distribution for those assumptions. Product or model office projections are run for every
simulation and hence produce results which are probability distributions for the outcome for the product, fund or
company projected.
Stochastic projections essentially measure the riskiness of the projected outcome. A typical investigation would
involve the stochastic projection of a number of alternative scenarios, followed by a comparison of the outcomes
relative to their riskiness. The measures of outcome (or "reward") and riskiness would be chosen to be appropriate
for the company, for instance they might be the mean free assets relative to the probability of the company
becoming insolvent or they might be the mean overall bonus allocations relative to the volatility of the rates that can
be declared.

Application
Prophet Asset / liability modelling is used extensively by life assurance companies to help them manage their
business.
Prophet is used in particular, to quantify risks that have been exposed by the shift in many countries to a relatively
low inflation and interest rate environment and thereby to determine suitably amended investment, bonus and
business strategies for the future. Prophet is also used to enable the guarantees interest in the business that they
sell to be properly valued, for example, guaranteed annuity rates and minimum bonus rates. This enables
companies to meet the requirements of new regulations, such as European Embedded Values, individual capital
assessments and C-3 Phase II calculations for variable annuity products.
In the UK, companies are typically exploring the interaction of bonus policy with future investment performance and
are seeking new ways to optimise the balance between policyholder and shareholder returns, and the risks they
incur. This feeds through to investment strategy, bonus policy and product design. In Continental Europe, the issues
brought about by reduced rates of inflation and interest rates are frequently different. Typically, companies are
concerned with measuring the effects and consequences of increasing the proportion of assets invested in equities.

Model office projections

47

Model office projections


In life assurance terminology, a model office is an actuarial representation of the finances of a life assurance
company. Such models are primarily used to project the financial position of the company.
A model office projection is built up from individual profit tests of existing business and, if required, of future new
business. For existing business the starting point for the projection is usually the policy records as at the start date
of the projection. In many cases, representative policies called model points are generated using a grouping
process. These model points are then used instead of individual policy data to reduce the processing required.
If a projection of the in force business is made using expected future experience and the profit stream is then
discounted at a risk discount rate (in other words using assumptions comparable to those in a profit test) a value is
obtained for the existing business. This is known as the embedded value of the business. This term is usually
defined to include any existing accumulated profits or surplus held. This latter item is called the net asset value.
Many companies monitor their financial health through the progress of the embedded value from year to year and
may include it in consolidated group accounts.
Embedded values are usually tested by means of sensitivity runs which quantify the effect of a change in each of
the main assumptions.
If a value is added for the future new business which may be written by the company, an overall value of the
company is obtained. This is called its appraisal value and is often used to determine a price for purchase or sale of
the company.
The value for future new business is called goodwill and is typically calculated as the value of one year's future new
business multiplied by a factor. This factor can be determined by assuming a certain rate of new business growth
valued at a risk discount rate which allows for the uncertainty that the sales will be achieved. Goodwill can also be
calculated based on projected sales volumes year by year for each product.

48

Chapter 1 Uses of Prophet

Profit testing
Profit testing is used to help design and price future new business which may be written by a life assurance
company. It helps the actuary set the premium rates and benefits which can be afforded. It is also the main building
block for most of the other types of calculations described below.
In Prophet, a "profit test" is a cash flow projection of a single policy. In this projection, probabilities are applied to the
various events that can occur during the projection, for instance of the policyholder surrendering the policy, or
dying.
Account is also taken in the profit test of the need for the company to set up reserves to meet future liabilities.
Assumptions are made as to the investment return that would be earned on the assets backing these reserves. An
allowance is also made for the cost of selling and administering each policy.
The resulting cash flow is a stream of the expected profits - the profits likely to be earned by the company from the
policy. There is normally a loss in the month of sale, called new business strain. This arises because the initial costs
and reserves required to be set up usually exceed the initial premium paid. The pattern of profit is often referred to
as the profit signature of the policy.
The value of the policy to the company at any point in time is obtained by discounting the future profit flows at a
suitable rate of interest which is typically called a risk discount rate. A risk discount rate is an interest rate higher
than that assumed to be earned on investments to take into account the uncertainty that the profit will actually
emerge in the future.

Statutory valuation

49

Statutory valuation
Insurance companies must periodically demonstrate to the regulatory authorities that they are solvent. This
requires, amongst other things, a valuation of their policy liabilities to determine an adequate level of reserves. This
valuation is usually made using more prudent assumptions than are expected to occur in practice.
There are two main alternative approaches to the valuation calculations. For conventional (also called traditional)
business, the normal approach is that valuation factors are constructed using actuarial commutation factors and are
applied to the benefits attaching to each policy to determine the appropriate reserve.
The second approach is to perform a cash flow projection for each policy, starting from the valuation date and using
conservative assumptions. For example, one normally assumes that the policy does not lapse or surrender in the
future. This approach is commonly adopted for unit linked business and in recent years has begun to be adopted
for conventional business.
The reserves that are set up are not normally allowed to be less than the current surrender value.

50

Chapter 1 Uses of Prophet

Profit recognition
The statutory valuation basis normally leads to the company incurring a loss when a policy is sold, followed by
profits thereafter. For many types of products these profits are concentrated more in the later years of a policy than
in its early years. This pattern rarely reflects either the work done or the risks borne by the company so, in a number
of countries, attempts have been made to find a more appropriate method of profit recognition.
One common method is to use embedded value profits since this gives a measure of the value added in any
accounting period. Other methods used are achieved profits in the UK, margin on services in Australia and GAAP in
the US.
These methods of profit recognition typically require a projection on a basis different both from the future expected
experience and from the statutory valuation basis.

Analysis of actual financial performance

51

Analysis of actual financial performance


Many of the uses of Prophet are concerned with determining a value or a liability at a point in time. Comparison of
successive values over time gives a measure of the profit earned. In order to gain confidence in a newly calculated
value, it is normal to attempt to reconcile its change from the previously calculated value. This reconciliation must
reflect both the changes to the underlying policy data in the inter-valuation period and any changes made to the
valuation basis, for instance to reflect changes in economic conditions. This is particularly important when the
values produced by Prophet are published, for instance to report embedded value profits.
Prophet's Analysis of Movements modules have been developed to enable an exact analysis to be produced
automatically of the effect of policy movements on embedded value profits, statutory profits and the change in
embedded value between one valuation and the next. They do this by projecting policy data which includes all
significant policy movements in the inter-valuation period both on an "expected" basis and on an "actual" basis and
then comparing the outcomes for each type of policy movement. In addition, multiple sensitivity runs may be
performed as part of a single run to quantify the effect of changes to the valuation basis.
This is a very important analysis for many companies and often needs to be produced under considerable time
pressure. The primary purpose of these Analysis of Movements modules is to enable companies to automate a
major part of the processes, significantly reducing the risk of surprises arising late in the day. However, once they
have been absorbed into the reporting processes, they can also be used to more positive advantage. The detailed
approach adopted by Prophet enables companies to drill down from the overall reported values to find the
individual areas of the company performing better or worse than expected. Ultimately the analysis can be used as
a means of focusing all functions of the company on "added value".

52

Chapter 1 Uses of Prophet

Experience analysis
Analysis of past performance is an important step in choosing appropriate assumptions for the mortality, lapse,
sickness and other rates that need to be used in the pricing, reserving, model office and other types of calculations
carried out using Prophet. An experience analysis system called Glean has been developed as a Prophet module
to make it easy to carry out these types of analyses. Powerful facilities are provided to enable three main types of
analysis to be carried out:
n

Actual Rates an intuitive "drill down" data analysis tool is provided. This uses data cubing techniques and
charts to enable you to investigate the effect of any of the factors that may affect the experience, such as product
type, age, policy year and distribution channel.

Actual versus Expected Ratios complete models of your expected rates can be set up using Prophet
mortality and generic tables. These can then be compared with actual rates using the same powerful data
analysis tool.

Generalised Linear Modelling allows you to analyse your experience using sophisticated statistical
techniques to determine the most significant factors affecting your experience.

General Insurance applications

General Insurance applications


SunGard will shortly be releasing a suite of new General Insurance Prophet applications that will augment the
existing offerings to General Insurance businesses:
n

General Insurance Capital Modelling providing dynamic financial analysis, business planning, pricing and
strategic investigations

General Insurance Reserving providing deterministic and stochastic reserve calculations

These will sit alongside the current applications in supporting specific General Insurance business:
n

DCS for data export, transformation, validation and correction

Glean for experience analysis and multiplicative pricing analyses and models

For more information please contact your usual SunGard Prophet account manager or the Prophet Helpdesk
prophet.helpdesk@sungard.com.

53

54

55

C H A P T E R

Getting Started

TOPICS IN THIS CHAPTER


Starting Prophet

56

What is a workspace?

60

Opening or creating a workspace

61

A Tour of Prophet Professional 8

72

The main modelling process

86

Quitting Prophet

89

56

Chapter 2 Getting Started

Starting Prophet
To start Prophet:
1. From the Windows desktop click Start and then click All Programs, SunGard iWorks, Prophet Professional.
2. In the Prophet Professional folder click Prophet Professional:

Starting Prophet

57

Prophet program group


The icons in the Prophet program group identify the following applications:
Icon

Description
Data Conversion System - This is a self-contained component of Prophet. It is used to convert files of
policy data into the format required for Prophet calculations. For more information refer to the Data
Conversion System and Viewer User Guide
Prophet Professional - This is the main Prophet application.

Prophet Viewer - This application enables policy data and model point files to be displayed and
analysed. It is generally accessed from within Prophet Professional or the Data Conversion System.
For more information refer to the Data Conversion System and Viewer User Guide.
Results Viewer - This application is used to inspect run and error logs, collectively known as a run log,
that are generated when a Prophet run is performed. This application is also used to create, query and
inspect the results data.
API Examples -This folder is displayed only if the Prophet Professional API has been licensed. It is
used to hold a set of examples that illustrate how the API can be used.
API Quote - This is a sample application that illustrates how the Prophet Professional APIcan be used
to drive an insurance quotation system.
Configuration - This contains a set of tools that are used to set up or test applications.

Configure Excel for Prophet - This configures the Prophet interface to Microsoft Excel. It sets the
interface to use the files appropriate for the version of Microsoft Excel installed on your PC. See the
section "Configuring Microsoft Excel for Prophet Excel Reporting" in the "Installing support applications"
section of the "Prophet Installation" chapter of the "Technical and Installation Guide "
HASP Remote Update System Utility- -This tool is used to collect and update licensing information as
detailed in the "The HASP runtime environment" section of the "Technical and Installation Guide".

58

Chapter 2 Getting Started

Icon

Description
Prophet Licence Manager - The Licence Manager is used to manage and control licences for the
Prophet Professional application, the actuarial libraires and any additional tools or features. Refer to
the "Technical and Installation Guide" for information on how to use the Licence Manager.
Test Workspace -This application tests Firebird and the workspace connections. By browsing to a
Prophet workspace and clicking Test a number of tests are carried out, the results of which can be
saved to a text file by clicking Save As
Prophet Tools - This folder can contain miscellaneous file conversion utilities.

Stochastic File Converter - This application allows you to convert stochastic files to a format that can
be used by Prophet.

Starting Prophet

59

Logging in
To start Prophet you click the Prophet Professional icon in the SunGard, Prophet Professional 8.2 program group.
This will start Prophet Professional and load the start page, similar to shown below:

60

Chapter 2 Getting Started

What is a workspace?
A workspace is the environment in which you work with Prophet. It consists of a number of objects, some of which
lie within a workspace file and some of which are separate files in the workspace location and its sub-folders. Some
of these objects are set up when you create a new workspace. Other objects are generated by you as you work.
The most important types of objects in a workspace are:
n

Libraries, which contain variables, actuarial definitions and formulas

Products, which define the specific calculations you require

Accumulations, which combine together the results for different products

Tables, which contain tabular data to be used in the calculations, for instance policy data and parameter values

Structures, which define the objects that are run

Run settings, which define how the objects are run

Results, which hold the values calculated in a run

The most important action you can take in a workspace is to run an object. You can run a product or accumulation
individually or you can run a number of products and accumulations together by including them in a structure and
then running the structure.
The run process performs the calculations you have specified and produces results.
Refer to the "Prophet concepts and terminology" chapter that describes these objects and actions and the
relationships between them in more detail.
Note: Although some objects are discrete files in the underlying folders, you must only access them through the
Prophet menus, windows and dialog boxs.

Opening or creating a workspace

61

Opening or creating a workspace


When you start Prophet Professional there's a section to the left of the start page similar to the following:

You must open a workspace before you can start to work. If you do not have an existing workspace then you need
to start by creating one.
The start page dialog box is divided into a number of section, from which you can perform actions as follows:

62

Chapter 2 Getting Started

Create a new workspace


You can create an empty workspace with no libraries, products or tables. Alternatively, you can create, using a
template workspace, a new workspace containing only libraries or a workspace containing libraries, products,
tables and other related objects. A template workspace that contains an example model office is supplied as
standard with Prophet.
You can create template workspaces from your own standard workspaces using the Install Template option in
the Utilities tab. See Installing a template workspace in the Workspace .Utilities chapter in this manual.

Open an existing workspace


An existing workspace can be selected from the displayed list of previously accessed workspaces or once
clicked on you can Browse and navigate to the folder containing the workspace.

Recent Workspaces
Recently opened workspaces are listed in two sections - pinned and unpinned. Click a workspace name to
open it (in a new instance of Prophet Professional if you already have a workspace open). Click the pin icon to
the right of a name to pin / unpin the workspace. Pin a workspace name to ensure it remains permanently in the
list, and is not replaced over time by a more recently opened workspace.

Opening or creating a workspace

63

Multi User
If Firebird Server is installed on the machine then workspaces on the local machine can be accessed by other
users either as a Master User or a Viewing User. The Master User has full editing rights to the workspace and
can also allow Viewing users limited access to the workspace and the tables associated with the workspace.
For more information see: Managing multi-user access later in this chapter.

Access documentation
Links to various PDFuser guides and a tutorial are provided at the bottom of the start page dialog box. Select
the check box to close the start page after a Workspace is loaded.

64

Chapter 2 Getting Started

Creating a new workspace


You can create the following types of workspaces:
n

An empty workspace
This contains no libraries, products or other related objects.

A workspace created from a template workspace


Using a template workspace you can create a workspace containing either libraries or libraries together with all
the files included in a workspace such as products, tables and other related objects. A template workspace that
contains libraries and Example Model Office files used in the Model Office tutorial.is supplied as standard with
Prophet.
Note: You can set up template workspaces from your own workspaces using the Install Template Workspace
dialog box. This is displayed when you click Create Template from the Utilities tab. See Creating a template
workspace in the Workspace Utilities chapter of this manual.

Creating an empty workspace


You normally create a new empty workspace if you intend to develop a new workspace containing new libraries or
products. To create the empty workspace click the Prophet button and from the Prophet menu choose New. The
Create New Workspace dialog box is displayed:

Opening or creating a workspace

65

Enter the workspace location into which the workspace is to be created. Alternatively, click Browse to locate an
existing folder to be used.Also, to identify the workspace, enter a description for it in the Description text box.
When you click OK the new empty workspace is created and then opened.
Note that:
n

If your Prophet Administrator has enabled User Permissions then you need to have "Create Workspace"
permissions set for you user logon to be able to create a new or empty workspace.

If you want to use an existing workspace as the basis for some new work you should start by creating a copy of
that workspace. See the section "Copying a workspace" in the "Workspace utilities" chapter of this manual.

Creating a workspace using a template workspace


Prophet is supplied with a number of standard libraries. When you create a new workspace all the libraries that
have been supplied to you are automatically included in the workspace. A manual is also supplied with each library
explaining its capabilities and how it should be used. All of these manuals can also be viewed on screen by
choosing User Manuals on the Support tab as shown below.

Example Model Office


If you are a new Prophet user then you should generally start by setting up a workspace that includes the Example
Model Office. For more information on the Example Model Office see "Example Model Office" in the "Runs" chapter
of this manual.
To create a workspace using a template workspace:

66

Chapter 2 Getting Started

Click the Prophet button and from the Prophet menu choose New. The Create New Workspace dialog box is
displayed.

Enter the location of the new workspace or browse to the location to which you wish to save the workspace and
then do ONE of the following:

To create a workspace from an existing workspace template


Select Install Template and from the dropdown list choose a template workspace, for example, Example Model
Office. This creates a workspace containing the libraries in the selected template workspace together with the
products, tables and any other associated files in the selected template.

To create a new workspace containing libraries only


Select Install Template and from the dropdown list choose a template workspace, for example, Example Model
Office. Then select Install Libraries Only. This creates a workspace that contains only the libraries in the
selected template workspace.

When you click OK the workspace is created and then opened


Note: If your Prophet Administrator has enabled User Permissions then you need to have "Create Workspace"
permissions set for your user logon to be able to create a new or empty workspace.

Opening or creating a workspace

67

Opening an existing workspace


You can open an existing workspace in any of the following ways:
n

Choose a workspace from the Recent Workspaces list in the Prophet menu.

In the Prophet menu, click Open. If no workspace is open in Prophet then the Open Workspace dialog box is
displayed from which you can choose a recently used workspace or browse to the location of an existing one.
You can also set the Multi-User options from the Open Workspace dialog box.

In the Workspace section of the Start Page, click Open an Existing Workspace and browse to the appropriate
prophet.prw file.

You can have any number of Prophet workspaces open on your PC provided it has enough memory. Each
workspace starts Prophet as a separate application. If the workspace is already open, a message appears
informing you that the database is already in use, and the name of the current user. In this case Prophet does not
allow you to open the workspace.
Note the following:
n

Before you open a Release 7.3 workspace in Prophet Release 8.0 or later it is recommended that you have a
complete backup of the Release 7.3 workspace. When the workspace is upgraded it cannot be opened or used
by Prophet Release 7.3.

You can set up a shortcut to bypass the Prophet dialog box and thus open a workspace directly. See Creating a
shortcut to open a workspace on page1.

Opening an additional workspace


Prophet allows you to work with more than one workspace with each one being hosted in a separate Prophet
application. To open another workspace from within Prophet you select or open it from the Prophet menu.

68

Chapter 2 Getting Started

You can choose a previously opened workspace from the Recent Workspaces list or click Open and browse to the
location of an existing workspace. In either case, Prophet launches another instance of the application tion and
then loads and opens the selected workspace.
Before you open a workspace that may be accessed by other users you need to specify whether you are a Master
user or a Viewing user in the Multi-User section of the dialog box.
For more information refer to Managing Multi-User Access.

Opening a workspace
If no workspace is open in Prophet then you can open an existing workspace from the Open Workspace dialog box
by choosing Open from the Prophet menu. The Open Workspace dialog box appears similar to the following:

Opening or creating a workspace

69

Before opening a workspace that may be accessed by other users you can specify whether you are a Master user
or a Viewing user in the Multi-User section of the dialog box.

Specifying the User type


You can specify to be one of the following types of user:
n

Master User
If you choose this option then you will have complete editing control over the workspace that you open subject
to the restrictions that may apply if User Permissions is enabled.

Viewing User
Choosing this option limits access to the Results, Reports view of the workspace open in Model Office. Build
view. If the Master User has allowed tables to be edited then the Viewing User can also view and edit the tables
in the Model Point Files and Tables view in Model Office Build view.

For more information refer to Managing Multi-User Access.


If the workspace you want to open is not listed in the dialog box then click Browse to locate it. A Prophet workspace
is identified by the existence of the workspace file Prophet.prw in a folder.
Note: You can also select and open a workspace that you have used recently used from the Recent
Workspaces list of the Prophet menu.

70

Chapter 2 Getting Started

Note: To edit the list of workspace shortcuts see Managing the workspace shortcut list.

Managing multi-user access


Access by other Prophet Professional 8 users to workspaces on your local machine is only available if Firebird
Server is installed on the local machine.
Note: If Firebird Server is installed some time after the installation of Prophet Professional then only those
workspaces created on or copied to the local machine after the server installation will have the multi-user
access capability.
Before selecting and opening an existing workspace on a machine that has Firebird server installed a user can
specify whether they are a Master user or a Viewing user in the Multi-User section of the start page.
The Multi-User Access section appears similar to the following:

You can choose from the following options


Master User Full Editing Capabilities
If you choose this option then you will have complete editing control over the workspace that you open subject to
any restrictions that may apply if User Permissions is enabled. As a Master user you can allow viewing users to
open the workspace and also edit the model point files and tables used by the workspace.
Viewing User
Choosing this option restricts access to the workspace. As a Viewing User you only be able to view the workspace

Opening or creating a workspace

71

you won't be able to change any objects or perform a run. If the Master User allows the editing of tables then the
Viewing User can also edit Model Point Files and tables used by the workspace.
When using Multi-User Access you should consider the following:
n

The default setting is Master User.

In general, the first person to open a shared workspace can elect to be the Master User subject to any
workspace restrictions placed on the user if User Permissions is enabled.

There can only be one Master User for a shared workspace. However, there can be any number of Viewing
Users subject to the restrictions placed on the workspace if User Permissions is enabled.

User workspace editing restrictions applied by the User Permission feature take precedence over those applied
by the Multi-User Access feature. For example, a Master or Viewing User is not able to view results in a
workspace to which they have insufficient rights.

A Viewing User cannot open and view a workspace to which a Master User has not allowed access.

If the first user to open the workspace is a Viewing User then the user is automatically assigned table editing
rights subject to any restrictions placed on the workspace if User Permissions is enabled.

Creating a shortcut to open a workspace


You can set up a shortcut to open a particular workspace
To set up a shortcut:
1. Right-click on the Windows desktop, point to New and click Shortcut.
2. In the dialog box type the name and location of the workspace. (For example, to open the workspace in the
location C:\PROPHET, type C:\PROPHET\Prophet.prw, where prophet.prw is the workspace file.)
To use the shortcut:
n

Double-click the shortcut.


Prophet starts and the specified workspace opens.

72

Chapter 2 Getting Started

A Tour of Prophet Professional 8


The diagram and descriptions below shows the different areas of Prophet Professional 8.

The Tree and object browser


This is to the left of the Main Window. The object browser is the section at the bottom, and it is from here you can
choose the starting point of the tree. The tree has been designed to show the interrelationship between the different
Prophet objects. The tree can be used to see for example what tables are referenced in a run setting, what
products are in a structure, what results have been generated for a product etc. You might find it useful now to
spend a few moments exploring the tree of an example model office workspace.

The Ribbon
This is at the top of the screen it is from here that you can perform actions on the objects opened in the work area or

A Tour of Prophet Professional 8

73

selected in the Tree or the List. There are four main tabs on the Prophet ribbon: Home, Object, Utilities and
Support and 4 context-sensitive tabs: Design, Diagram, Table and Print Preview. Each tab is subdivided in
groups.

The Prophet Button and Quick Access Toolbar


This is the button with the Prophet logo in the left hand corner; similar to Microsoft Office it contains general actions
and a useful Options button. To the right of the Prophet Button is the Quick Access Toolbar which can be
customised.

The Main Window


This is generally editable and is where details of opened objects are displayed.

The Level Tabs


There are three level tabs which give context to the open windows, the top level may not be showing when you first
open Prophet Professional 8, to view it, on the Home tab in the View group click Group Tabs.
The top level can be expanded to view the objects as a list by clicking on one of the buttons to the right of the top
level tabs.
You can see that each of the main objects in a workspace has a top level tab the number shown in brackets is the
number of objects currently open.
The following shows an example model office workspace with the Start page, 1 Product (C_GIB_) with 2 Variables
(YR1_LAPSE_SY and VAL_DTH_PAYT) and 1 Table (Global.fac) open. The focus is on the product tab which has
been selected by clicking on it.

74

Chapter 2 Getting Started

The list of open windows can also viewed by clicking (or using shortcut F12) on the Open windows pane to the right
of the main window.

Again at this stage you may find it useful to open a few objects and navigate between them. Also view the list and
observe the different details displayed for each object.

A Tour of Prophet Professional 8

75

Using Find and Replace


The Find and Replace option is used to locate Prophet objects in a workspace and text strings in a product, library
or table. The option is accessed from the Find/Replace option in the Home tab and allows you to select the type of
search operation you wish to perform from a menu:

The Find/Replace option is also context aware. For example, if you click Find/Replace from the Home tab while
working in a library then the Find/Replace in Product/Library panel appears.
For information on using Find in a workspace see: Using Find in a workspace on page77.
For information on using Find/Replace in a product or library see: Find and replace for a Product or Library on
page80.
For information on using Find/Replace in tables see: Finding and replacing data in tables on page248.
For information on using Find/Replace in an open table see: Finding and replacing data in a table on page251.

Docking windows
With the exception of the Object Browser you can change the layout of the windows within the application.Each
child window can be: picked and then placed wherever it is required in the main application window. A child
window can be:
n

Docked

Collapsed

76

Chapter 2 Getting Started

Tabbed

Independent sub panes created

The windows that can be docked are listed in the View Panes list which is accessed from the Home tab:

From the list you can show or hide:


n

The Object Browser

The Open Windows pane

History pane

Actuarial documentation pane

Preview pane

A selected window can be in any of the following forms:


n

Collapsed tab: Hover over the collapsed tab to expand the window until the cursor is moved away.

Pinned: Select the pin icon on the window to pin the selected window permanently to the Main window. In this
pinned state, the window can now be un-docked from its current position, and docked in other locations on the
Main window, with guidance from the widget. (The Object Browser cannot be un-docked.)

A Tour of Prophet Professional 8

77

Independent sub-pane: In their un-docked state, you can leave child windows as floating windows, re-size them
and place them anywhere on the screen as required.

Embedded and tabbed: You can also dock a child window within or above another active child window which is
either pinned or floating.

When in Debug mode, child windows also share enhanced functionality.


To reset the layout of the panes, click Reset Layouts from the Home tab.
Note: The Object Browser cannot be un-docked from the main window.

Using Find in a workspace


The Find option in a workspace is used to locate Prophet objects in a workspace.
To search for an object in an open workspace:
1. On the Home tab click the arrow below Find/Replace and select Find/in Workspace.
2. The Find in Workspace panel with search results appears similar to the following:

78

Chapter 2 Getting Started

3. In the Search text box, enter the name of the object to be found. As the name of the object is progressively
entered Prophet searches the open workspace and lists the likely objects.
4. You can also select the following options:
n

Find in Tables
Prefixes the term tab to the name of the object entered in the search text box. This displays a list of the
references to the search object found in table rows and headings only.

Find in Reference
Prefixes the term ref to the name of the object entered in the search text box. This displays a list of the
references to the search object found in Prophet formulas only.

Group by Type
Organises the search results by object folder.

Search results are displayed as a tree to which new results can be added. To create a new tree node to hold the
results of a new search click Add New Node.
To remove all previous search results click Clear All Results.

A Tour of Prophet Professional 8

79

Note: Clicking the Tables search and Ref buttons restricts the search to instances of the search object in tables
and Prophet formulas only.

80

Chapter 2 Getting Started

Find and replace for a Product or Library


The Find / Replace panel is shared between products and libraries. It allows search and replace operations to be
performed on data within a selected product or library. All options in the panel are applicable to both products and
libraries with the exception that only variable definitions can be searched in a product.
To display the Find/Replace panel:
1. In the Object Browser, open the folder containing the library or product to be searched.
2. Select and open the library or product in which you wish to locate information.
3. On the Home tab, click Find/Replace. Alternatively, in the Home tab, click the arrow below Find/Replace and
click Find/Replace in Product/Library.
4. If the panel is floated then it can be re-sized similar to the following:

The following are available:


n

Find and replace section


This section allows you to enter the search and replace settings for either a product or library which is selected

A Tour of Prophet Professional 8

81

in the Look in drop down list.


n

Find Within section


This section allows you to specify where to look in a product or library. In the case of a product you can only look
within variable definitions.

Start From section


This section specifies where the search and replace operation is to be started.

Options section
This specifies the type of match required for the text entered in the Find What box of the find and replace section.

Scope section
This allows you to search for all or selected items in a product or library.
Note: The Find / Replace panel is context sensitive. Pressing CTRL + F in a Product displays the dialog with the
appropriate Product selected. Similarly, pressing CTRL + F in a Library displays the dialog with the appropriate
Library selected.

A number of search and replace actions can be performed from the panel.

Search operations
The following search operations are available:
n

Click Find All to locate all occurrences of the search text which are displayed in a results tab which is displayed
alongside the Find/Replace tab in the panel.

Click Find Next to locate an occurrence of the search text which is displayed and highlighted in a code panel.

Click Find Previous to locate an earlier occurrence of the search text which is displayed and highlighted in a
code panel.

Search and Replace operations


If Replace With is selected then the following search and replace operations are available:

82

Chapter 2 Getting Started

Click Replace All to locate all occurrences of the search text to be replaced with the text entered in the Replace
with box. Ideally, you should have a backup of the product or library as this operation cannot be undone.

Click Replace Next to locate and replace an occurrence of the search text displayed and highlighted in a code
panel. If Confirm on replace is selected then you can allow or decline the replacement to take place..

Click Find Previous to locate and replace a previous occurrence of the search text displayed and highlighted in
a code panel. If Confirm on replace is selected then you can allow or decline the replacement to take place.

Performing a basic search:


1. Enter the text to search for in the Find What box and select the product or library to be searched from the Look in
dropdown.
2. Specify other search operation settings in the panel.
Click Find All to locate all instances of the search text. The results are listed in a new tab which is displayed similar
to the following:

As you select an item in the list of results it is displayed in the code editor in the main Work area. If you are
performing a search and replace operation then you can monitor the change in the Code editor by selecting an item
in the list and clicking Replaced Selected.
Note the following:

A Tour of Prophet Professional 8

83

Wild card search text is not available.

By default, the panel appears to the right of the Prophet application window.You can detach the panel by
holding on to the title bar area and dragging it free. Releasing the panel makes it "float" over the application
window. Alternatively, you can dock the panel to one of the edges of the application window.

If the panel is set to float over the application window then you can resize the panel by dragging the lower right
corner of the panel.

Using Find / Replace section


This section is used for a search or as a search and replace facility. If Replace with is not selected then the section
is ready for a search operation and appears similar to the following:

Enter the text to search for in the Find What box and select the product or library to be searched from the Look in
dropdown. Other search operation settings are specified in the panel.

Search and Replace operation


If Replace with is selected then the section appears similar to the following:

84

Chapter 2 Getting Started

Enter the text to search for in the Find What box and enter the replacement text in the Replace with box. Choose
the product or library to be searched from the Look in dropdown. In addition, choose to confirm the replacement by
selecting Confirm on replace and to validtae the replacement by selecting Validate Replace.
Other search operation settings are specified in the panel.

Using within section


This section specifies where in the product or library the search or replace operation is to be performed. In the case
of a product you can only look within variable definitions. The section appears as follows:

Library search, and search and replace operations can be performed on all the options available in this section.

Start from section


This section specifies where the search and replace operation is to be started and appears as follows:

The default is to start a search or a search and replace operation from the beginning.

A Tour of Prophet Professional 8

Options section
This section specifies the type of match required for the text entered in the Find What box of the find and replace
section. The Options section appears as:

Select Exact Match to find those items that only contain the text or number entered in the Find What box. Select
Match Case to locate only those that contain text that has the same upper and lower case characters..

Scope section
This section specifies whether the search or search and replace operation is to be performed on all or selected
items in a product or library. The section appears as follows:

The default is to perfom the search or search and replace operation on all items displayed in the work area.

85

86

Chapter 2 Getting Started

The main modelling process


In order to use Prophet effectively you need to have a specific goal in mind as to what you want to achieve. When
you have analysed your requirements, you can then follow the generic process illustrated as follows:

The steps involved are:


n

Specify the calculations required. Do this by setting up one or more products. Each product is specified through
the definitions given to the variables which make it up.

Set up any tables needed for the calculations. You need to set up tables to correspond to all those variables
which you specify to read tabular data.

Set up policy or model point data to test the calculations.

The main modelling process

87

Run the calculations.

Check the results produced. The main tool provided within Prophet to help you check the results is Diagram
view. Diagram view displays the calculations for each product in a dependency tree structure and shows you
the values calculated for each variable. Thus:

Refine and correct the calculations, tabular data and test data

Re-run until satisfied

Switch to using your real policy data. You can use Prophet's Data Conversion System to help you set up your
data into the format required for Prophet.

88

Chapter 2 Getting Started

Run the calculations

Produce reports on the results. You can produce reports within Microsoft Excel using Prophet Excel Reporting.

All work in Prophet follows this broad process. The processes are all explained in this manual. The details become
more voluminous and complex as you attempt more sophisticated calculations, but the process remains the same.

Quitting Prophet

89

Quitting Prophet
To quit from Prophet you should either:
n

Choose the Exit option from the prophet button.

Click at the right hand end of the title line.

Key Alt+F4.

If the workspace is open, it will be closed before you quit from Prophet. If you have edited any objects in the
workspace but have not yet saved them, you will be asked whether you want to save them first.
Note: If Viewer, Data Conversion System or the Adobe Acrobat Reader are open then you will need to close
them separately because they are separate applications. You also need to close each Prophet application
separately.

Closing a workspace
To close a workspace without quitting Prophet you can:
n

Choose the Close option from the Prophet Button.

The workspace will then be closed. If you have made any changes to the products or libraries in the workspace a
dialog box will be displayed asking if you wish to backup the workspace. If you click on Yes the Backup Workspace
dialog box will be displayed to enable you to create a backup of the workspace. For details see Backing up a
workspace on page782.

Note: If you use the Close option or the


than the workspace.

button from another window just that window will be closed rather

90

91

C H A P T E R

Prophet concepts and terminology

TOPICS IN THIS CHAPTER


Prophet Objects and Actions

92

Prophet system structure

114

Inside libraries and products

115

Types of tables

124

Data Conversion

133

92

Chapter 3 Prophet concepts and terminology

Prophet Objects and Actions


To work effectively with Prophet you need to understand the terminology that is used. This chapter outlines and
describes that terminology as well as the underlying concepts.

Workspaces
A workspace is the environment in which you work with Prophet. It consists of a number of objects, some of which
lie within a workspace file and some of which are separate files in the workspace location and its sub-folders.
Once a workspace is opened in Prophet you can see many of the objects that exist in a workspace. These objects
are displayed and accessed from the grouped panes to the left of the interface. Selecting and opening an object in
a pane allows you to inspect and edit its contents.

You can also attach actuarial documentation to any of the objects in a workspace.

Prophet Objects and Actions

93

Libraries
Libraries are the most important objects in a workspace. They hold the variables, actuarial definitions and formulas
that define the calculations you want to make.

Libraries also contain indicators to help you select the variables you require. The following libraries, grouped by
type, are currently available with Prophet:

Life insurance libraries


n

Conventional Library

Unit Linked Library

International Library

94

Chapter 3 Prophet concepts and terminology

German Library

French Library

Permanent Health Insurance Library

Group Pensions Library

ALM and company level libraries


n

Asset Liability Strategy (ALS) library

Summary Library

Asset Library (US Version)

Global Strategy Library (US Version)

General insurance libraries


n

General Insurance Library

Balance Pricing Library

Business Planning Library

Other libraries
n

Financial Services Library

Printed and electronic documentation is supplied for all libraries. In addition, most libraries also have embedded
information using the actuarial documentation feature.

Products
Associated with each library are products, each of which specifies a single set of calculations. In Prophet the term
"product" is used for these sets of calculation specifications because many products define the financial behaviour
of your insurance products.

Prophet Objects and Actions

95

You can think of products in Prophet as computer programs. The only difference is that Prophet takes care of much
of the programming and you need only specify the actuarial calculations required.
You set up products in Prophet to reflect your insurance products and business requirements. For example, you can
set up a number of conventional, unit linked and summary products in order to calculate embedded values.
Each product is given a level number which controls the order in which the products are run in a model office.
Liability products are normally all given the same level number.
You can also specify that a product uses the same calculation specifications as another product by defining it to be
the Same As that other product.
Prophet provides a sophisticated process to help you specify your products. The exact specifications for the
calculations to be made are stored in the definitions given to variables. This process uses indicators to define the
scope of the calculations and is described later in this chapter. For example, the following screen displays input
variables for a term assurance product:

96

Chapter 3 Prophet concepts and terminology

To see how products are specified in Prophet, a number of example products are supplied which can be installed
and run.

Accumulations
When you have set up more than one product you can set up accumulations to add their results together.
Accumulations can be used to add together any combination of the results produced by products or by other
accumulations. In particular, accumulations enable you to report on the overall results for your company. Like
products, they are also given level numbers, which need to be greater than or equal to the level numbers for the
products they are accumulating.
The following shows an example of an accumulation which accumulates existing business results for all the
individual products sold by a company:

Prophet Objects and Actions

97

Accumulations are also used to generate the inputs needed for products specified for company sub-fund or fund
level calculations. Such products need to be given level numbers that are greater than the level numbers given to
their underlying accumulations.

Tables
Prophet allows you to set up a number of different types of tables which can then be used in your product
calculations. The main types of table which can be used are:
n

Model point files, containing your policy data

Global files, containing constant values which apply across all of your products

Parameter files, containing constant values which vary by product

Unit Prices files, containing prices to value the initial numbers of units held

Mortality tables, containing select or ultimate mortality rates

Year dependent mortality tables, that is mortality tables where the rates depend on the calendar year, typically
AIDS and some annuity tables

Generic tables, containing any tabular data required for your product calculations

Stochastic tables, containing assumptions that vary by simulation

Sales files, containing assumptions for volumes of future new business

Segment tables, these are used by the Asset Liability Strategy library.

Table of Tables is a specific type of generic table that is used to hold references to other tables. The READ_
TABLE_NAME function is used to obtain the name of a table through the product and run number implicitly and
the value of a variable set in the code.

You set up these tables independently from the products. You specify which tables should be used in any run in the
run setting (see "Run Settings" for more information about run settings). Thus:

98

Chapter 3 Prophet concepts and terminology

Between runs you can change the values to be used by editing the tables, by changing the run setting to refer to
sometimes different tables or by setting up a number of run settings which refer to different tables.
Each table is set up using a grid and is automatically saved into the format required for it to be read during a
Prophet run. Every cell in the grid can have a value entered directly or can be defined by selecting an option from a
dropdown list.
Various facilities are included to enable the variables required in model point, global or parameter files to be
entered automatically from the product specifications. A more detailed description of each type of table is given later
in this chapter.

Prophet Objects and Actions

99

Structures
When you run the calculations you have set up, Prophet needs to know which products and accumulations should
be run. You store this information in structures.
The links between the products and accumulations in a structure can be viewed diagrammatically. You can also
see a list of the tables used by these products and accumulations.

You can also specify the method to be used for projecting new business. You are also able to limit the calculations
to a variable or a set of variables that you specify. Prophet will then only calculate those variables and the variables
on which they depend. For example, you could specify that only the mathematical reserve is to be calculated. This

100

Chapter 3 Prophet concepts and terminology

enables faster run times to be achieved because all the variables in the product which calculate the projected
profits, embedded value, etc are excluded.

Prophet Objects and Actions

101

Run settings
Various additional information is needed to enable a run to be performed and this information is stored in run
settings. In a run setting you specify items such as the start date for the projection, for how many years the
projection should be made and where to look for the tables and files to be used in the calculations.

In a run setting you also specify the run number to be used, which defines the location in which the results are
placed. For instance, you can run a product several times automatically, using different assumptions from the global
file for each run and using the run numbers to place the results in different locations. You can think of run numbers
as identifying alternative scenarios which you want to evaluate.

102

Chapter 3 Prophet concepts and terminology

Actuarial Documentation
You can attach documentation to the objects in the workspace through a window that can be opened at any time.
Thus:

This window displays the objects in the workspace in a hierarchical manner. Through it you can view, edit, compare
and print the documentation associated with individual or multiple objects. For instance you can edit the
documentation supplied with the libraries to reflect any changes or extensions you make. You can also create
documentation for the products you have created.
The actuarial documentation editor includes the types of features found in a word processing package, such as the
capacity to use different fonts, colours, indentations, bullet points and spell checking. You can also embed files
such as Microsoft Word documents and Excel workbooks.

Prophet Objects and Actions

103

The relevant part of this documentation can be viewed anywhere in the workspace through a context sensitive popup window.

Running products
When you have completed the specification for one or more products and have set up the tables and files they will
use, you can then run them. Within Prophet you can run a product individually or you can run one or more run
pairings. Each run pairing is a combination of a structure and a run setting.
If you run a product individually, you are prompted to specify a structure and run setting so that Prophet knows
where to look for the locations of the tables and files to be used and to provide all the other information Prophet
needs to process the run.

Code preparation
The first part of the run process is the code preparation stage during which Prophet takes the calculations specified
for each product and automatically converts them into a computer program, building in the appropriate inputs and
outputs and organising the order of calculation of the variables to reflect the dependencies implicit in your product
specifications.
Prophet works out for itself which variables evaluate to constants and which are time dependent. It calculates
values for every month for variables which are time dependent and, in this code generation phase, determines and
resolves any time dependencies between and within variables, both forwards and backwards in time.
For some variables it is necessary to start the calculation at the start of the projection and work forwards (eg number
of policies in force). For others it is necessary to start the calculation at the end of the projection and work
backwards (eg discounted value of future profits).
The code generator then converts these specifications into "C" code and compiles an executable program.
For goal seeking and looping calculations, the code generator automatically includes the additional looping
required in the calculation processes.
Prophet's code generator is designed to handle complex requirements such as recursive formulas and looping. The
code generator organises the order of calculation to reflect the details of the actuarial formulas entered. It gives you
the freedom to specify formulas in any order and with any dependencies.

104

Chapter 3 Prophet concepts and terminology

The automatic code generation process means that you can return to existing products in the future to add new
features and complexities without first needing to analyse existing code and then, potentially, to rewrite or to
reorganise it.

Compilation
Prophet automatically compiles the products. Prophet can use either the standard Microsoft C++ .NET compiler or
the Intel C++ compiler. Faster performance can be achieved by licensing the Intel C++ compiler.
This code preparation and compilation process is automatically repeated at the start of each run whenever you
have changed the specification for a product being run since it was last run.

Calculations
When a product is run, the calculations for that product are performed independently for every model point and the
results are summed together. In the model point file you specify a sub-product code for each model point. The
results are stored separately for each sub-product as well as being totalled for each product.

Parallel processing
Prophet has a parallel processing capacity. Parallel processing offers the potential for much higher performance
than any single processor system and gives Prophet a capacity comparable to many mainframe systems.
In parallel PC mode, Prophet uses the processors in a number of PCs in parallel in a single run. Each processor
performs the calculations for a single product, simulation or run number at a time. All that is required is that those
PCs are connected to a network server.
The run is initiated on a single PC and all products are generated and the run controlled by this PC. From this PC,
other PCs can be selected to be used in the run. Each of these PCs will be allocated a product, simulation or run
number which is included in the run but which has not yet been calculated. It will take it and perform its calculations,
writing the results to the same location as the "master" PC. This process will continue until the run has been
completed.
At any stage, the calculations on any PC may be suspended or terminated in a controlled way.

Prophet Objects and Actions

105

New Business calculations


There are three alternative methods by which Prophet can handle the new business calculations. You specify in the
structure the method to be used in that run.

Cross Multiplication new business method


The Cross Multiplication new business method is a simple and fast approach, but may be less accurate than the
Project new business method explained below. In the Cross Multiplication method, the new business model points
are calculated once and are then scaled up, with the appropriate time shifts, for the assumed volumes of future new
business in each month. An adjustment is made to avoid over-inflating non-monetary amounts, specifically counts
of numbers of policies.
If this approach is adopted, the system first produces new business profile results, which are the results of the
model point projection before cross-multiplication. The new business volumes are then applied to produce the
normal projection results.
You should normally start off with and test your products by generating new business profile results, because they
give complete cash flow projections for the model points from the date of policy issue, without any rescaling or time
shifts.

Project new business method


If you specify the Project new business method, Prophet repeats the calculations of the new business profile model
points for each month of the projection and scales each month's results for the appropriate volume of business in
that month. This approach ensures that any calendar date specific calculations automatically reflect the correct
months of sale.
Using the Project new business method, only the accumulated results for all new business are stored in the results.
No new business profile results are produced.

New Business in Model Point File method


You can also include future new business volumes directly in the model point file using the New Business in Model
Point File new business method, but it is normally better to use one of the other methods.

106

Chapter 3 Prophet concepts and terminology

Group pension scheme new entrants


For group pension schemes the new entrants into the scheme can be calculated so as to achieve a specified
number of active members in each future month. This approach can be used in conjunction with both the Cross
Multiplication and the Project new business methods. Either of these methods can also be used to model new
pension schemes assumed to be sold in the future.

Results
Each run can produce a number of types of results, based on what you specify in the run setting. The most
commonly used results are projection results, which are the accumulated results for each month for the period of
projection. Results can include time periods in the past, for instance to enable the calculation of historic asset
shares to be reported on.
When viewed annually, values for revenue account variables are displayed as the sum of the monthly values and
balance sheet variables are displayed as the values in the last month of the year. This is one of the properties given
to each variable.
A further important property of each variable is whether it is cumulative or not. For non cumulative variables, only
the values for the first model point for each sub-product are stored in the results. For cumulative variables, the
values stored are the summed results for every model point within each sub-product and product. Accumulations
only sum together values for cumulative variables. Variables are defined to be cumulative only when it makes
sense to add the values across model points.
Each run also produces a run log, which gives details of exactly which calculation processes, products, files and
tables were used. This information is also stored with each product's results, to provide an audit trail of how they
were produced. Any errors found are reported both in the run log and separately for each product.

Reporting
The results generated by Prophet can be viewed and reported upon in a number of ways. You can:
n

Display the results on the screen

Prophet Objects and Actions

Debug the calculations using Diagram view

Run queries

Report within Microsoft Excel using Prophet Excel Reporting

107

Displaying the results of a run


After you have run one or more products, you can view and print the values produced for any:
n

Run number

Product

Sub-product

Type of results, normally projection results

Group of variables

Prophet is supplied with a number of variable groups set up to cover standard reporting requirements, such as
revenue accounts and balance sheets, as well as other analyses. You can add to or modify these groups as you
wish, to reflect your particular requirements.
The following screen shows the revenue account for a term assurance product:

108

Chapter 3 Prophet concepts and terminology

You can also view and print an audit trail showing the dates and times of all the objects used in your calculations.

Debugging the calculations - Diagram View


To help you to understand the calculations and, if need be, to debug the values produced, you can use Diagram
view. This allows you to display:
n

The interdependencies between the variables in any product

The values calculated and used at each step

For this purpose it is usually best to set up test data in the model point files and only to include one model point for
each sub-product. Hence, the values that are displayed are only those calculated for a single model point. Thus:

Prophet Objects and Actions

109

One pane displays the name of the current variable in a box with lines linking it to boxes showing the variables it
depends on and the variables which depend on it. If the cursor is clicked on one of these other variable names, it
becomes the current variable and is moved to the centre of the pane.
Panes to the left and right allow the roots and branches of the current variable to be investigated by expanding the
dependencies to as many levels as required. As the cursor is moved across the variables in these three panes, a
further pane beneath them shows the formula or definition of each variable.
A further three panes show the values in the results files for the current variable and for the variables which
comprise its immediate roots and branches. You may select the sub-product code for which the values are
displayed.
All of the panes may be scrolled or resized to reflect the volume of information being displayed. Further operations
may be invoked from the Diagram ribbon.

110

Chapter 3 Prophet concepts and terminology

You can also use this view when you are setting up the definitions for a product. As you create and amend
definitions the diagram is immediately updated with the new dependencies.

Prophet Objects and Actions

111

Reporting with Prophet Excel Reporting


Prophet includes a sophisticated interface into Microsoft Excel. This includes a large number of reporting templates
to show you how you can set up workbooks to produce reports in the exact formats you require.
Part of the installation process for Prophet installs this interface. Then, when you load Microsoft Excel, an additional
Prophet ribbon is available from which you can access the report generator, sales generator, help system and
Prophet Excel Reporting functions.

The central components of this interface are a number of additional functions which you can include in the formulas
in each cell of a Microsoft Excel worksheet. Each function returns a value or text string from Prophet's results,

112

Chapter 3 Prophet concepts and terminology

depending on the parameters passed to it. For instance, for the function that reads the main projection results, the
parameters are:
n

Workspace location

Run number

Product

Sub-product

Variable

Time period

The effect of this approach is that values are read as required rather than needing to be loaded and made resident
in memory.
There are also functions that enable the details of variables and products to be read, for example their descriptions
and time stamps.
Prophet Queries For Excel Reporting
This feature of Excel Reporting is based on a rewritten query engine and has a new interface in Excel. The key
features are:
n

Insertion and storage of Query Sheets in a workbook.

On-sheet GUI controls which show allowed values of each dimension such as Run_No, Product and Variable
and allow dimension filters to be set.

Ribbon controls for creating, editing and replicating queries.

Same query types and query filters as normal Results Viewer queries. This includes wildcards and variable
group or property filtering.

Load and Save Queries from disk. You can load Prophet Results Viewer queries into Excel or vice versa.

Prophet Objects and Actions

113

Large queries generally provide significantly superior performance to normal Excel Reporting worksheet
functions.

Reporting templates
Each reporting template provides one or more worksheets set up to produce a single report. The templates cover
the main outputs which can be produced by Prophet. For example:
n

Revenue accounts

Reserves and balance sheets

Distribution of surplus

Shareholder fund / profit and loss account

Volumes of business sold and in force

Values of business sold and in force

Templates are also included for all of the main UK PRA Return Forms for which Prophet can perform the
calculations.
You can use any or all of the features of Microsoft Excel to translate the templates into whatever formats you
require. Alternatively, you can set up your own templates or reporting formats by directly keying in the Prophet
function names you require.

114

Chapter 3 Prophet concepts and terminology

Prophet system structure


The following diagram summarises the main elements of Prophet:

Inside libraries and products

115

Inside libraries and products


This section provides an overview of the construction of the libraries and how you use them to specify your
products.
n

Libraries hold the actuarial definitions and formulas which define the calculations you want to make.

You use the libraries to specify products. Each product is a single set of calculation rules.

Indicators
Within each library, we have set up indicators to help you to select the most appropriate definitions and formulas for
each variable included in each product.
A product is specified by first selecting the appropriate indicators which define the scope of the calculations to be
performed. For instance, if you specify a new product or amend an existing one, a dialog box similar to the following
appears:

Documentation for an indicator appears at the bottom of this dialog box.

116

Chapter 3 Prophet concepts and terminology

An indicators Wizard is also available to guide you through this process.


You can specify which indicators are displayed by selecting options at the bottom of the dialog box. You can also
read the actuarial documentation for a selected indicator in a pane at the bottom of the dialog box and view any
selection criteria associated with the selected indicator that specifies whether the selected indicator is dependent
on the presence or absence of other indicators.
If you click Wizard an Indicator Wizard is displayed that guides you through the selection of Indicators. It appears
similar to the following:

With experience, you may wish to extend the libraries with your own additional indicators.
A number of new properties are also provided for indicators in order to make it easier to select the indicators
required for a particular product

Inside libraries and products

117

An "Advanced Indicator" property allows indicators that relate to features not normally used to be hidden when
selecting the indicators for a product. Also, a "Selection Criteria" property enables formulas to be specified in the
"Must be selected if" and "Must not be selected if" fields which specify when the indicator either must or must not be
selected for a product depending on the other indicators selected for that product..
PUPS is an example of an indicator. If this indicator is selected for a product then policies can become paid-up if
premiums cease as well as being able to lapse or to be surrendered. A paid up policy is a policy which continues in
force until maturity but with reduced benefits payable. If PUPS is not selected then policies are assumed only to
lapse or be surrendered if premiums cease. Only if this indicator is selected will input variables be included to
specify the PUP benefit, the valuation basis for PUPs, the rate at which policies become PUP'd etc. If PUPS is
selected, Prophet will also bring in different core formulas from those which would be brought in if PUPS was not
selected. For example, the formula for death benefit outgo would include the death benefit payable on PUP'd
policies if PUPS was selected but not if PUPS was not selected.

118

Chapter 3 Prophet concepts and terminology

Variables
The exact specifications for the calculations to be made are stored in variables. Some of the properties of each
variable, for instance its type, description and whether it is a revenue account or balance sheet type of variable,
apply for the workspace as a whole. This is to ensure consistency when reporting across products.

Each variable may contain either a single definition or several alternative definitions. These definitions are stored
separately in each library.
Depending on their syntax and position in the calculations, variables may evaluate to constants or to timedependent values. Prophet determines which automatically. All time-dependent calculations are always made
monthly. This ensures accuracy and avoids any need for you to check the appropriateness to your particular needs
of annual or quarterly approximations.
The date span of the calculations is dependent on the product specifications and the particular library being used.
For liability libraries, it is normally all months from policy issue until maturity or until all cash flows associated with
the product have expired. However, you usually only retain a subset of this date span in the results.
Indicator expressions
When you select indicators for a product this tells Prophet which variables are to be included in that product and
which appropriate definition is to be used. This is achieved as a result of every definition for every variable in each

Inside libraries and products

119

library being associated with a logical indicator expression which shows the circumstances in which Prophet will
include it in a product. Effectively, the variable definitions are indexed by the indicators.

Input and core variables


There are two main types of variables, input variables and core variables.
Input variables are used to define the specific calculations you want to make for each of your products. When you
specify a new product, Prophet presents you with a list of input variables to be defined, based on the indicators you
select. Thus:

Each input variable is presented initially with a default definition. You can either accept that definition or modify it to
reflect your particular requirements. For some variables, the associated library contains one or more alternative
definitions which you can use instead. These alternative definitions are suggestions of possible definitions which
may be appropriate in some circumstances.
The definitions you set up for input variables for a product are stored separately as part of that product.

120

Chapter 3 Prophet concepts and terminology

Core variables contain the calculations which do not vary by product. Prophet automatically includes the
appropriate core variables with their appropriate definition, based on the indicators you select for that product.

Primary and secondary input variables


There are two types of input variables, primary input variables and secondary input variables. Primary input
variables are included in a product by virtue of their indicator expressions. Secondary input variables are included
in a product if and only if the definition of another input variable in that product refers to them. They are then
automatically included.
The default definition for a secondary input variable normally has a blank indicator expression, in other words it
does not have any indicator expression associated with it. Secondary input variables allow you to extend the
calculation specifications for some products without needlessly complicating the specifications for other products.
You may well wish to extend the libraries with additional variables to handle particular calculations not covered in
the standard libraries supplied with Prophet.

Variable dependencies
You need not be concerned about dependencies between variables. The code generator determines these
dependencies for each product separately and hence the order of calculation. This aspect of Prophet makes it
extremely flexible. It is possible to enter virtually any definition for a variable provided that this does not result in a
circular reference.

Array variables
You can define variables to be array variables which have one or more dimensions. The names and lengths of
these dimensions are specified at the workspace level.

Variable definition types


Prophet has a number of definition types that you can use to define how the values for a variable are calculated.
The variable definition types are:
n

Formula definitions

Extended formulas

Inside libraries and products

t-dependent extended formulas

Constant definitions

Table definition types

Time index values

121

Formula definitions
The most commonly used definition type is the formula definition. A formula is generally a mathematical expression
applied to the values calculated for one or more other variables. The following are simple examples of the types of
formulas that can be specified.
One of the default definitions for the net premium variable (NET_PREMIUM) appears as follows:
IF ADUE_F_VAL0 > ZERO_TOL THEN
MIN((SUM_ASSD_PP(1) * ABAR_VAL0 + VAL_ZILLMER) / ADUE_F_VAL0,
ANN_PREM_PP(1) * NP_RESTRN_PC/100)
ELSE
0

For the initial expense per policy variable (INIT_EXP_PP), one of the default definitions appears as follows:
IF t = 1 THEN
IE_FIXED * NB_INFL_ADJ(t-1)
+ IE_SA_PC/100 * SUM_ASSD_PP(t)
+ IE_PREM_PC/100 * ANN_PREM_PP(t)
ELSE
0

A formula for a variable can also refer to itself, provided that the reference is to a different time period. Thus the
definition for the number of policies in force variable (NO_POLS_IF) is typically:
IF t < DUR_M OR t > POL_TERM_M OR POLS_IF_AT_S = 0 THEN
0
ELSE IF t = DUR_M THEN
POLS_IF_AT_S

122

Chapter 3 Prophet concepts and terminology

ELSE
NO_POLS_IFSM(t) - NO_DEATHS(t) - NO_SURRS(t) - NO_NEW_PUPS(t)

The language used in the formulas is specific to Prophet but follows normal programming conventions and includes
a wide range of mathematical operators and functions. In practice, many formulas are more complex than those
shown above.

Extended formulas
Extended formulas provide the ability to include small programs within Prophet formulas, including the ability to use
FORLOOPS. This enables even more complex calculations to be carried out.
Each extended formula can generate values for any number of variables which can be defined to be scalar, vector
or multi-dimensional arrays. These variables are then referenced as required by other variables in the product.
Moreover, the values are "persistent", in other words, they remain in memory and can be used by successive model
points or when products are repeatedly run in dynamic or stochastic runs. To maximise runtime performance,
extended formulas can be set up so that the values are only recalculated if any of the values of the variables read
by that extended formula change.
Example uses include:
n

The calculation of commutation factors at the start of each product

The modelling of polices with multiple benefits

The handling of complex bonus structures

t-dependent extended formulas


t-dependent extended formulas are similar to normal extended formulas except they are re-run for each month of
the projection. This effectively makes them t-dependent and allows you to make references to Prophet variables in
your extended formula.
For example, a t-dependent extended formula can be used to lookup premium allocation rates for a product whose
annual premium varies over time as the formula is re-run for each month of the projection for each model point.

Constant definitions
You can use this definition type to specify that a constant value should be used in the calculations.

Inside libraries and products

123

Table definition types


Each of the following definition types causes Prophet to read the values to be used from a particular type of table at
run time. The types of tables are described later in this chapter.
n

Global

Parameter

Model Point

Generic Table

Mortality Table

Year Dependent Mortality Table

Year Index Table

Time index values


This definition type allows you to specify constant values for particular months of the calculations.

Codes and categories


The variables are grouped in the libraries and in your products by means of variable codes. The purpose of these
codes is to link the variables associated with each part of the calculations under a title which explains what those
calculations do. This makes the calculations easier to understand. Similarly, the indicators are grouped by means of
indicator codes and the variable groups used for reporting purposes are grouped by means of variable group
codes.
The first two characters of the variable code and the first character of the indicator code and the variable group code
are letters. These characters are known as categories. Text descriptions are assigned to these categories to explain
what the categories cover. For example, in the liability libraries the letter J indicates the Expenses variable category
and the letters JA indicate the Initial Expenses variable category.

124

Chapter 3 Prophet concepts and terminology

Types of tables
This section describes the main types of tables available to be used in Prophet.
n

Model point files

Global files

Parameter files

Mortality, generic, stochastic and year index tables

Unit prices files

Sales files

Model point files


You must set up a model point file for each liability product. Each model point file contains records for the policies
for which cash flow projections are required. These records are usually known as model points. Each model point
can represent either a single policy or a number of policies.
Model point files are normally set up using Prophet's Data Conversion System (DCS). You can use it to create
model points that represent either each individual policy or a number of similar policies. DCS is described later in
this chapter. The files can then be displayed using the Prophet Viewer thus:

Types of tables

Model point files can also be set up within Prophet, for instance for testing purposes. Thus:

125

126

Chapter 3 Prophet concepts and terminology

Other packages can also be used to create model point files, as long as the files created are in the format required
by Prophet.
You normally set up a number of model points to represent your existing business and further model points to
represent the new business you may sell in the future. For accurate projections some companies choose to include
every existing policy as an in force model point.
Variables with a model point definition read their values from this file at run time. The calculations are automatically
performed for every model point and the results are summed together.
Model point files must be given the same name as their corresponding product, although alternative versions may
be set up by giving these files different extensions.
If you are using the Asset library to model your assets, you will also need to set up model point files which contain
records for the assets held and for the assets which may be purchased in the future.

Types of tables

127

Global files
A global file is a two-dimensional table with values indexed by variable name and run number. You can therefore
specify that different values are used for different run numbers. Thus:

Variables with a global definition read their values from this file at run time. You can also use the READ_GLOBAL
or the READ_GLOBAL_TEXT functions to read values directly into formulas.

128

Chapter 3 Prophet concepts and terminology

Parameter files
Each parameter file is a two-dimensional table indexed by product name and variable name. You can therefore
specify that different values are used for different products. Thus:

Variables with a parameter definition read their values from this file at run time. You can also use the READ_
PARAMETER function to read values directly into formulas.
You can include more than one parameter file in a structure, provided that these names can be specified
collectively using a wildcard. For example TABLES\PARAM*.FAC.

Types of tables

129

Unit prices files


If your product is unit linked and your policy data contains the number of units held in each unit fund at the valuation
or projection start date, you can specify a unit prices file to be used to determine the initial value of units. Thus:

Unit prices files are normally used in conjunction with Prophet's Data Conversion System as part of the conversion
of your policy data into suitable model point file formats. However, the calculation of the initial value of units can
also be made as part of the calculations for each unit linked product. This then enables the total number of units in
each unit fund to be calculated and reported separately for each product.

130

Chapter 3 Prophet concepts and terminology

Tables
In your product specifications you can define variables to read from a specified table using a number of possible
table formats. You can also use Microsoft Excel in the Table Editor so that formulas can be used to calculate values
in tables. Editing a table using Excel allows you to enter input formulas as required using Excel functions if you
wish, including those specific to Prophet.

Mortality and year dependent mortality tables


Mortality tables are used to hold mortality rates. These tables can use either the traditional select/ultimate format or
they can be year dependent mortality tables where the values are also dependent on the calendar year. This
typically applies for AIDS tables and, increasingly, for mortality rates for annuitants. Prophet is supplied with a wide
range of standard mortality tables. Details of these tables are supplied in Help.

Generic tables
Prophet can also handle tables specified in a generic table format. Using this approach, tables can be set up with
between one and ten indices to determine the value or values to be read. If any of the indices are time dependent,
the values will be read for all time periods, at either monthly or yearly intervals. Thus:

Types of tables

131

Variables with a generic table definition read their values from the specified table at run time. You can also use the
READ_GENERIC_TABLE or READ_GENERIC_TABLE_TEXT functions to read values directly into formulas.
In your product specifications, you refer to each table by its name. If you have a number of alternatives which you
want to use at different times or in different runs, you store them in separate locations and select the location to be
used at run time in the Tables tab of the Run Setting. This contrasts with global, parameter and prices files for which
you specify the names as well as the locations in the run setting.

Year index tables


Year index tables can be used to hold values that vary by calendar year. However, we recommend that generic
tables are normally used instead of year index tables.

Stochastic tables
Stochastic tables are used to hold assumptions which vary by simulation and by calendar year or month. Up to
seven other indices can be used to determine the particular values to be read in a similar manner to generic tables.
For example stochastic investment assumptions might vary by economy, type of asset, type of value and
outstanding term to redemption.

132

Chapter 3 Prophet concepts and terminology

Sales files
If you are using Prophet to run financial projections which include future new business, you normally specify in the
model point file a profile for that future new business in terms of a mix of ages, policy terms, premium sizes, etc. You
separately set up a Sales file to specify the volumes of future new business to be assumed in each month of the
projection. This file can be generated using either the Table Editor or using the Microsoft Excel based Sales
Generator which is supplied as part of Prophet.
You open the sales generator from the Prophet menu option added into Microsoft Excel when Prophet is installed.
The main worksheet appears as follows:

Values of new business for each product and sub-product may be specified monthly or annually. If specified
annually, you may use seasonality factors to distribute the annual values.

Data Conversion

133

Data Conversion
The Data Conversion System (DCS) converts external data such as company policy data into files that can be used
by Prophet, Glean or other applications. The conversion process is controlled by a program which is written using
the DCS programming language and functions. Data validation and correction facilities are also available so that
any inconsistent data is handled correctly during the conversion. The DCS program can be written to create:
n

Individual policy model point files that can be used in Prophet for individual policy calculation runs or as input
for data grouping runs.

Stochastic and generic files for use with Prophet.

Delimited text, Access and ODBC (Open Database Connectivity) format files and Glean data files.

Grouped model point files that can be used in Prophet grouped data runs.

DCS can also create test model point files without the need for any input data.
The main DCS window appears similar to the following:

134

Chapter 3 Prophet concepts and terminology

The data conversion process


A DCS program contains the specifications of all inputs, calculations and outputs through a number of settings that
are accessed from the tree displayed in the Programs pane. In addition, Program Code is used to control and
manage the conversion process.
The following settings are specified for a DCS program:
n

Run Settings
These settings are generally the first to be set up when a DCS program is created. They specify the location of
the input files or database tables to be converted and the location of any tables and/or unit prices files that are
required by the data conversion process. In addition, the run settings also specify the location of the generated
output files or database tables.

Input Format settings


The format of Input data are specified in this setting. A number of formats can be specified each of which

Data Conversion

135

specifies the type of data that is to be read. The input data can be in fixed ASCII, delimited ASCII, Excel, model
point or a database format. You have full control over which records are accessed, which particular fields within
a record are read and what format those fields are in. DCS can handle variable record formats, typically
consisting of main policy records and sub-records. The sub-records might for instance contain details of
increments to the policy or of units held in each unit linked fund.
n

Output Format settings


The format of the output data to be written to file for each record is specified in this setting. You can create a
number of output files, normally one for each product from each input file. You can also set up further files to
report on records that fail validation tests or have been corrected. The output files can be sorted into ascending
sub-product code order which is required for the Prophet calculations. The output records can also be grouped
into representative model points.

Code setting
The code used to process the data conversion is specified in this setting. In particular, the code specifies the
calculations to be performed on the data and any new fields to be created. DCS provides a complete
programming language focused on these particular needs, including a comprehensive range of functions. For
instance, the CALC_UNIT_VALUES function generates the unit value for each policy using the number of units
held in each fund and unit prices read from a file. The SUMMARISE function produces summary output files in a
format that you specify. You can also create your own procedures and functions.

Debugger
The Debugger, accessed from the Code setting, allows you to debug your DCS programs interactively. You can
set breakpoints in the DCS code, view the type and value of variables as well as any messages sent to a run log
file.

Grouping setting
The Grouping setting specifies how values should be calculated when grouped output is produced, in particular,
whether the values are summed or averaged. You can also specify that each model point must represent at
least a certain minimum number of individual policies.

Once the settings are specified you run the DCS program. During the run, the DCS program is converted into C
code, compiled into an executable program which is then run to process the input data and create the specified

136

Chapter 3 Prophet concepts and terminology

output files or data. The generated results files are listed in the Results folder of the DCS Programs pane and can
be viewed using the Prophet Viewer application.
AComparison pane is also available that allows differences between two DCS programs to be compared.

Data analysis
Both the input and output files produced by DCS can be viewed on the screen. When viewing DCS input files the
record formats set up in DCS are automatically read and used to separate and display each record into its
component fields.
An analysis facility is supplied that enables the data in the files to be investigated as follows:
n

The minimum, maximum, average, sum and number of blank or zero entries for each variable in the file can be
calculated, with the option of analysing this information within the values of one or more of the variables in the
file. For example, the analysis could be carried out for each status within each plan code.

The values that exist for each variable can be listed, with information about the frequency with which each value
appears. For example, the number of records that exist for each policy term can be listed. The results can be
sorted based on either the values or the frequency with which they exist.

The average or sum of the values for particular variables can be calculated for each value of other variables. For
example, the average premium and the total of the sum assured can be calculated for each plan type.

137

Part 2 - Product design

This section describes the processes involved in creating, updating and managing products in a Prophet
workspace. The processes are described in the following sections:
n

Setting up products

Setting up tables

Running products

Displaying the results

Using Diagram view

138

139

C H A P T E R

Setting up products

TOPICS IN THIS CHAPTER


What are products?

140

Product design process

141

Creating a product

142

Variable definition options

169

Managing products

194

Printing product details

202

Auto-scan and Regeneration options

203

Comparing products

205

Product Schedule

217

140

Chapter 4 Setting up products

What are products?


Each product is a single set of calculation specifications. In Prophet, the term "product" is used for these sets of
calculation specifications because many products define the financial behaviour of your insurance products.
Each product is associated with the library from which it is defined. For example, a conventional product is a
product that is defined using the Conventional library. Similarly, a summary product is a product that is set up using
the Summary library.
Each product consists of a number of input variables and a number of core variables which together define the
calculations to be performed. When you specify a product you also select a number of indicators for it. These
indicators define the scope of the calculations required and determine the variables that are included.
n

Input variables are used to define calculations that can vary from product to product, or from company to
company. When you create a new product, default definitions for each input variable are presented on the
screen, based on the rules specified in the associated library. You can then accept these definitions or modify
them to enable you to specify the exact calculations you require for each product.

Core variables are used to define calculations that are generally generic in nature, for instance commutation
functions and basic accounting relationships. The appropriate core variables are included automatically for
each product, based on the rules specified in the associated library.

You can consider products in Prophet as computer programs. The only difference is that Prophet takes care of
much of the programming and you need only specify the actuarial calculations required.
You set up products in Prophet to reflect both your insurance products and your business requirements. For
example, you can set up a number of conventional, unit linked and summary products in order to calculate
embedded values.

Product design process

Product design process


To create and maintain a product, you need to specify a number of inputs and outputs. In particular, designing a
product involves:
n

Specifying a product and the library on which it is based.

Setting up the files and tables needed to run the product

Creating a structure and run setting to run the product

Running the product

Using Diagram view to check and debug the calculations

Displaying (and optionally, printing) the results

Reviewing the run log and any error log produced during a run

When a product is specified and saved it is added to the other products in the workspace and displayed in the
Products and Accumulations pane.

141

142

Chapter 4 Setting up products

Creating a product
To create a new product select Products and Accumulations from the object browser and in the Edit section of the
Home tab select New Product:

You then do the following:


n

Specify the product properties by completing the Product Properties dialog

Select the indicators you require for the product (using the Indicator Selection Wizard if necessary).

Specify the definition to be used for each of the input variables

Save the product

Each of these items is described in the following sections.

Creating a product

143

Product properties dialog


The Product Properties dialog box is displayed when you create a new product. It appears similar to the following:

The Product Properties dialog for an existing product is also displayed when you select the product in either the
Products & Accumulations pane or Product List View and click Properties from the Home tab. You can also display
the properties dialog by selecting the product in either the Products & Accumulations pane or Product List View and
choosing the Properties option from the right click menu.

General tab items


The following items are available from the General tab of the Product Properties dialog:
Item

Description

Name

The product name can have between 2 and 22 alphanumeric characters (A-Z, 0-9 and _)
but cannot start with a number. You cannot change the name of a product once it has been
created.
For infornation on using long product names see: Long Product Names.

Description

Enter a description that helps you identify the product.

Library

The name of the library to be used by the product.

144

Chapter 4 Setting up products

Item

Description

Same As

If the product is to use the same calculation rules as another product then select Same As
and choose the name of the other product from the dropdown list. If you do this for an
existing product Prophet discards all the existing input variable definitions for the product.

Level Number

The level number should be left with its default value of 10 unless you are constructing a
model office which requires products to be processed in a particular order.

Use in memory
dynamic/stochastic
calculations

Select this option to run any dynamic calculations specified in the product using the PC
memory instead of writing temporary files to disk. By setting this option you can significantly
reduce run times when dynamic calculations are performed.
You can check to see if this item is selected using the IMD_PRODUCT function in a
dynamic run and the IMS_PRODUCT function in a stochastic run.

Apply strong
t-limiting

Select this option to optimise the calculated time periods in dynamic runs. The system will
then aim to limit the calculations to the current dynamic period unless other time periods are
needed for other variables in the product.
You can check to see if this item is selected using the STRONG_T_LIMIT function.
Note: You must ensure that other products in the structure do not rely on the results
produced for the whole future accumulation time period. You can check the time periods
that are being calculated by looking in the product diagnostics file.

Allow Parallel
Model Point
Processing

Select this option to enable the product to be multi-threaded across a machine when it is
run in Prophet. This setting is used in conjunction with the Advanced Structure setting to
determine how the product is compiled.
A Prophet Professional license with the Prophet Enterprise feature is required to enable this
feature.
See Enterprise optimisations settings in the General tab of the Advanced Settings dialog of
a Structure.

Note the following:

Creating a product

145

If one or two variables need to use different calculation rules this can still be done using a Same As product.
You can do this by creating an additional parameter variable which varies by product. Use this variable in the
formula to determine which calculation rule is required.

Memory or t-limiting options can be changed later. You might need to do this if your run log indicates memory
problems, for example.

146

Chapter 4 Setting up products

Statistics tab items


The items in the Statistics tab provide general information that is generated by the system for the product. The tab
typically appears as:

None of the items in this tab can be edited. They are:


n

The date and time when the product was created

The date and time when the product was last modified

The user name of the person that last modified the product

The compile status

The number of variables used by the product

If you have Administrator permissions for a workspace then you can clear the "Modified" and "Modified By" fields
displayed here (or in the list of products displayed in the page list view of the user interface). You would normally
want to clear these fields if you have completed development of the product so that you can identify any changes
made in the future. For details on how to clear these fields refer to "Clearing Modified and Modified By".
To apply any settings click OK. To abandon any changes click Cancel.

Creating a product

Selecting indicators for a product


When you click OK on the Product Properties dialog for a new product (except Same As products), the Select
Indicators for Product dialog appears similar to the following:

Note: To display this dialog for an existing product you open the product in the Products and Accumulations
pane and in the Product section of the Object tab click Show Indicators:

147

148

Chapter 4 Setting up products

Note: Indicators are listed according to the current selection in the List View section of the Home tab: by name,
description and indicator code if Details is selected, or with only the names of the indicators if the List option is
selected.

Creating a product

149

From this dialog you can:


n

Select indicators you wish to use in your product

Display any indicator expression associated with a selected indicator

Read the actuarial documentation associated with a selected indicator.

Select options that control the display of advanced indicators or those indicators that cannot be selected.

Alternatively, you can use the Indicator wizard to choose the indicators that are relevant to the current product.

Selecting Indicators
You select the indicators you require for the product using this dialog. By default, Prophet pre-selects a number of
indicators when a new product is created.
You should add or remove indicators to define the scope of the calculations you require to be performed by the
product. The indicators are used by Prophet to determine which input variables and core variables are included,
based on the rules specified in the associated library.
The indicators selected for the product are listed in the right hand pane. The available indicators are listed in the
centre pane. You can use the indicator outline to the left of the dialog to filter the indicators that belong to a
particular indicator category. The list of indicators in the centre and right panes can also be sorted by clicking on the
heading of any column.
In addition you can select or deselect:
n

Hide Un-Selectable to display or hide those indicators that cannot be selected.

Hide Advanced to display or hide those indicators that have features which are not normally used when
selecting indicators for a product.

Show Selection Criteria to display or hide the Indicator Selection Criteria pane containing an indicator
selection criteria or expression for a selected indicator. Indicators that have selection criteria are prefixed with fx
(indicating a function) rather than I (a standard indicator).

For information on how to specify these settings for individual indicators see Indicator details.

150

Chapter 4 Setting up products

Note: Each indicator is assigned an indicator code. This places it in an indicator category and also gives it a
logical order within that category.

Actuarial documentation
If actuarial documentation is available for an indicator or indicator category then it is displayed in the lower part of
the dialog. Use this documentation to determine which indicators are appropriate for the product you are specifying.
You can also refer to the manual supplied with the library.

Indicator selection wizard


You can select and manage the indicators for a product by either:
n

Clicking Wizard and using the Indicator Wizard

Selecting indicators from the centre pane and moving them to the right-hand pane using the appropriate buttons
between the panes
Note: You can also select indicators and then drag them from one list to the other.

When you click OK Prophet scans the variable definitions in the library to determine which input variables qualify
for the product. This is based on the indicators which have been selected. Only the input variables are scanned at
this stage because, by definition, it is only the input variables which can be modified separately for each product.
If any variables have more than one qualifying definition an error message will be displayed and you will then be
returned to the Select Indicators for Product dialog. This will only happen if variables have been incorrectly coded in
the library or if you have chosen an invalid set of indicators.
If there are no such problems the Product Variables window will be displayed and you can then edit the input
variables used by the product.
Note: If you change the selected indicators for an existing product, Prophet scans the variable definitions in the
library twice, once using the old set of indicators and once using the new set. If it finds that the default definition
for any of the input variables has changed as a result of the change in indicators, it ignores the existing
definition and includes the new default definition in the product, with a status of "New Default".

Creating a product

151

Indicator Selection Wizard


You can use the Indicator Wizard to help you enter and update the indicators used in a product.
To display the Indicator Selection Wizard:
n

In the Object Browser select Products and Accumulations.

In the tree pane expand the Products folder and open the product by double clicking its name. Alternatively,
right-click the product and on the menu click Open.

From the Product section of the Object tab click Show Indicators.

From the Select Indicators for Product dialog click Wizard. The Indicator Selection Wizard appears similar to
the following:

The Indicator Wizard has the following panes:

152

Chapter 4 Setting up products

The top left pane displays actuarial documentation for the indicator category to which the indicators displayed in
the middle panel belong. A selection criteria pane is also displayed alongside the list of indicators.

The bottom left pane displays the actuarial documentation for an indicator selected in the middle pane.

The right pane displays the actuarial documentation for the library and the product.

In addition you can select or deselect:


n

Hide Un-Selectable to display or hide those indicators that cannot be selected.

Hide Advanced to display or hide those indicators that have features that are not normally used when selecting
indicators for a product.

The list of indicators in the middle pane changes as you step through the indicator categories by clicking Next or
Previous. The name of the current indicator category is always shown in the title bar of the dialog.
To change whether an indicator is included in a product, click on the tick box for that indicator in the middle pane.
When you click Finish, any changes that you have made are applied to the product and displayed in the right pane
of the Select Indicators for Product dialog.

Creating a product

153

Managing the input variables for a product


The Product Variables window is displayed automatically for a new product after you have selected the indicators
for the product. For an existing product, it is displayed when you open the product. The variables are displayed
similar to the following:

You can change how the variables are displayed from the List View section of the Home tab. The following
choices are available:
n

Details View
This view lists the variables including their properties (such as name, description, variable code, variable type,
definition type and variable status). You can sort the displayed list of variables by any of these properties by
clicking on the relevant column heading. You can also filter variables according to their category by clicking on

154

Chapter 4 Setting up products

the arrow on the Code column heading.


n

List View. This view displays the names of the variables only.

Diagram View
This view displays the dependencies of the variables in the selected product.

In the Details and List views the definition of the currently highlighted variable is displayed in the bottom pane.
Listing core variables
Only the input variables are listed when the window is first opened. If you want to include the core variables in the
list select the Core Variables option in the Product section of the Object tab. You can then view the definitions for
the core variables and their core definition number. Using this option makes it easier to identify which core
definition from a library is used by a particular variable in the product. Note that core variables can only be edited in
the library.
Note: Each variable in Prophet is assigned to a variable code as one of its properties. This variable code
groups variables that have related functionality and places them in a logical actuarial order, through the use of
variable categories.
From the displayed list of variables you can:
n

Select and open an input variable and edit its definition

Select one or more input variables and delete them

Inspect and edit the properties of the product and change the indicators selected for the product

Re-scan the variables in the library

Find or replace occurrences of a specified text string in the definitions for the variables in the product. See Find
and replace for a Product or Library on page80.

You can access the library and can create new tables to be used by the product from the Products and
Accumulations pane and display the dependencies of variables in a product and edit their definitions using
Diagram view.

Creating a product

155

You can also open an existing Structure or Run Setting by selecting the appropriate list at the bottom of the Product
variables window and clicking Open. Similarly, to create a new Structure or Run Setting you click New alongside
the appropriate Structure or Run Setting list.
Note: When you modify an input variable in a product, you only change its definition in that product. If you want
a changed definition to apply across all of your products you should first change the variable in the associated
library. See Libraries on page561 then see Auto-scan and Regeneration options on page203 for details on
how to apply the changed variable definitions to your products.

156

Chapter 4 Setting up products

Managing input variables using Diagram view


You can also manage the input variables for a product using Diagram view. This displays the dependencies of the
variables in a product diagrammatically. As you edit the definitions the dependencies are updated. If the selected
product has previously been run then you can also choose to display its results using the drop down list boxes at
the top of the window.
To display the dependencies for a variable in a product:
n

Select and open the product

Select the variable and choose the Diagram option in the List View section of the Home tab. The Diagram view
window then appears:

Creating a product

157

When you change between views, Prophet remembers which variable is selected.

Diagram View Panes


Details of the variables used in the product are displayed in Diagram view in a number of panes.
n

Top panes
Display the variable dependencies for the selected variable. By default, input variables are shown in red and
core variables in black. Only input variables can be edited from within this view. To edit the selected input
variable choose the Open option from the right click menu.

Middle pane
Placing the mouse pointer over a variable in any of the top three panes displays the definition for that variable in
the middle pane.

Bottom panes
If a set of results has been selected, this displays the results calculated the last time the product was run.

Diagram tab
An additional ribbon tab is displayed for Diagram view and appears similar to the following:

From the Diagram tab you can:


n

Change the current variable, run number, sub-product or results type

Adjust the time period values

Move backwards or forwards through the variables you have already selected

You can also change the number format and the font using the appropriate options in the Format menu.

158

Chapter 4 Setting up products

Opening tables
To open a table used in the definition of a variable, right-click the variable and select the Open Table option from
the menu. Note that Prophet uses the structure specified in the drop down list box in the bottom left of the window to
determine the location for the table.

Running a product
You can run a product from this window by clicking Run in the Home tab. You will be prompted to save any
changes you have made to the product. The product is then run and at the end of the run the revised results are
displayed.
The structure and run setting selected in the drop down list boxes at the bottom of the window are used to provide
the parameters for the run.
Note: You can also use Diagram view to display variable dependencies and results in the Results & Runlogs
pane. If you open Diagram view in this way the definitions cannot be edited.

Variable types
For each variable listed in the Product Variables window Prophet allocates a variable type setting. This setting can
be one of the following:
Variable Type

Description

Primary Input

An input variable brought into a product because it qualifies based on its


indicator expression.

Secondary Input

An input variable brought into a product because it is referred to by another


input variable. Normally the indicator expression associated with the
definition for this type of variable will be blank.

Core

A core variable brought into a product because it qualifies based on its


indicator expression.

Primary Default

An input variable brought into a product as a result of the DEFAULT


indicators.

Creating a product

Variable Type

Description

Secondary Default

An input variable brought into a product because it is referred to by a


Primary Default variable.

159

Note: You may need to pull the dividers between the column headings to change the column widths before you
can see these settings.

Variable status
For each variable listed in the Product Variables window, Prophet allocates a variable status setting. This setting
can be one of the following:
Variable Status

Description

Not Defined

This is the initial status for all the variables for a new product and for any
additional variables brought into an existing product as a result of scanning.

New Default

If you change the selected indicators for a product Prophet checks if a different
default definition qualifies for any variable with the new set of indicators as
compared to the old set. If this is the case, the default definition for the new set of
indicators is displayed, with the status set to "New Default".

blank

When a definition with a status of "Not Defined" or "New Default" is successfully


defined its status is changed to a blank.

Note: You may need to pull the dividers between the column headings to change the column widths before you
can see these settings.

160

Chapter 4 Setting up products

Specifying the input variables for a product


You can change the definition of any input variable for a product from the Product Variables window or from
Diagram view.
If you are specifying a new product, we recommend that you sort the variables into ascending variable code order
in the Prophet Variables window (by clicking on the Code column heading) and then work through the variables in
order. The default definitions specified in the associated library are intended to show you what might be appropriate
but you should consider each variable definition in turn to ensure that it meets your requirements.
Editing a variable
To edit a variable,select it in the Product Variables window and select Open from either the Home tab or the rightclick menu. This will display the details of the selected variable in a Variable Definition window:

Creating a product

161

The indicator expression that caused the variable to be brought into the product is displayed at the bottom of the
window. If the variable is a secondary input variable this will be blank.
To display the definition for the previous or next variable click Previous or Next from the Design tab. When you do
this, Prophet validates the current definition and saves it. The previous or next variable definition is then displayed.
To validate and save the definition click OK from the Design tab.
To cancel any changes you have made to the definition click Cancel. from the Design tab.

Selecting an alternative definition


To use an alternative definition that has been set up in the library for the current variable:
n

Open the product

In the Product Variables window, select and open the variable

From the Design tab click Select Definition to display the Select Definition from Library dialog:

All of the definitions for the selected variable in the library are listed alongside their indicator
expression/description, number, type and class.
Prophet allows you to select any of these definitions to be used in the product in place of the existing definition.
However, you should take care to ensure that it is appropriate for use in your product. Note the following:

162

Chapter 4 Setting up products

The Class indicates whether each definition is a default or an alternative definition. Alternative definitions,
where they exist, typically contain possible alternative formulas which have been set up to help you with your
specification of the variable.

Alternative definitions can be identified in this window by their descriptions. In contrast, default definitions are
identified by their indicator expressions.

You can also use this option to reset the definition of the variable to its original default.

You should not normally select a definition appropriate for a different set of indicators from those selected for
your product.

Changing the definition type


To change the definition type for a variable:
n

Open the product

In the Product Variables window select and open the variable

From the Design tab click Change Definition Type to display the Definition Type dialog box:

Definition types
Each variable in the product has a definition type. The following definition types are allowed:

Creating a product

163

Definition type

Description

Formula

A formula expressed in Prophet's programming language.

Constant

A constant value.

Global

The value is read from the global file at run time.

Parameter

The value is read from a parameter file at run time.

Model point

The value for each model point is read from the model point file at run time.

Generic table

The value or values are read from a specified generic table at run time.

Mortality table

The values are read from a specified mortality table at run time.

Year Dependent Mortality table

The values are read from a specified year dependent mortality table at run
time.

Year Index table

The values are read from a specified year index table at run time.

Time Index Values

Constant values for specified months of the calculations.

Extended Formula

A formula expressed using the extended formula syntax. For examples of how
to use an extended formulas see Extended Formula examples.

t-Dependent Extended Formula

A formula that uses the extended formula syntax to support the timedependent variable t. For an example of how to use a t-Dependent Extended
Formula see t-Dependent Extended Formula example.

Entering definitions for input variables of a product


The"Variable definition options" section of this chapter gives details of each definition type and the options
available within it to help you specify each definition.

Deleting an input variable in a product


You can Delete an input variable from a product in the Product Variables window. However, if it qualifies for the
product based on its indicator expression, it will be brought back into the product with its default definition before it
is saved or if the product is re-scanned.
Note: The variable is only deleted from the product and not from the library.

164

Chapter 4 Setting up products

This option has been included to allow you to remove secondary input variables which are no longer required in
the product (this can also be achieved by re-scanning).

Creating a product

165

Re-scanning the input variables for a product


Prophet can scan the input variables in the library to determine whether there are any missing variables in a
product. To initiate the scan, open the product and from the Object tab choose the Re-Scan option.
Reasons to perform a re-scan are that you:
n

Have created additional input variables in the library which need to be incorporated in the product

Have amended the indicator expressions for default definitions for input variables in the library, meaning that
input variables need to be either added or removed from the product

Have elected initially not to re-scan when prompted to do so when you opened the product.

Want to remove any secondary input variables that are no longer required in the product.
Note: Any new variables which are brought into the product as a result of the scanning are initially given a
status of "Not Defined".

Specifying array dimensions for a product


The size of a dimension for an array variable specified globally at the workspace level can be redefined for a
product from the Product Dimension dialog.
To display the dialog:
n

From the Products & Accumulations pane, select the product whose array dimensions you wish to redefine

Right click the product and from the context menu choose the Product Dimensions for option.
Alternatively, select the product and from the Object tab click Product Dimensions.

166

Chapter 4 Setting up products

The Product Dimension settings dialog is displayed similar to the following:

The dialog lists the dimensions defined for the selected product by:
n

Dimension description

Default size as specified globally

The redefined dimension size the product

A description of the dimension as specified globally.

Editing array variable dimensions


You can add, edit and remove dimensions from the list. You can also inspect the descriptions for other dimensions
n

To edit ot redefine a dimension for a product


Click Add or Edit and make the changes from the Add / Edit Dimension dialog.

To display the descriptions of dimensions


Click Description to display the descriptions of the dimensions in the Dimensions Description dialog.

Note the following:

Creating a product

167

You can override the redefined dimension settings for all products by selecting the Disable non global
dimensions setting in the Advanced tab of a Run Structure.

The dimensions of array variables are displayed in the Dimensions and Product Dimensions tabs of a Product
Schedule. Both tabs display the same information with the difference being that the Product Dimensions tab of
the Product Schedule displays the values of the dimensions modified using this dialog.

Dimensions are specified and managed from the Dimensions folder of the Workspace Objects pane.

For products defined as Same As this dialog is read-only.

168

Chapter 4 Setting up products

Saving a product
When you have completed the specification of the input variables for a product you save it by clicking Save in the
Home tab.
Prophet checks that all of the variables have been defined and prompts you if this is not the case. You can choose
to use the default definitions for these undefined variables automatically. The Save Product dialog is then
displayed.

You should check the option to Delete any Existing Results Files if you are concerned that any existing results
might be incorrectly used before the product has been regenerated and re-run.

Variable definition options

169

Variable definition options


When you open a variable definition within a product you can view and edit it. This section describes the options
available for each of the following definition types that can be used:
n

Formula definition

Constant definition

Model Point definition

Global definition

Parameter definition

Generic table definition

Mortality table definition

Year dependent Mortality table definition

Year Index table definition

Time Index Values definition

Extended formulas

t-dependent extended formulas


Note: Note that these options are identical to those available for editing variable definitions within a library.

170

Chapter 4 Setting up products

Formula definition
Formula definitions are expressed using either the Prophet programming language or extended formulas. They are
created and edited using a formula editor that also provides specific support for coding long extended formulas.
The types of formula definition that can be edited in the formula editor are:
n

Formula definition - this uses the Prophet programming language.

Extended formula definition - this uses the enhanced formula additions to the Prophet programming language.

t-Dependent Extended Formula definition - this uses the enhanced formula additions to the standard extended
formulas that allow calculations using the time dependent variable t.

For information on the formula editor see the Formula Editor section later in this chapter.
Prophet programming language
The language used in a formula definition is specific to Prophet but follows normal programming conventions and
includes a wide range of mathematical operators and functions. It can only be used to calculate the values for the
variable that has been given that formula definition. See "What is the Prophet programming language". To create
and use the format the variable definition type is set to Formula in the Definition Type dialog.
Extended formulas
Extended formulas are only used in an extended formula definition. They are an enhancement to the Prophet
programming language that allow complex calculations to be carried out and can retain values that have been
calculated from one model point to the next or from one dynamic or stochastic loop to the next. To use the
capabilities of extended formulas you need to change the formula definition to an Extended Formula type in the
Definition Type dialog. Extended formulas are described in "Extended formulas".
t-dependent extended formulas
t-dependent extended formulas are only used in a t-dependent extended formula definition. They are an
enhancement to the standard extended formula expressions that allow calculations using the time dependent
variable t to be carried out.
To use the capabilities of t-dependent extended formulas you need to change the formula definition to a tdependent extended formula type in the Definition Type dialog.

Variable definition options

171

Formula editor
Formula definitions written in either the standard Prophet programming language or extended formulas are created
and edited using the Prophet formula editor. In particular, the editor provides specific support for coding long
extended formulas. A typical Prophet extended formula definition appears in the editor as follows:

For typical editing operations see Editing operations in a formula in Help.


In addition, the following features are available in the formula editor:
n

Add Prophet functions - in any of the following ways:


l

Use the Function Wizard (shortcut - Shift F3) to select and enter the function.
Entering the first few letters of the function and using auto complete to enter the function name and any
required parameters.

172

Chapter 4 Setting up products

Insert variables or dimensions using the Insert Variable facility (shortcut F3) or choosing Insert variables /
dimension from the right click context menu.

Add outline statement structures such as IF THEN ELSE using the Insert Statement facility (shortcut Ctrl+J ) or
choosing Insert Statement from the right click context menu. Alternatively, click Insert Statement from the
Design tab.

Insert local variables that are declared in the current formula by selecting them from the Insert Local Variables
dialog (shortcut Ctrl+L).

Display and maintain Formula Block Documentation in the Formula Block Documentation pane for marked
and named extended formula blocks. The pane is displayed when clicking Show Documentation from the
Design tab. For more information see Formula Block Documentation in Help.

Search or replace text in the code (shortcut Ctrl+H) or from the right click context menu choosing Find &
Replace. The text to search for or replace is entered at the head of the formula editor pane.

Expand or collapse code at loop, comment and other blocks by clicking

to fold code or clicking

to

unfold it. See Fold and unfold code, Folding on statements and Folding on comments in Help.
Additional features
When you right-click in the code area of the editor you can choose the following additional features from the context
menu:
n

Save To File - The current code is copied and saved to a text file whose name and location you supply.

Variable definition options

173

Send Using Outlook - Opens Microsoft Outlook, creates a new message, and pastes the code into the message
area with the name of the formula as the subject.

Comment Selected and Uncomment Selected - Comments or uncomments code that you select in the code
editor.

Configuring the code editor


You can change the way a formula definition appears in the editor by clicking Editor Options in the Formula
Editing section of the Design tab and setting the options in the Editor Options dialog.
The syntax of the formulas and statements used in the definition is checked whenever you click OK, Previous or
Next in the Variable section of the Design tab. Any variable names in the formula that do not exist in the library are
identified.
Note that to ensure that code is folded by default when you open a formula select Formula is folded by default in the
Formula Options setting of the Options dialog. The dialog is accessed from the Prophet menu which is displayed
when you click the Prophet button.

174

Chapter 4 Setting up products

For more information on how to use the Formula editor see: Using the formula editor in Help.

Formula references to variable names


If you include a reference to an input variable which is not included in the product then it is added to the product as
a secondary input variable and given a status of Not Defined.
If you include a reference to a core variable, you should check that it will be included in the product when it is
generated. To do this you should check that one of its definitions in the associated library has an indicator
expression which corresponds to the indicators selected for the product.
Prophet allows you to specify formulas in which the variable refers to itself, provided that the reference is to a
different time period.

Function Wizard
You can use the Function Wizard to help you enter functions into the formula. To do this, first place the cursor in the
formula where the new function is to be inserted.
To display the Function Wizard
Do ONE of the following:
n

Choose Function...from the Insert menu button in the Design tab .

Press Shift+F3,

From the right click context menu choose Insert and from the sub menu choose Function.....

The Function Wizard appears similar to the following

Variable definition options

175

Select the function category and a function name, then click Next. The Function Wizard then prompts you to enter
any required arguments. For assistance and information about the selected function click Help. Finally, click Finish
to enter the new function and its arguments into the formula. If you click Finish without entering any arguments then
you can then enter them directly into the formula.
Note: Alternatively, if you have Auto Complete enabled in the Options dialog then you need only enter the first
few letters of the function you wish to enter and use auto complete to enter the function name and any requisite
parameters.

Insert Variable/Dimension
You can use the Insert Variable/Dimension facility to enter the following into a formula:
n

Variable name

Array variable dimensions

Enumerations

To enter a variable, an array variable dimension or an enumeration:

176

Chapter 4 Setting up products

Open the formula into which the item is to be inserted and place the cursor in the formula where it is to be
inserted.

Press F3 or select Insert Variable/Dimension from the Design tab.

A list of the variables, array variable dimensions and enumerations in the library or workspace is displayed
similar to the following:

To list all the variables, array variable dimensions and enumerations in the workspace choose Workspace. To list
all the items in a library choose Library.
If you know the name of the variable, array variable dimension or enumeration then you can locate it by entering the
first few characters of its name. Select the item you require and then click OK to enter it into the formula.

Inserting statements
Instead of manually entering a statement such as a FOR NEXT loop in your formula definition you can use the Insert
Statement facility to place an outline statement at the appropriate place in your code.

Variable definition options

177

To insert a statement you place the cursor in the formula where you wish to place it and then click Insert Statement
in the Design tab or press Ctrl+J. A list of statements is displayed alongside the cursor. The statement list for an
extended formula definition appears similar to the following:

Select the statement from the displayed list and either double click the selected statement or press Enter. The
selected statement is then placed in the formula as an outline. Complete the statement by completing the entries
required by the statement.
Note: The number of programming statements that are listed depends on whether a Prophet formula definition
or an extended formula definition is being edited. In general, there are more statements available when you edit
an extended formula definition.

Insert Local Variable


You can use the Insert Local Variable facility to enter a local declared variable into a formula.
To enter a local variable:
n

Open the formula in which the local variable is declared and and place the cursor in the formula where it is to be
inserted.

In the Design tab choose InsertLocal Variable option from the Insert menu button. The Insert Local Variable
dialog box is displayed. It appears similar to the following:

178

Chapter 4 Setting up products

A list of the locally declared variables is displayed by name, declaration and type. In addition, any information
associated with a variable selected in the list is displayed in a pane at the end of the variable list.
Note that the information displayed in this dialog box is extracted from local variables declared in the code with any
associated comment for a variable used as itsdescription.

Creating new variables


If a variable name that is used in a formula does not exist in the library then Prophet displays a Missing Variable
message when you attempt to save the definition:

Variable definition options

179

You can then do one of the following:


n

Click Edit definition to return to the definition to correct the variable name.

Click Create variable to create the variable in the library. The Variable Properties dialog will appear so that
you can enter basic details for the variable:

If you make the new variable an input variable, it is automatically included in your product as a secondary input
variable. Prophet gives it a default constant definition of 0. You can immediately modify this definition to meet
your needs.

If you make the new variable a core variable you should edit it within the library both to give it the definition or
definitions you require and to add indicator expressions for those definitions to define when they should be
used. You should generally do the same for an input variable created in this way.

Click Proceed anyway to continue with the missing variable remaining in the definition.

If you choose the Proceed anyway option and subsequently try to run the product without either creating the
missing variable or removing the reference to it, Prophet will report an error. You can then make the appropriate
correction.
The Proceed anyway option has been included primarily to help with the development of variable definitions and
indicator expressions within a library and should be used with caution within a product. For a library, you can at a
later stage choose the Validate option from the Object tab to check for missing variable names or indicators. Within
a library, this dialog also gives you the option to Suppress future warnings of missing variable names. Prophet
will reset this setting when you close the library.

180

Chapter 4 Setting up products

Constant definition
Use the constant definition whenever a fixed value needs to be assigned to a variable. For text variables, input the
value of the variable without quotation marks.

Model Point definition


If a variable is given a model point definition Prophet picks up the necessary values for the variable at run time from
the model point file associated with the product.
For more information, see "Model point files".

Global definition
If a variable is given a global definition Prophet will pick up the necessary value for the variable at run time from the
global file specified in the structure.
An alternative to using the global definition to read values from the global file is the READ_GLOBAL function. For
example:
READ_GLOBAL("VAR_NAME")

With this approach, which requires a formula definition, you can embed the value read from the global file directly
into a formula.
For more information, see "Global files" .

Parameter definition
If a variable is given a parameter definition Prophet picks up the necessary value for the variable at run time from
one of the parameter files specified in the structure.
An alternative to using the parameter definition to read values from a parameter file is the READ_PARAMETER
function. For example:
READ_PARAMETER("VAR_NAME")

Variable definition options

With this approach, which requires a formula definition, you can embed the value read from the parameter file
directly into a formula.
For more information, see "Parameter files" .

181

182

Chapter 4 Setting up products

Generic Table definition


The Generic Table Definition window appears similar to the following:

You need to specify the following:

Table Name
This is the filename of the table containing the required values. Either
n

Enter a table name directly (without any extension) or click Browse to locate the table, or

Select the "Variable containing Table Name" option and type in the name of the text variable which is to be used
to specify the table name.

Once you have entered the table name you can if you want to click Open to edit the table directly. You are prompted
to select the table location to be used and can create a new table if the table does not already exist in that location.

Variable definition options

183

Time Allocation
Choose Annually if the same value is required for every month within each year. Prophet will only access the table
at t=1, 13, 25, etc. For t=2 to t=12 the value at t=1 will be used, etc. A value of zero will be entered at t=0.
If you choose Monthly, the table is accessed for every value of t.
If the variable is not time-dependent it does not matter what you specify for the Time Allocation. In this case, the
table is accessed only once.
The default setting is Monthly.

Treat Missing Value as Error


Select this option if you want Prophet to treat a missing value as being an error. If it is not selected Prophet will use
a value of zero if it cannot find the required value in the table. This setting is selected by default.

Index Variables
Choose the variables to be used as indexes from the drop down list boxes or by clicking the associated Insert
Variable icon. The index variables should be entered so that they provide the appropriate index into the values in
the table. Prophet accesses the table based on the combination of values given to or calculated for these variables
in order to find the required value.
Prophet will work out for itself whether the generic table variable is time-dependent or not depending on whether
any of the index variables are time-dependent or not.
Any of the variables in the product can be used as index variables. If you enter the name of an input variable not
already included in the product, it is added to the product as a secondary input variable. There are also a number of
special index variables that you can use (see the section "Special index variables in a generic table" in the "Setting
up tables" chapter of this manual).

The Read_Generic_Table function


An alternative to using the generic table definition for reading values from a generic table is the READ_GENERIC_
TABLE function. With this function, which requires a formula definition, it is possible to read the table from within a
formula. For example:
READ_GENERIC_TABLE("PREM_RTE", "Y", "PROD_NAME",
AGE_AT_ENTRY, POL_TERM_Y, SEX, SMOKER_STAT)

184

Chapter 4 Setting up products

Note the following:


n

If you enter the name of the table in quotes, Prophet uses that name for the table. However, if you do not enter
quotes, Prophet uses the value calculated by a text variable with that name as the table name.

If you enter a variable name in quotes as an index variable, Prophet uses the name of the variable as the index
value. However, if you leave the quotes out, Prophet uses the value calculated for the variable.

For more information, see "Generic tables" .

Variable definition options

185

Mortality Table definition


The Mortality Table Definition window appears similar to the following:.

You need to specify the following:

Table Name
This is the filename of the table containing the required values. Either
n

Enter a table name directly (without any extension) or click Browse to locate the table, or

Select the "Variable containing Table Name" option and type in the name of the text variable which is to be used
to specify the table name.

Once you have entered the table name you can click Open to edit the table directly. You are then prompted to select
the table location to be used and create a new table if the table does not already exist in that location.

186

Chapter 4 Setting up products

Note: The standard mortality tables supplied with Prophet cannot be opened in this way because they are
stored in the MORT sub-folder of the Prophet System location. To open any of these tables, open the Table
Editor window by opening any table and choose Open Table in the File menu to locate the table you require.

Age at Entry Variable


The Age at Entry variable specifies the initial age to be used when reading the table. It should normally be set to
AGE_AT_ENTRY for the first life and AGE2_ATENTRY for the second life. You can select the appropriate variable
from the drop down list box or by clicking the associated Insert Variable icon.
This variable can be given a non-integral value in which case Prophet will interpolate linearly between the values
for integral ages held in the mortality table.
This variable must not have time-dependent values. It is used solely for determining the first mortality rate which is
read, with the reading of the subsequent rates automatically taking into account the fact that the age is increasing
over time.

Age Rating
The age rating may be either a positive or negative integer.

Select / Ultimate
Choose either Select or Ultimate rates as required.
Note: The Mortality Table definition type can be used for any type of table where the values vary by current age,
for example premium rates.
The mortality rate appropriate to the Age at Entry is entered at t=1 to t=12 inclusive in the variable that has the
Mortality Table definition type. The mortality rate appropriate to the Age at Entry +1 is entered at t=13 to t=24
inclusive, and so on.

The Read_Mort_Table Function


An alternative to using the mortality table definition for reading values from a mortality table is the READ_MORT_
TABLE function. With this function, which requires a formula definition, it is possible to read the table from within a
formula, for example:
READ_MORT_TABLE("AM80","AGE_AT_ENTRY","S",
(IF SEX=1 THEN -4 ELSE 0))

Variable definition options

187

Note the following:


n

If you enter the name of the table in quotes, Prophet uses that name for the table.

If you do not enter quotes, Prophet uses the value calculated by a text variable with that name as the table
name.

The age rating may be defined as an expression when this function is used, but must still have an integral value.

For more information, see "Mortality tables" .

188

Chapter 4 Setting up products

Year Dependent Mortality Table definition


The Year Dependent Mortality Table Definition window appears as follows:

You need to specify the following:

Table Name
This is the filename of the table containing the required values. Either
n

Enter a table name directly (without any extension) or click Browse to locate the table, or

Select the "Variable containing Table Name" option and type in the name of the text variable which is to be used
to specify the table name.

Once you have entered the table name you can if you want to click Open to edit the table directly. You are prompted
to select the table location to be used and can create a new table if the table does not already exist in that location.
Note: The standard year dependent mortality tables supplied with Prophet cannot be opened in this way
because they are stored in the MORT sub-folder of the Prophet System location. To open any of these tables,
open the Table Editor window by opening any table and choose Open Table in the File menu to locate the table
you require.

Variable definition options

189

Age at Entry Variable


The Age at Entry variable specifies the initial age to be used when reading the table. It should normally be set to
AGE_AT_ENTRY for the first life and AGE2_ATENTRY for the second life. You can select the appropriate variable
from the drop down list box or by clicking the associated Insert Variable icon.

Year of Entry Variable


The Year of Entry variable specifies the initial year to be used when reading the table. It should normally be set to
ENTRY_YEAR. You can select the appropriate variable from the drop down list box or by clicking the associated
Insert Variable icon.
This variable can be given a non-integral value in which case Prophet will interpolate linearly between the values
for integral years held in the table.

Age rating
The age rating may be either a positive or negative integer.
Note the following:
n

The variables for both the Age at Entry and Year of Entry must not have time-dependent values. They are used
solely for determining the first year dependent mortality rate which is read, with the reading of subsequent rates
automatically taking into account the fact that the age and the year is increasing over time.

The year dependent mortality rate appropriate to the Age at Entry and Year of Entry is entered at t=1 to t=12
inclusive in the variable that has the year dependent mortality table definition type. The year dependent
mortality rate appropriate to the Age at Entry +1 and the Year of Entry +1 is entered at t=13 to t=24 inclusive, and
so on.

The Read_Year_Dep_Mort_Table function


An alternative to using the year dependent mortality table definition for reading values from a year dependent
mortality table is the READ_YEAR_DEP_MORT_TABLE function. With this function, which requires a formula
definition, it is possible to read the table from within a formula, for example:
READ_YEAR_DEP_MORT_TABLE("AIDSR",AGE_AT_ENTRY,ENTRY_YEAR,0)

The READ_AIDS_TABLE function has exactly the same effect.

190

Chapter 4 Setting up products

Note the following:


n

If you enter the name of the table in quotes, Prophet uses that name for the table. However, if you do not enter
quotes, Prophet uses the value calculated by a text variable with that name as the table name.

The age rating may be defined as an expression when this function is used, but must still have an integral value.

For more information, see "Year dependent mortality tables" .

Variable definition options

191

Year Index Table definition


The Year Index Table definition window appears similar to the following:

You need to specify the following:

Table Name
This is the filename of the table containing the required values. Either
n

Enter a table name directly (without any extension) or click Browse to locate the table, or

Select the "Variable containing Table Name" option and type in the name of the text variable which is to be used
to specify the table name.

Once you have entered the table name you can if you want to click Open to edit the table directly. You are prompted
to select the table location to be used and can create a new table if the table does not already exist in that location.

192

Chapter 4 Setting up products

Year of Entry variable


The Year of Entry variable specifies the initial year to be used when reading the table. It should normally be set to
ENTRY_YEAR. You can select the appropriate variable from the drop down list or by clicking the associated Insert
Variable icon.
This variable can be given a non-integral value in which case Prophet will interpolate linearly between the values
for integral years held in the table.

When to use the Year Index Table definition type


This definition type is primarily intended for use in calculations where values are required which vary for each
calendar year, for instance in the calculation of asset shares.
For example, the annual rate of investment return achieved in each calendar year could be set up in a table. This
table would contain two columns, the first being the calendar year and the second being the rate of investment
return for that year.
However, it is normally better to use generic tables for holding this type of information instead of year index tables.

The Read_Year_Index_Table function


An alternative to using the year index table definition to read values from a year index table is the READ_YEAR_
INDEX_TABLE function. With this function, which requires a formula definition, it is possible to read the table from
within a formula, for example,
READ_YEAR_INDEX_TABLE("INV_RATE", ENTRY_YEAR)

For more information, see "Year index tables" .


Note: If you enter the name of the table in quotes, Prophet uses that name for the table. However, if you do not
enter quotes, Prophet uses the value calculated by a text variable with that name as the table name.

Variable definition options

193

Time Index Values definition


The Time Index Values Definition window appears similar to the following:

This definition type allows you to enter values of t in the Month column and the value that the variable is to take at
those values of t in the Value column. A value of zero is assumed for all values of t which are not entered in the grid.
t normally means the month of the policy.
Options are available to Insert, Add and Delete rows in the grid.

194

Chapter 4 Setting up products

Managing products
Products in the workspace are mainly managed using the tree displayed in the Products & Accumulations pane.
Different options are available depending on the item selected in the tree.
Managing products in a folder
Selecting and right clicking the Products folder displays the following context menu:

Options from the menu include:


n

New Product - This enables a new Product to be created.

Group By - This enables the Products in the folder to be grouped by Level, Same As, or by Library. Alternatively,
no grouping of the Products is also available.

Sort options - The Products in the folder can be sorted in ascending or descending order.

Show List of Products - Choose this option to display all Products as a list in the Products tab of the main work
area.

Product options
Selecting and right clicking a product in the tree displays the following context menu:

Managing products

195

You can also select more than one product in the tree using the Ctrl+click method and choose an option from the
right click menu. Options include the ability to open, delete, duplicate, run, regenerate and compare the product.
Products page list view
You can also manage products in the workspace from the Products Page list view which is displayed in the main
window.
To display the Products page list view:

196

Chapter 4 Setting up products

In the Products & Accumulations pane, if required, expand the Products folder.

Select the Products folder and from the right click menu choose the Show List of Products option.

The Products Page list view is displayed in the main window:

From the Products page list view you can select one or more products and select options from the Home or Object
tab. The products are typically listed by their name, description, library, level number, type, Same As product, status,
last date of modification and the name of the user that last modified the product. The list can also be sorted by
clicking a column header.
Grouping the product list
Products listed in the Products page list view can also be grouped by a selection criteria. To group the list, select a

Managing products

197

product in the page list and from the right click menu choose either the Group by or Group by Tab option. Then
choose the column header for the grouping criteria.
n

The Group By option groups the products based on the grouping criteria and lists them in the Products tab.

The Group By Tab option groups the products based on the grouping criteria and places them into separate
tabs.

Note the following:


n

To restore the Product Page List from a grouped list, right click on any product in the list and from the right click
menu choose the Grouped by <none> option.

The "Modified" and "Modified By" settings of Products listed in the page list view can be reset by a user that has
Administrator rights to the workspace. For details see Clearing Modified and Modified By details.

198

Chapter 4 Setting up products

Product status
For each product listed in the Products view Prophet allocates a product status setting. This setting can be one of
the following:
Product Status

Description

Specified

Input variables for the product are specified and the product
saved. When the product is run it is generated automatically.

Mixed

This status message identifies that the product is compiled for


some structures but not others. To open the dialog click Status in
the Home tab. A typical status display appears similar to the
following:

Compiled

This indicates that the product has been compiled.

Managing products

199

Editing an existing product


To edit an existing product you can select and open it in one of the following ways:
n

Products & Accumulations pane


In the object browser, select Products & Accumulations view and expand the Products folder. From the product
tree select the product to edit and click Open from the right click menu.

Products Page list view


Open the Products page list view. Select the product from the displayed list and from the right click menu choose
Open.

In either case, when the product is opened, a list of all the input variables included in the product is displayed. The
list can be further filtered by choosing the appropriate variable category in the product tree..

You can inspect and modify the following items for the selected product:

200

Chapter 4 Setting up products

The product properties, see "Product properties"

The indicators selected for the product, see "Selecting indicators for a product"

The definitions given to each input variable from the product, see "Managing the input variables for a product".
Note: If changes have been made to the input variables in the library associated with a product since it was last
saved, Prophet will prompt you to re-scan the product when you open it. This is to ensure that the list of input
variables displayed for the product is correct.

Diagram view
You can view the dependencies between all the variables in the product by selecting Diagram from the List View
section of the Home tab. You can also edit the definitions for input variables in this view.
Changing Indicators
If you want to change the indicators selected for a product we recommend that you first either Copy the existing
product or Export it to another workspace. Then, after changing the indicators selected and saving the product, you
can Compare the two versions to check what has been changed. This should help you to decide what further
tailoring is required for the input variables so that the product meets your needs.

Deleting a product
You delete a product from the Products folder in the Products and Accumulations view by selecting the product and
choosing Delete from the right click menu or clicking Delete from the Home tab.
Deleting more than one product
Products can be selectively deleted from the tree in the Products & Accumulation pane or from the Product page list
view.
n

Select the products in the tree or list that you wish to delete and either choose Delete from the right click menu
or click Delete from the Home tab.

What happens when a product is deleted?


When a product is deleted the following items are also removed:

Managing products

The selected product and any Same As products that are linked to it. These products are listed and you are
given the opportunity to cancel the deletion.

All results for these products in the workspace.

Files created by Prophet for the product.

201

You can also optionally delete all model point files relating to these products from the table locations in the
workspace.
If you delete a product that is included in any structure, or accumulation then it will be automatically removed from
that structure, accumulation or report.

Duplicating a product
If you need to develop a product that is similar to an existing one it is sometimes easier to make a duplicate of the
existing product and then edit it.
To duplicate a product do the following:
n

From the object browser select Products and Accumulations

If necessary, expand the Products folder to display the products in the folder

Select the product in the tree to be duplicated and either:

Choose Duplicate from the right click menu, or

From the Home tab click Duplicate

In either case the Product Properties dialog for the duplicated product is displayed.

Enter the details for the new product.


When you have finished entering details click OKto save the new product and add it to the Products folder.

202

Chapter 4 Setting up products

Printing product details


You can print the details of one or more selected products or even all the products in a workspace.
To print a list of products or details for a selected product:
To print the details of one or more products, select them in the Products pane list view and choose Print from the
Prophet menu. The Print Products dialog is then displayed:

To print details for the selected product choose Selected Product(s). Alternatively, to print a list of the products
choose List of Products.

Choose the required print options and click OKto print the details to the default printer.

To view the details prior to printing click Preview.


To select the printer and any options click Print Setup.

Auto-scan and Regeneration options

203

Auto-scan and Regeneration options


If you have made any changes to a library, you need to ensure that your existing products associated with that
library are updated to reflect those changes.
There are several methods that you can use, requiring different levels of intervention. Changes to input variables in
the library are incorporated into a product if you do one of the following:
n

Delete all input variables from a product and then re-scan the library. The input variables in the product will then
contain the qualifying definitions from the library.

Open a product, span an input variable, and then select the desired variable definition from the list of available
definitions.

Define which product or products should be auto-scanned, which brings new variables with qualifying
definitions into the product or products automatically.

Delete input variables and re-scan


You can remove all the input variables and their definitions from a product and then re-scan the library. This
ensures that the product does not contain any obsolete variable definitions.
1. In the Object Browser, click the product or products for which you want to update the variables.
2. On the Object tab in the Product group click Delete Input Variables. A confirmation message appears
informing that all the input variables in the selected products will be deleted.
3. In the message box, click Yes. All the input variables in the product are deleted.
Note: If the product contains any variable definitions that are only defined in the product and not in the
library, the definitions are deleted and cannot be recovered.
4. Click in the work area, then on the Object tab click Re-Scan.

Select specific variable definitions


You can specify which definition to use for individual variables in a product. This approach allows you to update
only certain definitions.

204

Chapter 4 Setting up products

1. Open the products which should use the changed definitions.


2. Open each of the variables concerned.
3. On the Design tab click Select Definition and then select the appropriate definition from the list presented.

Using Auto-scan
If you want the default definitions for new input variables to be accepted automatically you can use Auto-Scan,
which automates the steps of opening a product, re-scanning and saving the product.
1. In the Object Browser select Products and Accumulations and then select any product in the tree.
2. On the Object tab click Auto-scan.
3. In the Select Products for Auto-Scan dialog box, select the products for which you want the scanning process
to take place and click OK. New input variables are included automatically where appropriate in your products.
In addition, any input variables that are no longer required are removed.

Regeneration options
If you have made any changes or additions to core variables, these changes are incorporated in your products
when they are next regenerated. Regeneration of a product takes place automatically at the start of a run which
includes that product in the following circumstances:
n

If you have opened the product and then saved it, or

If you have auto-scanned the product, or

If you have selected the product, clicked Regenerate in the Home tab and when prompted by the Set Products
for Regeneration dialog box, clicked OK.

If you have used the Regenerate options in the Select Run Pairing to be Run dialog box.

Comparing products

205

Comparing products
You can compare products in one of the following ways:
n

To compare a product
To compare the product with another in the same or different workspace, select a product in the Products &
Accumulations pane or in the Products page list view and from the Utilities tab click Compare.
Alternatively,

To compare a number of products


To compare a number of products with those having the same names in a different workspace select them in the
Products & Accumulations pane or in the Products page list view and from the Utilities tab click Batch
Compare.

In addition to specifying a standard set of compare settings you can also supplement them by using more advanced
ones.
At the end of a compare operation the differences between the products are displayed in the comparison window.
You can then analyse, print and save the compare report.
Note: You can also compare libraries and export and import variables between them. See Comparing Libraries
in the Libraries chapter of this manual.

206

Chapter 4 Setting up products

Running a single product comparison


To compare two products first select one of the products to be compared in the Products & Accumulations pane
and from the Utilities tab click Compare to display the Compare Product dialog box. It appears similar to the
following:

From this dialog box you select the product to be compared with and the variables to be included in the
comparison. You can select:
n

A product in a different workspace, or

A different product in the current workspace

When you have selected a product to be compared you can:


n

Specify the standard compare settings and click OK to run the comparison, or

Click Advanced to specify additional compare settings and then click OK to run the comparison.

Standard compare settings


Standard compare options allow you to include a comparison of the indicators and variables in the products. In
particular, you can specify the following types of variables to be compared:

Comparing products

All Variables

Input variables only

Core variables only

A variable group and category

A variable code

207

To start the compare process click OK. To apply additional compare options click Advanced.

Advanced compare settings


In addition to the standard compare options you can apply additional compare options by clicking Advanced. The
Compare Product dialog box is then extended to display the additional options. The dialog box appears similar to
the following:

The advanced compare settings allow you to:


n

Compare all items used by the products.

Compare indicator expressions

Compare formulas only

208

Chapter 4 Setting up products

Compare variable codes only

Ignore the dimension values of array variables

Depending on the compare settings selected you can further specify to ignore:
n

Variable codes and their descriptions

The case of letters used for indicator expressions

The dimensions of any array variables

Leading white space

You can also compare formulas ordered by their definition type.


When you click OK the advanced compare settings are first saved. The comparison is then processed using all the
settings specified in the extended dialog. At the end of the comparison the results are displayed in the comparison
window.
Note the following:
n

To apply the advanced settings for another comparison you need to click Advanced before starting the
compare.

Advanced settings are saved between comparisons.

Comparing products

209

Running a batch product comparison


You use the batch compare facility to compare a number of products in one workspace with those having the same
name in a different workspace.
To set up a product batch compare:
n

In the Products & Accumulations pane select a product and from the Utilities tab click Batch Compare to
display the Batch Comparison of Products dialog. It appears similar to the following:

Two tab are displayed in this dialog:


n

Products tab
Allows you to specify the location of the workspace containing the products to be compared with those listed in
the Products tab. You choose the products in the current workspace to be compared by selecting them from the
Available Products list and moving them to the Selected Products list.

Options tab
Allows you specify the compare options.

210

Chapter 4 Setting up products

When you have specified the workspace, products and compare options click OK to start the comparison. When the
comparison is complete the Comparison window is displayed.

Comparing products

211

Batch Comparison of Products - Products tab


From this tab you complete the following:
n

Workspace location
Enter the location of the workspace in the Workspace text box that contains the products to be compared against
those in the current workspace.

Products view
Choose the products in the current workspace to be compared by selecting them from the Available Products
list and moving them to the Selected Products list.

When the workspace location and products have been specified you can then specify the compare settings from the
Options tab.

Batch Comparison of Products - Options tab


The Options tab of the Batch Comparison of Products dialog box appears similar to the following:

212

Chapter 4 Setting up products

In the Compare what section of the Option tab you can specify to compare variables or indicators or both. In
addition, if comparing variables, you can also specify in the Variable Category section of the dialog box the type of
variables to be compared and in the Compare Options section you can specify the type of comparison to be
performed
When the workspace, products and compare settings are specified click OK to begin the compare process.

Viewing a product comparison


When a product comparison is complete the differences are displayed in the Comparison window. For a product
comparison the window appears similar to the following:

The results of the compare are displayed in the window with the viewing options controlled by settings in the left
pane alongside.
From the tabs in the left pane you can display the variable or Indicator differences with their definitions in the two
products displayed in the middle and right panes.
For a product batch compare you select the product dropdown list in the bottom left of the window for each product
for which you wish to display differences.

Comparing products

213

Also, in the variables tab, the total number of new, deleted or modified core and input variables used in the
comparison are listed in the Summary tab with details of any advanced compare options used for the comparison
shown in the Advanced Options tab.
Similarly, in the indicators tab, the total number of new, modified or deleted indicators are listed in the Summary tab.
A Line Details area at the base of the comparison panes displays the contents of the selected lines in the panes. It
uses the entire width of the viewer window to display each line, one on top of the other.
Printing variables or indicator differences
You select the variables or indicators whose differences you wish to print in one of the following ways:
n

Standard windows selection method


You use the Shift-Click method to select contiguous variables or indicators or Ctrl Click to select non contiguous
ones.

Checkbox selection method


For each variable that you wish to print you select the checkbox alongside the variable or indicator name.

A number of display options are also available from the comparison toolbar immediately above the middle and right
panes. For the available options see Comparison toolbar in the online Help.

Comparison toolbar
A number of comparison options are available from the Comparison Toolbar which appears similar to the following:

The Comparison toolbar icons are as follows:

214

Chapter 4 Setting up products

Filter Options
Option

Description
Shows everything including differences

Displays just the differences

Displays just major differences

Displays matching text

Next / Previous Differences


Option

Description
Displays the next comparison difference

Displays the previous comparison difference

Find Text
Option

Description
Use to search for and find text in the comparison.

Use to repeat the search to find text in the comparison using the
previous search text.

Comparing products

Go to Line
Option

Description
Use to go to a specific line number. A dialog box appears
allowing you to specify the line number and which side it
applies to.

Display options
Option

Description
Click this button to display spaces using the tilde character ("~")
and tabs as rectangles.
Click this button to display line numbers for each file.

Click this button to display a thumbnail view or visual summary


of file differences in an area to the left of the file display.
Coloured lines show the relative position of line mismatches. A
white rectangle represents the part of the files currently visible
in the file viewer window. You can click on the thumbnail view
to position the file viewer at that point.
Click this button to show or hide the Line Details area. The Line
Details area "zooms in" on the current pair of lines selected in
the File Viewer. It uses the entire width of the viewer window to
display each line, one on top of the other. You can click on a
character to determine its column number.

215

216

Chapter 4 Setting up products

Rules
Option

Description
Allows you to modify the currently selected rules. Rules are
sets of options that control how items are compared. See
Comparison Rules.
Allows you to specify how the comparison appears. See
Comparison Viewer Options.

Product Schedule

217

Product Schedule
The Schedule option for products allows you to report on all variables, all input variables or variables in a variable
group across one or more products. Select a product in the Products & Accumulation pane and then click Schedule
in the Objects tab to display the Product Schedule dialog box.

This dialog box has two tabs:


n

Products
Enables you to specify the products to be included in the schedule and also the run number for which results
are to be displayed.

Variables
Enables you to specify the variables to be included in the schedule.

218

Chapter 4 Setting up products

Product Schedule - Products tab

Options from this tab allow you to:


n

Select the run number for which you want the results displayed in the schedule.

Choose whether the products should be displayed as the column headers, with the variables as the row
headers, or as the row headers, with the variables as the column headers.

Select the products to be included in the schedule.

Product Schedule

219

Product Schedule - Variables tab


Options from this tab allow you to specify the variables to be included in the schedule.

From this tab you can:


n

Choose whether the schedule should include all variables, all input variables or the variables in a selected
variable group.

For the Selected Definition Types option you can select the definition types you require. Also, select the
following options if appropriate:
Include Associated READ Functions
Select this option if you want, for example, formulas that use the READ_GLOBAL function to be included if you

220

Chapter 4 Setting up products

select the Global definition type.


Include Non-Selected Types for other Products
If you don't select this option the schedule will have blank cells for all the products included in the schedule for
those variables that don't have the required definition type(s). If you do select it then these cells instead show
the actual definition, even if it isn't of the required type(s).
n

For the Variable Group option select the required variable group category and name.

Product Schedule

221

Product Schedule window


When you have selected the products and variables you require click OK to display the Product Schedule window.

The Product Schedule window has the following views:


n

Variables view
Displays all the appropriate combinations of products and variables in a grid.

Indicators view
Displays the appropriate combinations of indicators used by the selected products.

Dimensions view
Displays the dimensions used by array variables used by the selected products.

222

Chapter 4 Setting up products

Product Schedule Variables view


This is the displayed default view when the product schedule report is complete. In this view the cells contain text
strings that describe the variable definition type for each product variable in a product.

From the Product Schedule variables view you can:


n

Transpose the products and variables by clicking Swap.

Close the Product Schedule window by clicking Close.

You can change the appearance of the content in the cells by selecting the appropriate options from the right click
menu.and print the schedule by clicking Print from the Prophet menu..

Product Schedule

223

You can also display the indicators used by your products in the Indicators view and the dimensions of array
variables in the Dimensions view.

Product Schedule text strings


The product schedule text strings give details of the definitions. They depend upon the definition type as follows:

Formula text string


Depending on the content of a formula different Formula text strings are displayed in the Product Schedule as
follows:

Formulas that do not reference any READ functions


n

The word Formula is displayed if the formula is time-dependent or there are no results for the product.

The 2 characters F= followed by the value from the results is displayed if the formula is non time-dependent and
results do exist. For example, F=33.00~

Formulas that reference any READ function


If the formula is time-dependent or there are no results for the product then the word Formula is replaced by one of
the following as appropriate:
Read_Generic, Read_Global, Read_Mort, Read_Paramet, Read_Results, Read_Results_Legacy, Read_Results_
Text_Legacy, Read_YearDep, Read_YearInd
Note: If the formula contains more than one of these functions then only the first function is displayed in the text
string.

Non time dependent formulas containing READ functions


If the formula is non time-dependent and contains any of the following functions then the text string F= is replaced
as follows:
READ Function

Text String

READ_GENERIC_TABLE

T=

224

Chapter 4 Setting up products

READ Function

Text String

READ_GLOBAL

RG=

READ_PARAMETER

RP=

READ_RESULTS with a G parameter

RRG=

READ_RESULTS with a P parameter

RRP=

READ_RESULTS with a Z parameter

RRZ=

Note: Only the first function is identified if the formula contains more than one READ function.
Constant text string
For a constant text string the 2 characters C= are followed by the constant value. For example C=24.67.
Generic Table text string
For a generic table the text string consists of 4 characters GEN= followed by the table name, for example GEN=RB_
RATES.
Global table text string
For a global table the text string consists of 2 characters G= followed by the value from the results.
Model Point text string
For model point file the text string consists of 2 characters M= followed by the value from the results for the first
model point of the first sub-product code.
Mortality Table text string
For a mortality table the test string consist of the table name followed by a space and then either S or U depending
on whether it is Select or Ultimate. If the age rating is not zero this is followed by + or - and then by the age rating,
for example A67-70_2 U and AM80S-2.
Parameter text string
For a parameter file the text string consists of 2 characters P= followed by the value from the results.
Time Index Values text string
For time index values the text string is set to the words Time Index.

Product Schedule

Year Dependent Mortality Table text string


For a year dependent mortality table the text string consists of the table name. If the age rating is not zero this is
followed by a space, then + or - and then by the age rating, for example AIDSF and AIDSR -2.
Year Index Table text string
For a year index table the text string consists of 3 characters YI= followed by the table name, for example YI=B_
RATES.

225

226

Chapter 4 Setting up products

Product Schedule Indicators view


This view displays the indicators used by the selected products. If an indicator is used by a product then the
appropriate cell is marked with a tick

From the Product Schedule Indicators view you can:


n

Change the products or indicators by clicking Schedule.

Transpose the products and indicators by clicking Swap.

Close the Product Schedule window by clicking Close.

Product Schedule

227

You can change the appearance of the content in the cells by selecting the appropriate options from the right click
,menu print the schedule by clicking Print from the Prophet menu.
You can also display the variables used by your products in the Variables view and display in the Dimensions view
the dimensions of array variables used by the products.

228

Chapter 4 Setting up products

Product Schedule Dimensions view


This view displays the dimensions of the array variables used by the selected products.

From the Product Schedule Dimensions view you can:


n

Transpose the products and dimensions by clicking Swap.

Close the Product Schedule window by clicking Close.

You can change the appearance of the content in the cells by selecting the appropriate options from the right click
menu.and print the schedule by clicking Print from the Prophet menu..
You can also display the variables used by the selected products in the Variables view and the indicators in the
Indicators view.

Product Schedule

229

Printing the product schedule


To print a product schedule open it and click Print in the Prophet menu. The Print Product Schedule dialog then
appears similar to the following:

You can print the entire schedule with or without the inclusion of product details. Choose what you want to print and
click OK. To see what is to be printed click Preview.

230

231

C H A P T E R

Setting up tables

TOPICS IN THIS CHAPTER


What is the Table editor?

233

Types of table supported by the Table Editor

234

Creating a table

236

Generic tables

255

Global files

263

Model point files

265

Mortality tables

268

Parameter files

269

Sales files

271

Segment table

272

Stochastic tables

273

Stochastic File Convertor utility

274

Table of Tables

276

232

Chapter 5 Setting up tables

Unit Prices files

278

Year dependent mortality tables

279

Year index tables

280

Managing tables and model point files

281

Printing tables and model point files

284

What is the Table editor?

233

What is the Table editor?


The Table Editor allows you to manage the tables used by your products during their calculations. You can use the
Table Editor to create new tables and edit existing ones.
Using the Table Editor you can:
n

Create all the different types of table types used in Prophet.

Automatically generate the row and column titles to match your product specifications for some types of table.

Select values from dropdown lists if only specific values are valid for the variable corresponding to a cell.

Copy and paste entries from one part of the table to another.

Apply linear interpolated values to empty cells in selected rows.

Show the descriptions for variables, products and other items instead of or in addition to their names.

Customise the appearance of tables. You can change the size of the columns, add a background colour to
selected cells and display either or both the names and descriptions of the variables used in the table.

When a table is saved using the Table Editor it is validated and then stored in a format that can be used in Prophet.

234

Chapter 5 Setting up tables

Types of table supported by the Table Editor


The Table Editor allows you to create and maintain all the different types of tables and files used in Prophet with the
exception of stochastic tables. The table types that are supported by the Table Editor are:
n

Generic tables in either table or column format

Global files

Model point files

Mortality tables

Parameter files

Sales files

Segment tables

Stochastic (.FAS) files are binary files. You can only view the contents of the files in the Table editor. They
cannot be edited.

Table of Tables

Unit Prices files

Year dependent mortality tables

Year index tables

If you attempt to open a table that is not recognised by the Table Editor then you can import it by specifying the
required table type, view the table using Viewer or launch the application that was originally used to create it.
Note the following:
n

The Data Conversion System can be used to create model point files from extracts of your policy data.

Sales files can also be generated and maintained using the Sales Generator.

Types of table supported by the Table Editor

Stochastic files can be created by converting generic tables saved in a specific format as .FAC files (comma
delimited text files) and then converted using the StoFacConvertor utility to.FAS files which are binary files.

For details of the supported table formats see: Table and file external formats in Help.

235

236

Chapter 5 Setting up tables

Creating a table
To create a table you click New in the Edit section of the Home tab and choose New Table.

You then do the following:


n

In the New Table dialog box you choose the type of table required. If appropriate, you can also populate the row
and column titles of the table with the names of the variable definitions used in a product by clicking Initialise.

Specify the table properties.

Enter and format the required values in the Table Editor. For editing options see General Table Editor editing
operations.

Finally, you save the table.

New Table dialog box


A new table is created using the New Table dialog box which is displayed when you choose New Table or New
Model Point from the New menu of the Home tab.
For all table types except a Model Point File the New Table dialog box appears similar to the following:

Creating a table

237

From the dialog box you can:


n

Choose the type of table to be created

For a generic table or model point file, enter the location and filename of the table or accept the default.

Optionally, fill the titles of the rows and columns of the table with the names of the products and variables by
clicking Initialise and selecting a product or products from the "Select products from which to read variable
names" dialog box.

Note the following:


n

The Standard Table option allows you to create a new table based on one of the standard tables supplied with
Prophet. These tables,are mainly used by Asset and Global Strategy products to specify many of the inputs for
ALM models.

Select table dialog box


The Select Table dialog box displays a list of the Standard ALM Tables that are stored in the location specifed in the
Table Options setting of the Options dialog box.
To display the dialog box:

238

Chapter 5 Setting up tables

From the Home tab choose New Table.

From the New Table dialog box choose Standard Table and click OK.

The Select Table dialog box appears similar to the following:

You can then do one of the following:


n

To create an empty table - Select the table from the list and click OK.

To populate the new table with variables from products - Click Initialise and select the variables from the
Selecting Products from which to read Variable names dialog box.

Initialising a table
You can populate a model point, global or parameter file with suitable row and column titles that match the variable
definitions of the products selected in the "Select products from which to read variable names" dialog box.
To display the "Select products from which to read variable names" dialog box:

Creating a table

In the New Table dialog box to click Initialise.

The Select Products dialog box appears and prompts you to select the product or products to be used. For a
Generic table the dialog box appears similar to the following:

239

From this dialog box you can:


n

Add products to a parameter file:


Any variables for those products with parameter definitions which are not already in the file will also be added.

Add variables to a global file


All the variables with global definitions in the products you select will be added.

Add variables to a generic table


All the variables with generic definitions referencing that table in the products you select will be added.

Add variables to a model point file


All the variables with model point file definitions in the products you select will be added.

Add products and table names to a table of tables file


Selected products are scanned for the existence of the READ_TABLE_NAME function. If the function exists in a

240

Chapter 5 Setting up tables

product then the name of the product is added to a row of the table together with the name of the table used by
the function.
Note the following:
n

You can use this dialog box either to initialise new files that you create or to add products and variables to
existing files.

Different options are available depending on the type of table being initialised. With the exception of model
point tables, you can read variables from all products by selecting Select All Products.

For a generic table you can also insert the variables from the selected products as either row or column
headers.
Note: If you choose not to initialise a table then the Table properties dialog box is displayed instead.

To specify which variables in the selected products are scanned when you initialise a table, click Options andselect
the options you require from the Product Scan Options dialog box. Once accepted, this scanning setting is used
indefinitely, until you change it.

To make sure that all relevant variables are included in the file select All Variables and Scan for READ function
calls. However, if your products have no core variables defined to read values from the table, as is the normal case,
or if you know that no READ functions are used, then you can select the other options to reduce the time taken by
Prophet to complete the scanning process.

Creating a table

Note: The scanning process only identifies variables that exist in the workspace. Thus for example, READ_
GLOBAL("DUMMY") will not lead to the variable DUMMY being included in the global file unless the variable
DUMMY also exists in the workspace.
Click OK to initialise the Table. For a global table it appears similar to the following:

You can then enter values into the table. Details on how to specify each type of table is described later in this
chapter.

241

242

Chapter 5 Setting up tables

Table properties
The Table Properties dialog is displayed if you do not select Initialise when you create a new table. It is also
displayed when you click Table Properties in the Table tab. For a model point file it appears similar to the following:

For a generic table it appears similar to the following:

Creating a table

243

The General tab allows you to enter a description for the table. It also displays the name and type of table together
with details about the table, such as the numbers of rows and columns, which vary by type of table.
New tables are always assigned default names. When a new table is first saved you can either accept the assigned
name or change it.
If you know the dimensions you require for the table then you can enter them in this dialog. The values that you
enter determine the number of rows and columns initially included in the table. Alternatively you can let these
values be determined as you build the table.
For Generic tables you should choose whether to use Table Format or Column Format. See "Generic tables". For
table format generic tables you should also:
n

Specify the number of index variables, that is the dimensions required for the table.

Enter the name of the last index variable, that is the variable whose values appear along the title row.

The Statistics tab displays additional information about the table. It is maintained by Prophet and cannot be
manually updated.
When you click OK the table is displayed.

Table data
A table has rows, columns and cells with row and column headings identified by a number. A cell marks the point
where a row and column intersect.
When you create a table, the Table Editor adds appropriate rows and columns to the table for the titles which
Prophet will use to identify the values to be read by your products during a run. The cells in these rows and columns
are set to a different colour to that of the rest of the table.
A table can contain up to 1,000,000 rows and 255 columns.

244

Chapter 5 Setting up tables

Table Editor editing options


Different options are available depending upon the type of table being created or edited. Those specific to each
type of table are described in the sections relating to each type of table. Those more generally applicable are
shown in General table editing operations .

General Table Editor editing operations


You can use all the standard Windows editing options. The main options, some of which are accessed from a menu
when you right click in the data grid are as follows:
To do this

Do this

Insert one or more


rows

Select the number of rows to be added before the required insertion point. From the
Table tab click Insert and choose either Insert rows above or Insert rows below. For
example, if you select 5 rows then 5 empty rows are created above the selected rows.

Insert one or more


columns

Select the number of columns to be added to the right of the required insertion point .
From the Table tab click Insert and choose either Insert columns to right or Insert
columns rows to left. For example, if you select 2 columns then 2 empty columns are
created to the left of the selected columns.

Add one or more rows


to the end of the table

From the Table tab select Table Properties and increase the number of rows and click
OK.

Add one or more


columns to the end of
the table

From the Table tab select Table Properties and increase the number of columns. and
click OK.

Delete one or more


rows

Select the rows to be deleted and then from the Table tab click Delete and choose
Delete Row.

Delete one or more


columns

Select the columns to be deleted and then from the Table tabclick Delete and choose
Delete Column

Cut the values for one


or more cells

Select the cells to be cut and from the Clipboard section of the Home tab click Cut.
Shortcut key, Ctrl+X

Creating a table

To do this

Do this

Copy the values for


one or more cells

Select the cells to be copied and from the Clipboard section of the Home tab click
Copy.
Shortcut key, Ctrl+C

245

Paste values that have Place the insertion point where you want to paste the values. From the Clipboard
been cut or copied
section of the Home tab click Paste.
Shortcut key, Ctrl+V
Delete values from
cells

Select the cells to be deleted and from the right click menu choose Delete Formula(s)
Shortcut key, Del

Exclude one or more


rows

Select the row(s) to be excluded. From the Edit section of theTable tab click Exclude
Row. Excluded rows are shown in a different colour.

Re-include one or
more excluded rows

Select the excluded row(s) to be re-included. From the Edit section of the Table tab click
Include Row

Find a particular value


or text string in one or
more tables

From the Home tab click Find and choose the Find option. Then enter the value or text
string and click Find Next .
Shortcut key, Ctrl+F.
In Tables or Model Point Files View click Find in the Home tab and choose the Find in
files option.

Replace a particular
value or text string in a
table

From the Home tab click Find and choose the Replace option. Then enter the value or
text string to be located and the value or text string to replace it and click Replace or
Replace All.
Shortcut key, Ctrl+H.

To update the data in


the table

From the Home tab click Refresh.


Shortcut key, F9

246

Chapter 5 Setting up tables

To do this

Do this

To duplicate data in
selected cells to all
cells to the right of the
selected cell

Select the cells in a column to be duplicated. From the Fill section of the Table tab click
Fill and choose the Replicate to right option.

To duplicate data in
selected cells of a row
to all cells down to the
bottom of the table

Select the cells in a column to be duplicated. From the Fill section of the Table tab click
Fill and choose the Replicate down option
Shortcut key, Ctrl+ D

To duplicate data in
selected cells to all
cells to the right and
down to the bottom of
the table

Select the cells in a column to be duplicated. From the Fill section of the Table tab click
Fill and choose the Replicate to end option.

Shortcut key, Ctrl+ R

To enter interpolated
Select the cells that include both the empty cells and the cells containing the values to
values into empty cells be interpolated. From the Fill section of the Table tab click Fill and choose the
between filled cells.
Interpolate values option. The data in the empty cells will then contain the interpolated
data. The interpolated value in an empty cell is the mean value between two adjacent
cells.

Creating a table

247

Table formatting options


Formatting options in the Table Editor are accessed from the Format section of the Table tab.

Options from the Format section allow you to:


n

Display the names, descriptions or both of the variables and products shown in the row and column headers by
clicking Names / Descriptions

Change the background colour of selected cells by selecting them, clicking Colour and choosing the desired
colour from the Colour dialog.

Show or hide the variable constraints applied to variables in the table. Clicking Toggle Constraints switches
between the views. Constraints for a variable are specified in the Workspace Level Properties section of the
Variable Properties for the variable.

Add / edit explanatory notes for a table by clicking Table Notes and entering the notes into the Notes pane that
appears. To close an open Notes pane click Table Notes again.

Validating entries in a table


The Table Editor performs a number of validation checks as you enter values or formulas into cells, to prevent you
making invalid entries.

248

Chapter 5 Setting up tables

Displaying Names and Descriptions


You can specify how the row and column headings are displayed in the table grid by setting options in the Display
of Names and Descriptions dialog box. To display the dialog box:
n

Choose Names/Descriptions from the Format section of the Table tab. The Display of Names and
Descriptions dialog box appears similar to the following:

From this dialog box you can specify to show the name or description or the name and description of:
n

Run Numbers

Products

Sub Products

Variables

Choose what you want to display in the rows and headers of tables and click OK to apply the changes.

Finding and replacing data in tables


You can use the Find and Replace panel to search and locate occurrences of a text string or a number in either a
table, a selection of tables or tables in a specific location. Similarly, you can use Replace to search for a particular

Creating a table

249

text string or number and then replace it by another text string or number.
To find data in more than one table:
1. On the Home tab click the arrow below Find/Replace and select Find/Replace in Tables.
2. The Find/Replace in Tables panel is displayed which can be docked within the Prophet application area or
detached and floated.

3. In the Find in Tables tab enter the text or number you wish to find in the Find What dropdown list which will may
also have text or numbers from a previous find or replace operation. You can then set the following options:
n

All open tables


Select this option to locate data in only those tables that are open in the application.

Highlighted tables
This option allows you to search tables selected in the List of Tables or selected in the Object Browser.

250

Chapter 5 Setting up tables

All in Workspace Table locations


Tables in the table locations specified in the Table Locations dialog are searched.

All in Workspace MP File locations


Tables in the Model Point file locations specified in the Model Point File Locations settings are searched.

All in specified location(s)


Select this option to specify one or more locations containing the tables you wish to search. Click Browse to
add a list of table locations in the Table locations dialog. You can also choose to search all tables in the sub
folders of the specified folder by selecting Include sub directories.

4. When you have specified which tables are to be searched to can specify the following search settings:
n

Options
Exact Match to find only those tables that only contain the text or number entered in the Find What
dropdown list. Select Match Case to locate only those tables that contain text that has the same upper and
lower case characters.

Find Within
Select the areas in which to search for the text or number from within this section. You can choose to search
for text and numbers in the column headings, fixed columns and data cells. The default setting is to search in
all these areas.

When you have set up the search options click Find All
The results of the search operation are displayed in a new tab in the Find/Replace in Tables dialog. The new tab
lists those tables containing the specified text or number by table filename and the location of the text or number
found in the table by its column, row and position in the cell.

Creating a table

251

From the search results tab you can choose to replace the search occurences with text or numbers entered in the
Replace with dropdown list. You can also choose to confirm replacements and also validate them.
To apply changes to all occurences, click Replace All. To apply changes to only those tables selected in the
displayed list click Replace Selected. To stop a replacemnet operation click Stop.

Finding and replacing data in a table


You can find and replace data in an open table using the local Find and Replace toolbar.
To find and replace data in a table:
1. Open the table in which you wish to change data.
2. On the Tabletab click Find/Replace to display the Find/Replace toolbar.
3. To show the Replace part of the toolbar, click Show Replace. The Find/Replace toolbar appears similar to the

252

Chapter 5 Setting up tables

following:

From the table Find/Replace toolbox you can:


n

Enter the text or number you wish to find in the Find dropdown or select text or numbers from a previous search
or replace operation.

Enter the replacement text or number in the Replace dropdown list or select text or numbers from a previous
replace operation.

You can then set the following options from the Options menu accessed from the Toolbar::
n

Start the search and replace operation from the currently selected cell to the end of the table. Alternatively, you
can choose to perform the replacement operation for the entire grid.

Perform the search and replace operation row by row down to the end of the table or along each column at a
time.

Select the areas in which to search and replace the text or number. You can choose to perform the replacement
operation for text and numbers in the column headings, fixed columns and data cells. The default setting is to
perform the replacement operation in all these areas.

Specify the replacement operation to be based on an exact match and case on the text or number to be located.

Specify to be prompted when the located search text or number is to be replaced.

When you have set up the replace options click Replace. To locate and replace all occurrences of the text or
number in the table click Replace All.

Creating a table

253

Saving a table
When you have entered values for all the cells in a table you save the table by clicking Save in the Table tab and
from the displayed menu choose one of the Save options:Save Table,Save without Validation or Save Table As.
If you are saving a new table you are prompted to enter a filename and a location.
To save an existing table under a different name or in a different location choose the Save Table As option from the
Save menu in the Table tab.
If you attempt to save a table using an existing table's name and location, you are prompted that the table already
exists and you are asked to confirm its replacement.

Table validation
The Table Editor performs a number of validation checks before a table is saved. The main checks are:
n

That no cells have been left empty or with invalid data, that is data that Prophet cannot read during a run.
The Table Editor warns you of the problems. You may elect to save the table anyway but if you do this, you
should still correct the table before you try to use it in a run.

No rows or columns may be left completely blank.


The Table Editor deletes blank rows and columns automatically.

For model point files, the rows must be in ascending sub-product code (SPCODE) order.
The Table Editor will then prompt you to sort the rows.

Table naming conventions


The following naming conventions for tables must be followed:
n

A model point file has a six character name followed by a three character file name extension. The six character
name must be the same as the name of the associated product. The file name extension can be anything,
although we recommend .RPT.

Global and parameter files can have any name and any file extension although we recommend that you use
.FAC for the file extension.

254

Chapter 5 Setting up tables

Unit price files and generic, mortality, year dependent mortality and year index tables can have any name. They
are given a .FAC file extension.

In addition, file names cannot include any of the following characters: forward slash (/), backslash (\), greater than
sign (>), less than sign (<), asterisk (*), question mark (?), quotation mark ("), pipe symbol (|), colon (:) or semicolon
(;).

Table locations
You can only save tables in the specified table locations for the workspace. For all tables other than model point
files, these locations are specified using the Table Locations setting in the Options dialog box of the Prophet menu.
See "Specifying table locations" .
The locations of model point files are specified using the Model Point Files Locations setting in the Options dialog
box of the Prophet menu. See "Specifying Model point file locations.

Generic tables

255

Generic tables
The window for a generic table appears similar to the following if you have chosen to use the table format:

You can use the table format for a generic table when the value or values required for a variable in any of your
products depend on the values of between two and ten index variables.
The column format for a generic table provides an alternative format that you may use if you prefer. It must be used
if the values required for a variable depend on the values of only one index, see "Generic tables -column format".
However, it is generally better to use a table format generic table if there are two or more index variables as it is
easier to view and enter the values.

256

Chapter 5 Setting up tables

Generic table definitions


If any of your products have any variables with a generic table definition, you must create a generic table for
Prophet to read the values to be used. Prophet will also read values from generic tables for variables with formula
definitions which include a READ_GENERIC_TABLE or READ_GENERIC_TABLE_TEXT function, for example:
READ_GENERIC_TABLE("PREM_RTE", "Y", "PROD_NAME", AGE_AT_ENTRY,
POL_TERM_Y, SEX, SMOKER_STAT)
READ_GENERIC_TABLE_TEXT("MORTALITY_TABLES", "Y", "PROD_NAME",
SERIES)

You must ensure that the generic table definitions in your products are consistent with the generic tables
themselves, both in the number and in the order of the index variables.
If you use the generic table definition type with time-dependent index values, you must ensure that the table
includes values for all the appropriate values of t. For a generic table which is read monthly, this is all the values
from t=0 to the end of the calculation array, that is to t = PROJ_TERM_Y * 12. For a generic table which is read
annually this is all the values t=1, t=13, etc up to PROJ_TERM_Y * 12-11.
If you use the READ_GENERIC_TABLE or READ_GENERIC_TABLE_TEXT functions with time-dependent index
values, you only need to include in the table values which correspond to the values of t at which this function is
called in your products.

Index variables in a generic table


A table format generic table has a column for each index variable that the variable depends on, except the last
index variable. These columns contain the possible combinations of values of those index variables. The possible
values of the last index variable go across the remaining cells in the top row.
Use the Insert or Delete options from the Tables tab to add or delete columns of index variables. Alternatively, you
can control the number of index variables, columns and rows from the Table Properties dialog box which is
displayed when you click Table Properties from the Table tab.
The descriptions for the index variables are displayed for a selected cell in the status bar at the bottom of the table.

Generic tables

257

The other cells in the table contain the values to be used in your products. In a run Prophet takes the value from the
cell at the intersection of the row containing the appropriate combination of index variable values and the column
that is headed with the value of the last index variable.

Use of functions and expressions as indexes in a generic table


In addition to the use of index variables, many of the functions in the Prophet programming language can be used
as indexes within a READ_GENERIC_TABLE or READ_GENERIC_TABLE_TEXT function. You can also use
mathematical expressions enclosed in brackets.
For example, START_YEAR is a function that returns the start year as entered in the run setting. It could be used to
index into a generic table VAL_RATE that contains valuation rates of interest by product for the past few years, as
follows:
READ_GENERIC_TABLE("VAL_RATE", "Y", "PROD_NAME", START_YEAR)

Thus the correct valuation rates of interest would be used, whatever start date is specified.
If you are using the READ_GENERIC_TABLE or READ_GENERIC_TABLE_TEXT functions, you can also use any
text string in place of a variable name as the value for an index, provided it conforms to the rules for a variable
name.

Naming and saving generic tables


A generic table can have any name provided that it has the same name as is specified for the variable set up to
read it in your products. You specify the location of the particular tables to be used in a run in the Tables tab of the
run setting.

Special index variables in a generic table


In addition to using ordinary variables as indexes, you can set up generic tables from which Prophet reads values
based on the values for a number of special index variables. These special index variables are as follows:
Special index variable

Description

LIBRARY

Prophet will use the library letter as the index variable (for exampleC).

258

Chapter 5 Setting up tables

Special index variable

Description

JUST_VAR_NAME

Prophet will use the name of the variable, without the array dimensions in the
case of an array variable. For example, MY_ARRAY is returned for an array
variable MY_ARRAY(1:1).

PROD_NAME

Prophet will use the 6 character name of the product as the index variable (for
exampleC_WEND).

RUN_NUMBER

Prophet will use the current run number as the index variable. Entries in the
table may be integers between 1 and 999, for example 1, 2, 10. Alternatively
they may be entered as text strings starting RUN_, for example RUN_01,
RUN_02, RUN_10. You cannot mix these formats in a single table.

SIMULATION

Prophet will use the current simulation number as the index variable. Entries
in the table may be integers, for example, 1,2,100, etc. Alternatively they may
be entered as text strings starting SIM_, for example SIM_1, SIM_2, SIM_100.
You cannot mix these formats in a single table.

SPCODE

Prophet will use the sub-product code of the current model point as the index
variable (for example51).

VAR_NAME

Prophet will use the name of the variable which has been given the generic
table definition as the index variable (for exampleYR1_LAPSE_PC). For array
variables the array dimensions will be included. For example, MY_ARRAY
(1:1) is returned for an array variable MY_ARRAY(1:1).

Generic table examples


Generic tables can be used in a number of ways as illustrated in the following sections.
2- dimensional generic table example
The following 2-dimensional table format generic table contains lapse rates that vary by product and the policy
year.

Generic tables

259

The title column contains the product names and the title row contains the policy years. The remaining cells contain
the lapse rates.
To establish which rate to read from the table, Prophet looks in the title column to see which row contains the
appropriate product and then looks across the title row to see which column is titled with the appropriate policy
year. Prophet then takes the value from the intersection of that row and column. Therefore, in this example, if the
product is U_MIP_ and the policy year is 2, Prophet takes the lapse rate from the cell at the intersection of row 4 and
column 4, that is 10.
Note: If a table with time-dependent index values is read using the generic table definition type with a Time
Allocation of Monthly then values are necessarily read for all values of t. Hence, the table must include a value
for when t=0, that is when the policy year = 0. Values of 0 for policy year = 0 are entered in the table because
such values are not used in the calculations. If the table is read with a Time Allocation of Annually then a value
would not be required for t=0 because the table would only be accessed for t=1, 13, 25, etc.
3- dimensional generic table example
The following 3-dimensional table format generic table contains lapse rates that vary not only by product and policy
year but also by premium frequency.

260

Chapter 5 Setting up tables

The first two title columns contain possible combinations of products and premium frequencies, and the title row
contains the policy years. The remaining cells contain the lapse rates.
Generic table indexed by variable names example
The following table format generic table contains values for several variables.

The value given to each of these variables depends on the asset type (ASSET_GRP) and the asset subtype
(ASSET_SUBGRP).
Suppose the definition of the variable INC_FRANK_PC is
READ_GENERIC_TABLE("Asset_Group_Details","Y",ASSET_GRP,
ASSET_SUBGRP, "VAR_NAME")

where ASSET_GRP is assigned a value of 1 and ASSET_SUBGRP is assigned a value of 0. Prophet looks to see
which row contains ASSET_GRP equal to 1 and ASSET_SUBGRP equal to 0 which it finds in row 2. It then takes
the value for INC_FRANK_PC from the intersection of row 2 and the column titled INC_FRANK_PC, column 7.

Generic tables

261

Generic tables - column format


The table for a column format generic table appears similar to the following:

Column format generic tables are a slight variant of the table format generic tables.
You can use a column format generic table when the value or values required for a variable in any of your products
depend on the values of between one and ten index variables.

Index variables for a column format generic table


A column format generic table has a column for each index variable that a particular variable depends on. These
columns contain the possible combinations of values of those index variables. Thus a column format generic table
can contain up to ten of these columns.
In addition, a column format generic table must contain one further column. This column, the final column in the
table, contains the values. During a run Prophet takes the value from this column for the appropriate combination of
index variable values.

262

Chapter 5 Setting up tables

Note: During a run, Prophet determines for itself the format that has been used for each generic table and reads
the values accordingly.

Global files

263

Global files
A global file contains values for variables that have the same value across all products for any run number. For
example, you may choose to use this type of file to specify the renewal expense inflation rate to be used for all of
your products. This type of assumption would not normally vary by product.

Run numbers in a global file


Multiple runs can be constructed by setting up the global file with a number of columns of values. Each column
contains the values to be used for a particular run number. You then specify in the Run Parameters tab of the Run
Setting the run numbers that are to be used in the run.
For example, the use of multiple runs enables sensitivity runs which quantify the effect of changing particular
assumptions to be performed in a single process.
You can think of run numbers as identifying alternative scenarios which you want to evaluate.
You can use the Sort option from the Table tab to rearrange the columns so that run numbers are in ascending
order.
You can give each run number a description by choosing Descriptions in the Options dialog box which is
accessed from the Prophet menu.. See "Describing run numbers and sub-products".

Global file definitions


If any of your products have any variables with a global definition, you must create a global file for Prophet to read
the values to be used in each run. Prophet will also read values from a global file for variables with formula
definitions which include any of the following:
n

A READ_GLOBAL function, for example:


READ_GLOBAL("VAR_NAME")
READ_GLOBAL("RE_FIXED_Y")

Note: You can use any text string within the READ_GLOBAL function to read a value from a global file, provided
that it conforms to the rules for a variable name. If "VAR_NAME" is entered, Prophet uses the name of the

264

Chapter 5 Setting up tables

variable in which the function is included.


n

A READ_RESULTS function where the fourth argument is "VAR_NAME" and the sixth argument is "G", for
example:
READ_RESULTS("GLOBAL_T",0,"P","VAR_NAME",NUMBER,"G","Y")

A READ_RESULTS function where the variable is named in the fourth argument and the sixth argument is "G",
for example:
READ_RESULTS("GLOBAL_T",0,"P","FII_PC",NUMBER,"G","Y")

There is an equivalent READ_GLOBAL_TEXT function that should be used when reading text strings from global
files, or you can use the READ_RESULTSfunction with data-type parameter specified as TEXT.

Inserting variable names in a global file


When you create a global file you can use Initialise in the New Table dialog box to insert the variable names for the
variables that have global definitions in your chosen products automatically. See "Initialisation of a table" .
If the products do not exist when you create the file, you can create a blank file and then insert the variable names
yourself. You can use Add Variables in the Table tab at any stage to add any missing variables with global
definitions that exist in selected products.

Naming and using a global file


The default name for a global file is GLOBAL and we recommend that you use .FAC for its file name extension. You
may only include one global file in any one run and identify the particular file to be used in the Tables tab of the run
setting used for the run.

Model point files

265

Model point files


The window for a model point file appears similar to the following:

Model point files contain values for variables with model point definitions. This is typically policy data. A model point
can represent an individual policy or a group of policies.
You generally create model point files using the Table Editor when you require data with which to test your product
calculations. We recommend that you use the Data Conversion System (DCS) to create model point files from
extracts of your company's actual policy data.

Model point definitions in a model point file


If any of your products have one or more variables with a model point definition, you must create a model point file
for each of those products. Thus, almost every liability and asset product needs a model point file.

266

Chapter 5 Setting up tables

When you run a product, Prophet determines the values for the variables with model point definitions by reading
them from the model point file. The calculations are made independently for each model point (unless you use
extended formulas to retain values between model points) and are then summed for each sub-product.

Sub-product codes in a model point file


Each row in the model point file defines a single model point. It consists of a sub-product code (SPCODE) and
values for each of the variables with model point definitions.
n

The lower number sub-product codes are normally used for existing business and the higher number subproduct codes for profiles for future new business. For example, you could use numbers 1 to 50 for existing
business and numbers 51 to 9999 for future new business. You set the delimiting value between these ranges
in the structure.

Sub-product codes must be in ascending order before you can use a model point file in a run. You can use the
Sort option from the Table tab to do this automatically.

Sub-Product code descriptions


You can also add descriptions to the sub-product codes that apply to all products in the workspace by entering
them into the Sub-Products tab of the Descriptions dialog. To display the dialog:
n

Click the Prophet button and from the menu click Options.

From the Options dialog choose Descriptions.

For more details refer to "Describing run numbers and sub-products" in the "Prophet options" chapter of this
manual.

Inserting variable names in a model point file


When you create a model point file, you can use Initialise in the NewTable dialog box to insert the variable names
for the variables that have model point definitions in your product automatically. See "Initialisation of a table" .
If the product does not exist when you create the file, you can create a blank file and then insert the variable names
yourself. You can use Update at any stage to add any missing variables with model point definitions that exist in the
corresponding product.

Model point files

267

Naming and using model point files


Each model point file must have the same six character name as its associated product. It is also recommended that
you use the file extension of .RPT but you can specify your own file extension in the Tables tab of the run setting
where you can also specify the location of the model point files.

268

Chapter 5 Setting up tables

Mortality tables
Mortality tables contain mortality rates by age and follow these conventions:
n

They must have three or more columns: the first and last columns must contain the ages and the columns in
between must contain the mortality rates.

If mortality rates are not available at particular ages for select tables, for example because the maximum age for
select rates has been exceeded, then those cells must contain a zero.

Naming and saving mortality tables


A mortality table can have any name but it must be the same name as specified for the variables set up to read it in
your products. We recommend that you use a name which clearly identifies it.
The Table Editor saves mortality tables in specified table locations for the workspace. If you want any mortality
tables you set up to be used by all your workspaces then use Windows Explorer to copy them to the MORT subfolder of the application data folder. For example:
C:\Documents and Settings\All Users\Application Data\SunGard\Prophet80\Mort
Note: The location of the mortality tables is specified when the application is first installed. To inspect the
location choose Worker in the Options dialog box and select the Tables tab of the displayed Worker dialog
box.

Parameter files

269

Parameter files
Parameter files contain values for variables that have the same value across all model points for any product. For
example you may choose to use this type of file to specify the annual renewal expense per policy to be used for
each of your products. This type of assumption normally varies from product to product but is the same for every
model point within a product.

Parameter file definitions


If any of your products have any variables with a parameter definition, you must create a parameter file for Prophet
to read the values to be used. Prophet will also read values from parameter files for variables with formula
definitions which include any of the following:
n

A READ_PARAMETER function, for example:


READ_PARAMETER("VAR_NAME")
READ_PARAMETER("RE_FIXED_Y")

Note: You can use any text string within the READ_PARAMETER function to read a value from a parameter file,
provided that it conforms to the rules for a variable name. If "VAR_NAME" is entered, Prophet uses the name of
the variable in which the function is included.
n

A READ_RESULTS function where the fourth argument is "VAR_NAME" and the sixth argument is "P", for
example:
READ_RESULTS("GLOBAL_T",0,"P","VAR_NAME",NUMBER,"P","Y")

A READ_RESULTS function where the variable is named in the fourth argument and the sixth argument is "P",
for example:
READ_RESULTS("GLOBAL_T",0,"P","REVBON_SA_PC",NUMBER,"P","Y")

There is an equivalent READ_PARAMETER_TEXT function that should be used when reading text strings from
parameter files, or you can use the READ_RESULTSfunction with data-type parameter specified as TEXT.

270

Chapter 5 Setting up tables

Inserting product and variable names in a parameter file


When you create a parameter file you can use Initialise in the New Table dialog box to insert the variable names for
variables that have parameter definitions in your chosen products automatically. See "Initialisation of a table" .
If the products do not exist when you create the file, you can create a blank file and then insert the product names
and variable names yourself. You can use Add Products or Add Variables from the Table tab at any stage to add
further products and the variable names for their variables with parameter definitions. You can also use Add
Variables from the Table tab to add any missing variable names for variables with parameter definitions for the
products included in the file.
You can use the Sort option in the Table tab to rearrange the rows so that the product names are in ascending
order.

Naming and using parameter files


The default name for a parameter file is PARAMET and it is recommend that you use .FAC for its file name
extension. You identify the particular file to be used in the Tables tab of the Run Setting used for the run.
You may include several parameter files in a run. For this purpose you need to name the parameter files so that
they can be identified using a wildcard expression. For example:
TABLES\PARAM_*.FAC

With this expression, Prophet uses all the parameter files in the TABLES folder with names which start PARAM_
and have a file name extension of .FAC.

Sales files

271

Sales files
A Sales file allows you to specify the volumes of future new business to be assumed in each month of your financial
projection. You can create this file using the Table Editor or the Microsoft Excel based Sales Generator supplied as
part of Prophet.
Values of new business for each product and sub-product must be specified monthly or annually.

Naming and saving sales files


A sales file can have any name but it must be the same name as specified in the Tables tab of the Run Setting used
for the run.

Sales File properties


The Properties dialog box has the following tabs:
n

General tab

Statistics tab

The General tab allows you to enter a description for the table, the Start month and Year for the projected data and
the projected period of business in months. You can also specify the number of Products or Sub Products for which
you wish to enter data for the specified period of business.
The Statistics tab displays additional information about the table. It is maintained by Prophet and cannot be
manually updated.

272

Chapter 5 Setting up tables

Segment table
A segment table is a generic table with a file extension of .seg.fac so that it can be displayed alongside other tables
in the Model Point Files folder of the tables tree pane. This type of table is mainly used by the ALS library.
A typical segment table appears similar to the following:

The first column contains the segment number with the remaining columns containing the variables with their
related values for each segment.

Stochastic tables

273

Stochastic tables
A stochastic table contains assumptions that vary by simulation. Prophet can use stochastic data saved either in a
generic file format (.FAC) or in a binary file format (.FAS). The binary file format is the preferred format for stochastic
runs as it is faster to read than a standard generic table and therefore reduces run times.
Binary Stochastic files (.FAS) can be created as text based comma separated files (.FAC) and converted using the
Stochastic File Converter utility to (.FAS) files.
Note the following:
n

To extract data from a binary stochastic file (.FAS) use the READ_STOCH_TABLE function in your formulas. To
extract data from a comma delimited text stochastic file. (.FAC) use the READ_GENERIC_TABLE function in
your formulas.

The first variable in a stochastic table must be the simulation number. It can have a name of SIMULATION, SIM
or, in the case of a text based simulation file, it can be SCENARIO.

The number of rows for each simulation number must be the same. For example, if there are 20 rows for
simulation 1 then there must also be 20 rows for simulation 2, 20 rows for simulation 3 and so on.

Stochastic binary (FAS) files now support varying time intervals between the points covered by the file. For
example a FAS file can be produced, using the FacStoConvertor utility located in the bin32 or bin64 folder of the
Prophet Worker, that starts with monthly steps, then quarterly steps and finally annual steps for the rest of time
period covered by the FAS file.

A FAC file is a comma delimited text file and appears similar to the following:
!4,SIM,VAR_NAME,ASSET,2000,2001,2002,2003,2004
*, 1,EXP,PENS,2,0,1,2,4
*, 1,EXP,LIFE,7,1,4,3,1
*, 2,EXP,PENS,3,1,4,1,6
*, 2,EXP,LIFE,6,4,6,2,1

For information on the text based stochastic file format (.FAC) see Stochastic file (.FAC) format in Help.

274

Chapter 5 Setting up tables

Stochastic File Convertor utility


The Stochastic File Convertor converts comma delimited stochastic simulation data saved as a text file (.FAC) to a
binary file (.FAS) that can be used by Prophet. The convertor can be run either from the Prophet Professional
interface or from the command line.
To run the convertor in Prophet:
n

Navigate to the location of the .FAC tables in the Tables. Model Point & Excel Files pane.

From the Tables tree, navigate to and select the .FAC file to be converted.

From the Object tab click Fac To Stochastic Convertor.

The convertor appears similar to the following:

The selected .FAC file is shown in the Input File Name text box with the name of the proposed output.FAS file
entered in the Output File Name text box.
Check the name and location of the output file and when satisfied click Convert to start the conversion process.

Stochastic File Convertor utility

275

The progress of the conversion process, together with any error messages, is displayed in the Output Messages
pane.
Running from the command line or from a batch file
In addition to running the convertor from within Prophet you can also initiate the conversion process from the
command line or from a batch file. The syntax for calling the utility is:
FacStoConverter.exe

FacFileName FASFileName

where:
FacFileName is the location and name of the input comma delimited FAC file. If specified, FASFileName points to
the location and name of the converted output file.
Note the following:
n

The input file must be a comma delimited text file (.FAC) containing the stochastic simulation data. The file
format of the file is described in the Stochastic file (.FAC) format section in Help.

The command line version of the convertor (FacStoConverter.exe), is located in either the bin32 or bin64
folder of the Prophet Worker installation.

If the the .FAS filename is not specified when using the command line version of the convertor, then the
convertor opens the .FAC file, creates a binary .FAS file and saves the new file with the same name but with a
.FAS extension in the same location as the source file.

The convertor is able to convert exceptionally large FAC files of more than 2 Gbytes into .FAS format.

276

Chapter 5 Setting up tables

Table of Tables
The Table of Tables allows you to specify the location and names of tables using another table. A typical tables of
tables appears similar to the following:

The table is a specific type of generic table that has the following columns:
n

Product Name
This column lists the names of the products each of which has a corresponding table in the Run Number
columns.
You can enter the name of a specific product or use the standard wildcard characters (* ?) to specify a group or
range of products. To specify a range or group of products the wildcard characters must be added at the partial
product name. For example, C* will read C_WEND

Name
This column contains an identifier that can be a standard Prophet variable, local extended formula variable or
identifier. The name is also used as a parameter by the READ_TABLE_NAME function. The Product name and
run number are determined by the run pair.

Populating the table


You can populate the table with the names of products that use the READ_TABLE_NAME function.

Table of Tables

277

To populate the Table of Tables:


n

Create or open a Table of Tables.

From the Table tab, click Add products.

From the "Select products from which to read variable names" dialog. choose the products you wish to scan for
the existence of the READ_TABLE_NAME function.

When you click OK, the selected products are scanned for the existence of the READ_TABLE_NAME function. If
a match is found, the name of the product and the associated table name are added to a table row.

If, at a later date, additional products using the READ_TABLE_NAME function are created then you can update and
re-populate the table using the Add Products option from the Table tab.
Note the following:
n

The name and location for the Table of Table is specified in the Tables tab of a Run Setting.

Diagram View can also display the Table of Table and the table it reads as separate entities.

278

Chapter 5 Setting up tables

Unit Prices files


Unit prices files contain the price, price code, price description and price type for each unit type to which products
can be linked.
You need to use a unit prices file if you are performing a run for a unit linked product where the initial numbers of
units held for each unit fund are stored in the model point file. Unit prices files can also be used by Prophet's Data
Conversion System. For more information see the Unit Linked library manual.

Naming and using unit prices files


A unit prices file can have any name. However, it is recommend that you use .FAC for its file name extension. You
may include only one unit prices file in any one run and you identify the particular file to be used in the Tables tab of
the Run Setting used for the run.

Year dependent mortality tables

279

Year dependent mortality tables


Year dependent mortality tables contain mortality rates which vary by both current age and calendar year. For
example, they are used for AIDS mortality rates and for annuitant mortality rates which are assumed to improve in
the future.
All year dependent mortality tables follow these conventions:
n

The ages in the first column must start at 0.

The first column must contain the ages. The subsequent columns must contain the year dependent mortality
rates using one column for each year.

The first row must contain the years.

Naming and saving year dependent mortality tables


A year dependent mortality table can have any name but it must be the same name as specified for the variables
set up to read it in your products. We recommend that you use a name which clearly identifies it.
The Table Editor can only save year dependent mortality tables in the specified table locations for the workspace.
However, if you want to allow any year dependent mortality tables you set up to be used by all your workspaces,
you should use Windows Explorer or a similar tool to copy them to the MORT sub-folder of the application data
location. For example:
C:\Documents and Setting\All Users\Application Data\SunGard\Prophet80\Mort

280

Chapter 5 Setting up tables

Year index tables


Year index tables are primarily used for values that vary by calendar year. However, they can also be used for
values that vary by age, such as premium rates. Year index tables should follow these conventions:
n

They must contain two columns: the first column contains the years, the second column contains the values for
the years in the first column.

The years in the first column must be in sequential order and be less than 32768.

The values in the second column can contain any number of digits but must include a decimal point.

Naming and saving year index tables


A year index table can have any name but it must be the same name as specified for the variables set up to read it
in your products. You specify the location of the particular tables to be used in a run in the Tables tab of the Run
Setting used for the run.

Managing tables and model point files

281

Managing tables and model point files


Tables and model point files are mainly managed using the tree displayed in the Tables, Model Point & Excel Files
pane. Different options are available depending on the item selected in the tree.
Managing tables in a folder
Selecting and right clicking the Tables folder (or sub folder)displays the following context menu:

Options from this menu include:


n

New Table - This enables a new Table to be created. See "Creating a table" .

Group By - This enables the Tables folder to be grouped by Path, Extension, TableType or TableCategory.
Alternatively, no grouping of the Tables is also available.

282

Chapter 5 Setting up tables

Sort options - The Tables in the folder can be sorted in ascending or descending order.

Show List of Tables - Choose this option to display all Tables as a list in the Tables tab of the main work area.

Table options
Selecting and right clicking a table in the tree displays the following context menu:Selecting and right clicking a
table in the tree displays a menu from which you can choose a range of options. A typical right click menu appears
as follows:

You can also select more than one table in the tree using the Ctrl+click method and choose an option from the right
click menu. Options include the ability to open, delete, duplicate, rename and view properties of a table.
Tables page list view
In addition to displaying the tables using the tree display you can also manage tables in the workspace from the
Tables Page list view which is displayed in the main window.
To display the Tables page list view:

Managing tables and model point files

In the Tables, Model Point & Excel Files pane, if required, expand the Tables folder.

Select the Table folder (or sub folder) and from the right click menu choose Show List of Tables.

The Tables Page list view is displayed in the main window similar to the following:

283

From the Tables page list view you can select one or more tables and select options from the Home tab. The tables
are typically listed by their properties with the list being sorted by clicking a column header.
Note the following:
n

To display model point files in a page list view select a model point file or folder in the tables tree and from the
right click menu choose Show List of Model Point files.

To restore a Page List from a grouped list, right click on any table in the list and from the right click menu choose
the Grouped by <none> option.

284

Chapter 5 Setting up tables

Printing tables and model point files


You can print a list of the tables or the details for one or more selected tables displayed in the Tables list. Similarly,
you can also print a list of the model point files or the details for one or more selected files displayed in the Model
Point Files list.
To print a list of tables or model point files:
n

Select a table or model point files listed in the Tables, Model Point & Excel Files pane and from the right click
menu choose Show List of Tables or Show List of Model Point files as appropriate.

From the appropriate list of tables or model point files select one or more tables or model point files whose
details or list you wish to print.

Click the Prophet button and from the menu click Print to display the Print Tables dialog box or Print Model
Point Files dialog box as appropriate.
A typical Print Tables dialog box appears similar to the following:

You can choose to print:


n

The list of tables displayed in the List, or

The content of the tables selected in the list

Printing tables and model point files

285

You can also prevent audit information from being printed by selecting Suppress Audit Information and specify the
printer and its settings to be used by clicking Print setup.
To print the list of tables or a selected tables click OK.
In all cases you can also print the details of a table or model point file from within the Table Editor.

Printing tables from within the Table Editor


To print details of a table click the Prophet button and from the menu click Print. The Print dialog box appears from
which you can:
n

Set the settings for the printed page by clicking Page Setup

Set up the printer to be used for printing the table by clicking Print Setup.

Different options are available depending on the Table Editor in use.


To print the table, set and select the print options and click OK.

Page setup in the Table Editor


You can specify the Page Setup to be used for printing each table separately.
To specify the Page Setup for a table:
n

Open the table

Click the Prophet button and from the menu click Page Setup

Alternatively,
n

Open the table

Click the Prophet button and from the menu click Print

From the print dialog box click Page Setup

In the Page setup dialog box enter the settings that you require and click OK.

286

Chapter 5 Setting up tables

Note: If you click Default in the Page setup dialog box then the values that are entered become the standard
values for any tables that you subsequently print.

287

C H A P T E R

Running products

TOPICS IN THIS CHAPTER


What is involved in running products?

288

Setting up a run for one or more products

289

Running one or more products

298

288

Chapter 6 Running products

What is involved in running products?


To run one or more products you need a structure in which the product(s) are specified together with any
accumulations and a run setting that specifies the type of calculations to be run, the tables to be used and other
related settings.
In particular, you need to ensure that the following has been specified prior to running the product(s):
n

The product(s) must be specified

The files and tables to be used by the product(s) must be set up

A structure must be created that specifies which products and any accumulations are run.

A calculation run setting must be created that specifies parameters for the run, such as the start date, the run
number(s) and tables to be used

When the above is specified you can select one or more products from the Products & Accumulations pane or from
the Products pane list view and click Run from the Home tab.
After the product or products are successfully run you can display the calculated results and produce reports.
Note: For information on setting up and running structures see "Structures" and "Runs" .

Setting up a run for one or more products

289

Setting up a run for one or more products


The basic procedure for running one or more products is the same and consists of:
n

Choosing one or more products from either the Products & Accumulations pane or the Products pane list view
and clicking Run from the Home tab

Selecting a structure for the product(s). Note that selected structure must contain the products that are to be run

Selecting a run setting

When the product(s) are successfully run you can display the results.
Each of these is further described in the following sections.

Choosing a structure for a product run


To run one or products you must first assign a structure so that Prophet knows which products and any
accumulations are to be run.
In the Structures and Run Settings pane select and double click the structure you wish to use to run the product.
Alternatively, create a new structure by clicking the down arrow on the New button of the Home tab and choosing
New Structure from the menu.

290

Chapter 6 Running products

Up to 3 tabs are used to specify the structure:


n

Products/Accumulations tab
Items in this tab allow you to select products and accumulations. Note that these have no effect when a single
product is run.

Configuration tab
Items from this tab allow you to specify the calculated variables and the type of new business method to be
used.
If you are developing and testing a product you should initially choose the cross-multiplication method and
should leave the other entries with their default settings. New business profile results will then be generated for
any new business model points.
If you plan to use the Project new business method you should only switch over to using it when you are happy
with the new business profile calculations being made. This is because the Project new business method only
stores the results for the aggregate new business. In contrast, the cross-multiplication method also allows you to

Setting up a run for one or more products

291

inspect the results for the new business profile model points.
A number of optional runtime profiling options are also available from this tab when you click Advanced.
n

Dynamic tab
This tab specifies the dynamic period for each level number and the sub-product substitution rules. Items in this
tab are only available if the Prophet Dynamic and Stochastic module is licensed.

Refer to "Managing structures" for further information on how to create and maintain structures.

292

Chapter 6 Running products

Choosing a run setting for a product run


To run one or more products you must specify a run setting so that Prophet knows how the product(s) should be
run.
In the Structures and Run Settings pane select and double click the run setting you wish to use to run the product
(s).
Alternatively, create a new run setting by clicking the down arrow on the New button of the Home tab and choosing
New Run Setting from the menu. When prompted, choose "Calculation Run" to create a new calculation run setting.
A typical Run Setting dialog box appears as:

Note: For details on a grouping run setting see Setting up a grouping run setting in the Data Grouping chapter
of the Developer Guide.

Setting up a run for one or more products

In the case of a calculation run, the run setting dialog box has the following tabs that allow you to specify the
settings for a calculation run.

293

294

Chapter 6 Running products

Run settings - Run Parameters tab


The Run Parameters tab contains items such as the start date, the period of the run and the type of run.
Enter the appropriate Company Year End Month and a Start Date consistent with any existing business model
points you are using.
To be able to display all the calculations for a model point representing future new business choose a Future
Accumulation Period at least one year greater than the maximum policy term.
To aid in debugging the calculations it is a good idea initially to select the option to only run the first model point for
each sub-product code.

You also enter the run numbers to be used for the run in the Run Numbers textbox. Alternatively, click

to select

the run numbers you wish from a pre-defined list. Make sure though that the global file you use includes values for
those run numbers.
Note: You can assign a description to each run number by selecting the Descriptions option in the Options
dialog box which is accessed from the Prophet menu. See "Describing run numbers and sub-products" .
If you are developing and testing a single product you can normally ignore all the other options on this tab.
Advanced dialog box settings
A number of advanced options are available from the Run Parameters tab when you click Advanced. They are:
n

Batch Programs tab


This tab allows any programs to be executed in the run to be specified. If you are developing and testing a
single Prophet product you can normally ignore the options on this tab.

Run Process tab


This tab allows you to specify options that allow you to: specify the order in which the products in a structure are
run, set the seed values for stochastic runs and apply options for creating and deleting files.

Setting up a run for one or more products

295

Run settings - Tables tab


The Tables tab allows you to select the files and table locations to be used for the run.

You should enter the locations and file names for the tables you want to be used by the product at run time.
For each type of file and table you can either enter the location or click Browse to locate the file or folder. To
change the entries for the file and table locations back to their default settings click Default. To check that all files
and locations exist click Validate. Unit prices files are rarely used in a run so you can normally leave this field blank.

Note: Refer to "Managing tables" for further information on tables.

296

Chapter 6 Running products

Run settings - Results tab


The Results tab allows you to specify the types of results to be created in the run.
If you are developing and testing a product you should check the box to create Projections/NB Profile results and
choose to retain All Variables in Results Files.
All the other settings on this tab can normally be ignored if you are developing and testing a single product and
should be left with their default settings.

Setting up a run for one or more products

Run settings - Runtime Configuration tab


The settings in the Runtime Configuration tab are duplicated in the Run Pairings dialog box which is displayed
when you click Run to run a run setting or a structure.

If you are developing and testing a single product you can normally accept the default options on this tab.
Refer to "Run Settings" for further information on how to create and maintain run settings.

297

298

Chapter 6 Running products

Running one or more products


To run one or more products select them in the Products & Accumulations pane and from the Home tab click Run.
The Run Product dialog box appears similar to the following:

Choose the structure from the dropdown list that you want to use for the run. Note that only structures containing
the selected product or products to be run are available from the list.

Similarly, choose the run setting you want to use from the dropdown list.

Click OK to start the run

You can view the results of the run from the Results & RunLogs pane. See "Displaying results".
Note: The preferred option when running a large number of products is to set up a structure that contains the
products to be run and then run that structure. .

For more information on setting up and running structures see "Structures" and "Runs".

What happens during a product run?


During a run of a product the following processing takes place:
n

Prophet first exports the necessary files to the Prophet Worker and then passes control to the Run Monitor which
displays the progress of the run in the Run Pairs tab..

The run identifier number is increased by 1 until it reads 999 when it is reset to 1.

Running one or more products

299

The run identifier enables you to keep track of the runs made in each workspace and to link each set of results
with the run log used to produce them.
n

Prophet checks the product to see whether it has been opened and saved since the previous run, or if the
regenerate or auto-scan options have been used on it. If you have performed any of these functions, the product
is re-generated and recompiled. To do this Prophet searches through the library for all the core variables that
match the indicators selected for the product and brings these and their appropriate definitions into the
calculations, together with the definitions saved with the product for each of the input variables.

Prophet then determines all the dependencies between the variables and hence determines the order of
calculation for the variables. Prophet then generates C code from the formulas and other definitions, which is
then compiled.

If the product has not been changed, the compiled code from the previous run is used.

The calculations are then carried out and results produced for the appropriate run number(s) and appropriate
types of results. The calculations are performed independently for every model point and the results are
summed together. The results are stored separately for each sub-product as well as being totalled for each
product.

If Projection / NB Profile results are requested in the run setting, those model points with sub-products that
represent existing business create projection results. Those model points with sub-products that represent
future new business create new business profile results provided that the cross-multiplication method is
specified in the run setting. They create projection results if the Project New Business Method is being used.

If unit numbers processing is required, this is done immediately before the calculations for each model point. For
more information see the section "Unit numbers processing" in the "Runs" chapter of this manual.

If a Sales file is included in the structure, and the new business cross-multiplication method is being used, this
process is run at the end.

Information displayed in the Run Pairs tab of the Run Monitor is written to the run log.

If any errors occur during the calculations an error log for the product is created.

300

Chapter 6 Running products

Stopping a product run


If you need to stop the processing of the product before it has been completed click Cancel in the Run Monitor.
When prompted, click Yes to stop the run.

Note that there may be a short delay before this dialog appears.
You can choose to do any of the following from the Run Monitor:
n

View any generated run logs in the Results Viewer by clicking Run Log

Modify the settings for the Run Monitor from the Run Monitor Settings dialog which is displayed when you click
Settings.

Dismiss the Run Monitor by clicking Close

Viewing the results of a run


When a run for a product has been completed you can:
n

To display the results


In the Results & Runlogs pane select and double click the results that were generated by the run. See
"Displaying results" .

To display the formulas for the product


In the Products & Accumulations pane select the product that was run and from the Home tab click Open and
from the menu choose Results Diagram. From the Results Diagram View you will be able to display the

Running one or more products

301

formulas for the product, their dependencies and the associated results produced by the run. See Diagram view
for more information.
n

To display the runlog


In the Results & Runlogs pane select and double click the run log that was generated and which contains
details of the activity that occurred during the run. The selected run log will be displayed in the Results Viewer in
which you will be able to analyse the generated logs as specified in the Run Log Settings section of the Options
dialog. For information on the Results Viewer see Results Viewer in the Results chapter of the User Guide.
Note: Runlogs generated in Prophet Release 8 and later can only be viewed using the Results Viewer.
Runlogs created using an earlier version of Prophet are displayed in the main interface.

302

303

C H A P T E R

Displaying results

TOPICS IN THIS CHAPTER


How are results displayed?

304

Sets of results displayed in a Results window

306

Formatting results in a Results window

308

Copying results in a Results window

310

Printing results in a Results window

311

304

Chapter 7 Displaying results

How are results displayed?


The results generated from a product run are saved in the appropriate sub folders of the workspace. To display the
results select and double click the results in the Results & Runlogs pane. They are displayed in the main window
similar to the following:

Tabbed sections allow you to display:


n

Values for time dependent variables

Constants and other non time dependent values

Audit information

You can choose which results to display by selecting items from the drop down list boxes in the header.
The variables for which values are displayed are selected by choosing the appropriate Variable Group in the
Category and Name dropdown lists. The time periods for which values are displayed are specified by clicking
Time Periods. You can change the set of results displayed by using the dropdown lists to the left of the header.

How are results displayed?

305

Hide Header / Unhide Header


To display more values on the screen you can hide the Results window header by selecting any value in the results
window and choosing Hide Header from the right click menu or show the header again by choosing Unhide
Header. Alternatively you can click the arrow on the divider.

306

Chapter 7 Displaying results

Sets of results displayed in a Results window


The values displayed in the Values and Constants tabs of a Results window are for a single set of results. You
choose a set of results by selecting the following items:
n

Run number

Product (or accumulation)

Sub-product - This must be 0 for accumulations

Type of results. You can choose between:

Projection

NB (New Business) Profile

Valuation - Maturity Year

Valuation - Current Age

Unit Numbers

Stochastic and a simulation number.

The types of results available depend on the results specified to be produced in the run setting used for the run:
n

Projection and NB Profile results contain accumulated values for the time span specified in the run setting.

NB Profile results are only produced if the cross-multiplication approach for new business is used.

If Valuation results are specified to be produced, the results contain accumulated values at the projection start
date either by maturity year or current age, depending on how the product calculations are specified.

Unit Numbers results are produced if unit numbers processing takes place for any product.

As soon as you select a different set of results the tabs are updated with information for those results. If the results
do not exist for the combination of entries that you have selected the tabs will be blank.

Sets of results displayed in a Results window

307

Note: For more information on the types of results see the "Results" chapter of this manual.

Variable groups displayed in a Results window


Variable groups provide a convenient way to displaying and reporting associated variables. For example, all the
variables which together form a revenue account are included in a single variable group.
To select a variable group in a Results window:
n

Select a Variable Group Category from the dropdown list in the header. Three additional options in this list
allow you to select All Variables, Cumulative Variables or Key Output Variables.

Then select the required Variable Group from the Name dropdown list. Variable Groups are supplied with the
standard libraries for the main types of results displays you may require.

This option has no effect on Unit Numbers results.


Note: If you want to create a new Variable Group or to change an existing one choose the Variable Groups
setting in the Options dialog which is accessed from the Prophet menu.

308

Chapter 7 Displaying results

Formatting results in a Results window


Options from the right click menu, displayed when you right click on any value in the results window, allow you to
apply a number of formatting options: A typical right click menu appears as :

The following formatting options that can be applied to the results displayed in the Values tab when viewing results
are available:
n

NumberFormat
This displayed the Number Format dialog box and allows you to specify how numbers are displayed in the cells.

Names / Descriptions
Displays the Display of Names and Descriptions dialog box from which you can specify whether the name,
description or both should be displayed for variables. Also whether the variable code should be displayed.

Time Periods
Displays the Time Periods dialog box from which you can change the periods for which results are displayed.

Suppress Zeros
Displays the Suppress Zeros dialog box that allows you to to suppress variables with zero values either for all
the currently selected time periods or for all the time periods.

Formatting results in a Results window

309

Alignment
Displays the alignment dialog box that allows you to specify the alignment of the entries in the top border, left
border and value cells.

Column Width
Displays the Column Width dialog box from which you can specify either a fixed or variable width setting to be
applied to the columns of results.

310

Chapter 7 Displaying results

Copying results in a Results window


You can copy a number of cells or the entire grid of values in the Values tab of a Results window to the Windows
clipboard as follows:
n

Use the Copy option from the right click menu to copy a selected range of cells to the Windows clipboard

Use the Copy Grid option from the right click menu to copy the entire grid of values including the top and left
borders to the Windows clipboard

You can also use the Copy to Excel option from the right click menu to copy the entire grid of values to an open
Microsoft Excel.

Printing results in a Results window

311

Printing results in a Results window


You can print the results displayed in any Results window. At the same time you can print a product listing showing
the indicators and input variables for the product. When you choose Print from the Prophet menu the following Print
Results dialog box is displayed:

Choose the items that you wish to print and click OK. To see what is to be printed click Preview.

312

313

C H A P T E R

Diagram view

TOPICS IN THIS CHAPTER


What is Diagram view?

314

About Diagram view

315

Working in Diagram view

321

Displaying public variable members

333

Diagram view settings

335

314

Chapter 8 Diagram view

What is Diagram view?


Diagram view allows you to display the relationships between variables in any product as a diagram. You can also
follow the calculations in a product, debug the values used in a product and filter the view by particular variables.
For this purpose it is usually best to set up test data in the model point files and only to include one model point for
each sub-product. Hence, the values that are displayed are only those calculated for a single model point.
You use Diagram view to display:
n

The variables in the product and their dependencies

The definitions specified for the variables in the product

The results of the calculations for each of the variables stored in the results

There are two main ways of using Diagram view:


n

To look at the results that have been calculated in a run in conjunction with the definitions of the variables that
caused those results to be produced.

To edit a product so that as soon as you make a change to a definition you can see the changed dependencies
between the variables in the product. Note that this functionality is only available in Prophet Professional.

The functionality that Diagram view provides is similar in both cases, except that when you are using it to edit a
product you have various buttons and menu options that allow you to edit the definitions and tables used in the
product.
Diagram view is particularly useful when testing and debugging calculations. For this purpose it is usually best to
set up a run setting so that values for all the variables in the product are stored in the results, to set up test data in
the model point file and only to include one model point for each sub-product. Hence, the values that are displayed
at any one time are only those calculated for a single model point.

About Diagram view

315

About Diagram view


Opening a product in Diagram view displays the inter dependencies between variables in the product. If a set of
results is opened in Diagram view for a product, then a set of panes is displayed at the bottom of the window
containing the results. Typically, a set of results opened in Diagram view for a product appears as:

You can switch between tree view and list view using the Listview toggle on the ribbon. You can adjust the size of
any pane by dragging its borders.

Top panes
The top panes are:
n

The root pane


This is the top leftmost pane and displays the variables on which the currently selected variable depends. You

316

Chapter 8 Diagram view

can use the drop-down box to select a variable. This will filter the diagram so that it displays only variables
which depend on it.
n

The dependencies pane


This is the centre pane and displays the relationship between the currently selected variable and the other
variables in the product

The branch pane


This is the top rightmost pane and is similar to the tree root pane. It displays the variables which depend on the
currently selected variable. You can use the drop-down box to select a variable. This will filter the diagram so
that it displays only variables on which the selected variable depends.

Centre pane
The centre pane displays the definition of the current variable over which the mouse pointer is placed.

Bottom panes
The lowermost panes display results information if a product has been run. The lowermost three panes are:
n

The left results pane


This pane displays the values for the time-dependent variables on which the current variable directly depends.

The centre results pane


This pane displays the results for the currently selected variable.

The right results pane


This pane displays the values for the time-dependent variables that directly depend on the current variable.

Note that these panes are not present if a product is opened directly.
In addition to the right-click menu options, a separate Diagram tab is displayed that allows you to:
n

Adjust the time periods for which results are displayed

Move backwards or forwards through the history of the variables that you have selected.

About Diagram view

317

For more information on the Diagram tab see Working in Diagram view on page321.

Editing variable definitions from within Diagram view


Definitions for all input variables can also be specified and edited from within Diagram view provided that you
opened Diagram view while in an open product. Input variables are by default shown in red and core variables in
black.
To customise the look of Diagram view, right-click Diagram view and on the menu click Diagram Options. You can
also access this option from the Customize GUI section of the Options dialog box (which is accessed from the
Prophet menu).
To edit or specify the definition for a selected variable
You can only edit or specify the definition for a selected variable when you open a product without its results in
Diagram view. To edit the selected variable:
n

In any of the top three panes in Diagram view right-click a variable and on the menu click Open.
OR
Select the variable and on the Home tab point to Open and then click Open Variable.

Editing variable properties from within Diagram view


Some of the properties of a variable selected from within Diagram view can be updated provided that you opened
Diagram view while in an open product. Input variables are by default shown in red and core variables in black.
You can customise the look of Diagram view by right-clicking on Diagram view and choosing Diagram Options
from the right-click menu. You can also access this option from the Customize GUI section of the Options dialog
box (which is accessed from the Prophet menu).
To edit or view the properties for a selected variable:
You can only edit or view the properties for a selected variable when you open a product without its results in
Diagram view. To edit or view the selected variable properties:
n

In any of the top three panes, right-click a variable and on the menu click Variable Properties. The Variable
Properties dialog box for the selected variable is displayed. You can inspect or edit the properties as required.

318

Chapter 8 Diagram view

Dependencies pane in Diagram view


The dependencies pane displays the relationship between the current variable and other variables in the product.
When you point to a variable its name and definition are displayed in the variable definition pane.

Click on a variable in the dependencies pane to make it the current variable. Diagram view changes the display
accordingly.

About Diagram view

319

List/Tree Panes in Diagram view


The top panes in diagram view can be viewed as either trees or lists. You can toggle between these views using
the Listview button on the Diagram tab.
The root pane displays the variables on which the currently selected variable depends. The currently selected
variable appears at the top of the tree or list which appears similar to the following:

In tree view, you can expand or contract the tree by clicking the arrows.
You can use the drop-down box to specify a variable. This will filter the diagram to show only variables which
depend on the specified variable.
A similar tree or list is displayed in the branch pane. The difference is that the variables displayed in this pane are
those that depend on the currently selected variable. You can use the drop-down box to filter the diagram to specify
a variable and hence show only variables on which the specified variable depends.
In front of the name of each variable in the tree or list is an icon that identifies the type of definition assigned to a
variable. Also, when you point to a variable in this pane the name and definition of the variable is displayed in the
variable definition pane.

320

Chapter 8 Diagram view

Variable definition pane in Diagram view


When you point to a variable in the root, dependencies or branch panes, its definition is displayed in the variable
definition pane. It appears similar to the following:

This pane provides the following information:


n

The name, description, type and code of the variable

The definition of the variable

The value of the variable, provided you have selected a set of results, the variable is not time-dependent and
the variable's value is stored in the results.

The results panes in Diagram view


The results panes display the values for the current variable, the variables on which it directly depends and the
variables that directly depend on it. It appears similar to the following:

The values are taken from the selected set of results for time-dependent variables, for those variables whose values
are stored in the results.

Working in Diagram view

321

Working in Diagram view


Many of the tasks that can be performed in Diagram view are accessed from the Diagram tab which appears
whenever Diagram view is opened or selected. The tab typically appears as:
Diagram view in Prophet Professional has two modes of operation:
n

Product Diagram view - This is displayed when a product is selected from the Products & Accumulation pane
and Open in Product Diagram view is selected from the right click menu.

Results Diagram view - This is displayed when a product is selected from the Products & Accumulation pane
and Open Results Diagram view is selected from the right click menu.

Options in the Diagram tab are grouped into the following sections
n

View group
This group contains options that customise the way variables are displayed

Diagram group
This group contains options that allow you to select and filter data based on specific items such as products,
variables and run numbers.

Format group
This group contains options that control the appearance of the dispayed data. It also allow you to customise the
environment by providing access to the Diagram view settings.

Variables group
This is a dropdown menu that allows you to select and display specific items such as variables that have links to
tables or are of a specific type such as extended formulas.

322

Chapter 8 Diagram view

General group
This group contains miscellaneous options that allow you to copy data to a Microsoft Excel spreadsheet,
transpose the data displayed in rows and columns and to update the display.

Each of these is further described in the following sections.

View group
This group appears similar to the following:

The options in this group are:


Option

Description

Circular
Dependencies

View only those variables that depend on a particular variable and which are
themselves used by that variable.If you select this option only those variables that both
depend on that variable and are used by it will be displayed. This makes it easier to
carry out this search.

Properties

Displays the Variable Properties dialog box for the selected variable.

Listview

Shows the inward and outward variables in a list view (instead of a hierarchical tree
view).

Filter

If array variable results exist then enter the array dimension into this list to display the
results in the Results pane. For example, to display the results for dimensions 1 to 3,
enter 1-3 to display 3 columns of results, one for each dimension, in the Results pane.

Dynamic Loop

Use this to debug a dynamic run. If Dynamic Debug is selected in the Results tab of a
Run Setting for a dynamic run then this list contains the loop numbers. Otherwise FINAL
is displayed for the dynamic loop.

Working in Diagram view

Option

Description

Dependency Trees

Displays additional trees on either side of the main tree in the centre that display the
dependencies of the displayed variables.

323

324

Chapter 8 Diagram view

Diagram group
This group appears similar to the following:

This group has the following options:


Option

Description

Back

Move backwards through the history of the variables you have selected.

Forward

Move forwards through the history of the variables you have selected.

Product Selection

Choose a different product to display dependencies and results for.

Variable

Change the current variable.

Run Number

Choose a run number to display results for.

Results Format

Displays the format of the results that are displayed.

Sub-Product

Choose a sub-product to display results for.

Results Type

Choose the type of results that you want to display.

Simulation

Choose the simulation number of the results that you want to display.

Working in Diagram view

Format group
This group appears similar to the following:

This group has the following options:


Option

Description

Font

Change the font used to display the information.

Number

Change the format to be used for displaying numbers.

Names / Description

Show array variable index descriptions

Suppress Zeros

Displays the Suppress Zeros dialog box which allows you to either suppress
variables with zero values for all currently selected time periods or for all the time
periods.

Time Periods

Display the Time Periods dialog box from which you can control the way results
appear.

Diagram Options

Displays the settings that allow you to customise Diagram view.

325

326

Chapter 8 Diagram view

Variables group
The Show menu is accessed from the Variables group and appears similar to the following:

Options from the menu allow you to display only those variables that have links to tables or are of a specific type
such as extended formulas.
When an option is selected from the menu the appropriate variables are displayed.
To get back to the previous view click Refresh from the Diagram tab or press F9.

Working in Diagram view

General group
This group appears similar to the following:

This group has the following options:


Option

Description

Copy Grid to
Excel

Copies the results to the clipboard. It then starts Microsoft Excel and loads the contents of the
clipboard into a spreadsheet.

Transpose
Results

Interchanges the results displayed as rows and columns in the results panes.

Refresh

Updates the displayed results.

327

328

Chapter 8 Diagram view

Filters in Diagram view


In Diagram view, the top left pane (root pane) shows all the visible precedents (direct or otherwise) of the central
variable - that is the complete list of variables on which the central variable depends.
Similarly, the top right pane (branch pane) shows all the visible dependents of the central variable that is the
complete list of variables which depend on the central variable.

Filter by Precedent
The filter in the root pane is labelled Filter by Precedent and is shown as a drop-down menu. It allows you to select
from all variables which are precedents of the central variable.

Working in Diagram view

329

Selecting a precedent filter variable restricts the diagram and ribbon to those variables which depend on the filter
variable and which feed into the central variable. The ribbon drop-down for choosing the central variable is also
filtered.

Filter by Dependent
The filter in the branch pane is labelled Filter by Dependent and is shown as a drop-down menu. It allows you to
select from all variables which depend on the central variable.
Selecting a dependent filter variable restricts the diagram and ribbon to those variables which on which the filter
variable depends and which feed out of the central variable. The ribbon drop-down for choosing the central
variable is also filtered.

Dual Filter
With both filters applied, the panes show the variables as expected from the definitions above. The ribbon dropdown for choosing the central variable is filtered to the precedents, dependents and other variables which feed from
the chosen Precedent to the Dependent not via the central variable.
Note the following:
n

When both filters are on and there are circular dependencies, all variables contained in the loop are shown in
the Precedents, Dependents and Ribbon drop-down for the central variable.

You will be able to navigate to any variable which depends on the filtered variable, either by clicking around the
diagram itself, or by selecting from the drop-down. Variables which do not depend on the filtered variable do not
appear in either the diagram or the variable Drop-down in the ribbon.

330

Chapter 8 Diagram view

A simple example of Diagram view Filtering


The simple fictional product TSTDV has the following variable structure and is illustrated in Diagram view for this
example:

Filter by Dependent: Filtering on TABLE_1 with DUR_M as the central variable.

In this case, Diagram view shows all variables on which TABLE_1 depends in the list view, with all non-dependent
variables removed. Variable BRANCH_2_3 also appears in the list because it has a circular dependency with
TABLE_1.
Note: VAR_7, VAR_8 and VAR_9 are filtered from the list.

Working in Diagram view

331

Filter by Precedent: Filtering on VAR_1 with VAR_4 as the central variable.

In this case, Diagram view shows only the loop containing both variables.
Note: DUR_M, VAR_7, VAR_8, VAR_9, BRANCH_1_1, BRANCH_1_2, BRANCH_1_3, and TABLE_1 are
filtered from the list.

Dual filter: Filtering on BRANCH_1_1 and TABLE_1 with BRANCH_1_2 as the central variable:

Diagram view shows only the variable path between BRANCH_1_1 and TABLE_1.
Note: The ribbon central variable drop-down shows all variable paths between the two filtered variables,
irrespective of the central variable. Hence in this case, BRANCH_1_1_1 can be selected in the drop down:

332

Chapter 8 Diagram view

Displaying public variable members

333

Displaying public variable members


Diagram view has the functionality to visually display the public variable members passed between Extended
Formula and Formula variables. Arrow buttons can be selected on the precedent, dependent and central nodes.
Selecting the precedent arrow button populates a list of member variables declared in the precedent Extended
Formula variable, which are referenced by the central Extended Formula variable:

Selecting the dependent arrow button populates a list of member variables declared in the central Extended
Formula variable, which are referenced by the dependent variable.

Selecting the central arrow button populates a list of all public variables declared in the central Extended Formula
variable. A public variable can be selected from this list and all paths leading to dependent variables are
highlighted:

334

Chapter 8 Diagram view

Diagram view settings

Diagram view settings


The Settings for Diagram view allow you to specify that variables with particular properties are highlighted in a
specified colour.
To display the Diagram view settings:
1. On the Prophet menu click Options. The Options dialog box appears.
2. Click Customize GUI. The Diagram view settings appear.

The following sections allow you to specify Diagram view settings:

Colour Scheme section


Settings in this section allow you to:

335

336

Chapter 8 Diagram view

Assign colours to specific items


By default, cumulative variables are displayed in blue. Also when Diagram view is used to edit a product the
input variables are displayed in red.

To specify a custom colour for the property of a variable, select the property from the colour list and select a
colour from the displayed palette.

To change the typeface used in Diagram view, click Font and from the Font dialog box select the appropriate
typeface.

To specify a custom border colour for input variables or external links, from the colour list select the colour.

Diagram section
This section specifies how variables are represented diagrammatically. The available settings are:
n

Show Dependency Tree View


Selecting this setting displays the dependent tree panels. Alternatively, clearing this setting hides the
dependency tree panels and so provides more space to display the relationship between variables.

Exclude Self Referencing Variables


Select this option to hide any self referencing variables displayed in the dependency tree panels. Self
referencing variables are hidden by default.

Results section
The setting in this section is used by Results Diagram view.
n

Synchronize results panes


Select this option to specify whether the three results panes are synchronised so that they all display results for
the same time periods.

To abandon changes click Cancel.


To save and implement settings click OK.

337

Part 3 - Model Office and Valuation

The following sections describe how to use the following:


n

Accumulations

Structures

Run Settings

Runs

Results

338

339

C H A P T E R

Accumulations

TOPICS IN THIS CHAPTER


What are accumulations?

340

Managing accumulations

341

Editing the contents of an accumulation

349

Running an accumulation

352

Printing accumulations

352

340

Chapter 9 Accumulations

What are accumulations?


Accumulations allow you to sum the results produced by running products and other accumulations. They therefore
allow you to report on any subset of your results or on the overall results for your company.
Each accumulation has an associated level number that allows you to control the order in which it and the products
and other accumulations are processed in a run. In particular, this enables you to use the results for an
accumulation as inputs into the calculations of other products.
Accumulations are also used to generate the inputs needed for products that perform calculations at a company,
sub-fund or fund level. Such products need to be given level numbers that are greater than the level numbers
assigned to their underlying accumulations.

Managing accumulations

341

Managing accumulations
Accumulations in the workspace are mainly managed using the tree displayed in the Products & Accumulations
pane. Different options are available depending on the item selected in the tree.

Managing accumulations in a folder


Selecting and right clicking the Accumulations folder displays the following context menu:

Options from the menu include:


n

New Accumulation - This enables a new Accumulation to be created.

Group By - This enables the Accumulations folder to be grouped by Level, or not grouped at all.

Sort options - The Accumulations in the folder can be sorted in ascending or descending order.

Show List of Accumulations - Choose this option to display all Accumulations as a list in the Accumulations tab
of the main work area.

Accumulation options
Selecting and right clicking an accumulation in the tree displays the following context menu:

342

Chapter 9 Accumulations

You can also select more than one accumulation in the tree using the Ctrl+click method and choose an option from
the right click menu. Options include the ability to open, delete, duplicate, run and view properties of an
accumulation.

Accumulations page list view


In addition to the tree view you can also manage accumulations in the workspace from the Accumulations Page list
view displayed in the main window.
To display the Accumulations page list view:
1. In the Products & Accumulations pane, if required, expand the Accumulations folder.
2. Select the Accumulations folder and from the right click menu choose the Show List of Accumulations option.

Managing accumulations

343

The Accumulations Page list view is displayed in the main window.

You can filter the displayed list by selecting options from the Filter section of the Home tab and sort the displayed
list of accumulations by clicking on the heading of any column.
From the Accumulations page list view you can also open, delete, copy or run an existing accumulation. You can
also create a new accumulation and review the properties of an existing one.

Accumulation properties
The Accumulation Properties dialog box displays the basic details of an accumulation. To display the dialog box
right click on the accumulation in the Products & Accumulations pane and on the menu click Properties. The
Accumulation Properties dialog box appears.

The dialog box has the following tabs:

General tab
This tab displays the name, description and level number of the accumulation.

344

Chapter 9 Accumulations

Name
The accumulation name can have between 1 and 24 alphanumeric characters (A-Z, 0-9 and _) but cannot start
with a number. It should be descriptive of the context in which it is used, for example, NEW_BUS. The name
must also not be the same as an existing Prophet object such as a product or a set of product results.

Description
This contains a suitable narrative that succinctly describes the accumulation.

Level Number
The level number should be left with its default value of 15 unless you are constructing a model office that
requires products and accumulations to be processed in a particular order.

Statistics tab
This tab displays additional information about the accumulation. It is maintained by Prophet and cannot be
manually updated.
Note the following:
n

You can specify an accumulation to accumulate other accumulations with the same level number. In this case,
Prophet orders the processing of the accumulations within that level number automatically.

You can also view and change the properties of an accumulation using the Structure View.

Creating an accumulation
To create a new accumulation do the following:
n

In the Products & Accumulations pane right-click the Accumulations folder and on the menu click New
Accumulation.

Alternatively, select the Accumulations folder and on the Home tab click New.

Then do the following:

Managing accumulations

345

Define the properties of the accumulation

Select the products and other accumulations whose results are to be accumulated

Specify the sub-product ranges to be accumulated for the products included in the accumulation

Optionally, you can add actuarial documentation for the accumulation using the Actuarial Documentation editor
which is displayed by clicking Global Actuarial Documentation on the Support tab. See Managing Actuarial
Documentation for more information.

346

Chapter 9 Accumulations

Editing an accumulation
You can inspect and modify the following items of an accumulation:
n

The description and level number. These are properties of the accumulation.

The list of products and other accumulations whose results are to be accumulated.

The sub-product ranges to be accumulated for the products included in the accumulation.

To make changes to an accumulation, in the Products & Accumulations pane double-click the accumulation.
Alternatively, right-click the accumulation and on the menu click Open.
The existing list of products and accumulations included in the accumulation are displayed similar to the following
in the Accumulations window.

The products and any accumulations are listed by name, description and type. For products the sub-product code
range is also listed.
You can select any product in the accumulation and from the right click menu you can:

Managing accumulations

Click Edit List to add or remove products and accumulations

Click Edit Range to update the sub-product range for one or more selected products

Click Properties to display and edit the properties of the accumulation

347

You can also edit the actuarial documentation for the product by:
n

Clicking Global Actuarial Documentation from the Support tab

Selecting the product from the Products folder in the Workspace tree of the Actuarial Documentation preview
pane

Clicking Edit in the toolbar associated with the documentation window.

See Managing Actuarial Documentation for more information.

Viewing accumulation documentation


Actuarial documentation related to an open accumulation is displayed in the Actuarial Documentation tab. If no
documentation is specified for the accumulation then the tab appears similar to the following:

348

Chapter 9 Accumulations

Documentation for the accumulation is created, edited and managed from the Actuarial Documentation editor which
is displayed by clicking Global Actuarial Documentation from the Support tab. See Managing Actuarial
Documentation for more information.
Note: If the accumulation is deleted then the associated actuarial documentation is also deleted.

Editing the contents of an accumulation

349

Editing the contents of an accumulation


You can edit the list of products and accumulations included in an accumulation by selecting the open
accumulation in the main window and clicking Edit List on the Object tab. Alternatively, right-click a product in the
accumulation window and on the menu click Edit List.
In either case the Select Products / Accumulations to be Accumulated dialog box appears.

Two lists are displayed:


n

Available Products / Accumulations

Selected Products / Accumulations

You move the products and accumulations between these two lists by selecting one or more items and choosing
the appropriate button.
Note: You can also select one or more items and then drag and drop them from one list to the other.
After making changes click OK to return to the Accumulation window.

350

Chapter 9 Accumulations

Editing sub-product ranges in an accumulation


You can edit the sub-product range to be accumulated for any products by selecting those you want to edit in the
Accumulation window and clicking Edit Range on the Object tab. Alternatively, right-click a product in the
accumulation window and on the menu click Edit Range.
The Sub-Product Range for Products dialog box appears.

To accumulate the results for all sub-products for all products in the accumulation choose Total of all Sub-Product
Codes for selected Productsand click OK.
Alternatively, you can specify the range for the selected products by choosing Specify Range for selected
Products. You can then do one of the following:
n

Enter a range of sub-product codes separated by commas and hyphens.

Enter a range of sub-product codes separated by commas and hyphens using the ? wildcard character. For
example, to specify a range from 50 to 59 and 700 to 799 you would enter 5?, 7??.
Note: If you specify wildcard characters then you cannot edit the sub-product codes using the Select SubProduct Codes dialog box.

Click Edit and select the required sub-product codes from the Select Sub-Product Codes dialog box.

The Select Sub-Product Codes dialog box appears similar to the following:

Editing the contents of an accumulation

351

The following lists are dispalyed:


n

Available Sub-Product Codes list

Selected Sub-Product Codes list

You move items from one list to another by selecting the items and choosing the appropriate button. Click OK when
you have selected the required items.
Note: You can select one or more items and then drag and drop them from one list to the other.
To save any changes and return to the Accumulation window click OK.

352

Chapter 9 Accumulations

Running an accumulation
To run a single accumulation select it in the Products & Accumulations pane and from the Home tab click Run.
The Run Accumulation dialog box appears similar to the following:

The structure is only used by Prophet to determine which run numbers are to be used in the run. Choose the
required structure and run setting and click OK.
Note: If you want to run more than one accumulation then set up a structure which includes them and then run
that structure. For more information on setting up and running structures see "Structures" and "Runs".

Printing accumulations
You can print the details of one or more accumulations by selecting them in the Accumulations page list and
choosing Print from the Prophet menu.
The Print Accumulations dialog box is displayed.

Printing accumulations

353

From this dialog box you can print either the list of accumulations displayed in the Accumulations view or the details
for those accumulations you have selected.
Choose what you want to print and click OK. To see what is to be printed click Preview.
Note: To display the Accumulations page list you select an accumulation in the Products & Accumulations
pane and choose the Show List of Accumulations option.

354

355

C H A P T E R

1 0

Structures

TOPICS IN THIS CHAPTER


What are structures?

356

Managing structures

358

Structure options

365

Structure view

391

356

Chapter 10 Structures

What are structures?


Structures are used to specify what is included in each run. You can create and save any number of structures.
A structure contains details of:
n

Products and accumulations used in a run

The variables that are to be calculated in the run

The type of new business processing to be carried out during a run

Settings for dynamic and stochastic runs

Dynamic looping options

In addition, you can also specify options that:


n

Include then run time for each variable in the diagnostic file which is created for each product

Create separate executables for each product in the structure

Disable output variables checks when running the structure

Specify how much memory is allocated to holding results values in memory during a run

Specify how memory is allocated for dynamic and stochastic runs

You can also display the actuarial documentation for a structure. The documentation is added and edited using the
Actuarial Documentation editor which is displayed by clicking Global Actuarial Documentation from the Support
tab. See Managing Actuarial Documentation for more information.
Running a Structure
In general, a run is started by selecting one or more structures from the Structure page list view or from the tree
displayed in the Structure & Run Settings pane and running them. You then specify the run settings used with the
structures from the Select Run Pairings to be Run dialog.

What are structures?

357

Each structure must have a corresponding run setting before it can be run. This pairing of a structure with a run
setting is known as a Run Pairing. Specifying run pairings provides you with the flexibility to run products under
different sets of criteria.
Similarly, the process of running a run setting is exactly the same as for running a structure. See "Running one or
more run pairings".

358

Chapter 10 Structures

Managing structures
Structures in the workspace are mainly managed using the tree displayed in the Structures & Run Settings pane.
Different options are available depending on the item selected in the tree.
Managing structures in a folder
Selecting and right clicking the Structures folder displays the following context menu:

Options from the menu include:


n

New Structure - This enables a new Structure to be created.

Group By - This enables the Structures folder to be grouped by Stochastic or Dynamic. Alternatively, no
grouping of the Structures is also available.

Sort options - The Structures in the folder can be sorted in ascending or descending order.

Show List of Structures - Choose this option to display all Structures as a list in the Structures tab of the main
work area.

Structure options
Selecting and right clicking a structure in the tree displays the following context menu:

Managing structures

359

You can also select more than one structure in the tree using the Ctrl+click method and choose an option from the
right click menu. Options include the ability to open, delete, duplicate, run, regenerate and view properties of a
structure.
Structures page list view
In addition to the tree view you can also manage structures in the workspace from the Structures Page list view
displayed in the main window.
To display the Structures page list view:
n

In the Structures & Run Settings pane, if required, expand the Structures folder.

Select the Structures folder and from the right click menu choose the Show List of Structures option.

360

Chapter 10 Structures

The Structures Page list view is displayed in the main window:

You can filter the displayed list by selecting options from the Filter section of the Home tab and sort the displayed
list of structures by clicking on the heading of any column.
From the Structures page list view you can also open, delete, copy or run an existing structure. You can also create
a new structure and review the properties of an existing one.
Displaying a structure
To display the relationships between the products and accumulations in the structure you select the structure in the
Structures & Run Settings pane and from the Home tab click Open and choose Results Diagram.

Structure status
Each structure listed in the Structure page list view has a status that reflects the overall compiled status of the
products in the structure. To view the compiled status of the products in a structure you select the structure in either
the Structure Page list view or in the tree of the Structures & Run Settings pane and from the Home tab click Status.
The status dialog is displayed similar to the following:

Managing structures

The possible status settings for either products in the structure or for the sturcture itself are listed in the following
table.
Structure Status

Description

Specified

This indicates that products specified in the structure have not been
compiled.

Mixed

This status message identifies that the structure has some products
that are compiled and some that are not. In addition, selecting the
structure and clicking the Status" button in Home tab displays the
products used by the structure together with their compiled status.

Compiled

This indicates that the structure has products that have all been
compiled.

361

362

Chapter 10 Structures

Structure properties
The Structure Properties dialog displays basic details of a selected structure. It appears similar to the following:

The General tab holds the name of the structure.


The Statistics tab displays additional information about the structure. It is maintained by Prophet and cannot be
manually updated.

Creating a Structure
To create a new structure do the following:
n

In the Structure & Run Settings pane select the Structures folder and from the right click menu choose New
Structure.

Alternatively, select the Structures folder and from the Home tab click New.

The Structure dialog box is displayed consisting of a number of tabs that allow you to enter the information required.
You should do the following:
n

Enter a name for the structure

Select the products and accumulations to be included in the structure from the Products/Accumulations tab

Specify whether the structure is for dynamic and/or stochastic runs

Managing structures

363

Specify the variables to be calculated, new business settings and any specific run time settings as appropriate
in the Configuration tab

Specify dynamic loop options and any sub-product code substitutions in the Dynamic tab

Optionally, you can add actuarial documentation for the structure using using the Actuarial Documentation
editor which is displayed by clicking Global Actuarial Documentation from the Support tab. See Managing
Actuarial Documentation for more information.

Refer to the "Structure options" for details of each of the tabs in the Structure dialog box.
When you have completed the structure click OK to save it.
Note: The dynamic looping and stochastic run options are not available if the Dynamic and Stochastic module
has not been licensed.

Deleting a Structure
When a structure is no longer required you can delete it.
To delete a structure select the structure in the Structure & Run Settings pane and click Delete from the Home tab.
Alternatively, select the structure and from the right click menu click Delete.The selected structure is deleted and the
list of accumulations updated.

Duplicating a Structure
Duplicating or copying an existing structure provides a method of creating a new structure based on an existing
one.
To duplicate or copy an existing structure, select the structure in the Structures page list view and from the Edit
section of the Home tab click Duplicate. Alternatively, select the structure in the Structures & Run Settings pane
and from the right click menu choose the Duplicate option.
In either case the selected structure is duplicated and the list of structures updated.

364

Chapter 10 Structures

Printing structures
To print the details of one or more structures, select them in the Structures pane list, click the Prophet button and
from the Prophet menu click Print. The Print Structures dialog box is then displayed.

From this dialog box you can print either the list of structures displayed in the Structures view or whichever details
you require for those structures you have selected.
Choose what you want to print and click OK. To see what is to be printed click Preview.

Structure options

365

Structure options
When you select and open a structure from the Structures & Run Settings pane the Structure dialog is displayed.
The dialog allows you to enter and update all aspects of a structure.
The dialog for an existing structure appears similar to the following:

In the dialog you enter the name of the structure and specify whether the structure is used for dynamic and/or
stochastic calculation runs. You can also specify the links between products and accumulations by clicking Select
Product Links. These links can also be displayed graphically using Structure view.
The Structure dialog has the following tabs:
n

Products/Accumulations tab
The products and accumulations used in the structure are specified in this tab. The products can also be
arranged so that they are processed in the order you specify.
Specify the names of the products and accumulations that are to be read in READ_RESULTS functions when

366

Chapter 10 Structures

reading values from other products and accumulations in the structure. This is done using by clicking Select
Product Links.
n

Configuration tab
Settings in this tab allow you to specify which variables are to be calculated in the run. You can also specify a
number of runtime performance settings which include memory usage when holding results values in memory
and performing dynamic and stochastic calculations.

Dynamic tab
Settings in this tab apply to dynamic calculation runs only. They allow you to specify the dynamic period for each
level number and the sub-product codes to be used for new business when it becomes existing business.
This tab is not displayed if the Dynamic option is not selected for the structure or if the Dynamic and Stochastic
module is not licensed.

Actuarial Documentation
This tab displays the Actuarial Documentation for the structure. The documentation is managed using the
Actuarial Documentation feature.

To save the structure settings click OK.

Structures - Products/Accumulations tab


From this tab you select the products and accumulations that are to be included in the structure. You can also
specify the links between products which give the names of products and accumulations to be used when reading
the values from another product. The Products/Accumulations tab appears similar to the following:

Structure options

367

Two lists are displayed that contain the products and accumulations that have been added to the structure.
n

To add or delete a product to the structure


Click Select Products above the Products list and choose the products from the Select Products dialog.

To add or delete an accumulation to the structure


Click Select Accumulations above the Accumulations list and choose the accumulations from the Select
Accumulations dialog.

To specify the product run order in the structure


Select a product in the Products list and use the up/down arrow buttons to arrange the processing order.
This feature only controls the order of processing for products with the same level number. This is because
products and accumulations are automatically run in ascending level number order.

Note the following:


n

The products are only run in the selected order if, in the Run Process tab of the Run Setting - Advanced
Settings dialog, the Product Run Order is set to Selected Order. To display the dialog you click Advanced on

368

Chapter 10 Structures

the Run Parameters tab of a Run Setting.

Structure options

369

Structures - Configuration tab


From this tab you can specify which variables are to be calculated in the run. The selected variables are included in
the generated products together with any other variables that they depend on even if they are in different products.
You can also specify from this tab a New Business Method and apply a number of runtime options.
The Configuration tab of the Structure dialog appears similar to the following:

You specify and apply settings to the following items:


n

Calculated variables

New Business Method

Advanced options

Details of the options are supplied in the following sections.

370

Chapter 10 Structures

Calculated Variables
This section in the Configuration tab of a Structure provides you with options to specify which variables are to be
calculated in a run. During a run the specified variables are included in the generated products together with any
variables that they depend on even if they are used in different products. By minimising the variables that are
calculated to just those that you wish to report on you can reduce the time taken to carry out the run.
The Calculated Variables section appears as follows:

You can accept the default setting to calculate all the variables in the products or specify the variables by choosing
Specified sub-set and selecting any of the following:
n

Cumulative variables
Select this option to include only cumulative variables in the run.

Variable group
Select this option and click VariableGroups to include one or more selected groups of variables from the
Variable Group Selection dialog box.

Specific variable
Select this option and then choose a variable from the associated drop down list. The variables shown in the
dropdown list are those in the current open workspace.

Note the following:


n

When Specified sub-set is selected the "Retain product executables separately for structure" option in the
General tab of the Advanced Settings dialog box for the structure is also selected.

Structure options

371

Some variables are always required to ensure that the products run correctly. For more information see "Limiting
calculations to a variable - required variables".

Variables specified in this section are included in the calculations. To include the variables in the Results files
you must specify them in the Results Files section in the Results tab of a Run Setting.

New Business Method


Details of the New Business settings are specified in the New Business Method section of the Configuration tab of a
Structure:

Cross Multiplication
When you select this method new business profile results are produced during the calculation of the products. They
are produced for all sub-products included in the model point files with sub-product codes greater than the last subproduct code for existing business. The files contain results on the assumption that all business is sold at the
beginning of the first month of the projection.
At the cross multiplication stage of the run process the new business volumes are read from the Sales file and are
then applied to the relevant new business profile results to produce the results allowing for future new business.
These results are stored as projection results.
Project
Choose this option to use the Project new business method. In this process the new business volumes are read
from the Sales file and applied during the calculation of each product. Prophet loops round the model points for
each new business sub-product once for each month of the projection. At the end of each loop the results are
multiplied by the sales volume for that month.

372

Chapter 10 Structures

This method allows the new business projections to incorporate assumptions that vary by calendar month and year
in the future, for example rates of investment return, bonus rates and AIDS mortality. The results are stored as
projection results. This method must be used for dynamic runs.
New Business in Model Point File
Choose this method if the model point files contain the new business volumes.
Level Number for Cross-Multiplication
Select the level number at which new business cross-multiplication is to take place in the Configuration tab of a
Structure.
Cross-multiplication takes place after any products included in the structure with the same level number have been
run and before any accumulations included in the structure with the same level number are run.
Last Sub-Product Code for Existing Business
Select the last sub-product code which should be treated as existing business in the Configuration tab of a
structure. Selecting 50 for example, causes all sub-products up to and including 50 to be treated as existing
business with sub-products 51-9999 being treated as new business.
Maximum Sub-Product Code in a Dynamic Run
The maximum sub-product code in a dynamic run must be between the Last Sub-Product Code for Existing
Business and 999.
Last Sub-Product Code for New Business based on Sales Volumes
Select the last sub-product code to be treated as new business based on sales volumes in the Configuration tab of
a structure. Selecting 70, for example, causes all new business sub-products up to and including 70 to be treated
as new business to which sales volumes read from a sales file will be applied. Sub-products 71-9999 will be
treated as new members into an existing group pension scheme or one that will be sold in the future.
Note: You can switch off the new business processing using the Cross Multiplication or the Project new
business method by leaving the location for the Sales file blank in the run setting being used.

Structure options

373

Advanced structure options


Additional structure settings are available from the Advanced Settings dialog box which is displayed when you
click Advanced in the Configuration tab of a structure. The dialog box appears similar to the following:

Options from this dialog box are as follows:


n

General tab
Options from this tab allow you to apply settings that can help you to diagnose runtime performance and specify
that separate product executables should be generated and retained. You can also reduce the time taken to
generate products at the start of a run by omitting some of the checks when running a structure. For details see
Structure - Advanced settings dialog box - General tab below.

Memory tab
Options from this tab allow you to manage the memory used by Prophet to hold results during a run. For details
see Structure - Advanced Settings dialog box - Memory tab on page378.

Structure - Advanced settings dialog box - General tab


Options from this tab allow you to apply settings that can help you to diagnose runtime performance, specify that
separate product executables should be generated and retained, and disable output variable checks when running

374

Chapter 10 Structures

the structure. The dialog appears similar to the following:

The settings that can be specified are:

Performance profiling
You can control the generation of diagnostic files by selecting options from this section. The settings that can be
selected are:
n

Generate codegen diagnostics


Selecting this option generates a compilation diagnostic file for each product The comma separated file has the
name of the product with the extension .DGN.CSV.

Generate runtime diagnostics


Selecting this option, creates a comma separated file for each product that is run and contains the details of
each variable used during the run, how many times it was called, the time spent processing it and the
percentage of the total run time for that product.
The filename is made up of the name of the product with an extension of ._000.CSV. For example, C_WEND_

Structure options

375

000.CSV. The files are located in the run folder. For example, C:\ProphetWorkspace\Results\Run_01\C_
WEND_000.CSV.
For more details on DGN and .DGN.CSV files see: How to use a code generation diagnostic file.

Product Executables
Selecting the Retain product executables separately for structure option allows you to specify the generation of
a separate executable files for each structure.
Note that this setting is automatically selected when Specified sub-set is selected in the Calculated Variables
section in the Configuration tab of the structure.

Disable Checks
This section has the following options:
n

Disable output variables check


This option is only available if All Variables is chosen in the Configuration tab of Structure. Otherwise it is
disabled.
Selecting this option allows you to skip some of the checks when running a structure. It can reduce the time
taken to generate the products at the start of a run and is mostly useful if the structure contains many products
and you are calculating all the variables in the products. However, if you also elect to not include all the
variables in the results files that will be created then there is a risk that a product may reference the values for a
variable in another product for which the results have not been included in the results files. You should therefore
use this option with care.

Disable non global dimensions


Selecting this option allows non global array dimension settings applied to products using the Product
Dimension dialog to be replaced by the global array dimension settings specified in the Dimensions setting of
the Options dialog.
Applying specific array dimensions at the structure/product level reduces the memory footprint and avoids using
the same array dimension, specified at the workspace level, for all products.

376

Chapter 10 Structures

Repeat Level
Select the Select levels to repeat option if you wish to repeat a level when running an in-memory dynamic product
run. When you select this option an additional column named `Repeats' is added to the Dynamic Periods column of
the Dynamic tab of a Structure. Each level can have a value from 0 to 99 and specifies how many times that level is
repeated.
Note that:
n

An in-memory dynamic product is specified by selecting the "Use in memory dynamic/stochastic calculations"
option in the General tab of the product property dialog.

The REPEAT_COUNT function can be used in formulas to condition on the number of repeats for a particular
level

The REPEAT_LEVEL function is not supported when used in conjunction with an in-memory dynamic run. If you
attempt to use the REPEAT_LEVEL function with Repeats in the run structure then a warning is logged in the
run log notifying that the REPEAT_LEVEL function has been ignored.

Selecting Repeat Level in the General tab runs the specified levels for each dynamic loop the specified number
of times. However, the REPEAT_LEVEL function only runs the first dynamic loop the specified number of times.
See REPEAT_LEVEL for more details.

Stochastic Accumulations
You can start a stochastic run from a specified level. If a lower level results exists then you can re-run a stochastic
structure from an accumulation upwards without having to rerun a lower level products. In this case rerun the
stochastic accumulation results are calculated from the underlying product stochastic results for any products that
do not exist in the structure.
This option is controlled by selecting the Accumulations process STO files for Products/Accumulations not in
the run option. By default this option is not selected when a new structure is created.
Note the following:

Structure options

377

If this option is selected then the accumulation will use the PRJ results for any products in the structure and the
STO results for any products accumulated that are not in the structure.

Stochastic results files may not contain all variables or monthly results for all time periods. If a monthly value for
a particular variable is not in the stochastic results file then the value in the projection results file will be used
instead and a warning will be shown in the run log.

Compiler optimisations
These options allow you to determine how products are compiled. You can choose from one of the following
options:
n

Fast compile
Choosing this option applies a set of compiler switch settings that help to reduce the time taken to compile
products but can extend the time taken to run the generated products.

Fast runtime
Choosing this option applies a set of compiler switch settings that can increase the compile time but reduce the
time taken to run the generated products.

Incremental Compilation
Select this option to force the system to compile only code that has been changed. Using this setting can
significantly reduce the time to compile and run models during development. Note the following:

Incremental Compilation applies to both debug and non-debug products

The first incremental compilation takes longer than a full non-incremental compile as additional files are
generated to support this feature.

If a product is regenerated then this setting is ignored and the product is recompiled as normal.

This setting is not selected by default.

Enterprise optimisations
If you are a Prophet Enterprise user and have the Prophet Enterprise feature of a Prophet Professional License,
then you can access the Prophet Enterprise model point and table optimisations and Parallel Model Point

378

Chapter 10 Structures

Processing
Enable Parallel Model Point Processing
n

If this option is selected - The run pairing is run using multi-threading capabilities.
Note: The setting for this option is ignored if Allow Parallel Model Point Processing is not selected for a
product in the Product Properties Dialog.

If this option is NOT selected - The run pairing is run using single threading processing.

Table and MP File Optimisation


This option optimises the generated code in respect to the content of the tables used by the job. If you edit a table
then the code has to be regenerated. If this option is selected then the code is optimised and can extend the time
taken during the job preparation phase. The available options are:
n

Off - Does not optimise table or model-point files. This is the default setting.

Base - Optimises a base product for table and model-point files for all same-as products in the structure. One
DLL per base product is generated.

Full - Optimises, generates and compiles one DLL per same-as product. This may extend preparation time but
can generate more optimal code. Could be worthwhile for huge products or large stochastic runs.

Generally, optimisations are aimed at identifying constants and integers which can improve the performance of
some models.

Structure - Advanced Settings dialog box - Memory tab


Options from this tab allow you to manage the memory used by Prophet. Adjust these settings if you wish to specify
how Prophet should manage the available physical memory during calculation runs.

Structure options

379

The settings that can be specified are:

Maximum amount of memory for holding results


This section, which applies to all types of run, appears as follows:

You can choose from one of the following options:


Unlimited
Choosing this option allows Prophet to use as much physical memory as it requires to hold the results of a run.
Keeping the results in memory provides optimum runtime performance by reducing the need to write results to disk
at key stages of a run. At the end of the run the results resident in memory are written to disk.
Note that under this setting if Prophet starts to run out of memory then the results will automatically be written to disk
in order to enable the run to complete. This is the default option.
str

380

Chapter 10 Structures

Minimal
Choosing this option instructs Prophet to use as little memory as possible for holding results. Prophet will use a
small amount of memory to store the results and write out each individual set of results in an efficient manner.
Note that Prophet can keep intermediate result files in memory during a run without reading and writing to disk. In
this situation when a product calls the READ_RESULTS function to read a result from another product no disk
access occurs. This means that performance is improved, especially where results files are stored on a network
server or during a parallel PC run.
Writing results to disk
Results data is automatically flushed (written immediately) to disk in the following circumstances:
n

If a run is neither stochastic nor dynamic then the results are flushed to disk when they have been calculated
since they will not be changed by any future calculations. The results are, however, retained in memory for
READ_RESULTS calls.

For a Parallel PC run split by product the results are flushed to disk after each product calculation to allow all
PCs to access the results.

In a stochastic run all results data is flushed to disk and the results removed from memory at the end of each
simulation.

In any run, all the results data is written to disk and removed from memory at the end of each run number.

In-memory dynamic / stochastic memory use management


A comprehensive range of memory settings for running dynamic or stochastic runs are available in this section
which appears similar to the following:

Structure options

381

You can choose from one of the following options:


Unlimited
This setting, which is the default, allows Prophet to assume that there is sufficient physical memory to hold the
calculations for every model point in memory throughout the in-memory dynamic / stochastic run.
Selecting this option may result in the run terminating unexpectedly if the memory required exceeds that available.
Limited
This setting can be used for models unable to run in the Unlimited option. Intermediate dynamic / stochastic values
can now be stored on either disk or in memory.
In this method if Prophet uses all the available memory then it will implement a disk swapping strategy. When this
happens Prophet will swap parts of the data held in memory to the hard disk. This should then allow the run to
complete but the performance may be reduced as swapping data between memory and the hard disk is relatively
slow.
The following settings are available:
n

Specified amount of Memory MB


This specifies the maximum amount of memory available to the run. Click ? to obtain the amount of free memory
currently available and then adjust as you require. This allocated memory will be shared out among the
products.

382

Chapter 10 Structures

Persistent Variables storage


This option instructs Prophet to store the Persistent variables either in memory or directly on disk. Storing the
values directly in disk is more efficient than attempting to store them in memory and then swapping to disk if
memory required exceeds memory available.

Pre-Dynamic Variables Recalculation


This option is available whether Unlimited or Limited memory strategy is chosen.

None is the default option. This will ensure that all Persistent variables are stored either in memory or disk
according to the settings above. All Persistent variables are calculated only in the first dynamic loop and the

Structure options

383

values stored for all future dynamic loops.


Simple Persistent Variables enables Prophet to determine the Persistent variables that can be easily
recalculated. These variables are the calculated in each dynamic loop instead of only the first dynamic loop.
This eliminates the storage requirement for those variables whether the values are stored in memory or on disk.
Controlling memory management on per product basis
See "Override using product level settings" for the ability to control the memory management on a per product
basis.
Once the settings are specified click OK to save them. Finally, note that for the settings to take effect the products in
the structure have to be regenerated by selecting the Regenerate all products in the run option in the Select Run
Pairings to be Run dialog.

384

Chapter 10 Structures

Structures - Dynamic tab


This tab is only used for dynamic runs and only appears when the Dynamic options is selected. From the Dynamic
tab you can specify the dynamic period for each level number and the sub-product codes to be used for new
business when it becomes existing business. The tab appears as:

The options in this tab are:


n

Dynamic Periods
Allows you to specify the dynamic period in months for each level number.
Note that an additional column named `Repeats' is added to the Dynamic Periods column of the Dynamic tab of
a Structure when the Repeat Level option is selected in the General tab of the Structure - Advanced Settings
dialog. The option allows you to specify the number of times a dynamic period level is repeated when running
an in-memory dynamic product.

Sub-Product Code Substitutions


Allows you to specify for each new business sub-product code the existing business sub-product codes to be
used in the loop after sale and in the remaining loops.

Structure options

385

Note: This item is only available if the Dynamic and Stochastic module is licensed.

Dynamic Periods settings


This section in the Dynamic tab of a structure allows you to specify the dynamic period in months for each level
number used.
The permitted entries are 1, 2, 3, 4, 6, 12, E and blank.
If the Start Date is part way through a company year the first main dynamic period will be a partial one for the period
up until the end of the current company year if the dynamic period is 12 months (or until the next appropriate period
end month if the dynamic period is less than 12). For example, if the Start Date is 4/2002, the Company Year End
Month is 12 and the dynamic period is 12 months then the first main dynamic period will be for 8 months up to
12/2002. If instead the dynamic period is 3 months then the first main dynamic period will be for 2 months up to
6/2002.
Specifying a dynamic period of E means that that level is not run dynamically. This has two main uses:
n

If there are any liability products which do not need to be run dynamically then by giving them a level number for
which the dynamic period is E they will only be run once at the start of the projection. This might be used if the
only dynamic decision related to the bonus rate to be declared. In this situation all the non profit products only
need to be run once and hence can be given a level number with a dynamic period of E.

If there are any global or summary products that need to be run on the final company level or fund level results
they will only be run once at the end of projection if they are given a level number for which the dynamic period
is E. This allows values to be calculated by discounting backwards on the final results. This cannot be done
within the products which are being run dynamically because they only calculate from the current start date
onwards.

Thus the level numbers with a dynamic period of E must all be at either the lowest levels or the highest levels used
in a run.
If a product or accumulation included in a dynamic run has a level number with a blank dynamic period then the
default of 12 will be used. You are warned of this at the start of the dynamic run.

386

Chapter 10 Structures

Sub-Product Code Substitutions settings


In a dynamic run, new business sold in each dynamic loop is treated as existing business in all subsequent
dynamic loops. You therefore need to specify the existing business sub-product codes which are to be substituted
for each new business sub-product code in the Dynamic tab of a structure.
For example, you could specify that new business model points with a sub-product code of 51 should have a subproduct code of 21 in the dynamic loop following the dynamic loop in which they are sold and a sub-product code of
1 in all subsequent dynamic loops.
In each column the value in one row cannot be lower than the value in the previous row. In addition, the values in
the Remaining Loops after Sale column cannot be higher than the values in the corresponding row in the First Loop
after Sale column.
Note: The maximum sub-product code for dynamic runs is 999 and not the normal limit of 9999.

Structures - Actuarial Documentation tab


From this tab you can display the actuarial documentation associated with the structure. If no documentation is
specified for the structure then the tab appears similar to the following:

Structure options

387

You add or edit documentation for the structure in the Actuarial Documentation window which is displayed when
you click Global Actuarial Documentation from the Support tab. See Managing Actuarial Documentation for more
information.

388

Chapter 10 Structures

Product links
Product links specify the names of products and accumulations results that are to be read when using the READ_
RESULTS function to read values into a product. The product links to be used in a workspace are specified from the
Products Links dialog box. To access the dialog box, click the Prophet button and from the Prophet menu click
Options. From the Options dialog box select Product Links.
You then specify the names of the products and accumulations results in the structure. For example, a product link
named GLOBAL_TOP exists in the standard workspace in Release 8.0 and later. In the structure you might specify
that GLOBAL_TOP was G_TOP1 for one liability product and G_TOP2 for another liability product.
Displaying the product links for a structure
To display the product links for a structure you open it and click Select Product Links. The Product Links for
Structure dialog box appears similar to the following:

When you click Update the system scans all the products in the structure to identify the product links that are used
and lists them for inclusion. You should generally include them all unless you are sure that the way the model is set
up the related READ_RESULTS function will not be called.
For each product that includes a product link you should then specify the name of the product or accumulation from
which it should read the value or values required. In the case of products, if you just enter a name, then the product
total results will be read (with sub-product code zero). If you want to read values for a specific sub-product code you
need to enter that code after the product name.
Product links for Structure
Note that in Release 7.2 and subsequent releases you should no longer use text variables to specify the names of
results files in READ_RESULTS function calls. They need to be specified here so that the system can correctly
identify the links when analysing a structure during code generation.

Structure options

389

Adjusting Product Links


Product links that have been added or removed since the last update are listed in the Adjust Product Links dialog
box. The dialog box is displayed when you click Update in the Product Links for Structure dialog box. It appears
similar to the following:

Product links that have been added or removed since the last update are listed in the dialog box by object and
product link name. The dialog box is divided into:
n

New product links


The product links listed in the top part of the dialog box are those that have been found since the last update
and which you can add to the structure.

Non existent product links


The product links listed in the lower part of the dialog box cannot be found and are assumed to no longer exist.

To add all the product links that have been located select Select All in the top part of the dialog box. Alternatively,
you can select individual links by selecting each one as required.

390

Chapter 10 Structures

Similarly, to remove all product links that have been removed or no longer exist select Select All in the lower part of
the dialog box. Alternatively, you can select individual links by selecting each one as required.
When you click OK the selected changes are implemented.

Structure view

391

Structure view
Structure view allows you to display and analyse the hierarchy and dependencies between the products and
accumulations in a selected structure. In particular, the dependencies between each product and accumulation are
displayed as a tree diagram with the tables used in the structure listed in a separate pane.
You can use Structure View to:
n

Display and analyse the dependencies for any selected products or accumulations in a selected structure

Display and edit tables used by a product

Display and edit a selected product or accumulation

Use Diagram View for a selected product

Display the results for any selected product or accumulation

Display the properties for a selected product or accumulation

Run the displayed structure using a selected run setting

Run a selected product or accumulation

392

Chapter 10 Structures

Using Structure View


To display Structure View do the following:
n

Select the structure in the Structures & Run Settings pane

From the Home tab click Open and choose Open Structure Diagram

The selected structure is the displayed:

The structure view window has a toolbar at the top and the bottom of the window.
n

Top toolbar
Options from the top toolbar allow you to select the structure to be displayed, view its properties, open a
selected object in the view, access Diagram view and view the results generated when the structure was run.

Additional options from the top toolbar allow you specify general settings and to update the display.

Structure view

393

Bottom toolbar
The bottom toolbar allows you to specify a run setting, run the selected structure and view the run log.

The structure window also has the following panes:


n

The Levels pane


This is the leftmost pane. It corresponds to the level numbers as specified in the structure. Products and
accumulations corresponding to a level are displayed alongside the appropriate level number.

The Hierarchy pane


This is the centre pane. It displays the links and dependencies between the products and accumulations in the
structure. Products are represented by a square edged box and accumulations are represented by a rounded
box. Also, different colours are used to represent the status of selected objects.

The Tables pane


This is the rightmost pane. It displays the tables used by the products in the selected structure. The tables are
sorted by category and displayed in a tree view.

You can also print a screenshot of the displayed structure together with the list of tables used by the structure by
choosing Print from the Prophet menu which is displayed when you click the Prophet button.

Levels pane in Structure View


The levels pane, to the left of the Structure view window, displays the level numbers that correspond to the products
and accumulations in the structure. Selecting a level number in the levels panel limits the links shown in the
Hierarchy pane to those for that level.
In addition to displaying the level numbers, each level may have additional suffixes as follows:
n

Cross Multiplication
If Cross Multiplication is selected in the New Business Method section of a structure then the word XMULT is

394

Chapter 10 Structures

displayed in the corresponding level number pane. For example, a level that has Cross Multiplication selected
in the New Business Method section of a structure appears similar to the following:

Dynamic period setting


If the structure is dynamic then the Dynamic Period set for each level is displayed as DP= value selected. For
example: (DP = 12). A dynamic structure that has levels with specified dynamic periods can therefore appear
similar to the following:

Note that to apply dynamic processing you must select Dynamic in both the structure and in the corresponding
run setting.

Structure view

395

Hierarchy pane in Structure View


The hierarchy pane takes the form of a tree diagram that displays the dependencies between the products and
accumulations in a structure.

Products in the hierarchy pane are represented by square ended boxes whereas accumulations are represented
by rounded boxes. The links between the objects are shown by lines that have arrows which indicate the direction
of the dependency.
To view a complex model you can also customise the Hierarchy pane to display only those items that you wish to
see by choosing options from the Options dialog box.
In addition, you can also right-click on a product, accumulation or link object and choose options from the displayed
menu.

396

Chapter 10 Structures

Product object - context menu


If you right click a product object displayed in the Hierarchy pane in Structure View then the menu options appear
similar to the following:

Options from the right-click menu for a product object allow you to:
n

Open, edit and run the product

Display the product in Diagram view and view the results in Results view

Display the products and accumulations that are used by the product

Display the products and accumulations that use the product

Display the tables used by the product

Display and edit the properties for the product

Accumulation object - - context menu


If you right-click an accumulation object displayed in the Hierarchy pane in Structure View then the menu options
appear similar to the following:

Structure view

Options from the right-click menu for an accumulation object allow you to:
n

Open, edit and run the accumulation

Display results in Results view

Display the products and accumulations that are used by the accumulation

Display the products and accumulations that use the accumulation

Display and edit the properties for the accumulation

Link object - context menu


If you right-click a link object displayed in the Hierarchy pane in Structure View then the menu options appear
similar to the following:

397

398

Chapter 10 Structures

Options from the right-click menu for a link object display:


n

Objects that are linked by the linked object

The type of link which can be an accumulation, asset, decision or result link. The design link type is currently not
used.

The properties assigned to the link

Structure view display options


In addition to options accessed from the Structure view display toolbar you can customise the display of the
structure by choosing options from the Options dialog.
To display the Options dialog you can either:
n

Click Options from the Structure toolbar, or

Right-click in an empty area of the Hierarchy pane in Structure View and choose Options from the displayed
menu.

In either case, the Options dialog appears similar to the following:

The settings that you can apply to the displayed structure are:

Structure view

399

Display Link Types


You can select the type of link to be displayed from the Display Link Types section. You can display all type of
links or select only those from the displayed list of options that include Accumulation, Asset, Decision and Result
type links.

Display Object Types


You can choose to display all object types, which is the default setting. Alternatively, you can display only
products or only accumulations.

Display Link Directions


You can choose to display the direction of the links displayed in the Structure view. You can display all link
directions, which is the default setting. Alternatively, you can choose to display only Uses or Uses By links.

Size to Fit
To display all objects at a single level on one line choose Resized to Fit. Alternatively, the default setting of
Arranged into multiple rows displays all objects at a single level in a number of lines.

Miscellaneous settings
A number of miscellaneous settings allow you to:

Display only those product objects in a selected library

Hide any empty levels

Hide products and accumulations that are not linked

Hide the Table pane in Structure view. Use this option to allow more space in which to display the structure in
the Hierarchy pane.

Show or hide the descriptions of products and accumulations in addition to their names

When you have chosen the settings in the Options dialog you can click Close to apply them to the Structure view.
Alternatively, you can click Default to reset any current changes and reapply the standard settings. Note that any
changes that you apply to the displayed structure using the Options dialog are lost when you leave Structure view.

400

Chapter 10 Structures

Tables pane in Structure View


The Tables pane is the rightmost pane in the Structure view. It displays the tables used by products in the selected
structure and sorted by category. The pane appears similar to the following:

The tables can be displayed by table name only or with descriptions. In addition, you can hide the Tables pane
using the Hide Tables Tree option in the Options dialog.
As you select a product or accumulation object in the Hierarchy pane the tables pane is updated to display only
those tables that are used by the selected object. You can also select, open and edit a table in the Tables pane.
If you select and right-click a table you can do the following from the displayed menu which appears similar to the
following:

You can choose the following options:

Structure view

Open and edit the selected table

Display which products use the selected table

Specify that the description of the selected table and its location are displayed in the Tables pane.

401

Structure View toolbar options


Many of the tasks in Structure View can be performed from the following toolbars:
n

Top toolbar
Options / Properties / Open / Diagram / Results / Update Links toolbar

Bottom Toolbar
Run Setting / Run / Run Log toolbar

Other options are available from the right-click menu displayed when you select and right-click an object such as a
link, product or accumulation. These options are described in Right-click menu options. In addition, the Options
menu, displayed when you click Options, is described in Options menu.
For information on the options available from the Structure View toolbar see Help.

402

403

C H A P T E R

1 1

Run Settings

TOPICS IN THIS CHAPTER


What are run settings?

404

Managing run settings

406

Run setting options

413

Printing run settings

449

404

Chapter 11 Run Settings

What are run settings?


Run settings are used to specify how each run should be performed. You can create and save any number of run
settings.
These are two types of run settings:
n

Calculation run settings


These are used for profit test, projection and valuation runs.

Grouping run settings


These are used when individual model point data is to be grouped together to form grouped model point files.

This section deals with calculation run settings. Grouping run settings are covered in "Data grouping in Prophet".
Items that are stored in a calculation run setting include:
n

The start date of the run and the periods for which results are required

The run numbers to be run

The location of the tables used by the run

The types of results to be generated

The numbers of errors and warnings to be permitted

Settings for dynamic and stochastic runs

Which batch programs are to be run

Options that specify how the run is performed on one or more PCs

What are run settings?

405

Running run settings


You can run a single run setting by selecting it in the Structures & Run Settings pane and clicking Run from the
Home tab.
To run more than one run setting:
n

Select the run settings in the Run Settings page list view and click Run from the Home tab, or

Select the run settings in the tree pane of the Structures & Run Settings paneand from the right click menu
choose Run.

In either case, the process is exactly the same as for running structures. See "Running one or more run pairings" .

406

Chapter 11 Run Settings

Managing run settings


Run settings for Calculation runs and Grouping runs are generally specified and managed using the tree displayed
in the Structures & Run Settings pane. Different options are available depending on the item selected in the tree.
Managing runs settings in a folder
Selecting and right clicking the Run Setting folder displays the following context menu:

Options from the menu include:


n

New Run Setting - This enables a new Run Setting to be created.

Group By- This enables the Run Settings in the folder to be grouped by Stochastic, Dynamic or by Run Type.
Alternatively, no grouping of the Run Settings is also available.

Sort options - The Run Settings in the folder can be sorted by run number or in ascending or descending order.

Show List of Run Settings - Choose this option to display all Run Settings as a list in the Run Settings tab of the
main work area.

Run Setting options


Selecting and right clicking a run setting in the tree displays the following context menu:

Managing run settings

407

Options from the menu include the ability to open, delete, duplicate and run a Run Setting. In addition, you can also
inspect the properties of the Run Setting.
Managing Run Setting in page list view
In addition to the tree view you can also manage run settings in the workspace from the Run Settings Page list view
displayed in the main window.
To display the Run Settings page list view:
n

In the Structures & Run Settings pane, if required, expand the Run Settings folder.

Select the Run Settings folder and from the right click menu choose Show List of Run Settings.

The Run Settings page list is displayed in the main window:

408

Chapter 11 Run Settings

You can arrange the displayed list of run settings in the page list by selecting a run setting in the list and from the
right click menu choosing one of the following:
n

Group by
Choose this option to arrange the list of run settings by their description, dynamic, stochastic, run numbers,
simulations, modified date or run type.

Group by Tab
Choose this option to arrange the list of run settings by tabs. For example, choosing to group the list of run
settings by Run Type displays the run settings depending on their run type in either the Calculation Run or
Grouping Run tab.

Other options
You can filter the displayed list of run settings by selecting options from the Filter menu of the Home tab. You can
also run one or more run settings by choosing them in the page list and clicking Run from the Home tab.

Run setting properties


The Run Setting Properties dialog box displays basic details of a selected run setting. It appears similar to the
following:

Managing run settings

409

The General tab displays the name and the type of run setting (calculation or grouping).
The Statistics tab displays additional information about the run setting. It is maintained by Prophet and cannot be
manually updated.

410

Chapter 11 Run Settings

Creating a run setting


To create a new run setting click New in the Home tab and choose New Run Setting from the menu. Alternatively,
select the Run Setting folder in the Structures & Run Settings pane and from the right click menu choose New Run
Setting.
In either case, the Select Run Setting Type dialog box is displayed from which you can select the type of run setting
to be created. It appears similar to the following:

Create a calculation run setting by choosing Calculation Run. Alternatively, create a grouping run setting by
choosing Grouping Run. In either case click OK to continue in the creation of the run setting.

Setting up a calculation run setting


If you are creating a Calculation Run setting then the "Run Setting - Calculation Run" dialog is displayed.
You then do the following:
n

Enter a name for the run setting

Enter values into the following tabs for the type of run that is required:

Run Parameters tab


Contains items such as the start date, the period of the run, the run numbers used by the run and advanced
settings relating to run processes and the batch programs facility

Tables tab
Specifies the names and locations of the tables used in the run.

Managing run settings

Plugins tab
Options on this tab allow you to specify the locations of Intex and Andrew Davidson data files, if you have
licensed either of those components. For more information see Plugins Reference.

Results tab
Specifies the types of results to be created in the run to be specified together with error control settings

Runtime Configuration tab


Specifies the type of the run and the configuration of the run when running in Parallel PC mode.

Actuarial Documentation
This tab displays the Actuarial Documentation for the run setting. The documentation is managed using the
Actuarial Documentation feature.

411

Refer to the "Run Settings options" for details on each of the tabs in the Run Setting - Calculation Run dialog.
To save the run setting click OK.
Note the following:
n

Dynamic and stochastic run setting options are not available if the Dynamic and Stochastic module has not
been licensed.

Deleting a run setting


To delete a run setting, select the run setting in the Run Settings page list view and in the Edit section of the Home
tab click Delete. Alternatively, select the run setting to be deleted in the Structures & Run Settings pane and from
the right click menu choose the Delete option.
In either case, when prompted to confirm the deletion, click Yes.
The selected run setting and the associated Actuarial Documentation is deleted and the list of run settings updated.

412

Chapter 11 Run Settings

Duplicating a run setting


To duplicate or copy an existing run setting, select the run setting in the Run Settings page list view and from the
Edit section of the Home tab click Duplicate. Alternatively, select the run setting in the tree pane of the Structures &
Run Settings pane and from the right click menu choose the Duplicate option.
In either case the Run Setting dialog box for the new run setting appears. Assign a new name to the run setting,
make any changes you want to make and click OK. The run setting together with its related actuarial documentation
is created with the name of the run setting added to the list of run settings.

Run setting options

413

Run setting options


When you open an existing calculation run setting or create a new one the Run Setting - Calculation Run dialog
box appears.

You enter or update the name of the run setting. You can also specify whether the run is dynamic or stochastic by
selecting the Dynamic and/or Stochastic options at the top of the dialog box.
You specify the run setting items in the following tabs:
n

Run Parameters tab


Contains items such as the start date, the period of the run, the run numbers used by the run and advanced
settings relating to run processes and the batch programs facility

Tables tab
Specifies the names and locations of the tables used in the run.

414

Chapter 11 Run Settings

Plugins tab
Options on this tab specify the locations of Intex and Andrew Davidson data files, if you have licensed either of
those components to enable Prophet to calculate Collateralized Mortgage Obligations (CMOs). For more
information see Plugins Reference.

Results tab
Allows the types of results to be created in the run to be specified together with error control settings

Runtime Configuration tab


Specifies the type of the run and the configuration of the run when running in Parallel PC mode.

Actuarial Documentation
This tab displays the Actuarial Documentation for the run setting. The documentation is managed using the
Actuarial Documentation feature.

To save the run setting click OK.


Note: Note that the dynamic and stochastic run setting options are not available if the Dynamic and Stochastic
module has not been licensed.

Run setting options

415

Run Setting - Run Parameters tab


You set the various run parameters for the run setting in this tab.

This tab has the following sections:


n

General Run Parameters


This section allows you to specify options that must be specified. Items that are specified include the period and
duration for which results are generated.

Run Numbers
This section allows you to specify run numbers which are used to identify sets of values in a global file and the
names of the folders into which the results for each run are stored.

416

Chapter 11 Run Settings

Stochastic Simulations
Allows you to specify the number of simulations to be run. This section is only available if the Stochastic option
is selected in the Run Settings dialog box and the Dynamic and Stochastic module is licensed.

Dynamic Properties
Allows you to specify the additional settings needed for a dynamic run. This section is only available if the
Dynamic option is selected in the Run Settings dialog box and the Dynamic and Stochastic module is licensed

Advanced Options
A number of specialised options for the run setting are available from the Advanced Settings dialog box which is
displayed when you click Advanced in the Run Parameters tab.

Each of these is further described in the following sections.

General Run Parameters


General options in the Run Parameters tab of a run setting allow you to specify the period for which the results are
to be generated. You can also results are to be created in Prophet's internal results format. The section appears
similar to the following:
The settings for this tab are as follows:

The following can be specified:


Start Date
The start date is used to specify the start date of the projection. Choose the appropriate start date from the drop
down calendar. This date should be consistent with the existing business policy data in the model point files to be
used in the run.

Run setting options

417

Note: If you are using the standard libraries supplied with Prophet, only the start month and the start year are
used in the calculations. The start day is ignored.
Future Accumulation Period
This is the number of years of projected results to be included in the projection results produced by Prophet.
The actual calculations for liability products are always continued until at least the end of the policy term to ensure
that items such as the discounted values of future profits are properly calculated. However, if the projection is to be
used for just looking 5 years ahead, then restricting the period for which results are retained can help reduce the
disk storage required and the run time.
Past Accumulation Period
This is the number of years of past results to be included in the projection results produced by Prophet. In particular
it enables you to produce reports that show the results of any asset share or other calculations in the past.
Month in which Company Year Ends
Choose the month number for the last month of the company year for your company.
The projection results that Prophet produces always start from the company year end coincident with or
immediately preceding the start date.
Only run first model point for each Sub-Product Code
Select this option if you only want to run the first model point for each sub-product. This option can be useful when
testing the calculations. It cannot be selected if the Project new business method is selected in the Configuration
tab of a structure. .
Maximum Projection Term
This option specifies the maximum projection term in years to be specified. The default setting is 199 years when
Default is selected. If the projection term is expected to be greater than 199 years then deselect Default to specify
the new term in years. Note that setting the value to greater than 199 years increases the demand for system
resources and consequently run process times may be extended.

Run Numbers
You enter the run numbers to be included when the run setting is run in the Run Numbers text box.

418

Chapter 11 Run Settings

Either enter the run numbers manually or click + and select them from the Select Run Numbers dialog box.
Run numbers are used to:
n

Identify the sets of values used in a global file. This in turn impacts on the calculations performed.

Identify the sub-folders into which the results are placed.

You can think of run numbers as identifying alternative scenarios that you want to evaluate.
You can assign a description to each run number in the Descriptions dialog box which is displayed when you
choose Descriptions in the Options dialog box. For more information refer to "Describing run numbers and subproducts" in the Prophet options chapter of this manual.

Stochastic Simulations
This option allows you to enter the simulation numbers to be run.

They should be separated by commas, with a range separated by a hyphen. For example:
1,2,10
1-5000
1,4-12,25,55-98,200-230,4097
The minimum simulation number is 1 and the maximum is 100,000. All the simulation numbers must be entered in
strictly increasing order. This option is available when the Dynamic and Stochastic module is licensed.
Retain results for simulations already run
Select this option to append additional stochastic results to those that were generated by a previous run. For

Run setting options

419

example, you can make a run using simulation numbers 1-100 and then run simulations numbers 101-1000 with
the results appended to the end of the existing results files.
Additional settings for a stochastic run are specified in the Stochastic Run section of the Results tab of the Run
Setting.

Dynamic properties
If you wish to make a dynamic run then you should select the Dynamic option in the Run Setting dialog box. You
will then be able to make entries in the remainder of this section which appears similar to the following:

Note: The Dynamic Properties section is unavailable if the Dynamic and Stochastic module has not been
licensed.
Settings for this section are as follows:
Dynamic Projection Period
You can choose one of the following options:
n

Same as Future Accumulation period


Choose this option if the period for dynamic calculations is to be the same as the future accumulation period set
in the Run Parameters tab.

For ... Years


Choose this option to limit the period for dynamic calculations and select the number of years required.

The following can be specified:

420

Chapter 11 Run Settings

Dynamic Loop at Start


Select this option if you want to have a dynamic loop at the start of the run. This allows the decision processes in the
run to be carried out at the Start Date.
This option only has an effect if the Start Date coincides with a company year end.
Dynamic Loop at End
Select this option if you want to have a dynamic loop at the end of the run. This allows the decision processes
carried out in the last month of the projection to be reflected in, for example, the mathematical reserves, embedded
values and tax calculations for that last month.
Include New Business in Initial Accumulations
Select this option to specify whether new business is to be included when the accumulations are first run in each
dynamic loop. This enables the new business to be excluded initially so that embedded values can be calculated
using updated bases at each year end on the assumption that the company is closed thereafter to new business.
In this circumstance, the REPEAT_LEVEL function is then normally used within the product calculations to cause
the accumulations to be repeated, this time including new business, so that other fund and company level
calculations can then be calculated allowing for new business.

Run setting options

421

Advanced Settings
You can supplement the settings in the Run Parameters tab of a run setting by specifying the following in the
Advanced Settings dialog box:
n

Product run order

Seed values used in both stochastic and non-stochastic runs

File creation and deletion options

Batch programs

To display the Advanced Settings dialog box click Advanced in the Run Parameters tab of a run setting. The
dialog box appears similar to the following:

The dialog box has two tabs:


n

Run Process tab


Contains options to control the order in which products are run, specify seed values when making stochastic

422

Chapter 11 Run Settings

runs and file creation and deletion options. For details see Run Process tab below.
n

Batch Programs tab


Allows you to specify additional programs that can be run at various points in a run. For details see Batch
Programs on page426.

Run Process tab


From this tab in the Advanced Settings dialog box of a run setting you can specify additional run setting options.
The tab appears similar to the following:

Options from the Run Process tab allow you to specify:


n

The order in which the products in a structure are run

The seed values for stochastic runs

File creation and deletion options

The options are described in more detail as follows.

Run setting options

423

Product Run Order


This section allows you to define the order in which the products are to be run.

You can choose one of the following:


n

Descending Size
Products with the largest model point files at a particular level are run first with those having the smallest model
point files run last.

Selected Order
The order in which products are run is determined by the order of the products in the structure.

You should normally choose the Descending Size option if you will be using Parallel PC Mode because it reduces
the likelihood of the largest products continuing to run after all the others have been completed.

Seed Values
Settings in this section are available when Stochastic is selected for the Run Setting.

The settings enable you to control the seeding of the random number generator used by the Prophet statistical
functions. If stochastic simulations are not performed then the seeding of the random functions is based on the
internal PC clock.

424

Chapter 11 Run Settings

If stochastic simulations are performed, then you can either seed the random number generator using values based
on the internal PC system clock or specify specific seed and step values.
To seed the random number generator you can:
n

Use the internal PC clock by choosing Based Upon System Clock, or

Specify values by choosing Specific Seed Values and then entering an initial seed value in the Initial Seed text
box and a step value in the Step Value text box.

If you specify the seed values for seeding the random number generator then the seed value for each simulation is
derived according to the following formula:
SeedValue = (MOD('InitialSeed' - 1 +
'StepValue' x (Simulation-1), 211587619)) + 1

The seed value is reset at the start of each product and is based upon the current value of the simulation. This
means that running the identical product will produce identical results.
The MOD function is used to prevent the seed value becoming too large. The large number 211587619 is prime
number and is specified as a limit since it can be used over a large number of simulations without repetition.
For information on Prophet Statistical functions see Statistical functions.

File Deletion/Creation
This section allows you to specify file creation and deletion options.

Settings for this section are as follows:

Run setting options

425

Level Number below which Results Files automatically deleted


Choose the appropriate level number below which results are to be automatically deleted on completion of a run. 1
indicates that no results will be deleted.
First Level Number for Stochastic Results Files
Choose the first level number for which stochastic results are to be created in a stochastic run. This option can be
used to prevent results being produced for, say, liability and asset products if you are only interested in looking at
the stochastic results at the Summary and Global Strategy product level.
First Level Number for which Cumulative variables are included in Results Files even if Selected variables
chosen
Choose the first level number for which cumulative variables are to be included in the results even if selected
variables are chosen in the Results Files section. This should typically be set at the lowest level at which you run
any summary or global strategy products. This then ensures that sufficient values are stored in the results to enable
the calculations in these products to work correctly, regardless of which variables are defined to be Selected
variables.
Delete Accumulation Results from Lowest Level
If you select this option then at the start of the run all existing accumulation results will be deleted for accumulations
with a level number at or above the level number of the lowest product or accumulation in the run. This ensures that
out-of-date accumulation results are not included in the run.
If you do not select this option the deletion does not occur, which can be mean that fewer accumulations can be
included in the run but you need to ensure yourself that out-of-date accumulation results files are not used.
Retain Binary Model Point Files
Select this option to keep the binary model-point files that are created during a run from the original text format.
When the run is subsequently repeated the binary files are used again only if no changes have been made to the
text model point files.This helps to improve performance as fewer files need to be converted during runtime.
For example, a run may made be performed multiple times each of which may only have small changes to the
product, MP file or table.

Results Retention in Memory


Settings in this section allow you to specify the number of years of results that are stored in memory.

426

Chapter 11 Run Settings

This option is mainly for use in ALM runs where there is a base product that feeds information into liability products,
typically to calculate asset shares for UK with profit business. The value specified can be accessed within a Prophet
formula using a new function RESULTS_RETENTION_Y.

Batch Programs
From this tab in the Advanced Settings dialog box of a run setting you can specify that additional program files of
your own are to be run at various points during a Prophet run. The tab appears similar to the following:

The options in this tab allow you to specify programs that can be run at the start or end of a run or a run number.
Hence, at each point, you can specify that a batch file (.BAT) or a program file (.EXE or .COM) is run.
Note that results generated by a run are merged at the workspace-level at the end of each run number. This
enables an end-of-run-number batch files to access the results. However, the logs generated during the run are not

Run setting options

427

indexed and so not available until the end of a run. If you need to copy the logs then they will only be available at
the end of the run using an end of run batch file or application.
n

For the Start/End of Run option you must have around the location of the batch file you wish to use. (This is
not necessary for the Start/End of Run Number)

You can pass parameters to the batch file when using the Start/End of Run but you cannot with the Start/End
of Run Number.

Possible uses for using a batch program


Possible uses for some of the options in the Batch Programs tab in the Advanced Settings dialog box of a run
setting are:
Start of Run
You can run a program that creates the model point files before the Prophet run commences.
For example, if you have created a DCS program called DATAGEN.DCS in the C:\DCS folder to generate your
model points and have compiled it, you can enter "C:\DCS\DATAGEN.EXE" here to run it at the start of each
Prophet run.
End of Run
You could enter the name of a batch file that could be used, for example, to load a database application and run a
script to import and accumulate together the individual model point results files that have been produced in the run
for different products.

428

Chapter 11 Run Settings

Run Setting - Tables tab


From this tab you specify the locations and names of the files and tables to be used by the products during a run.

From this tab you can specify the following:


n

The location and file name extension of the model point files

The name and location of the global, parameter, unit prices and sales files

The name and locationof the Table of Tables which contains the names of tables referenced by product and run
number. The READ_TABLE_NAME function.is used to look up a table name in a Table of Tables.

The locations of other tables


Note: Unit Prices files are rarely used in a run so this entry is usually empty.

Run setting options

429

In all cases, you can either enter the location or click Browse to locate the file or folder. To change the entries for
the file and table locations to their default settings click Default. To check that all files and locations exist click
Validate.
For Table Location(s) you can:
n

Manage the table locations by clicking Browse and then add, replace, delete or rearrange table locations from
the Table Locations dialog box.

Enter more than one table location in the Table Location(s) text box by separating the locations with commas,
for example TABLES, TABLES2.
Note: The location of mortality tables cannot be changed. The location is specified during the installation
process. The location is displayed in the Table Options setting of the Options dialog box which is accessed from
the Prophet menu. See Table Options setting in the Prophet options chapter of the the User Guide.

For Parameter files you can:


n

Manage the parameter files by clicking Browse and then add, replace, delete or rearrange the files from the
Parameter Files dialog box.

Enter more than one parameter file in the Parameter File(s) text box by separating the locations with commas.

You can either enter the paths to the locations of the files and tables relative to the workspace location or enter the
complete path. You should normally only use the latter option when the files or tables are stored outside the
workspace.
You can express the complete path to the location of any of the files and tables using either of the following formats:

K:\PROPHET\TABLES
\\EPS-S129\PROPHINS\PROPHET\TABLES

However, we recommend that you avoid use of the first of these formats if you are using Parallel PC mode. This is
because there is a risk that one or more of the Worker PCs use the drive letter specified here to identify a different
network drive.

430

Chapter 11 Run Settings

You can leave entries blank if particular files are not required. In particular, if you leave the Sales File location
blank, no new business processing using either the cross-multiplication or the Project new business method will be
performed.
Note: If at run time Prophet cannot find any table used by a product in the first specified location it will then look
in each of the other specified locations for it.

Run setting options

431

Run Setting - Plugins tab


The settings on this tab allow you to specify the locations of the Intex and Andrew Davidson data files. Note that the
settings are only available if the respective plugins have been installed and are also enabled in the Plugins setting
of the Options dialog box. A typical Plugins tab for a system that has the Andrew Davidson and Intex plugins
installed and enabled appears similar to the following:

The tab has the following sections which can be exposed or hidden by clicking the up / down icons on the page of
the dialog box.
Adco section
This setting allows you to specify the location of the data file needed to run the Andrew Davidson Pre-Payment
model.

432

Chapter 11 Run Settings

If you have licensed the Andrew Davidson pre-payment model then you can enter the location of the folder
containing the ADCO files or click Browse to navigate to and select the folder location in which the data files exist
To set the location to the default setting click Default.
To check that the entered location contains a valid plugin dll click Validate.
For information on using Prophet ADCO functions see the help supplied with the ADCO Plugin.
Intex section
This section allows you to specify the location of the supplied Intex data files used by Prophet Intex functions.

Note that Intex functions are not processed if these locations are not specified or if the files do not exist. You need to
specify:
n

Intex CDI directory


Enter the location of the folder containing the Intex CDI files and folders or click Browse and navigate to the
location.

Run setting options

433

Intex CDU directory


Enter the location of the folder containing the Intex CDU file or click Browse and navigate to the location.

Andrew Davidson Directory


If the Intex plugin uses the Andrew Davidson plugin then enter the location of the folder containing the Andrew
Davidson files. Alternatively, click Browse and navigate to the location. Note that this location will be the same
as that entered in the Andrew Davidson section of this tab.

Log used indexes


Select this option to log and save the indexes for each CUSIP. The logged indexes are saved in the standard
results folder area of the workspace.

To set the location to the default setting click Default.


To check that the entered location contains a valid plugin dll click Validate.
Note the following:
n

The CDI folder contains deal model description files organised by month. The CDU folder contains deal update
files also organised by month. The management of these file is the responsibility of the user.

For information on using Prophet Intex functions see the help supplied with the Intex Plugin.

434

Chapter 11 Run Settings

Run Setting - Results tab


From this tab you can specify the types of results you wish to have created. You can also set a limit on the number
of errors or warnings. The tab appears similar to the following:

This tab has the following sections:


n

Results Files
Allows you to specify the types of Prophet results to be created during the run and the variables they are to
contain.

Text Results Files


Allows you to specify the types of text results files to be created during the run. In addition it also allows you to
specify whether individual model point results files are to be created during the run.

Run setting options

Error Control
Sets the number of errors and warnings which are allowed to occur before a product or accumulation is
terminated.

Stochastic Run
Sets various options relating to stochastic results files created during a run.

435

Results Files
From this section of the Results tab of a run setting you can specify what results are to be created in Prophet's
internal results format. The section appears similar to the following:

Settings for this section are as follows:


Projection / NB Profile
Select this option to produce projection and/or new business profile results
Valuation
Select this option to produce valuation results by maturity year and current age
Accumulation Results
Select this option to retain the results generated by accumulations. The option is generally used to debug runs.
When selected, the accumulation results files can be displayed in the Projection and NB Profile folders of the tree
displayed in the Results & Runlogs pane.
The name of an accumulation results file is the name of the accumulation followed by the extension .acc.proj if the
results file is listed in the Projection folder. If new business files are also being accumulated then an equivalent
results file is shown in the NB Profile folder with an extension of ..acc.newbus.

436

Chapter 11 Run Settings

Note: To group accumulation results in folders in the tree displayed in the Results & Runlogs pane you have to
specify the grouping settings in the Tree Options setting of the Options dialog box. The dialog box is displayed
when you click Options from the Prophet menu. See Tree Options setting in the Prophet options chapter.
Intermediate Dynamic
Select this option to retain the intermediate results generated in dynamic runs. The option is used to debug dynamic
runs. When selected, the intermediate results files are listed in the Intermediate folder of the tree displayed in the
Results & Runlogs pane.
For more information see Viewing dynamic intermediate model point files. Also refer to The processes in a dynamic
run.
Note: To retain the results files make sure that settings in the File Deletion/Creation section of the Advanced
Settings dialog box are set appropriately. The dialog box is displayed when you click Advanced in the Run
Parameters tab of the run setting. For more information see Advanced Settings.
Dynamic debug
Select this option to store a copy of the results files at the end of each dynamic loop to help with debugging.
Variables in Results Files
You can specify which variables are to be included in the results files from the following options:
n

Selected
Variables in a selected variable group are included in the results. To select the variable group click Variable
Group. When a variable group is selected it is displayed below the selected option.

Cumulative
Only cumulative variables are included in the results

All
All variables are included in the results

Note the following:

Run setting options

437

The Cumulative setting overrides the Selected setting for all products and accumulations with level numbers
above a level number which you can specify in the Advanced settings dialog box.

Variables that are calculated in a run are specified in the Calculated Variables section of the Configuration tab
of a Structure.

Product Total Results Files (00)


Options in this area allow you to specify which Product Total Results files can be suppressed. This can improve run
times and reduce unnecessary disk space as unwanted results files are not created.
You can choose one of the following to specify whether results are created for every sub-product code and/or for
the product as a whole.
n

Create results files for all sub-product codes plus product totals

Only create results files for the sub-product codes

Only create results files for product totals

The default setting is to create results files for both sub-product codes and product totals.
For more information, see "Types of Results"in the Results chapter of this manual.

Text Results Files


From this section of the Results tab of a run setting you can specify which results files are to be created in text
format. The section appears similar to the following:

Settings for this section are as follows.


Projection / NB Profile
Select this option to produce projection and/or new business profile results files in text format.

438

Chapter 11 Run Settings

These text format results files contain monthly values for the Future Accumulation Period for all the variables
defined as text output variables in the Variables dialog accessed from the Variable setting of the Options dialog.
.To display the Options dialog click Options from the Prophet menu.
Note: If a variable is time independent (constant) within the product and spcode then no text output is produced,
the values can then be viewed in the constant section of the normal results file from within Prophet.
Valuation
Select this option to produce valuation results files by maturity year and current age in text format.
These text format results files contain the values calculated at the Start Date for all the variables defined as text
output variables in the Variables dialog accessed from the Variable setting of the Options dialog. To display the
Options dialog click Options from the Prophet menu.
Individual Model Point Results Files
You can specify the type of individual model point results files that are produced as comma delimited format files.
These files contain one line for each model point with the values calculated at the Start Date. You also, optionally,
create model point results files calculated from a time period offset by a specified number of months.
To specify the generation of Individual Model Point Results Files:
n

In the text Results Files section select Individual Model Point Results Files

Choose the variables to include in the model point files by clicking Variable Group and selecting a variable
group.

Optionally, to create additional model point files produced from an offset time period relative to the current start
date of the projection select Additional Time Period and enter the offset in months.
Note the following:

The filename for a standard model point file takes the form: PRODUCT.rpt. For example, C_WEND.rpt.

The filename for a model point file calculatedfrom an offset time period takes the form: PRODUCT.t.rpt, where t
is the offset time period in months. For example, C_WEND.7.rpt where the offset is 7 months.

Run setting options

439

The offset time period is restricted to 999 months and is not available for dynamic runs. it must also not exceed
the future accumulation period.

For more information, see "Individual model point results" inthe Results chapter of this manual.
Note: Variables are assigned to a variable group specified in the Variable Groups dialog which is accessed
from the Variable Groups setting of the Options dialog. To display the Options dialog click Options from the
Prophet menu.

Error Control
From this section of the Results tab of a run setting you can specify the number of errors and warnings that can
occur before Prophet terminates the calculations for any product or accumulation.

Settings for this section are as follows.


Maximum Number of Errors before Termination of a Product
Either select No Limit for Prophet to continue the calculations irrespective of the number of errors or choose the
required number.
The default is 0 which means that a product will be terminated when the first error occurs. If you enter 10 a product
will only be terminated when the 11th error occurs. If you select No Limit Prophet will continue the calculations
irrespective of the number of errors that occur.
If the number of errors for a product is within the limit you specify results will be produced which exclude the results
for any model points in error. Details of these errors are written to an error log for that product.
If the number of errors exceeds the limit you specify then no results will be produced for that product.

440

Chapter 11 Run Settings

If you have a large number of model points it is better to enter a limit such as 200. Otherwise, an error which applies
to all model points could easily result in the run log and error log becoming so large that your PC runs out of disk
space and all subsequent products then failing to run.
Maximum Number of Warnings before Termination of an Accumulation
Either select No Limit for Prophet to continue the accumulation process irrespective of the number of warnings or
choose the required number.
If, for example, the sub-product code range is "1,10-12" then a warning is generated if results do not exist for subproduct code 1. Similarly, a warning is generated if results do not exist for a sub-product code in the range 10 to 12.
A warning is also generated if no results exist for the product.

Stochastic Run
If you wish to make a stochastic run then you should select Stochastic in the run setting. You will then be able to
make entries in the remainder of this section which appears similar to the following:

The Stochastic settings section is not available if the Dynamic and Stochastic module is not licensed.
Settings for this section are as follows.
n

Number of Years Monthly Results Retained


Choose the number of years for which monthly stochastic results should be retained. You can use this option to
minimise the size of the results files. Annual stochastic results are always retained for both the Future and the
Past Accumulation Periods.

Variables in Stochastic Results Files


You specify the variables included in the stochastic results files from this section. You first select the variable
group category from the Category dropdown list and the variable group containing the required variables from
the Name dropdown list.

Run setting options

441

Note: Variables are assigned to a variable group specified in the Variable Groups dialog which is accessed
from the Variable Groups setting of the Options dialog. To display the Options dialog click Options from the
Prophet menu.
n

Calculate Stochastic Summary results


Select this option to create stochastic summary results using Prophet that can be opened and used by the
Prophet Excel Reporting add-in. To specify the results to be generated click Advanced to access the Stochastic
Summary Calculations dialog.
Prophet calculates stochastic summary statistics for:

All variables specified in the Variable for Stochastic results files section.

All products in the Structure (unless the variables do not exist in that product or you have selected advanced
options in the parameters tab of the Run Setting.

All time periods

All statistics specified.

Also note the following:

Details of the start and finish time together with any errors or warnings are logged in the run log.

If a statistic is not in the file created at runtime then calling the statistic from Excel will add the new statistic
results to the original file

Be careful for what you select for stochastic summary results as this can significantly increase runtime and use a
lot of memory.

The generated stochastic summary results caches one statistic, variable and time period at a time.

Only the percentile that is required is created.

The statistics that are available are the same as those in Prophet Excel Reporting Release 8.2.3.

442

Chapter 11 Run Settings

Other related stochastic run options


Other related stochastic run options that can be specified are:
n

The number of stochastic simulations to be performed. See Stochastic Simulations in Run Setting - Run
Parameters tab

Specify the seed values used by the Prophet Statistical functions. See Seed Values in the Run Process tab

Run setting options

443

Run Setting - Runtime Configuration tab


The settings in the Runtime Configuration tab allow you to specify the default runtime options. These settings are
subsequently displayed in the Select Run Pairs to be Run dialog box before the run setting is run.
Note that the runtime settings displayed in the Select Run Pairs to be Run dialog box can only be changed if:
n

A single run pairing is run, or

The "Override Run Setting Runtime Configuration" option is available in the Select Run Pairs to be Run dialog
box and a single run pairing contains a grouping run or a multiple number of run pairings is to be run.

The Runtime Configuration tab of a run setting appears similar to the following:

The available run options are:

444

Chapter 11 Run Settings

Type of Run
Options in this section enable a run to be run completely or started from a specified level number, cross
multiplication or first dynamic level. The run can also exclude any cross multiplication process. You can also just
compile the products using the compiler specified in the Compiler setting of the Options dialog box which is
accessed from the Prophet menu.

Method of Run
Options in this section enable a run to be carried out on the local PC or run in conjunction with other PCs using
either a default or specified PC configuration. You can also specify to run the run pairings using the Prophet
Enterprise infrastructure..See Using Prophet Enterprise Resources.

Split Run By
Options in this section are only available for multiple PC runs. The run can be split by product, run number or
simulation.
Note: The Start from first Dynamic Level option is only available when Dynamic is selected in the run setting.

Type of run
A number of options for the type of run are available in the Type of Run section of the Runtime Configuration tab of
a run setting. The section appears similar to the following:

These options allow you to start a run from a point part way through that specified in the structure. You can thus
avoid having to remove all the products and accumulations that have already been run from the structure or having
to set the Sales file to be blank, to switch off the cross-multiplication process.

Run setting options

445

The options selected from this dialog are applied to all selected run pairings based on the setting in the first run
pairing.
Note: Any options for the type of run that are not appropriate are dimmed.
Choose one of the following:
Complete
Selecting this option instructs Prophet to carry out the entire run as specified in the run pairing.
Start from Level Number
If you select this option, you must also select a level number. All the products and accumulations with level numbers
below the selected level number are then excluded from the run. In addition, if the level number for cross
multiplication is below the selected level number then cross multiplication is suppressed.
Start from Cross Multiplication
If you select this option, products at or below the level number for cross multiplication and accumulations below that
level are excluded from the run.
This option is useful if all you have done since the last run is change the volumes of future new business in the
Sales file.
Note: The level number for cross multiplication is set in the New Business Method section in the Configuration
tab of the structure being used. See Structures - New Business Method.
Start from first Dynamic Level
If this option is selected products and accumulations in levels with a dynamic period of E are suppressed if those
levels are below the levels which are calculated dynamically.
For example, this option could be used in the situation where the decision process only affects with profit products
and hence all the non profit products can be run at a lower level with a dynamic period of E. Selecting this option
then causes only the with profit and higher level products to be run.
For more information, see "Structures - Dynamic tab.

446

Chapter 11 Run Settings

No Cross Multiplication
Selecting this option suppresses the cross multiplication process.
Compile Only
Selecting this option just compiles the products using the compiler specified in the Compiler option in the Optons
dialog accessed from the Prophet menu.

Method of Run
The Method of Run section in the Runtime Configuration tab of a run setting appears similar to the following:

From this section you can set one of the following options:
n

Local Machine
The selected run pairings are run on the current PC. This is the default setting.

Multiple Machines
This setting enables the selected run pairings to be run across the selected networked PCs which can be
inspected and re-selected from the Select Machines dialog box which is accessed by clicking Change. See
Configuring Worker PCs before running a Parallel PC run for more information.

Default Machines
This setting is similar to the Multiple Machines setting. It enables the selected run pairings to be run across a
default set of networked PCs. The default set is specified in the Machine Selection setting of the Options dialog
box which is accessed from the Prophet menu.
If Multiple Machines or Default Machines is selected you can specify how a run is split across the networked
PCs in the "Split Run By" section.

Run setting options

447

Prophet Enterprise
This setting enables the selected run pairings to be run using the Prophet Enterprise worker machines. To
specify the characteristics of the Prophet Enterprise system click Settings to display the Prophet Enterprise
settings in the Options dialog box.
For more information on how to configure Prophet Professional to use Prophet Enterprise resources see See
Using Prophet Enterprise Resources.

Split Run By
If Multiple Machines or Default Machines is set in the Method of Run section in the Runtime Configuration tab of a
run setting then the following Split Run By section becomes available:

From this section you can specify how a run is split across multiple networked PCs. You can split a run by:
n

Products
Choose this option to run each product in the run on a separate machine.

Run Numbers
Choose this option to run each complete run number on a separate machine.

Simulations
Choose this option to run each complete simulation on a separate machine. This option is of most benefit when
carrying out dynamic or stochastic runs unless a DFA run is being carried out in which case the Run Numbers
option will normally give better performance.

448

Chapter 11 Run Settings

Run Setting - Actuarial Documentation tab


From this tab you can display the actuarial documentation associated with the run setting. If no documentation is
specified for the run setting then the tab appears similar to the following:

You add or edit documentation for the run setting in the Actuarial Documentation window which is displayed when
you click Global Actuarial Documentation from the Support tab. See Managing Actuarial Documentation for more
information.

Printing run settings

449

Printing run settings


To print the details of one or more run settings select them in the Run Settings page list view and from the Prophet
menu choose Print. The following Print Run Settings dialog box is displayed:

From this dialog box you can print either the list of run settings displayed in the Run Settings view or the details for
those run settings you have selected.
Choose what you want to print and click OK. To see what is to be printed click Preview.

450

451

C H A P T E R

1 2

Runs

TOPICS IN THIS CHAPTER


What is a run?

452

Running one or more run pairings

453

What happens during a run?

466

Parallel PC mode

470

Minimising the run time

481

Example Model Office

483

452

Chapter 12 Runs

What is a run?
A run is the process by which the calculations you specify are evaluated.
You can run an individual product or accumulation or you can run a number of products and accumulations
together by including them in a structure and then running that structure. You can also run more than one structure
at a time or can run a structure in more than one way at a time, by pairing it with a number of different run settings.
n

To run an individual product, see "Running products" .

To run an individual accumulation, see "Running an accumulation".

Using Parallel PC mode a run can be split up by product, run number or simulation and processed by a number of
networked PCs. In this mode of operation the PC that initiates the run is known as the Master PC and the specified
PCs on the network which are controlled by the master PC are known as Worker PCs. By utilising such a
configuration you can significantly reduce the time needed to perform large and complex runs.
Run pairings
To run one or more structures you pair them with one or more run settings to create run pairings. You then select
the run pairing or run pairings to be run. Each run pairing is a combination of a structure and a run setting. It
provides all the information Prophet needs to process a run.

Running one or more run pairings

453

Running one or more run pairings


Model office projections and valuations are usually run by selecting and running one or more run pairings of
structures and run settings from either the Structures page list view or from the Run Settings page list view.
n

To run one or more structures


Select the structures in the Structures page list view and from the Home tab click Run.

To run one or more run settings


Select the run settings in the Run Settings page list view and from the Home tab click Run.

In either case, the Select Run Pairings to be Run dialog box is displayed.

The Select Run Pairings to be Run dialog box lists the structures or run settings that are selected in the Structures
or Run Settings page list view. It also assigns to each the most recently used run setting or structure that was used
for that structure or run setting.
Options are also provided that enable you to specify how the selected run pairings are run.

454

Chapter 12 Runs

Changing run pairings


Changing run pairings
From the Select Run Pairings to be Run dialog box you can:
n

Select and open a run pairing to change the structure and/or run setting for it

Add a new run pairing to the list to be run

Delete an existing run pairing from the list to be run

Display the details of the structure and run setting for a run pairing

Specify the order in which the run pairings are run

Run pairings run options


Settings in the Select Run Pairings to be Run dialog box, with the exception of Regenerate, replicate those
specified in a Run Setting. Note that:
n

For a single Calculation Run Setting


All run pairing run options can be edited.

For multiple run pairings or a single pairing containing a grouping run setting
With the exception of the Regenerate setting, none of the other settings can be changed. To edit the Type of
Run, Method of Run and Split Run settings select Override Run Setting Runtime Configuration.

In general, the settings in this dialog box, with the exception of Regenerate, are used to modify specific run settings.
The changes to these settings are saved in a temporary run setting file and exist only for the duration of the run. The
settings are subsequently lost.
The available settings are organised into the following sections:
n

Parameters section
The options allow you to override the settings in the Run Parameters tab of the Run Setting specified in the Run
Pairing.

Running one or more run pairings

455

Type of Run section


The options in this section allow you to override the settings in the Runtime Configuration tab of the Run Setting
specified in the Run Pairing. You can enable a run to be run completely or started from a specified level
number, cross multiplication or first dynamic level. The run can also exclude any cross multiplication process.
You can also just compile the products using the compiler specified in the Worker setting in the Options dialog
box accessed from the Prophet menu.

Method of Run section


The options in this section allow you to override the settings in the Runtime Configuration tab of the Run Setting
specified in the Run Pairing. Options allow a run to be carried out on the local PC or run in conjunction with
other PCs using either a default or specified PC configuration. You can also specify to run the run pairings using
the Prophet Enterprise infrastructure.

Split Run By section


The options in this section allow you to override the settings in the Runtime Configuration tab of the Run Setting
specified in the Run Pairing. The options are only available for Parallel PC runs. Runs can be split by product,
run number or simulation.

Regenerate section
Provides options to regenerate some or all of the products in a run. This option is available for all run pairings.

Messages section
If Prophet identifies any issues that may degrade the performance of the run then it will display them in the
Runtime Performance Hints dialog box together with any appropriate advice. To prevent the Runtime
Performance Hints dialog box from being displayed select the "Do not show any runtime performance hints"
option.
Note: The option in this section is only available when you run a single run pairing.

456

Chapter 12 Runs

Parameters section
Options in the Parameters section of the Select Run Pairings to be Run dialog box replicate those in the Run
Parameters tab of the Run Setting. The options can be edited only if a single Run Pairing is used which contains a
Calculation Run Setting.
The settings in this section are taken directly from the corresponding options in the Run Parameter tab of the Run
Setting specified in the run pairing. It appears similar to the following:

For details of the options that can be changed refer to the Run Setting - Run Parameters tab.
Note the following:
n

The changes that you make to the parameters are temporary and last only for the duration of the run. At the end
of the revised run the settings are lost.

The name of the temporary Run Setting that is created from the settings is prefixed by an underscore character
and listed in the run log. For example, a Run Setting named Model Office is listed as _Model Office in the run
log.

If you have more than one run pairing then this section cannot be edited. However, the contents of this section
reflect those in the Run Setting when you selected for the run pairing.

Running one or more run pairings

457

Type of Run section


Options in the Type of Run section of the Select Run Pairings to be Run dialog correspond to and replicate the
Type of Run section of the Runtime Configuration tab of the Run Setting. The options can be edited only if a single
Run Pairing is used which contains a Calculation Run Setting.
The settings in this section are taken directly from the corresponding options in the Runtime Configuration tab of the
Run Setting specified in the run pairing. The section appears similar to the following:

The main purpose of these options is to allow you to start a run from a point part way through that specified in the
structure. You can thus avoid having to remove all the products and accumulations that have already been run from
the structure or having to set the Sales file to be blank, to switch off the cross-multiplication process
The options selected from this dialog are applied to all selected run pairings, based on the setting in the first run
pairing.
Note: Any options for the type of run which are not appropriate are dimmed.
From the Type of Run section in the Select Run Pairings to be Run dialog click one of the following:
n

Complete
Selecting this option instructs Prophet to carry out the entire run as specified in the run pairing.

Start from Level Number


If you select this option, you must also select a level number. All the products and accumulations with level
numbers below the selected level number are then excluded from the run. In addition, if the level number for
cross multiplication is below the selected level number then cross multiplication is suppressed.

458

Chapter 12 Runs

Start from Cross Multiplication


If you select this option, products at or below the level number for cross multiplication and accumulations below
that level are excluded from the run.
This option is useful if all you have done since the last run is change the volumes of future new business in the
Sales file.
Note: The level number for cross multiplication is set in the New Business Method in the Configuration tab of
the structure being used. See Structures - New Business Method.

Start from first Dynamic Level


If this option is selected products and accumulations in levels with a dynamic period of E are suppressed if
those levels are below the levels which are calculated dynamically.
For example, this option could be used in the situation where the decision process only affects with profit
products and hence all the non profit products can be run at a lower level with a dynamic period of E. Selecting
this option then causes only the with profit and higher level products to be run.
For more information refer to the Dynamic tab settings in the Structure chapter of the manual.

No Cross Multiplication
Selecting this option suppresses the cross multiplication process.

Prepare Only
Selecting this option just prepares the products using the compiler specified in the Worker settings of the
Options dialog accessed from the Prophet menu. See Worker settings.

Note the following:


n

All the above options are also specified in the Runtime Configuration tab of a run setting. See Runtime
Configuration tab in the Run Settings

The changes that you make to the parameters are temporary and last only for the duration of the run. At the end
of the run the revised settings are lost.

Running one or more run pairings

459

The name of the temporary Run Setting which is created from the settings is prefixed by an underscore
character and listed in the run log. For example, a Run Setting named Model Office is listed as _Model Office in
the run log.

If you have more than one run pairing then this section cannot be edited. However, the contents of this section
reflect those in the Run Setting when you select a run pairing.

Method of Run section


Options in the Method of Run section of the Select Run Pairings to be Run dialog box correspond to and replicate
the Method of Run section of the Runtime Configuration tab of the Run Setting. The options can be edited only if a
single Run Pairing is used which contains a Calculation Run Setting.
The settings in this section are taken directly from the corresponding options in the Runtime Configuration tab of the
Run Setting specified in the run pairing. The section appears similar to the following:

From this section you can set one of the following options:
n

Local Machine
The selected run pairings are run on the current PC. This is the default setting.

Multiple Machines
This setting enables the selected run pairings to be run across the selected networked PCs which can be
inspected and re-selected from the Select Machines dialog box which is accessed by clicking Change. See
Configuring Worker PCs before running a Parallel PC run for more information.

Default Machines
This setting is similar to the Multiple Machines setting. It enables the selected run pairings to be run across a

460

Chapter 12 Runs

default set of networked PCs. The default set is specified in the Machines Settings of the Options dialog box
which is accessed from the Prophet menu.
n

Prophet Enterprise
This setting enables the selected run pairings to be run using the Prophet Enterprise worker machines. To
specify the characteristics of the Prophet Enterprise system click Settings to display the Prophet Enterprise
settings in the Options dialog box.
For more information on how to configure Prophet Professional to use Prophet Enterprise resources see See
Using Prophet Enterprise Resources.

If Multiple Machines or Default Machines is selected you can specify how a run is split across the networked PCs in
the "Split Run By" section.
Note the following:
n

All the above options are also specified in the Runtime Configuration tab of a run setting. See Runtime
Configuration tab in the Run Settings

The changes that you make to the parameters are temporary and last only for the duration of the run. At the end
of the run the revised settings are lost.

The name of the temporary Run Setting which is created from the settings is prefixed by an underscore
characters and listed in the run log. For example, a Run Setting named Model Office is listed as _Model Office in
the run log.

If you have more than one run pairing then this section cannot be edited. However, the contents of this section
reflect those in the Run Setting when you select a run pairing.

Split Run By section


Options in the Split Run By section of the Select Run Pairings to be Run dialog correspond to and replicate the Split
Run By section of the Runtime Configuration tab of the Run Setting. The options can be edited only if a single Run
Pairing is used which contains a Calculation Run Setting.

Running one or more run pairings

461

The settings in this section are taken directly from the corresponding options in the Runtime Configuration tab of the
Run Setting specified in the run pairing.
If Multiple Machines or Default Machines is set in the Method of Run section of the Run Pairings dialog then the
following Split Run By section becomes available:

From this section you can specify how a run is split across multiple networked PCs. You can split a run by:
n

Products
Choose this option to run each product in the run on a separate machine.

Run Numbers
Choose this option to run each complete run number on a separate machine.

Simulations
Choose this option to run each complete simulation on a separate machine. This option is of most benefit when
carrying out dynamic or stochastic runs unless a DFA run is being carried out in which case the Run Numbers
option will normally give better performance.

Note the following:


n

All the above options are also specified in the Runtime Configuration tab of a run setting. See Runtime
Configuration tab in the Run Settings

The changes that you make to the parameters are temporary and last only for the duration of the run. At the end
of the run the revised settings are lost.

462

Chapter 12 Runs

The name of the temporary Run Setting which is created from the settings is prefixed by an underscore
characters and listed in the run log. For example, a Run Setting named Model Office is listed as _Model Office in
the run log.

If you have more than one run pairing then this section cannot be edited. However, the contents of this section
reflect those in the Run Setting when you select a run pairing.

Regenerate section
The options in the Regenerate section of the Select Run Pairings to be Run dialog box appear similar to the
following:

From this section you can force the regeneration of all or selected products in the run. By default, this option is not
selected.
For more information on what happens during the code generation and compilation phases of a run see "Code
generation and compilation".
Regenerating products in the run
If you wish to regenerate all the products included in the run then select the "Regenerate all products in the run"
option.
Alternatively, if you only want to regenerate specific products in the run you can select the products as follows:
n

In the Run Pairings to be Run dialog box check that the "Regenerate all products in the run" option is not
selected.

Click Select and in the Select Products for Regeneration dialog box select only those products you wish to
regenerate during the run and click OK.

When you start the run only the selected products are then regenerated.

Running one or more run pairings

463

Messages section - Runtime Performance Hints


The option in the Messages section of the Select Run Pairings to be Run dialog box allows you suppress the
display of the Runtime Performance Hints dialog box prior to processing a single run pairing only.

To suppress the messages select Do not show any run time performance tips.
If the option is not selected and Prophet identifies issues that may degrade runtime performance it will display the
the Runtime Performance Hints dialog box before running the single run pairing. The dialog box appears similar to
the following:

The suggested course of action is displayed in the top half of the dialog box. If more than one item of advice exists
then you can click Next and Previous to move between them. It is highly recommended that you read all the items
of advice before you proceed to make changes to the variable settings from this dialog box.
You can then choose one of the following options:
n

No Change
This is the default setting. No changes are made to the current run.

Change setting for this run


This option allows you to make changes from this dialog box to the variables used in the run. Note that any

464

Chapter 12 Runs

changes that you make are saved in a temporary run setting which is subsequently discarded at the end of the
run
n

Change setting for this run and future runs


This option applies any changes that you make from this dialog box to the variables used in the run and
permanently updates the corresponding run setting.

To continue with the run using the appropriate settings click OK.
To abandon the run click Cancel.
Note: The option in the Messages section of the Select Run Pairings to be Run dialog box is only available
when a single run pairing is run.

The run process


When a run pairing is started the necessary files are first exported to the Prophet Worker. Next, control is passed to
the Run Monitor which displays the progress of the run. A typical Run Monitor appears as follows:

The progress of the run is displayed in the Run Pairs tab while the list of machines used by the run are displayed in
the Machines tab.
You can adjust the settings for the Run Monitor by clicking Settings and stop a run at any time by clicking Cancel.

Running one or more run pairings

465

To stop a run and close Run Monitor


Stop any run if necessary, by clicking Cancel. When prompted, click Yes Then click Close to dismiss the Run
Monitor and pass control back to Prophet.
To view the run and error logs
At the end of a run you can view the run and error logs using the Results Viewer which appears when you click Run
Log.
Note: You can specify that the Run Monitor closes automatically after a successful run by selecting "Close Run
Monitor if Run Pairs finish without error" option in the Run Monitor Settings dialog which is displayed by clicking
Settings in the Run Monitor.

466

Chapter 12 Runs

What happens during a run?


Each run of a deterministic projection includes a number of processes, depending on what you specify in the
structures and run settings. The main processes are as follows, but not always processed in this order:
n

Deletion of existing results files

Code generation and compilation

Product calculations

Accumulation processing

New business processing

Unit numbers processing

You can also add your own external processes at a number of points. See Batch Programs.
The overall steps for a projection of a single product are outlined in "What happens during a product run?"
The further processing which occurs for a dynamic projection or a stochastic projection is explained in "Dynamic
runs" and "Stochastic modelling" .

Deletion of existing results files


At the start of a run, Prophet deletes all the existing results files for the products included in the structure in the
appropriate results sub-folders. For example, if run numbers 1 and 3 were about to be performed, then the results in
the sub-folders results\RUN_01 and results\RUN_03 would be deleted for the products included in the structure.
The results in any other results sub-folders, for example results\RUN_02, would not be affected. If more than one
run pairing is being run consecutively, this process takes place for the appropriate products at the start of the
processing for each run pairing.
Prophet identifies the lowest level number of the products and/or accumulations that are included in the structure. It
then normally deletes all the existing results files for all accumulations that have a level number equal to or greater
than this level from the appropriate results sub-folders. That is, results files are deleted for all accumulations with
this level number or higher irrespective of whether or not they are included in the structure.

What happens during a run?

467

If the new business method specified in the calculation run setting is cross multiplication and the level number for
cross multiplication is lower than the lowest level number of the products and/or accumulations in the structure, then
this level number is used as the base for the deletion of the accumulation results files unless you have specifically
elected to suppress cross multiplication.
The existing results files are deleted for two reasons:
n

If a product or accumulation fails, either during sequencing, compiling or calculation, any product or
accumulation that referenced that product or accumulation would not know this and would assume that any
results files that existed were the correct ones.

If a sub-product code had existed in an earlier run but not in the latest run the results file for that sub-product
code would not be overwritten during the latest run and would therefore continue to exist unaltered.

However, you can prevent the deletion occurring by deselecting the "Delete Accumulation Results from Lowest
Level" option of the Run process tab of the Run Setting. To access the setting click Advanced in the Parameters tab
of the Run Setting and choose the Run Process tab.
It should be noted that existing results files for products that are not included in the structure are not deleted. If any
of these products use the READ_RESULTS function to read results from products and/or accumulations that are
included in the structure then their existing results files will not be updated until they are also re-run.

Code generation and compilation


Prophet checks each product included in each structure being run to see whether:
n

It is a new one that has not previously been run, or

It has been opened and saved, or

The regenerate or auto-scan options have been used on it. See Auto-scan and regeneration options.

Any products in these categories are re-generated and compiled automatically at the start of the run. If more than
one run pairing is being run consecutively, this process takes place for the appropriate products at the start of the
processing for each run pairing.

468

Chapter 12 Runs

To perform the code generation and compilation process, Prophet first searches through the library for all the core
variables that match the indicators selected for the product and brings these variables and their appropriate
definitions into the calculations, together with the definitions saved with the product for each of the input variables.
Prophet then determines all the dependencies between the variables and hence determines the order of
calculation for the variables. Prophet then generates C code from the formulas and other definitions, which is then
compiled.
Note: The compiled code from the previous run is used if the product has not been changed.

Product calculations
Product calculations are processed in ascending level number order. Within each level number, they are processed
in the order specified in the Advanced option in the Run Parameters tab of the run setting.
The calculations are performed independently for each model point and the results are summed together for all
time-dependent cumulative variables. The results are stored separately for each sub-product as well as being
totalled for each product. For variables that are not cumulative or not time-dependent, the results for the first model
point for each sub-product are stored. You use the run setting to specify whether selected, cumulative or all
variables are stored.

Accumulation processing
Accumulations are processed in ascending level number order, after any product calculations with the same level
number have been processed.
Prophet automatically orders the processing of the accumulations if any of them uses the results of another
accumulation at the same level.
Only cumulative variables are processed and stored in the results.

New business processing


New business processing occurs normally only if a Sales file is specified in the structure being run. It calculates
projected values for future new business. There are two main alternative methods, which you select in the structure.

What happens during a run?

Cross Multiplication new business method

Project new business method

469

Alternatively, it is possible to include new business in each future month as individual model points in the model
point files.
If the Cross Multiplication new business method is being used, it is processed at the level number specified for it in
the structure. It is processed after any products with the same level number have been run and before any
accumulations with that level number are run.
If the Project new business method is being used, this processing takes place as part of the processing for each
product.
For more information see "New business processing" and the "Cross multiplication method" lesson in the Model
Office Tutorial.

Unit numbers processing


Unit numbers processing only ever takes place for unit linked products. It calculates the initial value of units for each
model point when it is not already available, using the numbers of units in each unit fund and the prices for those
units stored in a Unit Prices file.
If unit numbers processing is required, this is done immediately before the calculations for each model point. It is
triggered by the existence of any variables defined as model points which have names starting with VAL_UNITS_. It
requires a Unit Prices file to be specified in the run setting. For more information see the Unit Linked library manual.

If unit numbers processing takes place, unit numbers results are produced. These results contain an analysis of the
units allocated to each fund at the start date of projection together with their values. For more information see "Unit
Numbers results".

470

Chapter 12 Runs

Parallel PC mode
Parallel PC mode enables Prophet runs to be carried out using the computing power of PCs connected to a
network. The PC that initiates and controls the progress of a run is known as the Master PC. The networked PCs
used by the Master PC are known as Worker PCs. They must also have Prophet installed to process a run.
Communication between the Master and Worker PCs is performed across the network using Microsoft sockets
technology which must be configured on each PC. This is usually done during the Prophet installation.
The workspace used for a Parallel PC run must be accessible to the Master and Worker PCs. It can be resident on
the Master PC or on a server running Windows Server 2008.
A Parallel PC run can be split among the participating PCs by:
n

Product

Run number, or

Simulation number

The items in the split run are processed at the same time on different PCs with each PC processing one item at a
time. The decision as to which PC runs an item is determined by the master PC during the run on a first come first
served basis. The first Worker PC to respond to a master PC request is allocated the first item, the next Worker PC
to respond is allocated the second item and so on. If there are more items than Worker PCs then the first Worker PC
to complete running an item is allocated another. This continues until all the items are allocated.
Note the following:
n

If the workspace used for a Parallel PC run is located on a server that does not have Firebird installed then a
copy of the workspace is made on the master PC when it is first opened. When the workspace is closed the copy
on the master PC is copied back to its original location on the server.

If you have a large product to run you should consider splitting it into a number of smaller products by creating
Same As products to run subsets of the model points.

Parallel PC mode

471

If any files and tables used in the run are stored in locations outside the workspace then you must ensure that
these locations are properly specified in the run setting. See "Run setting - Tables tab" .

You can use a Worker PC for other purposes while it is being used during the Parallel PC run. There can
however be a noticeable loss in performance when the PC is carrying out calculations.

You can also specify to use the Master PC to process Parallel PC runs.

Parallel PC mode requirements


Before a PC can be used as a Master or Worker in Parallel PC mode it must satisfy the following conditions:
n

The PC must be connected to a network and have Prophet installed.

If the PC is to be a Master PC then it must have a software licence which supports a specified number of
Workers. A Worker does not require a licence.

The access rights on the Worker must be configured to allow the Master to use it..

The user must also grant the appropriate access rights to the Master for a run to be performed.

Setting up a Parallel PC run


To set up a Parallel PC run you need to:
n

Ensure that each PC used in the run is connected to a network and has Prophet installed.

Ensure that each PC used as a Worker grants the appropriate access rights to the user logged on the Master
PC.

Ensure that the workspace and any tables used for the run are accessible to all the participating PCs.

Specify the Master PC in the Select Machines dialog if it is to be used to process runs in conjunction with the
Worker PCs. If the Master PC is not listed in the dialog then it does not process any runs.

Specify from the Master PC which Worker PCs are used for the Parallel PC run.

Specify from the Master PC how the Parallel PC run is split.

472

Chapter 12 Runs

Each of these items is described in the following sections.

Configuring access rights


Before a PC can be used as a Master or Worker in Parallel PC mode it must grant the appropriate access rights. In
particular, the access rights on the Worker must be configured to allow the Master to run the ProphSlave application
on the Worker PC.
Note: For information on how to set up the access rights for each Worker refer to the Installation and Technical
Guide.

Specifying Worker PCs


You can specify the Worker PCs used by a Master PC in one of the following ways:
n

Configure a default set of Worker PCs to be used by the Master PC from the Machine Selection setting of the
Options dialog which is accessed from the Prophet menu.

Configure and update a default set of Worker PCs before you start a run that uses multiple PCs.

Although you can configure the Worker PCs from the Options dialog you will generally configure the PCs before
you start the run by choosing Multiple Machines in the "Select Run Pairings to be Run" dialog and clicking Change.
Note: The Worker PCs configured in the Options dialog always becomes the default set. You can however,
update this default set before you start a Parallel PC run by updating the configuration in the Select Machines
dialog and clicking Default.

Configuring Worker PCs before running a Parallel PC run


In addition to specifying the default set of Worker PCs used in a Parallel PC run from the Machine Selection option
of the Options dialog box you can also configure and update the set of Worker PCs from the Select Machines
dialog box.

Parallel PC mode

473

To display the Select Machines dialog box


Select a structure or run setting from either the Structures & Run Settings pane or and click Run from the Home tab.
From the Select Run Pairings to be Run dialog box choose Multiple Machines and click Change.

The specified default set of Worker PCs used in a Parallel PC run are listed by name, number of CPUs and
comments. From the dialog box you can add, edit and delete Worker PCs that are used in a Parallel PC run.
If you also want to use the Master PC to process runs alongside the Worker PCs then it must be added, listed and
selected in the Select Machines dialog box otherwise the Worker PCs perform all the run processing tasks.
From the Select Machines dialog box you can perform the following:
To do this

Do this:

To add a PC to be used in a
Parallel PC run

Click New and enter the details for the Master or Worker
PC in the Machine Details dialog box.

To remove a PC to be used in
a Parallel PC run

Select the PC from the list that you no longer require and
click Delete. The selected PC is removed from the list and
will not be available for use in any Parallel PC run.

474

Chapter 12 Runs

To do this

Do this:

To update the details for a PC

Select the PC from the displayed list and click Open. The
Machine Details dialog box for the selected PC is
displayed from which you can update its details.

To use a Master or Worker PC


in a Parallel PC run

Select the checkbox alongside each PC you wish to use in


a Parallel PC run. If the Master PC is selected then it too
will be used to process Parallel PC runs.

Check the CPU architecture


supported by a Worker PC

To check the CPU architecture supported by the


Calculation Engine (CE) installed on a Worker PC you
select each Worker in the list and click Test (32 bit) to test
for a 32 bit version of the CE or click Test (64 bit) to test for
a 64 bit version.

To make the list of Worker PCs


the default list for all runs

Click Default. The list of Worker PCs together with their


selection status will update the settings in the Machine
Selection option of the Options dialog box and become the
default setting for all runs.

When you click OK the Worker PC settings are used for the Parallel PC run.
Note the following:
n

These settings override those applied in the Machine Selection option of the Options dialog box and apply only
to the current run.

These settings replace those applied in the Machine Selection option of the Options dialog box if they are made
the Default settings by clicking Default.

Runs cannot be performed using Worker PCs that use a mix of .32 or 64 bit Calculation Engines (CE). A run can
only be performed with one type of CE. This means that all Worker PCs must use the same 32 bit or 64 bit CE for
a run to be successful.

Parallel PC mode

475

The Calculation Engine type (32 or 64 bit CPU architecture) that can be used for runs is specified at the
workspace level in the Runtime Architecture setting in the Compilers option of the Options dialog box. The
setting effectively determines which 32 or 64 bit Workers are used for the Parallel PC run.

Machine Details dialog box


The Machine Details dialog box is displayed whenever you add or update the details of a Worker PC to be used in
a Parallel PC run. You can display the dialog box in one of the following ways:
n

From the Prophet menu


Click Options and from the Options dialog box select Machine Selection. Either select a listed PC and click
Open or click New.

From the Structures & Run Settings pane


Select a structure or run setting and click Run. From the Select Run Pairings to be Run dialog box choose
Multiple Machines and click Change. From the Select Machines dialog box either select a listed PC and click
Open or click New.

From a Structures page list view


Select a structure, click Run from the Home tab. From the Select Run Pairings to be Run dialog box choose
Multiple Machines and click Change. From the Select Machines dialog box either select a listed PC and click
Open or click New.

The Machine Details dialog box appears similar to the following:

From this dialog box you can enter or set the following:

476

Chapter 12 Runs

Item

Description

Name

Enter the network name assigned to the Master or Worker PC you wish to
use. Alternatively, click
and select the PC from the available PCs listed
in the Connected Machines dialog box.

CPUs

The number of CPUs that are present in the PC whose name is entered in
Name. During a Parallel PC run the Master PC allocates a single item for
each CPU. Poor performance can be expected if more CPUs are entered
than actually exist in the PC since a CPU may have to process more than
one item.

Description

Enter a short description that best describes the Worker PC and its location.

Enabled

Select this item to allow the PC to be used in the Parallel PC run.

When you click OK the details are added to the list of PCs in either the Machine Selection tab of the Options dialog
box or the Select Machines dialog box.

Connected Machines dialog box


This dialog box displays the PCs that are connected to the network. The PCs are listed by their network name
together with any associated comments. To display the Connected Machines dialog box you click the machine icon
in the Machine Details dialog box.
The dialog box appears similar to the following:

Parallel PC mode

477

Select the appropriate PC to be used in a parallel run and click OK. The name of the selected PC is automatically
entered into the Name textbox of the Machine Details dialog box together with any comments in the Description text
box.

478

Chapter 12 Runs

Starting a Parallel PC run


To start a Parallel PC run you do the following:
n

Open the workspace to be used for the Parallel PC run


Ensure that the workspace can be accessed by all the Worker PCs specified in either the Machine selection
setting of the Options dialog accessed from the Prophet menu or the Select Machines dialog. The workspace
can reside on the Master PC or a network drive.

Select a structure
Select the structure in either the Structure & Run Settings pane or in the Structures list pane view and click Run
from the Home tab.

Choose the Run Pairing options


From the Select Run Pairings to be Run dialog select a run pairing and set the following options:
Run option

Description

Type of Run

Choose the appropriate run option.

Method of Run

Either choose Multiple Machines to use the Worker PCs


that have been added to the default list of Worker PCs or
choose Default Machines to use the default Worker PCs
previously specified.

Split Run By

Choose how the Master PC is to split the run.

Regenerate

Choose the appropriate code generation options.

For information on the options in the Select Run Pairings to be Run dialog refer to "Run pairings run options".
When you have selected the appropriate options start the run by clicking OK. The Run Monitor is displayed.

Parallel PC mode

479

In addition to listing the overall progress of the Parallel PC run the Run Monitor lists in the Machines tab all the
Worker PCs and the Master PC involved in the run, their connection status and the current task that they are
running. To stop the run on one or all machines click Cancel.

Stopping a Parallel PC run


You stop a Parallel PC run from the Master PC that initiated the run. To stop a run on one or all PCs involved in a
run you click Cancel or Close in the Run Monitor.
A list of the Workers running the Parallel PC run is displayed together with options that allow you to:
n

Stop the run immediately on all machines

Stop the run immediately on selected Workers

Stop the run on selected Workers after they have completed processing the current product.

If you choose to stop a run on a Worker immediately then the product currently being processed by the Worker is
returned to the queue maintained by the Master. The incomplete product run can then be processed later by either
the Master or by another Worker.

480

Chapter 12 Runs

Stopping a run on a Worker


If you choose "Selected Machines Immediately" or "Selected Machines After Current Product" then you can select
the listed Workers you wish to stop and click OK.

Minimising the run time

481

Minimising the run time


Prophet generates optimised compiled C code to process the calculations. However, for each model point it needs
to calculate all the time-dependent variables in the product for every month of the projection term for that model
point. A product might contain 400 time-dependent variables. A whole life policy might be projected to age 110,
which means that for a policy sold to someone aged 30 at entry the calculations need to be made for 81 years,
which is 972 months (the extra year is to allow for some calculations to carry on after the policy has expired). This
means that about 390,000 calculations are required for this policy. For 1,000 similar model points 390 million
calculations are required.
There are a number of things that you can do to help minimise the run time:
n

Reduce the maximum age to which whole life products are projected from (say) 110 to 100, although you would
need to check that this did not have an unacceptable effect on the results calculated.

Reduce the number of variables in your products by changing the indicators selected to remove any
calculations that you don't really need.

Use the option in the "Select Run Pairings to be Run" dialog box to limit the variables included in the calculation
to just those needed to calculate the variables that you are interested in for the current run.

You can change the formulas in your products to remove some of the run time checks, to reduce the use of
certain operators that are time consuming to calculate and to minimise the reading of generic tables (see the
"Performance issues when using the Prophet programming language" ). In practice the only one of these
changes which may have a significant effect is minimising the reading of generic tables, unless you have
carried out a large amount of tailoring to the libraries.

Use grouped model point data instead of individual policy data. You can group the individual policy data using
the grouping facilities in either Prophet itself (see "Data Grouping in Prophet" ) or in the Data Conversion
System (see "Data Conversion System and Viewer User's Guide". For some types of product such as
endowments you can often achieve virtually the same results with only 1% of the number of model points.

Use faster PCs and / or multi-processor PCs. The run time performance of Prophet is very closely related to the
processor speed of the PC carrying out the calculations.

482

Chapter 12 Runs

Use Parallel PC Mode so that several PCs are used in parallel to carry out the calculations (see the previous
section in this chapter for further details).

If you are carrying out stochastic runs use stochastic tables to hold the assumptions instead of generic tables.

Example Model Office

483

Example Model Office


Prophet is supplied with Example Model Offices that you may install when you create a new workspace using the
standard libraries. These Example Model Offices demonstrate how some of the features of Prophet can be used.
Different versions are installed depending on whether you have been supplied with the Standard, French, German
or US versions of the standard workspace.
The examples in the Standard version cover valuation, profit testing and grouping as well as a model office. A
number of Group Pensions products are also installed if you have licensed the Group Pensions library, although
they are not used in the Example Model Office itself. The following are installed with the Standard Example Model
Office:
n

Liability products

Model point files

Summary Product

Accumulations

Tables

Structures

Run Settings

Results

Liability products in the Example Model Office


The liability products installed depend on which libraries you have licensed:
Library

Product Name

Description

Conventional

C_CPA_

Compulsory Purchase Annuity

Conventional

C_GIB_

Guaranteed Income Bond

484

Chapter 12 Runs

Library

Product Name

Description

Conventional

C_PLA_

Purchased Life Annuity

Conventional

C_SEPP

Self Employed Pensions Plan

Conventional

C_TERM

Term Assurance

Conventional

C_WEND

With Profit Endowment

Conventional

C_WPWL

With Profit Whole of Life

Group Pensions

E_DBEN

Defined Benefit Scheme

Group Pensions

E_DC_C

Conventional Defined Contribution Scheme

Group Pensions

E_DC_U

Unit Linked Defined Contribution Scheme

International

I_CPA_

Compulsory Purchase Annuity

International

I_ENDA

Endowment with Profit Share

International

I_TERM

Term Assurance

PHI

P_PHI_

Permanent Health Insurance

Unit Linked

U_IB__

Single Premium Bond

Unit Linked

U_MIP_

Maximum Investment Plan

Unit Linked

U_UPPP

Personal Pension Plan

Unit Linked

U_UWPP

Unitised With Profit Pension

All of these products have been given a level number of 10.

Model point files in the Example Model Office


The existing business model points for each liability product have a sub-product code of 1. The new business
profile model points have a sub-product code of 51. The model point files have .RPT file name extensions and are
stored in the default MPFILES sub-folder in the workspace.
Two additional model point files C_WEND.PRO and U_IB__.PRO are installed. These files have been generated
using DCS and are supplied for use with the Example Valuation structure.

Example Model Office

485

The model point files C_TERM.PRO and I_TERM.PRO are also installed for use in the Grouping tutorial (see Part 1
of the Model Office Manual). These files and C_WEND.PRO and U_IB__.PRO can also be used with the Example
Grouping structure.

Summary Product in the Example Model Office


There is one Summary product, that is one product specified using the Summary library.
Library

Product Name

Description

Summary

S_COMP

Overall Company

It is given a level number of 20.


This Summary product performs the following calculations. It:
n

Specifies the initial overall value of the assets and hence calculates the surplus in the fund at each time period.
In these calculations it sets any reassurance cash flows calculated in the liability products off against the gross
amounts.

Allows for an investment return to be earned on the surplus in the fund.

Allows for additional expenses not charged in the liability products.

Allows for the mathematical reserves for product classes assumed not to have been modelled using liability
products in Prophet.

Charges additional tax to reflect the above items.

Calculates shareholders transfers taking into account the above "adjustments" to the cash flows in the liability
products.

Calculates a number of statistics such as the overall value of existing and new business and the overall
assumed investment yield on the fund.

Accumulations in the Example Model Office


There are four accumulations, all given a level number of 15:

486

Chapter 12 Runs

EXISTBUS

Overall existing non-group


business at the projection start
date. Sums the results for the
existing business for the liability
products.

NEW_BUS

Overall new non-group business.


Sums the results for new business,
after cross multiplication, for the
liability products.

S_COMP_T

Overall non-group liabilities.


Sums EXISTBUS and NEW_BUS.

EB_TOTAL

Overall group pensions liabilities.


Sums the results for the group
pensions products.

Note: The name for the accumulation S_COMP_T is such as to enable Prophet to recognise it when it is
processing the product calculations in S_COMP. It enables the appropriate values to be read from the
accumulation. For more details see the Model Office Manual.

Tables in the Example Model Office


The products use various global and parameter files, a Sales file and a number of other tables, all stored in the
default TABLES sub-folder of the workspace location.
The global file for the Example Model Office, GLOBAL.FAC, is set up to enable three model office runs to be made:
Run number 1

Standard assumptions

Run number 2

Higher lapse rates

Run number 3

Higher investment return

It also includes values for run numbers 5 and 10, for use for valuation and profit testing respectively.

Example Model Office

487

The Sales file, SALES.FAC, is set up using the Sales Generator with assumptions for the volumes of future new
business. It includes volumes for all liability products, regardless of which libraries you have licensed.

Structures in the Example Model Office


Five sample structures are installed. The one for the Example Model Office is set up as follows:
n

Structure - Products/ Accumulations tab


All of the products and accumulations are selected in this tab.

Structure - Configuration tab


The settings on this tab sets the Cross Multiplication method, at level 10. Thus this process takes place
immediately after the liability products have been calculated and before the accumulations are run. This tab also
identifies which model points represent existing business and which represent future new business profiles.

Three of the other example structures show how valuation, profit testing and group pensions runs can be specified.
The fifth structure shows how the products for a grouping run can be specified.

488

Chapter 12 Runs

Run Settings in the Example Model Office


Five sample run settings are installed. The ones for the Example Model Office are set up as follows:
n

Run settings - Run Parameters tab


The settings on this tab perform a 5 year projection using policy data as at 31 December 2002, assumed to be
the company year end.
The run numbers 1, 2 and 3 are selected in the Run Numbers text box. A description is given to run number 1 by
default.

Run settings - Tables tab


The names and locations for the files and tables are specified in the Tables tab. They are mostly the Default
locations used by Prophet. The exceptions are:

The parameter files, which are specified as PARAM*.FAC rather than PARAMET.FAC, because there are
several of them.

A Unit Prices file, included to demonstrate this facility.

Run settings -Results tab


The settings on this tab produce projection, new business profile, valuation results and individual model point
results files and to store the results of the calculations for all variables.
Note: For a real model office run you should normally store the results for only the Key Output variables, to
minimise the storage and processing required.

The other four example run settings and structures show how valuation, profit testing, group pensions and grouping
runs can be specified.

Results in the Example Model Office


The sets of results of the Example Model Office projection for run number 1 are listed in the Results list pane view.
You can display them by clicking Open from the Home tab. Alternatively, you can open the Results Diagram View
from the right-click menu.
If you run the five structures supplied, additional sets of results will be displayed for run numbers 2, 3, 5, 10 and 20.

Example Model Office

489

Running the Example Model Office


Use the Example Model Office to help with your familiarisation with Prophet. For example:
n

You can open any of the objects in the model office to see how they have been specified. You can also change
those specifications to experiment with alternatives.

You can run any of the structures supplied. For instance, you could run the Example Model Office structure to
produce results for run numbers 2 and 3, in addition to those already present for run number 1. You can also, if
you wish, rerun any products or accumulations individually.

Deleting the Example Model Office


If you no longer require the example model office, you can delete all of the above objects. You will then be left with
a workspace identical to one created without installation of the Example Model Office.

490

491

C H A P T E R

1 3

Results

TOPICS IN THIS CHAPTER


What results are generated by a run?

492

Displaying results

493

Types of results

497

Managing results

501

492

Chapter 13 Results

What results are generated by a run?


When a run is made Prophet generates the following types of output:
n

Results - containing the values of the variables calculated for the products and accumulations in the run

Run Log - containing a record of the steps performed in the run together with any error or warning messages.
This is displayed using the Results Viewer.

Error Logs - containing details for products that experienced errors during the run. These are displayed using
the Results Viewer.

Prophet also generates outputs that enable you to investigate the dependencies between variables.

Displaying results

493

Displaying results
The results that are generated when one or more products are run can be displayed by selecting them from the
Results & Runlogs pane which typically appears as:

Selecting and right clicking on a set of results displayed in the pane displays a menu of options that allows you to
open and delete the selected set of results. In addition, depending on the type of results selected you can display
them in Diagram View.
To display the run and error logs for the results generated by a run you locate and select the RunlogSummary.xml
file for a particular run number and either click Open from the Home tab or just double-click the selected file. The
run logs are then displayed in the Results Viewer application.
Results page list view
You can view and manage results in the workspace from the Results Page list view which is displayed in the main
window
To display the Results page list view:

494

Chapter 13 Results

In the Results & Runlogs pane, if required, expand the Results folder.

Select a results folder and the right click menu choose Show List of Results.

The Results Page list view is displayed in the main window:

To display the results grouped by tab:


Select a set of results in Results Page list view and from the right click menu choose Group by tab - ResultsType.
The results are then displayed in tabs as follows:

Displaying results

495

To display the contents of a result set:


Select a set of results in either Results Page list or Grouped by Tab view and from the right click menu choose the
Open Results option. The results are then displayed below the results view.
You can sort the displayed list of results by clicking on the heading of any column in Page List view.
If you choose to Group by Tab and then choose results Type the Results tab has tabs that list the results of each
type as follows:
n

Projection results

NB (New Business) Profile results

Valuation results - CurrentYear

Valuation results - Maturity Year

Unit Numbers results

Stochastic results

Individual model point results

Intermediate dynamic results

There is also a separate tab for run logs.


Details of the contents of each of these types of results are given in "Types of results".
To display a set of results, select them in the Results & Runlogs pane and from the right click menu choose the
Open Results option.
Displaying Individual MP results
Individual model point results files can be opened like normal model point files or displayed using Viewer. See the
Viewer chapter of the Data Conversion System and Viewer User's Guide.

496

Chapter 13 Results

Intermediate results
Intermediate results are created in dynamic runs and are displayed using Excel. See the "Dynamic runs - General
Concepts" chapter in this manual.

Diagram view
You can view the definitions of the variables in a product together with the values for a particular set of results in
Diagram view by selecting the Projection or NB Profile results in the Results & Runlogs pane and from the right
click menu choosing the Open in Results Diagram View option or choosing the Results Diagram option of the
Open button in the Home tab.
For further information see: Diagram view on page313

Types of results

497

Types of results
The types of results that can be generated during a run are as follows:
n

Projection results

New Business Profile results

Valuation results

Unit Numbers results

Individual Model Point results

Stochastic results

Intermediate results

Run logs

Projection results
Each set of projection results contains the summation of the results calculated for all the model points for a
particular product and sub-product, or for an accumulation. The summation is by month for a period of years equal
to the sum of the past accumulation period and the future accumulation period. These periods are measured from
the results start date, which is the company year end coincident with or immediately preceding the start date of the
projection.
Projection results are generated if Projection / NB Profile is selected in the Results tab of the run setting. The list of
variables for which values are stored in the results is determined by the setting of the Variables in Results Files
option in the Results tab of the run setting.

New Business Profile results


New business profile results have exactly the same format as projection results. They are created if the Cross
Multiplication new business method is selected and for sub-products for which the sub-product code is greater than

498

Chapter 13 Results

the Last Sub-Product Code for Existing Business. The results they contain are calculated on the assumption that the
new business is all sold at the start of the first month of the projection.
New Business Profile results are generated if Projection / NB Profile is selected in the Results tab of the run
setting and Cross Multiplication is selected in the New Business Method section of the Configuration tab of the
Structure. The list of variables for which values are stored in the results files is determined by the setting of the
Variables in Results Files option in the Results tab of the run setting.
During cross-multiplication the new business volumes from the Sales file are applied to these results to produce
Projection results if the sub-product code is less than or equal to the Last Sub-Product Code for New Business
based on Sales Volumes. If the sub-product is greater than this, the number of new members required each month
in order to achieve a specified number of active members in a group pension scheme is calculated and this is
applied to the New Business Profile results to produce Projection results.

Valuation results
Each set of valuation results contains the summation of the results calculated at the start date of the projection for all
the model points for a particular product and sub-product. The summation is either by maturity year if the variable
ACCUM_TYPE in each product has a value of 0 for all the model points for that sub-product and by current age if it
has a value of 1.
Valuation results are generated if the product contains the variables ACCUM_TYPE, MAT_YEAR and CURRENT_
AGE and Valuation is selected in the Results tab of the run setting. The list of variables for which values are stored
in the results is determined by the setting of the Variables in Results Files option in the Results tab of the run
setting.

Unit Numbers results


Each set of Unit Numbers results contains a breakdown of the units allocated to the model points at the start date for
a particular product and sub-product. For each unit price code to which the model points are linked the numbers
and values of the funded and unfunded units are recorded. The price, description and type of each unit price code
are also stored.
These files are created if unit numbers processing takes place during a run. See "Unit Numbers processing" .

Types of results

499

Individual model point results


Individual model point results files contain one line of results for each model point in the model point file. The
variables included in the results files are those that have been set up as Individual MP Output variables in a
Variable Group selected in the text Results Files section of the Results tab of a Run Setting. For time-dependent
variables, the value in the month corresponding to the start date is included. If you want to include a value
calculated at a different date, you should create a new variable and set its value at the start date (normally t=DUR_
M) to equal the required value.
Individual model point results files are generated if the Individual Model Point Results Files option is selected in the
Results tab of a Run Setting.
The sub-product code and the model point number within each sub-product code is also included at the start of
each record. You can then use a database application to:
n

Summarise the results in different ways

Calculate ratios of pairs of variables to validate their values

You can also analyse the results using the analysis facility in Viewer.

Stochastic results
Each set of stochastic results contains the summation of the results for all the model points of a particular product
and sub-product separately for each simulation in a stochastic run. The results are held monthly for the number of
years that monthly results are specified to be retained in the run setting. In addition, annual results are held for the
total of the future and past accumulation periods. Results are held for all the variables in the product which have
been set up as Stochastic Output variables in the Variables in Stochastic results files section of the Results tab of
the Run Setting.
The stochastic results do not hold summary statistics such as the mean, standard deviation, percentiles etc. These
are calculated as part of the reporting process or in Excel Reporting.

500

Chapter 13 Results

Intermediate results
The intermediate results generated during a dynamic run can be grouped by Intermediate Dynamic results type on
the tree or the results list. The intermediate results files that are generated are:
n

Dynamic model point files

Dynamic asset buy factors files

Dynamic asset sell factors files

Dynamic asset sale priorities files

Dynamic asset market values files

Dynamic sales ratio files

Intermediate results are only generated if Intermediate Dynamic is selected in the Results Files section of the
Results tab of the run setting and "In-Memory Dynamic Processing" is not being used.
For further information on these results see "What are dynamic runs?".

Run logs
Run logs are listed by run number in the Results & Runlogs pane. To view the logs locate and double click the
RunlogSummary.xml file. The Results Viewer will then open and display the results.

Managing results

501

Managing results
Prophet manages the results it produces automatically. From the Results & Runlogs tree you can:
n

Display the results

Delete results

Open, inspect and print run logs using the Results Viewer.

Deleting results
You can delete one or more sets of results by selecting them in the Results & Runlogs pane and then from the right
click menu choosing the Delete option. When attempting to delete one results file you will be prompted that all
result files from the selected run number will be deleted, click OK to delete all results from that run number.

Printing a results file list


You can print a list of the sets of results displayed in a page view list by selecting a results set from the results list
and from the Prophet menu choosing Print .
The Print List of Results Files dialog box is displayed similar to the following:

Options from the dialog box allow you to:

502

Chapter 13 Results

Preview the list of results before printing them by clicking Preview

Set up the printer to be used to print the results by clicking Print Setup.

To print the results files click OK.


Note: You can also save the results files to a text file by clicking Preview in the Print dialog box and from the
Print Preview tab clicking Save. See Printing to a text file in help for more details.

Results consistency
The Prophet application carries out the majority of its calculations at double precision. Calculations at double
precision have a limited degree of accuracy. Typically calculations are reliable to 15 significant figures.
There are many small changes that can lead to the results of a calculation being different at more than 15
significant figures. Common examples include using a different machine, a different compiler (including 32bit or
64bit) or any change that affects the order of the calculations.
The small differences that can be introduced by floating point accuracy are not normally an issue as the differences
are, by definition, very small in relative terms. This typically occurs when trying to determine whether the difference
between two very large numbers which should be the same is positive or negative. Library changes can be made to
make the library code more robust.

503

C H A P T E R

1 4

Results Viewer Viewing run logs

TOPICS IN THIS CHAPTER


About Results ViewerViewing the run log

504

Prophet Run Details view

508

Runlogs pane

509

Definition folder

510

Preparation folder

518

Execution folder

520

Audit folder

522

Printing a run log

528

Navigating run logs

530

Filter toolbar

533

504

Chapter 14 Results Viewer Viewing run logs

About Results ViewerViewing the run log


The Results Viewer allows you to display the run and error logs, collectively known as a run log, that are generated
whenever a Prophet run is performed. The application is also used to create and manage queries on the results
produced by a Prophet run. See An overview of queries on page537 for more information.
Whenever a Prophet run is performed, a run log that contains run and error messages is generated. You can view
the run log in the Runlogs pane in Prophet Forms.
You can access the Results Viewer in one of the following ways:
n

As a standalone application
You start Results Viewer from the SunGard iWorks program group and open a run log from a selected location.

From the Run Monitor


At the end of a Prophet run, in the Run Monitor dialog box click Run Log to start the Results Viewer. From the
Prophet Run Details view you can then select the run log to view. For details see Prophet Run Details view on
page508.

From Prophet Professional


In the Results & Runlog pane, locate and double click the RunlogSummary.xml file to start the Results Viewer
and display the generated run log.

To view the run log:


1. If the Runlogs pane is not already visible, on the Home tab in the View group select the Runlog check box. By
default the Runlogs pane is tabbed with the Output pane at the bottom of the application screen.

About Results ViewerViewing the run log

505

2. In the Runlogs pane, click the number of the run log you want to view. The run log appears in the work area,
similar to the following:

Note: To open and view a run log created using Prophet Professional 8.0 you need to run a command line
utility. See Upgrading a Run Log for further details.

506

Chapter 14 Results Viewer Viewing run logs

A typical run log for a selected run number appears as follows:

The run log for a specific run number run is structured as folders and file objects that are displayed as a tree in the
left pane. Expanding a folder in the tree displays the associated sub-folders. Selecting an object in the tree displays
the contents in the right pane. The main folders displayed in the run log tree are as follows:
n

Definition folder
This folder contains sub-folders that show the structure and run settings used for the run. For details see
Definition folder on page510.

About Results ViewerViewing the run log

507

Preparation folder
This folder contains sub-folders that hold the messages generated during the preparation phase during which
tables and model point files are converted and products are generated. A system log listing the machines used
for the preparation phase is also supplied. If more than one run number has been run then the contents of this
folder contain the same information for all the run numbers. For details see Preparation folder on page518.

Execution folder
This folder contains Products and Accumulations sub-folders that hold progress logs for each of the products
and accumulations processed during the run. A system log for the execution phase of the run is also included in
this folder. For details see Execution folder on page520.

Audit folder
This folder contains a tables sub-folder that lists the tables accessed and used by the run. For details see Audit
folder on page522.

You can also print the entire run log. For details see Printing a run log on page528.
In addition, you can import archived results and run logs from another location or archive and export the current
open run log and the associated results. For details see Importing run logs and results on page526 or Exporting
run logs and results on page525.You can also print the entire run log by selecting the tree and on the Prophet
menu click Print. For details see Printing a run log on page528.
Note: Run logs generated by Prophet Professional Release 8.0 and later can only be viewed using the Results
Viewer.

508

Chapter 14 Results Viewer Viewing run logs

Prophet Run Details view


The Prophet Run Details view in the Results Viewer is only displayed when a Prophet run has completed and you
click Run Log in the Run Monitor. The Prophet Run Details View appears similar to the following:

A summarised list of the runs by run number is displayed in a separate tab in the viewer. Each item in the list has a
Run Number and its description together with the number of errors and warning messages generated by the run. To
view the run log for a run number click View.
Note: When you close this view it cannot be restored.

Runlogs pane

509

Runlogs pane
The Runlogs pane contains a list of run logs relating to the current Forms workspace. By default, the Runlogs pane
is displayed at the bottom of the application screen in a tabbed pane with the Output pane. You can view a run log
in the work area, sort the list of run logs and adjust the position of columns in the Runlogs pane.

To view a run log, in the Run No column click the number of the run log you wish to view. The run log details are
displayed in the work area.

To sort the list on any of the headings, click a column heading.

To sort the order of the columns, drag a column heading to the new position.

To filter the list of run logs, click the Filter icon

beside any of the columns and complete the filter details.

510

Chapter 14 Results Viewer Viewing run logs

Definition folder
The Definition folder contains information on the structure and run settings used for the run run. In the tree click the
Definition folder to display the following:

Definition folder

511

The Definition folder displays summarised information. In particular, it displays the names of the structure and run
settings used for the run run, version information, timings for each phase of the run, the run numbers that were
executed and the number of errors and warnings during the preparation and execution phases of the run.

512

Chapter 14 Results Viewer Viewing run logs

You can expand or collapse the summarised details using the expand / collapse buttons. You can also expand and
inspect any error or warning messages that were generated during the preparation and execution phases. In
particular, you can access a specific error or warning message in the log by clicking the appropriate hyperlink.
The Definition folder also has the following sub-folders that provide additional detailed information:
n

Structure folder
Selecting this folder in the tree pane displays in the right pane the settings and details of the structure used for
the run run. For details see Definition - Structure sub-folder below.

RunSetting folder
Selecting this folder in the tree pane displays in the right pane the settings and details of the run settings used
for the the run run. For details see Definition - Run Setting sub-folder on page515.

Definition - Structure sub-folder


The Structure sub-folder displays in the right pane the settings and details of the structure used by the run run. It
appears similar to the following:

Definition folder

The displayed information lists the settings of the structure used by the the run run. In particular it lists:
n

The name and properties of the structure.

The number of levels and the properties of each product in a level.

513

514

Chapter 14 Results Viewer Viewing run logs

Product link information.

In addition, information is also supplied on any calculated variables used together with New Business and
Advanced settings.
Similar details are displayed for the associated run setting which is displayed when you select the RunSetting
folder in the tree pane.
Note the following:
n

Similar details are displayed for the associated run setting which is displayed when you select the RunSetting
folder in the tree pane.

This information is printed alongside other information in the Results Viewer report.

Definition folder

515

Definition - Run Setting sub-folder


The RunSetting sub-folder displays in the right pane the settings and details of the run setting used by the run run.
It appears similar to the following:

516

Chapter 14 Results Viewer Viewing run logs

The displayed information lists the settings of the run setting used by the run run. In particular it lists:
n

The name and properties of the run setting

The run numbers

Definition folder

Details of the run settings that include:

Parameters

Input files

Results files

Configuration

Batch programs

This information can be printed alongside other information in the Results Viewer report.

517

518

Chapter 14 Results Viewer Viewing run logs

Preparation folder
The Preparation folder contains sub-folders that hold the messages generated during the preparation phase
during which tables and model point files are converted and products are generated. A system log listing the
machines used for the preparation phase is also supplied. It appears similar to the following:

Preparation folder

519

The following sub-folders are displayed in the tree pane:


Folder

Description

Table Conversion

Contains the messages generated on any tables converted during the build
process.

Model Point Conversion

Contains the log on model point table conversions during the build process.

New Business Processing

This folder is created only if new business processing was performed and
contains the generated messages.

Code Generation

Contains a sub-folder and log for each product generated during the code
generation phase of job preparation.

Build Products

Contains a sub-folder and log for each product built during the code generation
phase of job preparation.

System Log

Contains details of the messages generated by the taskmaster machine or


machines.

520

Chapter 14 Results Viewer Viewing run logs

Execution folder
The Execution folder contains sub-folders that hold the messages generated during the execution phase during
which the results are generated. It appears similar to the following:

The Execution folder contains sub-folders as follows:


n

Simulations folder
This folder is only available if the run contains simulation data. The folder contains a sub-folder for each
simulation each of which contain the relevant generated messages.

Products folder
This folder contains a sub-folder for each product used by the run. Each sub-folder contains the relevant
generated messages.

Execution folder

System Log folder


This folder contains details of the messages generated by the Worker machines during the run.

521

522

Chapter 14 Results Viewer Viewing run logs

Audit folder
The Audit folder contains metadata at the top level and a Tables sub-folder that lists the tables used during the
runrun listed by their name, description and location. The contents of the Tables sub-folder typically appears as
follows:

Audit folder

523

524

Chapter 14 Results Viewer Viewing run logs

You can sort the list of tables by clicking on a column header. You can also print the information alongside other
related run log details using the print option accessed from the Prophet menu. You can also print the information
alongside other related run log details. For details see Printing a run log on page528.

Audit folder

525

Exporting run logs and results


To archive and export the generated run log and its associated results, on the Home tab click Export Results. The
Export Results dialog box appears similar to the following:

Enter or browse to the location of the RunlogSummary.xml file. Similarly, enter or browse to the location where the
archive file is to be placed.
If you have previously archived run log data to a specific location then if you click More locations a list of previously
visited run log locations is displayed from which you can choose to export the archive. You can also rearrange and
remove locations in the list. The extended dialog box appears similar to the following:

526

Chapter 14 Results Viewer Viewing run logs

When you click OK the generated run log and results are compressed into a zip file with an extension of .arc. You
can then copy this file to another location or keep it for archive purposes.
To view an archived set of results and run logs, on the Home tab of the Viewer ribbon click Import Results.
Note: Due to the large quantity of data the archive process can take some time. To ensure that the data is
archived successfully do not close the Results Viewer until the archive process has completed.

Importing run logs and results


You can import and view archived run logs and results previously exported and archived.
1. On the Home tab click Import Results. The Import Results dialog box appears similar to the following:

2. In the Import Archive Location box type the location of the run log and results archive file, which should have
an extension of .arc, or click the Browse button and navigate to the file.
3. In the Import Destination box type the location where the imported files are to be saved, or click the Browse
button and navigate to the location.
4. Optionally, select the Open Runlog after Import check box if you wish to see the run logs as soon as they have
been imported.
5. Click OK to start the import and archive extraction process. When the process has completed you can view the
run logs.

Audit folder

527

Note: To view the imported results you need to ensure that the Results location of the imported files is specified
in the Results setting of the Options dialog box which is accessed from the Prophet menu in Prophet
Professional.

528

Chapter 14 Results Viewer Viewing run logs

Printing a run log


In addition to viewing the contents of the run log you can also print a copy of the run log.
To print the run log:
n

In the tree pane of the Results Viewer click the item you want to print and on the Prophet menu click Print. The
Results Viewer prepares and formats the run log and displays it in a separate tab similar to the following:

On the File menu click Print. A preview of the formatted run log appears in the work area similar to the following:

Printing a run log

529

Using options from the local toolbar you can choose the appropriate page magnification and layout options. You
can also print the run log and search the displayed report using the search box at the bottom left of the tab.

530

Chapter 14 Results Viewer Viewing run logs

Navigating run logs


Run logs for a job are organised by folders that correspond to the job processing phases. In particular, the
Execution and Audit folders displayed in the tree each contain the run logs for each run number that was
processed. Selecting a node in the tree pane displays the corresponding run log in the work area.
Run logs are viewed by run number in the Results Viewer with each log displayed in a separate tab. Selecting a
node in the tree pane displays the corresponding run log in the work area.
Different views are supported depending on the type of run log selected. A typical run log for the Execution phase of
a runrun appears similar to the following:

Navigating run logs

531

For the Execution phase of a runrun the run log has two panes:
n

Summary pane
This is the top pane and contains a summarised list of the steps performed during the runrun.

Messages pane
This is the lower pane and contains detailed information on an item selected in the summary pane.

In each case you can filter the details using the associated Filter toolbar. For details see Filter toolbar on page533.
You can also expand or collapse sections in a run using the expand / collapse buttons.

532

Chapter 14 Results Viewer Viewing run logs

Note that there is an intentional delay before the log is displayed. This is to allow you to move through nodes using
the navigation keys before residing upon a node whose details you wish to view. Not all nodes have an associated
log.

Filter toolbar

533

Filter toolbar
The Filter toolbar allows you to select and display only those items in the list that you wish to view in the run log
pane. In general, the toolbar appears at the top of Summary and Messages panes and appears as follows:

The available options from the toolbar are listed as follows:


Option Description
Displays or hides error messages.
Displays or hides warning messages.
Displays or hides information messages.
Displays or hides all messages.
Opens the Field Chooser dialog box from which you can select which columns in the list of items is to be
displayed. For details see Field Chooser below.

Field Chooser
You can specify which columns are displayed in the run log by clicking Field Chooser

from the local toolbar

which appears at the top each pane displayed in the Results Viewer. The Field Chooser dialog box appears similar
to the following:

534

Chapter 14 Results Viewer Viewing run logs

The dialog box shows a list of the names of the columns that you can select to display or hide. Columns that are
selected are displayed. Those that are not are hidden. When you click OKonly the columns that are selected are
displayed.

535

C H A P T E R

1 5

Queries

TOPICS IN THIS CHAPTER


What are queries?

536

An overview of queries

537

Managing queries

539

Charting queries

552

Previewing and printing a query

556

536

Chapter 15 Queries

What are queries?


Queries allow you to create multi-dimensional views of specified sets of results. You can create a single query to
analyse a set of results or you can create several queries to analyse the results in different ways.
You can query and display several types of results:
n

Projection

New Business Profile

Valuation (maturity year and current age)

Stochastic (results and summaries)

Unit Numbers

You can query across Prophet workspaces, run numbers, products, sub-products, variables, time periods,
stochastic simulations and stochastic summary statistics. Queries can also be used for the following:
n

Sorting and printing results

Copying results to other Windows applications

Queries are managed in Results Viewer which appears whenever you create or open a query from the Queries
section of the Object Browser pane in Prophet Professional.

An overview of queries

537

An overview of queries
Queries are used to analyse the results of one or more Prophet runs. You can create, run and save any number of
queries to analyse a set of results in different ways. The results are displayed in the work area.The results of a
query are displayed in Results Viewer.

Different types of queries are available to cater for the different types of results. For example, you can create and
run projection queries to analyse projection results and valuation queries to analyse valuation results.
A query consists of dimensions and parameters.
n

A dimension is a category of data, such as product, variable or time period.

A parameter is an item within a dimension, such as C_WEND and C_CPA_ in the product dimension and M1,
M2 and M3 in the time period dimension.

538

Chapter 15 Queries

When you create a query you specify the dimensions and parameters in the header panel of the query. This
example shows the settings that can be specified for a Projection query:

From the panel you can interactively change the settings and run the query.

Managing queries

Managing queries
Queries saved in a Prophet workspace are listed in Prophet Professional in the Queries section of the Object
Browser pane, and the basic properties of the queries are listed in the Queries tab of the main window.
Tip: If the properties are not listed in the main window, right-click on the Queries folder in the Object Browser
pane and click Show List of Queries.
The Prophet screen appears similar to the following:

To edit and run an existing query:


1. In Prophet Professional, in the Queries section of the Object Browser pane double-click an existing query.
Results Viewer displays the query.

539

540

Chapter 15 Queries

2. On the Home tab click Execute Query. The results of the query are displayed below the query header.

Managing queries

You can manipulate the results of the query as follows:


n

To sort data by column, click the header of the column you want to sort by.

To sort data by row, select a row and on the Home tab click Sort Row.

To transpose row and column data, on the Home tab click Pivot.

To print the results of the query, on the Quick Access Toolbar click Print or press Ctrl+P.

To display and edit query properties, on the Home tab click Properties. For details on editing query
properties, see Query Properties on page547.

541

542

Chapter 15 Queries

To copy some or all of the results to be pasted into a spreadsheet application, highlight the required results
or on the Home tab click Select All, then click Copy.

Note the following:


n

When you first open a Prophet pre-Release 8.0 query, Prophet converts and saves it as a new query with the file
extension .Query. The original query is kept intact and is listed with the new and converted queries.

Before you can run a converted pre-Release 8.0 query you must recreate the results used for a pre-Release 8.0
query by running the Prophet models again.

You need to save a query created using Results Viewer in the Query folder of the workspace in order to display
it in the queries pane of a workspace.

Opening and editing an existing query


When you open an existing query or create a new query it is displayed in Results Viewer.
1. In the Queries section of the Object Browser pane select the query and on the Home tab click Open. Results
Viewer starts and the query opens and its settings are loaded.
2. To run the query, on the Home tab click Execute Query. The results of the query are displayed in the grid below
the query header.
3. To save the query, on the Home tab click Save. If you are saving a new query, in the Save As dialog box type a
name for the new query.
The query is saved as a separate file in the Queries folder of the Prophet workspace, with the extension .Query.
Note: When you save a query only the dimension parameters are stored. To update the results or move
dimensions you need to run the query again.
Note: If the query was created in an earlier version of Prophet prior to Release 8.0 then it is converted to the
new format and saved as a new query with an extension of .Query. The query is then opened in the Results
Viewer.

Managing queries

543

Creating a new query


You can create a query from the Queries pane in Prophet Professional, from within Results Viewer or Forms, or in
the Excel Reporting template.
1. In Prophet Professional, on the Home tab click the arrow below New and then click New Query.
OR
In the Queries section of the Object Browser pane right-click the Queries folder and then click New Query.
OR
2. In Results Viewer, on the Home tab click New Query.
The New Query dialog box appears.

3. On the Home or Queries tab click New Query.


The New Query dialog box appears.

4. In the Name box type a name for the query, and in the Description box type an informative description.

544

Chapter 15 Queries

5. In the Type list select the type of results to be queried from the following:
Query Type

Description

Projection

Queries projection results.

NewBusProfile

Queries new business profile results.

Stochastic

Queries stochastic results for each simulation.

Unit Numbers

Queries unit numbers results.

ValMatYear

Queries valuation results that are grouped by maturity year.

ValCurrAge

Queries valuation results that are grouped by current age.

StochasticSummary

Queries stochastic results across simulations using various statistics.

6. Click OK. The query header panel appears.

7. Specify the query dimensions. For each dimension, you can either enter the parameters directly into the
parameters entry field or click the browse button and enter the required entries using the displayed dialog box.
For details on how to enter parameters, see
Depending on the results type, the following dimensions are available:

Managing queries

Aspect

Current Age

Fund Code

Maturity Year

Product

Results Store

Run Number

Simulation Number

Sub-Product

Summary Name

Time Period

Variable

545

Note: The dimensions that appear in the header panel vary depending on the results type selected.
8. Select the header and row dimensions to use for the rows and columns of the displayed query.
9. To run the query, on the HomeQueries tab click Execute Query. The results of the query are displayed in the
grid below the query header.
10. To save the query, on the Home tab click Save. If you are saving a new query, in the Save As dialog box type a
name for the new query.
The query is saved as a separate file in the Queries folder of the Prophet workspace, with the extension .Query.

546

Chapter 15 Queries

Note: When you save a query only the dimension parameters are stored. To update the results or move
dimensions you need to run the query again.
11. To print a query, on the Quick Access toolbar, which is located above the ribbon, click Print.
Note: The results in a pre-Release 8.0 workspace must be recreated before a query can be executed.

Editing the dimension parameters


To edit the dimension parameters for a query:
n

Enter the dimension parameters directly into the query header.


OR

Click the Filter button corresponding to a dimension and edit the parameter from the displayed dimension
dialog box.

Whichever method is used, when a dimension is changed, Prophet reads the required values and updates the grid.

Managing queries

547

Query Properties
To view and edit properties for the currently open query:
n

On the HomeQueries tab click Properties. The Query Properties dialog box appears.

You can view the following settings:


Setting

Description

Properties

Basic information about the query which includes its name, description and
query type.

Filtering

Allows rows and columns in the query results that contain null values or zeros
to be hidden or removed. The zero setting can also be specified.

Name and Description

Specifies how the dimension entries in the row and column headers of the
results grid are displayed.

Number Format

Specifies how the numbers in the results grid are displayed.

Cell Alignment

Specifies the alignment of the values displayed in the headers and grid.

Column Width

Specifies the width of the column displaying the queried data.

Font and Colour

Specifies the characteristics of the font used in the query.

Sorting

Specifies how the queries data is sorted.

548

Chapter 15 Queries

Note: The settings applied in the Query Properties dialog box are for the current query only and are stored with
the query itself.

Manipulating queries
You can manipulate queries to help you inspect the results. Queries can be manipulated to help you inspect the
results. You can:
n

To transpose dimensions in the grid, on the HomeQueries tab click Pivot.

To replace a dimension in the grid, select the row or column button for the new dimension in the query header.

To change the parameters for a dimension, either type the new parameters directly into the dimension field in
the query header or click the Filter button beside the dimension parameter in the query header to display a
dialog box from which you can select and set the parameter values.

To hide the query header, click Query Dimensions. To show the header again, click Query Dimensions again.
Note: If you make changes to the dimensions of a query, regenerate the results of the query by clicking Execute
Query on the HomeQueries tab.

Managing queries

549

Transposing dimensions
You can transpose the the axes or dimensions of the query results.
To transpose the dimensions:
n

On the HomeQueries tab click Pivot.


For example:
Before:

After:

Replacing a dimension
Instead of specifying which are the row and column dimensions in the Specify Query dialog box, you can replace a
row or column dimension by clicking the row or column button alongside the dimension you wish to replace.

550

Chapter 15 Queries

For example, the following illustrates how the Time row dimension, shown on the left, is replaced by the Product
row dimension shown on the right:

Hiding or showing the query header


You can hide or unhide the query header section to display more values on the screen.
To control the visibility of the query header:
n

Click Query Dimensions in the query header to hide or show the query settings.

Managing queries

551

552

Chapter 15 Queries

Charting queries
You can also display the results of a query as a chart in Results Viewer Prophet Forms.
To create a chart from the queried data:
1. Create and run a query based on a set of results.
2. Select the rows and columns of the query results, and on the HomeQueries tab click Update Chart.
The selected results are displayed as a chart in the Chart window.
3. To specify the position of the chart, on the HomeQueries tab click Chart Position and then click one of the
options. For details see Charting options on page554.
4. To specify the type of chart to display, on the HomeQueries tab click Chart Type and then click one of the
options.

Charting queries

A typical chart with its associated results appears similar to the following:

553

554

Chapter 15 Queries

Charting options
You can adjust the charting options, which are on the HomeQueries tab in the Charting group.

The available options are as follows:

Charting queries

555

Chart Position
You can position the chart below the results grid, to the right of the results grid, or in a separate tab. You can
also hide the results grid, and hide the chart.

Chart Type
You can select the chart type to be used to display the results. Choose from Line Chart, Column Chart or Point
Chart.

Update Chart
To recreate the chart based on the selected rows and columns click Update Chart.

556

Chapter 15 Queries

Previewing and printing a query


You can preview and print a query.
1. On the Quick Access ToolbarQueries tab click Print. A preview of the query appears in a new tab.

Previewing and printing a query

557

Use the options on the local toolbar of the preview tab to adjust the page magnification and layout. You can also
print or save the printed query by choosing the appropriate options and search the displayed query using the
search box at the bottom of the tab.
2. To save the printed query, on the Home tab click Save.
3. To print the query, click the Print icon in the local toolbar. On the Print dialog box choose a printer and click OK.
Note: To print the query in landscape mode change the image orientation in the printing preferences.

558

559

Part 4 - Libraries and workspaces

The following sections describe the options relating to the management of libraries and workspaces:
n

Libraries

Actuarial documentation

Import and export

Workspace objects

Prophet options

Using Prophet Enterprise Resources

Workspace utilities

User permissions

560

561

C H A P T E R

1 6

Libraries

TOPICS IN THIS CHAPTER


What is a library?

562

Library objects

563

Managing libraries

565

Managing the variables in a library

576

Managing variable definitions

593

Variable codes and categories

609

Managing indicators

612

Indicator codes and categories

614

Validating libraries

616

Comparing libraries

618

Exporting and importing from within a library comparison

625

562

Chapter 16 Libraries

What is a library?
Libraries are the most important objects in a workspace. They hold the actuarial definitions and formulas which you
use to define the calculations you want to make in your products. They also hold the rules that you want to use for
grouping your model point data.
Prophet is supplied with a number of standard libraries that you will normally tailor as part of the process of setting
up your products. However, you can also create a new empty library if you wish to, and then either create objects for
it from scratch or import them from another workspace.

Library objects

563

Library objects
A library contains the following objects:
n

Variables and Variable Categories

Indicators and Indicator Categories

Grouping Rules and Grouping Calculations

Libraries are used to set up products. Each product becomes a self-contained set of calculation specifications.

Variables and variable categories


Variables are the main objects in a library. They are used to define the calculations to be made by each product.
Variables can be one of two types:
n

Input variables
The definitions given to each input variable in the library are presented to you as defaults when you specify a
new product. You can accept these default definitions or edit them to meet your requirements for each product.

Core variables
The definitions given to each core variable in the library apply to all products which are specified to use them.

An option is also provided which lets you set up input variables so that they are treated by Prophet effectively as if
they were core variables. This can help to reduce the number of input variables that need to be specified for each
product in circumstances where the same definition can apply to those variables across most or all products. See
the section "Primary DEFAULT and secondary DEFAULT variables".
Variables are grouped into variable categories for display purposes. This categorisation groups variables that have
related functionality.

Indicators
Variables and their definitions are effectively indexed in the libraries by the use of indicators. These indicators are
combined into logical combinations called indicator expressions. Each variable definition is given an indicator

564

Chapter 16 Libraries

expression which defines when it should be included in a product. Thus, when you specify a product and select the
indicators for it, Prophet can determine the particular variables to be included in that product.
For example, PUPS (Paid Up Policies) is an indicator. If this indicator is selected for a product then policies can
become paid-up if premiums cease, as well as being able to lapse or to be surrendered. If PUPS is not selected
then policies are assumed only to lapse or be surrendered if premiums cease.
Only if the PUPS indicator is selected are input variables included to specify the PUP benefit, the valuation basis for
PUPs, the rate at which policies become PUP'd etc.
Different core formulas are set up in the library for use if PUPS is selected compared to those used if PUPS is not
selected. For example, the formula for death benefit outgo would include the death benefit payable on PUP'd
policies if PUPS was selected but not if PUPS was not selected.
Indicator Categories
Indicators are grouped into indicator categories for display purposes, to help you select those appropriate for each
product.

Grouping Rules and Grouping Calculations


Grouping rules and grouping calculations specify the rules for grouping individual policy data. See Data grouping
in Prophet.

Managing libraries

565

Managing libraries
Libraries are managed from the using the tree displayed in the Libraries pane. Different options are available
depending on the item selected in the tree.
Managing libraries in a folder
Selecting and right clicking the Libraries folder displays the following context menu:

Options from the menu include:


n

New Library - This enables a new Library to be created.

Sort options - The Libraries in the folder can be sorted in ascending or descending order.

Show List of Libraries - Choose this option to display all Libraries as a list in the Libraries tab of the main work
area.

Library options
Selecting and right clicking a library in the tree displays the following context menu:

566

Chapter 16 Libraries

You can also select more than one library in the tree using the Ctrl+click method and choose an option from the
right click menu. Options include the ability to open, delete and duplicate a library. You can also import objects into
the selected library, and inspect its properties.
In addition to the tree view you can also manage libraries in the workspace from the Libraries Page list view
displayed in the main window.
To display the Libraries page list view:
n

In the Libraries pane, if required, expand the Libraries folder.

Select the Libraries folder and from the right click menu choose Show List of Libraries.

Managing libraries

567

The Libraries Page list view is displayed in the main window:

You can filter the displayed list by selecting options from the Filter section of the Home tab and sort the displayed
list of libraries by clicking on the heading of any column.
Selecting and right clicking a library in the page list allows you to open, delete, validate, and compare the selected
library. You can also import variables, indicators and their categories together with any grouping and calculation
rules into the selected library. A further option also allows you to export the selected library.

568

Chapter 16 Libraries

Library properties
The Library Properties dialog box displays basic details of a selected library. To display the properties dialog box
select the library in the Libraries pane and from the right click menu choose the Properties option. For an existing
Library the Properties dialog box appears as:

The dialog box has the following tabs:


n

General tab
This tab displays the library name and description. The library name can have between 1 and 30 alphanumeric
characters (A-Z, 0-9 and _) but cannot start with a number. Its description can have up to 40 characters.

Statistics tab
This tab displays library related information which is maintained and updated by Prophet consists of:

Library creation date and time

Last library modification date and time

Last input variable modification date and time

Managing libraries

Last core variable modification date and time

Number of variables, definitions and indicators

Original Release Number

569

The Library for projecting assets as individual model points check box is only applicable to the Asset library. No
other library uses this option.

Managing the contents of a library


To open a library, select it from the tree in the Libraries pane and from the Home tab click Open. Alternatively, you
can select the library in the tree pane and from the right click menu choose the Open option.
In either case the library window is opened:

By choosing the appropriate tab in the library window you can edit, copy, create or delete:

570

Chapter 16 Libraries

Variables

Variable categories

Indicators

Indicator categories

Grouping rules

Grouping calculations

You can also view, rename and delete any Formula Block documentation attached to extended formula variables in
the Formula Blocks Documentation tab. The documentation is created for extended formulas using the Formula
Block documentation feature of the Formula Editor.

Creating a library
To create a new library in the workspace select the New Library option of the New menu in the Home tab. When
prompted, enter the name and a description for the new library into the Library Properties dialog box. You should
also select whether the library will be used for projecting assets as individual model points. See Library properties
on page568
When you click OK a new, empty library is created in the workspace.
You can then create your own variables, variable categories, indicators, indicator categories, grouping rules and
grouping calculations.
Note: You should normally create the indicators before you create the variables, because you give each
variable definition an indicator expression to show when it should be included in a product.

Mandatory library variables


The following mandatory variables must be used in every product and hence need to be created in the new library
or imported from another library:

Managing libraries

DUR_M

Duration In Force at Start

PROJ_TERM_Y

Projection Term in Years

571

In addition, each product must also have at least one time-dependent variable.
If you wish to allow for future new business the following variables are also required depending on the new
business method you wish to use:
MTHS_
TO_
SALE

for New Business in Model Point File method. The variable must exist in the library even if you do not
want to use the New Business in Model Point File method but must not be brought into the product.

PREM_
for Cross Multiplication and Project methods. The variable must be cumulative and must have a time
AMOUNT dependent definition

The variable PREM_AMOUNT must be cumulative and must have a time dependent definition
If you wish to produce Valuation results then you must also have the following additional variables in your products:

ACCUM_TYPE

Accumulation Type: 0 = Maturity Year, 1 = Current Age

CURRENT_AGE

Current Age

MAT_YEAR

Maturity Year

Note: For information on new business methods see New business processing . For information on Valuation
results see Types of results on page497.

Deleting a library
To delete a library, select the library you wish to delete from the tree displayed in the Libraries pane and from the
right click menu choose the Delete option. When prompted, click Yes to confirm the deletion
When you delete an existing library the following items are deleted:

572

Chapter 16 Libraries

The variable definitions, variable categories, indicators, indicator categories, grouping rules and grouping
calculations in the library

The variable properties, if the variable does not exist in any other library in the workspace. In this case the
variables are also removed from any variable groups which include them.

All the products and results associated with the library

There is no way to reverse this operation and so you need to consider the matter carefully before deleting a library
from your workspace.
Note: The products deleted as a result of deleting a library are also removed from any accumulations and
structures that refer to them.

Duplicating a library
Prophet allows you to create a new library in your workspace by duplicating or copying an existing library. Its
variables and indicators are then initially the same as those in that existing library. You can then update and revise
the variables and indicators in the new library.
Note: Because it is now possible for a library to begin with the same letter as another library and for product
names to start with a different letter from the library they are associated with, you must take care not to create
duplicate product names.
To duplicate a library:
1. From the tree displayed in the Libraries pane right-click the library you wish to duplicate and on the menu select
Duplicate. The Library Properties dialog box appears.

Managing libraries

573

2. In the Name box type the name of the new library and in the Description box type a suitable description.
3. In the Product Prefix group adjust the product prefixes as required.
n

If the library you are duplicating previously had a prefix and you wish to remove it, in the Remove Prefix box
type the prefix you wish to remove.

574

Chapter 16 Libraries

If you wish to add a prefix to all of the product names that use the newly created library, in the Add Prefix
box type the prefix you wish to add.
Note: When you populate both fields, Prophet first removes the prefix to be removed and then adds the new
prefix. If you leave these fields blank, Prophet attempts to resolve any duplicated product names by
appending a number to each of the duplicated products.

4. Click OK.
Note: You cannot copy products between libraries in the same workspace except through this process of
duplicating a library. This is because it would not normally make sense to do so. If you do not want the
duplicated products in your duplicated library then you can delete them.

Printing the contents of a library


To print the details of one or more libraries select them in the Libraries Page list view and then choose Print from
the Prophet menu. The Print Libraries dialog box is displayed.

From this dialog box you can print either the list of libraries displayed in the Libraries tab or choose the following to
be printed from the selected library:
n

Details for all variables, that is the properties and definitions for all the variables

A list of all variable categories

Managing libraries

A list of all indicators

A list of all indicator categories

Details for all grouping rules

Details for all grouping calculations

575

Variables and indicators can be printed in code or name order. Choose what you want to print and click OK. To see
what is to be printed click Preview.
Further print options, which allow you to filter what is printed, are available by opening a library, selecting a tab in
the Library window and then choosing Print from the Prophet menu.
Note: For the standard libraries supplied with Prophet, a printout of the details for all variables can be extremely
large. This option should therefore be used with care.

576

Chapter 16 Libraries

Managing the variables in a library


When you open a library all the variables stored in it are listed in the Variables tab. If the Details option is selected
from the Home tab then the variables are listed by name, description, data type, variable code and variable type. If
the List option is selected from the Home tab then only the variable names are displayed.

You can sort the displayed list of variables by clicking the appropriate column header in the Variables tab. In
addition, indicator expressions and definitions for a variable selected in the Variables tab are also displayed in the
panes which you can resize, below the listed variables. From the Variables tab you can open and edit definitions for
a variable, create new variables and delete or copy existing variables.
Viewing variables by category
To filter and display only those variables belonging to a specific variable category click the down arrow in the Code
header of the Variables tab and select the variable category from the displayed list.

Managing the variables in a library

577

To redisplay all the variables choose the All Variables option from the Code header list.

Variable properties dialog box


All variables have a set of properties that can be displayed and amended.
To display the properties for a variable:
1. In the Object Browser click Libraries and open the relevant library in the work area.
2. In the work area click the Variables tab, right-click the variable and on the menu click Variable Properties. The

578

Chapter 16 Libraries

Variable Properties dialog appears as follows:

The variable properties are organised into the following sections:


n

Basic Variable Properties


The Name and Type settings are specific to the variable.

Workspace Level Properties


Settings in this section relate to those variable properties that remain the same irrespective of which libraries
include the variable.

Library Level Properties


Settings in this section relate to those variable properties that can vary from library to library.

Basic Variable Properties section


These variable property settings are unique to the variable. They are located in the top part of the dialog box and
appear similar to the following:

Managing the variables in a library

579

The basic variable property settings are as follows:


Setting

Description

Name

The name of the variable must be unique, start with a letter, have no more than 36 characters and
contain no spaces. The letters A to Z, numbers 0 to 9 and the underscore character _ are all valid.
Lower case characters are automatically changed to upper case.
You can change the name of an existing variable but should consider carefully before doing so.
See Deleting or renaming a variable on page590.

Type

The variable type can be either text or number. By default, new variables are numbers. You can
then set a variable as a text variable by choosing the Text option from the Type list.

Workspace Level Properties section


The variable properties that apply at the workspace level are located in the Workspace Level Properties section of
the Variable Properties dialog. It appears similar to the following:

580

Chapter 16 Libraries

These properties remain the same irrespective of which libraries contain the variable. The settings in this section
are:
Workspace Level Properties
The Workspace Level Properties for a variable are asd follows:

Description
The description of the variable must contain no more than 36 characters.

Accounting Type
The Accounting Type may be either Revenue Account or Balance Sheet. The default is Balance Sheet.
Annual values for revenue account variables are displayed as the sum of the twelve monthly values. Annual values
for balance sheet variables are displayed as the values in the last month of the year.

Default Printed Decimal Places


Sets the default number of decimal places to be used when the values for the variable are displayed or printed.
Values can be 0 to 9. The default value is 2 decimal places. Internally, Prophet holds all values in double precision
floating point format.

Cumulative
This option allows you to specify whether it is meaningful to accumulate the values for the variable across model
points. For example, surrender outgo is a cumulative variable but valuation mortality rates are not.
You can also specify this setting in the Variables dialog accessed from the Variables setting of the Options dialog
which is accessed from the Prophet menu. See Specifying variable settings properties.

Cross Multiply as a Number of Policies


Check this option if the variable represents a number of policies. This has an effect on how the variable is crossmultiplied. By default all the variables with names starting NO_ have this option selected. Note that if you are
logged in as an Administrator or as a user who is a member of the administrator group then you can prevent
changes to this option by a user that does not have administrator permissions by selecting the option in the "Fixed"
column.

Managing the variables in a library

581

You can also specify this setting in the Variables dialog accessed from the Variables setting of the Options dialog
which is accessed from the Prophet menu. See Specifying variable settings properties.

Dynamically Calculated
Check this option if the variable's value calculated at the end of a dynamic loop should be overwritten by the value
calculated at the start of the next loop. See "Dynamically calculated variables". Note that if you are logged in as an
Administrator or as a user who is a member of the administrator group then you can prevent changes to this option
by a user that does not have administrator permissions by selecting the option in the "Fixed" column.
You can also specify this setting in the Variables dialog accessed from the Variables setting of the Options dialog
which is accessed from the Prophet menu. See Specifying variable settings properties.

Dynamic Model Point


Check this option if the variable has model point values that need to be adjusted during a dynamic run. The values
that are output to the dynamic model point file at the end of a dynamic loop will then be given the correct values for
the start of the next loop. In the check box below this option you select the variable whose values are to be used in
the next dynamic loop. See "Dynamic model point variables" . Note that if you are logged in as an Administrator or
as a user who is a member of the administrator group then you can prevent changes to this option by a user that
does not have administrator permissions by selecting the option in the "Fixed" column.

Array Variable
You can define a variable to be an array variable that has one or more dimensions by selecting Array Variable. You
then specify the dimensions for the array variable by clicking Dimensions and choosing a dimension name in the
Variable Dimensions dialog.
Note the following:
n

The Dimensions button is unavailable if no dimensions are specified in the workspace. If this is the case then
you must abandon specifying the variable and set up the dimensions in from the Dimensions folder in the
Workspace Objects pane. See Dimensions for more information.

Dimensions are assigned text descriptions that describe their use.

582

Chapter 16 Libraries

You can import and export dimensions between workspaces using the import and export options in the Utilities
tab.

The Array Variable property will be greyed out if any of the definitions for that variable that exist in any library are
not formula definitions.

For a general discussion on how to set up and use array variables in Prophet refer to "Using array variables" .

Constraints
You can specify the values that a variable can have by setting up a constraint condition in the Constraints section of
the Variable Properties dialog. The constraint that you specify is then used to validate the value that you enter for
the variable in the Table Editor.
The constraints are specified for the variable in the Variable Constraints dialog and can be one of the following:
n

Specified values constraint


By setting this type of constraint to a variable you can apply any number of single text or number values with
associated descriptions that the variable can have.

Minimum / maximum / integer constraint


Specifying this type of constraint allows you to specify various combinations of upper and lower integer or noninteger values that can be applied to the selected variable in the Table Editor.

Enumeration
This option allows an enumeration to be used as a constraint to a variable. Note that the data type is still either
Numeric/Text but the value is now constrained to the enumeration members.

To remove a constraint applied to the variable click Delete in the Constraints section.
Variable restrictions
Note that restrictions may apply to some options depending on your user settings as specified by the Prophet
Administrator using the Prophet Administrator application. In particular, if permissions are enabled and you are
logged in as an Administrator or as a user who is a member of the Administrator group then you are able to restrict
users belonging to non administrator groups from changing the following options:

Managing the variables in a library

Cross Multiply as a Number of Policies

Dynamically Calculated

Dynamic Model Point

583

Settings to these options are restricted by the Administrator or a user who is a member of the Administrator group by
setting the appropriate option in the "Fixed" column alongside the option to be restricted. The "Fixed" column only
appears if permissions are enabled you are a member of the Administrator group.
For information on setting up users see "User Permissions".

Library Level Properties section


The variable properties that apply at the library level are located in the Library Level Properties section of the
Variable Properties dialog box. It appears similar to the following:

These properties, namely the type and the variable code, can vary from library to library
The Library Level Properties for a variable are:
Variable Type
Defines the variable type. May be either Input or Core. The default is Input. See "Changing the variable type".
Variable Code
This is a four character code made up of two letters followed by two digits. For example, BN45. This code does not
need to be unique. This code assigns the variable to a variable category.

584

Chapter 16 Libraries

You can either enter the code or click Browse to display a list of the codes for all variables in the current library. If
you select a code using the Browse option then Prophet increments the number of the selected code by one and
places that number in the Variable Code field.
The purpose of this code is to group variables that perform related calculations.
Modified
This is a system generated date and time stamp. It is created when you first create and save a variable. It is
subsequently updated whenever the variable is edited. This information is also displayed in the Modified column of
the Variables tab of the open library. To clear the information you need to be a user having Administrator
permissions. See Clearing Modified and Modified By details.
Modified By
This is generated by the system and contains the username of the person who first created the variable.
Subsequently, the field is updated by the system whenever the variable is edited. This information is also displayed
in the Modified By column of the Variables tab of the open library. To clear the information you need to be a user
having Administrator permissions. See Clearing Modified and Modified By details.
When you create or update a variable property and click OK the following occurs:
n

The Modified property settings is automatically updated with the current time and date taken form the PC

The Modified By property setting is filled with the username of the person making the changes to the variable

The variable properties are saved.

Variable constraints dialog box


You specify the values that a variable can have by specifying them in the Variable Constraints dialog box which is
displayed when you click Add/Edit in the Variable Properties dialog box. For details see Variable properties dialog
box on page577.

Managing the variables in a library

585

Once the constraint values are specified for a variable they are used to validate the data entered for the variable in
the Table Editor.
To specify a constraint for the variable in the Variable Constraints dialog box you select the type of constraint from
the Type list. When you click OK the constraint is applied to the variable and a description of the type of constraint
applied to the variable is displayed in the Constraints section of the Variable Properties dialog box.
To remove a constraint applied to a variable click Delete in the Constraints section of the Variable Properties
dialog box for the variable.

Specified values constraint


Applying this type of constraint to a variable allows you to specify any number of discrete single text or number
values together with any associated descriptions that the variable can have. These discrete values are then shown
in a list for the variable when it is being edited in the Table Editor.

Tables constraint
Applying this type of constraint to a variable allows you to restrict the tables that you can use to the tables specified
in the Options dialog box in the File Locations tab.
Note: This option is only available if the variable is a Text variable.

586

Chapter 16 Libraries

Mortality Tables constraint


Applying this type of constraint to a variable allows you to restrict the mortality tables that you can use to the tables
specified in the Options dialog box in the Calculation Engine tab in the Mortality Tables Location setting.
Note: This option is only available if the variable is a Text variable.

Minimum / maximum / integer constraint


Specifying this type of constraint allows you to specify various combinations of upper and lower integer or noninteger values that can be applied to the selected variable in the Table Editor. You can specify any combination of
the following:
n

Number or integer value

Minimum value

Maximum value

Enumeration constraint
Applying this type of constraint to a variable allows you to specify any of the elements of the chosen enumeration.
These element values are then shown in a list for the variable when it is being edited in the Table Editor.

Changing the variable type


You can open and change the properties of any variable. However there is a logically correct setting for many of the
properties of a variable. Particular care must be taken when:
n

Changing an input variable to a core variable, or

Changing a core variable to an input variable

Changing an input variable to a core variable


There may be occasions when an input variable should be redefined as a core variable. If you do this, Prophet
identifies all the products that use the variable and displays them. You then have the option to continue or cancel
the operation.

Managing the variables in a library

587

If you continue, Prophet saves the input variable as a core variable and removes the input variable and its definition
stored in each product from all the identified products and sets their status to Specified. This means that they will be
regenerated in the next run in which they are included. At that stage the appropriate core variable definitions will be
included automatically.

Changing a core variable to an input variable


There may be occasions when a core variable should be redefined as an input variable. You are able to make this
type of change. However, Prophet is unable to identify which products the variable should then be added to. You
therefore need to re-scan each of the products that may then need to have the variable included. If you want to
change the definition used by any of these products from its default you will need to open the product and amend
the definition individually.

Primary DEFAULT and secondary DEFAULT variables


The concept of DEFAULT variables provides an alternative approach which enables input variables to be treated
by Prophet as if they were core variables.
If a default definition for an input variable has the following as part of its indicator expression it will be treated
slightly differently when a product is specified:
AND NOT DEFAULT*

where * represents any string of between 0 and 5 characters. For example, DEFAULT_STD.
If the DEFAULT* indicator is not selected for a product, the default definitions will be included in the list of input
variables to be defined in the normal way. You can change the default definitions as required.
If the DEFAULT* indicator is selected for a product and the remainder of the indicator expression indicates that the
input variable qualifies for that product then the input variable is excluded from the list of input variables to be
defined and its default definition is included during code generation in the same manner as core variables. The
variable is then classified as a primary DEFAULT variable. If the default definition included in this way references
any other input variable which is not already included in the product by virtue of its indicator expression then no
secondary input variable will be included in the product.
This facility of DEFAULT variables is useful when you require an input variable to have the same definition across a
number of products, for example, to read values from a table at run time.

588

Chapter 16 Libraries

Variables can also be set up with definitions with just NOT DEFAULT* as their indicator expression. These
variables are then treated as secondary input variables except that:
n

They are excluded from the list of input variables (even if referenced by another input variable)

They are included in a product at the time it is generated whenever DEFAULT* is selected.

Note that they are included at this stage regardless of whether or not they are referenced by another input variable.
Note: By design, default indicators cannot be used in indicator expressions that are specified in a core variable.

Variable Dimensions dialog box


You can select dimensions for a selected variable from the Variable Dimensions dialog box.
To display the dialog box:
1. In a library, right-click a variable and on the menu click Properties. The Variable Properties dialog box
appears.
2. In the Variable Properties dialog box, when Array Variable is selected, click Dimensions.

Managing the variables in a library

589

Two lists of dimensions are displayed:


n

Available Dimensions list - contains the available dimensions.

Ordered Selected Dimensions list - contains the dimensions specified for the array variable. You can arrange
the order of the dimensions by using the up / down buttons to the right of the list.

You move the dimension items from one list to another by selecting the items and choosing the appropriate button.
You can also select one or more items and then drag and drop them from one list to the other.
Click OK when you have selected the required items.
Note the following:
n

Dimensions for the workspace are specified and managed in the Dimensions dialog box which is accessed
from the Dimensions setting of the Options dialog box.

You can import or export dimensions between workspaces by choosing Dimensions from either the Import or
Export options on the Utilities tab.

Creating a variable
You can add any number of new variables to a library. A new variable can be created from scratch. It can also be
based on an existing variable by copying it and assigning a new name to it.
Always take some time to plan what you want a new variable or variables to do before creating them.
The steps required to create new variable are:
n

From the Home tab choose the New Variable option in the New menu.

590

Chapter 16 Libraries

Alternatively, select a variable in the Variables tab and from the right click menu choose the New option.
n

Complete the Variable Properties dialog box

Select the new variable in the Variables tab and from the right click menu choose New Variable Definition.

From the Definition Type dialog box choose a definition type for the first definition to be created for the variable
and click OK.

To create additional definitions for the variable then create them in the same way.
Note: For details on how to enter the variable properties refer to "Variable properties".

Deleting or renaming a variable


Deleting a variable from a library or renaming a variable in a workspace should be done with care because the
variable being deleted or renamed may still be referenced in a formula or other definition of another variable.
Prophet cannot check for this at the time a variable is deleted or renamed.
You can use the Validate option from the Object tab to validate all the definitions in a library. See the section
"Validating libraries" in this chapter. This will identify any variable definitions which reference the variables that you
have deleted or renamed. You will also need to check whether any of the products that contain input variables
reference those variables that have been deleted or renamed. To do this you open each of the products in turn and
then use the Find option from the Home tab.

Managing the variables in a library

591

If you do not perform these validation checks any problem will be identified during the generation of your products
and you can then make the necessary corrections.
Note: It is recommend that you do not rename any of the variables in the standard libraries as supplied. This is
because of the difficulties that would then arise if you subsequently want to upgrade to a later version of the
standard library.

Duplicating a variable
You can duplicate or copy an existing variable within a library. You need to give the new variable a different name.
To duplicate a variable:
n

Select the variable in the Variables tab of the open library you wish to duplicate and from the right click menu
choose Duplicate.

Enter a new name and update the details for the duplicated variable.

Click OK to create the new variable.

After duplicating the variable you can then edit its properties and definitions.
This approach can in some circumstances prove easier and quicker than setting up the new variable from scratch.

Printing variables
To print the details of one or more variables in a library select them in the Variables tab of the Library window and
from the right click menu choose Print. The following options are available:

592

Chapter 16 Libraries

You can specify the level of detail printed for each variable:

A list of the variable names with their description, code and type

All the details for the variables including their properties and definitions.

You can print the variables in either code order or name order

You can specify which variables are printed:

All the variables in the library

Those variables that you have selected on the Variables tab

The variables in a particular variable group.

Choose what you want to print and click OK. To see what is to be printed click Preview.
Note: For the standard libraries supplied with Prophet, a print of all of the details for all of the variables would be
extremely long. This option should therefore be used with care.

Managing variable definitions

593

Managing variable definitions


Variables are the building blocks of Prophet calculations. Each variable can be given one or more definitions. You
specify each variable definition through the definition type you give it. The following definition types are available:
Definition type

Description

Formula

A formula expressed in Prophet's programming language

Constant

A constant value

Global

The value is read from the global file at run time

Parameter

The value is read from a parameter file at run time

Model Point

The value for each model point is read from the model point
file at run time

Generic Table

The value or values are read from a specified generic table at


run time

Mortality Table

The values are read from a specified mortality table at run


time

Year Dependent Mortality


Table

The values are read from a specified year dependent


mortality table at run time

Year Index Table

The values are read from a specified year index table at run
time

Time Index Values

Constant values for specified months of the calculations

Extended Formula

A formula expressed using Prophet's extended formula syntax

t-Dependent Extended
Formula

A formula expressed using Prophet's extended formula syntax


that supports t dependent values.

Each of these variable definition types is described in "Variable definition options".

594

Chapter 16 Libraries

Default definitions and alternative definitions


Each definition attached to an input variable can be specified to be either a default definition or an alternative
definition.
When you initially specify a new product the appropriate default definitions based on the indicators you select are
presented automatically within the product. You can then accept or amend these default definitions or set up new
definitions.
Alternative definitions are additional definitions that you can set up in the library and then use in a product. For
example, if you have a particularly complex formula which only applies to some products you can set it up in the
library as an alternative definition. Then, when you specify the products which should use it, you can select it for
those products. You would do this by opening the variable within the product and from the Design tab click Change
Definition Type.
Another example of the usefulness of alternative definitions is for experience mortality. The default definition may
assume that the mortality table is A67/70(2) but definitions which read other standard mortality tables may be
specified as alternative definitions.

Editing the definitions for a variable


To view the definitions for a variable you select the variable in the Variables tab of the library. A selected variable
and its definitions appears similar to the following:

Managing variable definitions

595

The indicator expression / description is displayed for the selected variable in a pane below the list of variables.
Selecting a definition in this pane displays the actual definition in the pane below.
Note: If more than one definition exists for the same variable they are numbered 1, 2, 3 and so on.
Options available in the Definitions pane allow you to do the following for a selected variable:
n

Edit an existing definition by selecting a definition and from the right click menu choosing Open

Create a new definition by selecting a definition and from the right click menu choosing New

Delete a definition for the variable by selecting a definition and from the right click menu choosing Delete

Duplicate an existing definition by selecting a definition and from the right click menu choosing Duplicate

596

Chapter 16 Libraries

Re-order the list of definitions by choosing a definition and choosing Move Up or Move Down from the right click
menu.

In addition, you can also display and edit the properties of the variable to which the definitions apply.

Indicator expressions
Each default definition for an input variable and each definition for a core variable is assigned an indicator
expression. This indicator expression defines the circumstances in which the definition is included in a product.
Each indicator expression is a logical expression of the indicators in the library which evaluates to "true" or "false".
For example, using indicators in the Conventional library, consider the indicator expression:
REG_PREM AND (ENDOWMENT OR WHOLE_LIFE OR LEVEL_TERM)
AND NOT INCR_PREMIUM

If a variable definition is given this indicator expression, that definition will be included in a product if:
n

REG_PREM is selected, that is the product has regular premium payments, and

Any of ENDOWMENT, WHOLE_LIFE or LEVEL_TERM are selected, that is the product is either an endowment,
whole of life or a level term assurance, and

INCR_PREMIUM is not selected, that is the premium payments for the product do not increase over time.

An input variable can also be given a default definition with a blank indicator expression. It is then only included in
a product if another variable is defined to reference it.
Each alternative definition for an input variable is identified by a description. It is only included in a product if you
select the alternative definition to replace the existing definition.
If more than one default or core definition is set up for a particular variable then the indicator selections must be
mutually exclusive.
n

Prophet will warn you if you create a new product or re-scan input variables for an existing product and it finds
that two or more definitions qualify for any one input variable.

Prophet will terminate the generation of a product if two or more definitions qualify for any one core variable.

Managing variable definitions

597

If this happens, you should then correct the indicator expressions for the variable definitions.

Creating a variable definition


If you select to create a new definition or change the type for an existing definition the Definition Type dialog box
appears.

Choose the definition type you require. If the variable is an input variable you can create the definition as an
alternative definition by selecting the Alternative Definition option. If this option is not selected then the definition
becomes a default definition.
Note: An alternative definition cannot be created for a core variable. However, if you change an input variable
to be a core variable any existing alternative definitions are retained but are not used.
Complete the definition by entering the required information. The following formula definition appears similar to the
following:

598

Chapter 16 Libraries

A separate tab for each of the variable definitions is displayed when you open a variable with each tab having two
panes. You enter either an indicator expression or a description in the bottom pane, depending on whether the
definition is a default or alternative definition. The information in the top pane varies according to the definition type.

The options available to you to specify definitions in a library are exactly the same as when you are specifying
definitions for input variables in a product. See "Variable definition options".

Insert Indicator facility


You can use the Insert Indicator facility to enter indicator names into an indicator expression. To do this place the
cursor in the indicator expression where the new indicator is to be inserted. Then press F3 or click Insert Variable /
Dimension.. from the Design tab.
A list of the indicators in the library is then displayed:

Managing variable definitions

599

If you enter the first few letters of the indicator name then the first indicator starting with those letters is highlighted.
Select the indicator you require and click OK to enter it into the indicator expression.

Insert Variable, Dimension or Enumeration


You can use the Insert Variable/Dimension facility to enter the following into a formula:
n

Variable names

Array variable dimensions

Enumerations

To enter a variable, an array variable dimension or an enumeration:


n

Open the formula into which the item is to be inserted and place the cursor in the formula where it is to be
inserted.

Press F3 or on the Design tab select Insert Variable/Dimension.

A list of the variables, array variable dimensions and enumerations in the library or workspace is displayed
similar to the following:

600

Chapter 16 Libraries

If you know the name of the variable, array variable dimension or enumeration then you can locate it by entering the
first few characters of its name in the text box. Alternatively, select the item you require and click OK to enter it into
the formula.

Using array variables


Array variables allow parameters other than time to be used within normal formulas within Prophet. These
parameters are called dimensions and are defined at a workspace level.
The dimensions of an array variable are specified in the workspace. Once dimensions are specified you can then
set up the array variable.
n

To create and specify the dimensions used by array variables see Setting up a dimension on the facing page.

To create an array variable using the dimensions specified in the current workspace see Setting up an array
variable on the facing page.

Managing variable definitions

601

Setting up a dimension
To set up a dimension choose the Dimensions setting from the Options dialog box which is displayed when you
click Options from the Prophet menu.
The Dimensions dialog box appears from which you can create, edit and delete dimensions for the workspace. For
details see Dimensions.
To add a new dimension:
1. In the Dimensions dialog box click New.
2. Complete the dimension name, size and description fields and click OK.
Note the following:
n

The name of a dimension cannot be the same as a variable name within the same workspace.

To minimise the run time and the memory usage it is advised that you do not specify a dimension size greater
than is required.

Dimension sizes can always be updated after a product has been set up, although further tailoring to variables
may be required if dimension sizes are increased.

Setting up an array variable


To create a new array variable you open the library and on the Home tab click the arrow below New and on the
menu click New Variable.
To specify an array variable in the Variables Properties dialog box select Array Variable. Then specify the
dimensions for the array variable by clicking Dimensions and choosing the dimensions that you require for this
variable from the Variable Dimensions dialog box. For example, you could select the previously defined
dimensions SEX_DIM and SMOKER.
An existing variable can also be changed to be an array variable in the same manner. It is generally expected that
you would then change the variable definitions to make use of the dimensions that you have added to the variable.
Note the following:

602

Chapter 16 Libraries

You can only use formula definitions for an array variable.

If you change an existing variable to an array variable then all definitions for that variable in every library must
be changed to formula definitions.

Array memory allocation


Memory for an array is allocated dynamically as required. Only those elements of an array that contain data are
stored in memory. Elements that are empty are not allocated. This type of array is known as sparse array. All arrays
in Prophet are treated as sparse and have the folloiowng characteristics:
n

Empty or zero elements are not allocated memory.

Arrays are not resized for out of bounds read access.

Additional memory is only allocated when non-zero values are added. This causes sub-blocks to be allocated
which are destroyed when the array is initialised.

Note the following:


n

Arrays of up to four dimensions are supported and t persistency.

The value of unallocated elements is treated as zero. Reading a value that does not exist is treated as zero.

An array is sparse on all but the last dimension.

For t-persistency each time period has an independent array.

The ARRAY_INTITIALISE function will only set bounds for an array using very little memory. Re-initialising an
array releases memory and resets bounds.

Copying arrays
Arrays containing elements of the same type can be copied. This eliminates the need for multiple loops with a
single line of code. It is also significantly faster to copy an array compared to copying individual array elements.
Note: An extended formula array cannot be copied into a normal variable. Similarly, a normal variable cannot
be copied into an extended formula array

Managing variable definitions

603

To copy an array do the following:


n

Specify an assignment operator


The assignment operator allows arrays to be specified. It is also possible to declare an array variable as
persistent or dynamic persistent. This will copy the array into the current time or dynamic loop. For example:
Private A(0,0) as Number
Private B(0,0) as Number

Specify the copy process


Once the arrays are assigned you copy the source array to the target array. For example the following copies
array A into B growing A if necessary:
A := B

Note the following:


n

Only arrays containing the same number of dimensions and type can be copied. For example, a two
dimensional array cannot be copied into a three dimensional array

Arrays of numbers, integers, and text values can be declared in extended formula.

An array can be assigned to another only if the elements are of a compatible type. Generally, you cannot assign
a numeric value to a text, nor assign a real to an integer because of loss-off precision.

Numbers are resolved as real but can be optimised to be integer in certain conditions such as looping variables
in for-loops.

An array variable example


An example of an array variable definition for a variable AV_Q_EXP_PN is as follows:
1: Default Formula Definition
Q_EXP_PN(t) * (1 + SEX_LOAD(SEX_DIM))
* (1 + SMOKER_LOAD(SMOKER))
Indicator Expression
ADJ_MORT

604

Chapter 16 Libraries

In this example SEX_LOAD and SMOKER_LOAD are array variables which are specified separately.
If SEX_DIM and SMOKER both have a dimension size of 2 then the four elements of this array will show in the
results and Diagram view with notation as follows:
AV_Q_EXP_PN(1:1)
AV_Q_EXP_PN(1:2)
AV_Q_EXP_PN(2:1)
AV_Q_EXP_PN(2:2)

An example of using t-dependent array variables


An example using t-dependent array variables is as follows:
IF t < DUR_M OR t > POL_TERM_M THEN
0
ELSE IF t = DUR_M THEN
UNF_VOU_0_AV(fund)
ELSE
UNF_VOUAD_AV(fund,t) * (1 + M_UNITGTH_AV(fund,t))

If the parameter t, representing time, is used then it must come after the dimensions in the array variable syntax.

Array variables - Example of setting up multiple discount rates


Calculating discounted values on a number of different bases by using array variables could be approached as
follows:
1. Define the array dimension
2. Set up the discount rates to use
3. Calculate the monthly discount rates
4. Calculate the discounted values you require

Managing variable definitions

605

Define the array dimension


To define the array dimension:
1. On the Prophet menu click Options. The Options dialog box appears.
2. In the Options dialog box click Dimensions. The Dimensions dialog box appears.
3. In the Dimensions dialog box click New.
4. Give the dimension a name, for example DISC_RATE, and choose the size you want, for example 5. Give the
array dimension a description, for example "Discount Rates". To give each element of the array a description,
click Descriptions.

Set up the discount rates to use


Open your library and create a new variable DISC_RATE_PC. Tick the array variable box, press the Dimensions
button and select DISC_RATE. Give the variable an appropriate description and variable code. You should now set
up an appropriate formula definition for this variable. For example, if you want to use discount rates of 3%, 5%, 7%,
9% and 11% then you could give it the following formula:
IF DISC_RATE = 1 THEN
3
ELSE IF DISC_RATE = 2 THEN
5
ELSE IF DISC_RATE = 3 THEN
7
ELSE IF DISC_RATE = 4 THEN
9
ELSE
11

Alternatively, if you want to read the values from a global file then you could use the formula:
READ_GLOBAL("DISC_RATE_PC(" + NUM_TO_TEXT(DISC_RATE, 0) + ")")

606

Chapter 16 Libraries

In this case your global file would need to contain entries for DISC_RATE_PC(1), DISC_RATE_PC(2), DISC_
RATE_PC(3), DISC_RATE_PC(4) and DISC_RATE_PC(5).
You should set up an appropriate indicator expression for this definition, for example DISC_PROFITS OR DISC_
REVACCT OR ACC_PROFITS.

Calculate the monthly discount rates


Create a new variable M_DISC_RATE. Tick the array variable box, press the Dimensions button and select DISC_
RATE. Give the variable an appropriate description and variable code. Set up a formula for this variable with the
following definition:
(1 + DISC_RATE_PC(DISC_RATE)/100)^(1/12) - 1

Set up an appropriate indicator expression for this definition, for example DISC_PROFITS OR DISC_REVACCT OR
ACC_PROFITS

Calculate the discounted values you require


For example to calculate the discounted value of future profits, create a new variable DISC_PROF. Tick the array
variable box, press the Dimensions button and select DISC_RATE. Give the variable an appropriate description
and variable code. Set up a formula for this variable with the following definition:
IF t = PROJ_TERM_Y * 12 OR t < DUR_M THEN
0
ELSE
(DISC_PROF(DISC_RATE,t+1) + PROFIT(t+1) - MAT_PROFIT(t+1)) /
(1 + M_DISC_RATE(DISC_RATE,t+1)) + MAT_PROFIT(t+1)

Set up an appropriate indicator expression for this definition, for example DISC_PROFITS.
You can also create any other discounted values using the same approach, for example if you want to have the
discounted value of future profits at the point of sale then create an array variable START_PVFP with the formula:
IF t = 1 THEN
DISC_PROF(DISC_RATE,0)

Managing variable definitions

607

ELSE
0

Array variable functions


Functions that are specific for use with array variables are: ARRAY_SIZE, ARRAY_SUM, ARRAY_PROD, ARRAY_
MIN, ARRAY_MAX and ARRAY_INITIALISE.
ARRAY_SIZE
This function gives the size of a particular dimension, which may be useful if, for example, you want to add array
elements and you wish to change the size of the dimension in the future. Using ARRAY_SIZE you do not need to
have your final array element hard-coded in your variable definitions.
An example of this function is as follows:
ARRAY_SIZE("occ_class")

ARRAY_SUM
ARRAY_SUM adds together elements of the given array variable, between the indices specified. For example:
ARRAY_SUM(ADJ_DTH_R_AV(SEX_DIM,SMOKER,OCC_CLASS,t),
"SEX_DIM", 1, 2, "SMOKER", 1, 2, "OCC_CLASS", 1, 6)

In this example the elements of the variable ADJ_DTH_R_AV between ADJ_DTH_R_AV(1:1:1) and ADJ_DTH_R_
AV(2:2:6) will be added together.
ARRAY_PROD
ARRAY_PROD multiplies the elements of the given array variable between the indices specified. For example:
ARRAY_PROD(REGION_LOAD(REGION), "REGION", 1, ARRAY_SIZE("REGION"))

System variables applicable to array variables


If the existing system variable VAR_NAME is used within an array variable definition then that particular element
will be returned. For example, if VAR_NAME was used within REGION_LOAD then REGION_LOAD(1), or
REGION_LOAD(2) ...and so on would be returned as appropriate.

608

Chapter 16 Libraries

There is a new system variable called JUST_VAR_NAME that if used in REGION_LOAD would return REGION_
LOAD regardless of the indices.

Global array variable filter


A global filter in Prophet allows you to view only certain elements of an array in Diagram view or Results view.
If 1 is selected then only the elements with a first index of 1 are displayed.
If 1:1 is selected then only elements with first element 1 and second element 1 are displayed
...and so on.
To choose ranges use a hyphen or use commas to create a list.
Dimensions must be separated by a colon.

Variable codes and categories

609

Variable codes and categories


Variable codes consist of two letters followed by two numbers. They group and order variables which perform
related calculations. The two letters define the variable category to which the variable belongs.
For example, the code EB10 indicates that the variable belongs to the EB category, which has a description of
Death Benefit in the Conventional library. This category is a sub-category of the E category which has a description
of Benefits.
The numbers order the variables within each variable category.
Variable codes are primarily used for the display of variables in the Variables tab of a library and in the Product
Definition window. They can also be included in the display of results.
Note: Prophet ignores variable codes when it is sequencing variables into the order for calculation as part of
the code generation process. For this purpose it only uses the actual calculation dependencies between
variables.
Variable categories are created and managed in the Variable Categories tab of the Library window

610

Chapter 16 Libraries

If the Details option is selected from the Home tab the variable code names (that is the one or two letters) are
displayed together with their descriptions. If the List option is selected from the Home tab then only the names are
displayed.
From the Variable Categories tab you can inspect and edit a selected variable category. You can also create a new
category and copy or delete an existing one.

Printing variable categories


To print the details of one or more variable categories select the Variable Categories tab. Click the Prophet button
and from the menu click Print. Alternatively, select a category and from the right click menu choose Print. The Print
Variable Categories dialog box appears.

Variable codes and categories

You can print either:


n

A list of all the variable categories in the library

A list of the variable categories you had selected on the Variable Categories tab.

Choose what you want to print and click OK. To see what is to be printed click Preview.

611

612

Chapter 16 Libraries

Managing indicators
The indicators in a library are managed in the Indicators tab of the Library window.

If the Details option is selected from the Home tab then the indicators are listed with their details. If the List option is
selected from the Home tab then only the names of the indicators are displayed.
You can sort the displayed list of indicators by clicking on the heading of any column.
From the Indicators tab you can create new indicators and edit or delete existing ones. You can also copy an
existing indicator as a means of creating a new one.

Managing indicators

613

Printing indicator details


To print the details of one or more indicators select the Indicators tab and then select one or indicators. Then from
the right click menu choose Print. The Print Indicators dialog box appears.

You can print either:


n

A list of all the indicators in the current library

A list of the indicators you had selected on the Indicators tab.

The indicator details are printed in alphabetical name order if you choose the Name Order option. Alternatively, the
details are printed in ascending code order if you choose the Code Order option.
Choose what you want to print and click OK. To see what is to be printed click Preview.

614

Chapter 16 Libraries

Indicator codes and categories


Indicator codes consists of a single letter followed by two numbers. They group and order indicators into logical
categories. They are primarily used in the Select Indicators for Product dialog box when you are specifying a
product. The single letter is called an indicator category.
Indicator categories are created in the Indicator Categories tab of the Library window.

If the Details option is selected from the Home tab then the indicator category names (that is the single letters) are
displayed together with their descriptions. If the List option is selected from the Home tab then only the names of
the indicator categories are displayed.
From the Indicators Categories tab you can inspect and edit a selected indicator category. You can also create a
new indicator category and copy or delete an existing one.

Indicator codes and categories

615

Indicator category details


The details of an indicator category can be inspected by selecting the category in the Indicator Categories tab and
from the right click menu choosing Open. The details of an indicator category appear similar to the following:

You can update the name and description of the indicator category.

Printing indicator category details


To print details of one or more indicator categories select them in the Indicator Categories tab and from the right
click menu choose Print. The Print Indicator Categories dialog box appears.

You can print either:


n

A list of all the indicator categories in the library

A list of the indicator categories you had selected on the Indicator Categories tab.

Choose what you want to print and click OK. To see what is to be printed click Preview.

616

Chapter 16 Libraries

Validating libraries
If you have made significant changes to the library variables, indicators and definitions it is a good idea to validate
the library using the library validation option.
This validation primarily checks for situations where a variable or indicator is referred to in a definition but does not
exist in the library. The reasons why this situation may arise are:
n

You have deleted or renamed an existing variable or indicator without making the necessary changes to the
definitions that refer to it.

You have selected the Proceed anyway option when updating variable definitions in a library, when Prophet
has informed you that a variable referred to in a definition is missing from the library.

You have imported variables from another library that contains additional variables and/or indicators.

How to validate a library


To validate a library select the library in the Libraries pane and from the right menu or the Object tab, choose
Validate . Prophet opens the library and checks that:
n

Every variable referenced in every formula definition and in every generic, mortality, year dependent mortality
and year index table definition exists in the library.

Every indicator referred to in the indicator expression for every definition exists in the library.

Prophet searches through the entire library and identifies all the validation problems. If there are any, the first
definition which has failed the validation is opened and a dialog box is displayed.
If it is not clear what has caused the definition to fail the validation you should click OK on the Variable Definition
window. You can do this without first closing the Validation dialog box but if the OK button is not available then click
anywhere in the definition pane. The definition will then be validated again and details of the precise cause of the
problem will be displayed. You should then be able to correct the problem and click OK to save the corrected
definition.

Validating libraries

617

Note: If there are errors in both the formula and the indicator expressions then these are counted as two
separate errors. You will not be able to save the corrected expression until you have moved to the second
validation error by clicking Next in the Validation dialog box.
You should then click Next on the Validation dialog box for the next invalid definition to be displayed.

You should continue this process until all the definitions have been corrected. If at any stage you wish to stop the
validation process click Close on the Validation dialog box.
You should note that if you click Next without closing the definition by clicking OK or Cancel then it will remain
open and you will need to close it yourself at a later stage. If you have a lot of such open definitions the easiest way
to close them is to close the library or to click Close All in the Home tab.
Note: You can also validate individual variables in a library by selecting them in the Variables tab in the Library
window and then clicking Validate in the Object tab.

618

Chapter 16 Libraries

Comparing libraries
When you compare two libraries, you compare the variables and definitions stored in those libraries. You can
choose whether to compare all variables or various subsets of them.
At the end of the compare operation, the differences between the variables are displayed. These can be printed or
be saved to a file for future reference.
For instance, if you compare any of your existing libraries with a copy of the original standard library supplied to you
that you have used for your tailoring, you will generate a complete list of the changes you have made to the
variables.
You can also export or import the variables listed in a library comparison between workspaces. This can be
particularly useful when you need to incorporate changes made to a library in another workspace into the current
library or you are retailoring a standard library with changes that you made to an earlier version of the standard
library.
Note: The two libraries being compared must be closed before a comparison can be performed.

Running a library comparison


To run a library comparison on two libraries first close the libraries if they are open. Then select one of the libraries
to be compared in the Libraries pane and from the right click menu choose Compare to display the
CompareLibrary dialog box

Comparing libraries

619

In the Compare Library dialog box, select the library to be compared with and the variables to be included for this
comparison. You can select:
n

A standard library, that is a library as originally supplied

A library in a different workspace

A different library in the current workspace

You can choose to use either the standard compare settings or apply additional settings by clicking Advanced.
Click on the following to display the settings that are available.

Standard compare settings


Standard compare options allow you to choose which variables are to be used in the comparison. You can perform
the comparison on:

620

Chapter 16 Libraries

All Variables

Input variables only

Core variables only

A variable group and category

A variable code

To start the compare process click OK. To apply additional compare options click Advanced.

Advanced compare settings


In addition to the standard compare options you can apply further compare options by clicking Advanced. The
Compare Library dialog box is then extended to display the additional options. The dialog box appears similar to
the following:

The advanced compare settings allow you to:


n

Compare all items used in the libraries.

Compare indicators only

Comparing libraries

Compare formulas only

Compare variable codes only

621

Depending on the compare settings selected you can further specify:


n

To ignore variable codes and/or descriptions

To ignore the case of letters used for indicators and formulas

To ignore indicator expressions

To ignore the dimension values of array variables and comments

To compare definitions in the order they are displayed (if this is not selected, the definitions are compared
based on their indicator expressions).

When you click OK the advanced compare settings are first saved. The comparison is then processed using all the
settings specified in the extended dialog box. At the end of the comparison the results are displayed in the
comparison window.
Note the following:
n

To apply the advanced settings for another comparison you need to click Advanced before staring the compare.

Advanced settings are saved between comparisons.

Viewing, saving and printing a library comparison


When the comparison of the two libraries is complete the differences are displayed in a window.

622

Chapter 16 Libraries

This window displays the variables that differ between two libraries. Variables that have differences are listed in the
left pane and their definitions in the two libraries are displayed in the middle and right panes.
You highlight a variable in the left pane to see its definitions in the two libraries being compared. Items are
displayed as follows:
n

Unchanged text on changed lines is shown in blue

Additional lines and changed text is shown in red.

Identical lines are shown in black

A Line Details area at the base of the comparison panes displays the contents of the selected lines in the panes. It
uses the entire width of the viewer window to display each line, one on top of the other.
You select variables whose differences you wish to print, export or import in one of the following ways:

Comparing libraries

623

Standard windows selection method


You use the Shift-Click method to select contiguous variables or Ctrl Click to select non contiguous variables.

Checkbox selection method


For each variable that you wish to print, export or import you select the checkbox alongside the variable name.

A number of display options are available from the comparison toolbar immediately above the middle and right
panes. For the available options see Comparison toolbar.
Note: You can adjust the widths of the panes to see more of the information by dragging them across.

Saving a library comparison


To save a library comparison click Save in the Library Comparison window. You are then prompted to enter a name
and location for the file in which the comparison is to be saved. Once saved you can load and view the comparison
file in Viewer, a word processor such as Microsoft Word or WordPad.
If you want to maintain a log of the changes you have made or are making to a library, it will generally be better to
take a copy of the current workspace rather than to use this Save Comparison option. For instance, copying the
workspace will enable you to:
n

Produce the comparison listing whenever required in the future

Easily reverse out subsequent changes, if required.

Printing a library comparison


To print the library comparison click Print in the Library Comparison window. The Print Library Comparison dialog
box appears

624

Chapter 16 Libraries

You can choose the following options to preview or print the variable differences in the current library comparison:
n

All variable differences


All variable differences are printed.

Selected variables
The variable differences that are selected in the variables list using the standard windows selection method.

Checked Variables
The variable differences that are selected in the variables list using the checkbox selection method. Note that
this option is only available if one or more variables are checked in the variables list of the comparison.

To print the comparison with the selected option click OK. To display a copy of the selected print setting click
Preview.
Note: Library comparison details are always printed in landscape orientation.

Exporting and importing from within a library comparison

625

Exporting and importing from within a library comparison


The Export button in the Library Comparison window allows you to export variables from the current library to
another library in another workspace. This facility is particularly useful if you want to update the latest standard
library with the changes that you have made to an earlier version of the same standard library. If you compare your
current library with the standard version on which it is based the Library Comparison window will display all the
changes that you have made. You can then export the tailoring you have made to a workspace containing the latest
standard library.
To export the new or changed variables select them in the Library Comparison window then click Export and from
the menu choose one of the options:

.
You can export the variables from the library comparison in the following way:
n

All Variables
This option exports all variables listed in the library comparison window that are different or do not exist in the
other library.

Selected Variables
This option exports those variables listed in the library comparison that have been selected using the standard
Windows selection method.

Checked Variables
This option exports those variables listed in the library comparison that have been selected using the checkbox
selection method. Note that option is available only if one or more variables are checked in the variables list of
the library comparison window.

626

Chapter 16 Libraries

The Export Variables dialog box is displayed which prompts you for either a new or existing workspace to export
the variables to. The Export Variables dialog box appears similar to the following:

When you click OK the workspace you have selected is loaded and the export process performed.
If an exported variable already exists in the target workspace then you will be prompted to confirm the changes. For
more information see the "Exporting variables" section in the "Import and Export" chapter of this manual.
The Import button in the Library Comparison window allows you to import variables from the comparison library
into the current library. This facility is particularly useful if you wish to update a library with changes that someone
else has made to a library in another workspace.
To import the new or changed variables that you want to include in the current library select them in the Library
Comparison window and click Import. From the menu choose the type of variables you wish to import.

You can either import into the current library all the variables listed in the comparison window that are different or
do not exist in the current workspace or import only those that have been selected in the comparison window.
When you click OK the Import of Variables dialog box is displayed which allows you to select a number of import
options. The Import of Variables dialog box appears similar to the following:

Exporting and importing from within a library comparison

627

From the Import of Variables dialog box you can choose to:
n

Replace, retain or review existing workspace level properties

Replace any actuarial documentation associated with the imported variables

Replace, append or inhibit the import of any definitions associated with the imported variables. You can also
manually select the definitions to be imported for selected variables by selecting the Manually select
definitions option.

For more information on the import process see The import process section in the "Import and export" chapter of this
manual.

628

Chapter 16 Welcome to Library Shield

Welcome to Library Shield

Library Shield is an application that searches for and identifies those libraries used in a workspace have a valid
licence. HASP licensing software, included with the Prophet installation, informs Prophet of what individual libraries
are licensed for use on the current machine.
In particular, Library Shield allows you to:
n

Upgrade and identify pre-release 8.0 libraries so that they can be used with Prophet 8.0 and later.

Inspect the licensing requirements of a workspace's libraries and warn of any unlicensed libraries before trying,
and failing, to use them in Prophet.

Library Shield manages the licensing of Prophet libraries so that they can be used with Prophet 8. In particular,
Library Shield allows you to:
n

Inspect the licensing requirements of libraries on your PC that you own.

Upgrade and license pre-release 8.0 libraries so that they can be used with Prophet 8.0 and later.

Identify any unlicensed libraries.

Each of these aspects is further described in the following sections.

Using Library Shield

629

Using Library Shield


After identifying and checking the workspace the Library Shield dialog box appears similar to the following:

The workspace analysed is displayed in the Workspace box with the libraries used by the workspace listed by
name below. The number of indicators and variables, HASP ID and licensing status is also shown.
When Library Shield is called automatically from Prophet, the workspace location entry is locked and Library Shield
starts scanning the workspace immediately. When it is finished and the user closes the application, Prophet
automatically reopens the workspace.

Launching Library Shield manually


You can launch Library Shield manually from Prophet.
To launch Library Shield:
1. In Prophet, on the Utilities tab click Licensing and run Library Shield against an arbitrary workspace. The
Library Shield dialog box appears.

630

Chapter 16 Welcome to Library Shield

2. To check that you have the appropriate library licences for a workspace, in the Workspace box enter the name
and location of the workspace, then click Scan.
The HASP ID is the content-based identifier for the library and is stored in the workspace - it is this that Library
Shield is primarily concerned with. Thus you do not need to run Library Shield repeatedly against the same
workspace, for example for every computer or user that might use the library.
The HASP ID description is shown in the Identified As column.
Note: If you need to contact the Prophet Helpdesk with any licensing problems or queries, make a note of the
values in both the HASP_IDand Identified As columns.
The Licensed column states whether the HASP ID is licensed/available on the current computer. Thus the
Licensed column may vary by computer if the HASP licence varies for different computers.
If a library is not recognised by Library Shield then it is classed as Unidentified and given a HASP Id of 999. The
licence status will state N/A (i.e. Not Applicable) and you will be able to use the library in Prophet 8.0 and later.

Licensing pre-release 8.0 workspaces

631

Licensing pre-release 8.0 workspaces


When you open a pre-Release 8.0 workspace for the first time in Prophet Professional Release 8.0 or later, it is first
upgraded. Library Shield then runs immediately after the upgrade and inspects the workspace to identify the
libraries used in it. Until the libraries used in the workspace are identified as being licensed, they are considered to
be protected and hence unusable in Prophet Professional.

Library recognition
If a library for which you do not have an appropriate licence is recognised and identified by Library Shield, then it
will not be available for use with Prophet 8.0 or later. If a library is not recognised by Library Shield then it is classed
as Unidentified and given a special HASP ID of 999 - you will then be able to use it in Prophet.
A classification of Unidentifiedoccurs for libraries created solely by customers, although there are some libraries
provided by SunGard that do not require a licence and are thus intentionally not detected by Library Shield. If a
protected SunGard library is customised by a customer, a licence is still required for the original library.
If a SunGard library is classed as Unidentified by mistake, then this does not imply that the library can be legally
distributed to other clients or used by the customer without a licence - a customer is still bound by their contract(s)
with SunGard. If any libraries are misidentified or if you wish to obtain a valid licence for your workspace, please
contact the Prophet Helpdesk.

632

Chapter 16 Welcome to Library Shield

An introduction to licensing
A HASP licence is a list of Prophet features and library IDs that you are entitled to use. You may only use a
particular feature or library if its ID is available for use on the computer running Prophet.
A HASP licence may be stored and locked to a particular machine or stored on a central licence server and
accessed remotely by individual client computers running Prophet. In the latter case there is a limit on the number
of concurrent users of a particular feature or library in accordance with your contract. Prophet and the HASP
software automatically handles the checking in and out of IDs, but laptop users may want to detach a licence
manually if they know they will be away from the corporate network when working with Prophet.
If a licence ID for a library is not found then you will not be able to do the following:
n

Open the library or any of its products.

Run any products of an unlicensed library or any structures using such products.

Compare or import, to or from, an unlicensed library or product.

However, you will still be able to open the workspace and use any libraries, and associated products, that are
licensed. Unlicensed content for pre-existing workspaces will not be deleted - thus the client may contact the
Prophet Helpdesk to resolve any licensing issues without loss of work. However any new standard workspaces
created in Prophet 8.0 and later will only have licensed libraries in them.

633

C H A P T E R

1 7

Actuarial documentation

TOPICS IN THIS CHAPTER


What is actuarial documentation?

634

Using actuarial documentation

635

Managing actuarial documentation

642

Comparing actuarial documentation

650

Printing actuarial documentation

653

Exporting actuarial documentation

658

Importing actuarial documentation

659

634

Chapter 17 Actuarial documentation

What is actuarial documentation?


Actuarial documentation allows you to document any object in a Prophet workspace by assigning to that object an
actuarial documentation topic. Each topic can contain text, graphics and embedded objects such as Microsoft Word
documents and Microsoft Excel spreadsheets that describe the object.
Actuarial documentation topics are stored as Rich Text Format (RTF) objects in the Prophet workspace file. You can
export or print selected topics as required. You can also compare actuarial documentation between different
workspaces.
The actuarial documentation for an object effectively becomes part of that object. Therefore if you copy an object the
actuarial documentation for it is also copied. If you delete an object then its actuarial documentation is also deleted.
The standard libraries are supplied with actuarial documentation. When you create a new workspace based on the
standard workspace a copy of the standard actuarial documentation is also made. It is this copy that you can edit
and view.
All topics are created and managed using the actuarial documentation window which operates in one of two
modes:
n

View mode

Edit mode

View mode allows you to display the actuarial documentation topic for any object in the current open workspace.
Edit mode allows you to create and edit topics for selected Prophet workspace objects.
In addition to the actuarial documentation window, a context actuarial documentation pane is available. This is a
separate pane that displays the appropriate actuarial documentation for each workspace object as it is selected.

Using actuarial documentation

635

Using actuarial documentation


Actuarial documentation is displayed in one of the following ways:
n

Using the actuarial documentation window


This displays all the actuarial documentation that is available in the current open workspace. The window is
displayed when you click Global Actuarial Documentation from the Support tab.

Using the context actuarial documentation pane


This is located at the bottom of the work area and displays actuarial documentation linked to an object selected
in the main window. To open the pane click Context Actuarial Documentation from the Support tab or press
the shortcut key Ctrl+Shift+A..

Actuarial documentation window


This window has an outline that is used to navigate and select Prophet objects and display their associated
actuarial documentation. You can also compare documentation in the current workspace with another workspace,
locate topics and text in the current workspace and display a historical list of previously viewed topics. You can also
click Edit in the pane to add and edit the actuarial documentation for a selected object
Context Actuarial Documentation pane
When this pane is opened it displays the corresponding actuarial documentation relating to Prophet objects
selected in the workspace. You can also print any topic displayed in this pane.

636

Chapter 17 Actuarial documentation

Using the actuarial documentation window


To display actuarial documentation for any object in the open workspace click Global Actuarial Documentation
from the Support tab. The actuarial documentation window is then displayed.

The Actuarial Documentation window has two panes:


n

An outline pane displays the objects in the workspace for which topics can be created and displayed

A window pane displays the topic for the object selected in the outline pane.

Selecting objects in the outline pane displays the associated topic. Click a plus sign to expand a section of the
outline or a minus sign to contract it.

Using actuarial documentation

637

Note: If you change the indicator code for an indicator the position of the indicator in the hierarchy will change
but its actuarial documentation remains unaltered. Similarly for variables.

Features
Topics can have "sections" that enable large blocks of text to be split into manageable chunks.
In addition, topics can also contain links to other topics. When you view a topic that has links to other topics you can
click See Also to display the list of linked topics that can be selected and displayed.

Operating modes
The Actuarial Documentation window operates in one of two modes:
n

View mode

Edit mode

View mode is the default mode of operation when the Actuarial Documentation window is first opened. To enter or
update actuarial documentation click Edit in the local toolbar to place the Actuarial Documentation window into Edit
mode. You can then:
n

Display and edit text in the topic for any object in the open workspace

Format text and spell check it

Embed pictures and other objects such as a Microsoft Word document

Add, edit or delete links to other topics

Add, edit or delete "sections" in the topic

To return to View mode when in Edit mode, click OK to save any changes you have made or Cancel to discard
them.

638

Chapter 17 Actuarial documentation

Navigating actuarial documentation in View mode


When you are in View mode in the actuarial documentation window you can navigate the actuarial documentation
in any of the following ways:
n

Using the outline view pane

Clicking See Also and Sections

Using the Navigation Bar

The Navigation Bar is displayed at the top of the Actuarial Documentation window when in View mode. It appears
as follows:

The buttons on the Navigation Bar do the following:


Click

To
Display a list of all the topics linked to the current topic from which you can
select and display a linked topic.
Display a list of all the sections in the current topic from which you can select,
open and display a section
Switch to Edit mode
Compare the existing topics with those in another workspace
Move to the previous object in the outline

Move to the next object in the outline

Using actuarial documentation

Click

639

To
Move to the previous topic viewed
Move to previously viewed documentation
Print the current topic or all topics

Displaying previously viewed documentation


A list of all list recently viewed topics can be displayed when you are in View mode by clicking History from the
actuarial documentation toolbar. It appears similar to the following:

The list is updated every time you view a topic, with the most recently viewed topic at the top of the list. To display a
recently viewed topic select the topic from the list and click OK. Alternatively, double click the topic.

640

Chapter 17 Actuarial documentation

Using the context actuarial documentation pane


The context actuarial documentation pane displays the actuarial documentation topic for the currently selected
object in the workspace. As you select different objects in the workspace the displayed topic information changes
accordingly. If no topic exists for the current object the pane will display the topic for the first object which is higher
up in the object hierarchy for which a topic does exist.
To display actuarial documentation in the context actuarial documentation pane click Context Actuarial
Documentation from the Support tab. Alternatively press the shortcut key Ctrl+Shift+A
The pane appears similar to the following:

The toolbar at the top of the context actuarial documentation pane provides a number of options.

The options on the toolbar allow you to perform the following:

Using actuarial documentation

Click this
button

641

To do this:
Print or preview the currently displayed topic

Display the top level topic for the workspace

Display the previous topic in the object hierarchy

Display the next topic in the object hierarchy. This button is unavailable if the
current displayed topic is for the last object in the hierarchy.
Display the last topic in the object hierarchy. This button is unavailable if the
current displayed topic is for the last object in the hierarchy.
Closes the context pane and opens the Actuarial Documentation window

Display a list of all the topics linked to the current topic from which you can
select and display a linked topic
Display a list of all the sections in the current topic from which you can select,
open and display a section
To prevent the context pane from updating the topics as objects are selected select Disable Update. This option
can be useful when the displayed topic refers to more than one object.
Topics cannot be edited in the context pane.

642

Chapter 17 Actuarial documentation

Managing actuarial documentation


All actuarial documentation is created and managed from the actuarial documentation window when in Edit mode.
In this mode you can select an object from the actuarial documentation outline and do any of the following to its
related topic:
n

Add, delete or supplement the standard supplied topic

Embed or remove objects created using other applications

Add, update and delete sections in the current topic

Add, edit and delete See Also links from the current topic to other topics

Note that you can also compare the current documentation with the documentation in another workspace or with
the standard documentation. You can then replace the current documentation with the compared documentation.
This is performed in View mode by clicking Compare in the local toolbar of the Actuarial Documentation window.

How actuarial documentation is structured


Most objects in a workspace have an associated actuarial documentation topic. The name of a topic is also the
same as the name of the object to which the topic belongs.

Sections
Information in a topic can be divided into sections which can be used to break up large amounts of information into
manageable chunks. Each section has a heading which you define below which the related information can be
hidden or shown by collapsing or expanding the selected section.
Whenever a topic that contains sections is displayed for the first time all of its sections are closed. To open or
expand a section to display its information click the section heading. To close or collapse an open section, click the
section heading again.

Embedded objects
In addition to sections you can also embed document and graphic objects from applications that support OLE. Such
applications include Microsoft Word, Excel and Access. If you have the appropriate application installed on your

Managing actuarial documentation

643

computer you can open and display the embedded object by double clicking the object. Using embedded objects in
this manner can help you document workspace objects using existing documentation stored in other file formats.
Objects are embedded into a topic using the Insert Object dialog box. This is accessed by clicking the Insert Object
button

from the local toolbar when the Actuarial Documentation window is in Edit mode.

Editing actuarial documentation in Edit mode


Actuarial documentation topics are managed in the Actuarial Documentation window when it is in Edit mode. The
exception is when actuarial documentation is compared between workspaces. This is done in View mode.
To edit a topic for a selected object you select the object in the Actuarial Documentation outline and click Edit in the
local toolbar. You can then add and update the documentation using the text formatting options from the local
toolbar.
After making changes click OK to switch back to View mode. Any changes you have made to the topic are saved in
the workspace.

Edit options
Edit options for the selected topic are selected from the local toolbar of the Actuarial Documentation window:

The toolbar provides the following options:


Click

To:
Specify the topics linked to the current topic.
Add, remove or edit sections in the current topic

644

Chapter 17 Actuarial documentation

Click

To:
Save any changes to the actuarial documentation and switch to View mode
Cancel any changes to the actuarial documentation and switch to View mode
Apply a particular font from the drop down list
Set the size of the font
Apply bold formatting to the selected text

Apply italic formatting to the selected text

Apply underline formatting to the selected text

Left justify the selected paragraph

Centre the selected paragraph

Right justify the selected paragraph

In addition, a second toolbar is also provided in Edit mode as follows:

The buttons on this toolbar do the following:

Managing actuarial documentation

Click

To:
Apply bullets to the selected paragraphs.

Outdent the selected paragraph

Indent the selected paragraph

Sets the current colour to all selected or entered text. The line displayed in the button
displays the current selected colour.
Insert an OLE object such as a Microsoft Word document or an Excel spreadsheet

Check the spelling of the current topic

Incorporating sections in a topic


Sections are incorporated in an Actuarial Documentation topic using the Sections editor when the Actuarial
Documentation window is in Edit mode. To access the Sections editor click Edit in the Actuarial Documentation
window if it is in View mode, and click Sections. The Sections editor is then displayed. It appears similar to the
following:

645

646

Chapter 17 Actuarial documentation

The Sections editor displays a list of all the sections in the current topic. Using the Sections editor you can:
n

Insert a section

Delete one or more selected sections

Rename a selected section

Re-order the sections

Note the following:


n

When you move a section the information in that section is also moved

The section heading and the information contained in the section are both deleted when you delete a section in
the Sections editor

Managing actuarial documentation

647

Incorporating See Also links


Each topic in Actuarial Documentation can have links to information in other topics. These links, known as See Also
links, are listed in View mode when you click See Also on the Actuarial Documentation Navigation Bar. The list
appears similar to the following:

To display a topic listed in the See Also list click the appropriate item.
You add and remove See Also links when you edit a topic in Edit mode by clicking SeeAlso. The See Also
Selection for dialog box is then displayed from which you add and remove the links for the current topic:

Adding hyperlinks to an external file


Apart from entering text you can also add hyperlinks to external files such as Microsoft Word documents and Excel
spreadsheets. To add a hyperlink to the Actuarial documentation simply type the link in using the standard syntax.
To add a hyperlink into an actuarial documentation topic open the Actuarial Documentation window by clicking
Global Actuarial Documentation from the Support tab. Locate and select the workspace object using the
workspace object outline and click Edit when the topic for the selected object is displayed.
Then type in the hyperlink using the following syntax:
n

Links to intranet
The link should start with http://
For example http://ukintranet/intranet/intranet.nsf

Links to website
The link should start with www.
For example www.prophet-web.com

648

Chapter 17 Actuarial documentation

Links to network or locally stored files


These links should start with either file:// or \\
For example file://C:/temp/text.txt or using UNC pathnames \\uk33415\temp\text.txt
Note: If you are setting up the hyperlinks to use UNC pathnames, you should ensure that the path which is used
should be shared out. This is not normally a problem for Network locations.

Locating topics and text


When the Actuarial Documentation window is open you can search all of the actuarial documentation in the current
workspace for a topic heading or textual item.
To search the actuarial documentation first make sure that the Actuarial Documentation window is open. Then from
the Home tab click Find or use the shortcut Ctrl+F. The Search Actuarial Documentation dialog box is then
displayed.

The dialog box has two tabs:


n

Topic tab
Lists all topic headings in the actuarial documentation for the current workspace. You locate the appropriate
topic by typing in a complete or partial topic name in the text box at the top of the displayed list.

Managing actuarial documentation

649

Textual tab
Lists the results of a search on the text in the actuarial documentation topics based on complete or partial words
entered in the text box. To search for words with the same case select Match Case. To search for whole words
only select Whole Word. To start a textual search click Start.

In both cases the results of a search are listed in the selected tab by topic name, type and library. You can sort the
search results by clicking the appropriate column header. To display a listed topic select the topic in the list and
either click GoTo or double click the selected item.
To close the Search Actuarial Documentation dialog box click Close.
Note the following:
n

You can search actuarial documentation in either Edit or View modes.

The dialog box remains open and floats over all other windows until you close it. This allows you to view more
than one topic without having to perform a new search.

The search dialog box lists those topics that contain one or more instances of the text you have entered.

Only one type of search can be performed at a time.

You can resize the dialog box.

650

Chapter 17 Actuarial documentation

Comparing actuarial documentation


The compare option in Actuarial Documentation allows you to compare and replace the actuarial documentation for
the same objects in different workspaces. This can be useful when you need to locate and copy updated
documentation between workspaces.
Compare for Actuarial Documentation differs from that for products and libraries in that it does not identify the
differences between two sets of actuarial documentation. Instead it displays the actuarial documentation from the
two workspaces side by side for the objects that exist in the current workspace. To compare and display the
differences between two sets of actuarial documentation you should export them to Rich Text Format and then use
the Revision facility in Microsoft Word.
Note: To copy actuarial documentation between workspaces for an entire library use the Import option
To compare actuarial documentation in your current workspace with that in another workspace open the Actuarial
Documentation pane by clicking Global Actuarial Documentation from the Support tab and from the Actuarial
Documentation pane click Compare. The Select Workspace dialog box is displayed. It appears similar to the
following:

In the Select Workspace dialog box enter the name of the workspace with which you wish to compare the current
actuarial documentation. You can either select the standard workspace or a specified workspace. If you choose to
select a specified workspace, either enter the name and location of the workspace file or click Browse.
When you have entered the name and location of the workspace file, click OK to begin the comparison of the
actuarial documentation.

Comparing actuarial documentation

651

The compare process


During the comparison, Prophet opens the selected workspace, locates the actuarial documentation and compares
it with the documentation in the current open workspace. When the operation is complete the Actuarial
Documentation comparison window is displayed.
Three panes are displayed when an actuarial documentation compare is displayed:

The left pane displays the outline of the objects in the current open workspace

The middle pane displays the topic for the currently selected object in the current open workspace

The right pane displays the corresponding topic in the workspace being compared with

As you select different objects in the outline the middle and right panes display the associated topics contained in
the current and compared workspaces respectively.

652

Chapter 17 Actuarial documentation

Replacing topic contents


You can replace the information contained in the currently displayed topic with the corresponding topic in the
workspace being compared with by clicking Replace from the local toolbar. Use this option with care as the existing
topic for the current object is overwritten with the topic in the workspace being compared with. There is no undo
option.
To return to View mode click Exit Compare.

Printing actuarial documentation

653

Printing actuarial documentation


You can print actuarial documentation in one of two ways depending on the method used to view the
documentation:
n

When editing or viewing actuarial documentation in the Actuarial Documentation pane you can print all or
selected topics with or without sub-topics.

From the actuarial documentation panel you can print the current topic only with just the sections that are
currently open or with all the sections.

When Prophet prints the actuarial documentation it is first saved as a Rich Text Format file in the workspace
location. The name of this file is ~ADocn.RTF where n is a number automatically allocated by Prophet.
Either the Windows application registered to open .RTF files or WordPad is then invoked and is used to display or
print the generated file. Usually the registered application is a word processor such as Microsoft Word.
Note: When you installed Prophet the file association for .RTF files would have been set to be the same as for
.RTF files, which is the standard extension for Rich Text Format files. If no such association existed you will be
prompted to select an application to load .RTF files the first time you print actuarial documentation. If you want to
change the association use the File Types tab in the Options dialog box which appears when you select
Options in the View menu in Windows Explorer.
Prophet automatically deletes existing files with names of the form ~ADoc*.RTF whenever actuarial documentation
is printed. If you wish to save a printed copy then use the Preview option and save the file displayed under a
different name.

Actuarial documentation print setup


You can specify either the registered .RTF application or Windows WordPad to print and preview actuarial
documentation by selecting the appropriate option from the Actuarial Documentation Print Setup dialog box.
The dialog box is accessed in one of the following ways:

654

Chapter 17 Actuarial documentation

On the local Actuarial Documentation toolbar click Print and from the Print Actuarial Documentation dialog
box click Print Setup, OR

On the local Actuarial Documentation toolbar click RTF Export and from the Export Actuarial Documentation
Print Setup dialog box click Print Setup.

In either case the dialog box appears similar to the following:

To preview and print actuarial documentation using the registered .RTF application click Rich Text Format
Association (*.RTF), or click WordPad.
When you click OK Prophet saves the selected option.

Specifying a printer
The default printer specified in the application registered to manage .RTF files is used to print actuarial
documentation. If you wish to use an alternate printer then start the registered application and set up the new
printer. Then leave the application open.
When the actuarial documentation is printed from Prophet the generated .RTF file will be loaded into the registered
application. The printer which has been specified will be used to print the file.

Printing actuarial documentation

655

Printing an embedded object


To print an object displayed in a topic as an icon you must open the object by double clicking on its icon and then
use its application to print it. If you print a topic using the standard actuarial documentation print option then only the
embedded object icon will be printed as part of the documentation.
Note: You must ensure that you have the appropriate application installed on your PC to enable you to display,
edit and print an embedded object.

Printing from the actuarial documentation window


To print one or all topics displayed in the actuarial documentation window click Print from the local toolbar. The
Print Actuarial Documentation dialog box is displayed and appears similar to the following:

From the Print Actuarial Documentation dialog box you can:


n

Print the topic selected in the object outline, with or without any sub-topics.

Print all the topics in the workspace

To print the currently displayed topic together with its sub-topics select Include all sub-topics. Sub-topics are topics
that are lower down in the object hierarchy as displayed in the Actuarial Documentation outline.

656

Chapter 17 Actuarial documentation

To specify the application to be used to preview and print the actuarial documentation click Print Setup. To preview
the actuarial documentation in this application click Preview. To print the actuarial documentation click OK.
Note: Printing all the topics in a workspace can take a considerable amount of time depending upon the
number of topics and the speed of your PC. In addition the size of the generated .RTF file can be considerable
and may take some time to load into the application you have selected.

Printing actuarial documentation

657

Printing from the context actuarial documentation pane


To print the current topic from the context actuarial documentation pane click

in the local toolbar. The Print

Topic dialog box is then displayed:

From this dialog box you:


n

Select Open Sections to print the current topic with just the open sections included, that is as it is currently
displayed.

Select All Sections to print the current topic with all sections included, that is as it would be displayed if you
opened all the sections.

To specify the application to be used to preview and print the actuarial documentation click Print Setup. To preview
the actuarial documentation in this application click Preview. To print the actuarial documentation click OK.
Note: The Print Topic dialog box is not displayed if actuarial documentation for the selected topic is not
available.

658

Chapter 17 Actuarial documentation

Exporting actuarial documentation


Actuarial documentation can be exported as a Rich Text Format file and then imported into any word processor that
supports the Rich Text file format. You can select to export all or selected topics with or without any sub-topics.
To export actuarial documentation topics, ensure that the Actuarial Documentation window is open. If not, then from
the Support tab click Global Actuarial Documentation. If you want to export a particular topic then select that topic
then choose the RTF Export option from the local toolbar. The Export Actuarial Documentation to RTF File dialog
box appears as follows:

You can choose to export documentation for the currently selected topic or all topics in the workspace.
You can specify that all the sub-topics of the selected topic should be exported and that the exported file should be
loaded into the appropriate RTF editor after it has been created.
You can also specify the application to be used to open the exported actuarial documentation after it has been
exported by clicking Print Setup and choosing the application from the Actuarial Documentation Print Setup dialog
box.
In the Export File box type the file name and location for the exported actuarial documentation. By default the file to
which the documentation is exported has a .RTF extension.
When ready click OK to begin the export process.

Importing actuarial documentation

659

Importing actuarial documentation


Actuarial documentation can be imported into an existing workspace on a library by library basis. This differs from
importing actuarial documentation within an actuarial documentation comparison which is carried out at a topic
level.
To import actuarial documentation from another workspace:
n

Close all open panes in the workspace by clicking Close All from the Home tab.

From the Utilities tab click Import and choose Actuarial Documentation (Libraries). The Import Library based
Actuarial Documentation dialog box is then displayed. It appears similar to the following:

Select the workspace file from the drop down list or click Browse to locate it.

When you click OK, the libraries contained in the selected workspace are displayed in the Import Library based
Actuarial Documentation dialog box from which you can select the library or libraries from which you wish to import
the actuarial documentation.
the Import Library based Actuarial Documentation dialog box appears similar to the following:

660

Chapter 17 Actuarial documentation

From this dialog box you can select the libraries from which you wish to import actuarial documentation for all the
objects that are contained in both the libraries. Two lists are displayed:
n

Available Library based Actuarial Documentation

Selected Library based Actuarial Documentation

Select the library or libraries in the Available list and transfer them to the Selected list using the arrow buttons.
Alternatively, you can select one or more libraries in one list and drag them to the other list.
Click OK to start the import of the selected library based actuarial documentation.
All the actuarial documentation in the source libraries for the objects which exist in the libraries in both workspaces
will then be imported into the current workspace and overwrite any existing actuarial documentation.

661

C H A P T E R

1 8

Import and export

TOPICS IN THIS CHAPTER


What can be imported and exported?

662

Importing Prophet objects

664

Exporting Prophet objects

673

662

Chapter 18 Import and export

What can be imported and exported?


The main objects stored in a workspace file can be imported or exported between Prophet workspaces. In addition,
the objects stored within libraries can be imported or exported between libraries, which can be in the same or
different workspaces. The objects that can be handled in this way are:

Between workspaces
n

Accumulations

Enumerations

Libraries

Products

Structures

Run settings

Actuarial documentation (can only be imported)

Dimensions (can only be imported)

Formula block documentation (can only be imported)

Table Details (can only be imported)

Variable Groups (can only be imported)

You can use the Import Library option to add a Standard library to your workspace.

Between libraries in the same or different workspaces


n

Grouping calculations

Grouping rules

Indicators

What can be imported and exported?

Indicator categories

Variables

Variable categories

663

664

Chapter 18 Import and export

Importing Prophet objects


You can import one or more of the following objects from another workspace:
n

Libraries

Products

Accumulations

Structures

Run Settings

In addition, you can import variables, variable categories, indicators, indicator categories, grouping rules and
grouping calculations from another library in the current workspace or in a different workspace.
You can also import actuarial documentation, formula block documentation, table details.the dimensions used by
array variables and the variable groups from another workspace.
You can only import objects of a single type in a single process.
You should back up your workspace before you start an import process. This is particularly important if you propose
to import a significant number of objects.
In general, you need to close any open Prophet objects such as products, structures and run settings before you
import new objects from another workspace. If you wish to import objects such as variables, variable categories and
indicators into an existing library you should choose the Libraries pane, select the library and from the right click
menu choose the appropriate Import option.

Importing Prophet objects

665

Importing objects not in a library


For an import of objects other than objects within a library, an Import dialog box appears similar to the following:

Select the workspace file from the drop down list or click Browse to locate it.
To import a Standard library, locate Prophet.prw in the STD_80 folder which is generally located in.C:\Documents
and Settings\All Users\Application Data\SunGard\Prophet80\STD_80.

Importing objects within a library


For an import of objects within a library, an Import dialog box appears similar to the following:

666

Chapter 18 Import and export

If you choose a different library in the current workspace you are prompted to select the source library. If you choose
a library in a different workspace, select the workspace file from the drop down list or click Browse to locate it. You
are then prompted to select the source library.
Note the following:
n

The name of the source workspace is always Prophet.prw.

If the language setting of the source workspace is not the same as that of the current workspace then the
Language Mismatch dialog box appears. If you continue with the import then the descriptions and actuarial
documentation in the source workspace language will overwrite those in the current workspace. For more
information see "Working with workspaces with different language settings".

Selecting objects to import


When you click OK on an Import dialog box you can choose the objects to import from a further Import dialog box.
For instance, if you have selected to import products, an Import Products dialog box appears similar to the following:

Importing Prophet objects

667

Select the object or objects to be imported in the Available list and transfer them to the Selected list using the arrow
buttons. Alternatively, you can select one or more objects in one list and drag them to the other list.
If you have selected to import actuarial documentation the dialog box will list the libraries in the source workspace.
For the libraries that you select all the actuarial documentation topics in those libraries will be imported provided the
objects to which they are linked exist in the current library. If you want to import actuarial documentation which is not
related to libraries or just particular topics you should use the Compare option in the Actuarial Documentation
window (see the "Actuarial Documentation" chapter in this manual).
Click OK to start the import of the selected objects.

The import process


During the import process an analysis is performed on the objects that are imported and their relation and links to
other objects. It then imports not only the selected objects but also the properties for any other objects that are
required to maintain the integrity of the current workspace
For example, if you import a product that uses variables and indicators that are not present in the library associated
with the product, then not only the properties for the selected product and the definitions of its input variables are
imported but also the properties for any missing input variables and any missing indicators.
Likewise, if you import an accumulation or structure then the products and accumulations listed within it are also
imported. For each product it imports all the objects listed in the previous paragraph.

668

Chapter 18 Import and export

If you import a library, all the objects within it are imported.


When you import an object its actuarial documentation topic is normally imported at the same time. The only
exception to this is when you are importing libraries or variables. For these objects you have the option of retaining
the existing documentation for objects that already exist.
Note the following:
n

If the language setting of the source workspace is not the same as that of the current workspace then, if you
proceed with the import, the descriptions and actuarial documentation in the source workspace will overwrite
those in the current workspace.

The grouping rules and grouping calculations used by a product are not imported if the product is imported.
However, the names of the grouping rules and grouping calculations for the product are imported if the grouping
rules and grouping calculations exist in the corresponding library. If they don't the names are blanked out.

Importing Prophet objects

669

Resolving import conflicts


Some of the export conflicts that can arise are:
n

Importing objects other than variables

Importing variables

Details of these conflicts are described in the following sections.

Importing objects other than variables


If an imported object other than a variable already exists in the workspace you will be prompted with an Object
Already Exists dialog box. For an indicator object it appears similar to the following:

For all object types you can then choose whether to replace the object or retain it. In addition for libraries you can
also elect to merge all the objects, such as variables, in the two libraries.
For objects other than libraries, you can also specify whether in all subsequent conflicts the action should apply to
just this object, to all objects of the same type or to all objects of any type.

Resolving import conflicts for variables and libraries


If you choose to replace or merge an imported variable with one that exists in the workspace or library then you will
be prompted with the Import of Variables dialog box if you import a variable or Import of Library dialog box if you
import a library. The dialog boxes for both types of import have similar options. For example, the import of a variable
appears similar to the following:

670

Chapter 18 Import and export

You can make selections and choices from items in the following sections:

Workspace Level Data


Options in this section allow you to replace, retain or review the workspace level properties of the variable that are
specified in the Workspace Level Properties section of the Variable Properties dialog box.
If you choose to review any workspace level property differences that exist between the existing and imported
variable then the Variable Properties Conflict at Workspace Level dialog box is displayed whenever a difference is
encountered between the existing and imported variable.

Replace Actuarial Documentation


The option in this section allows you to replace documentation relating to an existing variable with that relating to
the imported variable. If no documentation exists with the imported variable then the documentation relating to the
existing workspace variable is kept intact

Importing Prophet objects

671

Library Variable Definitions


You can choose from a number of options:
n

Replace all existing definitions


Choose this option if you wish to replace all the definitions associated with an existing variable with those from
the imported variable.

Append new definitions


If you wish to add the definitions associated with the imported variable to those associated with an existing
variable then choose this option.

Do not import definitions


If you do not wish to import any definitions from the imported variable then choose this option.

Manually select definitions


This option is only available if you import a variable. It is unavailable when you import variables from a library.
Choosing this option displays the Import Variable Definitions dialog box during the import process which allows
you to select those definitions in the imported variable that you wish to add to an existing variable.

When you click OK the import process continues depending on the options that you have selected. Alternatively,
click Cancel to terminate the import process.
If you select to Review any differences in workspace level properties and any differences are found you will be
prompted with a Variables Properties Conflict dialog

672

Chapter 18 Import and export

You can choose the action to be taken for this and future variable property conflicts.

Exporting Prophet objects

673

Exporting Prophet objects


You can export one or more of the following objects to a new or existing workspace:
n

Products

Accumulations

Structures

Run Settings

Libraries

To export one or more products you select them from the Products pane and from the Utilities tab click Export.
Similarly, you can export a structure selected from the Structures pane.
Likewise, you can open a library and select and export variables, variable categories, indicators, indicator
categories, grouping rules or grouping calculations to another workspace.
Note: If you want to export any of these objects to a different library in the same workspace, you should use the
Import option from the target library.
You can only export objects of a single type in a single process.
You should also back up the target workspace before you start an export process. This is particularly important if
you propose to export a significant number of objects.
To export an object you first need to close all open windows in the workspace by clicking Close All from the Home
tab. Then, when you have selected the objects to export, click Export from the Utilities tab.
The Export dialog box then appears similar to the following:

674

Chapter 18 Import and export

You can choose to export the selected objects into a new or existing workspace.
If you choose a new workspace, enter the location for that new workspace or click Browse to locate a suitable
existing folder.
If you choose an existing workspace file, select it from the drop down list or click Browse to locate it.
If you are exporting objects from within a library to a workspace where that library does not exist, a library with the
same name as in the same source workspace is created.
Click OK to start the export of the selected objects.
Note the following:
n

If the language setting of the source workspace from which the objects are exported is not the same as that of
the receiving workspace then the Language Mismatch dialog box appears. If you click Proceed then the
exported descriptions and actuarial documentation associated with the exported objects will overwrite those in
the receiving workspace.
For more information see "Working with workspaces with different language settings".

The target or receiving workspace file is always called Prophet.prw. You can only export to a closed workspace.

The export process


During the export process Prophet analyses the objects that are exported and their relation and links to other
objects. It then exports not only the selected object but also the properties for any other objects which are required

Exporting Prophet objects

675

to maintain the integrity of the target workspace.


For example, if you export a product to a new workspace, Prophet exports not only the properties for the selected
product but also the properties for the missing library, the definitions of the input variables for the product, their
variable properties and the indicators used by the product. Such a workspace can be used for storage, for instance
to enable products to be compared against earlier versions.
Likewise, if you export an accumulation or structure to a new workspace, Prophet also exports the products and
accumulations listed within it.
If you export a library, all the objects within it are exported.
When you export an object its actuarial documentation topic is normally exported at the same time. The only
exception to this is when you are exporting libraries or variables. For these objects you have the option of retaining
the existing documentation for objects that already exist in the target workspace.
Note the following:
n

If the language setting of the source workspace from which the objects are exported is not the same as that of
the receiving workspace then any exported descriptions and actuarial documentation will overwrites those in
the receiving workspace.
For more information see "Working with workspaces with different language settings".

The grouping rules and grouping calculations used by a product are not exported if the product is exported.
However, the names of the grouping rules and grouping calculations for the product are exported if the grouping
rules and grouping calculations already exist in the corresponding library in the target workspace. If they do not,
then the names are blanked out.

Resolving export conflicts


Some of the export conflicts that can arise are:
n

Exporting objects other than variables

Exporting variables

676

Chapter 18 Import and export

Details of these conflicts are described in the following sections.

Exporting objects other than variables


If an exported object other than a variable already exists in the target workspace you will be prompted with an
Object Already Exists dialog box.

For all object types you can then choose whether to replace the object or retain it. In addition for libraries you can
also elect to merge all the objects, such as variables, in the two libraries.
You can also specify whether in all subsequent conflicts the action should apply to just this object, to all objects of
the same type or to all objects of any type.

Exporting variables
If an exported variable already exists in the target workspace you will be prompted with an Export of Variables
dialog box

Exporting Prophet objects

677

If you select Append new definitions, all of the variable definitions are exported and added to any that already exist
for the variable in the target library and workspace.
If you select to Review any differences in workspace level properties and any differences are found you will be
prompted with a Variables Properties Conflict dialog.

678

Chapter 18 Import and export

You can then choose the action to be taken for this and future variable property conflicts.

679

C H A P T E R

1 9

Workspace objects

TOPICS IN THIS CHAPTER


What are workspace objects?

680

Enumerations

681

Dimensions

686

Specifying variable groups and categories

689

680

Chapter 19 Workspace objects

What are workspace objects?


In addtion to the standard workspace objects such as products and libraries the following are accessed from the
Workspace Objects pane:
n

Enumerations

Dimensions

Variable Categories

In Prophet Release 8.1 and earlier these objects were accessed from the Options dialog of the Prophet menu.

Enumerations

Enumerations
An enumeration can be considered to be a data type that consists of a set or list of named values that represent
integral constants known as enumeration elements. Enumerations can be useful for variables that have a small
number of possible values.
Enumeration settings are created and managed from the Enumerations folder of the Workspace Objects pane:

Enumerations folder options


Selecting and right clicking the Enumerations folder displays the context menu from which you can:
n

Create a new enumeration

Group and sort the existing enumerations in the tree

Display a list of the existing enumerations in the main work area.

Enumeration context menu options


Selecting and right clicking an enumeration displays the context menu:

681

682

Chapter 19 Workspace objects

From the menu you can open, delete or export the selected enumeration and its associated elements.
List of Enumerations
Choosing the Show List of Enumerations from the right click context menu of the Enumerations folder displays the
existing enumerations in the tabbed pane of the work area:

From the window you can also open, delete or export a group or selected enumerations from the right-click menu.
When you create or open an enumeration the Enumeration dialog box is displayed:
The dialog box displays the name of the enumeration, its description and the associated elements or values.
Note: The name of an enumeration must be unique and also not contain spaces.
It can have any number of elements.
To create an enumeration

Enumerations

In the Workspace Objects pane, right click on the Enumerations folder and choose New enumeration.

The Enumeration dialog box appears similar to the following:

Enter the name and description for the enumeration in the Enumeration dialog box.

Add the elements for the enumeration by clicking Add and in the Enumeration element dialog box add the
details for the new element. Click OK to add the element.

Either create another enumeration element or click OK to save the enumeration.

Adding elements from a spreadsheet


Do the following to add a number of enumeration elements prepared as a list in a spreadsheet:
n

Open the spreadsheet and copy the list of enumeration elements and their descriptions if any.

Select and open the enumeration from the Enumeration folder of the Workspace Objects pane.

From the Enumeration dialog box click Paste to insert the copied elements from the spreadsheet.

The list of elements specified in the spreadsheet are added to the list of elements for the selected enumeration.

683

684

Chapter 19 Workspace objects

Editing and deleting enumerations


To edit an enumeration you select it in the Enumerations folder in the Workspace Objects pane and from the right
click menu choose the Open option. You can then edit the settings in the Enumeration dialog box.
To edit an enumeration element you select the element in the Enumeration dialog box and click Modify. The
element can then be edited from the Enumeration dialog box.
To delete an enumeration you select it from the Enumerations folder in the Workspace Objects pane and from the
right click menu choose the Delete option.
To delete an enumeration element you select the element in the Enumeration dialog box and click Delete.
To re-order enumeration elements select one or more elements and click the Up or Down arrow button to move
the selected element(s) up or down the list. There is generally a logical order for enumerations, for example in days
of the week, Sunday is normally index value 0, Monday 1, and so on.
To export an enumeration you select it from the Enumerations folder in the Workspace Objects pane and from the
right-click menu choose the Export option. From the Export Enumerations dialog box you can export the selected
enumeration to either a new workspace location or to an existing workspace.
Note the following:
n

Deleting an enumeration and its associated elements must be done with care as it can cause actuarial code that
uses the enumeration to fail.

Enumerations are workspace objects and are listed in the Workspace Objects tree view of the object browser
alongside other workspace objects.

Enumerations can be imported between workspaces.

The following enumeration functions are available:

INT_TO_ENUM.

ENUM_SIZE

ENUM_TO_INT

Enumerations

ENUM_TO_TEXT

TEXT_TO_ENUM

685

Enumeration element dialog box


Enumeration elements are listed in the Enumeration dialog box. The details of an elements are specified in the
Enumeration Element dialog box which is displayed when you click Add or Modify in the Enumeration dialog box.
The Enumeration Element dialog box appears similar to the following:

From the dialog box you specify the name of the enumeration element and attach a description.
When you click OK the enumeration element is listed alongside the other elements in the Enumerations setting.
Note the following:
n

The name of the enumeration element can be up to 36 characters in length. It cannot contain spaces.

To add a number of enumeration elements you can prepare them in a spreadsheet and copy and paste them
into the enumeration elements list using the Paste option from the right click menu in the Enumeration Element
list of the Enumeration dialog box..

686

Chapter 19 Workspace objects

Dimensions
The dimensions used by array variables are specified and managed from the Dimensions folder of the Workspace
Objects pane:

From the right-click menu you can create, edit, delete or duplicate a dimension. Choosing the Show List of
Dimensions displays the dimensions in the tabbed window:

The array dimensions that are specified in the workspace are listed in the Dimensions tab by name, description,
size, and by Modified and Created dates.

Dimensions

687

In addition, whenever you import a library that contains array variables that use dimensions that do not exist in the
workspace then they are also automatically added to the list of dimensions.
You edit an existing dimension by selecting it in the Dimensions folder of the Workspace Objects pane and from the
right-click menu choosing the Open option.
. Choosing New Dimension or select an existing dimension from the list of dimensions and click Open.
Note the following:
n

At least one dimension must exist before an array variable can be specified.

If you attempt to delete a dimension that is used by an array variable in a library or product then a list of the
variables that use the dimension is displayed. You will not be able to delete the dimension until it is removed
from the variable(s) that use it. The dimensions used by a variable are managed in the Workspace level
properties section of the Variable properties dialog box. For details see Variable properties dialog box on
page577.

Array dimensions remain in the list even if the products or libraries that used the dimensions have been deleted
or removed.

You can also import dimensions from another workspace by choosing Dimensions from the Import menu of the
Utilities tab.

Dimension description dialog box


Instead of displaying numbers for dimensions when viewing array variable results you can apply descriptions in this
dialog box. The descriptions are then displayed instead of the numbers.
To add descriptions to the dimensions of an array variable:
n

Locate and expand the Dimensions folder in the Workspace Objects pane and then do ONE of the following:

For an existing dimension: select a dimension in the Dimensions folder and from the right-click menu choose
the Open option.

688

Chapter 19 Workspace objects

For a new dimension: select the Dimensions folder in the Workspace Objects pane and from the right-click
menu choose New Dimension

In either case, the Dimension dialog box appears.

From the Dimension dialog box click Descriptions.to display the Description dialog box:

You enter a description for each element by double clicking the Description text box.
When you click OK the new or updated dimension is listed with the other dimensions in the Dimensions tab in the
main workspace area..
Note that the descriptions that you enter can be displayed in place of the dimension entry number when you display
results. To display the descriptions in results, select a column in the results and from the right click menu choose
Names/Descriptions . In the Display of Names and Descriptions dialog box select "Show Array Variables Index
Descriptions".

Specifying variable groups and categories

689

Specifying variable groups and categories


Variable groups are mainly used for reporting purposes and provide a convenient way to produce lists of
associated variables. For example, all the variables which together form a revenue account can be included in a
single variable group.
You specify variable groups and their categories using the Variable Groups dialog.
To display the Variables Groups settings:
n

Click the Prophet button and from the Prophet menu click Options

From the Options dialog choose the Variable Groups setting which appears similar to the following:

You can open, create, edit, delete and duplicate both:


n

Variable Groups, and

Variable Group Categories

Each Variable Group is assigned a unique 3 character code, the first letter of which defines the Variable Group
Category to which the Variable Group belongs.

690

Chapter 19 Workspace objects

For example, in the standard Conventional library the "Discounted Revenue Account" variable group has a variable
group code of A40 and therefore belongs to the "Revenue Accounts - Liab Libraries" variable group category,
whose name is A.

Variable Groups - Variable Groups tab


You can maintain, create and delete variable groups on the Variable Groups tab in the Variable Groups dialog.

When you select this tab, the existing variable groups are listed in the right pane. Use the outline in the left pane to
filter and display variable groups belonging to one or all categories.
Each variable group is created and maintained using the Variable Group dialog. The Variable Group dialog is
displayed when you:
n

Select an existing variable group and click Open

Select an existing variable group and click Duplicate

Click New to create a new variable group

The Variable Group dialog appears similar to the following:

Specifying variable groups and categories

From the Variable Group dialog you specify the name and code for the variable group. You also specify which
variables belong to the group.
To assign a variable group code to the variable group either enter the code in the Code field or click Browse to
choose an existing code. If you choose an existing code Prophet increments the code by one and updates the
Code field.
This dialog has the following tabs:
n

Variables tab
Allows you to select the variables for the variable group

Array Variable Filters tab


Allows you to add, edit and delete filter expressions that can be applied to array variables

Applicable Libraries tab


Allows you to choose the libraries to which the variable group is applicable.

691

692

Chapter 19 Workspace objects

Variables tab
From the Variables tab you select the variables for the variable group.
For an existing variable group, the currently assigned variables are displayed in the Selected Variables list in the
Variables tab. Variables that are available are displayed in the Available Variables list.
You move selected variables between the two lists by choosing the appropriate buttons. Alternatively, you can
select one or more variables in one list and drag and drop them into the other list.
You can also adjust the order in which the variables are listed in the Selected Variables list by selecting one or
more variables and using the Up and Down arrow buttons. This determines the order of the variables when they are
displayed on the screen.

Array Variable Filters tab


The array variables in the selected variable group are listed in the Array Variable Filters tab by name and their
corresponding dimension filter expression.

Specifying variable groups and categories

693

From the tab you can select an array variable and add, edit or delete a dimension filter expression for that variable.
Dimension filter expressions enable you to restrict the dimension entries for which results for that array variable are
displayed. If you do not enter a dimension filter then the values will be displayed for all the dimension entries.
Examples of the filters that you can enter are:
1,6
1-5,8
2:1-2:3,5
To apply or edit a filter for a variable, select the variable in the Selected Array Variables list and click Edit Filter.
From the Dimension Filter dialog you can apply a filter expression that enables you to display only those
dimensions that you require.
The Dimension Filter dialog appears similar to the following:

694

Chapter 19 Workspace objects

To add or edit a filter expression for a dimension, select the dimension in the displayed list and enter the filter
expression into the Filter cell for the dimension.
If more than one dimension is listed in the dialog then the Dimension Filter text box displays the filter expression for
each dimension separated by the colon character (:). For example, 2:1-2:3,5 specifies the filter expression for 3
dimensions. You can also directly edit the dimension expressions in the Dimension Filter text box.
The syntax for the filter expressions that can be applied to a dimension are listed as follows:
Enter this

To do this

Use the colon character (:) to separate expressions for each


dimension.
For example, the multiple expression for 3 dimensions could be: 12:2:3,5 where 1-2, 2 and 3,5 are the expressions for 3 dimensions.

Specifying variable groups and categories

Enter this

To do this

Use the hyphen character (-) to specify a range of dimension indices


for a dimension. For example, if a dimension has a size of 6 then the
filter expression 1-3 specifies that indices 1, 2 and 3 are used and
the rest are ignored.

Use the comma character (,) to specify specific indices. For example,
1,3 specifies that only dimension indices 1 and 3 are used for that
particular dimension.

When you have entered the filter expression, click OK to save the expressions in the workspace.
For an example of using filter expression see Filter expression example in Help.

Applicable Libraries tab


From the Applicable Libraries tab you assign which libraries are applicable to the current variable group.

695

696

Chapter 19 Workspace objects

A particular variable group will often include variables that only relate to one library. For example, a variable group
might be set up which only includes variables in the Asset library. When you are displaying the results for a product
in another library it is better if this variable group is not included in the list of available variable groups.
Therefore, if only the Asset library is set in this tab as an applicable library for a variable group, then that variable
group will only be listed as an option when an Asset product is being displayed.
To specify that the current variable group is applicable to all libraries choose All Libraries. Alternatively, to specify
one or more libraries, choose Selected Libraries and select the appropriate libraries from the displayed list.

Variable Groups - Variable Group Categories tab


Variable group categories are created and maintained on the Variable Group Categories tab in the Variable
Groups dialog.

To edit an existing category, select the category and click Open.


You can then update the category using the Variable Group Category dialog which appears similar to the following:

Specifying variable groups and categories

697

698

699

C H A P T E R

2 0

Prophet options

TOPICS IN THIS CHAPTER


What Prophet options are available?

701

Workspace options settings

702

Compiler settings

704

Descriptions settings

706

File Locations settings

707

Plugins setting

709

Language settings

712

Memory settings

714

Product Links setting

716

Prophet Enterprise Settings

717

Run log settings

719

Table details

725

Variables settings

729

700

Chapter 20 Prophet options

Workspace Permissions settings

731

Workspace Properties settings

738

Machine options settings

739

Calculation engine settings

741

Customize GUI settings

746

Miscellaneous settings

748

Table Options setting

750

Diagram view settings

752

Formula Options setting

754

Tree Options

760

Machine selection setting

763

Quick Access Toolbar

765

Worker logging

767

What Prophet options are available?

701

What Prophet options are available?


Settings for various aspects of a Prophet workspace and the Prophet environment are accessed from the Options
dialog box which is displayed when you click Options from the Prophet menu. The options are grouped into:
n

Workspace Options
The settings in this group relate to items in the Prophet workspace and are saved with the workspace. Hence,
these settings change whenever a different Prophet workspace is loaded.

Machine Options
The settings in this group relate to the machine running Prophet and are independent of the Prophet workspace.

Each of these options is described further in the following sections.

702

Chapter 20 Prophet options

Workspace options settings


Settings that are saved with a Prophet workspace are specified in the Workspace Options group of the Options
dialog box which is accessed from the Prophet menu. The Workspace Options appear similar to the following:

From the Workspace Options group you can apply or inspect the following settings:
n

Compilers

Descriptions

File locations, Table, Model Point file, Excel file and Results locations

Language settings

Memory settings

Plugins settings

Product links

Prophet Enterprise settings

Workspace options settings

Run Log settings

Table details

Variable groups and Dimensions settings

Workspace permissions

Workspace properties

Each of these options is described further in the following sections.

703

704

Chapter 20 Prophet options

Compiler settings
These settings relate to the Prophet Worker which processes runs. In Prophet Professional 8.0 and later, all runs
are processed by a Worker which is a separate application that normally resides as a sub folder of the main
SunGard program folder.
Compiler settings are accessed from the Compilers setting of the Options dialog box which is accessed from the
Prophet menu. The settings appear similar to the following:

Section

Description

Compilers

Allows you to choose the compiler to be used by the worker to process Prophet runs.
Note: If no compiler is specified in this section, the default compiler specified in the Calculation
Engine settings of the Options dialog box is used instead. For details see Calculation engine
settings on page741.

Architecture

The setting in this section determines which version of the Calculation Engine (CE), 32-bit or 64bit, is to be used by the Worker or Worker computers to process all runs in the workspace.For
example, choosing 32bit from the Runtime Architecture list requires a Worker computer or
computers to have a 32-bit version of the CE to be installed to process a run.
Note the following:

Compiler settings

705

Models that use the CALL_DLLfunction


Models using the CALL_DLL function must be run with the same architecture (32 or 64 bit) as the DLL which is
being called.

Compiler settings
The compiler settings that you select in this option are applied and saved to the currently open workspace.
Different workspaces can each have different compiler settings. If you share workspace in a mixed OS
environment then you need to ensure that the compiler settings of the workspace match the capabilities of the
operating system and the installed compiler of the recipient system.

Compiler locations
The locations of the compilers are obtained by Prophet from the compilers installed in the default location as
specified by the compiler provider. For details on how to install and use compilers installed in non-default
locations please contact the Prophet Helpdesk.

Worker PC selection
The Worker PCs that you select in either the Machine Selection setting of the Options dialog box or the Select
Machine dialog box accessed from the Multiple Machines option of the Runtime Configuration tab of a Run
Setting must have the same version (32 bit or 64 bit) of the Calculation installed as the setting specified in the
Runtime Architecture setting.

Third party tools


Note that Intex and Andrew Davidson need to be installed in the appropriate versions (32 or 64 bit) for the run
being performed.

When you click OK any settings that are made are saved with the workspace.

706

Chapter 20 Prophet options

Descriptions settings
Run numbers, sub-products and model point groupings can be rather meaningless unless descriptions are
assigned to them.
Description settings are accessed from the Descriptions setting of the Options dialog box which is accessed from
the Prophet menu. The settings appear similar to the following:

The dialog box has the following tabs:


Tab

Description

Run Numbers

Allows you to specify and list the descriptions for run numbers. Note that any descriptions added to
run numbers in a global file saved using the Table Editor are also added to this list.

Sub-Products

Allows you to specify descriptions for sub-products. To add a description for sub-product click Add
and enter the sub-product number with its description. To delete a description click Delete.

Model Point Grouping

Allows you to specify descriptions for each of the 5 model point groupings.

To save the changes click OK. To abandon the changes click Cancel.

File Locations settings

707

File Locations settings


The locations of tables, model point files, Excel reporting files and results files are specified in the File Locations
settings of the Options dialog box which is accessed from the Prophet menu. The File Locations settings appear
similar to the following:

The setting has the following tabs:


n

Tables

Model Point

Excel Files

Results

In all cases, two list boxes are displayed. One displays the available locations in the current workspace and the
other displays the locations that have been selected and made available for a Prophet run. In addition, if a location
outside of a workspace is required for a Prophet run then it can be added to the Selected Locations list by entering
it in the New Location box and clicking Add.
To save the location settings with the Prophet workspace click Save.

708

Chapter 20 Prophet options

To revert to the settings prior to any changes made to the selected locations click Reset.

Plugins setting

709

Plugins setting
The Plugins setting in the Options dialog box allows you to enable / disable the plugins and their version that are
installed on the machine.
To specify the settings for a plugin you choose the Plugins setting in the Options dialog box which is accessed from
the Prophet menu. The setting typically appears as follows:

Each installed plugin is listed by its name, qualifier, version, enabled status, valid status and the type of CPU
architecture supported. For each installed plugin you can:
n

Choose the version of plugin from the Version list. Note that choosing Latest Version always uses the current
version.

Enable or disable the plugin by selecting or clearing the Enable check box.

The setting currently supports System Plugins which are additional applications that support your model and are
installed separately. They are also available to all workspaces. Currently, plugins from Intex and Andrew Davidson
are supported.
Note the following:

710

Chapter 20 Prophet options

Only those Plugins that are installed are displayed in the Options dialog. If a Plugin is subsequently uninstalled
it is also removed from the dialog.

To make the plugin available to a model it must be enabled in the Options dialog.

If a model uses a plugin then the locations of the data files for a plugin are specified in the Plugins tab of a Run
Setting. For details see Run Setting - Plugins tab on page431. The location data is only available if the plugin is
enabled in the Options dialog.

The version of the Intex library selected in the dropdown list is only checked at runtime. If the version of the
installed Intex library does not match that specified in this dialog then a runtime error is generated.

The current version of Prophet Professional supports the following:

Andrew Davidson support


Prophet 8.2 Update 3 supports the following versions of Andrew Davidson:
l

5.2h_p2

5.2i_p1

LDM v2.0.2
Note: Only the Andrew Davidson dlls listed above are supported in this update. Users are advised to update
their plugins to the latest versions available. Also note that in LDM v2.0.2 the new Loan Dynamics functionality
is not available. Prophet will return values from the old prepayment model which Andrew Davidson has
embedded inside LDM.

Intex support
Prophet 8.2 Update 3 and DCS 8.2 Update 3 support the following versions of Intex:

Plugins setting

3.3c_p1

3.3d_p1

3.3e_p2

711

Note: Only the Intex Subroutines listed above are supported in this update.
Users are advised to update their plugins to the latest versions available. For example, Prophet users using
Intex 3.3c_p1 released with Prophet 8.2 Update 2 are advised to upgrade to the Intex 3.3c_p1 plugin released
with Prophet 8.2 Update 3.
n

32-bit (cmosub32.dll) and 64-bit (cmosub64.dll) versions of the Intex subroutines are supported.

712

Chapter 20 Prophet options

Language settings
Prophet provides multi-language support for actuarial documentation descriptions of the workspace objects.
A workspace can contain actuarial documentation and descriptions in a number of different languages. When a
workspace is opened it uses the Active Workspace Language setting specified in the Language dialog box.
To display Language settings:
n

Choose the Language setting from the Options dialog box which is accessed from the Prophet menu.

The setting appears similar to the following:

From the Language setting you can:


n

Edit the name and description of the current active workspace language.

Select, edit and delete a workspace language to be used in place of the current active workspace language.

Language settings

713

Add and create a new workspace language setting.

Replace missing actuarial documentation and descriptions in a workspace language with those in the current
active workspace language. The copied entries can also be tagged to allow them to be located and translated
into the new language. The tag, entered in the Tag with box can contain letters, numbers and spaces. It can be
up to 6 characters in length.

Note the following:


n

The current active workspace language cannot be deleted. To delete the language you must change to a
different workspace language and then delete it.

If you delete a workspace language that is not the active workspace language then any actuarial documentation
and object descriptions for that language are also deleted.

714

Chapter 20 Prophet options

Memory settings
You can specify the size of Grouping Memory allocated to a grouping run by setting the amount in the Memory
setting of the Options dialog box.
To display the dialog box:
Choose the Memory setting from the Options dialog box which is accessed from the Prophet menu.
The Memory setting appears similar to the following:

As a rule, the amount of memory allocated should not be less than 1% of the size of the largest input model point
file.
The memory settings options allow you to specify:
Grouping Memory
This option allows you to specify how much physical memory is used during a grouping calculation by entering an
appropriate value. As a guide, the amount of memory allocated should not be less than 1% of the size of the largest
input model point file.
Whenever the amount of physical memory specified is exceeded during a grouping run then the operating system
memory manager takes over and pages the data to disk. The runtime will then increase when this happens.

Memory settings

715

In-Memory Dynamic
This setting only applies to in-memory dynamic / stochastic runs.
Selecting Show details of memory allocation for limited memory method option does the following:
n

Displays a warning that the option needs to be used with care.

Extends the size of the Memory tab of the Advanced Settings of a Structure in which a table of products and their
memory usage is displayed.

For more information on how to specify memory settings for products used in an in-memory dynamic / stochastic run
see Structure - Advanced Settings dialog box - Memory tab.
For information on how to manage and fine tune the memory settings for In-Memory Dynamic or Stochastic runs.
See Override using product level settings.

716

Chapter 20 Prophet options

Product Links setting


The product links used in a workspace are specified using the Products Links setting in the Options dialog box:
n

Choose the Product Links setting from the Options dialog box which is accessed from the Prophet menu.

The Product Links setting appears similar to the following:

The names of any existing product links are listed in the dialog box.
To add a product link:
n

Click Add and enter the name in the list. The product link name can contain a maximum of 36 alphanumeric
characters. No spaces are allowed however, you can use the underscore character (_) in place of spaces.
Product Link names are not case sensitive.

To delete an existing product link:


n

Select the product link in the list that you wish to delete and click Delete. The selected link is deleted. Note that
deleting a product link can cause product runs to fail.

When you have specified the product link names click OK to apply and save them to the workspace. Alternatively, to
revert to the original settings click Reset.
The specified product link names for the workspace can then be used to specify the names of the products and
accumulations results in a structure. See Product Links.

Prophet Enterprise Settings

717

Prophet Enterprise Settings


The Prophet Enterprise Settings option allows you to specify the characteristics of the Prophet Enterprise
environment used to run Prophet Professional runs.
Prophet Enterprise options are displayed when you select Prophet Enterprise in the Options dialog box of the
Prophet menu. It appears similar to the following:

From this setting you can specify the following:


n

Server Location
Enter a valid Prophet Enterprise Web Server URL. For example,
https://PE_WebServer/prophet.

Server Version
This is a read only field and displays the version of the Prophet Enterprise server when a valid Server location
(URL)is entered into the Server Location text box and Validate is clicked. The field remains empty if an invalid
URL is entered.

718

Chapter 20 Prophet options

Workspace ID
This is the id or description of the Prophet workspace. It can be an arbitary value and is used by Prophet
Enterprise to identify the workspace.

Prophet Studio
This displays the location of the Prophet Studio application on the machine running Prophet Professional. It is
for information only and is a read-only value.

Note the following:


n

These options are only applicable when the Prophet Enterprise option is selected in the Method of Run section
of the Runtime Configuration tab of a Run Setting.

For information on how to set up Prophet Professional to use Prophet Enterprise resources using the Push to
PEfeature see: Using Prophet Enterprise Resources.

Run log settings

719

Run log settings


With some exceptions, most run log settings apply to the logging of messages sent to the run log during goalseeking and stochastic runs.
To display the Run Log settings:
n

Choose the Run Log Settings setting from the Options dialog box which is accessed from the Prophet menu.

The Run Log Settings appear similar to the following:

720

Chapter 20 Prophet options

The available settings are:


n

Message logging settings


These settings apply to simulations and therefore stochastic runs only.

Errors and Warnings


These settings apply to stochastic runs only.

Additional logging settings


These settings apply to goal seeking and extended formula. They are not specific to stochastic runs.

Run Log Report


This setting applies to any type of run. It creates a single run log formatted as an XPS file for each run number.
The report is viewed and printed using an XPSviewer.

Exception Logging
This setting applies to any type of run and is generally used to track exceptions such as memory issues.

When a run is finished the generated run logs are accessed from the Results & Runlogs pane. With the exception of
the Run Log Report, the Results Viewer is used to view the logs that are selected and opened from the Results &
Runlogs pane.
Note: Run logs generated in Prophet Release 8 and later can only be viewed using the Results Viewer. Run
logs created using an earlier version of Prophet are displayed in the main interface.
The following sections are available:
Message Logging
Settings in this section are specific to stochastic runs only. They are used to specify which simulations are used to
generate the log messages.

Run log settings

721

The available settings are:


n

All Simulations
This setting is set by default. When set, all messages and warnings generated by the system for each simulation
during a stochastic run are sent to the run log. If a large number of simulations are run then the run log can
become large and will contain the same information repeated many times.

First and Last Simulations


Choose this setting to limit the number of messages sent to the run log to the first and last stochastic simulations
only.

Specified Simulations
Choose this setting to send messages to the run log for specific simulations by entering the simulation numbers
into the associated text box. You can enter specific simulations separated by commas or as a range separated
by a dash. For example, to send run log messages for simulation 1,4,6 and 50 to 60 you would enter: 1,4,6,5060.
Note: If you select Specified Simulations and then run a different set of simulations than those specified
here, you may find that the error and warning messages for the run you perform are not written to the run log.
For example, if you specify simulations 1, 2 and 3 in this setting but then run simulations 4 and 5, the
messages from simulations 4 and 5 are not written to the run log.

Errors and warnings


The settings in this section apply to stochastic runs only.
Note: Some options are not available if All Simulations in the Message Logging section is selected.

722

Chapter 20 Prophet options

You can specify the following:


n

Include Error Messages for all Simulations


Select this setting to send all error messages generated by the stochastic run to the run log

Include Warnings for all Simulations


Select this setting to send all warning messages generated by the stochastic run to the run log

Include User Specified Warnings for all Simulations


Select this setting to send all user specified warnings produced by the Warning function for each simulation to
the run log. It is usually selected by default.

Additional logging
The settings in this section apply only to goal seeking runs or extended formulas.

You can include any of the following:


n

Include Goal Seeking Messages


Select this setting to log details of the iteration process when performing goal seeking. Generally, if you are use
goal seeking Prophet does not provide any details of the process. However, selecting this option when
developing a goal seeking product allows you to monitor how the iteration process progresses towards the goal.

Run log settings

723

Include Extended Formula Recalculation Warnings


Select this setting to log details of any warning messages generated by code that uses t-extended formulas.
Recalculation warnings are generated whenever a t-dependent formula is called more than once for the same t.
You can address formula recalculations by doing either of the following:

Amending you code so that the variables are sequenced in a more optimal manner, OR

Defining the public variables that are referenced as PERSISTENT.

Run Log Report


This setting applies to all types of Prophet run. It generates a single XPSformatted run log report for each run
pairing run.

The generated run log report is named as runlog.xps and can be viewed by selecting and opening it from the
appropriate Run Number folder of the Results & Runlog pane. Using Windows Explorer, the report can also be
located and opened from the appropriate Run Number folder of the Prophet workspace.
Note the following:
n

If a run is repeated then an existing runlog.xps file is renamed to lastlog.xps overwriting any previous lastlog.xps
file. Both run log files are displayed in the appropriate run number folder of the Results & Runlogs pane.

An XPS viewer and print driver is required to display and print an XPS formatted run log report.

Machines running Windows 7 or later can display and print the XPSformatted run log report from within
Prophet.

Machines running a pre-Windows 7 operating system may need to have installed an XPS viewer and printer
driver which is available from the Microsoft website.

Exception log
This setting applies to all types of Prophet run and allows the location of an exception log file to be specified.

724

Chapter 20 Prophet options

By default, the location of the log file is in the application data area of the Documents and setting folder for the user.
To enable exception logging to a text file:
1. Select Enable exception logging.
2. Accept the default location of the log file or click Browse and enter the name of the log file in a specific folder.
To apply changes to the Run Log Settings dialog box click OK. Alternatively, click Cancel to abandon any changes.

Table details

725

Table details
You can categorise and document the tables used in the workspace by using the Table Details setting in the
Options dialog box which is accessed from the Prophet menu. The setting appears similar to the following:

The currently specified tables are displayed organised by category in the tree structure in the top pane of the dialog.
The remainder of the dialog allows you to:
n

Create, copy, rename and delete table categories.

Create, copy and delete table details.

Attach documentation to a table.

726

Chapter 20 Prophet options

Table details are managed using categories. Initially, a basic template of categories and tables is supplied to which
you can add additional categories and tables. The table details and categories are saved in the workspace that you
use.
In the top pane tree view of the Table Details dialog you can:
n

Rearrange the order of the table categories by selecting a category and clicking the Up or Down buttons to
move the selected category to the desired position.

Select, drag and drop a category to the desired position in the category hierarchy.

Select, drag and drop a table to the desired position in the category hierarchy.

In the remainder of the dialog you can manage table categories and tables.
Note the following:
n

When you move a table category its associated tables are moved with the category.

A table category can also have sub-table categories each containing tables and their associated
documentation.

A table can exist in more than one table category. However, each table is treated as a unique table with its own
documentation even if the table has the same name and location.

If you copy a table then its documentation is also copied.

A category can only be deleted if it does not contain any tables.

Creating a table category


Table categories are created in the Table Details setting of the Options dialog box. Once created, the categories
are displayed in the Category tree structure of the Table Details setting and also in Structure Diagram View.
To create a table category:

Table details

727

From the Prophet menu click Options.

Choose the Table Details setting in the Options dialog box.

In the Category section of the Table Details setting click New. The Category dialog box appears similar to the
following:

In the Category dialog box, enter a unique name for the new table category. The name can be up to 50
characters in length and can contain spaces and other punctuation.

When you have entered the new category name, click OK.

The new category appears at the bottom of the Category tree. You can then add tables to the new category by
either entering the table details for each table or selecting one or more tables in an existing category and dragging
them to the new category.
You can also select the new category and use the Up / Down buttons to place the new category in the desired
position in the tree structure.

Creating new table details


You create details for a table displayed in a table category from the Table Details setting of the Options dialog box.
which is accessed from the Prophet menu.
To create table details for a selected table:

728

Chapter 20 Prophet options

In the Table details setting select the table category from the Category drop down into which you wish to create
the new table.

In the Table section, click New to create a new table record which is added to the end of the selected table
category. Note that the name of the new table is initially set to FileName1.

Select the new table in the tree view and then either enter the file name of the new table together with its
extension in the Name text box or click Browse and select a table from the Select Table dialog box.
Note that the table name including its file extension can be up to 40 characters in length.

You can optionally enter documentation for the new table in the Documentation text box or add another table to
the table category by clicking New.

When you have entered the table details click OK to save them .

Variables settings

729

Variables settings
The properties of each variable include a number of settings which you may sometimes wish to change for a
number of variables. The Variables dialog allows you to make these changes without having to access the Variable
Properties dialog for each of the variables individually.
To display the Variables dialog:
n

Choose the Variables setting from the Options dialog box which is accessed from the Prophet menu.

The variables dialog appears similar to the following:

The Variables dialog has the following tabs:


n

Cumulative

Text Output

Cross Multiply as a Number of Policies

Dynamically Calculated

All but one of these tabs corresponds to a setting in the Variable Properties dialog.

730

Chapter 20 Prophet options

The exception to this is the Text Output setting. The Text Output setting identifies the variables to be included in the
Text Results files that can be produced during a run, see "Results tab".
Details of each of the other settings are given in "Variable properties".
For all the tabs two lists are displayed. The left list displays variables that are available and the right displays the
variables that have been selected. To move variables from one list to the other you select the appropriate variables
and use the buttons between the lists to move them. Alternatively, you can select one or more variables and drag
them to the other list.

Workspace Permissions settings

Workspace Permissions settings


The Workspace Permissions setting of the Options dialog allows user permissions and user information for the
open workspace to be applied to the current workspace. It also allows message to be sent to other users of the
workspace.
To display the Workspace Permissions setting:
n

Choose the Workspace Permissions setting from the Options dialog which is accessed from the Prophet
menu.

The Workspace Permissions setting appears similar to the following;

The Workspace Permissions setting has the following sections:


n

Permissions
Options from this section display the workspace items that can be changed by a user or group. If you are the

731

732

Chapter 20 Prophet options

Master or the owner of the workspace or have workspace creation rights then you can specify full access to all
users or restrict and set access rights to selected users or groups. For information on managing the workspace
permissions see Limiting access to a workspace.
n

Users
This section lists those users that are currently accessing the workspace to which the Master or owner has
allowed access. The users are listed by name, type (Master or Viewing), computer name and the time and date
when first logged into the workspace.
Users can also send single line messages to each other. For example, the Master user can inform each Viewing
user that a run is being performed and that the results will change. To do this the Master selects the user in the
Users tab of the Workspace Properties dialog to whom the message is to be sent, enters the one line text
message in the text box at the bottom of the list and clicks Send Message. The Viewing user sees the message
at the bottom of the workspace window. All users can send messages to each other in this way.
For more information refer to Managing Multi-User Access.
Note: If you create a workspace and apply restrictions to it then make sure that you assign at least all
workspace permissions to your user name otherwise you may not be able to subsequently access or change
items in the restricted workspace.

To apply changes to the workspace click OK. Alternatively, to abandon them click Cancel.

Workspace Permissions settings

733

Limiting access to a workspace


You can limit access to a workspace that you have created providing that permissions have been enabled using the
Prophet Administrator application.
If permissions are enabled then do the following:
n

Open the workspace, and if prompted, login as a user that has administrator rights.

In the Workspace Permissions setting of the Options dialog box, accessed from the Prophet menu choose "Limit
access to Administrator and the following".

To allow limited access to users or groups


Click Add. The Available Users and Groups dialog box is displayed similar to the following:

734

Chapter 20 Prophet options

From the dialog box select the users or groups to which you wish to restrict access to the workspace.

You can display all users by selecting "Show Users" and all groups by selecting "Show Groups".

Select a user or group from the dialog box. You can select more than one user or group by holding down the
Ctrl key and selecting each user or group to which the workspace is to be made available.

Click OK to apply the users or groups. The list of selected users and groups together with their permission
settings is displayed in the Permissions section of the Workspace Permissions setting of the Options dialog box:

Workspace Permissions settings

735

You can now apply the workspace restrictions to a user or group.


To assign workspace restrictions to a user or group:
n

In the Permissions section of the Workspace Permissions setting select the user or group and click Edit
Permissions.

From the Permissions dialog box, select the type of restriction to be applied for the user and click OK.

Note the following:


n

A user can inherit permissions if added to a group that confers additional permissions to those already available
to the user. For example, if a user that does not have the "Create Workspace" permission is placed in a group
that has the "Create Workspace" permission then the user inherits that additional permission and so can create
new workspaces.

Conversely, a user cannot be disinherited of any permissions. For example, if a user that has the "Create
Workspace" permission does not lose that permission if placed in a group that does not have the "Create
Workspace" permission.

736

Chapter 20 Prophet options

Setting user or group restrictions on a workspace


To apply or change the user or group permission settings for a workspace you need to have created the workspace
or have administrator rights. You can then limit the workspace tasks that can be performed by a selected user or
group as follows:
n

In the Permissions section of the Workspace Permissions setting of the Options dialog, ensure that "Limit access
to Administrator and the following" is set.

To apply or edit restrictions to a user or group select a user or a group in the Permissions tab and click Edit
Permissions. The Permissions dialog is displayed.

From the Permissions dialog you can apply or remove permissions for the selected user or group.
The permission settings that you can edit are:

Workspace Permissions settings

Permission

Type of restriction

Edit Product

When selected, allows products to be created or edited.


Otherwise, you can only view the product details.

Edit Library

When selected, allows variables and other objects in a library to


be created or edited. Otherwise, you can only view the library
details.

Perform Run

When selected, allows runs to be set up and run. Otherwise no


runs can be made.

View Results

When selected allows results to be viewed. Otherwise, no results


can be viewed.

Alter Permissions

When selected, enables permissions to be changed by a user


that has the "Create Workspace" permission setting. Otherwise,
no permissions setting can be made.

When you click OK the selected permission settings are applied to the user or group and displayed in the
Permissions section of the Workspace Permissions setting.

737

738

Chapter 20 Prophet options

Workspace Properties settings


The workspace properties setting displays location, language and statistical for the open workspace.
To display the Workspace Properties setting:
n

Choose the Workspace Properties setting from the Options dialog box which is accessed from the Prophet
menu.

The Workspace Properties setting appears similar to the following;

The Workspace Properties setting has the following sections:


Section

Description

General

Displays the location, description and language setting of the workspace. You can only edit the description of the
workspace.

Statistics

Displays the date and times of when the workspace was created and last modified. You cannot edit any of the fields in
this section.
n

To apply changes to the workspace click OK, or to abandon the changes click Cancel.

Machine options settings

739

Machine options settings


The settings in the Machine Options group of the Options dialog box apply to the user and the machines available
to the Prophet machine. Unlike the Workspace options which are saved with the Prophet workspace, the machine
options are stored on the Prophet machine. The Machine Options group of the Options dialog box is accessed from
the Prophet menu and appears similar to the following:

From the Machine Options group you can apply or inspect the following settings:
n

Calculation engine

Customize GUI

Machine selection

740

Chapter 20 Prophet options

Quick Access Toolbar

Worker Logging

Each of these options is described further in the following sections.

Calculation engine settings

741

Calculation engine settings


The calculation engine setting of the Options dialog box displays information on the minimum version of the
Prophet calculation engine supported by Prophet. It also displays information on the location of the 32 bit and 64 bit
Worker PCs used to process Prophet runs.
Calculation engine options are displayed when you select the Calculation Engine setting in the Options dialog box
of the Prophet menu. It appears similar to the following:

742

Chapter 20 Prophet options

Section

Description

Mortality
Tables

The location of the Mortality Tables that can be accessed by the Worker when processing Prophet runs is shown in this
section. It is initially specified during the Prophet installation but can be later amended by clicking Edit and entering the
location in the Worker Options dialog box. For details see Worker options on page744.

Calculation engine settings

Section

Description

Worker
CPU
Options

The settings in this section allow you to specify the number of CPUcores that are available during the compilation
phase of a Prophet run. The settings are:
n

743

Number of Licensed Cores


This displays the maximum number of cores that can be used for the build (compilation) phase of a Prophet run.
This number is fixed by the Prophet licence that is supplied.

Maximum Number of Local Cores


This setting specifies the number of cores used locally for the compilation and run time phases of a Prophet run.

The default setting is Unlimited. and the maximum number of available local cores (CPUs) is used during
compilation and runtime.

To specify the number of cores choose Limit to, enter the number of cores to be used and click Apply to confirm
the change.

Note the following:


n

The maximum number of cores that are currently supported is 50.

This setting is generally used to resolve issues when processing Prophet runs in a shared environment such as
Citrix in which multiple users submit runs at the same time.

This setting should be used with care as it affects the number of cores used locally at compilation and run time. It
can also dramatically reduce the performance of some runs.

It is recommended that this setting is only applied when contention and machine reliability issues are affecting a
shared environment.

Warnings are generated if a more cores (CPUs) are specified in the Runtime Configuration setting of the Run
setting than are specified in this section. For details see Run Setting - Runtime Configuration tab on page443.

744

Chapter 20 Prophet options

Section
Default
Compiler
Option

Description
This setting allows the default compiler used by the calculation engine to be specified. Note that the setting can be
overridden by the compiler selected for the workspace in the Compilers setting of the Options dialog box. For details
see Compiler settings on page704.
If more than one compiler is installed then choose it from the Default Compiler dropdown and click Apply. If only one
compiler is available then it is used by default. Note that you need machine level Admin rights to make changes to the
default compiler setting.

Worker options
The location of the Mortality Tables accessed by the Worker when processing Prophet runs are specified in the
Worker Options dialog box.
To display the dialog:
n

Choose the Calculation Engine settings in the Options dialog box which is accessed from the Prophet menu.

In the Mortality Tables section of the Calculation Engine settings click Edit. The Worker Options dialog
appears similar to the following:

The current location of the Mortality Tables as specified during the installation of the Worker is displayed. If
required, the location can be changed by clicking Browse and navigating to the new location.
Note: This setting applies only to the Worker application installed with Prophet

Calculation engine settings

745

When you click OK any changes are applied to the Worker and are displayed in the Mortality Tables Location text
box of the Calculation Engine settings.

746

Chapter 20 Prophet options

Customize GUI settings


The Customize GUI setting in the Options dialog box allows you to manage the look and feel of the Prophet
environment. The settings are accessed from the Customize GUI setting of the Options dialog box which is
accessed from the Prophet menu. The setting typically appears as:

You can choose the following customisation settings:


n

Miscellaneous
The settings allow the colour scheme to be selected from a number of preset options. In addition, database
warning messages can be controlled as well as the option of reseting window and history settings.

Table Options
This setting provides options relating to tables displayed and edited in Prophet.

Customize GUI settings

747

Diagram Options
This setting relates to Diagram View and allows you to customise the colour scheme and behaviour of items
duisplayed in the application.

Formula Options
The options in this setting allow you to set code folding and block documentation options that are used when
coding extended formulas.

Tree Options
The options in this setting allow you to customise the tree for each object displayed in the panes displayed on
the left of the interface.

When you click OK the settings are saved to the user machine and not the current open workspace.

748

Chapter 20 Prophet options

Miscellaneous settings
The Customize GUI setting in the Options dialog box allows you to manage the look and feel of the Prophet
environment.
To change or inspect the settings choose the Customize GUI setting in the Options dialog box which is accessed
from the Prophet menu. The setting typically appears as:

You can choose the colour scheme from a list of pre-defined types in the Colour Scheme section.
Database section
The one option in this section allows you to hide or show the warning dialog box which is displayed when you
access a workspace on a server that does not have the Firebird database server running.
To display the warning dialog box you select "Warn when opening a Workspace on a server not running Firebird ".
This is the default setting.
Note the following:

Miscellaneous settings

749

It is recommended that the "Warn when opening a Workspace on a server not running a database " setting is
always selected.

If you select "Do not show this dialog box again" in the Warning dialog box which is displayed when you open a
workspace on a server not running Firebird then the "Warn when opening a Workspace on a server not running
database" setting is de-selected.

Settings section
To clear all Prophet layout settings together with any history and debugger settings click Restore to Default. This
returns all windows and panes to their original size just after installation.

750

Chapter 20 Prophet options

Table Options setting


The Table Options setting in the Options dialog allow you to change the settings relating to tables displayed and
edited in Prophet.
To display the Table Options setting:
n

Choose the Customize GUI setting from the Options dialog box which is accessed from the Prophet menu.

The Table settings are displayed in the Tables Options tab which appears similar to the following;

The following sections are available:


Tables section
Settings in this section allow you to:

Table Options setting

751

Hide or display the descriptions


Selecting "Do not display the Description or Type in the Tables or Model Point Files and Queries views"
prevents the descriptions and table type for each table being read when a list of referenced tables is built..This
option can be useful in improving performance especially If a workspace contains references to many tables.
Note: You can update the table and model point file lists in a workspace by pressing F9 or clicking Refresh
in the Home tab.

Allow searches of table row and column headers


Selecting this option allows the system to include the data in the table row and column headers to be included
in the system search facility. Note that enabling this option can impact the responsiveness of the system.

Include Table and Model Point Files specified in Run Settings


Select this option to add the Table and Model Point file locations specified in all the Run Settings of the current
workspace to the tree displayed in the Tables, Model Point and Excel files view.

Table Editor section


Select this option to display the name of the Last Index Variable in the column header of a generic table. Note that
the name of the Last Index Variable can also be inspected in the Properties for the table.
Standard Tables section
The location of the Standard Tables installed by the Prophet installation is displayed in this text box and is used to
display the available tables in the Select Table dialog when a Standard Table is created.
To use a different set of standard tables stored in different location, click Edit and navigate to and select the new
location from the Browse for Folder dialog.
To restore the original table location as specified by the Prophet installation click Reset.

752

Chapter 20 Prophet options

Diagram view settings


The Settings for Diagram view allow you to specify that variables with particular properties are highlighted in a
specified colour.
To display the Diagram view settings:
1. On the Prophet menu click Options. The Options dialog box appears.
2. Click Customize GUI. The Diagram view settings appear.

The following sections allow you to specify Diagram view settings:

Colour Scheme section


Settings in this section allow you to:

Diagram view settings

753

Assign colours to specific items


By default, cumulative variables are displayed in blue. Also when Diagram view is used to edit a product the
input variables are displayed in red.

To specify a custom colour for the property of a variable, select the property from the colour list and select a
colour from the displayed palette.

To change the typeface used in Diagram view, click Font and from the Font dialog box select the appropriate
typeface.

To specify a custom border colour for input variables or external links, from the colour list select the colour.

Diagram section
This section specifies how variables are represented diagrammatically. The available settings are:
n

Show Dependency Tree View


Selecting this setting displays the dependent tree panels. Alternatively, clearing this setting hides the
dependency tree panels and so provides more space to display the relationship between variables.

Exclude Self Referencing Variables


Select this option to hide any self referencing variables displayed in the dependency tree panels. Self
referencing variables are hidden by default.

Results section
The setting in this section is used by Results Diagram view.
n

Synchronize results panes


Select this option to specify whether the three results panes are synchronised so that they all display results for
the same time periods.

To abandon changes click Cancel.


To save and implement settings click OK.

754

Chapter 20 Prophet options

Formula Options setting


The Formula Options settings in the Options dialog box allow settings to be applied to the Formula Editor
environment.
To display the Formula Options settings:
n

Choose the Customize GUI setting from the Options dialog box which is accessed from the Prophet menu.

Click the Formula Options tab.

The formula settings appears similar to the following:

The settings that can be applied are:

Formula Options setting

755

Formula Editor
The settings allow you to customise the formula editor. In particular, you can specify code folding and formula
block documentation options that are used when coding extended formulas.

Auto Complete
The settings in this section allow you to customise the auto complete feature which assists in entering functions
and their parameters as you enter code in the formula editor.

Full Screen
This setting enables a second monitor to be used to display the formula editor.
Note: The Formula Options dialog box is also displayed when you click Editor Options from the Design tab
when using the Formula Editor.

Each of these options is described as follows:


Formula Editor section
This section specifies the code folding and block documentation options that are used when coding extended
formulas. The section appears similar to the following:.

The settings that can be applied to the formula editor are specific to extended formulas and are as follows:

756

Chapter 20 Prophet options

Formula is folded by default


Selecting this option "shrinks" the code and displays it either as a number of Statement or Documentation
blocks. For example, you can shrink or expand specific IF/ENDIF blocks and loop statements such as Do
While/Loop. In addition, the extent of the block or loop statement is displayed in the left margin.

To shrink and expand statement blocks choose Fold on Statements.

To shrink and expand Formula blocks choose Fold on Formula Blocks.

Block Documentation is shown by default


This setting becomes available when Fold on Formula Blocks is chosen. Selecting this option displays the
Block Documentation window alongside the Formula Editor window. When the Block Documentation window is
open you can insert a Formula Block in the code and enter text in the Block Documentation widow to describe
the formula.

Highlight Matching Statements


Selecting this setting allows matching statements such as IF/ENDIF blocks and loop statements such as Do
While/Loop to be highlighted. When this setting is selected you can do ONE of the following:
l

Mouse Position - Choose this option to highlight matching statements by hovering over a statement using
the mouse pointer.
Cursor Position - Choose this option to highlight matching statements at the location of the cursor.

Auto Indent Code


Select this option to ensure that code within blocks such as IF/ENDIF statements, and loop statements such as
Do While/Loop, are automatically indented, making the code easier to read.
Note the following:
l

The amount by which code is indented is specified by the Tab Width setting in the Display tab of the Editor
Options dialog box which is displayed when you click Advanced Editor Options.
Indent and UnIndent buttons on the Formula Editor tab allow you to manually indent or outdent code that

Formula Options setting

757

you select in the Formula Editor.


l

To format and indent all or selected code in a formula click Format on the Formula Editor tab.

Auto Close Code Blocks


Selecting this option automatically adds an ending statement when you enter code blocks. For example, if you
type an IF statement in an extended formula definition then the ENDIF is automatically added on the line below
when you press Enter. Similarly, if you begin a DoWhile loop and press Enter, Loop is automatically added on
the line below to complete the code block.

Advanced Editor Options


Click Advanced Editor Options to customise the formula editor to your requirements. For information on what
can be customised see:Formula Editor Options.

Auto Complete section


This section allows to control the behaviour of the auto complete functionality that suggests names of functions and
their parameter as you enter them into the formula editor. The section appears similar to the following:

The settings that can be applied are:


n

Show Auto Complete for all objects when typing


Select this option to enable auto-complete functionality when entering functions or enumerations into a formula.

758

Chapter 20 Prophet options

You can set the length of time, in milliseconds, before auto complete makes a suggestion. The default setting is
500 milliseconds.
Once this setting is selected you can further specify which auto complete functionality is required. You can
choose to enable the functionality for Enumerations, Extended Formulas or plugins.
n

Show Function Parameter Hints


Select this setting to display in one of two modes:

Simple - This displays basic parameter hints in one line.

Extended - This displays detailed parameter hints in the order that they need to be entered.

Show Documentation Panel


This setting extends the auto-complete panel by displaying a documentation panel which contains additional
information on the function being entered.

Formula Options setting

759

..
Full Screen section
If Prophet detects that a second monitor is attached to the machine then selecting Use Second Monitor for Full
Screen Mode allows the formula editor to be displayed in the second monitor when Toggle Full Screen is selected
in the Design tab.

To return from Full Screen Mode to the normal mode of operation press Esc.

760

Chapter 20 Prophet options

Tree Options
The Tree Options setting of the Options dialog allows you to customise the tree for each object displayed in the
panes displayed on the left of the interface.
To display the Tree Options settings:
n

If not done, open a Prophet workspace.

Choose the Customize GUI setting from the Options dialog box which is accessed from the Prophet menu.

The Tree View settings are displayed in the Tree Options tab which appears similar to the following:

Tree Options

Settings from the Tree Options section allow you to control the grouping and display of the Prophet Objects
displayed in the tree pane of the main application window. In particular you can:
n

Select a Node from the displayed list and select a grouping criteria displayed in the Grouping list

Arrange the order of grouping criteria selected in the Grouping list by clicking the Up / Down arrows

761

762

Chapter 20 Prophet options

Select and hide a specific sub node displayed in the list of Nodes and selecting the Hide Node option. Note that
this option only applies to sub nodes and not the main Nodes.

Applying original settings


You can reset the grouping criteria settings to their original installation settings by clicking Defaults.
Clearing hidden sub-nodes
To unhide any sub nodes in the Nodes list that were previously hidden using the Hide Node setting click Clear.
Note that this option also clears any tree grouping criteria for the sub nodes.
Resetting Grouping settings
To reset the grouping setting of a selected node in the Nodes list to its default setting, you select the node and click
Reset. To reset the grouping criteria of a node and all its sub nodes to the default settings, you select the node in
the Nodes listand click Reset Children.
Applying minimum grouping criteria
To apply a grouping criteria to a minimum number of the same object you select the object in the Node list and set
the number in Minimum Grouped Records. The number of objects below the set number will not have any
grouping criteria applied. If the minimum number is exceeded then the specified grouping criteria is applied to the
same objects in the sub node.
Note the following:
n

Grouping criteria that you apply in the Tree Options settings are saved in the User Profile location of the
machine.

Grouping criteria settings are loaded whenever a workspace is opened.

If a second Prophet session is started and changes are made in the second session to the grouping criteria
using the Options dialog then the changed grouping criteria does not take effect in the first session until a
workspace is reloaded in the first session.

Changes to grouping criteria that are applied using options from the right click menu in the tree pane of the main
application window override those settings specified in the Tree Options settings. These additional changes are
lost when the Prophet session is closed.

Machine selection setting

763

Machine selection setting


The set of Worker machines used in a Parallel PC run can be specified from the Machine Selection setting of the
Options dialog box. To display the setting, click Options from the Prophet menu and choose Machines Selection
from the Options dialog box. It appears similar to the following:

Any Worker PCs that have been specified are listed by name, number of CPUs and comments. From the Machine
Selection option you can add, edit and delete Worker PC's that are used in a Parallel PC run. You can also test
whether the selected Worker machines has a 32 or 64 bit Calculation Engine (CE)installed. If you also want to use
the Master PC to process runs alongside the Worker PCs then it should also be listed and selected in the Machine
Selection option.
Note: These machine settings are replaced entirely with those specified as Default in the Machine Settings
dialog box. The dialog box is accessed when you choose Multiple Machines and click Change in the Runtime
Configuration tab of a Run Setting.
The tasks that you can perform are:
To do this

Do this:

Add a Worker PC

Click New and enter the details for the Worker PC in the Machine
Details dialog box.

Remove a Worker
PC

Select the Worker PC from the list that you no longer require and click
Delete. The selected Worker is removed from the list and will not be
used in a Parallel PC run.

764

Chapter 20 Prophet options

To do this

Do this:

Update the details


for a Worker PC

Select the Worker PC from the displayed list and click Open. The
Machine Details dialog box for the selected Worker is displayed from
which you can update its details.

Use a Worker PC in
a Parallel PC run

Select each Worker PC in the list that you wish to use in a Parallel PC
run. Note that selecting a listed Master PC will allow the PC to process
Parallel PC runs alongside any other selected Worker PCs.

Check the CPU


architecture
supported by a
Worker PC

To check the CPU architecture supported by the Calculation Engine


(CE) installed on a Worker PC you select each Worker in the list and
click Test (32 bit) to test for a 32 bit version of the CE or click Test (64
bit) to test for a 64 bit version.

When you click OK the Worker PC settings become the default settings for a Parallel PC run.
Note the following:
n

The maximum number of cores that are currently supported is 50.

Parallel runs cannot be processed using Worker machines running different versions of the CE.

These settings can be overridden by the Multiple Machines setting in the Runtime Configuration tab of a run
setting.

Quick Access Toolbar

765

Quick Access Toolbar


The Quick Access Toolbar (QAT) is a small toolbar that provides fast access to tasks that are frequently performed.
The toolbar is always available and can be located either on top or at the bottom of the main ribbon.
A typical quick access toolbar appears as follows:

The items on the toolbar are managed and customised using the Customize QAT setting in the Options dialog box
which is accessed from the Prophet menu. The settings typically appear as:

Two lists are displayed. The list on the left displays the commands that are available and the list on the right
displays the commands that are on the quick access toolbar.
To add additional commands to the toolbar select them in the left list and click Add. Similarly, to remove a command
on the quick access toolbar, select it in the right list and click Remove.

766

Chapter 20 Prophet options

Other QAT toolbar customisation


You can apply other customisation options to the toolbar by choosing options from the toolbar right click menu:

From the QAT menu you remove a selected item on the toolbar and position the toolbar above or below the ribbon
and minimise or maximise the ribbon. Choosing the Customize Quick Access Toolbar option displays the
Customize QAT settings in the Options dialog box from which you can add, remove and rearrange commonly
accessed ribbon items.

Worker logging

767

Worker logging
Worker logging settings allow specific log information to be generated by the worker machine during a Prophet run.
The settings are specified in the Worker Logging settings of the Options dialog which is accessed from the Prophet
menu. Previously, these settings were applied by manually editing configuration files.
Note: Log settings should only be changed if issues are encountered with specific runs that prove difficult to
troubleshoot.
To access the Worker logging settings;
n

Display the options dialog by clicking Options from the Prophet menu.

Choose the Worker Logging setting which appears similar to the following:

768

Chapter 20 Prophet options

The settings that relate to the Prophet Worker machine settings are:
n

Errors
This is the default logging setting an cannot be changed. It enables the logging of serious errors during the
compilation and run phases of a Prophet run. Typically, these logging messages will give more information
about fatal errors that will prevent current operations or tasks from completing successfully, these error
messages will ultimately cause a run to fail.

Warnings
This is the default logging setting an cannot be changed. It enables the logging of warning messages generated
during the compilation and run phases of a Prophet run. These messages are usually less serious errors that
will allow an operation or task to continue without causing the run to fail.

Information
This logging setting generates a high level informational trace on the progress of the Prophet run. It records
information regarding the execution and behaviour of the Prophet services and it is usually used for
troubleshooting and debugging purposes when trying to diagnose an on-going problem..

Socket Messages
This logging setting records the socket and messaging trace information used by the Prophet application,
including the ports used. These messages include send and receive acknowledgements from the worker
machines while performing compilation and runtime tasks. This log level is usually used for troubleshooting and
debugging purposes when trying to diagnose an on-going communication failure between Prophet worker
machines.

Debug Messages
This logging setting contains detailed information regarding all the operations performed by the Prophet
services and tasks associated with a Prophet run while it is in progress. It is especially useful for Prophet
developers. This setting has the potential to generate a considerable amount of data and increases disk space
usage substantially. This setting should only be selected if advised by SunGard support personnel.

Extended Debug Messages


This is a verbose version of the debug messages setting. It is especially useful to Prophet developers. This

Worker logging

769

setting has the potential to generate a considerable amount of data and increase disk space usage
substantially. This setting should only be selected if advised by SunGard support personnel.
You can do any of the following:
n

Choose the logging settings that are required and click Apply to set them.

To select all logging options click All.

To return the settings to those currently in force, click Get Current.

To return the settings to their default values, click Restore Defaults.

Note the following:


n

Changes are applied immediately when you click Apply and do not require any services to be restarted.

The generated logs are stored in the Program data area of the host machine.
For example, C:\ProgramData\SunGard\Prophet80\Prophet.Logs.

Redundant logs should be cleared periodically as they can take a considerable amount of disk space.

When a Prophet run issue has been identified and fixed the Worker Logging settings should be reset to their
default values.

Worker logging settings are reset to their default setting if the broker service for the Worker machine is restarted
or the machine is rebooted.

770

771

C H A P T E R

2 1

Using Prophet Enterprise Resources

TOPICS IN THIS CHAPTER


Overview

772

Push to PE - Prophet Professional settings

773

Push to PE - Prophet Enterprise settings

774

Running a model using Prophet Enterprise resources

776

772

Chapter 21 Using Prophet Enterprise Resources

Overview
Prophet Professional can use Prophet Enterprise resources to run models. This is especially useful when
processing complex models that have large memory and processing requirements. This feature is known as Push
to PE.
To enable Prophet Professional to access Prophet Enterprise resources it requires access to a Prophet Enterprise
system . In addition, the following requirements are also required:
n

System requirements
Prophet Enterprise Studio and the Prophet Enterprise APImust be installed on the same machine as Prophet
Professional. In addition, both systems must be at the same release. Hence, the Push to PE feature requires
Prophet Professional Release 8.2 to be used with Prophet Enterprise Release 8.2.

Prophet Enterprise configuration


Prophet Enterprise has to be configured to allow runs initiated from Prophet Professional to use Prophet
Enterprise resources. This involves specifying the compartments, machine groups and core settings that are
used to process the Prophet models.

Prophet user profile


A Prophet user profile using Windows authentication has to be set up in the Prophet Enterprise system.

Workspace sharing
Prophet workspaces must be available and accessible to both systems. Ideally,shared workspaces should be
stored be on a file server and have the appropriate read and write permissions.

More information on each of these items is described in the following sections.

Push to PE - Prophet Professional settings

773

Push to PE - Prophet Professional settings


Settings for each workspace using the Push to PE feature are specified in the Prophet Enterprise setting of the
Options dialog box in Prophet Professional. The Options dialog box appears similar to the following:

A valid URLpointing to the Prophet Enterprise Web Server must be entered into the Server Location text box. The
location also needs to be validated by clicking Validate. Once validated, the version of Prophet Enterprise running
on the web server is displayed in the Server Version text box.
A unique id also needs to be entered into the Workspace ID text box which identifies the workspace to the Prophet
Enterprise worker machines.
Note: These settings must be applied to each workspace that is used to run models on the Prophet Enterprise
server.

774

Chapter 21 Using Prophet Enterprise Resources

Push to PE - Prophet Enterprise settings


Settings for each user or a group of users using the Push to PE feature are specified in the Prophet Professional
Job settings dialog box in Prophet Enterprise Studio. Once specified, users can initiate Prophet runs from within
Prophet Professional that are processed using the Prophet Enterprise infrastructure.
To display the Prophet Professional Job Settings dialog box:
n

In Prophet Enterprise Studio click PP Jobs on the Administration tab.

The Prophet Professional Job Settings dialog box appears similar to the following:

For each Prophet Enterprise user or group, specify the Compartment, Machine group, the maximum number of
preparation machines and the maximum number of runtime cores that can be used by a Prophet Professional run. If
no settings are specified for a user then the default settings specified in the dialog box are applied.
Once the job settings for Prophet Professional users have been specified click OK.
Note the following:
n

The Prophet Professional user must have a Prophet Enterprise account which is accessed using Windows
Authentication.

The workspace used for Prophet runs must be accessible to both Prophet Professional and Prophet Enterprise.

Push to PE - Prophet Enterprise settings

775

To run a model from Prophet Professional using Prophet Enterprise resources the Prophet Enterprise option in
the Runtime Configuration of a run setting must be selected.

For more details on how to set up the Prophet Professional Job Settings dialog box refer to the Prophet Enterprise
Studio documentation.

776

Chapter 21 Using Prophet Enterprise Resources

Running a model using Prophet Enterprise resources


A run can be submitted to Prophet Enterprise from Prophet Professional once the Push to PE feature has been
configured in Prophet Professional and Prophet Enterprise .
To use the submit a run from Prophet Professional:
Do ONE of the following:
n

Open the Run setting for the run and select the Runtime Configuration tab, OR
Open the Run Pairing for the run.

In either case, in the Method of Run section, choose Prophet Enterprise.

If necessary, click Settings to adjust the Prophet Enterprise settings for the workspace.
Save the Run Setting / Run Pairing and start the run by clicking Run from the Home tab.
Viewing results
When the run has completed you can view the results using the Prophet Professional Results Viewer.

777

C H A P T E R

2 2

Workspace utilities

TOPICS IN THIS CHAPTER


What workspace utilities are available?

778

How workspaces are organised

779

Backing up a workspace

782

Restoring a workspace

785

Compacting a workspace file

787

Creating a template workspace

788

778

Chapter 22 Workspace utilities

What workspace utilities are available?


The workspace is the environment in which you work in Prophet. Workspaces hold your data, calculation
specifications and results.
A number of utilities are supplied to maintain the overall workspace environment. The utilities, which are accessed
from the Utilities tab, allow you to:
n

Backup workspaces

Restore workspaces

Compact workspaces

Install a template workspace

In addition, if you have Administrator permissions to a workspace then you can set the date and time information for
a workspace, its products and variables using the Reset Workspace setting in the Options dialog accessed from the
Prophet menu.

How workspaces are organised

779

How workspaces are organised


A workspace consists of a number of files in a folder and its sub-folders. In Prophet, the folder is referred to as the
workspace location.
The main file in the workspace location is Prophet.prw. This is the file which Prophet uses to identify a workspace
location and is usually referred to as the workspace file. Opening this file will open the workspace in Prophet. Files
that are stored in a workspace location include:
n

The workspace file

Model point files and tables

Results

Run process files

Microsoft Excel workbooks

Organisation of the workspace file


Most Prophet objects are stored in the workspace file. The name of this file is always set to Prophet.prw and
contains the following main objects:
n

Libraries and their contents

Products and their contents

Accumulations

Structures

Run Settings

Actuarial documentation

780

Chapter 22 Workspace utilities

Organisation of model points files and tables


Model point files and tables are normally stored in sub-folders of the workspace location. However, you can also
specify table locations which are outside of the workspace location. This option enables these files, which may in
some cases be extremely large, to be generated using other software applications and stored in a more convenient
location. You specify these table locations using the Table Locations section of Options (accessed via the Prophet
button).
Model point files and tables outside of the table locations may be opened from the Table Editor in Prophet but may
then only be saved in a specified Table Location. This option enables tables created using other software
applications to be effectively imported into the workspace. You may also copy such tables directly into the
appropriate sub-folder.
When you use the Workspace Backup options only the files and tables within the workspace location are backed
up or copied. Therefore, if any files are stored outside of the workspace location, you will need to back these up
separately.

Organisation of results
Results are stored in sub-folders of the workspace location. These sub-folders are all stored in the Results folder
and are named RUN_ followed by a two digit run number, for instance RUN_01. These folders store the results for
each product and accumulation in addition to the most recent run and error logs. You cannot specify these as Table
Locations.
You should never copy or delete any of these files except from within Prophet. Generally, you should never need to
refer to them from outside Prophet or Prophet Excel Reporting.

Organisation of Microsoft Excel workbooks


Although you can save the Microsoft Excel workbooks you set up using Prophet Excel Reporting in any location, we
recommend the following:
n

Sales Generator workbooks should be saved to an appropriate Table Location. That way, they will be
automatically backed up with their associated tables.

How workspaces are organised

781

Microsoft Excel workbooks containing Prophet results should be saved within the workspace location or any of
its sub-folders. That way, they can be automatically backed up with the workspace.

782

Chapter 22 Workspace utilities

Backing up a workspace
Always make regular backups of your Prophet workspaces. These backups should also be kept off site for security
and safety reasons. A backup of a complete workspace also allows you to restore it to another computer or to
another drive on a network. You can include the following in the backup:
n

All files and folders in the workspace location

The workspace file and query files only

The workspace file, queries, tables and model point files

The workspace file, queries, tables, model point files, and generated products

The workspace file, queries, tables, model point files, generated products and results

Note that although queries are not available in Prophet Professional 8.0 and later, queries created in earlier
versions of Prophet may still be backed up.
To back up a workspace:

Backing up a workspace

783

1. Close the workspace you want to back up.


2. On the Utilities tab click Backup. The Backup Workspace dialog box appears.

3. In the Select Workspace list, click the workspace to back up, or click Browse to navigate to and select the
workspace.
4. In the Copy to location group, assign a location, name and description for the workspace.
Tip: Give the backup a description which will help you decide what it contains, if you ever need to restore it.
You can express the path to the location using either of the following formats:
K:\PROPHET\BACKUPS\2008.PBU
\\EPS-S129\PROPHINS\PROPHET\BACKUPS\2008.PBU

Note: Prophet creates a new folder if the location for the backup does not already exist.
5. In the Items from Workspace Location group click the type of backup you want to perform.
Note the following:

784

Chapter 22 Workspace utilities

When tables and model point files are included in the backup, all files in all of the Table Locations within the
workspace are included.

When the generated products are included in the backup, all files in all library sub-folders are included, as
well as additional files in the workspace location. Sufficient files are included to enable the products to be
run without regeneration, if the backup is subsequently restored for use.

When the results are included in the backup, all files in the results sub-folders are included in the backup.

The backup file is given a .PBU file name extension.

6. Click OK. Prophet performs the backup and displays the progress in a dialog box.

To stop the backup click Stop.

Restoring a workspace

785

Restoring a workspace
Only backups created using the Prophet workspace backup option can be restored
To restore a workspace, click Restore... in the Utilities tab. The Restore Workspace dialog box appears.

From the Restore Workspace dialog box either enter the location and backup file to be restored or click Browse to
navigate to and locate the backup file. Backup files have a .PBU file name extension. Next, enter the location for the
restored workspace or again click Browse to navigate to the required location.
Note: A folder and sub-folders are created if the restore location does not exist.
When you click OK Prophet performs the restore and displays the progress in a dialog box.

786

Chapter 22 Workspace utilities

To stop the restore click Stop.

Compacting a workspace file

787

Compacting a workspace file


Each workspace file contains the majority of the data required by a Prophet workspace. As this file is updated over
time it will gradually become fragmented and its performance will begin to suffer. It will also become a larger file
than it needs to be. To rectify this situation you use the Prophet compact workspace option.
You should always consider compacting a workspace file when you have made a large number of changes to the
libraries and products in a workspace.
The compact workspace file option is accessed using the Compact option in the Utilities tab.

Compacting an open workspace file


Prophet can only compact a workspace file when the workspace is closed. Therefore, if you choose to compact an
open workspace Prophet first closes the workspace, performs the compact operation and then re-opens it.
To start the compact operation, click Compact... in the Utilities tab.
During the compact operation, Prophet reorganises the workspace file to remove any fragmentation and deleted
data which is likely to create a loss in performance. Prophet re-opens the workspace when the compact operation
has finished.

Compacting a closed workspace file


To compact a closed workspace file, click Compact... in the Utilities tab. From the Select Workspace to be
Compacted dialog box select the workspace to be compacted. Alternatively, click Browse to locate it.
To start the compact process on the selected workspace click OK.
During the compact operation Prophet reorganises the workspace file to remove fragmentation and deleted data
which is likely to create a loss in performance.
Click OK when the compact operation has finished.

788

Chapter 22 Workspace utilities

Creating a template workspace


If you have a standard workspace that is normally used as a starting point for development then it can be saved and
used as a template workspace. The workspace is saved as a template in the location specified during the
installation of the Prophet standard workspace. Typically, for a 64-bit operating system the location is: C:\Program
Files (x86)\SunGard\Prophet Professional\STD Workspaces.
Note: Before you can use a workspace created in an earlier version of Prophet as a template it must be first
upgraded by opening and then saving it in the current version of Prophet.
To use an existing workspace as a template workspace:
n

Ensure that the workspace to be used as a template is not open.

From the Template menu of the Utilities tab choose Create Template

The Install Template Workspace dialog box appears displaying a list of the previously used workspaces sorted
by Description. Location and Current User:

Either select an existing workspace from the list to be used as a template workspace or click Browse and
navigate to and select a workspace in another location.

Creating a template workspace

789

Choose the items to be included with the selected workspace. You can choose to have all or a subset of the files
and folders in the selected workspace location to be saved as a template.

In the Template Name text box, enter the name of the template workspace which will be displayed in the
dropdown list of the Create New Workspace dialog box.

Click Install to copy the selected workspace into the standard workspace location as specified during
installation. Workspaces saved in this location are subsequently available to create new workspaces based on
them.

Note the following:


n

A template workspace is saved in a sub-folder of the standard workspace location that was specified during
installation. The name of the sub-folder is the same as the template name specified in the Install Template
Workspace dialog box.

To upgrade a template workspace created in an earlier version of Prophet Professional choose Upgrade
Template from the Template menu of the Utilities tab. See Upgrading a template workspace in help.

To delete an existing template workspace choose Delete Template from the Template menu of the Utilities
tab.See Deleting a template workspace in help.

Template workspaces are used to create new workspaces using the Create New Workspace dialog box.

790

791

C H A P T E R

2 3

User permissions

TOPICS IN THIS CHAPTER


What are user permissions?

792

Using Prophet Administration

795

Managing workspace permissions

811

792

Chapter 23 User permissions

What are user permissions?


The user permissions feature allows an administrator to manage and control the access rights to Prophet and its
workspaces of users running Prophet on a PC network.
The main requirement for implementing user permissions is to assign a person, known as an administrator, to be
responsible for the management and control of the Prophet installation and its workspaces.
When Prophet is initially installed the user permissions facility is disabled. Users can thus perform any tasks in any
workspace without having to enter a password.
To enable the user permissions feature the administrator must:
n

Run the Prophet Administration program to set up user and group access rights to Prophet and its workspaces
by registering user names and passwords

Use Prophet to apply restrictions to tasks that can be performed by a user or group of users in particular
workspaces.

When user permissions is enabled, only those users that the administrator has specified are able to run Prophet.
Restrictions can be applied to new and existing workspaces. They can also be changed by a user that has been
granted sufficient rights by the administrator.
Note: Users should also have full control permissions for the folders which contain their workspaces. This is set
within Windows rather than within Prophet.

Types of restrictions
The restrictions that can be applied to a workspace by a user or administrator are:
n

Editing a product

Editing a library

Performing runs

What are user permissions?

Viewing results

Changing permissions

793

The administrator can also prevent users or groups of users from creating new workspaces.
Note the following:
n

Details of the users and groups together with their permission settings are stored in a permissions database set
up during the Prophet installation.

The permissions database is managed by the Prophet Administration application which is run by the designated
Prophet administrator.

The standard server backup procedure should be used to keep backup copies of a permissions database
resident on a network server. If the permissions database is corrupted or deleted then the Prophet server
installation must be performed again to recreate the database. User permissions are then set up again by the
administrator using the Prophet Administration.

To allow users of portable computers to work on copies of workspaces that have restrictions when away from
the network they must have a copy of the permissions database on their computer. For Windows 7 and Vista the
location of the database is: C:\ProgramData\SunGard\Prophet80\FULL_ACC\PROADMIN.IB
Note: Users must have administrator rights and a copy of the Prophet Administration application on the
portable computer.

Restrictions to Prophet and specified workspaces can be set up by the administrator based on either the
Prophet or Windows user logon.

If a user has access rights to create a workspace, then that user becomes the owner of the new workspace and
can set up restrictions for that workspace. The restrictions can however be changed by another user that has the
same rights as the originator of the workspace.

The administrator can apply access rights to any workspace and can also override any restrictions placed on
the workspace by a user. Restrictions placed by the administrator on a specified workspace cannot be changed
by any user other than the administrator.

794

Chapter 23 User permissions

Checking workspace restrictions


A user can always determine the restrictions placed on a workspace by viewing the property settings for the open
workspace in Prophet.
To display the permissions settings:
1. Click the Prophet button and on the Prophet menu click Options. The Options dialog box appears.
2. On the Options dialog box click Workspace Properties. The Workspace Properties dialog box appears.
3. In the Workspace Properties dialog box click the Permissions tab.
If you have sufficient rights as determined by your Prophet or Windows logon then you can apply or remove any
restrictions to the open workspace.
For information on the Workspace Properties dialog box see Workspace Properties settings on page738.

Implementing user permissions


To set up and implement user permissions you need to:
n

Use the Prophet Administration program to create users and groups and configure their access rights to Prophet
and its workspaces.

Use the Prophet Administration program to enable the permissions settings.

Enable permissions settings to take effect when using the Prophet or network login.

Open and apply restrictions to workspaces used by users and groups.

The creation and management of access rights for users and groups and the handling of workspace restrictions is
covered in the following sections. For information on the network server installation of Prophet please refer to the
Prophet Technical Guide.

Using Prophet Administration

795

Using Prophet Administration


Permissions are created and maintained by a System Administrator using the Prophet Administration application.
Users that do not have administration rights on their machines cannot run or use the application. Prophet
Administration is installed in the Prophet system location and for extra security can be removed from some PCs.
Starting Prophet Administration for the first time
When you start Prophet Administration and no permissions database exists then you are presented with the
Prophet Administration application which apears similar to the following:

Permissions database
Select Use Permissions Database and enter or browse to the location of the permissions database that contains
the details of the access rights of users and groups. Initially, the database resides in the Full_Acc folder of the
Prophet system location, for example, C:\Program Files\SunGard\Prophet Professional\Full_Acc. It can however, be
copied and moved to a network server location where it can be accessed by other users.
Note the following:

796

Chapter 23 User permissions

You need administrator rights to specify the location of the permissions database.

If you wish to set up a permissions database that can be accessed from a network drive by other users then it is
recommended that you copy and move the database in the Prophet system location (for example, C:\Program
Files\SunGard\Prophet Professional\Full_Acc\PROADMIN.IB, or C:\Program Files (x86)\SunGard\Prophet
Professional\Full_Acc\PROADMIN.IB), before assigning permissions. You then point Prophet Administration to
the new network location to manage Prophet permissions.

Each Prophet User must have access to the same permissions database.

Starting Prophet Administration with a an existing database


If a permissions database already exists then the following login dialog is displayed when you start Prophet
Administration:

Enter the following:


Username and password
The username is initially set to ADMINISTRATOR and the password is "prophet". Note that the password is case
sensitive. You can subsequently change the username and password from the Edit User dialog by selecting the
User and from the edit section of the Home tab clicking Edit. For more information see Editing user details.
When you click OK, the username and password are validated and if they match the entry in the permissions
database, the main Prophet Administration window is displayed.

Using Prophet Administration

797

Prophet Administration overview


After starting the Prophet Administration program and completing the Prophet User Login dialog box the main
Prophet Administration window is displayed.

From the Prophet Administration window you can display the following views by selecting them from the Objects
section of the Home tab:
n

Users View
This displays the currently assigned users together with the groups that they belong to and any permissions that
are set. From this view you can create, edit and delete user details. You can assign permissions to users and
also add or remove users from groups specified and managed in the Groups view.

Groups View
This displays the currently assigned groups together with the users that they contain and any permissions that
are set. From this view you can create, edit and delete details of a group. You can also set permissions to a
group and add or remove users from groups.

798

Chapter 23 User permissions

Permissions View
This displays the permissions granted to users and groups. From this view you can apply or remove
permissions from users or groups.

When Prophet is first installed two users are defined which cannot be removed:
n

Administrator
This user has all the available permissions applied. You can only change the description and password for this
user.

Guest
This user does not have the "Create Workspace" permission applied which cannot be changed. You can only
change the description and password for this user.

Similarly, the Administrator and Guest groups in the Groups view cannot be changed.
Activating user permissions
Once you have set up the Prophet users they will need to enter a user name and password in order to access
Prophet.
Alternatively,if a user is set up to use a network login then setting Use Network Login from the Options section of
the Home tab enables them to be automatically logged in after starting Prophet.

Enabling permissions
Permissions are enabled on each machine by a System Administrator who has admin rights. For permissions to be
enabled for a user their machine must be configured by a System Administrator using Prophet Administration to
point to a central permissions database located on a network.
Once permission are enabled on a machine a user will have to log in to access and use Prophet.
Using Network login
A user can either be set up to use a specified user name and password or alternatively be allowed access using the
user's Windows network user name and password. To enable a user to login into Prophet using their network
credentials click Use Network Login in the Optionssection of the Home tab:

Using Prophet Administration

799

Changes are effective when the users specified in the permissions database next start Prophet.
Note the following:
n

To disable the Network login click Use Network Login to unselect it.

To stop using the permissions database and allow all users unlimited access to Prophet workspaces click
Disable Permissions from the Options section of the Home tab.

Implementing a Prophet network login


To implement a Prophet network login the designated Prophet Administrator has to allow each Prophet user to use
their network login instead of the standard Prophet login to start and use Prophet. To do this the Prophet
Administrator must:
n

In the Edit User dialog box for each Prophet user, choose the "Network User" option and enter the same name
for the user as used for their Windows login.

In the Optionssection of the Home tab click Use Network Login.

Assuming these conditions are met the Prophet login dialog box is not displayed when the user starts Prophet since
the network login is assumed to be secure. If a network user with the same name is not found in the permissions
database when Prophet is started then the Prophet Login dialog box is displayed and the user is prompted for a
name and password.
Using a network login is preferred to using the Prophet Login because:

800

Chapter 23 User permissions

A user does not need to enter a name and password to start Prophet, and

Passwords do not need to be maintained by the Prophet Administrator.

Although a network login is preferred to a Prophet login there is a drawback. The user name itself may not be
unique. It is possible for the user name to exist in multiple domains or workgroups. For example, the
ADMINISTRATOR user may exist in the NTSERVER domain and workstation PC123.

Disabling user permissions


If user Permissions are no longer required then you can disable the database for all users as follows:
To disable user permissions:
n

If not done, start Prophet Administration by locating ProphetAdministration.exe in the Prophet system folder.

When prompted, enter the Administrator user name and password in the Login dialog box.

To disable the Permissions database click Disable Permissions from the Options section of the Home tab.

The Permissions database will be disconnected to all users and allow them to access and edit all features of
shared Prophet workspaces.
Note the following:
n

The Permissions database is not deleted and can be used again at a later date.

To re-enable user permissions you can reconnect to the existing database using the Select Permissions DB
option in the Home tab. Alternatively, you can create a new Permissions database using the New Permission
DB option in the Home tab.

Using Prophet Administration

801

Setting up users
You create and manage users from the Users view of Prophet Administration which is displayed when you click
Users in the Objects section of the Home tab.

A list of the currently configured users is displayed in the left pane. When you select a user in the left pane, the
permissions granted to the selected user and the groups to which the user belongs are displayed in the top right
and bottom right panes respectively.
From the Users view you can:
n

Display the permissions granted to a user selected in the left pane.

Display the groups to which the selected user belongs.

Create or delete a user.

Edit the name, password and login settings for an existing user.

After you set up a user you can grant permissions to the user from the Permissions view. You can also add the user
to a group which is managed in the Groups view.

802

Chapter 23 User permissions

Creating a User
Users that have access to Prophet and its workspaces are created in the Users view of Prophet Administration. To
create a user:
n

Select the Users view in Prophet Administration which is displayed when you click Users in the Objects
section of the Home tab.

From the Edit section of the Home tab click New.


Alternatively, select a user in the left pane and from the right click menu choose New.

The Create User dialog box is then displayed.

Details entered in this dialog box determine which user login is used to access Prophet.
n

If the user is a Prophet User then the user name and password entered in this dialog box are those that must
be entered in the Prophet user login when that user starts Prophet.

If the user is a Network User then the network login that the user has to enter to logon to the network is
deemed to be sufficient to use Prophet. In this case the Prophet User Login dialog box is not displayed when the
user starts Prophet.

In this dialog box you specify:


n

Name
For a Network User, the name must be the same as the network login user name. For Prophet and Network

Using Prophet Administration

803

users, the name can be up to 24 characters in length including spaces. The name is not case sensitive.
If you are configuring the user to use a secure network login using the NT Domain name then you must choose
Network User and prefix the name of the user with the name of the NT domain. For example, a user named
Peter has a network login name of NTServer1\Peter where NTServer is the NT domain name.
Administrator and Guest are reserved user names and cannot be changed.
n

Description
Enter a short description that describes the group and rights granted to the user. The description can be up to
100 characters in length including spaces.

Password
A password is only required if the Prophet User login is used. The password that you enter is case sensitive and
can consist of up to 12 characters including spaces. You can also specify an empty password.

Confirm Password
The Confirm Password is only required if the Prophet User login is used. The entry in the Confirm Password text
box must be the same as that in the Password text box.

When you click OK the new user name is added to the list of users in the left pane of the Users view. If required, you
can now add the user to a group in the Groups view.

Editing user details


You edit all aspects for a selected user from the Users view which is displayed when you click Users in the Objects
section of the Home tab.
To change a users login settings name, description and password:
n

Select the user in the list of users pane.

From the Edit section of the Home tab click Edit.


Alternatively, double click the name of the user in the left pane of the Users view. The Edit User dialog box is
displayed.

804

Chapter 23 User permissions

Update the user login settings, name, description and password as required and click OK to apply the changes.

To apply or remove permissions for a user:


n

Select the user in the list of users pane.

Select or deselect the permissions in the permissions pane applicable to the user

To apply or remove a user from a group


n

Select the user in the list of users pane.

Select or deselect the group in the groups pane applicable to the user

The changes are applied to the permissions database immediately.


Note: You cannot change the name for Administrator or Guest as they are reserved names.

Removing a user
If a user is no longer needed you can remove the user from the Users view as follows:
n

Select the Users view in Prophet Administration by clicking Users in the Objects section of the Home tab.

In the left pane, select the user to be removed

Using Prophet Administration

From the Edit section of the Home tab click Delete. When prompted, click Yes to delete the selected user.

The selected user is then removed from any groups and from the permissions database.
Note: You cannot remove the Administrator or Guest user as they are reserved user types.

805

806

Chapter 23 User permissions

Setting up groups
You create and manage groups from the Groups view of Prophet Administration which is displayed when you click
Groups in the Objects section of the Home tab.

A list of the currently configured groups is displayed in the left pane. When you select a group in the left pane, the
permissions granted to the selected group and the users belonging to the selected group are displayed in the top
right and bottom right panes respectively.
From the Groups view you can:
n

Display the permissions granted to a group selected in the left pane.

Display the users that belong to the selected group.

Create or delete a group

Edit the name and description of an existing group.

Using Prophet Administration

807

After you set up a group you can grant permissions to the group from the Permissions view. You can also add users
to a group in the Users or Groups views.

Creating a group
To create a group:
n

Select the Groups view in Prophet Administration which is displayed when you click Groups in the Objects
section of the Home tab.

From the Edit section of the Home tab click New. Alternatively, select an existing group in the left pane and from
the right click menu choose click New.

The Create Group dialog box is displayed.

In this dialog box you specify:


n

Name
This is the name of the group which can be up to 24 characters in length including spaces. The name is not
case sensitive.

Description
Enter a short description of group that describes the permissions granted to the group. The description can be
up to 100 characters in length including spaces.

808

Chapter 23 User permissions

When you click OK the new group name is added to the list of groups in the left pane of the Groups view. If required,
you can now add users to the group in either the Users or Groups views.

Editing group details


You can only edit the name and description of a group selected in the Groups view which is displayed when you
click Groups in the Objects section of the Home tab. You cannot edit the Administrator or Guest groups.
To change or update the name or description applied to a group:
n

Select the group listed in the left pane.

From the Edit section of the Home tab click Edit. Alternatively, double click the name of the group in the left
pane of the Groups view. The Edit Group dialog box is displayed.

Update the group name and description as required and click OK to apply the changes.

To apply or remove permissions to the selected group:


n

Select the Group in the left pane.

Select or deselect the permissions applicable to the group.

To add or remove a user from a group

Using Prophet Administration

Select the Group in the bottom pane.

Select or deselect the user.

809

The changes are applied to the permissions database immediately.

Removing a group
When a group is no longer required you can delete it from the Groups view as follows:
n

Select the Groups view in Prophet Administration clicking Groups in the Objects section of the Home tab.

In the left pane, select the group to be removed

From the Edit section of the Home tab click Delete. When prompted, click Yes to delete the selected group.

The selected group is then removed from the permissions database. Note that any users in a group that is deleted
are not themselves deleted.

810

Chapter 23 User permissions

Applying permissions
You apply Permissions from the permissions view of Prophet Administration which is displayed when you click
Permissions in the Objects section of the Home tab.

A list of the current permissions is displayed in the left pane. The selected permission can be applied or removed
from the users and groups that are displayed in the top right and bottom right panes respectively.
Note the following:
n

You cannot edit or remove any permissions.

The only permissions that you can apply or remove from a user or group is Create Workspace. The other
permissions such as being able to edit products or perform runs are specified for each individual workspace.

You should normally apply this option to all users and groups. Otherwise users are unable to create copies of
the standard workspace in order to run the tutorials.

You can only apply or remove permissions for users or groups that you create. You cannot edit the permissions
for the default administrator and guest users and groups.

Managing workspace permissions

811

Managing workspace permissions


Before permissions can be applied to a workspace the user permissions feature must be enabled. This is done from
the Settings section in the Home tab of Prophet Administration by a user that has Administrator rights.
When permissions are enabled, the workspace permissions can be applied to an open workspace from the
Workspace Permissions setting in the Options dialog box which is accessed from the Prophet menu. For a
workspace that has been created by the user and has not had any restrictions applied the setting appears similar to
the following:

812

Chapter 23 User permissions

If you are the creator of the workspace and currently have Create Workspace rights or have administrator rights
then you can do the following in the Permissions setting for the open workspace:
n

Permit full access to the workspace for all users or users belonging to any group.

Restrict access only to the Administrator and selected users or groups.


Note: Options in the Permission setting are unavailable to users that do not have Create Workspace rights.

813

Part 5 - Plugins Reference

The following provides information on:


n

Installing and licensing a plugin

Configuring plugins

Using Plugins in Prophet

Using plugins at runtime

Information on the supported versions of the plugins is also supplied.

814

815

C H A P T E R

2 4

Prophet plugins

TOPICS IN THIS CHAPTER


What is a plugin?

816

Installing plugins

818

Configuring plugins

820

Using plugins

822

Using plugins at runtime

824

816

Chapter 24 Prophet plugins

What is a plugin?
A Prophet plugin in provides additional functionality to a Prophet Model by supplying functions to perform specific
types of calculations. Plugins are installed and configured separately. They also require a licence before they can
be used.
Prophet currently supports Intex and Andrew Davidson. Other plugins will be supported as and when they become
available.
Supported Plugin versions
The currently supported versions of the Intex and Andrew Davidson plugins listed below.

Andrew Davidson support


Prophet 8.2 Update 3 supports the following versions of Andrew Davidson:
l

5.2h_p2

5.2i_p1

LDM v2.0.2
Note: Only the Andrew Davidson dlls listed above are supported in this update. Users are advised to update
their plugins to the latest versions available. Also note that in LDM v2.0.2 the new Loan Dynamics functionality
is not available. Prophet will return values from the old prepayment model which Andrew Davidson has
embedded inside LDM.

Intex support
Prophet 8.2 Update 3 and DCS 8.2 Update 3 support the following versions of Intex:
l

3.3c_p1

What is a plugin?

3.3d_p1

3.3e_p2

817

Note: Only the Intex Subroutines listed above are supported in this update.
Users are advised to update their plugins to the latest versions available. For example, Prophet users using
Intex 3.3c_p1 released with Prophet 8.2 Update 2 are advised to upgrade to the Intex 3.3c_p1 plugin released
with Prophet 8.2 Update 3.

818

Chapter 24 Prophet plugins

Installing plugins
Prophet plugins are installed and licenced separately. When you obtain a plugin it is supplied as an installation file
together with a product licence key.
Installing a plugin requires:
n

Installing the plugin using the supplied installation file.

Licencing the plugin using the Licence Manager.

Note that a separate product licence key is required for each version of the plugin that is installed on a machine. In
addition, the plugin must also be licenced on each machine that will use workspaces that use the plugin.

Installing a plugin
To install a plugin do the following:
n

Run the supplied installation file (usually a .msi file). Follow the on-screen prompts.

Depending on the plugin, it can be installed in the following locations:

Intex plugins
These are installed in sub-folders of the following location:
C:\Program Files (x86)\Common Files\SunGard\Plugins\intex
For example: Intex 3.3b_p1 is installed in:
C:\Program Files (x86)\Common Files\SunGard\Plugins\intex\Intex 3.3b_p1

Andrew Davidson plugins


These are installed in sub-folders of the following location:
C:\Program Files (x86)\Common Files\SunGard\Plugins\adco
For example: Adco 5.2.0f is installed in:
C:\Program Files (x86)\Common Files\SunGard\Plugins\adco\5.2.0f

Once the plugin is installed you need to enable the licence.

Installing plugins

Licencing the plugin


To licence the plugin do the following:
n

From the Windows Start menu, locate and start the Prophet Licence Manager.

Click the Activation tab and enter the supplied product licence key for the plugin:

Click Activate to apply the licence.

You can check that the licence has been validated by clicking Details and locating the plugin entry in the
displayed list.

Click Exit to close Licence Manager.

Once the plugin is installed you need to configure the plugin to the Prophet Professional application.

819

820

Chapter 24 Prophet plugins

Configuring plugins
Once a plugin is installed and licenced it needs to be configured and made available to the workspaces used in the
Prophet Professional interface. Plugins are configured and made available to Prophet workspaces using the
Plugins setting of the Options dialog box.
To configure a plugin:
n

Ensure that a Prophet workspace is open.

Click the Prophet button and from the menu click Options.

From the Options dialog box choose the Plugins setting:

For each listed plugin do the following:

Choose the version of plugin from its Version dropdown. Note that choosing Latest Version always uses the
current version.

Enable or disable the plugin by selecting or clearing the Enable checkbox.

Note the following:

Configuring plugins

821

Only those Plugins that are installed are displayed in the Options dialog box. If a Plugin is subsequently
uninstalled it is also removed from the dialog box.

To make the plugin available to a model it must be enabled in the Options dialog box.

If a model uses a plugin then the locations of the data files for a plugin are specified in the Plugins tab of a Run
Setting. The location data is only available if the plugin is enabled in the Options dialog box.

The version of the Intex library selected in the dropdown list is only checked at runtime. If the version of the
installed Intex library does not match that specified in this dialog box then a runtime error is generated.

822

Chapter 24 Prophet plugins

Using plugins
Once a plugin is installed, licenced and configured it is ready to be used. Since plugins are used to supply
additional functions the related plugin functions will appear in the Function Wizard. For example, Intex functions are
displayed in the Function Wizard as follows:

In addition, if you have Auto-Complete enabled then the function parameters are displayed as soon as you start to
enter the plugin function name:

Note the following:

Using plugins

823

If the plugin is not enabled in the Plugin settings of the Options dialog box then the related plugin functions do
not appear in either the Function Wizard or in Auto-Complete.

The version of the plugin is only checked at runtime. If the version of the installed plugin does not match that
specified in the Options dialog box then a runtime error is generated.

824

Chapter 24 Prophet plugins

Using plugins at runtime


Some plugins have specific runtime settings that are specified in the Run Settings for the run. In particular, the
following plugins have run time settings that are specified in the Plugins tab of a run setting:
n

Andrew Davidson

Intex

A typical Plugin tab of a run setting appears as:

Separate sections are available to cater for the Andrew Davidson and Intex plugins. If a plugin is not enabled in the
Plugins setting of Prophet Options dialog box or is not installed then the settings are not available. For details on
the setting see: Run Settings - Plugins tab.

Using plugins at runtime

825

826

827

Index

B
Batch Comparison of Products - Options tab 211
Batch Comparison of Products - Products tab 211
Batch Programs
Run setting 426

C
A

Calculated Variables
Structures 370

Accumulations 96
Creating 344
Editing 346-347, 349
Editing sub-product ranges 350
Managing 341
Printing 352
Processing 468
Properties 343
Running an accumulation 352
Actuarial documentation 92, 102
Actuarial Documentation
Structures setting 386
Actuarial libraries
What they are 93
Advanced options
Structure 373
AIDS tables 130
Analysis of movements 51
Array variables
Functions 607
Multiple discount rates example 604
Asset/liability modelling
Introduction 45
Auto-scan and Regeneration options 203

Calculation Engine settings 741


Calculations
Debugging using Diagram view 108
New Business calculations 105
Parallel processing 104
Product calculations 468
Results 106
Run log 106
Running products 103-104
Changing run pairings 454
Changing the definition type 162
Clearing Modified and Modified By details 741
Code compilation 467
Code generation 467
Running products 103
Codes and categories 123
Comparing products 205
Comparison toolbar 213
Compilation
Running products 104
Compiler settings 704
Configuring plugins 820
Configuring Slave PCs before running a Parallel PC run 472
Connected Machines dialog 476
Constant definition 180

828

Index

Constant definitions 122

Settings 335, 752

Copying results in a Results window 310

Diagram View 496

Creating

Dimensions settings 686

Accumulation 344
Product 142
Run setting 410
Structure 362

Displaying
Names and Descriptions 248
Results 303, 493
Duplicating

Table 236

Product 201

Table category 726

Run setting 412

Table details 727


Creating a new query 543

Structure 363
Dynamic projections 45
Dynamic properties

D
Data Conversion System
See DCS 133
DCS
Data conversion process 134

Run setting 419


Dynamic runs
Dynamic Periods settings 385
Structure settings 384

What is it? 133


Definition types 162
Definitions
Variable definition types 120
Deleting
Existing results files 466
Input variable in a product 163

Editing
Accumulation 346-347
Product 199
Editing a query 542
Enumerations
Settings 681

Product 200

Example Model Office

Results 501

Accumulations 485

Run setting 411

Liability products 483

Structure 363

Model point files 484

Deleting input variables 203

Overview 483

Describing

Results 488

Mmodel point groupings 706

Run Settings 488

Run numbers 706

Running 489

Sub-products 706

Structures 487

Diagram view
Debugging calculations 108

Summary Product 485


Tables 486

829

Examples of table format generic tables 258

Generic Table 255

Experience analysis

Column format 261

Glean 52

Definition 182

Exporting

Definitions 256

Results 525

Generic tables 130

Run logs and results 525

Global File 263

Extended formulas 122

Definition 180
Definitions 263

F
FAC to FAS Convertor 274

Global files 127

Facility to create new variables 178


Find

How are results displayed? 304

Text in library variables 77


Find and Replace
Find/Replace section 83
Options section 85
Overview 80
Scope section 85
Start from section 84
Using within section 84
Finding and replacing data in a table 251
Finding data in a table 248
Finding text in variables 77
Formatting results in a Results window 308
Formula definition 170
Formula definitions 121
Formula Editor 171
Settings 754
Formula references to variable names 174
Function Wizard 174

I
Importing
Run logs and results 526
Index variables for a column format generic table 261
Index variables in a generic table 256
Indicator expressions 118
Indicator Selection Wizard 151
Indicators 115
Individual model point results 499
Initialising a table 238
Input and core variables 119
Insert
Array variable dimension 175, 599
Dimension 599
Enumeration 175, 177, 599
Local Variable 177
Variable 175, 599
Insert Variable/Dimension facility 175
Inserting product and variable names in a parameter file 270

General Insurance applications


Other 53
General Table Editor editing operations 244

Inserting statements 176


Inserting variable names in a global file 264
Inserting variable names in a model point file 266

830

Index

Inside libraries and products 115

Managing structures 358

Installing plugins 818

Managing tables and model point files 281

Intermediate results 500

Managing the input variables for a product 153

Intex

Memory settings 714

Specifying version used 709


Introduction to licensing 632

Structures 378
Method of run section 459
Miscellaneous settings 746, 748

L
Language
Settings 712
Libraries
Finding text in variables 77
Library Shield
Overview 628
LibraryShield
Introduction to licensing 632
Launching manually 629, 631

Model office
Projections 47
Model Point definition 180
Model point definitions in a model point file 265
Model point files 124, 265
Example Model Office 484
Mortality Table definition 185
Mortality tables 130, 268
MortalityTables location, Worker 744

Pre-release 8.0 workspaces 631


Using the application 629

Naming and saving year dependent mortality tables 279

Licensing pre-release 8.0 workspaces 631

Naming and saving generic tables 257

Logs

Naming and saving mortality tables 268

Using the run log viewer 530

Naming and saving sales files 271


Naming and saving year index tables 280

M
Machine Details dialog 475
Machine selection settings 763
Main Helpdesk 10
Managing
Runlogs 506
Managing accumulations 341
Managing input variables using Diagram view 156
Managing products 194
Managing queries 539
Managing results 501
Managing run settings 406

Naming and using a global file 264


Naming and using model point files 267
Naming and using parameter files 270
Naming and using unit prices files 278
New Business calculations
Cross multiplication 105
Group pension - new entrants 106
New business in model point file 105
Project new business method 105
New Business Method
Structures 371
New business processing 468

831

New Business Profile results 497

Variables settings 729

New query 543

Worker logging 767

New Table dialog 236

Worker Options dialog 744


Workspace options settings 702

O
Objects
Accumulations 96
Actuarial documentation 102

Workspace Permissions 731


Workspace properties 738
Overview of LibraryShield 628

Indicators 115
Libraries 93

Page setup in the Table Editor 285

Products 94

Parallel PC mode

Run settings 101

Configuring access rights 472

Structures 99

Overview 470

Tables 97

Requirements 471

Variables 118

Setting up a run 471

Online Manuals
Selecting manuals 6
Opening a query 542
Options

Specifying Worker PCs 472


Starting a run 478
Stopping a run 479
Parallel processing 104

Calculation Engine settings 741

Parameter definition 180

Compiler settings 704

Parameter file definitions 269

Customize GUI 746, 748

Parameter files 128, 269

Descriptions settings 706

Parameters section 456

Diagram view settings 335, 752

Permissions

Formula Editor settings 754


Intex setting 709
Machine selection settings 763

Managing for workspace 811


Pivot
Transposing query dimensions 549

Machine settings 739

Plugin runtime settings 824

Memory settings 714

Plugins

Product links setting 716

Configuring plugins 820

Prophet Enterprise Settings 717

Installing plugins 818

Quick Access Toolbar 765

Options dialog setting 709

Run log settings 719

Prophet plugins 815

Table details 725

Runtime settings 824

Table Options setting 750

Using plugins 822

832

Index

What is a plugin? 816


Primary & secondary input variables 120
Printing

Profit testing 48
Project new business method
New Business calculations 105

Accumulations 352

Projection results 497

Query 556

Projections

Results file list 501

Dynamic 45

Run log 528

Model Office 47

Run settings 449


Structures 364
Printing products 202
Printing results in a Results window 311
Printing tables 284

Stochastic 46
Prophet basics 41
Prophet Enterprise
Configuration settings 774
Push to PE Overview 772

Printing tables from within the Table Editor 285

Prophet Enterprise settings 717

Printing the product schedule 229

Prophet options 699

Product
Design process 141
Setting up 29, 139
Product array dimensions 165
Product links
Settings 716
Product Links
Adjusting 389
Structures 388

Machine settings 739


Workspace settings 702
Prophet programming language
Array variable functions 607
Prophet system structure 114
Public variable members 333
Public variables 333
Push to PE
Enterprise settings 774

Product properties 143

Overview 772

Product Schedule 217

PP settings overview 773

Dimensions view 228

Running a PP Model 776

Indicators view 226


Products tab 218
Text strings 223
Variables tab 219
Variables view 222
Window 221
Product status 198
Products 94
Profit recognition 50

Q
Queries
Charting 552
Charting options 554
creating a new query 543
editing a query 542
Hiding / showing query header 550
managing queries 539

833

opening a query 542

Results Viewer

Overview 535, 537

Definition folder 510

Printing a query 556

Execution folder 520

Query Options 547

Exporting run logs and results 525

Transposing dimensions 549

Filter toolbar 533

Query Options 547

Importing run logs and results 526

Quick Access Toolbar settings 765

Preparation folder 518


Printing a query 556

R
Re-scanning the input variables for a product 165
Regenerate section 462
Reporting
Displaying the results of a run 107
Microsoft Excel templates 113
Types of report 106
Using Microsoft Excel 111
Results 491
Consistency 502
Deleting 501
Displaying 493
Example Model Office 488
Individual model point 499
Intermediate 500
Managing results 501
New Business Profile 497
Printing results file list 501
Projection results 106, 497
Run and error logs 500
Run log 106
Stochastic 499
Types of 106
Types of results 497
Unit Numbers 498
Valuation 498

Printing a run log 528


Prophet Run Details view 508-509
Run Setting sub-folder 515
Structure sub-folder 512
Run
Displaying results of a run 107
Run log 106
Run logs
Audit folder 510, 522
Definition folder 510
Execute folder 520
Execution folder 520
Exporting run logs and results 525
Filter toolbar 533
Importing run logs and results 526
Managing 506
Preparation folder 518
Prepare folder 518
Printing a run log 528
Prophet Run Details view 508-509
Run Setting sub-folder 515
Structure sub-folder 512
Using the log viewer 530
Run logs and error logs 500
Run numbers in a global file 263
Run pairings run options 454

834

Index

Run settings 101


Plugins usage 824
Run Settings
Actuarial Documentation tab 448

Example Model Office 489


One or more run pairings 453
Single product comparison 206
Running products

Advanced Settings 421

Calculations 104

Batch Programs 426

Code generation 103

Creating 410
Deleting 411

Compilation 104
Runs 451

Duplicating 412

Accumulations processing 468

Dynamic properties 419

Code compilation 467

Error Control 439

Code generation 467

Example Model Office 488

Configuring access rights 472

General Run Parameters 416

Deleting existing results 466

Managing 406

Messages section 463

Method of Run 446

Minimising the run time 481

Options 413

New business processing 468

Plugins tab 431

Parallel PC mode 470

Printing 449

Parallel PC mode requirements 471

Properties 408

Product calculations 468

Results Files 435

Setting up a Parallel PC run 471

Results tab 434

Specifying Worker PCs in Parallel PC 472

Run Numbers 417

Split Run By section 460

Run Parameters tab 415

Starting a Parallel PC run 478

Run Process tab 422

Stopping a Parallel PC run 479

Runtime Configuration tab 443

The run process 464

Setting up Calculation run 410

Unit numbers processing 469

Split Run By 447

What happens during a run? 466

Stochastic Run 440


Stochastic Simulations 418
Tables tab 428
Text Results Files 437
Type of run 444
Running
An accumulation 352
Batch product comparison 209

S
Sales File properties 271
Sales files 132, 271
Saving a product 168
Saving a table 253
Segment table 272
Select table dialog 237

835

Selecting an alternative definition 161

Dynamic Periods 385

Selecting indicators for a product 147

Dynamic runs 384

Sets of results displayed in a Results window 306

Example Model Office 487

Setting up

New Business Method 371

Calculation run setting 410

Options 365

Setting up products 29, 139

Printing 364

Setting up tables 231

Product links 388

Settings

Products/Accumulations 366

Calculation Engine settings 741

Properties 362

Enumerations 681

Status 360

Formula Editor 754

Structure view 391

Machine settings 739

Sub-Product code

Workspace settings 702

Substitutions 386

Special index variables in a generic table 257


Specifying the input variables for a product 160

Structure View 391

Statutory valuation 49

Accumulation context menu 396

Stochastic File Converter 274

Display options 398

Stochastic projections 46

Hierarchy pane 395

Stochastic results 499

Levels pane 393

Stochastic Run

Link object context menu 397

Run Setting 440


Stochastic Simulations
Run setting 418
Stochastic tables 131, 273
Structure
Actuarial Documentation 386
Adjusting Product Links 389
Advanced options 373
Advanced settings- General 373
Advanced Settings - Memory 378
Calculated Variables 370
Configuration 369

Product context menu 396


Tables pane 400
Toolbar options 401
Using 392
Structures 99
Sub-Product code
Model point file 266
Substitutions 386
Summary Product
Example Model Office 485
Support
Contacting local support 10

Creating 362

Main Helpdesk 10

Deleting 363

System structure 114

Duplicating 363

836

Index

Debugging the calculation 108


Display results of a run 107

t-dependent extended formulas 122


Table category
Creating 726
Table data 243
Table definition types 123
Table details 725
Creating 727
Table Editor editing options 244
Table formatting options 247
Table locations 254
Table naming conventions 253
Table of Tables 276
Table Options setting 750
Table properties 242
Table validation 253
Tables
Example Model Office 486
Generic 130
Mortality tables 130
Stochastic 131
Types of table 97
Year dependent mortality tables 130
Year index 131
Templates
Creating workspace template 788
Terminology and Concepts
Accumulations 96
Actuarial documentation 102
Calculations 104
Code generation 103
Codes and categories 123
Compilation 104
Constant definitions 122
Cross multiplication 105

Extended formulas 122


Formula definitions 121
Generic tables 130
Global files 127
Group pension - new entrants 106
Indicator expressions 118
Indicators 115
Inside libraries and products 115
Libraries 93
Model point files 124
Mortality tables 130
New Business calculations 105
New business in model point file 105
Parameter files 128
Primary & secondary input variables 120
Products 94
Project new business method 105
Reporting 106
Reporting with Prophet Excel 111
Results 106
Run settings 101
Running products 103
Sales files 132
Stochastic tables 131
Structures 99
t-dependent extended formulas 122
Table definition types 123
Tables 97, 130
Time index values 123
Types of tables 124
Unit price files 129
Variable definition types 120
Variables 118

837

Workspaces 92
Year dependent mortality tables 130
Year index tables 131

Valuations
Statutory valuation 49
Variable definition options 169

Time index values 123

Variable groups displayed in a Results window 307

Time Index Values definition 193

Variable status 159

Type of run section 457

Variable types 158

Types of results 497

Variables

Types of table supported by the Table Editor 234

Alternative definitions 119

Types of tables 124

Array variables 120


Constant definitions 122

U
Unit numbers processing 469
Unit Numbers results 498
Unit prices files 129
Unit Prices files 278
Use of functions and expressions as indexes in a generic table 257
User Manuals
Selecting manuals 6
XML file format 6
Uses of Prophet
Analysis of movements 51
Asset / liability modelling 45
Dynamic projections 45
General Insurance applications 53

Default definition 119


Definition types 120
Extended formulas 122
Formula definitions 121
Input and core variables 119
Primary & secondary input variables 120
t-dependent extended formulas 122
Table definition types 123
Terminology and Concepts 118
Time index values 123
Variable dependencies 120
Variables setting 729
Viewing a product comparison 212

Model office projections 47


Profit recognition 50
Profit testing 48
Statutory valuation 49
Stochastic projections 46
Using LibraryShield 629
Using plugins 822

Worker
MortalityTables location 744
Worker logging
Options setting 767
Workspace
Creating a template 788
Managing permissions 811

V
Validating entries in a table 247
Valuation results 498

Permissions settings 731


Properties 738
Settings 702

838

Index

Workspace languageSee alsoLanguage


Workspace objects
Dimensions settings 686
Enumerations settings 681
Workspaces 92

Y
Year Dependent Mortality Table 279
Definition 188
Year dependent mortality tables 130
Year index tables 131
Year Index Tables 280
Definition 191

Potrebbero piacerti anche