:Arkitex Enterprise - Agfa

:Arkitex Enterprise 

Courier System Administration 

Guide

2 

Trademarks, Copyright 

and EULA 

Agfa, the Agfa rhombus, and Arkitex Courier are registered trademarks of Agfa-Gevaert N.V. 

Those names and product names not mentioned here are trademarks or registered trademarks of their respective 

owners. 

For more information about Agfa Graphics products, visit www.agfa.com, or contact us at one of the following 

addresses: 

Agfa Corporation 

2545 W. Hillcrest Drive, Suite 220 

Thousand Oaks , CA 91320, USA 

Tel: (+) 805 277 6700 

Agfa Graphics 

Septestraat 27 

B-2640 Mortsel, Belgium 

Tel: (+) 32 3 444 2111 

Document Part 

Number 

Rev Date Pages Text Changes 

CG+0952660001 A 30 August 2005 All Preliminary 

CG+0952660001 B 3 November 2005 All Courier release 

CG+0952660001 C 11 July 2006 All SP1 

CG+0952660001 D 26 January 2007 All 5.0 

CG+0952660001 E 20 June 2008 All Release 6.0 

CG+0952660001 E1 19 March 2009 Page 2 Copyright, address 

CG+0952660001 F 26 July 2010 All Rel 6.0 Hot Fix 6 

Copyright © 2005-2010 Agfa Corporation 

All software and hardware described in this document are subject to change without notice. 

:Arkitex Enterprise Courier System Administration Guide

About This Courier System Administration 

Guide 

This Courier System Administration Guide offers you a complete description of 

the :Arkitex Courier interface and provides procedures and settings so you can 

work efficiently. 

You access the Courier System Administration Guide from the Help menu in the 

:Arkitex Courier menu bar and it is viewed in a new window of your standard 

web browser. You can also refer to specific topics by clicking the small Help icon 

on each screen. 

Keyboard Conventions 

All key names are shown in capital letters. For example, the Control key is shown 

as CTRL. 

Keys are frequently used in combinations or sequences as shortcut keys. For 

example, SHIFT+F3 means to hold down the SHIFT key while pressing F3. 

Mouse Conventions 

To... 

Click 

Double-click 

Context-click on Windows 

Context-click on Macintosh 

Drag 

Do this... 

Point to an item, and then quickly press and release the mouse 

button without moving the mouse. 

Point to an item, and then quickly press and release the mouse 

button twice. 

Click the right mouse button. 

Hold down the CTRL key while clicking the mouse button. 

Point to an item. Press and hold down the mouse button as you 

move the mouse to a new location, then release the mouse button. 

Related Documentation 

The following documents can be referred to for more information: 

• :Arkitex Client Reference Guide 

3

4 RELATED DOCUMENTATION 

• :Arkitex Courier Installation Guide 


Contents 

About This Courier System Administration Guide ....................................... 3 

Keyboard Conventions ..................................................................................................... 3 

Related Documentation .................................................................................................. 3 

Chapter 1 Java .................................................................................................................................................. 9 

Java for PC Installation .................................................................................................... 10 

Plug-in Installation ..................................................................................................... 10 

Set Java Memory ......................................................................................................... 13 

Disable Update Reminders ...................................................................................... 16 

Java Mac Configuration ................................................................................................... 17 

Modify Runtime Parameters ................................................................................... 17 

Disable Proxy Server .................................................................................................. 19 

Chapter 2 Adding Additional Arkitex Servers ............................................................ 21 

Configure Arkitex Client Servers .................................................................................. 22 

Host Name ..................................................................................................................... 22 

Command Buttons ...................................................................................................... 22 

If Authentication Fails ............................................................................................... 26 

User Authentication .......................................................................................................... 29 

If Authentication Fails ............................................................................................... 30 

Web Server Home Page ................................................................................................... 30 

Chapter 3 Destinations .......................................................................................................................... 33 

Configuration ....................................................................................................................... 34 

Destinations ........................................................................................................................ 35 

Chapter 4 Destination Groups ....................................................................................................... 47 

Destination Groups ............................................................................................................ 48 

Chapter 5 Input ................................................................................................................................................ 53 

Input ........................................................................................................................................ 54 

Miscellaneous ............................................................................................................... 61 

Chapter 6 Users ............................................................................................................................................... 63 

Users ....................................................................................................................................... 64 

5

6 

Permissions Tab ........................................................................................................... 65 

Publication Groups ............................................................................................................ 71 

Configuration Toolbar ...................................................................................................... 73 

Chapter 7 System ......................................................................................................................................... 75 

System ................................................................................................................................... 76 

Properties .............................................................................................................................. 76 

Folders Tab .................................................................................................................... 76 

Scripts Tab ..................................................................................................................... 79 

Active Backup Tab ...................................................................................................... 81 

Proxy ................................................................................................................................ 86 

Subsystem Capacity ................................................................................................... 86 

Miscellaneous .............................................................................................................. 87 


Chapter 8 Courier-Renaming Rules ....................................................................................... 91 

Renaming Rules ................................................................................................................. 92 

Renaming Facilities .................................................................................................... 92 

Input Rules .................................................................................................................... 92 

Output Name Generators ......................................................................................... 93 

Naming Script Functions .......................................................................................... 96 

Script Initialization ..................................................................................................... 97 

Editing the Rename Table ....................................................................................... 97 

Testing Rename Rules .............................................................................................. 97 

Special Uses of Renaming ....................................................................................... 97 

Renaming Examples .................................................................................................. 98 

Renaming Rules List Box ......................................................................................... 100 

Properties .............................................................................................................................. 102 

Parameters .................................................................................................................... 105 


Chapter 9 UNIX ................................................................................................................................................ 109 

UNIX ....................................................................................................................................... 110 

Client Interface ................................................................................................................... 110 


Chapter 10 Active Backup for MS SQL on Windows ............................................ 111 

Prerequisites ........................................................................................................................ 112 

Active Backup Configuration ......................................................................................... 112 

Timed Backup ............................................................................................................... 112 

Real-Time Backup ....................................................................................................... 112 


7 

Install/Configure rsync ....................................................................................................113 

Installation .....................................................................................................................113 

Folder Permissions ......................................................................................................113 

RsyncServer Service ....................................................................................................113 

Configuration .................................................................................................................113 

Rsync Configuration ...................................................................................................113 

Temporary Working Folder .......................................................................................114 

Courier Active Backup Configuration ..........................................................................115 

Configuration .................................................................................................................115 

Paths .................................................................................................................................116 

Activation of Backup Server ...........................................................................................116 

Active Backup Batch Files ...............................................................................................118 

Snapshot ................................................................................................................................118 

Rsync Options ......................................................................................................................120 

Optional Module ..........................................................................................................120 

Setting the Port for rsync server ............................................................................120 

Remote_sync.cmd Script ..........................................................................................120 

backupFiles.cfg .............................................................................................................121 

Chapter 11 Active Backup for Oracle on UNIX ............................................................123 

Active Backup Configuration .........................................................................................126 

Configure Prerequisites .............................................................................................126 

Ssh .....................................................................................................................................127 

Rsync ................................................................................................................................133 

Active Backup Initialization (Courier1 Primary / Courier2 Standby) .......134 

Data Guard Configuration .........................................................................................137 

Operational Procedures ....................................................................................................140 

Active Backup Failover procedure (Failover from Courier1 to Courier2) .140 

Failover from Courier1 to Courier2 .......................................................................142 

Recovering from Failover ..........................................................................................143 

Making a Snapshot of the Database ....................................................................144 

Solaris Active Backup Troubleshooting ......................................................................148 

SSH Not Connecting ...................................................................................................148 

Files Not 

Synchronized Between Primary/Standby Servers ..........................................148 

Oracle Backups Not Completing ...........................................................................149 

Backup/Data Synchronization Problems ............................................................149 

Activating Standby Server Fails ..............................................................................151 

Command Line Status Check ..................................................................................153 

Chapter 12 Alert Listener Utility Application .................................................................155 

Alert Listener Utility ..........................................................................................................156 


8 

Chapter 13 Enhancements .................................................................................................................... 159 

Version Soft Proof .............................................................................................................. 160 

Cleanse Input Filenames of Rejected Characters .................................................. 162 

System Messages in System Error Log ...................................................................... 162 

Index .............................................................................................................................................. 165 


CHAPTER 

1 Java 

This chapter contains instructions for installing Java on PCs and Macs. 

Java for PC Installation ........................................................................................ 10 

Plug-in Installation ........................................................................................ 10 

Set Java Memory ............................................................................................ 13 

Disable Update Reminders ......................................................................... 16 

Java Mac Configuration ....................................................................................... 17 

Modify Runtime Parameters ...................................................................... 17 

Disable Proxy Server ..................................................................................... 19 

9

10 JAVA FOR PC INSTALLATION 

Java for PC Installation 

Courier uses Java (2) Runtime Environment, Standard Edition 1.5.0_XX. 

You will be doing the following procedures: 

• “Plug-in Installation” on page 10 

• “Set Java Memory” on page 13 

• “Disable Update Reminders” on page 16 

Plug-in Installation 

If you log onto a Courier server remotely through a Web browser, and your client 

does not have Java Plug-in 1.5.0_XX, a prompt appears with the correct plug-in. 

Installation 

1 The executable can be saved locally by: 

a 

Right-clicking on the link, and selecting Save Target As. 

b 

Or launched by selecting Open. 


1 JAVA 11 

3 Begin the installation: 

4 When prompted, Accept the license agreement: 



5 Click Next. 

6 Select Typical setup type: 

7 Click Next. 

8 Click Finish when the install completes. 


1 JAVA 13 

9 Close the Java Plug-in window: 

Set Java Memory 

The default memory allocation for the Java plug-in is 128MB. When the Client 

is displaying the hi-res view, the Java plug-in could run out of memory 

depending upon the size of the soft proof that is being displayed. This could 

result in a delay in viewing the soft proof, or the soft proof not displaying. 

To prevent this from happening, the Java Runtime Parameters should be 

changed to allocate more memory to the plug-in. 

Set Java Memory 

1 From the Start button, select Settings > Control Panel. 



2 Double-click on the Java icon. Select the Java tab. 

3 Select View for Java Applet Runtime Settings. 

4 Enter the following in the Java Runtime Parameters field: 

-Xms200m -Xmx200m 


1 JAVA 15 

5 Click OK. 

6 Select View for Java Application Runtime Settings. 

7 Verify Enabled is checked under the User and System tabs: 

8 Click OK to return to the Java tab screen. 



Temporary Files Settings 

1 When setting Temporary File Settings: 

a 

b 

c 

Under Location be sure that you are caching on a local disk and not on a 

network resource. 

Limit the amount of disk space used. By default it is set to unlimited. This 

will slow down your client. 

Do not set the cache value at too low a setting because it will not be 

cleaned up. 

4 Close the dialog box. 

Disable Update 

Reminders 

By default a reminder prompt will appear asking to update the Java plugin. 

Courier will only run with Java 1.5.0_XX, so new updates should not be run. To 

turn off update reminders: 

Setup 

5 Select the Update tab. 


1 JAVA 17 

6 Uncheck Check for Updates Automatically. Click Apply. 

7 Click OK to close the Java dialog box. 

8 Close Control Panel. 

Java Mac Configuration 

This section describes how to configure a MacIntosh running Java 1.5.0 on 

Mac OS X v10.4. 

To configure Safari Browser for Arkitex Client, perform the following: 

• “Modify Runtime Parameters” on page 17 

• “Disable Proxy Server” on page 19 

Modify Runtime 

Parameters 

In Java Preferences, the runtime memory must be modified. 

Steps 

1 Open the Java Preferences dialog box. 


18 JAVA MAC CONFIGURATION 

NOTE: If more than one version of Java is installed, each version will appear 

under Java Application Runtime Settings. 

2 Select J2SE 5.0 from the Use Version field. 

3 Enter the following in the Java Runtime Parameters field: 

-Xms200m -Xmx200m 

4 Click Save. 

5 Close the Java Preferences dialog box. 

Temporary Files Settings 

1 When setting Temporary File Settings: 


1 JAVA 19 

a 

b 

c 

Under Location be sure that you are caching on a local disk and not on a 

network resource. 

Limit the amount of disk space used. By default it is set to unlimited. This 

will slow down your client. 

Do not set the cache value at too low a setting because the it will not be 

cleaned up. 


Disable Proxy 

Server 

Proxy servers must be disabled in Safari preferences. 

Steps 

1 Launch the Safari browser. 

2 Select Preferences. 

3 Select Advanced, and then Change Settings. 


20 JAVA MAC CONFIGURATION 

4 The Network dialog box will open. 

5 Uncheck any proxy servers under Select a proxy server to configure. 

6 Click Apply Now. 

7 Close the Network dialog box. 

8 Close the Safari browser. 


CHAPTER 

2 

Adding 

Additional Arkitex 

Servers 

This chapter discusses configuring additional Courier servers. 

Configure Arkitex Client Servers ...................................................................... 22 

Host Name ........................................................................................................ 22 

Command Buttons ......................................................................................... 22 

If Authentication Fails .................................................................................. 26 

User Authentication .............................................................................................. 29 

If Authentication Fails .................................................................................. 30 

Web Server Home Page ....................................................................................... 30 

21

22 CONFIGURE ARKITEX CLIENT SERVERS 

Configure Arkitex Client Servers 

Arkitex Client Servers is a list of all available servers configured for Courier or 

Director. 

More than one Courier server can be configured and their names will appear in 

the Server Drop-Down list after you log into Arkitex Client. 

Host Name 

When setting up Client, you will typically specify the server’s host name in the 

appropriate fields. If you do specify the server name (instead of the server’s IP 

address), make sure all clients can access the server by that name. This requires 

either an entry in the internal DNS server, or an entry in the client’s hosts file if 

no DNS server is available. 

Command Buttons 

A set of command buttons is used to configure the server list. Command buttons 

include: Add, Edit, Remove, Up/Down. 

Add 

Additional servers can be added using the Add button. 


2 ADDING ADDITIONAL ARKITEX SERVERS 23 

Server Properties 

The following fields are available: 

Type 

Name 

Host Name 

Port 

Soft Proof Path 

Tiff Path 

Script Path 

Either Courier or Director. 

Customizable server name. This displays on the server drop down list in Arkitex 

Client. 

Match this name to the host name of the Courier server. 

18181 is the default port. 

Location where soft proofs will process on the Courier server. 

Location where TIFF files will process on the Courier server. This is used for the 

High Resolution Soft Proof feature that must be enabled. Set the Tiff path as / 

/server_name:18181/Tiff/ where server_name is the name of your Courier server. 

Location where scripts will be processed on the Courier server. 

• Refer to the Enabling High Resolution Soft Proof in the Courier Installation Guide 

Configure Fields 

1 Replace all instances of SERVER_NAME with the actual name of the Courier 

server. 

NOTE: Do not change the default Port variable. 



Test 

2 Before accepting the entries, click Test to test the configuration. 

3 If the test is successful, a green icon will appear next to each entry. 

4 If the test is unsuccessful, red icons will appear. Go to “If Authentication 

Fails” on page 26 to resolve. 

5 Click Done to close the Server Test window and return to Server Properties. 

6 To accept the entries, click OK. Click Cancel to exit without saving. 

CAUTION: Before entering a server name, the client must either appear in the 

Host File or be known by a DNA server for the client to access soft proofs and 

scripts. 

Edit 

1 Select the Courier server name, and click Edit. 

2 The Server Properties window will open. 



3 Server Properties are the same as described under Add (see “Add” on 

page 22). 

4 Test is the same as described under Add (see “Add” on page 22). 

5 Results are the same as described under Add (see “Add” on page 22). 

6 Click Done to close the Server Test window and return to Server Properties. 

7 To accept the entries, click OK. Or click Cancel to exit without saving. 

Remove 

1 An existing server can be deleted from the list with Remove. 

CAUTION: No warning prompt is given with Remove. The server name will be 

deleted from the list. 

2 To reverse the deletion, do not select OK. 

Up / Down 

1 To change the order of the Arkitex Client Servers in the list, select the server 

type (Courier or Director), and then click Up or Down. 

2 The server name will change in the list. 



o 

If Authentication 

Fails 

If the test results fail, perform the following checks: 

Ping the Host Name 

1 Check that the host name is reachable from the server. 

2 From the Start button, select Run. 

3 In the Open field, type cmd, and hit OK. 

4 Type ping . 

5 If a successful reply returns, close the command window, and go to step 14. 

Check the DNS Server 

6 Check the DNS server and be sure the server name is listed. 

Check the Local Hosts Table 

7 Locate the local hosts table and be sure the server name is listed in the table. 

Check Tomcat 

8 The Tomcat service must be running on the server. 

9 Click the Start button and then Programs > Administrative Tools > 

Services. 

10 Check that Apache Tomcat is started in the services list. 

1 If it is started, go to step 11. 

2 If it is not, right-click on Apache Tomcat, select Start, then go to step 11. 

11 Exit the Services dialog box. 



Check Soap 

12 From the Start button, select Run. 

13 In the Open field, type cmd, and hit OK. 

14 Change to the C:\Arkitex\tomcat directory. 

15 Type deploy_soap.bat, and hit Enter. 

16 When the C:\Arkitex\tomcat prompt returns, exit the command window. 


Services. 



18 Locate Apache Tomcat in the services list. 

19 Stop the service by right-clicking Apache Tomcat, and selecting Stop. 

20 Then reselect it, and click Start. 


22 Repeat “Test” on page 24. 



User Authentication 

User Authentication is used to confirm the validity of the user name, password, 

and associated permissions. 

NOTE: No changes are required for the default port number. 

• Host Name and Port number are defined under Add (see “Add” on page 22). 

• Client Port number is a Web Server port number defined by the user. 

Test 

1 Enter the host name of the authentication server. 

2 Click Test. 

1 If authentication is successful, a green check will appear. 

2 If authentication is unsuccessful, a red circle with a cross will appear. Go 

to“If Authentication Fails” on page 30 to resolve. 

NOTE: Authentication may not succeed on the Solaris-Courier server until the 

server is rebooted. 


30 WEB SERVER HOME PAGE 

3 To accept the configuration, click OK. Click Cancel to exit without saving. 

Exit Client Configuration 

1 Click from the upper right-hand corner of the window. 

