Phoenix Getting Started Guide

Download as pdf or txt
Download as pdf or txt
You are on page 1of 52

Phoenix Getting Started

Guide
Applies to:
Phoenix 8.4
Legal Notice
Phoenix® WinNonlin®, Phoenix NLME™, IVIVC Toolkit™, CDISC® Navigator, Certara Integral™,
Pirana™, PK Submit™, AutoPilot Toolkit™, Job Management System™ (JMS™), Trial Simula-
tor™, Validation Suite™ copyright ©2005-2023, Certara USA, Inc. All rights reserved. This
software and the accompanying documentation are owned by Certara USA, Inc. The soft-
ware and the accompanying documentation may be used only as authorized in the license
agreement controlling such use. No part of this software or the accompanying documenta-
tion may be reproduced, transmitted, or translated, in any form or by any means, electronic,
mechanical, manual, optical, or otherwise, except as expressly provided by the license
agreement or with the prior written permission of Certara USA, Inc.
This product may contain the following software that is provided to Certara USA, Inc. under
license: ActiveX® 2.0.0.45 Copyright © 1996-2023, GrapeCity, Inc. AngleSharp 0.9.9 Copy-
right © 2013-2023 AngleSharp. All rights reserved. Autofac 4.8.1 Copyright © 2014 Autofac
Project. All rights reserved. Crc32.Net 1.2.0.5 Copyright © 2016 force. All rights reserved.
Formula One® Copyright © 1993-2023 Open-Text Corporation. All rights reserved. Json.Net
7.0.1.18622 Copyright © 2007 James Newton-King. All rights reserved. LAPACK Copyright ©
1992-2013 The University of Tennessee and The University of Tennessee Research Founda-
tion; Copyright © 2000-2013 The University of California Berkeley; Copyright © 2006-2013
The University of Colorado Denver. All rights reserved. Microsoft® .NET Framework Copy-
right 2023 Microsoft Corporation. All rights reserved. Microsoft XML Parser version 3.0
Copyright 1998-2023 Microsoft Corporation. All rights reserved. MS-MPI 10.1 Copyright ©
Microsoft Corporation. All rights reserved. Minimal Gnu for Windows (MinGW, https://
osdn.net/projects/mingw/) Copyright © 2004-2023 Free Software Foundation, Inc. NLog
Copyright © 2004-2023 Jaroslaw Kowalski <[email protected]>. All rights reserved. Rein-
forced.Typings 1.0.0 Copyright © 2023 Reinforced Opensource Products Family and Pavel B.
Novikov personally. All rights reserved. RtfToHtml.Net 3.0.2.1 Copyright © 2004-2017 Sau-
tinSoft. All rights reserved. Sentinel RMS™ 8.4.0.900 Copyright © 2006-2023 Gemalto NV. All
rights reserved. Strawberry Perl Copyright © 2009-2023 Larry Wall. All rights reserved.
(Strawberry Perl is distributed using the TAL (The Artistic License) option and can be down-
loaded from the following link: http://strawberryperl.com/, with all additional packages
available on https://www.cpan.org/.) Syncfusion® Essential Studio for WinForms
16.4460.0.42 Copyright © 2001-2023 Syncfusion Inc. All rights reserved. TX Text Control
.NET for Windows Forms 26.0 Copyright © 19991-2023 Text Control, LLC. All rights reserved.
Websites Screenshot DLL 1.6 Copyright © 2008-2023 WebsitesScreenshot.com. All rights
reserved. This product may also contain the following royalty free software: CsvHelper
2.16.3.0 Copyright © 2009-2023 Josh Close. DotNetbar 1.0.0.19796 (with custom code
changes) Copyright © 1996-2023 DevComponents LLC. All rights reserved. ImageMagick®
5.0.0.0 Copyright © 1999-2023 ImageMagick Studio LLC. All rights reserved. IMSL® Copy-
right © 2019-2023 Rogue Wave Software, Inc. All rights reserved. Ninject 3.2 Copyright ©
2007-2012 Enkari, Ltd. Software for Locally-Weighted Regression Authored by Cleveland,
Grosse, and Shyu. Copyright © 1989, 1992 AT&T. All rights reserved. SQLite (https://
www.sqlite.org/copyright.html). Ssh.Net 2016.0.0 by Olegkap Drieseng. Xceed® Zip Library
6.4.17456.10150 Copyright © 1994-2023 Xceed Software Inc. All rights reserved.
Information in the documentation is subject to change without notice and does not repre-
sent a commitment on the part of Certara USA, Inc. The documentation contains informa-
tion proprietary to Certara USA, Inc. and is for use by its affiliates' and designates' customers
only. Use of the information contained in the documentation for any purpose other than
that for which it is intended is not authorized. NONE OF CERTARA USA, INC., NOR ANY OF THE CON-
TRIBUTORS TO THIS DOCUMENT MAKES ANY REPRESENTATION OR WARRANTY, NOR SHALL ANY WARRANTY BE
IMPLIED, AS TO THE COMPLETENESS, ACCURACY, OR USEFULNESS OF THE INFORMATION CONTAINED IN THIS
DOCUMENT, NOR DO THEY ASSUME ANY RESPONSIBILITY FOR LIABILITY OR DAMAGE OF ANY KIND WHICH MAY
RESULT FROM THE USE OF SUCH INFORMATION.

Destination Control Statement


All technical data contained in the documentation are subject to the export control laws of
the United States of America. Disclosure to nationals of other countries may violate such
laws. It is the reader's responsibility to determine the applicable regulations and to comply
with them.
United States Government Rights
This software and accompanying documentation constitute “commercial computer soft-
ware” and “commercial computer software documentation” as such terms are used in 48
CFR 12.212 (Sept. 1995). United States Government end users acquire the Software under
the following terms: (i) for acquisition by or on behalf of civilian agencies, consistent with
the policy set forth in 48 CFR 12.212 (Sept. 1995); or (ii) for acquisition by or on behalf of
units of the Department of Defense, consistent with the policies set forth in 48 CFR
227.7202-1 (June 1995) and 227.7202-3 (June 1995). The manufacturer is Certara USA, Inc.,
100 Overlook Center, Suite 101, Princeton, New Jersey, 08540.
Trademarks
AutoPilot Toolkit, Integral, IVIVC Toolkit, JMS, Job Management System, NLME, Phoenix,
Pirana, PK Submit, Trial Simulator, Validation Suite, WinNonlin are trademarks or registered
trademarks of Certara USA, Inc. NONMEM is a registered trademark of ICON Development
Solutions. S-PLUS is a registered trademark of Insightful Corporation. SAS and all other SAS
Institute Inc. product or service names are registered trademarks or trademarks of SAS Insti-
tute Inc. in the USA and other countries.
Sentinel RMS is a trademark of Gemalto NV. Microsoft, MS, .NET, SQL Server Compact Edi-
tion, the Internet Explorer logo, the Office logo, Microsoft Word, Microsoft Excel, Microsoft
PowerPoint®, Windows, the Windows logo, the Windows Start logo, and the XL design (the
Microsoft Excel logo) are trademarks or registered trademarks of Microsoft Corporation.
Pentium 4 and Core 2 are trademarks or registered trademarks of Intel Corporation. Adobe,
Acrobat, Acrobat Reader, and the Adobe PDF logo are registered trademarks of Adobe Sys-
tems Incorporated. All other brand or product names mentioned in this documentation are
trademarks or registered trademarks of their respective companies or organizations.
Certara USA, Inc.
100 Overlook Center, Suite 101, Princeton, NJ, 08540 USA
Telephone: +1.609.716.7900
Content

Phoenix Installation and Licensing . . . . . . . . . . . . . . . . . . . 7


System and hardware requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Installing Phoenix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Post-installation considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Configuring Phoenix for international use . . . . . . . . . . . . . . . . . . . . . . . . 15
Executables to be white-listed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Installed folders requiring read/write permission . . . . . . . . . . . . . . . . . 17
Modifying, updating, or removing an installation . . . . . . . . . . . . . . . . . . 18
Silent installation of Phoenix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Phoenix 64-bit versus 32-bit version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Licensing of Phoenix software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
License key code types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Product and authorization codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
License activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
License management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
License Server configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Testing the Phoenix installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Test installation of Phoenix NLME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

v
Getting Started
Guide

This page intentionally left blank.

vi
Phoenix Installation and Licensing
This section contains installation instructions and licensing information for the Phoenix plat-
form and its modules, such as Phoenix NLME, the IVIVC Toolkit. The generic term Phoenix is
used to simplify terminology.
System and hardware requirements
Installing Phoenix
Post-installation considerations
Silent installation of Phoenix
Phoenix 64-bit versus 32-bit version
Licensing of Phoenix software
Testing the Phoenix installation
Test installation of Phoenix NLME

7
Getting Started
Guide

System and hardware requirements


Phoenix is a software platform built on the Microsoft .NET 4.7 framework. It uses the
MinGW (Minimalist GNU for Windows) compiler to create PML (Pharmacometrics Modeling
Language) models. Phoenix also uses Microsoft MPI to allow usage of multiple CPUs and
CPU cores. All software prerequisites needed to use basic Phoenix functions are included in
the Phoenix installation file. Extended Phoenix functions have additional software require-
ments.

Phoenix NLME-specific information


GNU compilers are 64-bit version 8.4.0 and the MPI version is 10.1.
Phoenix NLME only works on 64-bit systems.
NLME jobs can be executed on remote Linux hosts and Torque/SGE/LSF/SLURM grids from a
Phoenix Windows installation.
If user accounts have limitations in executing command prompt commands, users will not
able to execute NLME objects. The Prevent access to the Command Prompt policy for users
must be changed from Enabled to Disabled.

Required software
Windows® Installer 3.1 can be downloaded through the Microsoft Update service or by
downloading the Windows Installer 3.1 redistributable from the Microsoft download page.
A PDF reader, such as Adobe Reader, must be installed to access PDF files of various software
documents, such as the Validation Suite report.

Compatibility with operating system versions


Phoenix is compatible with the following desktop operating system versions with the English
(United States), Kanji (Japan), French (France), Spanish (Spain), German (Germany), or Sim-
plified Chinese (China) language packs and with a Regional Options setting of English (United
States):
– Windows 10 (64-bit) version 1607 or greater, using a keyboard and mouse, Profes-
sional edition
*Phoenix NLME only works on 64-bit systems.
Phoenix is compatible with the following server operating system versions (for direct access
or for access via a desktop with a terminal server application), with English (United States)
operating system/language pack and Regional Options setting of English (United States):
Windows Server 2016
Windows Server 2019
Note: Phoenix is a desktop application that requires isolated resources to perform optimally. If
you wish to deploy this desktop application in an enterprise type fashion, such as through
Citrix, it is important that it be done in a manner that will isolate the recommended
amount of resources to each user, such as through a VDI (virtual desktop infrastructure).
Publishing Phoenix from a shared resource sever with multiple users is not recommended.
8
Phoenix is not supported on any cloud environments such as Azure, AWS, etc.

Compatible third-party software


Third-party tools that are to be used as plug-ins need to be installed on the server. The fol-
lowing third-party software programs are compatible with Phoenix.
Microsoft Office 2013, 2016, 2019 local installation and usage of Office 365 (32 and 64-
bit).
Web version of Office 365 is not compatible with Phoenix for the tools that use Office.
SAS: versions up to and including 9.4 (32 and 64-bit)
NONMEM: 7.3, 7.4, and 7.5 (32 and 64-bit)
SigmaPlot as a third-party tool: 11.1 through 12.5
SigmaPlot as used by AutoPilot Toolkit 2.x for Phoenix: 11.1, 11.2, 12.2, 12.3, and 12.5
R for the R object and for Linux Grid computing: versions up to and including 4.2.3
R for Windows MPI-cluster processing for NLME: R 4.2.3.
PsN: versions up to and including 5.3.0 (only with the operating system version(s) and
NONMEM version(s) with which each PsN version is compatible).
Note: PsN 3.4.2 and 3.6.7 are not compatible with server operating system versions or
with German, Spanish, or Chinese language operating system versions/language packs.
See also the “Phoenix 64-bit versus 32-bit version” section.
Note: When Phoenix is installed and configured to run on a Windows operating system version
where its Regional Language settings are not US English, SAS and SigmaPlot objects can-
not be executed.

Compatible Certara software


Phoenix can be installed on the same computer with other current Certara software prod-
ucts.
It is not guaranteed that a project created with a newer version of Phoenix can successfully
load on older versions of Phoenix. The system will warn the user if the project cannot be
loaded. The opposite (backwards compatibility) is guaranteed, although, in some cases, set-
tings or models are automatically updated to new options. Warnings are given when these
automatic updates occur and the user should review the loaded settings and model.
Note: Newer versions of Phoenix NLME might fail when they are executed on a grid/remote
Linux system that has older versions of Certara.NLME8 installed. Check that the version of
the R library package Certara.NLME8 on the remote host is the same as the package dis-
tributed with the Phoenix version you are installing and upgrade, if necessary (see the
“Job control for parallel and remote execution” section in the NLME documentation for
instructions).

9
Getting Started
Guide

Hardware requirements
Processor
Minimum Requirement: Intel i5 processor 3 GHz
Recommended*: Intel i7 processor 4 GHz
RAM
Minimum Requirement: 8 GB of RAM
Recommended*: 16 GB of RAM
Internal Storage Device
Minimum Requirement: 1 GB 7200 RPM Magnetic HD
Recommended*: 1 GB SSD
*Especially for large datasets and large projects.

10
Installing Phoenix

Installing Phoenix
The instructions for installing Phoenix WinNonlin and Phoenix NLME are the same.
Note: To allow Phoenix to correctly process projects created in English locales, standards and
formats must be set to US English. Using the Control Panel, navigate to the Region and
Language settings. Select English (United States) as the format, then click Additional Set-
tings and set the decimal symbol for numbers and currency to be a period (.) and, finally,
set the list separator to be a comma (,).

The following instructions assume that the Phoenix license is installed on the end user’s
local machine. If Server license(s) are being used, Phoenix will need to be configured to
use the Server license(s) after installation of the release. For instructions, please refer to
the “Licensing of Phoenix software” section.
Prepare for a clean install
1. Manually uninstall any version of Phoenix released prior to 8.1 (e.g., on Windows, use
Windows > Settings > Apps & features).
The installer only recognizes and uninstalls Phoenix versions 8.1 or later, earlier versions
are not recognized and must be uninstalled manually.
2. Manually uninstall any plugins that were installed separately from Phoenix (e.g., on Win-
dows, use Windows > Settings > Apps & features).
Folders for these separately installed plugins do not get removed when the previous ver-
sion of Phoenix is uninstalled and will remain in C:\Program Files (x86)\Certara\Phoe-
nix\application\Plugins. Such plugins include: Phoenix Integral Plugin, PKAssist, and
PKSubmit.
3. Copy the license file (lservrc) from C:\Program Files (x86)\Certara\Phoenix\applica-
tion\Services\Licensing to a temporary location.
4. Remove all remaining folders and files under C:\Program Files (x86)\Certara.
Start the installer
1. Extract the ZIP file that contains the installation files.
2. Double-click Setup.exe to run the Phoenix Installation wizard.
Setup.exe detects the operating system and starts the appropriate executable.
If you have a version of Phoenix installed that is 8.1 or later, the installer displays a confirma-
tion dialog to proceed with uninstalling that version.

11
Getting Started
Guide

Selecting OK uninstalls Phoenix. Follow the instructions to remove the software and then
restart the installer.
The installer also checks for the following:
– the appropriate version of the .NET framework
– the LegacyWNL components and Microsoft Visual C++ components
If any of these requirements are not met, a notification dialog is displayed and the installer
will proceed to install the necessary items. A forced reboot must be done prior to installing
Phoenix. To continue with the Phoenix installation after the reboot, double-click Setup.exe.
Follow installer steps
1. On the Phoenix Setup wizard Welcome screen, click Next to display the Setup Type
screen.

2. Select a setup type.


Typical is the default setup type. Only the Phoenix application and GCC (Minimalist GNU
for Windows GCC Compiler) are installed.
Complete installs the Phoenix application, GCC, components for remote execution (JPS,
JQS, and JMS), and MPI (for parallel computing for Phoenix NLME).
Custom allows the user to select the items to install. Recommended for advanced users.

12
Installing Phoenix

The GCC component will be installed to C:\PHSTMinGW64 whether the user retains the
default installation location or selects an alternate location.
3. Press Next to display the Destination Folder screen.

4. Specify a destination folder and press Next to display the Ready to Install screen.
5. In the Ready to Install screen, use the Back button to return to the previous screens to
make any changes to the installation or press Next to continue the installation process.
Once installation is finished, the Completed the Installation of Phoenix screen is dis-
played.
6. To complete the installation, the computer should be restarted. However, if restarting
needs to be delayed, uncheck the Restart now box.
7. Press Finish to close the installer.
Return license file and reinstall plugins
1. Copy your license file back to C:\Program Files (x86)\Certara\Phoenix\application\Ser-
vices\Licensing.
2. Reinstall the plugins that you uninstalled.
For PK Assist customers using Integral, the Phoenix Integral Plugin must be reinstalled
before PK Assist is reinstalled.
If you encounter any difficulties with these steps, please contact Certara Support.

13
Getting Started
Guide

Post-installation considerations
Configuring Phoenix for international use
Executables to be white-listed
Installed folders requiring read/write permission
Modifying, updating, or removing an installation

14
Post-installation considerations

Configuring Phoenix for international use


When Phoenix is installed on systems that do not use the United States region, then some
regional display information must be changed before Phoenix can be used.
Note: If the settings are not changed then Phoenix cannot correctly run projects that are cre-
ated in the United States region.
1. In the Control Panel, display the Region settings.
2. Select United States as the region.
If the region information cannot be changed, then users must set the decimal symbol to
a period (.) for numbers and currency, and the list separator symbol to a comma (,).
3. Click the Additional date, time & regional settings link.
4. In the dialog, click the Change data, time, or number formats link.
5. In the Formats tab, press Additional settings.
6. From the Decimal symbol menu, select a period (.).
7. From the List separator menu, select a comma (,).
8. Select the Currency tab.
9. From the Decimal symbol menu, select a period (.).
10. Press OK to save the changes and exit the dialogs.
Note: When Phoenix is installed and configured to run on a Windows operating system version
where its Regional Language settings are not US English, SAS and SigmaPlot objects can-
not be executed.

For operating systems with Regional Language settings set to Japanese, the default Cal-
endar type should be set to Western Calendar (Japanese) in order for .xpt files to be
exported correctly.

15
Getting Started
Guide

Executables to be white-listed
There are executables that may be flagged/quarantined by different antivirus software. This
can cause Phoenix applications to function improperly or even fail. To avoid these types of
problems, the following items should be included in an exception list for virus protection by
your IT professional.
wnlnca.exe in C:\Program Files (x86)\Certara\Phoenix\application\Plugins\WnlModel-
ing\
Phoenix.exe in C:\Program Files (x86)\Certara\Phoenix\application\
Phoenix32.exe in C:\Program Files (x86)\Certara\Phoenix\application\
ChiDistribution.exe in C:\Program Files (x86)\Certara\Phoenix\application\lib\
TDL5.exe in C:\Program Files (x86)\Certara\Phoenix\application\lib\NLME\Executables\
In addition, the following folders (and their sub-folders) may need to be added to the excep-
tion list:
C:\Users\%UserName%\AppData\Roaming\Certara
C:\Users\%UserName%\AppData\Local\Temp
C:\Users\%UserName%\Documents\Certara Projects
C:\Program Files (x86)\Certara
C:\ProgramData\Certara
C:\PHSTMinGW
C:\PHSTMinGW64

16
Post-installation considerations

Installed folders requiring read/write permission


For environments where a Phoenix installation is being shared, users should have read/write
permission for C:\ProgramData\Certara.
When creating custom tables, users should have read/write permission for C:\Program Files
(x86)\Certara\Phoenix\application\Plugins\Table\Custom.

17
Getting Started
Guide

Modifying, updating, or removing an installation


If Phoenix is already installed, then users can double-click the Setup.exe or the Setup.msi file
to update or modify a Phoenix installation.
1. Double-click the Setup.exe or the Setup.msi file to display the Welcome screen.
2. Select a maintenance operation.
Modify Available Options is the default selection type and provides options to install
updates to the existing application.
Repair Application re-installs over the existing application to replace possibly corrupt
files.
Uninstall removes all files from the Phoenix installation folder that were originally part
of the installation, including files associated with GCC and MPI. The uninstall process
does not uninstall any .NET framework versions or C++ runtime versions that were
installed as prerequisites, nor does it uninstall the LegacyWNL file.
3. Press Next.
– If Modify Available Options is selected, the Custom Setup dialog is displayed.
– If Repair Application is selected, the Ready to Install Phoenix dialog is displayed.
Phoenix will be re-installed based on the user selections made when Phoenix was
originally installed.
– If Uninstall is selected, the Ready to Install Phoenix dialog is displayed.

18
Silent installation of Phoenix

Silent installation of Phoenix


Administrators can remotely install Phoenix on users’ computers in “silent” mode using
scripting. This allows large organizations to “push out” installation updates to computers
overnight without any user interaction.
The command to issue is the following. This can be run from a command prompt, from the
directory where the Phoenix setup.exe file is located.
setup.exe /s MINIMUM=FALSE COMPLETE=TRUE DESKTOPDIR=C:\Users\Pub-
lic\Desktop
where:
/s: Tells the install to be silent (no UI is displayed).
MINIMUM=FALSE: Specifies that it will not just be Phoenix installed.
COMPLETE=TRUE: Specifies that MPI and JMS are also to be installed.
DESKTOPDIR=C:\Users\Public\Desktop: Specifies the location to put the Phoenix
shortcut. Specifying the Public profile will ensure ALL users receive the shortcut.
As part of scripting the installation (PowerShell is being used in the following example):
Start-Process <PATH_TO_PHOENIX_EXECUTABLE> -ArgumentList “/s MINI-
MUM=FALSE COMPLETE=TRUE DESKTOPDIR=C:\Users\Public\Desktop” -Wait
Italicized text above indicates PowerShell syntax needed to properly execute the command,
as well as wait for a successful completion before continuing.

19
Getting Started
Guide

Phoenix 64-bit versus 32-bit version


Both the 64-bit and 32-bit versions of Phoenix, namely Phoenix and Phoenix32, are available
to users with 64-bit operating systems. Users of 32-bit operating systems are unable to
launch Phoenix as a 64-bit application. Any features not available in Phoenix 64-bit are avail-
able in the 32-bit version, on the same system.
Phoenix 64-bit has all the same features as Phoenix running in 32-bit, except for the specific
differences outlined here. The following functionality descriptions refer only to the 64-bit
version.
• Executables: Executables that do not support 64-bit fail validation if the user tries to
execute them. Users can still open, save, create and interact (limited in some cases) with
all executables but are not able to execute them if not supported in 64-bit. These execut-
ables are: SigmaPlot and AP.
• File I/O: Not all file formats supported in 32-bit are supported in 64-bit. Primarily due to
COM interaction with legacy WNL components used to read the file formats. This is the
case for importing files from the desktop as well as Certara Integral. (The exception is
WNL 5 scenarios from PKS. Scenarios are well-formed workspaces that can be loaded
without additional user intervention in a separate process space which is why they are
supported.)
PWO, PMO, PTO, PCO, BQL, TDF, XML, LML, CMD, IVC, MAP
WNL workspaces (WSP, PWS)
ODBC Import
In the case of the legacy files the user is given a warning that the file format is not sup-
ported in 64-bit. For ODBC, the menu options are not displayed to the user. To import
these legacy files, run Phoenix32.exe to import the data and save the project. The saved
project can then be loaded into 64-bit Phoenix.
Compatibility notes:
– Projects created in the 32-bit or 64-bit versions of the application work in both ver-
sions.
– JMS/RMS work with Phoenix regardless of the bit level of the server or client compo-
nents (e.g., 32-bit Phoenix can communicate with 64-bit JMS/RMS; 64-bit Phoenix
can communicate with 32-bit JMS/RMS.
– Certara Integral works with both versions of Phoenix.
– The JMS queue and job processor components (queue: JQS, job processor: JPS) sup-
port 32 and 64-bit versions. The AnyCPU versions are the default.

If a user or admin needs to use the 32-bit versions of JQS or JPS they are also
installed as jqs32.exe and jps32.exe. To use the 32-bit versions the services must be
stopped and the 32-bit versions must be renamed to jqs.exe and jps.exe respectively.

20
Licensing of Phoenix software

Licensing of Phoenix software


The Phoenix Licensing Service is the system Phoenix uses to manage user licenses. When a
user starts Phoenix for the first time the Licensing Service is the first Phoenix service that is
initialized, and a message is displayed that you are running an unlicensed version of the soft-
ware, if no license is detected. The Licensing Service is integrated into the Phoenix Prefer-
ences dialog, which can be accessed by selecting Preferences in the Edit menu.
Users have several options to install or acquire a license. Users can activate their copy of
Phoenix by using online and offline activation, or users can connect to a license server to
acquire a license for online or offline use.
License key code types
Product and authorization codes
License activation
License management
License Server configuration

21
Getting Started
Guide

License key code types


Phoenix requires the installation of a license key code. There are two types of license key
codes:
• Named User: a license key code that activates the software on (i) a single machine that
may be accessed by the individual named end user for that license or (ii) a single host
machine or server (“Host Server”) that may be accessed by any of the named end users
as part of the license agreement. A Named User License means that only one named
person can use each license and that named person has the right to unlimited access to
the software. A Named User License is not based on concurrent users but on an actual
named user basis.
• Commuter: a license key code that is retrieved from a network. Commuter licenses give
users temporary offline authorization to use Phoenix while away from the network
where their license server resides.
Commuter licenses can be used for a specified period of time and are subject to a hold
time during which they cannot be checked out by another user. This protects users who
need to make changes to a Phoenix project after they close Phoenix from immediately
losing their license key to another user on the network.
Customers must work with Certara Sales and the Licensing Administrator to determine
how many of their licenses should contain the commuter feature and the length of time
that commuter enabled licenses are valid after they have been checked out from the
license server. The time-out period cannot be altered after the license has been
installed.
Note: The commuter license option is only available if the Sentinel™ RMS 8.x license server is
used with Phoenix.

22
Licensing of Phoenix software

Product and authorization codes


A product code and an authorization code are included with each license or set of licenses
purchased. The primary delivery system for acquiring the Phoenix application is download-
ing the installation files from a Certara server. Certara’s download and support page is
located at https://certaracommunity.force.com/support/s/.
When Phoenix is purchased, customers are sent an email with the four things necessary to
use Phoenix:
– The application and license server download link.
– The authorization code.
– The product code.
– The license code generation Web site link.
Please include the product code in all correspondence with Certara about the product and
its license, including license renewals, software updates, and product upgrades.

23
Getting Started
Guide

License activation
1. Run Phoenix as an administrator.
a. Right-click the Phoenix icon on the desktop and select Run as administrator.
b. In the User Account Control dialog, enter the administrator login information and
press Yes.
2. Select Edit > Preferences from the Phoenix menubar.
3. In the navigation panel, expand the Licensing node and select License Acquisition.

4. On the right side of the Preferences dialog, select the Online tab.

5. In the Online tab, click Test to check that you have access to the Authentication Server
for online license activation.
If the test is unsuccessful, go to the “Offline activation” section.
6. Copy the entire authentication code given in the email.

7. In the Preferences dialog, paste the copied code into the step 2 text field and press the
Activate button.
A verification pop-up confirming that the activation was successful.
Note: If your machine does not have internet access, or if the Online Activation failed, refer to
the “Offline activation” section.
8. Press OK to close the pop-up verification.
9. Restart Phoenix as a non-administrator user, select Edit > Preferences, and, in the navi-
gation pane of the Preferences dialog, select the License Management node.

24
Licensing of Phoenix software

10. Verify that the correct license now appears. Below is an example of a correctly installed
local license:

If the License Management window shows a successfully “Acquired” license, you are done
with the license activation and are ready to use your Phoenix application.

Offline activation
In the Offline tab of the Preferences dialog, click the Email Certara license administrator link
to request a license. Include the following information in the email:
– Your System Lock Code (press the Copy Lock Code button in the Preferences dialog
and paste the information into the email).
– Your order number from the Subject line of your license email (C-0xxxxx)
Certara Licensing will use the System Lock Code to make a license code for your machine,
and email it back. Paste the license code(s) into the field in the Offline tab and press Install.

25
Getting Started
Guide

License management
The License Management panel in the Preferences dialog allows users to see which license
types are available and acquired.

Name: Lists the names of available licenses.


Type: Lists whether the license is a named user or named user server license.
Commuter: Lists licenses that are available to be commuted.
Status: Lists the status (Available, Acquired, etc.) of licenses.
Expires: Lists the license expiration date.
Use the License Management dialog
1. Select Edit > Preferences.
2. In the Preferences dialog, expand the Licensing node in the menu tree by clicking the (+)
signs.
3. Select License Management.

26
Licensing of Phoenix software

Local named user licenses


There are no options for local named user licenses in the License Management screen.

Named user server licenses


To use a named user server license, click a license name in the Name column.
The license status is changed to Acquired.
To return the license, click the license name again.
The license status is now Available.

Commuter licenses
If a commuter license is available, click Request in the Commuter column.
If the commuter license is acquired, its status is changed to Commuting.
The date the commuter license expires is listed in the Expires column.
To return a commuter license, click Release to release the license.
Press Refresh to update the list of available licenses.

27
Getting Started
Guide

License Server configuration


The License Server Configuration panel allows users to add license server IP addresses to
Phoenix. The number of available license servers is determined by the customer. Some ver-
sions of Sentinel license servers support redundant license servers.
The License Server Configuration panel has three fields: Name, IP Address, and Status. The
Name field contains the name of the license server, the IP Address field contains the IP
address of the license server, and the Status field contains the connection status.

Use the License Server Management screen


To add a license server:
1. Enter the IP address of the server in the IP Address or Host Name field.
2. Press Add.
To remove a license server:
1. Enter the IP address of the server in the IP Address field.
2. Press Remove.
To update the list of available license servers, press Refresh.

28
Testing the Phoenix installation

Testing the Phoenix installation


The following instructions test the installation of Getting Started by using a number of the
sample files provided with the software. This chapter is not intended as a full validation of
the product. It is intended to test for proper installation of major components of the applica-
tion.
A set of Validation Suite Products is available from Certara. Contact the Certara sales depart-
ment for more information.
Start Phoenix and create a new project

1. Double-click the Phoenix icon ( ) on your desktop to start Phoenix.


Note: AutoPilot users running on 64-bit operating systems should run the 32-bit version of
Phoenix (Phoenix32) as opposed to the 64-bit version. The Phoenix desktop icon should
be updated to reference the Phoenix32 executable as well.
2. Select File > New Project to create a new project. A new project is created in the Object
Browser.
3. Name the new project Install Test.
The left panel’s default view is the Object Browser, which contains the project, and the other
folders and objects that are contained in the project. The right viewing panel’s default view
is blank, unless one of the project folders or the workflow is selected.

Creation of Install Test project denotes a successful installation test.


Confirm license installation
The ability to execute different Phoenix plug-ins depends on the license type installed. Use
the Preferences dialog to check the installed Phoenix license(s).
1. Select Edit > Preferences to access the Preferences dialog.
2. Select Licensing > License Management to access the list of available licenses.
3. Confirm that the purchased license or licenses are listed in the Licenses panel.

29
Getting Started
Guide

Confirm plug-in startup


The Phoenix architecture is based on a series of plug-ins that allow different features to be
enabled or disabled. Phoenix initializes these plug-ins when the application starts. The
default setting is for all plug-ins to initialize when Phoenix starts. The plug-in initialization is
independent of the installed license(s).
1. In the Preferences dialog, click Plugins to view the list of available plug-ins.
The Plugins panel on the right contains three tabs: General, System, and Non-loaded.
Each plug-in has two possible states, Started and Stopped. All plug-ins are started the
first time Phoenix is started.

2. Select the General, System, and Non-loaded tabs to see the review the state of each
plug-in type and to confirm they are started.
3. Press OK to exit the Preferences dialog.
Import a dataset
The dataset Bguide1.dat is used to test key Phoenix functions.

1. Select File > Import, click (Import File icon), or right-click the Data Folder in the
Object Browser and select Import to display the Import File(s) dialog.
2. Navigate to <Phoenix_install_dir>\application\Examples\WinNonlin\Supporting files).
3. Select the file Bguide1.dat and press Open.
The File Import Wizard dialog is displayed. The dialog is used to assign options for how
the data are imported and presented.
4. Press Finish.
The dataset is added to the project Data folder and the worksheet is displayed in the
right viewing panel.

30
Testing the Phoenix installation

Create a plot
1. Right the Workflow object and select New > Plotting > XY Plot.
The XY Plot object is added to the workflow in the Object Browser and is automatically
opened in the right viewing panel. The default view of an object is the Setup tab, which
contains all the steps necessary to set up an object.
2. Drag the Bguide1 worksheet from the Data folder to the XY Data Mappings panel.
3. Use the option buttons in the XY Data Mappings panel to map the columns to the con-
texts as follows:
Subject to Group.
Time to X.
Conc to Y.

4. Click (Execute icon) to execute the workflow.

31
Getting Started
Guide

XY Plot results:

Create a table
Now use the Bguide1 dataset to test the Table object and its summary statistics function.
1. Add the Table object to the workflow by right-clicking the Workflow object and selecting
New > Reporting > Table.
2. Drag Bguide1 from the Data folder to the Table object’s Main Mappings panel to map
the dataset Bguide1 as the input source for the Table object.
3. Use the option buttons in the Main Mappings panel to map the columns to the contexts
as follows:
Subject to Stratification Row.
Conc to Data.
Leave Time mapped to None.
4. In the Options tab (located below the Setup tab, specify which table type the Table
object is to use by selecting Table 1 - Column Summary by Row Stratification from the
Table Type menu.
5. Check the Page Break on Row Stratification box.

6. Select the Statistics tab, located below the Setup tab.


7. Press Select All to select all output statistics.
32
Testing the Phoenix installation

8. Execute the object.


The results are presented as three HTML tables in the Results tab. Compare the tables in the
Results tab to the tables pictured below.
Resulting HTML table for subject DW:

33
Getting Started
Guide

Resulting HTML table for subject GS:

Resulting HTML table for subject RH:

34
Testing the Phoenix installation

Confirm noncompartmental analysis functions


1. Select File > Load Project. The Load Project dialog is displayed.
2. Navigate to <Phoenix_install_dir>\application\Examples\WinNonlin.
3. Select Multiple_Profiles.phxproj and press Open.
This project contains:
– A dataset worksheet (profiles)
– A worksheet of dosing information (Dosing published from NCA)
– An XY Plot object
– An NCA model object
– A Descriptive Statistics object
– A Data Wizard object
– An X-Categorical XY Plot object
4. Expand the Workflow node in the Object Browser.
5. Select the NCA model object.
6. Select items in the Setup tab list to explore the data mappings and option settings.
7. Execute the object.

Text output
The Core output contains the model settings and the same data as the worksheets but pre-
sented in plain ASCII text. If there were errors in the model they would be listed here. Part of
this file is shown below:

Model: Plasma Data, Extravascular Administration
Number of nonmissing observations: 12
Dose time: 0.00
Dose amount: 100.00
Calculation method: Linear Trapezoidal with Linear Interpolation
Weighting for lambda_z calculations: Uniform weighting
Lambda_z method: Find best fit for lambda_z, Log regression
Compute Concentrations at: 75

Summary Table
-------------
Time Conc. Pred. Residual AUC AUMC Weight
min ng/ml ng/ml ng/ml min*ng/ml min*min*ng/ml
------------------------------------------------------------
0.0000 0.0000 0.0000 0.0000
5.000 340.3 850.8 4254.
10.00 1914. 6487. 5.636e+04
15.00 2069. 1.644e+04 1.818e+05
20.00 1417. 2.529e+04 3.329e+05
30.00 788.8 3.659e+04 5.983e+05
45.00* 496.4 460.9 35.54 4.623e+04 9.434e+05 1.000
60.00* 372.8 357.2 15.63 5.275e+04 1.279e+06 1.000

35
Getting Started
Guide

90.00* 204.3 214.6 -10.33 6.141e+04 1.890e+06 1.000


120.0* 124.1 128.9 -4.852 6.633e+04 2.389e+06 1.000
180.0* 39.25 46.52 -7.266 7.123e+04 3.048e+06 1.000
240.0* 19.32 16.79 2.531 7.299e+04 3.399e+06 1.000
The Settings file lists all the settings used to specify the noncompartmental analysis.

Sort: Subject, Form
Time: Time [min]
Concentration: Conc [ng/mL]
Carry:
Dosing: (Internal)
Slopes: (Internal)
Partial Areas: (Internal)
Therapeutic Response: <None>
Units: (Internal)
Parameter Names: <None>

Plasma Model
Title=Processing Multiple Profiles with Model 200
Linear Trapezoidal Linear Interpolation
Sparse=False
Weighting=Uniform Weighting; 0
Dose Type=Extravascular
Dose Unit=ng
Dose Normalization=None
Compute Concentrations at: 75

Output data
The NCA object creates seven results worksheets: Dosing Used, Exclusions, Final Parameters,
Final Parameters Pivoted, Partial Areas, Plot Titles, Slopes Settings, and Summary Table.
Selections from the Final Parameters and Summary Table worksheets are shown below.

36
Testing the Phoenix installation

Final Parameters worksheet:

37
Getting Started
Guide

Summary Table worksheet:

38
Testing the Phoenix installation

Plots
A total of 12 plots are generated; one for each of two formulations, for each of the six sub-
jects. The first two charts for subject one are shown below.

Confirm pharmacokinetic modeling functions


1. Select File > Load Project.
The Load Project dialog is displayed.
2. Navigate to <Phoenix_install_dir>\application\Examples\WinNonlin.
3. Select PK_Model.phxproj and press Open.
This project contains:
– A dataset worksheet (study1).
– An XY Plot object.
– A PK model object.
4. Expand the Workflow node in the Object Browser.
5. Select the PK Model object.
6. Select items in the Setup tab list to explore the model’s data mappings and option set-
tings.
The imported PK Model object uses PK Model 3, which is a one-compartment model
with 1st order absorption.
7. Execute the object.

Worksheet results
The PK Model object’s output worksheets partially include Condition Numbers, Diagnostics,
Dosing Used, Final Parameters, Initial Estimates, Secondary Parameters, and Summary Table.

39
Getting Started
Guide

The Final Parameters, Secondary Parameters, and Summary Table worksheets are shown
below.
Final Parameters worksheet:

Secondary Parameters worksheet:

Summary Table worksheet:

Text output
The Core output text results include all model settings and iterations, including the output
from the worksheets. Any model errors would be listed here. Part of this file is shown below.

Listing of input commands
MODEL 3
NVAR 3

40
Testing the Phoenix installation

NPOI 1000
XNUM 2
YNUM 3
NCON 3
CONS 1,2,0
METH 2‘Gauss-Newton (Levenberg and Hartley)
ITER 50
INIT 0.25,1.81,0.23
MISS ‘.’
DATA ‘WINNLIN.DAT’
BEGIN
The Settings file lists all the settings used to specify the noncompartmental analysis. Part of
this file is shown below.

Main: PK Model.Data.study1
Sort: Subject
Time: Time [hr]
Concentration: Conc [ng/mL]
Carry:
Dosing: (Internal)
Initial Estimates: (Internal)
Units: (Internal)
***** Other Parameters *****

PK 3-[PK]
Gauss-Newton (Levenberg and Hartley)
Convergence criteria of 0.0001 used during minimization process
50 maximum iterations allowed during minimization process

Plots
The plot results include Observed Y and Predicted Y vs X, Partial Derivatives Plot, Predicted Y
vs Observed Y, Predicted Y vs X, Residual Y vs Predicted Y, and Residual Y vs X. Some plot
results are shown below.

41
Getting Started
Guide

Observed Y and Predicted Y vs X:

Predicted Y vs Observed Y:

42
Testing the Phoenix installation

Residual Y vs X:

Confirm bioequivalence functions


1. Select the Install Test project in the Object Browser.
2. Select File > Import.
3. In the Import File(s) dialog, navigate to <Phoenix_install_dir>\application\Exam-
ples\WinNonlin\Supporting files.
4. Select the file Seq2Per4.csv and press Open.
5. In the File Import Wizard dialog, press Finish.
The dataset is added to the project Data folder.
6. Right-click Workflow in the Object Browser and select New > Computation Tools > Bio-
equivalence.
The Bioequivalence object is added to the workflow in the Object Browser.
Note: The default settings for a new Bioequivalence model are Crossover as the type of study
and Average as the type of bioequivalence.
7. Drag the Seq2Per4 worksheet from the Data folder to the Main Mappings panel.
The Seq2Per4 dataset is mapped to the Bioequivalence object.
8. Use the option button in the Main Mappings panel to map AUC to the Dependent con-
text.
The following data types are automatically mapped to contexts when the dataset is
mapped to the Bioequivalence model.
– Sequence to Sequence.
– Subject to Subject.
– Period to Period.
– Formulation to Formulation.
– AUC to Dependent.
43
Getting Started
Guide

9. In the Model tab (located below the Setup tab), ensure that:
a. Crossover is selected as the Type of study.
b. Average is selected as the Type of Bioequivalence.
c. R is selected as the Reference Formulation.

10. Select the Fixed Effects tab, located below the Setup tab.
Ln(x) is automatically selected in the Dependent Variables Transformation menu. Do
not change this setting.
11. Execute the object.

Output data
The bioequivalence model worksheet output partially includes Average Bioequivalence,
Diagnostics, Final Fixed Parameters, Final and Initial Variance Parameters, Least Squares
Means, and Sequential Tests. The Diagnostics, Final Variance Parameters, and Sequential
Tests worksheets are shown below.

44
Testing the Phoenix installation

Average Bioequivalence worksheet:

Diagnostics worksheet:

Final Variance Parameters worksheet:

45
Getting Started
Guide

Sequential Tests worksheet:

This concludes the Phoenix installation tests.

46
Testing the Phoenix installation

Test installation of Phoenix NLME


Users who have purchased a license for Phoenix NLME can use the Maximum Likelihood
Models object to create and test population models. After Phoenix is installed, follow the
steps below to confirm that population modeling is working correctly.
This example verifies that the Phoenix NLME license and the Minimal GNU C++ compiler are
correctly installed and configured. It is not intended as a full validation of population model-
ing. If Phoenix is being used without population modeling functionality, then skip this instal-
lation test.
Note: For this installation test to work, users must have an active license for Phoenix NLME 8.4.
If any problems are encountered during this installation test, report the issue to Customer
Support.
Start Phoenix and create a project

1. Double-click the Phoenix icon ( ) on your desktop to start Phoenix.


2. Select File > New Project to create a new project.
A new project is created in the Object Browser.
3. Name the new project Installation Project.
Confirm population modeling functionality
1. Select File > Import.
2. In the Import File(s) dialog, navigate to <Phoenix_install_dir>\application\Exam-
ples\NLME\Supporting files.
3. Select theopp.csv and press Open.
4. In the File Import Wizard dialog, press Finish.
The dataset is added to the project Data folder and the worksheet is opened.
5. Select the Workflow object in the Object Browser.
6. Select File > Load Workflow Template.
7. In the dialog, navigate to <Phoenix_install_dir>\application\Examples\NLME\Supporting
files.
8. Select Diagonal Model.phxtmplt and press Open.
Phoenix template files store information about settings and internal worksheets but do
not store external data sources.
The template file adds a one-compartment, 1st order absorption model that uses weight
as a covariate. The model uses the FOCE L-B (First Order Conditional Estimation with the
Lindstrom-Bates iterative algorithm) run method.
9. Select the Structural, Parameters, and Run Options tabs to examine the model configura-
tion.
The Parameters tab contains several sub-tabs that list fixed effects, random effects, and
covariates.

47
Getting Started
Guide

10. Drag the theopp worksheet from the Data folder to the Main Mappings panel.
The theopp dataset is mapped to the Diagonal model and the study variables xid, dose,
time, yobs, and wt are automatically mapped to the contexts ID, Aa, Time, CObs, and
wt, respectively.
11. Execute the object.
12. Close the NLME Job Status dialog by clicking the X in the upper right corner.
Verify the results
1. Select the Verification tab.
The Verification Results state that the model successfully executed, and that no errors
occurred.

2. Select the Results tab.


The model object produces text files, plots, and worksheets. The output types are listed
below.

Output data
The model creates 23 worksheet results. Some of the output worksheets are Eta, EtaCovari-
ate, Omega, and Theta. Not all worksheets listed under Output Data contain results.
Confirm the accuracy of some of the output to complete the installation test.
1. In the Output Data, select the Theta worksheet and confirm that the following estimates
are the same (after rounding):
tvKa 1.556
tvV 0.455
tvCl 0.0403
stdev0 0.692
Theta worksheet:

48
Testing the Phoenix installation

Eta worksheet:

Plots
Thirty-nine plots are listed in the Plots section. Not all listed plots have results.
1. In the Plot output, select Pop CWRES vs PRED and compare it to the screen shot below:

Text output
The Maximum Likelihood Models object creates six text files. The Settings text file lists
model settings, part of which is shown below.

Sort:
ID: xid
Aa: dose

49
Getting Started
Guide

Time: time
CObs: yobs
wt: wt

test(){
deriv(Aa = -Ka * Aa)
deriv(A1 = Ka * Aa - Cl * C)
dosepoint(Aa)
C=A1/V
error(CEps = 1)
observe(CObs = C + CEps)
stparm(Ka = tvKa * exp(nKa))
stparm(V = tvV * exp(nV))
stparm(Cl = tvCl * exp(nCl))
covariate(wt)
fixef(tvKa = c(, 1.54697,))
fixef(tvV = c(, 0.455465,))
fixef(tvCl = c(, 0.0402979,))
ranef(diag(nV, nKa, nCl)=c(0.01809, 0.41265, 0.06997))
}
------------------------------------
id("xid")
time("time")
dose(Aa<-"dose")
covr(wt<-"wt")
obs(CObs<-"yobs")
table(file=”posthoc.csv”, time(0), Ka,V,Cl)
------------------------------------
Run Options
Method: FOCE L-B
N Iter:1000
Input sorted by subject+time
Enabling automatic log transform (if applicable)
ODE solver method: matrix exponent
Method of computing standard errors: Central Diff
Hessian standard errors
Confidence Level %95
Simple run was performed
This concludes the installation test for Phoenix NLME. Close project without saving it.

50
Index

I
Install
NLME 11
silently 19
WinNonlin 11
L
License
activation 24
management 26
server configuration 28
N
NLME
installation 11
P
Permissions for installed folders 17
Preferences
license activation 24
license management 26
license server configuration 28
S
Silent install 19
V
Verify
population modeling 47
W
White-listed executables 16
WinNonlin installation 11

51
Getting Started
Guide

52

You might also like