Administrator Scripts

The script processes a pipe-separated value (PSV) file of <Astoria Object ID> | <revision stamp name> values; for example, the following pair of values, 00000018WGA3070GYZ|1.0, instructs the script to roll the file forward to version 1.0.

Usage: jython findCommentsOrProcessingInstructionsContainingText.py –h #this will print out the documentation

jython findCommentsOrProcessingInstructionsContainingText.py -tp -c "15_display" 00000016WGA1080GYZ

Parameters: {folderItemStrings=['00000016WGA1080GYZ'], type=2, content=15_display, verbose=false}
Searching: Documents for Don > Biking of type Folder
Hit in doc: Documents for Don > Biking > Documents 1 - 2 > tp_SealBeach.dita, comment: target Pub UDT FAR15 _display.
Result Count: 1. 00000023WHG1003302080GYZ
Done 

• The folder to import
• The directory to which the imported folder and its contents are shadowed
• Optional pattern argument to cause files that match the pattern to be ignored

For example:

jython importTopLeaf.py C:\Users\Don\TopLeaf\Astoria C:\Styles .*\.png

In this example, the script ignores all files that have the .png extension.

Traditionally Astoria names its output files in the format [name].[extension]. However the presence of a registered parameter will alter the naming to be of the format _id_[astoria_object id]_[name].[extension]. This naming convention is required for certain transtypes to work, such as EditLink. See About the EditLink Plugin . However, Astoria automatically adds the three EditLink plugin custom parameters to the watched parameters during an upgrade or installation, so customers who subsequently install the EditLink plugin do not need to run the script to add the parameters. The script is supplied for customers who may install other plugins that require similar functionality to work correctly.

The parameter argument is the name of the parameter to register to watch.

Run this script only on the Primary ACS Server.

Periodically servlets should go offline exit/restart, reinitialize, then go back online. Only one servlet should recycle at a time.

Note that the script waits 5-10 minutes per servlet, so this can take a few hours to execute. Ideally, it should be scheduled to run during lowest system usage such as right after backups.

The Event Queue Properties sheet for Deletions can specify which optional types of events are logged. Logon and logout events are always included by default.

Run this script only on the Primary ACS Server.Note that the script waits 5-10 minutes per servlet, so this can take a few hours to execute.Ideally, it should be scheduled to run during lowest system usage such as right after backups.

• Acrolinx host
• Signature
• API token

This option controls whether users are required to checkin validated XML without detected errors. This is done by forcing the Validate and Cancel on Errors buttons of the checkin dialog to be checked and disabled.

This script can also set require a minimum length for checkin notes, which can be used to force all users to provide a checkin note for every checkin.

This script can set a control to prevent users from altering the Version Name when checking in an object.

Increase the read timeout limit to eliminate errors when importing large document sets or performing other operations which exceed the timeout limit. After you run the script, close all Workbenches and then restart them.

For examples of client logging and servlet logging when configured to override the global policy, see the topic Configuring Stack Trace Logging in the ACS Installation and Configuration Guide for Astoria 6.5.

• 1 -No hierarchy - All subdocuments are placed in the specified folder for the import operation.
• 2 -Hierarchy Tranche - Documents are tranched (broken up into separate folders), each folder containing a maximum of 100 documents.
• 3 -No Hierarchy First Tranche - This is the default value. The first 100 documents are stored in the specified folder for the import; additional documents are tranched into subfolders, each containing a maximum of 100 documents.

When you run the script, the current policy value is displayed. Click Enter to accept the current policy, or click an option number to change the policy. A changed policy takes effect immediately for subsequent imports.

If you set a limit and an object exceeds the limit, the Details view indicates you have reached the Enumeration limit, and shows the number of additional items not displayed.

Leave the default value of no limit unless you are directed to limit the number by Astoria technical support.

1. jython setGlobalApp.py 0 com.astoria.database folderItemUniqueName prefix " ("
2. jython setGlobalApp.py 1 com.astoria.database folderItemUniqueName counter 2
3. jython setGlobalApp.py 0 com.astoria.database folderItemUniqueName suffix ")"

When you run the script, the current policy value is displayed. Click Enter to accept the current policy, or click an option number to change the policy. A changed policy takes effect immediately for subsequent imports.

Settings include the seed and the pattern. The seed is a number to start ids with, which will increment for each new Id. The pattern allows you to add text to each new Id, and must contain {0}.

Use this script in conjunction with setNewXmlDocumentIdMode.

See Configuring New XML Document Options

See

Configuring New XML Document Options

See Configuring New XML Document Options

Can control whether workflow status is copied when documents are branched. See Preserving Workflow Status when Branching an Object.

Can define a named user (must be in the Administrators group) that is allowed to hold locks on objects without preventing merge operations to succeed. See .Allowing a Merge When the Object is Locked to a Named User .

Updates are active automatically within an hour of invoking the script, or immediately upon restarting Astoria services on all ACS servers. Changes have no impact on files already residing in the repository.

• Session Duration: set Current Credentials Period in seconds; default is 86,400 seconds (24 hours)
• Session Idle: set Current Credentials Activity Duration in seconds; default is 3,600 seconds (1 hour)

Example output:

Daemon summaries displays the following processor information for all detected Event Queues:

• systemIds.py
• systemIds.bat

• Implements Astoria database processing.
• Is a start manager for the systemIds.py script.

See the topic About the System Id Scripts in the ACS Installation and Configuration guide.