System Properties
STEP employs a variety of properties to determine some basic system settings for asset push. Many properties are best utilized in their default setting, but may need to be changed in certain situations. Except where noted, these settings can be found in the sharedconfig.properties file and affect all asset pushes in the system.
The tables below describe all system properties related to asset push, and recommendations for when to change them. Note that changing any property in the sharedconfig.properties file may require a restart of the system for the property to take effect.
AssetPush.AutoDetectedExtension.MimeTypes
|
Definition |
This defines a list of mimetypes (separated by comma) of generated content where auto-detected extensions will be applied (if part of template). Otherwise the original extension will be used. |
|
Default |
image/*,application/postscript Using the default, autodetected extensions will only be applied to image and postscript files. |
|
Additional Info / When to Change the Default Value |
Change only if the autodetect macro is used as part of the relative path template to ensure that all necessary types of files can be detected. Note that the autodetect macro is used sparingly so this property generally does not need to be changed. Can also be used as a means of filtering which assets have their extensions detected as those not listed will be pushed with their original extensions. You can use an asterisk (*) as wildcard at the end of mimetype. |
AssetPush.BatchSize
|
Definition |
This defines Upper limit to how many events to read ahead |
|
Default |
Using the default, value would be 100. Value specified for batch size must be an integer. |
|
Additional Info / When to Change the Default Value |
Consult with Stibo Systems Technical Services before changing this. |
AssetPush.Concurrency
|
Definition |
Option to run in concurrency mode. Running in concurrency mode means that more than one sidecar can get access to events in the same queue. Running in concurrency mode has the consequence that events will be marked read immediately, i.e., before processing. If processing fails, the event will no longer be available on the queue. In that case the asset must be touched to have a new event generated. Must be a Boolean (true or false). |
|
Default |
false |
|
Additional Info / When to Change the Default Value |
Typically changed only when a full download / push is being performed as it can speed up this process by allowing multiple sidecars to perform the work. Consult with Stibo Systems Technical Services before changing this or the Concurrency Level property (below). |
AssetPush.Concurrency.Level
|
Definition |
Defines the number of concurrent sidecars that will be used when the system is running in concurrency mode (refer to above). |
|
Default |
N/A |
|
Additional Info / When to Change the Default Value |
Only set if Concurrency is set to ‘true’. Refer to above. |
AssetPush.DTPConfiguration
|
Definition |
The default configuration to use from DTP Clients (IDS and QXP) when workspace is Main, in order to obtain pushed assets. The property should be an ID of the configuration. |
|
Default |
raw-main |
|
Additional Info / When to Change the Default Value |
Used for Print / InDesign asset pushes. Only relevant for new (queue-based) asset-pusher. |
AssetPush.DTPConfiguration.Approved
|
Definition |
The default configuration to use from DTP Clients (IDS and QXP) when workspace is Approved, in order to obtain pushed assets. The property should be an ID of the configuration. |
|
Default |
raw-approved |
|
Additional Info / When to Change the Default Value |
Used for Print / InDesign asset pushes. Only relevant for new (queue-based) asset-pusher. |
AssetPush.DefaultDTPClientAssetLocation
|
Definition |
Allows a default asset location to be set in the server for use by all DTP clients on site (if they have Use Default Asset Location checked in their preferences). Must be a string in the appropriate form for the DTP client and applicable platform. |
|
Default |
N/A (null) |
|
Additional Info / When to Change the Default Value |
Used for Print / InDesign asset pushes. |
AssetPush.IgnoreClassifications
|
Definition |
Defines a list of classifications (separated by semicolon ';') that will be ignored when an event is fired. ('*' will ignore all classification events). |
|
Default |
N/A (null) |
|
Additional Info / When to Change the Default Value |
Can be set to ignore classifications for asset hierarchy folders that should not be included in asset push and/or for any non-asset classification hierarchies. It is recommended to use the ‘Include Classification’ setting in the configuration rather than to exclude via this setting. However, either is acceptable and at least one (if not both) should be populated. |
AssetPush.LegalChars
|
Definition |
Legal characters for file name and file structure on the local file system. Any illegal characters encountered (those not in this list) will be converted to underscores. Format=$char$ to indicate a range, or type individual values without using $ |
|
Default |
N/A (null) |
|
Additional Info / When to Change the Default Value |
Should not be used in conjunction with Illegal Characters (use one or the other, or neither). Use when the downstream system has character limitations and allowable characters are limited (e.g., A-Z, a-z, 0-9, hyphen and underscore, indicated as $A-Z$$a-z$$0-9$-_ OR abcdefghijklmnopqrstuvwxyz01234567890-_ ABCDEFGHIJKLMNOPQRSTUVWXYZ ). |
AssetPush.IllegalChars
|
Definition |
Illegal characters for file name and file structure on the local file system. Any illegal characters encountered (those in this list) will be converted to underscores. Format=$char$ to indicate a range, or type individual values without using $ |
|
Default |
N/A (null) |
|
Additional Info / When to Change the Default Value |
Should not be used in conjunction with Legal Characters (use one or the other, or neither). Use when the file system has character limitations and the allowable characters are significant in number (e.g., standard alphanumerics plus all accented versions allowed but forward slash and asterisk must be omitted, indicated as \*). |
AssetPush.Instances
|
Definition |
Space separated list of asset push instance names, minus the assetpush- prefix. If the value is 'a b c' then there are 3 asset push instances, named assetpush-a, assetpush-b and assetpush-c. Note: A remote event handler is automatically set up for each instance. |
|
Default |
N/A (null) |
|
Additional Info / When to Change the Default Value |
Must be matched by: /[a-z0-9\.-]* ( [a-z0-9\.-]+)*/ |
AssetPush.MaxHeapSize
|
Definition |
The amount of memory to allow the Asset Push payload to use. |
|
Default |
256m |
|
Additional Info / When to Change the Default Value |
Typically left as defaulted. Consult with Stibo Systems Technical Services prior to changing. |
AssetPush.PathAddOn
|
Definition |
An intermediate part of the path to inject if attempting to find the asset via the old asset-push system. |
|
Default |
N/A (null) |
|
Additional Info / When to Change the Default Value |
Inserted between the prePath, and before the (off-cut) relativePath. e.g., if the old pusher stored an asset in /AssetPush/Images/Main/Global/asset.gif, where /AssetPush/Images is the prePath, and the new stored the asset in /AssetPushQueue/Images/ss/et/asset.gif, then setting the AddOn to "../../AssetPush/Images would result in the path (when searching for old-pushed assets) /AssetPushQueue/Images/../../AssetPush/Images/Main/Global/asset.gif, which is hopefully equivalent to the wanted location. |
AssetPush.PathCutoff
|
Definition |
The amount of levels (of directories) to cut off the full path, if mounting the client-drives partly into the assetpush-file-system. Defaults to zero. |
|
Default |
Zero |
|
Additional Info / When to Change the Default Value |
Only relevant for new (queue-based) asset-pusher. |
AssetPush.RedownloadAllMethod
|
Definition |
Defines how to find all assetURLs when no classification root has been specified. |
|
Default |
Query |
|
Additional Info / When to Change the Default Value |
Possible options: 'Query' and 'Traverse.' Notice, when Query is chosen, AssetPush.RedownloadAssetURLsBatchSize will be ignored. |
AssetPush.RedownloadAssetURLsBatchSize=10000
|
Definition |
Defines the number of assetURLs to fetch in each batch when doing redownload. |
|
Default |
10000 |
|
Additional Info / When to Change the Default Value |
Value must be an integer. Typically left as default. Consult with Stibo Systems Technical Services prior to changing. |
AssetPush.RelativePathTemplate.Sample1
|
Definition |
A pre-defined relative path template. Will be used in the AssetPushConfiguration editor in the Relative Path Template combo box. |
|
Default |
$configID$/$contentdimensionpointsID$/$IDpath$/$assetID$.$autodetected-extension$ |
|
Additional Info / When to Change the Default Value |
Use to provide valid and useful macro templates for asset push administrators. |
AssetPush.RelativePathTemplate.Sample2
|
Definition |
A pre-defined relative path template. Will be used in the AssetPushConfiguration editor in the Relative Path Template combo box. |
|
Default |
$configID$/$IDpath$/$assetID$_$contentdimensionpointsID$.$autodetected-extension$ |
|
Additional Info / When to Change the Default Value |
Use to provide valid and useful macro templates for asset push administrators. |
AssetPush.RelativePathTemplate.Sample3
|
Definition |
A pre-defined relative path template. Will be used in the AssetPushConfiguration editor in the Relative Path Template combo box. |
|
Default |
$conversion$/$workspaceID$/$IDpath$/$assetID$_$contentdimensionpointsID$.$autodetected-extension$ |
|
Additional Info / When to Change the Default Value |
Use to provide valid and useful macro templates for asset push administrators. |
AssetPush.RelativePathTemplate.Sample4
|
Definition |
A pre-defined relative path template. Will be used in the AssetPushConfiguration editor in the Relative Path Template combo box. |
|
Default |
N/A (null) |
|
Additional Info / When to Change the Default Value |
Use to provide valid and useful macro templates for asset push administrators. |
AssetPush.RelativePathTemplate.Sample5
|
Definition |
A pre-defined relative path template. Will be used in the AssetPushConfiguration editor in the Relative Path Template combo box. |
|
Default |
N/A (null) |
|
Additional Info / When to Change the Default Value |
Use to provide valid and useful macro templates for asset push administrators. |
AssetPush.UseSystem
|
Definition |
Entry defining which AssetPush system to use. Legal values are:
|
|
Default |
new |
|
Additional Info / When to Change the Default Value |
Should always be populated with ‘new’ unless on a system with a STEP installation prior to 5.1 or being upgraded from a pre-5.1 system (in which case ‘both’ may be appropriate). |
Assetpush.Email.Notification.Minutes
|
Definition |
Time between email notifications for asset push. Must be an integer. Set in minutes. |
|
Default |
60 |
|
Additional Info / When to Change the Default Value |
Update as needed |
Event Queue Properties
When a sidecar is installed for an asset push, an assetpush.properties file is created and populated with the location for the asset push and the credentials of the user performing the asset push. This file defines some key information for the specific event queue with which the asset push is associated. For more information, refer to the Asset Push Sidecar topic in this documentation here.
Note that this file only affects individual event queues, whereas system properties apply to all asset pushes in the system. Additionally, asset properties always need to be defined, whereas system properties can often be left with the default values.
The assetpush.properties file contains the following properties:
|
Name |
Definition |
|---|---|
|
UserName |
Username for file system login. |
|
Password |
Password for file system login. |
|
ImageFolder |
Specifies the first part of the path and/or parent directory into which all pushed assets will be placed. Relative Path Template takes effect after this, meaning that all asset push configurations under a single event queue will share a parent folder on the local file system, but each configuration is expected to have a separate directory structure under the common parent. |
|
Delay |
Rate in seconds for sidecar to ping the file system to ensure connection. Always set to 30 seconds and should not be changed without consultation with Stibo Systems Technical Services. |