2 A prompt will appear asking to Save Changes. 

3 Select Save. 

If Authentication 

Fails 

If the test results fail, perform the following checks: 

Check Services 

1 Check that the host name is reachable from the server. 

2 The Soap and Apache Tomcat services must be running on the server. 


Services. 

2 Check that Apache Tomcat is started in the services list. If not, right-click, 

and select Start. 

3 Exit Services. 

4 Repeat “Test” on page 29. 

Web Server Home Page 

Under Internet Server Manager the default Web Server home page must be set 

to Arkitex/Client. 

Set the Web Server home page 

1 Go to Programs > Administrative Tools > Internet Services Manager. 

2 Select Default Web Site, right-click, and select Properties. 

3 Select the Home Directory tab. 

4 Enter Arkitex\Client in the local path field. 



5 Select OK. 

6 Select Action > Stop. 

7 Select Action > Start to restart the Web Server. 

8 Close the Internet Services Manager. 

Log In 

1 Launch an IE browser window. 

2 Use the local server name as the URL. 

3 At the login window, login as ArkitexAdmin. This is the only user that will be 

available at this time. 

4 The Client window will open. 


32 WEB SERVER HOME PAGE 


CHAPTER 

3 Destinations 

This chapter discusses configuring destinations. 

Configuration ........................................................................................................... 34 

Destinations ............................................................................................................ 35 

Destinations List Box .................................................................................... 35 

Properties .......................................................................................................... 37 

Location Tab ..................................................................................................... 38 

Miscellaneous Tab ......................................................................................... 41 

Scripts Tab ......................................................................................................... 42 

Renaming Tab .................................................................................................. 44 

Director Tab ...................................................................................................... 44 

Configuration Toolbar ................................................................................... 46 

CAUTION: Determine which users will have administrative permission that will 

give them access to Tools > Configuration. Otherwise this option will be grayed 

out. 

33

34 CONFIGURATION 

Configuration 

All system-configuration is permission based and is accomplished though the 

browser-based Client application. Configuration can take place on a running 

system, and any changes made do not require restarting the server or any server 

subsystems for those changes to take effect. 

By selecting the Configure Server button, the configuration for the selected 

Courier server can be set. It will be possible to export and import full 

configuration data in an XML format for backup, transfer, configuration, and 

support purposes. 

One configuration file is created for each major category under Configuration: 

Destination, Destination Groups, Input, Users, System, and Renaming 

Rules. 

If a new configuration is received, then the Courier engine will update its 

database and perform any changes and/or additional transmissions required. 

This update will be dynamic, not requiring the engine or any subsystem to be 

restarted. 

To begin configuration of the selected Courier server, select Tools > 

Configuration from the menu. 


3 DESTINATIONS 35 

Destinations 

The Destinations configuration dialog box is used to configure Courier’s server 

transmission subsystem. This consists of defining destinations and their 

properties. Destinations may be added, renamed, and deleted. Each destination 

has the property categories of “Location Tab” on page 38, “Miscellaneous Tab” 

on page 41, “Scripts Tab” on page 42, “Renaming Tab” on page 44, and 

“Director Tab” on page 44. 

NOTE: Before deleting a destination, appropriate warnings will be displayed if 

this affects current jobs. 

NOTE: Plans will not be automatically retransmitted to new destinations in the 

group. Resubmit the plan if an existing group contains new destinations. 

Destinations List Box 

The list box displays destinations and their properties. Destinations may be 

added using the Add button, deleted by using the Delete button, and renamed 

using the Rename button when the Destinations name is highlighted. 


36 DESTINATIONS 

Add 

Click to add a new destination long name and short name. Long and Short 

Names are used not only in the tracking interface but elsewhere within the 

system (such as plans). 

Once the destinations are defined, they will be available in the Destination 

Group dialog box (“Destination Groups” on page 48). 

Delete 

Use to delete a destination. A warning message will appear asking to confirm the 

deletion. 

NOTE: Before deleting a destination, appropriate warnings will be displayed if 

this affects current jobs. 

Rename 

Use to rename a destination from the list. Enter the new long name and short 

name. 



OK: Accepts the changes. 

Cancel: Cancels the changes. 

Properties 

Destinations may be enabled or disabled. This can be handy for pre-configuring 

a future site that is not active yet. Once configured, just disable it. When the site 

becomes active, enable it. 

Disable Destination 

Proofing Only 

Check Disable Destination to deactivate the selected Destination. 

Destinations can be set up for exporting files for proofing purposes. If the 

Proofing Only checkbox is selected, the destination will appear in the Export to 

Proofing dialog box when you right click on a page. 

Selecting a destination in this dialog will send the high-resolution file to this 

destination(s) for proofing. 





Location Tab 

For each destination, both a primary and a secondary destination point can be 

set. Each destination point can be either a folder or an FTP site. A site may also 

be pinged. 

NOTE: If the destination is FTP, it has the additional properties of host name, 

port, FTP folder, user name, password, and passive/active transfers. 

Primary and Secondary 

Plans 

Both the primary and secondary settings for a given destination can be defined. 

Used to define an Alternate Delivery path. 

Alternate Delivery Path 

Plan files can be delivered to a path other than the standard path to which data 

files are delivered. 

• The alternate path can be on the same server as the other destination paths 

or another computer, and requires the same settings (such as path, ping, 



intermediate file method, user name and login for FTP) as the other destination 

paths. These additional settings may be the same as the standard 

delivery paths, or different from them. 

• The transmission of files to the Alternate Delivery path observes all other 

rules for a destination such as retries and renaming. 

NOTE: If the Alternate Delivery Path is not available for file transmission, then 

the file will be sent to one of the other delivery paths (Primary or Secondary) 

based on the Switching method defined. 

The Alternate Delivery path is an optional setting for each destination. 

Folder 

When selected allows files to be sent via Windows copy functionality to the 

‘Destination Folder Path’ defined. Use the Browse button to search for the folder 

to use in the path. 

NOTE: When the Plans radio button is selected, the Alternate Delivery path is 

defined here. 

Path: Enter a path and folder name; or click on a folder, and a path is entered. 

Then click Set. 

NOTE: To change the partition in Windows, enter the drive letter in the Path, 

click the Set button, then re-open the Browse button. 

FTP 

The FTP option button when selected includes settings for: 



Host Name: The host name of the FTP server. 

User Name: The user logon name for the FTP server. 

Password: The user password for the FTP server 

FTP Folder: The FTP server folder to use. 

Port: The command or control port of the FTP server (usually 21). 

Passive Transfers 

Use Proxy 

Checking the box allows Courier to initiate connections to and from the FTP 

server. 

When checked, the information found in the Proxy tab will be used. If there is no 

information in the Proxy tab, this check box will be disabled. 

Use Intermediate File 

Method 

Checking the box allows transmission to servers where the software will process 

files as long as the file is seen. This may be used on each destination point. 

Enabling this feature allows for the selection of which method to use, either Sub 

Folder or File Extension. 

Sub Folder: Allows Courier to write the file into a sub folder until the file is 

completely sent. This is relative to either the local folder or the FTP folder. At 

that point, Courier will move the file into the correct destination folder. 

NOTE: This method allows Courier to send files to systems that may not wait for 

the file to be complete. The method used depends on the system receiving the 

file. 

File Extension: Allows Courier to write the file with a specified extension that is 

dropped once the file is completely written. 

Ping To Monitor Connection 

Status 

Check this box to allow pinging of each destination. Refer to “Miscellaneous 

Tab” on page 41. 

Ping Host Name: Enter the name of the host to ping. 



NOTE: These features apply to each destination point, both primary and 

secondary, and independently. 

Miscellaneous Tab 

Simultaneous Transfers, Switching Method, Disable Plan Transmission, 

Integrate with Director, Errors Settings and Ping Settings are set here. 

Simultaneous Transfers 

Switching Method 

Disable Plan Transmission 

Error Settings 

Identifies how many files to send to a given destination at a time. Certain 

networks may only use a percentage of the total bandwidth during the transfer 

of a single file. This setting allows the transmission of multiple files at one time 

in order to maximize throughput. 

The drop down list box identifies how files are distributed to the Primary and 

Secondary servers if a Secondary server is defined for the Destination. 

Check this box to disable the transmission of plans to this site. By default, a plan 

entering the system will be sent to any destination site identified in the plan. 

Destination Is In Error State After Failed Transmission Retries: Defines when a site 

will be considered in an errored state. 

Time Between Transmission Attempts: Defines the time in seconds to attempt a 

retransmission. 

Ping Settings 

Ping Destination Every ( ) sec: Defines the time intervals in seconds between ping 

attempts. 

Ping Timeout: Defines the timeout in seconds for ping attempts. 

Max Retries: Defines the maximum number of retries to continue pinging. 



Scripts Tab 

A checkbox and a list box with a browse button allows association of a file 

renaming rule with a destination. The drop-down list box will list all configured 

file renaming rules. 

NOTE: The selected renaming rule applies to the destination, meaning both 

primary and secondary destination points. 

The following Script settings are made for each Destination: 

On Transmission Start 

Check the box to allow the execution of a script on the start of file transmission. 

Parameters: Customer-defined parameters for the script. 

Timeout: Times out the script after the amount of seconds specified. If it does not 

return before the timeout, kill it and log an error. 

Launch With: Defines the scripting shell to use for scripts. 

On Transmission End 

Check the box to allow the execution of a script on the end of file transmission. 



Parameters: Customer-defined parameters for the script. 

Timeout: Times out the script after the amount of seconds specified. If it does not 

return before the timeout, kill it and log an error. 

Launch With: Defines the scripting shell to use for scripts. 

NOTE: These scripts can be turned on and off for each Destination. 

Scripting allows additional customization of the Courier system based on unique 

customer requirements. Scripts can be automatically run at a number of points 

in the workflow: 

• Arrival of a file into Courier. 

• Before transmission to a specific Destination site. 

• Upon completion of transmission to a specific Destination site. 

The results of this script may then be used in further processing of the file. Scripts 

run to completion before the next step in the workflow. 

Script Return Code 

When a script completes running, it returns a “code” back to Courier. This code 

indicates the success or failure of the script. Codes can indicate: 

Continue: Log information to all logs and continue processing the file. 

Halt: Log information to all logs and stop processing the file. 

Warn: Log a warning message to all logs including a warning to the System 

Messages window, and continue processing the file 



Error: Log an error to all logs including an error to the System Messages window, 

and stop processing the file. 

Script Type and Language 

The script may be a true script file, or it may be an executable. Scripts can be 

written in any language that can run on the selected platform. 

NOTE: Examples are vbscript and batch scripts for Windows, and cshell on 

Solaris. 

Renaming Tab 

Allows association of a file renaming rule with a destination. The drop-down list 

box will list all configured file renaming rules that are available. These are 

defined under “Renaming Rules” on page 92. 

NOTE: The selected renaming rule applies to the destination, meaning both 

primary and secondary destination points. 

Apply Renaming Rule 

Check the box to allow the selection of the named Renaming Rule. The dropdown 

list box will list all configured file renaming rules. 

NOTE: Renaming can be turned on and off for each destination. 

Use Original File Name 

Check to use the original incoming file name on transmission. 

Director Tab 

From the Director tab, you can integrate with Director, enable Director 

feedback, copy variables from the primary server, use FTP, and do passive 

transfers. 



Integrate With Director 

Enable Director Feedback 

Copy From Primary 

Folder 

Check this box to enable integration with Director systems at other sites. 

Enables reception of status information from Director (images, text messages). 

Copies all variables from the primary server. 

When selected allows files to be sent via the Windows copy functionality to the 

‘Destination Folder Path’ defined. Use the Browse button to search for the folder 

to use in the path. 


Set: Accepts changes and closes the dialog box. 


NOTE: To change the partition in Windows, enter the drive letter in the Path, 

click the Set button, then re-open the Browse button. 

Stable Time: seconds: The amount of time an input file must remain unchanged 

before Courier will start processing that file. 



FTP 

The FTP option button includes settings for: 




Password: The user password for the FTP server 

FTP Folder: The FTP server folder to use. 

Local Folder: Where files should be copied on the Courier server. 


Indicates if passive FTP transfers should be used for this input. 

NOTE: FTP proxy servers are supported through the FTP settings screen. A single 

input can be either a folder or FTP, not both. Selection of passive or active FTP 

connections are based on the type and configuration of the FTP server. 

Configuration Toolbar 

The Configuration Toolbar provides for accepting configuration changes and 

cancelling changes. The Help button accesses an online help file. 

OK 

Cancel 

Help 

Select the OK button to accept the configuration choices made. 

Select the Cancel button to not accept the configuration choices. 

Select the Help button to open online help. 


CHAPTER 

4 

Destination 

Groups 

This chapter discussed configuring destination groups. 

Destination Groups ................................................................................................ 48 

Destination Group List Box ......................................................................... 48 

Properties .......................................................................................................... 49 

Retransmission Groups ................................................................................ 50 


47

48 DESTINATION GROUPS 

Destination Groups 

A Destination Group is a named list of sites that may include another group in its 

definition as a convenience. There is no limit to the number of group definitions 

supported. 

The Destination Group configuration dialog box is used to configure groups. 

This consists of defining a group and then adding as group members available 

destinations. Groups may be added, deleted, and renamed. 

NOTE: A destination group may not contain itself as a member. 

Destination Group List Box 

The list box displays destination groups and their members. Groups may be 


using the Rename button when the group name is highlighted. 


4 DESTINATION GROUPS 49 

Add 

Click to add a new destination long name and short name. Each group is given a 

long name and short name. They are used not only in the tracking interface but 

elsewhere within the system (such as plans). 

Delete 

Click to delete a group. 

CAUTION: No warning message will be given prior to deleting a group. 

Rename 

Use to rename a group from the list. Enter the new long name and short name. 



Properties 

Properties consist of two lists showing the Group Members and Available 

Destinations. The currently selected group is displayed just under the Destination 

List Box. 

Group Members 

This is a list of member destinations in that group. 



Available Destinations 

These are destination sites that can be added to the group. 

Toolbar 

Use these tools to add and remove destinations to groups: 

Adds the selected destination into the Group Members box. 

Removes the selected destination from the Group Members box. 

Retransmission Groups 

This new enhancement gives the user the ability to configure a retransmission 

group for any planned destination group. This enhancement gives the user the 

ability to hide destinations such as “non-printing” sites (i.e., proofer destinations) 

when selecting a page for retransmission. 

When a user selects a page to be retransmitted by right-clicking and selecting 

retransmit, they can now filter the destinations they wish to transmit to by 

selecting one of three choices from the drop-down selection box. 

The user can choose to see All Destinations, Plan Destinations, or Retransmit 

Destinations. Retransmit Destinations are configured in the Courier configuration. 

The selection made of this pull-down will define which destinations appear 


4 DESTINATION GROUPS 51 

in the box. The users selection is stored and becomes the selection the next time 

this dialog is opened. 

When Courier processes a plan, it will take the destination group indicated in the 

plan as the primary destination group. Files in the plan are sent to sites in this 

destination group as they are today. However, when a user retransmits a file and 

Retransmit Destinations is selected, the Client will list only those destinations in 

the previously defined retransmit destination group. 

A retransmission group is defined just like an ordinary destination group using 

Group Configuration in the Client. You give the Destination Groups a name, and 

then you add the destinations you wish that destination group to contain. 

Once you have defined a retransmission group, you can link this group to one of 

your regular transmission groups by selecting the Destination Groups (i.e., All 

Sites) and then linking it to a Retransmit Group by selecting the retransmission 

group from the Retransmit Group drop-down box at the bottom of the dialogue 

box. 

The default entry in the Retransmit Group is None, which means that no destinations 

will show up in the box. 


For information about the buttons located on the bottom of the configuration 

window, refer to the following links: 



• “OK” on page 46 

• “Cancel” on page 46. 

• “Help” on page 46. 


CHAPTER 

5 Input 

This chapter discussed configuring input points. 

Input ............................................................................................................................ 54 

Input Points List Box ..................................................................................... 54 

Properties .......................................................................................................... 55 

Location Tab ..................................................................................................... 55 

Script/Filter Tab .............................................................................................. 57 

Renaming Tab .................................................................................................. 58 

Defaults Tab ..................................................................................................... 59 

Miscellaneous .................................................................................................. 61 


53

54 INPUT 

Input 

The Courier server input subsystem can be configured by defining input points 

and their properties. Input points may be added, edited and deleted. Each input 

point has the property categories of Location, Script/Filter, Renaming, and 

Defaults. Once configured, input points may be enabled or disabled. 

Input Points List Box 

The list box displays input points and their properties. Input points may be 


using the Rename button when the Input Point name is highlighted. 

Add 

Click to enter an Input point name. 


5 INPUT 55 

Delete 

Click to delete. 

CAUTION: No warning message will be given prior to deletion. 

Rename 

Use to rename an input point from the list. Begin entering a new name, and the 

old name will be overwritten. 

Properties 

Input points may be enabled or disabled. This can be handy for pre-configuring 

a future site that is not active yet. 

Disable Input Point 

Check this box to disable the selected Input Point. Files arriving at that input 

point will not be processed. 

Location Tab 

The location of the input point is either a folder or an FTP site along with a stable 

time value. If the input point is FTP, it has the additional properties of Host 

Name, Port, FTP Folder, User Name, Password, Local Folder, and Passive 

Transfers. 

NOTE: A single input point can be either a folder or FTP, not both. 

Folder 

This identifies the folder path if the input point is a folder accessed by the server. 

Use the Browse button to search for the folder to use in the path. 


56 INPUT 


Set: Accepts changes and closes the dialog box. 


NOTE: In Windows to change the partition, enter the drive letter in the Path, click 

the Set button, then re-open the Browse button. 

Stable Time 

The amount of time an input file must remain unchanged before Courier will 

start processing that file. 

NOTE: The stable time value applies to either the folder or the local folder 

depending on which item is selected (Folder or FTP). 

Stable File Location 

Where .stable is located. Used when Input is on another computer. 

Subfolder of Input: Default is .stable. 

Local Folder: Used in place of .stable. User defined. 


5 INPUT 57 

FTP 

The FTP option identifies settings for an input point that reads files from another 

server via the FTP protocol. The FTP settings include: 




Password: The user password for the FTP server. 

FTP Folder: The folder to use for monitoring on the FTP server. 

