In this section:
Installation Directory and User Account
You should use the same local user to install enterprise pack with DTP. This is to enable full integration and avoid potential issues in some environments. The user should have a local home directory, not a network shared directory.
One Policy Center Per DTP Deployment
For the full duration of your DTP and Policy Center implementation, you should only integrate one DTP server with one instance of Policy Center. This is because Policy Center requires DTP's project list to be consistent so that accurate information is displayed. The following scenarios describe potential issues regarding this requirement and how to resolve them:
Scenario | Resolution |
---|---|
Moving DTP to new server | If you are migrating to new DTP, be sure to move the Enterprise Pack installation at the same time so that all internal data is consistent. |
Lost DTP and data | If DTP data is lost, reset the Policy Center database when DTP is brought back online. All previously stored data will no longer be valid. |
Set testing against production | A separate Enterprise Pack installation should be deployed for each environment. |
Setting Default Ports for Connected Services
You can specify a default host and port for applications connecting to DTP using the services API. This enables you to redirect users to the appropriate URL if you need to enforce SSL, for example. DTP Enterprise Pack applications, for example, use the services API to communicate with Report Center.
- Open the DTP_HOME/conf/PSTRootConfig.xml configuration file in an editor.
Locate the
<default-server-url>
element and provide a valid URL:<default-server-url>http://example.host.com:port</default-server-url>
- Save the file.
Enabling Single Sign-on
Open the <DTP_install_dir>/conf/PSTSecConfig.xml configuration file and either uncomment or add the
<pst-cookie>
element:<pstsec-config> ... <pst-cookie> <domain>companydomain.com</domain> </pst-cookie> ... </pstsec-config>
- Save your changes and restart the DTP server. See Starting DTP Services.
DTP Enterprise Pack Requirements and Settings
Make sure your system environment meets the system requirements before installation. Extract the files from the installation package. The package includes a script, dtpservices.bat for Windows and dtpservices.sh for Linux, which automates processes, such as starting up, stopping, and restarting the Extension Designer, Policy Center, and the database. The dtpservices scripts include a process for upgrading your current installation. If your installation contains custom flows, be sure to back them up before upgrading. Upgrading from PIE 1.x requires a manual migration for its database and flows. See Migrating PIE Slices to Extension Designer for additional information. The dtpservices scripts include a process for backing up your current installation. The following files and directories are backed up: Files stored in the Common, Components, Examples, Parameters, and Sample Widgets built-in directories are backed up, but any JSON files stored in those directories are not restored on upgrade. The dtpservices scripts include a process for restoring backup archives. SSL is not enabled in DTP Enterprise Pack by default. You will need to enable SSL if you need to secure the data transported between applications in your infrastructure. If you are using an SSL-enabled reverse proxy server, you do not need to enable SSL for Parasoft applications (see Reverse Proxy Support). To enable SSL, you must first obtain an authority-signed certificate (CA) from a provider, such as VeriSign, Symantec, or GlobalSign. Do Not Use a Self-signed Certificate Unless you are implementing a reverse proxy infrastructure, only use authority-signed certificates when enabling SSL. The same ports are used when SSL is enabled for DTP Enterprise Pack, but they will all use the HTTPS protocol. DTP Enterprise Pack will also use SSL-enabled ports to communicate with DTP. If you want to send data between DTP and Enterprise Pack applications over HTTPS, you must enable SSL for both systems to make sure they work properly. If you enable SSL for Enterprise Pack, you must also enable SSL for the DTP interface (DTP APIs always run under SSL) so that Report Center, Extension Designer, and Policy Center use the same protocol (HTTPS). If you disable SSL and are not using an SSL-enabled reverse proxy server, then passwords and other important information will transmit over the network unencrypted. A Parasoft DTP Enterprise license is required. Contact your Parasoft representative if you have questions about your license. Windows (64-bit only): Linux: Solaris: Solaris installation is not supported. If your DTP is installed on Solaris/Sparc, you can install the DTP Enterprise Pack on a separate Windows or Linux system. Parasoft does not support Solaris on x86 platform. Contact your sales representative or support for additional questions. * Extension Designer cannot be run in Compatibility mode. To disable this mode: We recommend installing the Enterprise Pack and DTP on the same server. If they must be installed on different servers, they should both be installed on the same network. The start argument starts Extension Designer, Policy Center, and database will start. To stop DTP Enterprise Pack applications, run the dtpservices script with the The following table lists all available commands: Installs deployed slices into DTP. This command is only available if DTP and Extension Designer are installed as the same user on the same machine. For Windows, the DTP_HOME environment variable is set if DTP is installed on the machine. For Linux, PST_HOME is set under $HOME/.pstrc_<hostname>. Potential Errors When Stopping on Linux In some unexpected instances, you may see the following message when running the "Time out on DTP Enterprise Pack process termination. Please kill all processes manually. (Refer to the documentation)" This message only triggers if any of the children processes of the main DTP Enterprise Pack application (typically one of the service processes) started but was not killed completely. These processes must be terminated before starting DTP Enterprise Pack again. You can configure the DTP Enterprise Pack database to archive log files, which eases system administration resources. The DTP Enterprise Pack startup process enables the ability to rotate database logs, but your system administrator must perform additional tasks for the database to begin archiving logs. In addition, the process is specific to the operating system running Enterprise Pack. The The Enter the host and port number in a browser address bar to open Extension Designer and Policy Center. The following examples use the default ports, but the actual port number depends on the availability of the port. See System Requirements: If SSL is enabled, the protocol will be https (see Enabling SSL). You will also be able to access Enterprise Pack applications from the settings menu in DTP. Policy Center will be available from the DTP applications menu. Extension Designer and Policy Center must be configured for use within your DTP environment. This includes: After starting an Enterprise Pack application, choose Settings from the gear icon menu to access the configuration page. You can also access the settings from Policy Center by choosing Settings from the gear icon menu. See DTP Enterprise Pack Configuration for details. You can add a custom logo to the header of Enterprise Pack applications. To add a custom logo, replace the png at /public/lib/custom-logo.png with your company logo. The image file must be named "custom-logo.png". The dimensions of the image container is 300px by 35px. The following table provides working definitions of concepts and terms associated with DTP Enterprise Pack applications. Service In the context of this technology, a service is a group of one or more flows or artifacts that can perform specialized tasks. Services can provide custom REST endpoints, custom widgets for DTP, custom practices for Policy Center, trigger actions in third-party system, etc. Services in DTP Enterprise Pack should not be confused with web services or components that are more generally described as services. Flow Node Artifact Model ProfileUpgrading from a Previous Version
dtpservices.bat upgrade --target <dir>
Specify the directory of the older version with the --target
argument.Migrating PIE Slices to Extension Designer
Backing Up
dtpservices.bat stop
dtpservices.bat backup --target <dir> --output <dir>
The --target
and --output
arguments are optional.
Specify the directory you want to backup with the --target
argument. If not defined, the parent of the current directory and its children are backed up.
Specify the destination directory for the backup with the --output
argument. If not specified, the backup archive will be placed in the parent of the current directory.Restoring a Backup Archive
dtpservices.bat stop
dtpservices.bat restore --src <your-backup-file.zip> --target <dir>
Specify the archive you want to restore with the --src
argument. This argument is required.
Specify the directory you want to restore the archive to with the --target
argument. This argument is optional. If not specified, the archive will be restored in the current directory.Additional Installation Notes
Enabling SSL
enabled
property to true
and set the options to use your certificate. See the node.js documentation for a complete list of options. If the certificate was created with a passphrase, then be sure to include it in your configuration.Licensing
System Requirements
Operating System Hardware Software Browser Network Starting and Stopping Applications
start
argument:
Windows:dtpservices.bat start
Linux:dtpservices.sh start
stop
argument:dtpservices.bat stop
Command Output dtpservices.bat start
Starts all servers and the database. Also see Configuring Log Rotation for the Database. dtpservices.bat stop
Stops all servers and the database. dtpservices.bat install-addon
dtpservices.bat status
Reports the status for DTP Enterprise Pack applications and services. If you are experiencing issues with Extension Designer, Policy Center, or any of your flows, run this command to verify that components and services are running. stop
on Linux: pgrep node or pgrep -f <installation home>/nodejs/bin/node
This command will print out all processes that DTP Enterprise Pack started.pkill node
or pkill -f <installation home>/nodejs/bin/node
Configuring Log Rotation for the Database
Linux
logrotate
command configures and starts log rotation using a configuration file. The following snippet is an example configuration file–your actual configuration file should be written according to your organization's needs:"/home/qa/parasoft/dtpservices/logs/mongodb.log" {
size 5M
missingok
rotate 5
compress
delaycompress
}
logrotate -v --state ~/parasoft/dtpservices/logs/status.tmp ~<path to your configuration file>
status.tmp
is not required; you can point to any location where you have write permission. Windows
logrotate
command is not native on Windows. You can download a utility that provides this functionality (e.g., LogRotateWin from https://sourceforge.net/projects/logrotatewin/). A configuration file is also required to configure and start rotation. The following snippet is an example configuration file–your actual configuration file should be written according to your organization's needs:"C:\parasoft softwares\dtpservices\logs\mongodb.log" {
size 5M
missingok
rotate 5
compress
delaycompress
postrotate
"C:\parasoft softwares\dtpservices\mongodb\bin\mongo.exe" --port 8316 --eval "db.runCommand('logRotate')" admin
endscript
}
C:\Program Files (x86)\Ken Salter\LogRotate>logrotate.exe -v --state "C:\temp\status.tmp" <path to your configuration file>
status.tmp
is not required; you can point to any location where you have write permission. Accessing Enterprise Pack Applications
Setup and Configuration
Branding Extension Designer and Policy Center
Important Concepts and Terminology
Flows are one or more nodes that can perform specialized tasks. Flows can be grouped into services to more evenly distribute data processing across endpoints, which results in more stable execution. Nodes are the basic building blocks for creating flows and services that can perform specialized tasks. Artifacts are complete services or flows that can be downloaded and installed from the marketplace (see Downloading and Installing Artifacts) or created locally and uploaded to Extension Designer. Policy Policies are non-functional requirements that can be automatically monitored in an exception-based manner. See Core Policy Center Concepts for additional information. Practice A practice can be any means of automatically assessing the software being produced, such as static analysis, metrics analysis, code coverage, and unit testing. See Core Policy Center Concepts for additional information. Gate Gates measure compliance to one or more policies at a particular point in time. If the policy expectations are not met, the gate can prevent the software from proceeding to the next phase of the SDLC. See Core Policy Center Concepts for additional information. If you want to perform custom calculations within the context of a flows or services, you can create a model, which defines the template for the data used to perform the specific type of calculation. Specific instances of a model are called profiles, which can be used in a flow to carry out the custom calculation. See Working with Model Profiles for additional information. Each instance of a model is a profile. Profiles must be paired with flows that can consume the data associated with the specific type of calculation. See Working with Model Profiles for additional information.