Import/Export Target and Process Policies

Previous Next  Print this Topic

Policy import and export functionality offered by SoleraTec's Phoenix VCM allows you to save policies, restore policies, and copy sets of policies from one computer to another. After creating a set of policies, you can export them to a policy file. Then, at a later time, if you want to re-implement the set of policies or implement them for the first time on another computer, they are there for import.

Use the import and export functionality to take a snapshot of the working policy configuration, bring new computers online, test different policy configurations, or restore user corrupted policy configurations.

By default, Target and Process policies are exported to TgtProcSvc.cfg. Data service policies are exported to DataSvcsSvc.cfg.

Although each policy editor uses only one policy set at a time, multiple policy sets exported to policy files can be used. Create, name, and use any file naming convention for policy files, and be sure to keep track of where policies are exported to if it is a location other than the default location (the user's home directory).

Before restoring a set of policies to a computer that currently has policies set up, be sure to delete all of the current policies before importing other policies - otherwise imported policies are added to current policies.

Although Target and Process policies that ingest data from Microsoft Exchange Server can be created and run on only Windows computers, Exchange Server policies can be imported to, modified on, and re-exported from Linux and Mac computers.

Data Service policies are incompatible with other client policies and vice versa. If you try to import a Data Service policy into a non-Data Services policies client (or vice versa), an error message appears and no policies are added.

Import Policies

When importing policies, they are added to the policies that are already in the policy editor.

1.From the application's main menu (or policy editor), click File > Import from. The Import from window appears.
2.If you are not importing policies from your local computer, navigate to the networked computer that contains the policies that you need.
3.Select the policy file that contains the policies that you want to use.
4.Click Open. The policies in the configuration file are implemented.

Export Policies

1.Create policies.
2.From the application's main menu (or policy editor), click File > Export to. The Export to window appears.
3.To save your policies with the default policy file name, click Save without entering a new file name. Or, enter a new name In the Export to window, and then click Save.

Import/Export Policy File Structure

An exported policy file is block structured but free from any column or order formatting. The tokens listed below specify job criteria. By default, policy files are exported to and imported from the locations below:

Data Service Policies

<install-dir>/Config/DataSvcsSvc.cfg.

Target and Process Policies

<install-dir>/Config/TgtProcSvc.cfg.

Files that contain policies are formatted as follows. Each policy is a single block. The beginning of each block is indicated by policy_name="<policy name>".

policy_name="<policy name>"
[
 <token>=<value>
 <token>=<value>
 . . .
]

policy_name="<policy name>"
[
 <token>=<value>
 <token>=<value>
 . . .
]

. . .

Token/Value Pairs

A token is a job attribute that is given a value that determines how the job runs.

Token/Value

Description

act_log_enabled = <boolean>

Enable the creation of activity logs.

Valid values: true | false

Default = false

act_log_pn = "<pathname>"

Define the path for the activity log. Supports token substitution.

Default path = "%R/Logs/%P.act"

absolute_start = <yyyy>/<mm>
/<dd>-<hh>:<mm>:<ss>

The exact start time and date that the job is to run. Multiple absolute start tokens may be entered.1, 2

active = <boolean>

Define if the policy is active or inactive.2

Valid values = true | false

Default = true

admin_pn = "<pathname>"

The directory that contains the log, retry, and history files. Supports token substitution.

Default path = "<install-dir>/JobHistory/"

any_user_retrieve = <boolean>

Allows any user to retrieve a file in the job, regardless of the initial read access.

Valid values = true | false

Default = false

backup_data

Internal use only.

backup_stub

Internal use only.

complete = <boolean>

Print all summary information plus the path names of the files ingested to the file indicated by the list_pn option.

Valid values = true | false

Default = false

compress

Internal use only.

create_job_history = <boolean>

Create job history files for each job.

Valid values = true | false

Default = false

data_paths = <number>

The maximum number of concurrent files that can be sent.

Default = 1

description = "<character string>"

A description of the policy.2

Default = blank

diag = <boolean>

Print diagnostic information to the file indicated by the list_pn option.

Valid values = true | false

Default = false

dir_spec = "<pathname>"

Directories to include. Multiple dir_spec options can be specified. The dir_spec check is made for every directory found. This includes the directories contained in the path name list that the job  traverses.

Default = "*" (any)

display_only = <boolean>

Cause job to search for but not store targeted files. List the files that would have been ingested.

Valid values = true | false

Default = false

dst_local_only = <boolean>

Cause job to use only a Vault local to the computer from where service is running.

Valid values = true | false

Default = false

dst_media_name = "<character string>"

The destination media to be used. If not specified, the first available unit of media is used.

Default = "*" (any)

dst_media_speed = "<character string>"

The destination media to be used according to media speed.

Valid values =

S0 - S10
Unspecified

Default = Unspecified

dst_media_type = "<character string>"

The media type to be used for a job.

Valid values =

Hdisk – Hard disk
8mm – Eight-millimeter tape
Dds – Digital data storage
Dlt – Digital linear tape
Ait – Advanced intelligent tape
SuperAit
Vxa - Exabyte Vxa tape
Travan - Travan tape
Lto – Linear tape open
MagOptical – Read/write optical
NullDevice
Unspecified

Default = Unspecified

dst_storage_pool = "<alpha>"

The name of the destination storage pool. Use ''" for no storage pool name.

Default = "*" (any)

dst_vault_name = "<character string>"

The destination Vault name. If not specified, the first available Vault is used.

Default = "*" (any)

dst_volume_format

Internal use only.

dst_volume_name

Internal use only.

dst_volume_pack

Internal use only.

dtu_type = <alpha><yyyy>/<mm>
/<dd>-<hh>:<mm>:<ss>

or

dtu_type = L<level>

Ingest files based on time and date or job level.

Valid values =

AO (Absolute Old) – Select files with a dtu (date_time_use) equal to or before the specified date. Enter the year as a 4-digit number.
AN (Absolute New) – Select files with a dtu equal to or after the specified date. Enter the year as a 4-digit number.
RO (Relative Old) – Select files with a dtu equal to or before the relative specified date.
RN (Relative New) – Select files with a dtu equal to or after the relative specified date.
L0 – Ingest all files.
L1 – Ingest all data changed since the last L0 job.
L2 – Ingest all data changed since the last L1 job.
L3 – Ingest all data changed since the last L2 job.
L4 – Ingest all data changed since the last L3 job.

Default = L0

error_log = "<pathname>"

The path for the error log file. If you specify "/dev/tty", error messages display on the default output device. Supports token substitution.

Default path for the configuration file = "R/Logs/%P.err"

exclude_dir_spec = "<pathname>"

Omit directories. Accept multiple instances.

Default = "" (no directories excluded)

exclude_file_spec = "<pathname>"

Omit files. Accept multiple instances.

Default = "" (no files excluded)

ext_metadata = "<command>"

Extended metadata in a token/value pairs. Token/values can be found in the MetadataExtensions.cfg

Format:

token="<command>"token="<command>"...

Default = ""

ext_metadata_plugin = "<character string>"

Enable the collection of extended metadata.

Default = "EmdProcessNone"

file_grouping_plugin = "<character string>"

Enable file grouping.

Default = "FgProcessNone"

file_spec = "< pathname>"

Files to be ingested. This token/value pair can be specified multiple times to include multiple file filters.

Default = "*" (any)

follow_links

Internal use only.

host_Id = "<character string>"

Where the Target and Process Service runs.2

Default = blank

include_offline

Internal use only.

job_type = <alpha>

Specify the job type.

Valid values =

backup
move

Default = backup

list_pn = "<pathname>"

The filename where all report information is written. Supports token substitution.

Default path for the configuration file is "%R/Logs/%P.log"

local_only = <boolean>

Specify that the ingested file is to reside on the local computer.

Valid values = true | false

Default = true

localize = <boolean>

All subsequent files in the same job are sent to the same unit of media until it is full.

Valid values = true | false

Default = true

lock_vault

Internal use only.

obj_type = "<character string>"

The policy source.

Valid values =

native_fs
mse_pst
mse_msg

Default = native_fs

out_of_band = <boolean>

Enable the application to constantly monitor its processes and select the network transmission protocol that best suits the files being processed.

Valid values = true | false

Default = true

pathname = "<pathname>"

The path name that is searched for files matching the options. Files, directories, and wildcard expressions are valid. This token/value pair can be specified multiple times to include multiple paths.

No default

pict_gen_preview_image = <boolean>

Generate preview image thumbnails at capture/ingest.

Valid values = true | false

Default = true

pict_preview_image_quality = <boolean>

Determine the quality of the preview image.

Valid values = High | Medium | Low

Default = Medium

pict_process_components = <boolean>

Capture/ingest picture files so that they are readable by search applications.

Valid values = true | false

Default = false

pict_save_preview_image = <boolean>

Save a preview image at the path entered in pict_save_preview_image_dir_pn.

Valid values = true | false

Default = false

pict_save_preview_image_dir_pn = "<pathname>"

The path where the copy of the preview image is saved.

Default path = ""

policy_name = "<policy name>"

The job identifier.

No default

post_proc_cmd = "<command>"

A post-process command that runs immediately after the job is finished. Supports token substitution.

Default = ””

pre_proc_cmd = "<command>"

A pre-process command that runs immediately before the job starts. Supports token substitution.

Default = ””

process_directories = <boolean>

Preserve the state of directories.

Valid values = true | false

Default = true

ref_id = "<character string>"

Internal use only.

repeat_interval = <hh:mm:ss>

The amount of time that elapses before a job is repeated.1, 2

Default = 24:00:00

retry_time = <alpha><yyyy>/<mm>
/<dd>-<hh>:<mm>:<ss>

The date and time to retry the list of files not ingested. These files match all job criteria but were not sent to the Vault. You must precede the date/time value with an A to specify an absolute date and time or an R to specify a date and time relative to the end of the job. Enter the absolute year as a four-digit number (for example, 2001, 2002, etc.).

Valid values =

A – Absolute date and time.
R – Relative date and time.

Default = R0000/00/00-00:00:00 (retry files immediately after the job finishes)

start_days = <mtwtfss>

The days the job runs. Use - to indicate days the job should not run.

For example, if the job is to run on Thursday, you would enter ---t---.1, 2

Default = mtwtfss

start_time = <hh:mm:ss>

The time the job should start for each defined start day in start_days.1, 2

Default = 00:00:00 (midnight)

stop_time = R<yyyy>/<mm>
/<dd>-<hh>:<mm>:<ss>

The date and time the job is to stop. The date and time entered is relative to the start of the job.

R = relative to the start of the job.

Default = R0000/00/00-00:00:00 (no stop time)

summary = <boolean>

Print the start and finish times of the job and the final statistics to the file indicated by the list_pn option.

Valid values = true | false

Default = true

system_info = <boolean>

Ingest system info and other system states.

Valid values = true | false

Default = false

throttle = <setting>

The throttle controls the amount of bandwidth used by jobs (and, the speed files are sent to Vaults). Throttle values are relative to Information Repository capacity and range from 1% to 100%. A lower setting reduces the amount of available bandwidth that is used.

Default = 100

timestamp = <alpha>

Specify the timestamp of the file that is to be examined when determining if the file meets the dtu_type criteria.

atime - access time
mtime - modified time

Default = mtime

type = <alpha>

The policy type of the policy file.2

Default = tap

update_run_record = <boolean>

Update the job run record (<install-dir>/JobHistory/run_record.trr) whenever a "level” job runs.

Valid values = true | false

Default = true

vcs = <alpha><max num files>

The number of files (F) or number of bytes (S) to ingest per single Vault connection.

Valid values =

F – files
S – bytes
1 -

Default = F500

version = <number>

The version number of the policy. The current version is 1.0.2

vid_extract_closed_caption = <boolean>

Extract closed captioning data from a video at ingest.

Valid values = true | false

Default = true

vid_gen_low_res_proxy = <boolean>

Generate low resolution proxy videos at capture/ingest.

Valid values = true | false

Default = true

vid_gen_preview_image = <boolean>

Generate preview image thumbnails at capture/ingest.

Valid values = true | false

Default = true

vid_low_res_proxy_quality = <setting>

Determine the quality of the low resolution proxy video.

Valid values = High | Medium | Low

Default = Medium

vid_preview_image_quality=<setting>

Determine the quality of the preview image.

Valid values = High | Medium | Low

Default = Medium

vid_process_components = <boolean>

Capture/ingest video files so they are readable by Phoenix VCM search applications.

Valid values = true | false

Default = false

vid_save_closed_caption = <boolean>

Save a copy of the closed captioning data in a location specified by vid_save_closed_caption_dir_pn.

Valid values = true | false

Default = false

vid_save_closed_caption_dir_pn = "<pathname>"

The path where the closed captioning file is saved.

Default path = ""

vid_save_low_res_proxy = <boolean>

Save a copy of the low resolution proxy video at the location entered in vid_save_low_res_proxy_dir_pn.

Valid values = true | false

Default = false

vid_save_low_res_proxy_dir_pn = "<pathname>"

The path where the copy of the low resolution proxy video is saved.

Default path = ""

vid_save_preview_image = <boolean>

Save a preview image at the path entered in vid_save_preview_image_dir_pn.

Valid values = true | false

Default = false

vid_save_preview_image_dir_pn = "<pathname>"

The path where the copy of the preview image is saved.

Default path = ""

1Note: Timing tokens are mutually exclusive. Only one timing token may be set. In other words, you may set either absolute_start, or repeat_interval, or start_days and start_time.

Sample Target and Process Policy

The following is an example of an exported policy:

#

# Start of object rule for policy_name 'Test Policy'

#

policy_name = "Test Policy"

[

 type                               = "tap"

 version                            = "1.0"

 active                             = true

 job_type                           = backup

 obj_type                           = "native_fs"

 description                        = "test"

 dtu_type                           = L0

 local_only                         = true

 follow_links                       = false

 process_directories                = true

 timestamp                          = mtime

 backup_stub                        = false

 backup_data                        = false

 include_offline                    = false

 dst_media_type                     = Unspecified

 dst_media_speed                    = Unspecified

 dst_volume_format                  = Unspecified

 dst_vault_name                     = "*"

 dst_media_name                     = "*"

 dst_volume_name                    = "*"

 dst_storage_pool                   = "*"

 dst_volume_pack                    = ""

 dst_local_only                     = false

 localize                           = true

 start_time                         = 00:00:00

 start_days                         = mtwtfss

 stop_time                          = R0000/00/00-00:00:00

 pre_proc_cmd                       = ""

 post_proc_cmd                      = ""

 error_log                          = "%R/Logs/%P.err"

 summary                            = true

 complete                           = false

 diag                               = false

 list_pn                            = "%R/Logs/%P.log"

 display_only                       = false

 update_run_record                  = true

 create_job_history                 = false

 retry_time                         = R0000/00/00-00:00:00

 any_user_retrieve                  = false

 out_of_band                        = true

 vcs                                = F500

 data_paths                         = 1

 throttle                           = 100

 system_info                        = false

 act_log_enabled                    = false

 act_log_pn                         = "%R/Logs/%P.act"

 ext_metadata_plugin                = "EmdProcessNone"

 file_grouping_plugin               = "FgProcessNone"

 vid_process_components             = false

 vid_gen_low_res_proxy              = true

 vid_low_res_proxy_quality          = Medium

 vid_save_low_res_proxy             = false

 vid_save_low_res_proxy_dir_pn      = ""

 vid_gen_preview_image              = true

 vid_preview_image_quality          = Low

 vid_save_preview_image             = false

 vid_save_preview_image_dir_pn      = ""

 vid_extract_closed_caption         = true

 vid_save_closed_caption            = false

 vid_save_closed_caption_dir_pn     = ""

 pict_process_components            = false

 pict_gen_preview_image             = true

 pict_preview_image_quality         = Medium

 pict_save_preview_image            = false

 pict_save_preview_image_dir_pn     = ""

 ext_metadata                       = "Company="Frank's Media""

 ref_id                             = 697d68f117c311e2b97588f218d4aa9b

 compress                           = false

 lock_vault                         = true

]

 

# end of object rule for policy_name 'Test Policy'