Local Folder: The location where files should be copied on the Courier server. 


Indicates if passive FTP transfers should be used for this input. 

NOTE: Selection of passive or active FTP connections is based on the type and File 

Name. 

Script/Filter Tab 

This tab is used to configure scripts for the input point and to identify which 

script to run. Specific files can also be filtered in or out of the input point. 

NOTE: The default for a new input point is to accept all files. You can type in 

specific file types in the Accept table. 

Script 

Identifies if a script is to be run when a file is found in the input folder, and the 

name of the script. Scripts run to completion before any processing of the file 

continues. 


58 INPUT 

Parameters 

Timeout 

Customer-defined parameters for the script. 

Times out the script after the amount of seconds specified. If it does not return 

before the timeout, kill it and log an error. 

Timeout: Second: Times out the script; if it does not return before the timeout, kill 

it and log an error. 

Launch With 

Filter 

Defines the scripting shell to use for scripts. 

Selects which files to process and which to ignore. Very specific filters can be 

created using multiple Accept and Ignore lines. 

File Type 

Accept 

Ignore 

Files types to accept or ignore. 

Accept the file type. 

Ignore the file type. 

NOTE: An empty filter means accept all files. 

Add 

Delete 

Toolbar 

Adds a row to define more file types to filter. 

Deletes a row. 

Renaming Tab 

File renaming rules can be associated with an input point. The drop-down list 

box will list all renaming rules that are available for use. 


5 INPUT 59 

Apply Renaming Rule 

The renaming rule selected from the drop down list box is activated. 

Defaults Tab 

You can define various default properties to apply to input points and when to 

apply them. The default setting can be specified for each property, priority, 

destination group, hard proof, and page approval. You may also specify whether 

to use defaults to override the corresponding values in the plan. 

NOTE: Default values will be used only if the corresponding plan value is absent. 

Enable Courier Express 

Checking the box identifies this input point as either a Courier Express Input, or 

a Standard Input. 

When Enable Courier Express is checked, the default group will display as an 

icon in the Destinations View. 


60 INPUT 

If Courier Express is selected, then the file will be processed without trying to 

match it against any planned objects. Unplanned hot folders will know how to 

process files that have a filename existing in a plan. 

NOTE: Courier Express files associated with an Input Point can be automatically 

purged after a set time period. In order to use this feature, enable the 

Automatically purge unplanned files older than setting (refer to “Miscellaneous” 

on page 61). 

Priority 

Override Plan Priority 

Destination Group 

The transmission priority of files arriving in this folder is defined. For Standard 

Inputs this priority is only used if the MAXML plan does not include a priority for 

the file. Values are between 2 and 127, with 127 being the highest. 

Checking the box overrides any priority in the plan with the Priority settings. 

The drop down list box defines the destination to which files arriving in the Input 

are to be sent. This value is only used if the MAXML plan does not include destinations 

for the given plan. 

Page Approval On/Off 

Defines if page approval is required for files arriving in the Input. When Courier 

Express is unchecked, this option is grayed out. 

NOTE: Page Approval is only valid for Courier Express Inputs. For Standard 

Inputs, all Approval requirements must be included in the MAXML plan. 

Duplicate Version Handling 

For each input point, defines if duplicate versions should be processed (soft 

proofed and retransmitted), or not (accept the file and update the soft proof). 

If a file arrives without a version number, Courier assigns that file to be the next 

highest version number, and soft proofs and processes the file. 

