Configuring extra arguments for a content delivery configuration

Use the following instructions and the properties described in the extra arguments table to configure extra arguments for a content delivery configuration.

To create or modify extra arguments:

  1. On the Extra Arguments page, click Edit.

    The extra_arguments page appears.

  2. In the Enter new value box, type an argument for the content delivery configuration.

    For example, type mail_notification_on success or mail_notification_user documentum.

  3. Click Add to move the extra argument.

    You can use the Move Up or Move Down buttons to rearrange the order of the extra arguments. To delete an argument, select an extra argument on the right side and then click Remove.

  4. Click OK.

Table 12.5. Extra arguments

KeyDescriptionDefault Value(s)

use_docbase_formats

Determines whether the default file format extensions set in the repository are used when files are published.

FALSE overrides the default file format extensions set in the repository. TRUE or no setting uses the extensions set in the repository format objects.

TRUE

use_text_file_extensions

When set to TRUE, text files that do not have a .txt extension in the object name are published with the .txt extension. For example, if a text file MyFile is published and the parameter is set to TRUE, the file is published as MyFile.txt. If the parameter is set to FALSE, the default value, the file is published as MyFile.

FALSE

agent_connection_timeout

The timeout interval in seconds for the IDS publish method’s connection to the target host. For example, to wait 90 seconds:

agent_connection_timeout=90

If the publishing operation takes longer, Documentum Administrator displays an error message and the publishing log files record that the publishing operation failed.

120

connect_thread_timeout

The timeout interval in seconds for the end-to-end tester’s connection to the target host. For example, to wait 90 seconds:

connect_thread_timeout=90

30

lock_sleep_interval

The number of seconds for which IDS waits for a webc lock object to be unlocked. For example, to wait 90 seconds:

lock_sleep_interval=90

10

lock_retry_count

How many times IDS checks whether the webc lock object is unlocked. The value of this key multiplied by the value of lock_sleep_interval controls the total amount of time for which IDS waits to lock a configuration with a lock object.

Since the default lock_sleep_interval value is 10 seconds, IDS retries for a total of 300 seconds (5 minutes) by default.

30

disable_dctm_tag

Whether you want the Documentum META tag to appear when you use META tag merging.

TRUE

trace_passwords

Whether passwords appear in debug tracing output. FALSE causes passwords to be omitted from debug tracing output. TRUE causes passwords to be included in debug tracing output.

FALSE

error_threshold

The number of errors allowable on the source side during a single full-refresh, incremental, or force-refresh publishing operation.

0

max_cached_ssl_sockets

The number of cached SLL sockets between source and all targets that are retained for reuse. Does not restrict the maximum number of SLL sockets that can be open at one time. Used only in the scs_admin_config object in the IDS Administration sub-node.

30

publish_contentless _documents

Whether documents can be published that do not have associated content files. TRUE causes publication of documents without associated content files. FALSE causes documents without associated content files not to be published.

Note

This option can also be selected on the Advanced tab of the content delivery configuration.

FALSE

publish_folder_properties

Whether folder properties can be published. TRUE causes folder properties to be published. FALSE causes folder properties not to be published. If set to TRUE, requires that publish_contentless_documents is also set to TRUE.

Note

This option can also be selected on the Advanced tab of the content delivery configuration.

FALSE

compression

Whether file compression is enabled. TRUE causes files to be compressed. FALSE disables file compression.

TRUE

min_size_worth _compressing

The threshold in bytes beneath which compression of a particular file does not yield performance gains

5000

max_entries_per_zipfile

The number of files whose size is below min_size_worth_compressing that are collected in a zip file for transfer to the target host.

128

extensions_to_compress

The file types to compress, by file extension.

html, jhtml, shtml, phtml, xhtml, htm, jht,sht, asp, jsp, xml, css, txt

publish_source_version_labels

When set to TRUE, all values of the r_version_label attribute are published to the repeating attribute table.

FALSE

mssql_store_varchar

Microsoft SQL Server database only. When set to TRUE, string attributes are stored in the source catalog database and target database as varchar rather than nvarchar.

When set to true, you cannot publish multibyte data.

FALSE

store_log

Whether to store log files in the repository. Valid values are:

  • TRUE: The logs are stored in the repository.

  • FALSE: The logs are not stored in the repository.

The log is not stored in the repository for a single-item publishing operation when method_trace_level is set to 0.

TRUE

store_log_fileDetermines whether publishing logs are deleted or retained on the source host. If the key is set to TRUE, publishing logs are preserved. If the key is set to FALSE, the trace level is less than 10; if the publishing operation succeeds, the log files are deleted. 

