There are several ports which need to be opened for the API to be accessed through a firewall.
- RMI Server port. This defaults to 9099, but can be changed in the API Administrator Tool (more about this later on in this document)
- CompressionService port. This defaults to use any available (unspecified) port. This setting can be changed in the API Administrator Tool (more about this later on in this document)
- SSLService This defaults to use any available (unspecified) port. This setting can be changed in the API Administrator Tool (more about this later on in this document)
- StandardService This defaults to use any available (unspecified) port. This setting can be changed in the API Administrator Tool (more about this later on in this document)
- HTTP port. This is usually 8080, but please check the settings on your web server and in the API Administrator Tool (more about this later on in this document)
It is not actually necessary to have all of CompressionService, SSLService and StandardService enabled as the RMI Server is able to function with just one of these services. However it’s possible to have a web application decide which service to use at run time, so all three are enabled by default. If, however, you know you’re only going to use one of these services, you can disable the other two and only open a port for the one you intend to use.
The API Administrator Tool can be accessed on a Windows System via Start, Programs, Primavera Integration API x.x, Primavera Administrator.
All of these settings are Configurations > Custom > {ConfigurationName} > IntegrationServer > RMI where {ConfigurationName} is the name of the configuration being used for the Primavera API.
The settings available are as follows:
RegistryPort – Port for the RMI Registry (default setting is 9099).
Enable – Enables (true) or disables (false) the RMI server (default setting is true).
StandardServiceEnable – Enables (true) or disables (false) the Standard service mode (default setting is true).
StandardServicePort – Port to use for Standard service mode. A setting of 0 (default) means that any available port will be used. If the server will be accessed across a firewall, you must set this to a specific port.
CompressionServiceEnable – Enables (true) or disables (false) the Compression service mode (default setting is true).
CompressionServicePort – Port to use for Compression service mode. A setting of 0 (default) means that any available port will be used. If the server will be accessed across a firewall, you must set this to a specific port.
SSLServiceEnable – Enables (true) or disables (false) the SSL service mode (default setting is true).
SSLServicePort – Port to use for SSL service mode. A setting of 0 (default) means that any available port will be used. If the server will be accessed across a firewall, you must set this to a specific port.
The Primavera Administrator tool:
![]()
All this information can be found in the Programmers Reference HTML file which installs with the API. A copy of the Programmers Reference document for version 4.1 is attached below:
Programmers Reference document for version 4.1
|