If the file arrives with a version number (as a ,# at the end of the file name), the 

file is deemed to be that version number. 


5 INPUT 61 

If that version number is higher than the existing current version, the new file 

becomes the current version; and normal processing takes place. 

Accept: If the version number is the same as or less than the current version 

number, and the setting is Accept, the file is received, the soft proof updates, the 

current version is changed to this version, and reprocessing takes place. 

Ignore: If the setting is Ignore, a message is logged indicating that the file was a 

duplicate version, and it is being ignored. 

Miscellaneous 

Unplanned files associated with an Input Point can be purged after a set time 

period. When configuring an Input Point, the administrator can set the duration 

for how long any files that have been received through the Input Point remain in 

Unplanned before being automatically deleted. 

Automatically purge 

unplanned files older than 

Unplanned files will be deleted according to this setting. 

NOTE: Courier Express files associated with an Input Point after a set time period 

can be automatically purged. In order to use this feature, first enable Courier 

Express for a given Input (refer to “Defaults Tab” on page 59). 


62 INPUT 








CHAPTER 

6 Users 

This chapter discusses configuring users. 

Users ........................................................................................................................... 64 

Permissions Tab .............................................................................................. 65 

Product Access Tab ........................................................................................ 67 

Folder Access Tab ........................................................................................... 70 

Publication Groups ................................................................................................ 71 

Configuration Toolbar ........................................................................................... 73 

Windows Authentication Server General Notes ................................. 73 


63

64 USERS 

Users 

The Users list box displays the names of users given access to Courier. Users can 

be groups or individuals. Users can be added or deleted to the Courier system 

users. 

Add 

A Users and Groups dialog box opens with a list of available groups and users 

created on the Authentication Server (Refer to “Windows Authentication Server 

General Notes” on page 73.) 

OK: Click to add the new user now to the Users list box. 



6 USERS 65 

Single and Unlimited 

Logins 

For specified Courier logins (user or group), you can configure either a single or 

an unlimited number of clients to concurrently connect with that name. The 

default for a new user is single login. 

NOTE: Each login uses up one Client license. Courier always allows unlimited 

logins for a user from the same computer, and then only one Client license is 

used. 

Delete 

To delete a user, select one from the list and click Delete. 


Permissions Tab 

Access to the Courier Client feature set is configured with a tabbed dialog 

window. User permissions are granted not only to use the features, but also to 

see selected Products and view files based on their Input node. 

Permissions are assigned for three different categories: 

• Users are given permission to use selected functions. 

• The selected user is allowed to use the permitted features (defined in the first 

step) on selected Products. 

• Users are given the ability to use the permitted features on Unplanned files 

arriving in selected Standard Inputs, and on files arriving in selected Courier 

Express folders. 

Assigning permissions to selected products and files arriving in selected folders 

allows division of access. This is desirable in newspapers producing multiple 


66 USERS 

products or titles where users may not be allowed to see information on these 

items. 

Workflow 

Track: When checked allows the ability to view tracking information. When 

unchecked, only View Thumbnails is available. 

Soft Proof: When checked allows the ability to view softproofs. When unchecked, 

View Thumbnails is grayed out. 

Manual Changes: When checked allows the ability to make manual changes. 

Unhold Editions: When checked allows the ability to uphold a complete edition. 

Unhold Pages: When checked allows the ability to unhold individual pages. 

Kill Transmission: When checked allows the ability to kill a file. 

Approval 

Edition: When checked allows the ability to approve an entire edition. 

Page: When checked allows the ability to approve a single page. 

Editorial: When checked allows the ability to approve the editorial content of a 

page. 

Advertising: When checked allows the ability to approve the advertising content 

of a page. 

Skip Approval: When checked allows the ability to skip approval. 

System 

Configuration: Checking the box allows opening the System Configuration 

window to make changes. 

Start/Stop Input Scanning: Scanning for new files to input can be stopped and 

started. 

Purge: Purges plans and associated files, log messages, and/or files from folders. 

Auto Logout after minutes 

Allows the system administrator to set an auto-logout of the client when it is not 

in use. The client will detect whether to automatically disconnect a client after a 

set timeout period based on either the last time a mouse has been clicked, or 

movement of the mouse with a mouse click. Each user or group can be configured 

to have different timeout properties. Select the timeout value from the 

dropdown list. 

There are two settings which must be set to enable the timeout. 


6 USERS 67 

1 Set the Timeout Activity to either “Mouse Click” or “Mouse Movement and 

Click” under System > Miscellaneous. (Refer to “Timeout Activity” on 

page 88.) 

2 Set the timeout value for each user or group under Auto Logout after 

minutes. By default the value is “0”, which means disabled. 

Once the configuration is set, and you click OK to accept the configuration, each 

client must logout and back in to enable the timeout period. Once the timeout 

period has been enabled, a timeout notification will display in the bottom 

taskbar of the Client. 

Product Access Tab 

Access to selected products is configured for All or Custom Publications and 

Editions. 

For access to work properly, publication dates cannot be included in the 

publication or edition name. If dates are included, each will be considered as 

unique and will be added to the list. 


68 USERS 

NOTE: Dummy plans that contain publications/editions (or one plan that 

contains all combinations) should be created and processed during installation 

for accurate configuration and to show all possible publications and editions. If 

a site is going to allow all users to access all publications/editions, this is not 

necessary 

Publication & Editions 

All: When the radio button is selected, the list of publication and editions will be 

automatically populated by the system and will be grayed out. When selected, it 

will define user permissions for all publications/editions (those in the list, and 

those that are not in the list and arrive later). A user can access all publications/ 

editions in the list and any new publications/editions. This is the installed 

default. 

Custom: When the radio button is selected, the list of publication and editions 

will be automatically populated by the system and will be visible. The admin 

must allow access by checking the publications/editions in the list for any publications/editions, 

and for any new publications/editions. 

NOTE: When Custom is selected, the user can be given access to a selected set of 

Products. 

In order to allow wildcarding of publication and edition permissions (the ability 

to define in advance which publication/editions users can access): 


6 USERS 69 

• The list of publications and editions (represented as a two-level tree) is 

automatically populated by the system. 

• Every unique pub/edition combination that arrives in a plan will be added to 

this list. As new pub/editions arrive, the list is updated. 

• An administrator will check which pub/editions a user can access. 

Edit Tree 

You can delete editions from the publication tree by selecting Edit Tree. A dialog 

box displays showing the available publications. 

Add: Adds an edition to the publication tree. (Refer to “Publication Groups” on 

page 71.) 

Delete: Deletes items from the publication tree. 

Close: Closes the dialog box. 

Publication Access 

Publication Access allows an administrator to control the access of publications 

by publication date. A user or group can be granted access to All Dates, Today 

Only, Tomorrow Only, Today and Future Dates, or Tomorrow and Future 

Dates. For Example if a user is granted Today and Future Dates, the only Publication 

visible in the Client will be today’s publication, and any publications in the 

future. Any previous publications will not be visible to the user. 

The default access granted to the user or group is All Dates as it is today. 


70 USERS 

Folder Access Tab 

Access is configured using All or Custom for the Unplanned Folder and Courier 

Express. 

NOTE: For this to properly work, publication dates cannot be included in the 

publication or edition name. If publications or editions include dates, then each 

will be considered as unique and will be added to the list. 

• When Custom is selected, the user can be given access to a selected set of 

Products. 

• The selected user can also be given access to view Unplanned files and to 

view all files arriving in selected Courier Express folders. 

Unplanned Files 

Permits the user to view any files arriving in the selected Input folder that cannot 

be matched to a plan. 

All: The user can view unplanned files arriving in all input folders. This is the 

installed default. 

Custom: The administrator can allow/restrict access to view unplanned files 

arriving in selected input folders. 

Enable Courier Express 

Permits the user to track any files arriving in the selected input folder. 

All: The user can view files arriving in all Courier Express folders. 


6 USERS 71 

Custom: The administrator can allow/restrict access to view files arriving in 

selected Courier Express folders. 

Publication Groups 

For newspapers with a large number of new daily or changing publications 

granting users custom privileges can be a daunting task. Publication Grouping 

seeks to simplify that task by allowing the System Administrator to grant access 

to publications via Publication grouping. 

Currently this feature can only be used when using an external planning tool 

such as Autoplan. 

In order to activate Publication Groups you must add the following tag in red to 

the maxml header for each publication. 

 

 

 

2009-02-23 

Front Page 

Front Page 

East 

 

To add a Publication Group to the system for the first time, you can either drop 

the plan into Courier (which will add the Publication Group automatically); or 

you can add the Publication Group manually by using Configuration. 

For Publications that also have a Publication Group defined, a user can be 

assigned access either by Publication or by Publication Group, but not both for a 

given publication. If the administrator wants to change permission access to use 

Publication Name, then they must use Product Access > Custom > Edit Tree 

to uncheck the Publication Group before using the Publication only access. 

(Refer to “Edit Tree” on page 69.) 

NOTE: Plans without a Publication Group will be treated as having a Blank 

Publication group. All Publication Names must be unique globally and cannot 

belong to more than one Publication Group. 

Add Publication Group 

1 Select Tools > Configuration > Users. 


72 PUBLICATION GROUPS 

2 Select a user from the list of Users that you wish to grant access by publication 

group. 

3 Select the Product Access tab. 

4 Click on the Edit Tree button. 

5 Click Add. 

The Add Publication Group screen will be displayed. In order for the Publication 

Group access to work, you must enter a Pub Group, Pub Name, Pub 

Full Name. 

NOTE: The Edition Name, and Edition Full Name are optional. 

The Pub Group entry must match the entry used in the 

tag in your MAXML plan. The Pub Name and Pub Full Name can be any 

name, but must be unique and not used by any other Publication in the plan. 


6 USERS 73 

Once you have filled in the information, click OK, and close the Edit Tree 

screen. The Publication Group will now be displayed in the Publications and 

Editions window under Product Access. 

6 Check the box next to the Publication Group to grant access. 

7 Exit Configuration by clicking OK. 

Once you have granted access by Publication Group, any Publication in the plan 

that has a Publication Group matching the one in the system, the user will be 

granted those rights in the Client. 







Windows Authentication Server General Notes 

A User can be a Group member, a multiple Group member, or an Individual and 

Group Member. Permission Levels are inherited differently for each User type: 

Group Member 

A User added only to a Group will inherit Group Permissions. 

NOTE: Do not add as an Individual User if only Group Permissions are authorized 

for that user. 

Individual User 

Deleting Individual User 

Who is a Group Member 

Member of Multiple Groups 

If the User is a Group member and an Individual User, User Permissions are set 

by the Individual’s User Permissions Dialog. Individual permissions will supersede 

Group Permissions. 

When an Individual User is deleted from the User List, and the User remains in a 

Group, User Permissions revert back to Group Permissions. 

If a User is a member of two or more Groups, User’s Permissions are the sum of 

all permissions granted by the Groups. 


74 CONFIGURATION TOOLBAR 








CHAPTER 

7 System 

This chapter discusses configuring System parameters. 

System ....................................................................................................................... 76 

Properties .................................................................................................................. 76 

Folders Tab ........................................................................................................ 76 

Scripts Tab ......................................................................................................... 79 

Active Backup Tab .......................................................................................... 81 

Proxy ................................................................................................................... 86 

Subsystem Capacity ...................................................................................... 86 

Miscellaneous .................................................................................................. 87 

Configuration Toolbar ........................................................................................... 89 

75

76 SYSTEM 

System 

System configuration is used to specify global or system-wide properties. 

Properties 

System properties are used to configure files storage, softproofs, script paths, kill 

and error scripts, and Active Backup methods. 

Folders Tab 

Specifies paths to the Files Storage, the Client Soft Proof, and the Scripts folders. 


7 SYSTEM 77 

Files Storage 

This folder contains files gathered from all input points, arranged by type, in 

automatically created subfolders under this folder (e.g., PDF files in a PDF subfolder, 

XML files in an XML subfolder). 

When the input system detects a new file in an input point, the engine will move 

the file to the appropriate subfolder before pre-processing. 

Files will remain in these subfolders until they are purged. 

• To search for a file, select the Browse button. The Select Files Storage Path 

dialog box will open. 

• Enter a path and folder name; or click on a folder, and a path is entered. 

• Click the Set button to accept the changes, or choose Cancel to close. 


78 PROPERTIES 

NOTE: In Windows to change the partition, enter the drive letter in the Path, click 

the Set button, then re-open the Browse button. 

Client Soft Proof 

CAUTION: If you change the default Client Soft Proof path, you must edit the 

server.xml file. Refer to “Server.xml correction” on page 79. 

This folder specifies the path where the engine will store JPEG thumbnail and 

JPEG Soft Proof files. This folder must be accessible to the web server. 

• To search for a file, select the Browse button. The Select Client Soft Proof 

Path dialog box will open. 



Scripts Path 

CAUTION: If you change the default Scripts Path path, you must edit the 

server.xml file. Refer to “Server.xml correction” on page 79. 

• To search for a file, select the Browse button. The Select Scripts Path dialog 

box will open. 


7 SYSTEM 79 



Server.xml correction 

1 If the Client Soft Proof and Scripts Path are changed, you must edit the 

server.xml file and make the same changes as follows: 

2 Locate the server.xml file on your server. It will be located under: 

\jboss\server\default\deploy\jbosswebtomcat50.sar\. 

3 Using a text editor, edit the server.xml file to match the Client Soft Proof 

and Scrips Path. 

NOTE: The Client Soft Proof folder must be accessible to the web server. 

Scripts Tab 

Specifies paths to the Kill and Error scripts. Each script may be enabled or 

disabled. Parameters can be applied to each script with a timeout value. 


80 PROPERTIES 

Kill 

If a file or page is killed, a system wide script runs. If Director Integrator has been 

selected, an XML message is sent to Director. 

• A script can be selected from the drop down list box. 

• Parameters - Customer defined parameters for the script. 

• Timeout - Times out the script after the amount of seconds specified. If it 

does not return before the timeout, kill it and log an error. 

CAUTION: Naming.vbs and Script.cgi are used by the system scripts and should 

not be used otherwise. 

Error 

If any error occurs within the system (system generated, or an error returned by 

another script), a script runs to report the error. The script can do different 

things based on error type. 

The script returns indicate success, error, or warning; and each return can be 

unique depending on who writes the script. 

• A script can be selected from the drop down list box. 


7 SYSTEM 81 

• Parameters - Customer defined parameters for the script that are passed as 

an XML file. 

• Timeout - Times out the script after the amount of seconds specified. If it 

does not return before the timeout, kill it and log an error. 

CAUTION: Naming.vbs and Script.cgi are used by the system scripts and should 

not be used otherwise. 

Active Backup Tab 

Configuration is divided into two areas: database and files. There are two tabs 

for backup: Oracle and MS SQL. 

Oracle 

Configuration is the same as MS SQL server except for the backup options available. 

Log Backup is used most often. Hot Backup should be done at times where 

there is not too much activity on the system. Purged restored backups is used 

to erase backups that were already restored. 

• Log Backup, Hot Backup, and Purge Restored Backups are for use with 

Oracle 10 Standard Edition. 


82 PROPERTIES 

• The Data Guard option is for use with Oracle 10g Enterprise (refer to “Oracle 

10g Data Guard Overview” on page 123). 

Configuring Solaris 

4 File system settings must be changed. 

5 The Oracle user and DBA group IDs must match on both the backup and 

primary servers. 

6 NFS mounts pointing from the primary to the secondary can be established, 

and vice versa. 

7 The standby database is initialized from a snapshot of the primary. 

8 Press the Courier Active Backup System Configuration and restore and 

cleanup jobs that run on standby. 

NOTE: To use the Active Backup settings, see “Active Backup Configuration” on 

page 126. 

Configuring NFS 

1 Create a mount point to other machines that are Arkitex only. 

2 To activate the standby, first share the Arkitex system. 

3 Restart the engine. 

4 Create the mount point. 

Initializing Using Printer Backup 

1 Create a snapshot from the backup or from the primary to the backup. 

2 Mount. 

3 Restore the database to initialize it as a standby. 

Running Default Primary Jobs on the Standby System 

On the standby unit two primary jobs are installed: restore all backups every 30 

minutes from the default location (Active Backup, Backup and Courier only); 

and delete all restart backups over 6 hours old. 

The main script is standbyrestore.csh located in Active backup/bin. The script 

uses the path where the database backups are located (using the optional 

command and optional archive path). 


7 SYSTEM 83 

NOTE: To use the Active Backup settings, see “Active Backup Configuration” on 

page 126. 

The optional commands are Cleanup, Activate, or De-activate. 

NOTE: Cleanup and De-activate use the default setting unless the archive path 

is specified. Without optional commands, the script restores all backups. 

1 De-activate the primary server. 

2 Clean up the directory where the database backups are located. 

3 Activate the standby server, and restart it. 

4 Create a Hot Backup of the old primary server to initialize the old primary as 

the standby server. 

5 Start Courier on the primary server. 

6 Initialize the standby server instead of the primary server. 

7 To activate, either use the script or the backup utility. 

Backup Types 

• Data Guard - Enterprise active backup (refer to “Oracle 10g Data Guard 

Overview” on page 123). 

NOTE: When Data Guard is selected, Log Backup is grayed out. 

• Log Backup - Causes the current transaction logs to be archived and moves 

all archived transaction logs to the backup destination (standby server). 

CAUTION: This is the most efficient type of backup and should be done the most 

frequently of any backup (every 10-30 minutes, depending on how much data 

you are willing to loose if the primary goes down). 

 

Start Time - Defines the start time for the backup. 

Frequency - Runs as a scheduled script job once a day. Values are every 5 

minutes, 10 minutes, 15 minutes, 30 minutes; every hour; or every 6 

hours. 


84 PROPERTIES 

• Hot Backup - Can be done a couple of times per day and can cause performance 

issues and should be scheduled for times of low server/database load. 

NOTE: It is recommended that this be done once a day, when a hot backup is 

restored on the standby server it will make all previous log archive backups 

unnecessary and the old archived logs will be purged from the archive location 

of oracle. 

 

 


Frequency - Runs as a scheduled script job once a day. Values are every 

hour, every 6 hours, or every day. 

• Purge Restored Backup - Allows you to choose how often you want to purge 

the backups that are no longer needed. 

NOTE: The Purge Restored Backups check box, Start Time and Frequency 

are grayed out. To make changes to the Purge Restored Backups, you must 

check either the Log Backup or Hot Backup check box. 

NOTE: Backups that already have been restored on the standby will be purged 

from the backup location on the primary and resynced with the standby 

which will cause a purge on the standby. 

 

 


Frequency - Runs as a scheduled script job once a day. Values are every 

hour, every 6 hours, or every day. 

• Database Server Name - Use localhost. 

• Sys Password - Password for the sys user of the Oracle database. 

• Backup Server Name - Name of the backup server. 

• Backup Database Path - Path to the NFS directory that is mapped to the 

standby Arkitex home (i.e., /backup). 

• Engine Home Path - Path to Arkitex home on the machine that the engine is 

installed on. 

• Client Home Path - Path to the Arkitex home on the machine where the 

client is installed. 


7 SYSTEM 85 

• Error Log Path - Path to directory that will hold the logs of failed Oracle 

backups. 

NOTE: When a backup fails the log file will be moved to this directory and the 

backup directory will be deleted. 

• Backup Data Files - If left unchecked only the database will be backed up. 

MS SQL Server 

There is a choice to back up the database, data files, or both. 

• Database Backup - Enables database back up. 

 


Frequency - Runs as a scheduled script job every 5, 10, 15, 20, and 30 

minutes, every hour, every 6 hours, or once a day. 

 

 

 

 

 

Number of Saved Backups - Counter showing number of saved backups. 

Database Server Name - Name of the database server to backup. 

User Name - User logon name. 

Password - User password. 

Backup Server Name - Name of the Backup server. 


86 PROPERTIES 

 

 

 

 

 

Backup Database Path - Path to the database to back up. 

Engine Home Path - The home path of the Arkitex Engine. 

Client Home Path - The home path of the Arkitex Client. 

Error Log Path - Path to where error logs are located. 

Backup Data Files - Backs up of data files. This copies the status of each 

file. 

Proxy 

Information filled out under the Proxy tab is read by the system when the Use 

Proxy box is checked under Destinations. 

Properties 

• Host Name - The host name of the FTP server. 

• User Name - The user login name for the FTP server. 

• Password - The user password for the FTP server. 

• Use ‘USER’ command - If checked, this xml variable will be used. 

• Use ‘PASS’ command - If checked, this xml variable will be used. 

Subsystem 

Capacity 

Information under the Subsystem Capacity tab is used to control the number of 

threads that each subsystem runs in parallel. If your system is running over 


7 SYSTEM 87 

capacity, decrease the thread count. If your system is running under capacity, 

increase the count. It is recommended that increases be done in increments of 5. 

Properties 

• Input Subsystem Capacity - Threads running under the Input Subsystem. 

The default is 5. 

• File Subsystem Capacity - Threads running under the Input Subsystem. The 

default is 10. 

• Scripting Subsystem Capacity - Threads running under the Scripting 

Subsystem. The default is 5. 

• Soft Proof Subsystem Capacity - Threads running under the Soft Proof 


• Timer Subsystem Capacity - Threads running under the Timer Subsystem. 

The default is 5. 

• Transmission Subsystem Capacity - Threads running under the Transmission 


Miscellaneous 

Three system wide settings can be set that control Advertising Approval, 

Approval from Soft Proof, Copy and Paste capability, and Time Format. 


88 PROPERTIES 

Ignore Advertising 

Approval 

Approval From Soft Proof 

Only 

Disable Copy And Paste 

Time Format 

The Advertising Approval for output can be turned off. The Advertising Approval 

check box will remain for verification purposes. 

Page Approval can be disabled everywhere except in the display of the Soft 

Proof. 

Copy and Paste can be disabled for all users. These items will appear grayed in 

menus. 

Controls the system-wide format to use. Select the format from the dropdown 

list. 

Timeout Activity 

Allows the system administrator to set an auto-logout of the client when it is not 

in use. The client will detect whether to automatically disconnect a client after a 

set timeout period based on either the last time a mouse has been clicked, or 

movement of the mouse with a mouse click. Each user or group can be configured 

to have different timeout properties. Select the timeout value from the 

dropdown list. 


7 SYSTEM 89 

There are two settings which must be set to enable the timeout. 

1 Set the Timeout Activity to either “Mouse Click” or “Mouse Movement and 

Click”. 

2 Set the Auto Logout after minutes for each user or group under User Configuration 

> Permissions. (Refer to “Auto Logout after minutes” on page 66.) 

Once the configuration is set, and you click OK to accept the configuration, each 

client must logout and back in to enable the timeout period. Once the timeout 

period has been enabled, a timeout notification will display in the bottom 

taskbar of the Client. 










CHAPTER 

8 

Courier-Renaming 

Rules 

This chapter discusses configuring renaming rules. 

Renaming Rules ..................................................................................................... 92 

Renaming Facilities ....................................................................................... 92 

Input Rules ....................................................................................................... 92 

Output Name Generators ............................................................................ 93 

Naming Script Functions ............................................................................. 96 

Script Initialization ........................................................................................ 97 

Editing the Rename Table ........................................................................... 97 

Testing Rename Rules .................................................................................. 97 

Special Uses of Renaming .......................................................................... 97 

Renaming Examples ...................................................................................... 98 

Renaming Rules List Box .......................................................................... 100 

Properties ............................................................................................................... 102 

Parameters ..................................................................................................... 105 

Configuration Toolbar ........................................................................................ 108 

91

92 RENAMING RULES 

Renaming Rules 

File renaming rules can be created and tested before applying them to the 

Courier system. These perform in the same way as Renaming Rules to Arkitex 

Integrator and Arkitex News Drive. The only difference is the use of a Test 

button to test the rules in Courier. Renaming is being done by the server and not 

the client. 

• File Renaming, which can be used both for Inputs and/or for Destinations, 

provides a very flexible method for translating and converting file names. 

• File renaming sets define where each set consists of one or more renaming 

rules. Each rule defines an input name pattern to match and, if matched, a 

pattern for file name conversion. 

• When a given renaming set is used, and no match is found, the file continues 

processing with no file renaming taking place. 

Renaming Facilities 

Courier has powerful renaming facilities which may be set up independently for 

each output process. These allow the filenames to be analyzed and then new 

output filenames and associated processing parameters to be generated as a 

result of this analysis. 

Renaming works through a table of rules and name generators held in each 

output process set up. 

The input rules are scanned in turn until a match is found, and then the output 

names and parameters are generated according to the template. If no match is 

found, the filename is left as original although the extension may be changed 

according to the function employed. If the filename is matched, but the output 

name template results in an empty filename, this file will be skipped by this 

process. 

NOTE: The order of the entries in the table may be important in resolving 

ambiguities in the renaming. Entries at the top are tried first. 

Input Rules 

The first column in the renaming table holds the set of input rules that are used 

to analyze and match the incoming filenames. 

Input rules are a mixture of parameters and literal strings. A parameter is 

%xyzCode where xyz is an optional format, and Code controls how the file is 

interpreted. If xyz is present, then it determines the number of characters 


8 COURIER-RENAMING RULES 93 

scanned for this parameter. If it is not present, then the next part of the rule must 

be a literal; and all characters up to this literal will be scanned. 

The possible parameter codes are: 

• D – Date. For date parameters the format can contain dmyw characters to 

pick out the day month year and week numbers, e.g., %dd-mm-yyyyD will 

scan and pick out the Date string in the filename. If week numbers are used, 

the day and month will be ignored. If year or month are not defined, they 

default appropriately. Day numbers are assumed to be ‘later than the day 

before yesterday’, e.g., if today is 29th March, then 27 is assumed to be 

March, but 01 up to 26 are assumed to be April. The same logic applies to 

years. 

• N – Number. For number parameters the format can be a number, which will 

be the number of characters scanned and evaluated as a number, e.g., %3N 

will take 3 characters as a number, %N_ will take all characters up to the “_” 

as the number field. 

• S – String. For string parameters the format can be a number, which will be 

the number of characters scanned and kept as a string, e.g., %5S will take 5 

characters as the string, %S_ will take all characters up to the “_” as the string 

field. 

• [CharSet] – Wildcard. This can be used to match input characters against a 

set of characters. All characters in the input segment must match against one 

of the characters in the Charset. The segment is available for use in the 

output naming just like the D, N, or S parameter codes. The Charset can be a 

list of characters, and can contain ranges as well. For example %2[A-Z0-9] 

will take 2 characters as a string, and check that they are both alphanumeric. 

As each parameter is scanned, it is saved as a sequentially indexed variable 

(starting from 1) for later renaming usage. 

NOTE: There are no limits to the number of input rules, or the number of fields in 

each rule. The matching has been optimized to allow high speed matching of 

multiple rules and large look up tables held in the rules. 

Output Name 

Generators 

Two output columns are provided to generate two names from the data scanned 

from the input filename. The first, OPNames, is the name that will be used for 

the Output file, or the printer (if printing to the dynamic printer). Parameters is 

the data that may be sent to a function to control its operation. If the Parameters 

field is blank, then the Parameters defined for the whole output function is used 

instead. 



The output name templates are a mixture of literal characters and parameters 

obtained from the input rule. A parameter is %n:xyzCode and may be used in 

any position in the output name template. Parameters can also be repeated in 

different positions and with different formats. 

The possible parameter codes are: 

• D – Date. For date parameters the format can contain dmyw characters to 

pick out the day month years or week number, e.g., %3:mmddyyD will 

reformat the 3rd scanned parameter Date string in the output filename. If 

week numbers are used, the first week of the year is controlled by a system 

parameter in the environment file. Similarly, day numbers or day names are 

also controlled by a system parameter in the environment file. 

The following formatting characters can be used. 

• d - Display the day as a number without a leading zero (1 – 31). 

• dd - Display the day as a number with a leading zero (01 – 31). 

• ddd - Display the day as an abbreviation (Sun – Sat). 

• dddd - Display the day as a full name (Sunday – Saturday). 

• ddddd - Display the date as a complete date (including day, month, and 

year), formatted according to your system's short date format setting. For 

Microsoft Windows, the default short date format is m/d/yy. 

• dddddd - Display a date serial number as a complete date (including day, 

month, and year) formatted according to the long date setting recognized by 

your system. For Microsoft Windows, the default long date format is 

mmmm dd, yyyy. 

• w - Display the day of the week as a number (1 for Sunday through 7 for 

Saturday). 

• ww - Display the week of the year as a number (1 – 54). 

• m - Display the month as a number without a leading zero (1 – 12). 

If m immediately follows h or hh, the minute rather than the month is 

displayed. 

• mm - Display the month as a number with a leading zero (01 – 12). 

If m immediately follows h or hh, the minute rather than the month is 

displayed. 



• mmm - Display the month as an abbreviation (Jan – Dec). 

• mmmm - Display the month as a full month name (January – December). 

• q - Display the quarter of the year as a number (1 – 4). 

• y - Display the day of the year as a number (1 – 366). 

• yy - Display the year as a 2-digit number (00 – 99). 

• yyyy - Display the year as a 4-digit number (100 – 9999). 

• F – Filtered. This will filter the scanned parameter to only have alphanumeric 

characters. All other characters are stripped out. 

• L – Left String. This will output the left part of the scanned parameter, e.g., 

%2:3L will output the left 3 characters of the scanned string. If the number is 

left out, it defaults to 1. If the scanned parameter is not long enough, it is all 

used. If the number is negative, this refers to the number of characters to take 

off the right part of the string (e.g., %2:-3L will produce abcd from abcdefg) 

• M – Middle String. This will output the middle part of the scanned parameter, 

e.g., %1:3:2M will output the 2 characters of the scanned string starting 

from the third. If one of the numbers is left out, it defaults to 1. If the scanned 

parameter is not long enough, it is all used. 

• N – Number. This will output the scanned parameter as a formatted number, 

e.g., %3:000N will output the number as 3 digits with leading 0s. If no 

formatting string is present, the number will be a variable length. If the 

number is too big to fit, it will be truncated. 

• R – Right String. This will output the right part of the scanned parameter, 

e.g., %2:3R will output the right 3 characters of the scanned string. If the 

number is left out, it defaults to 1. If the scanned parameter is not long 

enough, it is all used. 

• S – String. This will output the whole string. If there is a formatting string, it 

will be used to pad the scanned parameter to the length of the formatting 

string. Normally the padding is to the left of the string. If the first character of 

the formatting string is a / then it will fill using the remainder on the right, 

e.g., %1:######S will produce ###ABC if the first parameter is ABC. 

%1:/######S will produce ABC###. 

• T – Table. This will search through the table again matching the parameter 

against the input rules. This may be used to translate arbitrary strings like 

titles or colors. If a formatting string is present, it will be added on to the front 



of the scanned parameter before the in rules are searched. This can make it 

easier to document the rules and can avoid ambiguity in rule matching, e.g., 

%2:Col=T with a scanned parameter of C will search the table for a rule with 

Col=C and substitute the output name. 

Naming Script 

Functions 

In addition to all the built in parameters in the Output name generator, Courier 

supports the calling of scriptable functions within the output name templates 

control string to give extensibility in the mechanisms used to create output 

names. 

These functions are contained within a single script file called Naming.vbs and 

are loaded each time the Courier application is started, or the main scanning is 

enabled. If the Script is edited while Courier is active, you need to disable and 

enable scanning to reload the functions and make any new functions available. 

A naming function script is called by embedding a sequence at any point in one 

of the Output name templates. This sequence has the form: 

• %$(FunctionName:Control) - Where FunctionName is the actual Name of 

a function in the MovePrintNaming script and Control is an optional control 

string sent to the function. 

Each function is passed three arguments: the Control string, the input 

filename, and a parameter. 

NOTE: This is a change from V2 Courier naming scripts, which only had two 

arguments. Any scripts being ported from V2 to V3 will need to have the extra 

argument added to the functions even if it is not used. 

The Naming function can generate any text content and pass this back as a single 

string. This is then inserted into the output name in place of the call to the script. 

Multiple functions can be called within the same output name template, and 

different name templates can use different functions if they wish. 

If the function does not exist, or will not run, then the call is replaced by an 

empty string. 

A script may also pass back the keyword Null to indicate that this rule should be 

regarded as invalid and allow Courier to try further rules in the table. 



Script Initialization 

Normally each script function is self contained and does not require any initialization. 

Sometimes it is more efficient to perform some global initialization, for 

example, to create look up tables once. 

As the Naming Script is loaded, it is checked for a special function called 

NamingInitialisation. If this is present, it is called once to perform any special 

set up. It does not take any parameters. 

Editing the Rename 

Table 

Entries in the rename table may be added or edited by clicking in the cell and 

typing. Cursor keys may be used to move between cells. The contents of a cell 

may be cut and pasted to other cells. 

A single row may be inserted by clicking on the small gray column, and then 

pressing the insert key. The contents of multiple rows may be deleted by 

marking them using the first gray column, and pressing the delete key. This does 

not actually delete the rows, but rows with empty rules will be automatically 

removed when the dialog is closed. 

Multiple rows may be copied and pasted to other rows in the same table, or to 

the tables in the other folder set ups. This is useful for putting the same set of 

rules into all folders. Mark the rows using the gray column, and use the CTRL-C 

and CTRL-V keys. When rows are pasted, they will overwrite previous contents. 

Testing Rename 

Rules 

If you are using complex or multiple rules, you may wish to try them without 

having to process files. Two entry boxes below the rules table allow you to do 

this. 

The contents of the left-hand box are transformed to the right hand box using all 

the rows in the table. You may change the text, the rules and names, and see the 

effect immediately on the rename name generated. 

Special Uses of 

Renaming 

1 Output SubFolders 

The final output name can have \ characters either from input subfolder 

scanning, or by the insertion of \ characters in the output rules. Courier will 

check and create subfolders under the normal output path as required. 

NOTE: This is only operational for Windows destinations and not for FTP move. 

2 Selective skipping 



If the input rule is matched, and the OPName produces a blank filename, 

functions that require an output filename (e.g., non-printing functions) will be 

skipped. This may be used to give a more selective process matching set of rules. 

3 Dynamic Printing support 

The renaming function may be used to select the printer used for the print 

functions based on the filename. To use this, select the last printer in the printer 

selection list (“Dynamic”). Then set up a renaming rule table where each input 

rule selects a particular class of filename, and each output rule contains the 

name of the printer (exactly how it appears in the selector). As each file is 

processed, the table is searched for a matching entry. The printer in the table is 

then used. If no entries match, the operation is skipped. 

Renaming 

Examples 

1 Reordering Fields 

The filename consists of PPTTTEEEC where PP is a page number, TTT is a 

Title, EEE is an edition, and C is a color. The desired output filename is 

TTT_EEE_PP_C.tif 

As the input filename has fixed length fields, it is simple to scan and 

reorder 

IPRule = %2N%3S%3S%1S 

OPName = %2S_%3S_%1:00N_%4S.tif 

09ABCDEFK -> ABC_DEF_09_K.tif 

2 Extracting SubFields 

The filename consists of Title.Edition.P.Colour where P is a variable length 

page number, Title is a variable length Title, Edition is a variable length 

edition, and Colour is a color name. The desired output filename is 

TT_EEE_PP_C.tif where TT is the second and third letters of the title, EEE is 

the last three letters of the Edition, PP is a fixed length Page number, and C 

is the first letter of the Color. 

As the input filename has separators, use these to scan and reprocess the 

fields with the string selection Output parameters. 

IPRule = %S.%S.%N.%S 

OPName = %1:2:2M_%2:3R_%3:00N_%4:1L.tif 

3DTimes.FirstED1.3.Cyan -> DT_ED1_03_C.tif 

3 Using Multiple Rules 



Two types of filename exist. Some use of Title.Edition.PP.C where P is a 

fixed length page number, Title is a variable length Title, Edition is a variable 

length edition, and Colour is a color character. Alternatively for the ‘Main’ 

Title, the format is Edition.PP.C, and the Title is assumed to be Main. The 

desired output filename is Title_Edition_PP_C.tif. 

As the input filename has separators, use these to scan. Use two rules to pick 

out the variants. 

IPRule1 = %S.%S.%N.%S 

OPName1 = %1S_%2S_%3:00N_%4S.tif 

IPRule2 =%S.%N.%S 

OPName1 = Main_%1S_%2:00N_%3S.tif 

3DTimes.FirstED1.3.Cyan -> DT_ED1_03_C.tif 

4 Using Table translation 

The filename consists of E.P.C where E is an edition number (1=First, 2= 

Second), P is a page number, and C is a color code. The desired output 

filename is EditionName_PP_ColourName.tif. 

As the input filename has separators, use these to scan. Use two sets of Table 

rules to translate the Edition and color names. 

IPRule1 = %S.%N.%S 

OPName1 = %1:edT_%2:00N_%3:colT.tif 

IPRule2 = ed1 OPName2 = First 

IPRule3 = ed2 OPName3 = Second 

IPRule4 = colC OPName4 = Cyan 

IPRule5 = colM OPName5 = Magenta 

IPRule6 = colY OPName6 = Yellow 

IPRule7 = colK OPName7 = Black 

2. 3.K -> Second_ 03_Black.tif 

5 Changing date format 

The filename consists of TTDDPPC where TT is a title, D is a day number, and 

PP is a page number, and C is a colour. The desired output filename is 

YYYYMMDDTTPPC. 



As the input filename has fixed lengths, use these to scan. Use the date 

scanner, and do not bother to separate PPC as this is a string needed in the 

output. 

IPRule1 = %2S%ddD%S 

OPName1 = %2:yyyymmddD%1S%3S 

AB1205K -> 20020312AB05K 

6 Using a Script function 

The filename consists of FileName.Tif The desired output filename is 

FileNamexxxxxx.tif where xxxxxx is a random number to make the 

filename unique. 

As the input filename has a separator, use this to scan. Use the example 

Script function Random to generate the number needed. This takes a 

control number specifying the number of digits generated. 

IPRule1 = %S.%S 

OPName1 = %1S%$(Random:6).%2S 

File.Tif -> File239871.Tif 

Renaming Rules 

List Box 

The list box displays renaming rules. Rules may be added using the Add button, 

deleted by using the Delete button, and renamed using the Rename button 

when the rule name is highlighted. 



• Click the Add button and enter a Renaming Rule Name. 

• Select a user or group, and click the OK button. The new user now appears in 

the Users list box. 

• To delete select a rule, and click the Delete button. 


• To rename, select a rule from the list, and click the Rename button. Begin 

entering a new name, and the old name will be overwritten. Click OK. 


102 PROPERTIES 

Properties 

Properties that can be configured include: UnplannedColor, Configuring Colors, 

Input and Output Names. 

Unplanned Color Soft Proofs 

If an unplanned file matches a renaming rule with parameters identifying both 

a JobName and a Color, this unplanned file will be combined with other files in 

Unplanned with the same JobName to create a color soft proof. 

NOTE: JobName indicates which part of the file to use to match files to each 

other. 

Unplanned Color Renaming Rules 

These checkboxes are used to indicate which of the columns display. These 

affect Unplanned files. 

Enable Renaming 

Enable Color Unplanned 

Thumbnails 

Enable FastTrack 

Indicates if renaming takes place and if the Output Name column appears. If this 

is not checked the Output Name column is hidden and no renaming takes place. 

Indicates if color thumbnails are generated for unplanned files. If this is not 

checked the Job column is hidden. 

Indicates if FastTrack editions are used. If this is not checked, the Parameters 

column is hidden. 

This renaming rule enhancement allows the assignment of default values for 

commonly used parameters. The Parameters dialog is accessed when the user 

selects the Add Parameters button on the far right of the Parameters column. 

(Refer to “Parameters” on page 105.) 

FastTrack 

FastTrack allows plan base tracking (i.e., product appears in the planned tree) 

for publications without requiring a plan. 

By enhancing renaming rules Courier pulls publication information (Pub Name, 

Ed Name, Zone Name, Section Name, Page Number, Color, JobName) from the 



file name and uses this information to automatically create the appropriate tree 

entry. 

A new node in the Publication Tree will be created and populate itself based on 

files in the input folder that have met the FastTrack criteria. 

The user enters an Input Rule and Output Name, was Output Rule previously. 

Configure Colors 

You can define FastTrack RGB Color IDs for files received in Unplanned. Set up 

the Color ID in the Colors dialog box. If a file is received with that Color ID, the 

color will appear as a tab in the soft proof. 



Add 

Delete 

Adds a new color row. 

Removes the selected color row. 

Renaming Rules Table 

Renaming allows the assignment of default values for commonly used parameters. 

The dialog box is resizable. You can pull the lower right corner to stretch the 

box to the desired size. You can also size the column width by clicking between 

column headings. 

Input Name 

Output Name 

Job ID 

Color ID 

Parameters 

Identifies a file name pattern to test against the input file name. 

Can be used to pad page numbers with padding characters to create a lookup 

table, or to convert date formats. 

Used for unplanned softproofing. 

Used for unplanned softproofing. 

Adding parameters makes the rule a FastTrack rule. 



Parameters 

Enter values for any parameters you want to be associated with this FastTrack 

rule in the text field next to any of the default parameters. The short name form 

of the default values is in parenthesis next to the full name of each parameter. 

Descriptions will be localizable; the keywords are not. This is what will appear 

in the Parameters columns in the Renaming Rules Table. 

Description Keyword Required Valid Values Default 

Publication Date* DATE Yes Date N/A 

(DATE) 

Be sure the Publication Date field is formatted as a Date value (i.e., %3:mmddyyD). 

Publication* (PUB) PUB Yes Text N/A 

Edition (EDIT) EDIT No Text N/A 

Zone (ZN) ZN No Text N/A 

Section (SEC) SEC No Text N/A 

Approval (APR) APP No Yes/No 

True/False 

No 



Approval Mode (AMD)* AMD No Normal 

Deferred 

Late Black 

Update Black 

Blank for No 

Approval required 

None 

The Approval Mode is set by the first file arriving in a Publication or Edition. 

If the Approval Mode is Late Black, Update Black, or Deferred, this mode is set for a Publication 

by the arrival of the first file in that Publication. This means that the entire Publication is 

set into one of these modes. Once the Approval Mode for a Publication is set to one of these 

modes, each file should have the Approval Parameter set to Yes or True. 

If the Approval Mode is Normal, that mode is set for an Edition and is set by the arrival of the 

first file in that Edition. This means that the Edition is set into Normal approval mode so that 

other Editions in the same Publication may not have an Approval Mode (a “blank” or empty 

Approval Mode parameter). When in Normal mode, each file can have Approval of On/True, 

or Off/False based on other parameters such as color files requiring approval while 

monochrome files do not require approval. 

Page Approval (APR) APR No Yes/No 

True/False 

Priority (PRI) PRI No Number from X to 

Y 

Destination Group 

(DGP) 

Duplicate File Action 

(DFA) 

DGP No Text Picked up from input 

folder 

DFA No Accept 

Ignore 

Ask 

No 

? 

Accept 

Page Number* (PG#) PG# Yes Number N/A 

File Version (VER) VER No Number N/A 

Hot Time Start Time HTST No (HTST = hh:mm) No default value 

(HTST)* 

Hot Time Start Day HTSD No (HTSD = d) 1 

(HTSD)* 

Hot Time End Time HTET No HTED = hh:mm) 23:59 

(HTET)* 

Hot Time End Day 

(HTED)* 

HTED No (HTED = d) 0 



Priority Before (HTPB)* HTPB No (HTPB = nn) 0 

Priority After (HTPA)* HTPA No (HTPA = nn) 50 

Where d = days before publication date 

Where hh = hours (0-23) 

Where mm = minutes (0-59); Note: minute is optional 

Priority during Hot Time is Priority (Pri). 

Table substitution can also be used. If the name of the substitution string starts with dow, 

the publication day of the week will replace dow. 

"dow_NYT" will become "mon_NYT", "tue_NYT", "wed_NYT", "thu_NYT", "fri_NYT", 

"sat_NYT", "sun_NYT" 

NOTE: If the keywords defined as required are not set, then the configuration 

should not be saved, and you must complete the setting. 

Cancel 

Add Parameters 

Closes the Parameters dialog box and makes no changes. 

Adds entered text to the Parameters column in the Renaming Rules Table. 

Input Rules 

These identify a file name pattern to test against the input file name. 

Test Rules 

The Input Name will be tested against the rules in the Renaming Rules Table. 

Results will be displayed in the Output Name, Job ID, Color ID, and Parameters 

fields. 

Output Rules 

These can be used to pad page numbers with characters to create a lookup table, 

or to convert date formats. 

Output Name 

Job ID 

Color ID 

Parameters 

If an output name is matched, it will appear in the Output Name field. 

If a Job ID name is matched, it will appear in the Job ID field. 

If an Color ID is matched, it will appear in the Color ID field. 

If a Parameters name is matched, it will appear in the Parameters field. 



Toolbar 

Use these tools to add and remove rows to the rules table and to test the rule. 

Add 

Delete 

Test Rule 

Adds a row to the Input Rules and Output Rules. 

Removes a row from the Input Rules and Output Rules. 

Tests the selected rule to see if it is functional. After the Test Rules button is 

pressed, the results show if the rule was successfully implemented. 








CHAPTER 

9 UNIX 

This chapter discusses the Unix interface. 

UNIX ........................................................................................................................ 110 

Client Interface .................................................................................................... 110 

Configuration Toolbar ........................................................................................ 110 

109

110 UNIX 

UNIX 

Courier runs on an Oracle 10 database in a Sun Solaris SPARC environment. 

User authentication can be performed on either a Windows NT system or a 

Solaris Unix system. (Refer to “Windows Authentication Server General Notes” 

on page 73.) 

• To begin configuration, select Tools > Configuration from the menu. 

• Follow the configuration guidelines for Destination Groups and Users (refer 

to “Destination Groups” on page 48 and “Users” on page 64). 

NOTE: Follow UNIX syntax to enter paths for folders and scripts for 

Destinations, Input, System, and when using Import and Export. 

Client Interface 

The Client interface has the same functionality in a UNIX environment as in a 

Windows environment. 








CHAPTER 

10 

Active Backup for MS SQL 

on Windows 

This chapter discusses the MS SQL active backup for Windows. 

Prerequisites ......................................................................................................... 112 

Active Backup Configuration .......................................................................... 112 

Timed Backup ............................................................................................... 112 

Real-Time Backup ....................................................................................... 112 

Install/Configure rsync ..................................................................................... 113 

Installation ..................................................................................................... 113 

Folder Permissions ...................................................................................... 113 

RsyncServer Service ................................................................................... 113 

Configuration ................................................................................................ 113 

Rsync Configuration ................................................................................... 113 

Temporary Working Folder ...................................................................... 114 

Courier Active Backup Configuration .......................................................... 115 

Configuration ................................................................................................ 115 

Paths ................................................................................................................ 116 

Activation of Backup Server ............................................................................ 116 

Active Backup Batch Files ............................................................................... 118 

Snapshot ................................................................................................................. 118 

Rsync Options ...................................................................................................... 120 

Optional Module .......................................................................................... 120 

Setting the Port for rsync server ............................................................ 120 

Remote_sync.cmd Script .......................................................................... 120 

backupFiles.cfg ............................................................................................. 121 

111

112 PREREQUISITES 

Prerequisites 

• MS SQL installed on the backup server 

• Courier installed on the backup server 

Active Backup Configuration 

Active Backup for MS SQL on Windows consists of: 

• “Install/Configure rsync” on page 113 

• “Courier Active Backup Configuration” on page 115 

• “Activation of Backup Server” on page 116 

• “Active Backup Batch Files” on page 118 

• “Snapshot” on page 118 

The Courier Active Backup Configuration defines settings that are needed for 

timed backup jobs, as well as real-time backup of data files. 

Timed Backup 

The timed backup job will: 

• backup the database 

• rsync: 

 

 

 

 

the database backups 

the softproofs folder 

the filestorage folder 

anything configured in the 

"ARKITEX_HOME\Courier\active_backup\conf\backupFiles.cfg" file 

Real-Time Backup 

The real-time backup will rsync anything that is modified/created in the 

filestorage location. This includes pages and plans. 


10 ACTIVE BACKUP FOR MS SQL ON WINDOWS 113 

Install/Configure rsync 

By default rsync on Windows will be setup to run in socket mode. It will install as 

a service (on the backup server) and be configured to open up certain folders 

that can be synchronized with an rsync client (from the primary server). 

Installation 

A cwRsync installer is located in ARKITEX_HOME\third party. Run it, and install in 

%ARKITEX_HOME%\rsync on both the primary and backup servers. 

NOTE: If you have a Windows password policy enabled which expires passwords, 

you may want to edit the Windows cwrsync account, and check the box next to 

Password never expires. 

Folder Permissions 

The rsync installation creates a user "cwrsync". This user must have Full Control 

permission to the folders specified in the rsycnd.conf file. 

RsyncServer 

Service 

By default the "RsyncServer" service is installed to start up manually. This should 

be changed to Automatic, and the service should be started on both servers. 

Configuration 

Identical configuration is recommended for both the primary and backup 

servers. Both should have an rsync server configured so either one can be the 

backup server. 

Steps 

1 Modify the %ARKITEX_HOME%\rsync\rsyncd.conf file. This file defines mount 

points and modules that are opened by the rsync server. 

2 Add the following to your rsyncd.conf, substituting c/arkitex/ with the directory 

you selected during installation (c/arkitex/ is the example location): 

NOTE: A colon (:) is not used to designate the drive letter. 

Rsync 

Configuration 

The Rsyncd.conf file contains configuration options for Courier as well as necessary 

modules needed to synchronize files. Three modules (arkitex, softproof, 

and filestorage) are required for Courier and must point to the paths configured 

using Courier System Configuration (see “System” on page 76). The options at 

the beginning of the rsyncd.conf file should not be deleted. 


114 INSTALL/CONFIGURE RSYNC 

NOTE: Modifying Courier System Configuration will not cause this file to change; 

it must be maintained separately. 

Specifying these modules allows the rsync client to create/delete files in those 

folders, and anything under them. 

use chroot = false 

strict modes = false 

hosts allow = * 

log file = rsyncd.log 

pid file = rsyncd.pid 

[arkitex] 

path = /cygdrive/c/arkitex/ 

read only = false 

transfer logging = yes 

[softproof] 

path = /cygdrive/c/arkitex/courier/clientsoftproof 



[filestorage] 

path = /cygdrive/c/arkitex/courier/FileStorage 



3 Replace the paths with what is configured on your system. 

NOTE: Any configuration changes made outside the Configuration screen under 

Tools in the Client will not be automatically replicated to the standby server. 

This includes changes to the server.xml file for the Client Softproof path. 

Temporary Working 

Folder 

A new configurable feature has been added to softproofing. Errors are being 

reported in the rsync log when transient (temporary) working files appear then 

disappear from the ClientSoftProof folder. This is a timing related problem that 

may show when softproofs are generated while an rsync (active backup) is being 

performed. 

To avoid this, the softproof subsystem can be configured to use a temporary 

working folder. This folder must be specified in the 

$ARKITEX_HOME\Courier\conf\subsystem.properties file. The format is: 



softproof.workingfolder = c:\\Arkitex\\sptemp 

where the folder is an arbitrary folder on the same file system (device) as 

$ARKITEX_HOME. 

NOTE: This folder should NOT be a sub folder to 

$ARKITEX_HOME\Courier\ClientSoftProof, since rsync runs recursively. The rsync 

process may attempt to transfer transient SoftProof files. Pathnames on a 

Windows system must be escaped (use \\ to indicate each directory level). 

Courier Active Backup Configuration 

Configuration 

The Active Backup configuration for MS SQL Server (see “MS SQL Server” on 

page 85) consists of the: 

• Database Backup - Start time of the first active backup job of the day and 

how often it should run. 

• Number of saved backups - Number of backups to keep. 

• Database Server Name - Name of the server the database is installed on 

(localhost). 


116 ACTIVATION OF BACKUP SERVER 

• User Name - Database user. 

• Password - Password for user. 

• Backup Server Name - Name or IP of the backup server. 

• Backup Database path - Path to where the database backups are to be 

placed. 

• Engine Home path - Path to the Arkitex home on the machine where the 

engine is installed. 

• Client Home path - Path to the Arkitex home on the machine where Client is 

installed. 

• Error log path - Path to directory that will hold the logs of failed backups. 

• Backup Data Files - If left unchecked, no files will be backed up; only the 

database. 

Paths 

Paths are relative from the Engine Home Path, or the Client Home Path set up 

in System Configuration. If there is no such file under the Engine Home Path, 

the Client Home Path is used. 

Activation of Backup Server 

This section details the procedures to activate the backup server when the 

primary server is down. 

NOTE: Before activating the standby server, you should verify that data files have 

been synchronized between primary and standby servers through active backup. 

You should also verify that the database backups on the standby server match 

those on the primary server. 

Activation is accomplished using the 

"%ARKITEX_HOME%\Courier\active_backup\bin\backup_util.bat" utility. 

Setup 

1 Stop Courier Services on the primary server. 

2 Stop Courier Services on the secondary server. 



3 Launch backup_util.bat. The :Arkitex Courier Backup Utility window will 

open. 

4 Supply the Arkitex Home directory. 

5 Click Browse and select your Arkitex Home directory. 

6 For MS SQL User, enter the user name and password. 

7 Supply the database backup directory. 

NOTE: Make sure no MS SQL tools are open on the server you are trying to 

activate, or the activation will fail. 

8 Click Browse, and select the database backup directory. 

9 Click on Activate. 

10 You will be asked if you want to enable Active Backup on the newly 

activated server to allow backups to a new backup server. 

1 If you answer No then the system configuration will be modified, and the 

data file and database backups will be disabled. The backup server name 

will be reset to blank. 


118 ACTIVE BACKUP BATCH FILES 

2 If you answer Yes, you will be prompted for the new backup server name. 

11 The configuration will be updated with the new backup server name. 

12 When complete the following dialog will display: 

NOTE: After activating the current Backup Server, it is best to disable the "Arkitex 

Courier Engine" service in the Services control panel on the new "Backup" server. 

Active Backup Batch Files 

There are two other batch files that are part of active backup: stndby_backup.bat 

and stndby_restore.bat. These are located in the 

Arkitex\Courier\active_backup\bin directory 

CAUTION: They are used internally by Courier and should not be used by the 

user. 

Snapshot 

Snapshot is used to create a backup that is independent of active backup. If the 

primary goes down, and the backup is initiated, a snapshot of the backup can be 

made and used on the primary to restore it as primary. 



Create Snapshot 

NOTE: After creating the snapshot, you will need to copy it to the system where 

it will be restored. 

NOTE: If you restore a snapshot created on one server to the other server, you will 

need to update the Backup Server Name under Active Backup Configuration 

(refer to “Configuration” on page 115). 

Restore Snapshot 

NOTE: See %ARKITEX_HOME%\courier\log\scripting.log for errors. 


120 RSYNC OPTIONS 

Rsync Options 

Optional Module 

Optionally, a fourth module can be defined: [databasebak] 

• This module can define a path where database backups are configured to go. 

This is necessary only if database backups are not saved under any of the 

other modules. 

NOTE: More info on the config file format can be found at: 

http://rsync.samba.org/ftp/rsync/rsyncd.conf.html 

Setting the Port for 

rsync server 

By default the rsync server uses port 873. You can update the registry to specify 

a new port: 

[HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\RsyncServer\Parameters] 

"AppArgs"="--config rsyncd.conf --daemon --no-detach --port=new-port-number" 

Remote_sync.cmd 

Script 

The "ARKITEX_HOME\rsync\remote_sync.cmd" script is used to rsync the files to 

the backup server. The destination path is passed to the script in two different 

ways: 

• A socket destination path that includes the module name and a relative path 

from that module. 

• A full path that can be used with rsync and ssh. 

 

By default a socket path is used. The default windows configuration is to 

use rsync with sockets. This file allows the field engineer/administrator to 

modify how rsync does the transfer (ssh could be installed and used 

instead). 

NOTE: For more information on rsync (cwRsync is the windows version used) 

can be found at: 

http://www.itefix.no/phpws/index.php?module=pagemaster&PAGE_user_op=view 

_page&PAGE_id=6&MMN_position=23:23 

http://rsync.samba.org/ 



backupFiles.cfg 

The "ARKITEX_HOME\Courier\active_backup\conf\backupFiles.cfg" can be used to 

backup any other files on a timed basis that are not backed up by default. The 

default contents of this file are: 

Courier\conf 

Client\conf 


122 RSYNC OPTIONS 


CHAPTER 

11 

Active Backup for Oracle 

on UNIX 

CAUTION: All commands within this chapter should be run while logged in as 

root unless specified otherwise. 

NOTE: The UID and GID for identical users on both systems must be the same. 

Active Backup setup for Oracle on UNIX consists of installation, configuration 

and operation. Installation of Active Backup is performed when the Courier 

server is installed. This chapter will deal with configuration and operational 

issues. It will cover, in detail, how to configure both primary and standby servers. 

Operational issues include taking and restoring of snapshots, activation and 

deactivation of servers, and automated incremental backups. 

The concept of primary and standby servers references the current mode a server 

is configured for. In the examples provided in this chapter the primary and 

standby servers are named “server1” and “server2”. At some point during operation 

you may choose to fail over to the standby server. After completing a fail 

over, the mode of each server is reversed. 

This chapter contains three sections: 

Active Backup Configuration .......................................................................... 126 

Operational Procedures .................................................................................... 140 

Solaris Active Backup Troubleshooting ...................................................... 148 

Oracle 10g Data Guard Overview 

In our implementation, Data Guard operates in one of two directions: Courier1 - 

> Courier2, or Courier2 -> Courier1. 

Prerequisites 

• Data Guard environment variables must be added to ~ArkitexService/.cshrc. 

123

124 ACTIVE BACKUP FOR ORACLE ON UNIX 

• The ORADATA Data Guard environment variable must be added to ~Oracle/ 

.cshrc. 

• Overwrite the isActivated.csh script in $COURIER_HOME/bin with 

isActivated_dg.csh. 

• Edit $ARKITEX_HOME/Courier/active_backup/dbutil.properties, updating 

hostname. 

• Install Rsync. 

• Configure ssh. 

Initializing the Standby server 

1 Taking a snapshot of the Primary 

1 Stop the Courier processes. 

2 Become ArkitexService. 

3 Run the dataguard.csh script 

4 rsync snapshot to Standby server 

5 Exit ArkitexService 

6 Bring Courier processes back online 

2 Restore the snapshot on the Standby server 

a 

b 

Become ArkitexService 

Run the orarestore.csh script 

Switchover (assumes Primary and Standby are both running) 

1 Bring Courier processes offline on the Primary. 

2 Run the dataguard.csh switch. 

3 Run the dataguard.csh switch Courier2. 

4 Bring Courier processes online on the Standby. 

Failover from Primary to Standby 

NOTE: The Primary is down and Standby has been running. 


11 ACTIVE BACKUP FOR ORACLE ON UNIX 125 


2 Run the dataguard.csh script to failover. 

3 Run the dataguard.csh script to Standby. 

4 Bring Courier processes online. 

Recovering from failover - Failed Primary server becomes Standby 

1 Ensure Courier processes are offline on new Standby (Courier1). 


3 rsync snapshot to new Standby (Courier1). 

4 Run the orarestore.csh script. 


126 ACTIVE BACKUP CONFIGURATION 

Active Backup Configuration 

Data Guard is an Oracle tool to keep two database instances (a Primary and a 

Standby) transactionally aligned. Changes committed to the Primary are 

reflected in the Standby, such that the Standby is ready to use with an identical 

(or near-identical) copy of the data already in place. 

Active Backup is used to back up configuration and data files. Users with Data 

Guard should skip this section unless they wish to include configuration and 

data files in their backup schema. 

NOTE: Use for two or more machines in a configuration. 

NOTE: Active Backup for Courier requires Solaris 10 and Oracle 10G. 

Configuring ActiveBackup for Oracle on UNIX consists of several steps. 

Successful configuration requires attention to detail especially where it concerns 

file and directory permissions. The steps outlined below are expanded in this 

document. 

Configure Prerequisites 

• copy updated dbora script 

• ssh configuration 

• primary server Oracle ARCHIVELOG Mode 

CAUTION: All commands within this section should be run while logged in as 

root unless specified otherwise. 

Configure 

Prerequisites 

Copy Oracle start script from $Courier_HOME/oracle/bin/ to /etc/init.d “cp 

$ORACLE_HOME/bin/dbora /etc/init.d” 

Active Backup uses ssh and rsync to securely transfer files between servers. Rsync 

is delivered with the Courier software and ssh is included with Solaris 10. A 

script is available to install rsync. Some manual editing of configuration files is 

required. 



Ssh 

The ssh software must be configured on both servers. The public keys generated 

during installation must be exchanged between servers. Finally the configuration 

must be tested. 

To install and configure ssh and rsync you must be logged in as root. 

Prerequisites 

1 Add Data Guard variables to ~ArkitexService/.cshrc 

 

Three Data Guard environment variables must be added to ~ArkitexService/.cshrc 

DATAGUARD_BACKUP, DATAGUARD_PRIMARY and ORADATA. 

 

For example on the Courier1 machine, the following should be added: 

setenv DATAGUARD_PRIMARY Courier1 

setenv DATAGUARD_BACKUP Courier2 

setenv ORADATA u01/data/oradata 

 

and on the Courier2 machine it would: 




NOTE: The local host must be configured as the Primary (even though at times 

it can be and will be a Standby server). 

2 Add Data Guard variables to ~oracle/.cshrc 

 

Three Data Guard environment variables must be added to ~ArkitexService/.cshrc 

DATAGUARD_BACKUP, DATAGUARD_PRIMARY and ORADATA. 

 

For example on the Courier1 machine the following should be added: 






 

and on the Courier2 machine it would: 




NOTE: The local host must be configured as the Primary (even though at times 

it can be and will be a Standby server). 

3 Update the isActivated.csh script. 

Overwrite the isActivated.csh script in $COURIER_HOME/bin with isActivated_dg.csh 

using the following command: 

"cp $COURIER_HOME/bin/isActivated_dg.csh $COURIER_HOME/bin/isActivated_dg.csh" 

4 Edit dbutil.properties. 

 

Edit the file: 

$ARKITEX_HOME/Courier/active_backup/dbutil.properties 

On each system change localhost to the actual hostname. 

 

On the Courier1 machine: 

ArkitexDBUtil.DBServerName=Courier1 

And on the Courier2 machine: 

ArkitexDBUtil.DBServerName=Courier2 

5 Install Rsync. 

Rsync must be set up for the ArkitexService user. It will be installed from the 

$ARKITEX_HOME/third_party/rsync directory with the command 

"installRsync ." 

NOTE: You must include the space and period after installRsync. 

6 Configure SSH 

Ssh must be set up for the ArkitexService user. You should be able to ssh 

between the 2 sides without having to type in a password. A suitable version 

of ssh is delivered with Solaris 10. In our application we will use RSA authentication 

and exchanging public keys. The keys must be generated using 

ssh-genkey and reside in the ~ArkitexService/.ssh directory. 



First we will start by modifying the /etc/ssh/ssh_config file. These should be 

the only un-commented lines in the file. When working on the Courier2 

machine, substitute Courier1 with Courier2 in this example: 

Change permissions on the ssh_config file to –rw-r—r— (read/write for user, 

read for group and other). 

chmod 644 /usr/local/etc/ssh_config 

7 Perform the following steps in order: 

1 Create the .ssh directory. Login as the ArkitexService user, and create the 

subdirectory .ssh in that user’s home directory (/export/home/ArkitexService/.ssh). 

Set the permissions for the .ssh directory to be writeable only by 

the ArkitexService user (chmod 700 ~/.ssh). The ArkitexService home 

directory should be drwxr-xr-x. Do this on both machines. 

2 Create the rsa keys. Login as the ArkitexService user, and cd to the ~/.ssh 

directory, then run the following command. Accept the defaults by 

answering with a carriage return. This will create the id_rsa and id_rsa.pub 

files. Do this on both machines. 

ssh-keygen -t rsa 

3 Pass the public keys - As the ArkitexService user, start an FTP session from 

the .ssh directory. Change the directory to .ssh (cd .ssh), and run the 

following commands: 

put id_rsa.pub authorized_keys 

get id_rsa.pub authorized_keys 

4 Change the group on authorized_keys - The authorized_keys file must be 

readable by the dba group. As the root user, issue the following 

command: chown ArkitexService:dba authorized_keys 



5 Change permission on authorized_keys (very important). The 

authorized_keys must be writeable only by the ArkitexService user, and 

readable by the dba group. Use the following command to change permissions 

on authorized_keys: chmod 640 authorized_keys 

6 Restart SSHD. 

NOTE: Alternative to reboot is to launch the sshd daemon. Do this by typing: 

/etc/init.d/sshd start 

Up until now you have been operating as the root user. The installation of 

ssh was performed by root for user ArkitexService. You will need to su to the 

ArkitexService user to test the configuration. Type: 

su - ArkitexService 

Test the interface by logging into the other server. On the command line 

run the ssh command in verbose mode with the other server name. The 

first time you do this you will be asked if you want to continue connecting. 

Answer “yes”. This will add the other server to your known_hosts file. 

Type: 

ssh –v server2 

The first time you will see: 

The authentication host ‘server2 (10.237.50.214)’ cannot be established. 

RSA key fingerprint is 0a:7f:8f:df:89:c7:57:90:d9:fa:22:4d:35:d9:68:b8. 

Are you sure you want to continue connecting (yes/no)? 

Answer: 

yes 

Perform the same test from server2. 

NOTE: Some sites may have implemented additional security measures 

that include limiting use of specific ports or denying access. Refer to the 

Troubleshooting section at the end of this chapter for specific examples. 

Now that the test has succeeded, you may exit the ArkitexService user. 

Type as in the previous example: 

exit 



7 Test the interface by running the ssh command to the other machine. 

Answer 'yes' when prompted (this will only happen the first time you try 

to connect). 

Run dg_prereqs.ksh script 

You will need to run the dg_prereqs.ksh script to prepare oracle for Data Guard. 

This script will turn on the archive log mode, add Data Guard initialization 

parameters to the spfile, and create an oracle net services file (tnsnames.ora). The 

script will also start and stop the database, so oracle and all dependent resources 

must be brought down before running the script (i.e., Courier software). 

NOTE: This script and all Data Guard scripts must be run as the oracle user. 

Run the following script on the PRIMARY ONLY. 

$COURIER_HOME/oracle/bin/dg_prereqs.ksh 

NOTE: Answer yes when asked if you would like to generate a new tnsnames.ora 

file 

After running the dg_prereqs.ksh on Primary, copy the $ORACLE_HOME/network/ 

admin/tnsnames.ora to the Standby server. 

Initializing the Standby Server 

Use this procedure to initialize Courier2 as the Standby server during the initial 

Data Guard setup, or after it has been off-line for a while, and it no longer has an 

up-to-date database. 

1 Taking a Snapshot of the Primary (Courier1) and Rsyncing to the Standby 

Server (Courier2) 

NOTE: All commands in this section will be run on the Primary server. 

1 Login as root and stop all the processes that require Oracle: Courier, 

JBoss, and Tomcat. 

/etc/init.d/tomcat.sh stop 

/etc/init.d/courier.sh stop 

/etc/init.d/jboss.sh stop 



2 Switch user to ArkitexService. 


3 Create a snapshot on Courier1. 

su oracle -c '/u01/app/arkitex/Courier/active_backup/bin/dataguard.csh backup \\ 

/u01/data/oradata/snapshots/backup_MMDDYY' 

(where MM=month DD=day YY=year) 

When prompted, enter the password for the oracle user. 

4 Rsync the snapshot to Courier2 

The following command must be entered on a single line. 

rsync -avrz /u01/data/oradata/snapshots/backup_MMDDYY Courier2:/u01/data/ 

oradata/snapshots 

example: 

rsync -arvz /u01/data/oradata/snapshots/backup_040206 

Courier2:/u01/data/oradata/snapshots 

5 Exit the ArkitexService session (returning to 'root'). 

exit 

6 Bring Courier processes back online. 

/etc/init.d/tomcat.sh start 

/etc/init.d/courier.sh start 

/etc/init.d/jboss.sh start 

2 Restore the Snapshot on the Standby Server (Courier2) in Standby Mode 

1 Open a terminal or telnet session to both servers and tail the oracle alert 

log to monitor restore progress. 

From a command prompt use the following command: 

"tail u01/app/oracle/admin/arkitex/bdump/alert_arkitex.log" 

2 Become ArkitexService 


3 Run orarestore.csh script from the Standby Server (Courier2) 

cd /u01/data/oradata/snapshots/backup_MMDDYY 

su oracle -c 'orarestore.ksh -s . -d STANDBY -v -l restore.log' 




NOTE: You will see message that says command completed successfully. 

4 Verify that Data Guard is working properly by doing a logswitch on the 

Primary (Courier1). 

You can monitor this by tailing the oracle alert logs on both servers. To tail 

the logs, open a terminal or telnet session to both servers, and run the 

following command: 

"tail /u01/app/oracle/admin/arkitex/bdump/alert_arkitex.log" 

NOTE: The path to the Oracle Alert Log may be different depending on the 

Oracle installation and database configuration. 

Next, run the command to force a logswitch: 

su - oracle -c '/u01/app/arkitex/Courier/oracle/bin/dg_util.ksh -a LOGSWITCH -v' 

NOTE: The command output will display “Dataguard operation completed 

successfully” if it completes without errors. 

After you run the command, the log should show the redo log changing 

on the Primary and subsequently on the Standby. If the log switch is 

successful, you will see a message similar to the following in the 

alert_arkitex.log on the standby server: 

Media Recovery Log /u01/data/oradata/flash_recovery_area/Courier1/archivelog/ 

2007_02_26/o1_mf_1_47_2y6zsg33_.arc 

NOTE: You can substitute IP addresses for the host and hostname if necessary. 

Rsync 

The rsync package provides fast incremental file transfer. The required packages 

for rsync installation are contained in the Courier software located in 

$ARKITEX_HOME/third_party/rsync. Simply run the installRsync script by typing: 

InstallRsync . 

Make sure to include the (.); it specifies the current location. 

Now reboot the machine so the changes take effect. 



Do this on both servers. 

Here you must be the ArkitexService user to perform the test. 

Test the configuration by transferring a file between servers. In the following 

example the file testfile can be any file in your current directory (on server1). The 

options avr perform the function in verbose mode and recursively. Type: 

rsync –av “testfile” server2:/tmp 

This command will transfer the file testfile to the directory /tmp on server2. 

Try the test from server2. 

Active Backup 

Initialization 

(Courier1 Primary / 

Courier2 Standby) 

It is important to always be working with an initialized version of the database; 

this is not something that has to happen often, but it is important for Data Guard 

to start off knowing which database is Primary and which is a Standby. 

Following the initialization procedure ensures that the two states (Primary and 

Standby) are represented. 

In all of the examples used to illustrate the procedures here, "Courier1" is 

assumed to be Primary and "Courier2" is assumed to be Standby. 

Failovers require initializing the failed Primary as a new Standby, as the old 

database will be incompatible. 

Use this procedure to initialize Courier2 as the Standby server during the initial 

Data Guard setup, or after it has been off-line for a while, and it no longer has an 

up-to-date database. 

As an example, we will work with two Solaris machines named Courier1 and 

Courier2 with Courier1 as the primary. 

Courier1 - Primary Server 

1 Disconnect All Clients from Courier 

1 Use Courier Client > Tools > View Clients. 

2 Select Disconnect All. 

2 Check that the Subsystems, Courier Engine, and Tomcat are stopped. 

Telnet to Courier1 

su - (passwords is agfa) 



cd /etc/init.d 

./courier.sh stop 

./jboss.sh stop 

*Wait 30 seconds before running the next script. 

./tomcat.sh stop 

ps -ef | grep java 

Check that tomcat, engine and subsystems have stopped 

ps -ef | grep rsync Check that no rsync processes are running. If any are running 

please wait up to 10 minutes for them to stop. If they are not stopped after waiting 10 

minutes, use kill -9 to stop. 

exit (to return to ArkitexService logon) 

3 Create a Snapshot on Courier1. 

su oracle -c '/u01/app/arkitex/Courier/active_backup/bin/dataguard.csh \\ backup /u01/ 

data/oradata/snapshots/backup_MMDDYY' 


password is "oracle" 

4 Rsync the snapshot to Courier2. 

rsync -avrz /u01/data/oradata/snapshots/backup_MMDDYY \\ 


example: 

rsync -arvz /u01/data/oradata/snapshots/backup_040206 \\ 


Courier2 - Standby Server 

5 Restore the snapshot on Courier2. 

1 Telnet to Courier2 (login as ArkitexService) 


"tail /u01/app/oracle/admin/courier1/bdump/alert_arkitex.log" 



"tail /u01/app/oracle/admin/courier1/bdump/alert_arkitex.log" 





NOTE: Replace MMDDYY with the date as used in the snapshot creation 

procedure above. 

Run orarestore.csh script 



NOTE: You will see a message that says command completed successfully. 

6 Verify that Data Guard is working properly by doing a logswitch on the 

Primary (Courier1). 

NOTE: You can monitor the status of the log switch by watching the two alert 

log tails you started in the last step. 

1 Next, run the command to force a logswitch: 


NOTE: The output will either display "ERROR" if it fails or "VALID" if it succeeds. 

NOTE: After you run the command, the log should show the redo log changing on 

the Primary and, subsequently, on the Standby. 

Configure Active Backup 

Now two servers are set, and we want to activate the client to Courier1 and 

configure the balance of Active Backup. 

7 Check Active Backup Configuration on Courier1 

1 Connect to the Client as a user with Configuration permission. 

2 Go to Tools > Configuration > System > ActiveBackup > Oracle. 

3 Make sure the settings are as shown below. 



Data Guard 

Configuration 

In the client you must configure Courier Active Backup using Tools > Configuration 

> System > Active Backup > Oracle. 

Data Guard - Must be checked on to enable the Active Backup configuration. 

Choose the Start Time and Frequency of this timed backup. The data guard 

timed backup will force oracle to do a log switch, which causes all the transactions 

up to that point (since the last logswitch) to be sent to the Standby 

database. This is a fairly inexpensive process as far as affecting the performance 

of the system goes, and can be done as often as every 5 minutes. During this 

timed backup, the file storage and softproof locations are rsync’d to the Standby. 

The status of the Standby database is also checked during this timed backup, an 

error is logged if the connection to the Standby is in error, or if there are more 

than 10 unapplied archive logs on the Standby. If there are more than 5 

unapplied logs on the Standby, a warning is logged. These thresholds are configurable 

(to do: document configuring thresholds). 

Purge Restored Backups - This timed backup will do an rman delete of the 

archived logs on both the Primary and Standby databases. All archived logs that 

have been applied on the Standby (minus 50) are purged. This will keep the 

oracle flash recovery area from filling up. This should not be done more often 

then daily. 

• Database Server Name - Use localhost 

• Sys Password 

• Backup Server Name 



• Backup Database Path - This path will be used for the log files of the 2 timed 

backups 

• Engine home path - arkitex home 

• Client home path - arkitex home 

• Error log path - Not used, but needs to have a value 

• Backup Data Files - When checked, turns on data file backup/synchronization 

to the Standby. This happens during the Data Guard timed backup for 

the file storage and softproof locations, and during real-time file processing 

for page files and plans. 

backupFiles.cfg 

The $ARKITEX_HOME/Courier/active_backup/conf/backupFiles.cfg can be used to 

backup any other files on a timed basis that are not backed up by default. The 

default contents of this file are: 

Paths 

Courier\conf 

Client\conf 

Paths are relative from the Engine Home Path, or the Client Home Path set up 

in System Configuration. If there is no such file under the Engine Home Path, 

the Client Home Path is used. 

1 Verify the Active Backup Operation. 

NOTE: You can monitor the status of the log switch by watching the two alert 

log tails you started in the "Restore the Snapshot" step above. 

2 Verify that Data Guard is working properly by doing a logswitch on 

Courier1. 

Telnet to Courier1 


NOTE: The output will either display "ERROR" if it fails, or "VALID" if it succeeds. 



NOTE: After you run the command, the log should show the redo log changing on 

the Primary and subsequently on the Standby. 


140 OPERATIONAL PROCEDURES 

Operational Procedures 

NOTE: All operation procedures in this section should be done after logging into 

CDE as ArkitexService. 

This section discusses the procedures required to setup the primary and standby 

servers for Active Backup processing. You will deactivate the standby server, 

create and restore a snapshot of the primary server, and configure a cron job to 

apply backups to the standby server. 

Active Backup 

Failover procedure 

(Failover from 

Courier1 to 

Courier2) 

This procedure is only used if the Primary server is down and you want to 

promote the Standby server to Primary. We assume that the Standby has been 

successfully running as Standby. The Primary server should not be ping-able. If 

you are just testing the failover procedure, both the Courier and Oracle software 

must be stopped on the Primary server. 

NOTE: If running a failover test from Courier1 to Courier2, force a log switch on 

the Primary after having stopped the courier software. This will prevent any data 

loss. 

Switchover 

Switchover is only used to switch server roles. This is not an alternative to failing 

over. Both sides must be up and Data Guard must have been running for either 

side to be able to be in Primary or Standby roles. 

Switching from Courier1 as Primary to Courier2 as Primary 

This procedure assumes that Courier1 starts as being the Primary, and Courier2 

is the Standby. 

1 As the root user, bring Courier processes offline on the Primary (Courier1) 




2 Run the dataguard.csh switch on Primary (Courier1) 

su oracle -c '/u01/app/arkitex/Courier/active_backup/bin/dataguard.csh switch' 



When the command completes, you should see the following message: 

Dataguard operation completed successfully. 

3 Run the dataguard.csh switch with "server" parameter on the Standby Server 

(Courier2) 

When running the following command, replace "Courier1" with the name of 

your new standby server. 

su oracle -c '/u01/app/arkitex/Courier/active_backup/bin/dataguard.csh switch Courier1' 

When the command completes, you should see the following message: 

Dataguard operation completed successfully. 

4 Bring Courier processes online on the new Primary (Courier2) 




Switching from Courier2 as Primary to Courier1 as Primary 

This procedures assumes that Courier2 starts as being the Primary, and Courier1 

is the Standby. 

1 As the root user, bring Courier processes offline on the Primary (Courier2) 




2 Run the dataguard.csh switch on Primary (Courier2) 


3 Run the dataguard.csh switch with "server" parameter (Courier1) 


4 Bring Courier processes online on the New Primary (Courier1) 






Failover from 

Courier1 to 

Courier2 

This procedure is only used if the Primary server is down and you want to 

promote the Standby server to Primary. We assume that the Standby has been 

successfully running as Standby. The Primary server should not be ping-able. If 

you are just testing the failover procedure, both the Courier and Oracle software 

must be stopped on the Primary server. 

NOTE: If running a failover test from Courier1 to Courier2, force a log switch on 

the Primary after having stopped the courier software. This will prevent any data 

loss. 

1 Force log switch on Primary (Courier1) (assumes primary server is running). 

telnet Courier1 


su oracle -c '/u01/app/arkitex/Courier/oracle/bin/dg_util.ksh -a LOGSWITCH' 

(System should report "log switch succeeded") 

2 Telnet to Courier2. 

3 Become ArkitexService 


4 Make Courier2 the Primary Server 

su - oracle -c '/u01/app/arkitex/Courier/active_backup/bin/dataguard.csh failover' 

When prompted enter the password for oracle 

NOTE: The last line of output should say "Data Guard operation completed 

successfully." 

5 Create snapshot on New Primary (Courier2) 

su - oracle -c '/u01/app/arkitex/Courier/active_backup/bin/dataguard.csh backup \\ / 

u01/data/oradata/snapshots/backup_MMDDYY' 


When prompted enter the password for oracle 

6 Bring Courier processes back online. 






Recovering from 

Failover 

After any problems have been fixed on the original Primary (Courier1), and it 

has been restored to its pre-failure state, we will restore it to the Primary role. 

This will entail retrieving the most current snapshot from Courier2, restoring it 

on Courier1 and then changing Primary / Standby roles. 

1 Stop the Courier, Jboss, and Tomcat processes on Courier1 




2 Switch User to ArkitexService 


3 Rsync the snapshot from the current Primary (Courier2) 

NOTE: The following command must be entered on a single line. 

rsync -avrz Courier2:/u01/data/oradata/snapshots/backup_MMDDYY 

/u01/data/oradata/snapshots 

NOTE: MMDDYY should be the same as date as used in the failover backup 

creation procedure above. 

4 Restore the database on Courier1. 



When prompted, enter the password for oracle. 

NOTE: You should see message that says command completed successfully. 

5 On Courier2 force a log switch using dg_util.ksh. This will ensure that Data 

Guard is syncing the redo logs. As detailed in an earlier section you can 

monitor this activity by tailing the alert_arkitex.log. 

telnet Courier2 (as root) 




NOTE: The output will either display "ERROR" if it fails or "VALID" if it 

succeeds. If you get an error, run the logswitch command multiple times, 

until it reports "VALID". 

6 Bring Courier processes offline on Courier2 (step 8 will perform the 

switchover) 




7 Run dataguard.csh switch on Courier2 to make it the Standby. 




8 Run the switch command on Courier1 to make it the Primary and specify 

Courier2 as Standby server. 



NOTE: System should say "Data Guard operation completed successfully." 

In the command above, Courier2 is specified as the Standby parameter. 

9 Bring Courier processes online on the new Primary server (Courier1) 




10 Check the Active Backup configuration on Courier1. 

Refer to the "Data Guard Configuration" section. 

Making a Snapshot 

of the Database 

This procedure should be run when there are configuration changes to ensure 

that we have a good database backup on the Primary and Standby servers. 

1 Create a database snapshot on the Primary server. 

su oracle -c '/u01/app/arkitex/Courier/active_backup/bin/dataguard.csh backup \\ 

/u01/data/oradata/snapshots/backup_MMDDYY' 





2 Rsync the snapshot to the Standby server (Courier2). On Courier1 run this 

command: 

NOTE: The following command must be entered on a single line. 

rsync -avrz /u01/data/oradata/snapshots/backup_MMDDYY Courier2:/u01/data/oradata/ 

snapshots 

example: 

rsync -arvz /u01/data/oradata/snapshots/backup_040206 Courier2:/u01/data/oradata/ 

snapshots 

NOTE: MMDDYY should be the same as date as used in the backup creation 

procedure. 

Reference 

• Log Files 

Scripting Subsystem log: 

$COURIER_HOME/log/Scripting.log 

will have logging of the timed backup jobs. 

• File Subsystem log: 

$COURIER_HOME/log/File.log 

will have logging for the realtime rsync of page and plan files. 

• Data guard and Purge Restored logs 

There is one log for the data guard backup jobs and one log for the purge 

restored jobs in the directory configured for database backups (see Courier 

System Configuration above). 

Restoring Database Snapshot as Primary 

1 Restore the database on Courier1. 


su oracle -c 'orarestore.ksh -s . -d PRIMARY -v -l restore.log' 




NOTE: You will see message that says command completed successfully. 

Command Line Utilities 

Determine Database Role 

select DATABASE_ROLE from v$database; 

$COURIER_HOME/active_backup/bin/dataguard.csh 

Description: Main Data Guard script. Must be run as oracle user. 

usage: 

dataguard.csh backup|switch|failoverparameters [backupDir] | [backupServer] 

backup - creates database backup 

switch - switch roles (Primary -> Standby or Standby -> Primary) 

failover - failover a Standby server to Primary 

parameters - prints out the parameters to be used after reading the properties 

file 

backupDir - required with backup action 

backupServer - optional with switch option, should be supplied when switching 

Standby to Primary, must be the name of the new Standby server. If not supplied 

the active backup configuration in Courier is disabled. 

$COURIER_HOME/oracle/bin/dg_util.ksh 

Description: This script is primarily used internally by Courier, but it is also 

useful for testing an Oracle Data Guard setup outside of Courier. 

Running the following command on the Primary will force a log to be archived 

and sent to the Standby server. 


It will also check the status of the connection between the Primary and 

Standby. If the connection is VALID then the logswitch operation is considered 

successful, if the status is ERROR then the associated error message is 

printed out. 

• Running the following on the Primary will connect to the Standby server 

(Courier2) and find out how many logs it has received which have not been 

applied yet. 



/u01/app/arkitex/Courier/oracle/bin/dg_util.ksh -a STATUS -c sys -s Courier2 -v 

Command to determine how much free space in Flash Recovery Area 

su - oracle -c '/u01/app/arkitex/Courier/oracle/bin/flash_recovery_free_space.ksh' 

Sample command Output: 

Sun Microsystems Inc. SunOS 5.10 Generic January 2005 

1.3457E+10 

Freespace: 1.3457E+10 

Which equals 13.45 GB out of 20 GB. 

Password File 

$ORACLE_HOME/dbs/orapwarkitex must be same on both machines. 

Oracle Initialization Parameters 

Make sure that the local_listener parameter is not set in Oracle. To check, run 

sqlplus as the oracle user from the command line, and login as "sys as sysdba". 

Use the following query: "show parameter;" and look for the local_listener 

parameter. 


148 SOLARIS ACTIVE BACKUP TROUBLESHOOTING 

Solaris Active Backup Troubleshooting 

Solaris Active Backup Troubleshooting is discussed in the following topics: 

• “SSH Not Connecting” on page 148 

• “Files Not Synchronized Between Primary/Standby Servers” on page 148 

• “Oracle Backups Not Completing” on page 149 

• “Backup/Data Synchronization Problems” on page 149 

• “Activating Standby Server Fails” on page 151 

• “Command Line Status Check” on page 153 

SSH Not 

Connecting 

Check permissions on ~/ArkitexService/.ssh/authorized_keys. Make sure the 

owner is ArkitexService, the group is set to dba, and the permissions are set to 

644. Also view the file and verify that it lists the user and server you are 

connecting from at the end of the file. 

Make sure sshd is running at startup. Type "ps -ef |grep sshd". If it is not running, 

you can start it with the following command "/etc/init.d/sshd start". You can also 

start it in debug mode by using the -d option. Also try specifying "ssh -v servername" 

to run ssh in verbose mode when connecting your other server. 

NOTE: If you are controlling network access to your system using /etc/hosts.deny, 

be sure to add an entry in /etc/hosts.allow for sshd. 

Files Not 

Synchronized 

Between Primary/ 

Standby Servers 

The following describes how file synchronization works in Courier 4.0. 

When Backup Data Files is selected, the following synchronization occurs: 

• All new data files that are submitted to the primary server are immediately 

synchronized to the standby, regardless of backup schedules. 

• Files purged from the primary server will be synchronized immediately. If 

files are manually deleted from the server without using the Courier purge 

function, they will not be synchronized until the next scheduled Log or Hot 

backup. 



• ClientSoftProof files are only synchronized during scheduled Log or Hot 

backups. 

Oracle Backups Not 

Completing 

The following describes what to do when Oracle backups are not completing. 

Hot Backups do not appear to run 

NOTE: If you schedule hot backups to run at a time earlier than the current time, 

the backup jobs will not run until the following day at the scheduled time. 

1 You can check the next scheduled Hot backup time by using the SQL 

scratchpad, which can be started from the oemapp console. 

2 In the scratchpad, type the following query (without quotes), and press 

execute: "select * from arkitexservice.parameters". 

3 Look for the ORACLE_HOT_BACKUP_CHECK_TIME parameter name, and 

you will see the see a date and time in the VALUEDATE column. This time 

will be earlier than the runtime you configured by the amount of time specified 

by the frequency you set for the task. 

4 You can also use this query to check the status of other scheduled events. The 

query above assumes you have logged in as "sys as sysdba". 

Backup/Data 

Synchronization 

Problems 

Check the following items on the primary server: 

• Scripting.log 

View the $ARKITEX_HOME/Courier/log/Scripting.log, and look for errors. This 

log shows all the scripting subsystem activity, which includes active backup 

actions. If you see errors in this log pertaining to a specific Hot backup or 

Archive Log sequence, you can view the associated log file located in the 

error log path you specified in the active backup configuration. If it appears 

that the backups are being created, but you find errors regarding rsyncing files 

between the primary and standby server, you will need to determine whether 

ssh and rsync are working properly. Refer to the ssh and rsync setup sections 

for more information. 

• Backup directory contents 

Within the backup directory, you will find the file .backupInfo which indicates 

the latest Oracle Log archive sequence or Hot backup sequence completed. 

This file is created on the primary server and rsync’d to the standby server to 



indicate the latest backup completed so the standby server knows which 

backups to restore. 

Also within the backup directory, the .standbyInfo file contains information 

from the standby server indicating which hot backup or Archive Log 

sequence has been restored to the standby server. This file is rsync’d to the 

primary server when the "Purge Restored Backups" job runs according to the 

schedule you set. Info from the .standbyInfo file is used by the primary server 

to determine which backups have been restored to the standby and can now 

be deleted. 

Look in the backup directory you specified when active backup was setup. 

You should see directories containing log archives and hot backups. Within 

each of the Log archive and Hot backup directories is a directory called logs, 

containing the file backup.log. This log details the status of each Hot backup 

or Archive Log sequence on the primary server. 

Check the following on the Secondary server: 

• Backup directory contents 

You should see directories in the backup directory containing log archives 

and hot backups. The contents should be similar to the backup directory 

located on the primary server. The backup interval you specified during 

active backup configuration will determine how closely the backup directory 

contents will match between servers. 

• Restore Log 

If it appears that the Oracle backups are completing without errors and being 

rsync’d to the standby server, there may be a problem with restoring of 

backups on the standby server. View the $ARKITEX_HOME/Courier/ 

active_backup/logs/cron_restore.log. This log file details all Hot backup and 

Archive Log restores done on the standby server. Also, make sure that the 

cron_restore.log is owned by oracle:dba. 

• Data Files 

Data files and softproofs should be synchronized to directories on the 

standby server identical to those specified on the folders tab in the system 

configuration page. Compare the contents of the directories and subdirectories 

specified in your system configuration for File Storage and Client Soft 

Proof between your primary server and standby server. They should contain 

the same or nearly the same contents depending on your Active Backup 

schedule frequency. 



Activating Standby 

Server Fails 

When activating the standby server, you will see messages from the backup 

utility displayed in the console window from which you ran the backup utility or 

activation script. The messages provide information useful to troubleshooting 

activation problems. 

If you see errors indicating that a particular Archive Log or Hot backup is bad, 

you will need to follow one of the procedures below before attempting to 

activate the standby again. The procedure you follow will depend on the error 

you see when you attempted to activate. 

Error occurred restoring standby backup: LOG_ARCHIVE_nn 

Option 1 

1 Identify the bad Oracle Archive Log file from the activation error message. 

Look at the restore.log file located in $COURIER_HOME/active_backup/ 

backup/LOG_ARCHIVE_nn/logs/, where LOG_ARCHIVE_nn is the name of the 

directory specified in the original activation error. 

You will find an error in this log identifying the Archive Log file that could 

not be restored. 

2 Copy the Archive Log file from the backup directory on the primary server to 

the backup directory on the standby server. 

3 Activate the standby server again. If activation fails again, you will need to 

follow the instructions under option 2. 

Option 2 

1 Identify the bad Oracle Archive Log file from the activation error message. 

Look at the restore.log file located in $COURIER_HOME/active_backup/backup/ 

LOG_ARCHIVE_nn/logs/, where LOG_ARCHIVE_nn is the name of the directory 

specified in the original activation error. You will find an error in this log 

identifying the Archive Log file that could not be restored. 

2 Once you have identified the bad Archive Log, delete it and all subsequent 

Archive Log files from the $COURIER_HOME/active_backup/backup/ 

LOG_ARCHIVE_nn/ directory. 

3 Delete the bad Archive Log file and all subsequent Archive Log files from the 

Oracle Archive Log directory. This should be $ORACLE_HOME/dbs/arch by 

default, but you can verify the location with the command "archive log list" in 

sqlplus. 



4 Delete all the Archive Log directories in the $COURIER_HOME/active_backup/ 

backup/ directory with numbers higher than the one which contained the bad 

archive log file. 

5 Activate the standby server again. 

Bad Archive Log Example 

For example, if you try to activate the standby server and get an error indicating 

a problem restoring LOG_ARCHIVE_1336, you will need to look at the restore.log in 

the logs directory of the failed backup "LOG_ARCHIVE_1336". Assuming an error 

in the restore.log states that it could not open the Archive Log file 

arch_1_3006.arc, and the backup directory contains the following: 

LOG_ARCHIVE_1331 


HOT_1333 

HOT_1334 





and the Archive Log location contains the following logs: 

arch_1_3003.arc 






You will need to do the following: 

1 Delete logs: arch_1_3006.arc, arch_1_3007.arc, arch_1_3008.arc from the 

Archive Log directory. 



2 Delete all database backups with a sequence number greater than 

LOG_ARCHIVE_1336 from the backup directory. 

3 Delete arch_1_3006.arc and all archived logs with a sequence number greater 

then 3006 from the LOG_ARCHIVE_1336 directory. 

4 Activate server. 

If the problem is an Archive Log gap (in the example, if you had the 

arch_1_3006.arc missing), the procedure would be the same. Treat the first 

missing log file as the bad log, and delete everything after it. 

Error occurred restoring standby backup: HOT_nn 

If the error is with a bad data file (i.e., ARKITEX.dbf), you have two options: 

Option 1 

1 Copy the bad data file from the backup directory on the primary server to the 

backup directory on the standby server. 

2 Activate the standby server again. If activation fails again, you will need to 

follow the instructions under option 2. 

Option 2 

1 Delete all backups made after the last good hot backup. 

2 After you delete the backups, you must edit the .standbyInfo file, and change 

the last_restored_sequence number to the number of the last good Hot backup 

minus 1. Now activate the standby server. 

3 In the case where no other Hot backup exists, you must restore the last 

database snapshot you took, and be sure to restore it as the primary. 

Command Line 

Status Check 

For Active Backup operations run from the command line, you can use the 

command “echo $status” after the command completes. The command should 

return “0” if the command was successful. 

Troubleshooting 

• Oracle 

Oracle must always be started up using the same spfile. An spfile contains a 

binary representation of the configuration parameters Oracle requires. The 

human readable form is called a pfile. Pfiles can be generated from spfiles 



and vs. versa. The pfile name created during a snapshot and restore is 

tempinitarkitex.ora. The spfile is named spfilearkitex.ora. They both live in 

$ORACLE_HOME/dbs. 

NOTE: $ORACLE_HOME/network/admin/listener.ora must be configured with 

the correct global_db_name and host values. Both should be set to the 

machine name (Courier1 or Courier2), for example on Courier1 the file 

would look like this: 


CHAPTER 

12 

Alert Listener Utility 

Application 

This chapter discusses configuring the Alert Utility. 

Alert Listener Utility ........................................................................................... 156 

155

156 ALERT LISTENER UTILITY 

Alert Listener Utility 

The Alert Listener Utility is used to configure a PC to listen for a message sent 

from the Courier server that an event has occurred and an alert sound should be 

played. 

Configure Alerts is used to select the event where the RunAlertScript will 

execute and when the alert no longer needs to be played. 

Installation instructions 

Configure the utility on the PC that will listen for messages from the Courier 

Server. 

1 Copy the entire contents of alerts_util (including sub-folders) to the root 

folder (i.e., C:\) of the Client PC. 

2 Install the Java JRE plug-in if not already installed (this can be found on 

Courier under $ARKITEX_HOME\Client\downloads. 

3 Modify the wrapper.conf file, if necessary. 

a 

b 

Navigate to the alerts_util\install\conf folder, e.g., 

C:\alerts_util\install\conf. 

Open the wrapper.conf file with a text editor, e.g., Notepad. 


12 ALERT LISTENER UTILITY APPLICATION 157 

c 

Modify the following line so that it points to the location of the Java 

application. 

Example, if the java application is in "C:\jre1.5.0_06\", change the following 

line: 

From: wrapper.java.command=C:\Program Files\Java\jre1.5.0_06\bin\java 

To: wrapper.java.command=C:\jre1.5.0_06\bin\java 

d 

Save the file. 

5 Install the service. 

a 

b 

c 

d 

Open a command prompt window. 

Navigate to the alerts_util\install\bin folder, i.e., C:\alerts_util\install\bin. 

Type the command InstallAlertsService.bat. 

If successful, the following line will be seen: 

wrapper | Alerts Listener installed 

5 Start the service: 

net start "alerts listener" 

6 Launch the Alerts Listener UI: 

RunListenerUI.cmd 

7 Verify/modify the settings. 

a 

b 

c 

d 

e 

Select the Options tab. 

Verify the port is 18182. This parameter must match the value used in the 

Courier script that sends the alert. 

Verify/set the delay between sounds in milliseconds (1000=1 second, the 

default. 10 seconds{10000] would be better) 

Click Browse next to Sound Path, and navigate to the location that holds 

the sound files you wish to use ("C:\Winnt\Media" is the default location 

for an XP system). 

Click Browse next to Default Sound, and select the 'wav' file that you 

wish to use as the default. 

NOTE: A different wav file can be specified as part of the alerts set up so that 

different alerts can have different sounds. 

f 

Click on Test to verify the sound works. 


158 ALERT LISTENER UTILITY 

g 

Click Save to save the settings. 

8 Set up Courier, and test from Courier. 


CHAPTER 

13 Enhancements 

This chapter Hot Fix 6.0 enhancements to Courier. 

Version Soft Proof ............................................................................................... 160 

Cleanse Input Filenames of Rejected Characters ................................... 162 

System Messages in System Error Log ....................................................... 162 

159

160 VERSION SOFT PROOF 

Version Soft Proof 

Version Soft Proof is used to selectively view the soft proofs of all versions of a 

page that have been received so that a decision can be made whether to revert to 

a previous version. 

If more than one version of a page has been submitted to the system, right 

clicking on the page enables the user to select Version Soft Proof. Once selected 

the system will display the soft proof window, and allow the user to view all soft 

proof versions of the page by selecting them from the drop-down list. 

This will cause all soft proofs generated prior to the installation of Hot Fix 6.0 to 

no longer be viewable unless a provided separate script is run to rename the 

previously generated soft proofs. 


13 ENHANCEMENTS 161 

set_softproof_versions.vbs 

A script has been provided with this installation that will add the current version 

number information to the relevant soft proof names, so that these soft proofs 

can be viewed with the updated Client. 

After installing Hot Fix 6, you will find a script called set_softproof_versions.vbs 

located in the \Arkitex\Updaters directory. From a command prompt window, 

change directories to \Arkitex\Updaters. From the command prompt type the 

following command followed by the ENTER key. 

cscript //nologo set_softproof_versions.vbs 

The script will first find the location of the soft proof files from the system configuration 

and then, using the Courier database, it will determine from the files it 

has received which ones need to be renamed. It will rename only those that do 

not already have a version number. 

A log file, softproofnames.txt, will be generated showing which files have been 

modified. 

By default the login used to access the database is: 

User: ArkitexService 

Password: ArkitexService 

If a different user/password is required, these should be modified in lines 32 & 

33 of this script before running this script. 

To prevent access errors, this script should only be run on the system where 

Courier is installed. 

This script is only required to be run once on the active server in an Active 

Backup configuration as the changes will propagate to the other server if 

datafiles are being synchronized. 

CAUTION: Once this script has been run, the soft proofs will have been renamed, 

and if there is a rollback to the previous version of Courier, you will no longer be 

able to view these soft proofs unless you resubmit the pages to the system. 


162 CLEANSE INPUT FILENAMES OF REJECTED CHARACTERS 

Cleanse Input Filenames of Rejected Characters 

In some cases Filename characters allowed by the originating OS may cause a 

file to be rejected by Courier because those characters may not be valid by the 

Courier Host OS. Courier can now replace those characters with an underscore 

allowing the file to be processed. 

To activate filename filtering, add the following property to the 

subsystem.properties file on the server followed by a regular expression describing 

the characters to be removed from an incoming file name: 

input.filenameBadCharacters = 

For example: 

input.filenameBadCharacters = [!:] 

In the above example, if any exclamation mark or a colon character are present 

in a filename, they will be replaced with an underscore character. No other 

characters would be altered. 

System Messages in System Error Log 

The Administrator can control which system messages show up in the System 

Error log in the Client. A Java applet on the server allows the Administrator to 

choose from a list of system messages to show in the Client Error log messages 

window. 

To configure which Error Events will appear, you must use the Error Events Java 

applet located on the server. If you use explore and navigate to the \Arkitex\Error- 

EventsUpdate folder ,and double-click on ErrorEventUpdaterW.exe. A dialog will 

pop up asking for the username and password to access the database. You can 


13 ENHANCEMENTS 163 

use username ArkitexService and password to enable the program access to 

update the Arkitex database. 

Once logged in, a window will appear that will let you select which events will 

appear in the Client Error log. 

Enable the Events to be shown by clicking in the check box to the right of the 

Event in the ‘Show Error Indicator Column. Click ok after you have made your 

choices to save the changes. Any new Events that were selected will show in the 

Client Error log. 


164 SYSTEM MESSAGES IN SYSTEM ERROR LOG 


Index 

A 

activation 116 

active backup tab 81 

Alert Listener Utility 156 

Alternate Delivery Path 38 

Apply Renaming Rule 44, 

59 

Approval 66 

Approval From Soft Proof 

Only 88 

ArkitexAdmin 31 

authentication 26, 29, 30 

Automatically purge 

unplanned files older 

than 61 

B 

Backup Data Files 85 

Backup Database Path 84 

Backup Server Name 84 

Backup Types 83 

backupFiles.cfg 112, 121, 

138 

batch files 118 

C 

Client Home Path 84 

command buttons 22 

configuration 24, 30, 33, 

34, 35, 46, 48, 51, 62, 66, 

68, 73, 74, 76, 81, 82, 89, 

108, 110, 112, 113, 114, 

115, 116, 117, 118, 120, 

126, 138 

configuration toolbar 46, 

51, 62, 73, 74, 89, 108, 

110 

Copy From Primary 45 

D 

Database Server Name 84 

Destination Group 60 

destination groups 47, 48 

destinations 33, 35, 36, 37, 

48, 49, 50, 60, 92, 110 

Destinations List Box 35 

destinations list box 35 

Director Tab 44 

disable caching 17 

Disable Copy And Paste 88 

disable destination 37 

Disable Input Point 55 

Duplicate Version 

Handling 60 

E 

Edit Tree 69 

Enable Courier Express 59 

Enable Director 

Feedback 45 

Engine Home Path 84 

Error Log Path 85 

F 

File 45, 104 

filename 60 

Folder 39, 45, 55 

folder access tab 70 

folder permissions 113 

folders tab 76 

Frequency 83, 84 

FTP 39, 46, 57 

G 

Group Member 49 

H 

host name 22, 23, 26, 29, 

30, 38, 40, 46, 55, 57 

Hot Backup 84 

I 

Ignore Advertising 

Approval 88 

input points list box 54 

input rules 107, 108 

Integrate With Director 45 

J 

Java 9, 10, 13, 14, 16, 17, 

18 

L 

Local Folder 56 

localhost 84 

Location Tab 38 

location tab 38, 55 

Log Backup 83 

M 

Mac OS X v10.2 17 

miscellaneous tab 41 

MS SQL Server 85 

MS SQL server 81, 85, 115 

O 

On Transmission End 42 

On Transmission Start 42 

optional module 120 

Oracle 81, 82, 110, 123 

output rules 107, 108 

Override Plan Priority 60 

P 

Page Approval On/Off 60 

Passive Transfers 40, 46, 

57 

paths 76, 79, 110, 113, 

114, 116, 138 

permissions tab 65 

Plans 38 

plug-in 10, 13 

Primary and Secondary 38 

Priority 60 

165

166 INDEX 

product access tab 67 

Proofing Only 37 

properties 23, 24, 25, 30, 

35, 37, 38, 49, 54, 55, 59, 

76, 102 

Proxy 86 

Publication Groups 71 

Purge Restored Backup 84 

R 

real-time backup 112 

remote_sync.cmd 120 

Rename 55 

renaming rules 34, 42, 44, 

58, 91, 92, 100 

Renaming Tab 44 

renaming tab 44, 58 

required modules 113 

result 13 

Retransmission Groups 50 

rsync 112, 113, 114, 120 

Rsync Configuration 113 

T 

timed backup 112 

U 

UNIX 109, 110, 123 

Use Intermediate File 

Method 40 

Use Original File Name 44 

Use Proxy 40 

Users 33, 34, 63, 64, 65, 

66, 68, 101 

V 

Version Soft Proof 160 

W 

Web server 30, 31, 78 

Workflow 66 

S 

Script/Filter Tab 57 

Scripts Tab 42 

scripts tab 42, 79 

set_softproof_versions.vbs 

161 

Single and Unlimited 

Logins 65 

snapshot 82, 118, 119 

soft proof 13, 23, 66, 76, 

78 

ssh 120, 127 

Stable File Locatio 56 

Stable Time 56 

Start Time 83, 84 

Subfolder of Input 56 

Subsystem Capacity 86 

sys 84 

Sys Password 84 

System 1, 34, 36, 40, 41, 

43, 44, 49, 64, 66, 68, 69, 

75, 76, 77, 80, 81, 82, 92, 

110, 113, 114, 116, 117, 

120, 138

:Arkitex Enterprise - Agfa

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?