method_trace_level

The level of tracing output. 0 is the lowest level of tracing and 10 is the highest level of tracing.

Note

To get LDAPSync debug information, use method_trace_level 8. To get verbose debug information, use method_trace_level 10.

0

export_threshold_count

Indicates the number of items the export operation exports at one time.

100

use_format_extensions

Use with format key to check for valid format extensions.

If use_format_extensions is set to FALSE, files are published with the format extensions defined in the repository for the format.

If use_format extensions is set to TRUE and a particular extension is defined as valid for a particular format, files of that format with that extension are published with the extension.

If use_format_extensions is set to TRUE and a particular extension is not defined as valid for a particular format, files of that format with that extension are published with the format extensions defined in the repository for the format.

FALSE

format

Use with use_format_extensions key. Takes the format:

format.format_name=semicolon-separated_extensions

 

force_serialized

When set to TRUE, single-item publishes are performed serially rather than in parallel.

FALSE

source_attrs_only

By default, on each publish IDS creates a properties.xml file, which contains all the attributes of the objects published. If source_attrs_only is set, IDS writes only the default attributes and any additional attributes that are published to the XML file.

  • r_object_id

  • r_modified_date

  • object_name

  • i_chronicle_id

  • r_version_label

  • content_id

  • i_full_format

  • r_folder_path

FALSE

additional_metatag_file_exts

Allows exported attributes to be added as metatags to file formats with the extensions asp, jsp, jht, and sht. Add them as a semicolon-separated list:

additional_metatag_extensions=asp;jsp;jht;sht

No default value.

export_relations

When set to TRUE and attributes are published, relation objects (dm_relation objects) are published to a database table on the target.

FALSE

clean_repeating_table_no_attrs

Deprecated.

 

export_media_properties

When set to true, attributes of the dmr_content object and dm_format object are exported and published to the target.

FALSE

additional_media_properties

When export_media_properties is set to true, used to specify additional attributes of dmr_content and dm_format objects to be published. The format is a semicolon-separated list:

additional_media_properties=type1.attribute1;type2.attribute2

For example:

additional_media_properties=dmr_content.x_range;dmr_content.z_range

FALSE

exclude_folders

A semicolon-separated list of absolute repository paths, indicates the folders to be excluded from a publishing operation. When set, content files and attributes from folders indicated are not published. For example:

exclude_folders=/acme.com/images;/acme.com/subdir 

 

pre_webroot_switch_script

A script to be run before online synchronization takes place. For more information, refer to "Scripts run before or after the Webroot Switch" in the Interactive Delivery Services User Guide.

 

post_webroot_switch_script

A script to be run after online synchronization takes place. For more information, refer to "Scripts run before or after the Webroot Switch" in the Interactive Delivery Services User Guide.

 

full_refresh_backup

When set to TRUE, the content files and database tables on the target host are backed up before the synchronization phase in a full-refresh publishing operation.

FALSE

exclude_formats

Takes a semicolon-separated list of format extensions and excludes content files with those extensions from publishing. For example to exclude .xml and .wml files:

exclude_formats=xml;wml

Not set

check_valid_filename

If this parameter is set to TRUE, then the filename is checked for Windows illegal characters. Illegal characters are replaced as specified by the filename_replace_char parameter.

The default value of check_valid_filename is TRUE if the IDS source is on Windows; the default is set to FALSE for all other operating systems. This parameter should be used if the target is on a Windows host and the source is not on Windows.

TRUE (Windows only); FALSE for all other O/S

filename_replace_char

Windows only. Used in conjunction with check_valid_filename. Defines the character to use to replace invalid characters in file names on Windows. For example:

filename_replace_char=0

_ (underscore)

sync_on_zero_updates

When set to TRUE, database updates are made and pre- and post-synch scripts are run even if there is no new data to publish from the repository.

FALSE

transform_type

Used with Web Publisher Page Builder only.

Determines whether links in HTML pages are resolved at publication time to absolute or relative paths. Valid values are absolute and relative.

absolute

recovery_publish_retry_countControls the number of times IDSx tries to recover from a failed incremental publishing operation. The value is an integer that represents the number of times IDSx retries the publishing operation. 
set_tcp_delayDetermines TCP protocol behavior. With the default setting of FALSE, packets are sent to the target as soon as they are written on the source side; IDSx does not wait until the sockets buffer is filled or there is a timeout. For debugging purposes, this parameter can be set to TRUE. The setting must match the same key in agent.ini.FALSE
ingest_workflow

Used with Content Delivery web service only. Specifies a custom workflow to be used with the ingest operation. Refer to the Documentum Enterprise Content Services Reference Guide for details about this web service.

