Previous Next
Opalis Integration Server > Foundation Objects > File Management > PGP Encrypt File

PGP Encrypt File
The PGP Encrypt File object encrypts a file or an entire folder tree using a PGP key file that you have created. When encrypting an entire folder, the folder tree is preserved from the root folder down. For example, if you encrypt C:\Documents and Settings\Administrator\My Documents\*.* and all sub-folders, all files below My Documents are encrypted as well as all files within folders under My Documents. All files that are in sub-folders will be in the same sub-folder in the Output folder.
Note: To use this object you must install GPG.exe. For more information see the Opalis Integration Server Administrator’s Guide.
Note: This object supports DSS and RSA4 keys. RSA keys are not supported by this object.
How it is used
Use the PGP Encrypt File object to encrypt files before backing them up.
Configuration
To configure the PGP Encrypt File object you will need to know the path of the files that you want to encrypt, and the output folder where the encrypted files will be stored.
Details Tab
 
Path
Type the path of the files that you want to encrypt. You can use wildcards such as ? and * to specify the files that you are encrypting.
Include sub-directories
Select this option to find all the files that match the filename that you specified in all the sub-folders of the folder that you specified in the path.
Output folder
Type the path of the folder where you want the encrypted files to be stored.
Skip
Select this option to skip encrypting a file when a file with the same name is found in the Output folder.
Overwrite
Select this option to overwrite any files with same name as the resulting encrypted file.
Create unique name
Select this option to give the encrypted file a unique name if a file with the same name already exists.
File extension
Type the file extension that you want to appended to the filename when it is encrypted.
Advanced Tab
 
Key file
Type the location of the PGP key file that you will use to encrypt the files. If you leave this field blank, the PGP Encrypt File object uses the file that you specify in the Keyring folder field below. Files can have any extension, but *.asc is the standard.
Keyring folder
Type the location of the folder that contains the keyring that you will use to encrypt the files. The public keyring file (*.pkr) may be renamed with a *.gpg extension.
User
Type the user name that was specified when the encryption key was created. This is a required field.
Comment
Type the comment that was specified when the encryption key was created. If this field was completed when the encryption key was created, you must provide this information when using this object.
Email
Type the email address that was specified when the encryption key was created. This is a required field.
Available Published Data
 
Name
Description
Key file
The path of the key file used to encrypt the files.
Keyring folder
The path of keyring folder that contains the key used to encrypt the files.
User
The name of the user that was used to encrypt the files
Comment
The comment that was used to encrypt the files.
Email
The email address that was used to encrypt the files.
Output folder
The path of the folder where the encrypted files were saved.
Files to encrypt
The number of files that Opalis Integration Server attempted to encrypt.
Files encrypted
The number of files that successfully encrypted.
Encrypted filename
The path of the resulting encrypted file.
Common Published Data

Previous Next