This section describes how to install and configure SCP on Windows, for uploading offline usage data in on-premises isolated network.
On-premises Mode
For uploading usage data for the on-premises mode, SCP is installed as a service on the proxy machine. The SCP service and RMS License Manager need not be installed on the same machine.
The topics included in this section are:
>Unzip the SCL Add-on Package
>(Optional) Specify the Path of the SCP Configuration File
>Configure SCP
•By Editing the SCP Configuration File
•By Using SCP Command-line Options
>Install SCP
>Start SCP
Unzip the SCL Add-on Package
Unzip the SCL Add-on package by using the password received in Thales order emails, to extract the Windows-specific package.
(Optional) Specify the Path of the SCP Configuration File
The default path of the SCP configuration file is <extractedfolder>\Redistributable\SentinelCloudPlugin (same as the SCP service). You can specify a different path for the SCP configuration file by using the SCP_CONFIG_FILEPATH_[vendor_alias] system-level environment variable.
The precedence of options for picking the SCP configuration file is:
>The configuration file path specified in the SCP_CONFIG_FILEPATH_[vendor_alias] system-level environment variable.
>The default configuration file path.
NOTE
The SCP_CONFIG_FILEPATH_[vendor_alias] environment variable (if defined) has higher precedence than the application directory. The environment variable to pick the configuration file should be set under the system variables for the SCP service to run successfully.
Configure SCP
There are certain settings that you need to configure before installing and running SCP. There are two ways of configuring SCP on Windows:
>By editing the SCP configuration file
>By using the SCP command-line options
By Editing the SCP Configuration File
Open the SCP configuration file and modify the following elements applicable for on-premises deployment mode:
| Element | Description |
|---|---|
| [Mandatory] YPSaddress | Specifies the URL of Directory Services (DS) which is received in emails from Thales. https://demo-yps.com/YPServer |
| [Mandatory] UsageUploadMode | Specify the mode to upload the usage data. For on-premises deployment mode, it should be set to "offline_uploader". NOTE After modifying this element in SCP configuration file, execute |
| (Optional) LoggingSettings | Specifies the logging settings. By default, logging is enabled in error mode. For details on how to change the logging settings, refer to the section Configure Logging. |
| (Optional) ProxyMode | Specifies the proxy connection mode. The possible values are: >1: Indicates that the proxy is disabled. NOTE The licensed application will not connect to the cloud if the client machine is in a proxy environment and proxy settings for SCP are not defined. >2: Refers to the manual proxy mode. In this mode, you need to manually set the proxy settings. >3: Refers to the auto proxy mode. In this mode, the proxy settings are automatically detected. For details about the advanced proxy connection mode settings, refer to the section Configure Advanced Proxy Settings. |
A Note on Applying Updated SCP Configurations
If the SCP configuration file is updated while SCP is running, the application restart is required to apply the updated settings.
>Open the SCP configuration file and modify the following element:
<OfflineUsageSetting><UsageUploadMode value = "offline_uploader"/></OfflineUsageSetting> NOTE After modifying the SCP configuration file, you need to execute the following command from the path where the SCP service is placed:sntlcloudps_[vendor_alias].exe -start.
To change the logging settings, open the SCP configuration file and uncomment the LoggingSettings section and change the options as per the requirement. Values of these settings are mentioned in comments in the configuration file itself. For example, if logging needs to be changed from error mode to debug mode, LogLevel can be changed from ‘1’ to ‘2’.
<!--<LoggingSettings><Logging value ="1"/><LogLevel value ="1"/><LogFilePath value ="scp.log"/><LogFileMode value ="2"/><LogType value ="1"/></LoggingSettings>-->
Specify the name and path of the log file in the LogFilePath element.
<LogFilePath value ="scp.log"/>
By default, the log file (.log) is created at the same location where SCP executable is placed.
To configure logging using command-line options, refer to the section SCP Command-line Options.
(Optional) Configure Advanced Proxy Settings
Open the SCP configuration file and modify the following elements:
| Element | Description |
|---|---|
| Manual Proxy Settings (ProxyMode value="2") | |
| ProxyHost | Proxy host name or IP address. |
| ProxyPort | Port at which the proxy is running. |
| Proxy Credentials (when authentication is enabled in the proxy server) | |
| ProxyUser | User name for the proxy authentication. |
| ProxyPassword | Proxy password for the proxy authentication. |
| Auto Proxy Settings (ProxyMode value="3") In this mode, the proxy settings are automatically detected. There are two automatic proxy detection methods: >WPAD (Web Proxy Autodiscovery Protocol): The proxy detection can be done by using either DNS or DHCP discovery methods. NOTE DHCP has a higher priority than DNS. The WPAD-enabled client first uses DHCP to find a proxy server, and if the desired information is not obtained, DNS is used. If the wpad.dat file is not found or if a proxy is not detected while running wpad.dat, no error is returned. Instead, the client tries to connect in a manner similar to when the proxy is disabled (No Proxy). >PAC (Proxy Auto-configuration): The location of the proxy script file is specified in the configuration file. In the auto proxy mode, WPAD takes precedence over PAC. | |
| ProxyPAC | Location of the auto-proxy configuration (.pac) file to be used for the proxy detection. Use this option for auto-proxy with the .pac file support. This option takes the URL or path of the .pac file as input. |
To configure proxy settings using command-line options, refer to the section SCP Command-line Options.
Install SCP
NOTE Please note that Admin privileges are required to perform install/uninstall operations.
By using command-line, navigate to the following directory: <extractedfolder>\Redistributable\SentinelCloudPlugin .
To install the SCP service, use the following command:
sntlcloudps_[vendor_alias].exe –install
or
sntlcloudps_[vendor_alias].exe -i
or
sntlcloudps_[vendor_alias].exe -installstart
NOTE
>The installstart option should be used after the required configurations have been set in the SCP configuration file. Otherwise, the required configurations (such as, ypsaddress) should be specified as input to the installstart option.
>To start SCP in offline mode, you need to either configure the offline mode in SCP configuration file or execute sntlcloudps_[vendor_alias].exe -is -mode "offline_uploader" command.
Start SCP
>To start SCP:
sntlcloudps_[vendor_alias].exe -start -mode "offline_uploader"
or
sntlcloudps_[vendor_alias].exe -start
NOTE The above command is applicable only when OfflineUsageSetting is already uncommented in the SCP configuration file.
>To restart SCP:
sntlcloudps_[vendor_alias].exe -restart -mode "offline_uploader"
>To stop SCP:
sntlcloudps_[vendor_alias].exe –stop
>To uninstall SCP:
sntlcloudps_[vendor_alias].exe -remove
or
sntlcloudps_[vendor_alias].exe -r
>To check whether SCP is running or not:
sntlcloudps_[vendor_alias].exe -status
For more details, refer to the section SCP Command-line Options.