Note

This argument can be set at the repository (IDS Administration) level only. You cannot specify different ingest workflows for individual content delivery configurations.

 
wan_acceleration_ssh_port

This is the TCP Port required for accelerated data transfer authentication. If the SSH port has to be changed, check the SSH service configuration (sshd_config) for windows for changing the default port.

The default value is applicable to all publishing configurations and can be overridden for each publishing configuration, by setting this as an extra argument for publishing.

22

wan_acceleration_disabled

This parameter is used to disable the accelerated data transfer and use HTTP for file transfer.

False

wan_acceleration_policy

This parameter defines the policy used for accelerated data transfer.

  • ADAPTIVE/FAIR (A): When set to this value, the file transfer monitors and adjusts the transfer rate to fully utilize the available bandwidth to the maximum limit. When there is congestion due to other file transfers, this mode shares bandwidth for other flows and utilizes a fair rate of transfer. In this mode, both the maximum and minimum transfer rates are required.

  • FIXED (F): When set to this value, the file transfer happens at a specified target rate, irrespective of the actual network capacity. In this mode, a maximum transfer rate is required.

  • TRICKLE/STEALTH (T): When set to this value, the file transfer uses the available bandwidth to the maximum rate. When there is congestion due to other file transfers, the transfer rate is reduced down to the minimum rate.

A

min_file_transfer_rate

This is the minimum file transfer rate

0 Mbps
max_file_transfer_rate

This is the maximum file transfer rate

1000 Mbps
wan_acceleration_log_details

The file transfer process status are captured in the content delivery log files

FALSE

wan_acceleration_file_checksum

This parameter is used to resume file transfer when there is a failure.

  • FILE_ATTRIBUTES: When set to this value, checks for the file size of both files. If the file size is the same, then transfer does not take place.

  • FULL_CHECKSUM: When set to this value, checks for the checksum of both files. If it matches, then transfer does not take place

  • SPARSE_CHECKSUM: When set to this value, checks for the sparse checksum of both files. If it matches, then transfer does not take place

  • OFF: When set to this value, the file gets replaced

    When set to OFF, the rate of file transfer is high.

OFF

decision_commit_rollback

This parameter is used to set the threshold value for transaction capability. For example, if there are 10 replication targets, and if the DCR value reads as:

decision_commit_rollback 6
implies that if replication operation succeeds on a minimum of 6 replication targets, then a decision is taken to commit (File System and RDBMS) the changes performed by the replication operation.

If the number_of_failures value is greater than the decision_commit_rollback value, a rollback is initiated on the replication targets.

The value assigned to this attribute must be a positive integer.

NA

tc_file_count

The transaction capability is based on tc_file_size and tc_file_count.

When the number of files replicated exceeds tc_file_count, transaction capability feature is disabled.

The value assigned to this attribute must be a positive integer.

500

tc_file_size

The transaction capability is based on tc_file_size and tc_file_count.

When the size of the files replicated exceeds tc_file_size, transaction capability feature is disabled. The units is specified in MB.

The value assigned to this attribute must be a positive integer.

100 MB

use_replication_time

Use this extra argument to ensure that after replication is complete, all the replication targets will display the same time stamp as when the replication was triggered.

TRUE

use_repository_time

Use this extra argument to ensure that after replication is complete, all the replication targets will display the same time stamp as when the content was last modified in the docbase (r_modified_date when the file was replicated).

TRUE

lock_exitifbusy_flag

During publishing or replication operations, IDSx locks a configuration using a webc lock object, so that only one publishing or replication operation can take place at a time for that configuration. If you want IDSx to exit rather than retry when the publishing configuration is locked, set the lock_exitifbusy_flag argument to TRUE.

TRUE

auto_replication

Replication can be invoked automatically after a publishing operation by setting the extra argument auto_replication to TRUE in Documentum Administrator.

Note

Concurrent single item publishing at the same time as auto replication causes a considerable load on the staging target. Hence, set the extra argument lock_exitifbusy_flag along with auto_replication to TRUE. The subsequent replication process will consider all the published batches that were left unused during the creation of the previous replication batch.

TRUE
full_refresh_transactional_replication The replication process can start a transactional replication, even when the replication batch being replicated contains a full refresh publish. Replication Manager can be enhanced to start a transactional replication setting the extra arguments, full_refresh_transactional_replication and full_refresh_backup, to TRUE for full refresh publish.FALSE
post_replication_script_on_staging_targetUse this script to perform any arbitrary action on the staging target after replication is complete on all replication targets.No default value.