Enfocus software SWITCH 09 User Manual
User Guide
Contents
1. Introduction.......................................................................6
2. Installing and running Switch ..............................................10
Enfocus Switch 09
1.1 Welcome to Switch.............................................................................6
1.2 Using Switch Help..............................................................................6
Displaying help............................................................................6
Applicability................................................................................6
Getting more help.........................................................................7
1.3 Switch product flavors........................................................................9
Product family..............................................................................9
Product flavors.............................................................................9
2.1 Getting ready to run Switch ................................................................10
System requirements....................................................................10
Installing Switch .........................................................................10
Using language packs....................................................................11
Running Switch as limited user.......................................................12
2.2 Running Switch for the first time.........................................................13
Preparing to run Switch ................................................................13
2.3 Licensing........................................................................................13
Creating an activation account........................................................14
Starting a trial.............................................................................14
Activating licenses........................................................................15
Moving licenses between computers................................................16
2.4 Third-party applications....................................................................17
Installing third-party applications...................................................17
Detecting third-party applications...................................................17
Licensing third-party applications...................................................19
2.5 Upgrading from a previous version......................................................20
Stop the Switch server before upgrading...........................................20
One version at a time...................................................................20
Version change detection...............................................................21
Downgrading to a previous version..................................................21
3. Finding your way around Switch ...........................................23
3.1 Switch application components...........................................................23
3.2 Switch designer...............................................................................24
Workspace overview.....................................................................24
Toolbar......................................................................................28
Canvas......................................................................................29
Elements pane............................................................................30
Files pane...................................................................................31
2
Contents
Flows pane.................................................................................33
Folders pane..............................................................................35
Messages pane............................................................................36
Progress pane.............................................................................37
Properties pane...........................................................................37
Statistics pane............................................................................38
Users pane.................................................................................39
Filtering....................................................................................40
3.3 SwitchScripter..................................................................................41
3.4 SwitchClient....................................................................................41
4. Creating and executing a flow..............................................43
4.1 Performing the tutorial......................................................................43
4.2 Creating a flow................................................................................43
4.3 Adding the input folder....................................................................44
4.4 Sorting between PDF and non-PDF files................................................44
4.5 Creating a drop folder......................................................................46
4.6 Retrieving files from an FTP server.......................................................47
4.7 Testing the partial tutorial flow...........................................................49
Monitoring the active flow............................................................49
Files and unique name prefixes......................................................49
4.8 Delivering the PDF files through FTP.....................................................50
4.9 Sending the non-PDF files via email....................................................51
5. Managing flows.................................................................53
5.1 Creating a new flow..........................................................................53
Creating a new flow.....................................................................53
Choosing the type of flow to create..................................................53
Downloading files from FTP servers..................................................54
Receiving files through email.........................................................55
Sorting files into folders................................................................56
Sending notifications...................................................................58
Finishing up...............................................................................59
5.2 Working with flows..........................................................................60
Organizing flows.........................................................................60
Changing flow properties..............................................................62
Adding and removing flows...........................................................62
Locking and unlocking flows..........................................................63
Activating and deactivating flows....................................................65
Importing and exporting flows.......................................................65
6. Designing flows................................................................68
6.1 Basic concepts................................................................................68
Working with the canvas...............................................................68
Working with flow elements...........................................................70
Working with properties................................................................77
3
Enfocus Switch 09
6.2 Advanced topics..............................................................................78
Preferences................................................................................78
Working with folders....................................................................79
Leaving originals in place..............................................................82
Configurators..............................................................................83
Using hierarchy info.....................................................................83
Using email info..........................................................................85
Acknowledged job hand-off..........................................................88
Specifying file filters....................................................................89
Skipping subfolders in hierarchies...................................................91
7. Running flows..................................................................94
7.1 Monitoring flow execution..................................................................94
Viewing an active flow.................................................................94
Putting connections on hold..........................................................95
Viewing log messages...................................................................98
Viewing processes.......................................................................102
Viewing flow problems................................................................102
Viewing statistics........................................................................105
7.2 Handling execution problems.............................................................107
Handling problem jobs................................................................107
Handling problem processes.........................................................109
8. Metadata........................................................................111
8.1 Metadata overview...........................................................................111
8.2 Defining text with variables...............................................................112
Entering text..............................................................................113
Inserting a variable.....................................................................113
Updating a variable.....................................................................114
8.3 Defining a condition with variables.....................................................115
Defining a condition....................................................................115
Comparison operators...................................................................117
8.4 Sample jobs..................................................................................118
Working with sample jobs.............................................................118
Selecting a sample job.................................................................119
8.5 Building a location path..................................................................120
9. Scripting concepts.............................................................123
9.1 Scripting overview...........................................................................123
9.2 Putting a script in a flow..................................................................125
Script expressions.......................................................................125
Script package...........................................................................128
Script declaration.......................................................................129
Scripted plug-in.........................................................................130
9.3 Scripting languages.........................................................................130
JavaScript.................................................................................130
4
Contents
Applescript................................................................................131
VBScript....................................................................................133
10. Working with SwitchClient.................................................135
10.1 Preparing for SwitchClient................................................................135
Setting up communication............................................................135
Designing a flow........................................................................136
Managing users..........................................................................139
Configuring access rights..............................................................140
10.2 Installing SwitchClient.....................................................................142
Licensing issues..........................................................................142
SwitchClient System requirements..................................................142
Installing SwitchClient from a DVD..................................................142
Installing SwitchClient from the internet..........................................143
Preparing to run SwitchClient........................................................143
10.3 Using SwitchClient.........................................................................143
Finding your way around SwitchClient.............................................143
Connecting to Switch...................................................................144
Submitting jobs.........................................................................146
Working with checkpoints............................................................146
Replacing a job..........................................................................148
Viewing log messages..................................................................149
Working with jobs......................................................................150
5
Enfocus Switch 09
1. Introduction
1.1 Welcome to Switch
Thank you for your interest in Enfocus Switch.
Switch was born because so many people like you were looking for a simple yet powerful
publishing automation solution. Over the years numerous features have been added to make it
easier for you to automate your life.
We strive to make our products user-friendly and easy to learn. If you think we could do more
with the product, the documentation, our web site or anything else to make your life easier, we
would love to hear about it.
1.2 Using Switch Help
Displaying help
Switch uses your default web-browser to display its help content.
You can reach Switch help in one of the following ways:
•
Select the Help > Switch help menu item.
•
Press the F1 key.
Applicability
Switch help describes the capabilities of the complete Switch product family. Some topics may
not apply to your version of the Switch product (see Switch product flavors on page 9 for a
description of the Switch product family members).
The applicability for some topics is indicated with an icon:
PowerSwitchFullSwitchLightSwitchIcon
6
Getting more help
How to get more help
If you run into a problem while installing or using Switch, there are a number of ways to get
help:
• Consult the User Guide presented in Switch help.
• Consult the Switch Reference Guide
• Consult the support section on the Enfocus web site; you'll find an extensive information
database, including:
Enfocus Switch 09
PowerSwitchFullSwitchLightSwitchIcon
a) A set of example flows and scripts (flow library, application library, script library).
b) A knowledge base with answers to frequently asked questions.
• Discuss the issue with other Switch users on the Enfocus user group.
• Contact your reseller; a list of authorized resellers is available on the Enfocus web site: Open
http://www.enfocus.com/FindReseller.php and choose your country in the dropdown menu.
• Complete and submit the "report a problem" form on the web at
http://www.enfocus.com/reportaproblem.php.
Flow library
The flow library offers an extensive set of documented example flows. You can download an
example and use it "as is", as a starting point for your own customized flow design, or just to
get a feeling for the capabilities of Switch.
To access the flow library, go to: http://www.enfocus.com/flows.php
Application library
The application library lists third-party applications that can be automated through Switch and
for which such automation has been tested by Enfocus. The list includes third-party applications
for which Switch offers a configurator, and other third-party applications that are treated as a
generic application.
The description for each application includes links to example flows and scripts to get you on
your way quickly.
To access the application library, go to
https://www.crossroads-world.com/crossroads/site.aspx?p=27.
Script library
While Switch offers many features "out of the box", some situations require additional
customization through scripting.
7
Enfocus Switch 09
The script library offers a number of example scripts for use with Switch. You can download an
example and use it "as is", as a starting point for your own customized script, or just to get a
feeling for the capabilities of Switch scripting.
To access the script library, go to: http://www.enfocus.com/flows.php.
Knowledge base
The knowledge base contains articles with answers to frequently asked questions, work-arounds
and tips & tricks. The knowledge base should be your first stop when you run into a problem
with Switch.
To access the knowledge base, go to: http://www.enfocus.com/kboverview.php?id=4707.
User group
The Switch user group is an email-based user community where you can ask questions and
exchange ideas with other Switch users. Joining the user group is very simple.
Sign up today!
To join the user group, go to: www.enfocus.com/usergroup.htm.
Support
If you cannot find the answer to your question in Switch help or on the web, help is available
from the Enfocus support team.
Before asking your question please:
• Consult the product documentation (Switch help) and the online resources available on the
web (knowledge base, flow library, application library, script library).
• Consider to gain advice from your peers on the user group.
• Register your product - this will help us to know who you are and what products you are
using.
To contact Enfocus Support: complete and submit the "report a problem" form on the web at
http://www.enfocus.com/reportaproblem.php.
Contact us
We highly value interaction with our customers.
Web site
Email
For sales questions: sales@enfocus.com
For support questions: contact the support team
All other questions: info@enfocus.com
8
1.3 Switch product flavors
Product family
Switch offers an impressive array of features, including:
• Visual flow design tools making automated flows easy to setup and deploy.
• Automatically receiving and sending jobs through FTP or email.
• Configuring and driving a range of third-part applications used for publishing tasks.
• Importing, exporting and working with metadata in various formats.
• Sorting and processing jobs based on their origin or based on the contents of metadata
accompanying the job.
• Powerful scripting capabilities to automate a yet wider range of third-party applications and
to integrate with databases, digital-asset management systems or MIS-systems.
• Interacting with users on the network to support job submission and monitoring from their
own desktop.
Enfocus Switch 09
Product flavors
The Switch product family has the following three members, also called “flavors”, in order of
increating capabilities:
File transfer through FTP and
email, and sorting files into
folders
Automating third-party
applications through
configurators
PowerSwitchFullSwitchLightSwitch
More sophisticated automation
through scripting and
advanced metadata features
Users on the local network can
submit jobs and monitor their
progress
9
Enfocus Switch 09
2. Installing and running Switch
2.1 Getting ready to run Switch
System requirements
Resources
By itself Switch doesn’t require a lot of resources.
You can find the system requirements on the Enfocus website http://www.enfocus.com by choosing
Products > Enfocus Switch > [your Switch Flavor] > System Requirements
However Switch usually drives a number of processes that require substantial additional
resources:
• Disk space for (potentially large) jobs as they are being moved along a flow or after they have
been archived.
• Network bandwidth for email and FTP communication.
• Processor time, disk I/O capacity, memory and disk space for third-party applications.
The resource requirements for these processes must be estimated separately.
Multi-processor systems
Switch is heavily multi-threaded and takes full advantage of multi-processor systems, both for
its internal operation and when driving external processes. See the Switch Reference Guide for
more details.
Configurators
While most configurators are provided for all supported operating systems, this is not always
possible because the corresponding third-party application may not be available (or may not
support an automation interface) on all systems.
See Third-party application version requirements in the Switch Reference Guide for details.
Installing Switch
Locating the installer from a trial or product DVD
1. Insert the DVD in the DVD drive of your system
2. On Windows: the DVD wizard appears and shows you the content of the DVD. Follow the steps
in the wizard to find the installer
3. On Mac OS: locate the installer application. The name of the installer depends on the version
of Switch you are installing:
10
• For LightSwitch, locate "LightSwitch Installer"
• For FullSwitch, locate "FullSwitch Installer"
Enfocus Switch 09
• For PowerSwitch, locate "PowerSwitch Installer"
Download the installer from internet
To download the latest version of the installer:
1. Visit the Enfocus web site and go to the download section.
2. Download the appropriate installer for your operating system.
3. Locate the installer where you saved it on your computer.
Installing Switch
• Double-click the Switch installer to launch it, and follow the steps presented to you by the
installer.
• If you had a previous version of Switch installed, see Upgrading from a previous version on
page 20
Note: You need administrator rights to install and license Switch . In other words, you can't
successfully complete these tasks when you're logged in with a limited user account.
Using language packs
The Switch user interface and help system can be displayed in a language other than English
by installing the appropriate language pack and selecting the desired language in the user
preferences.
Locating language pack installers
For each language there are two language pack installers:
LightSwitch
FullSwitch
PowerSwitch
SwitchClient
A server-side language pack that includes the
localization information needed by the server,
designer and scripter
The same language pack is applicable for any
of the product flavors
A client-side language pack that includes the
localization information needed by the client
(including the translation for messages received
from the server)
You need to locate the language pack installer appropriate for your needs (server-side or
client-side). Also see Installing Switch on page 10 for hints on locating installers.
Installing language packs
1. Double-click the language pack installer to launch it
2. Follow the steps presented to you by the installer.
11
Enfocus Switch 09
The language pack installers assume that the corresponding Switch application was installed
in the default location. If you installed the application in a different location, you must
intervene manually to install the language pack in that location as well (i.e. next to the
application), in a folder called "Switch Language Packs"
MacWindows:
Selecting the desired language
After installing the language pack, perform the following steps for each Switch application
(designer & server; scripter; client):
1. Quit the Switch application (if you haven't already done so).
2. Launch the Switch application.
3. Open the Preferences
on Mac
on Windows
4. In the application's preferences dialog, set the "Language" property to the desired language.
5. Quit the Switch application.
6. Launch the Switch application.
Running Switch as limited user
Choose Preferences from the application menu
For Switch (designer & server) and SwitchScripter, Choose Edit > Preferences
. For SwitchClient, click the window title bar icon or right-click the title
bar, and choose Preferences from the window’s system menu
12
Installing and licensing
You need administrator rights to install and license Switch . In other words, you can't successfully
complete these tasks when you're logged in with a limited user account.
Application data
All of the application data managed by Switch (including flow definitions, auto-managed
backing folders, internal job tickets and so on) is stored in a nested folder hierarchy under a
Enfocus Switch 09
single root folder, which is called the application data root. By default, this folder is not accessible
for writing by limited users (i.e. a user without administrator rights).
If you need a limited user to operate Switch , you need to provide that user with full read-write
access to the Switch application data.
Preparing for operation by limited user
To prepare Switch for operation by a limited user, perform the following steps:
1. Log in as administrator.
2. Ensure that Switch is successfully installed and activated (or the trial period has not yet
expired).
3. Launch Switch .
4. Deactivate all flows (preferably).
5. Open the preferences dialog and select the application data group.
6. Select a new location for the application data root that offers full access rights to the intended
limited user(s).
7. Switch guides you through the procedure of relocating the application data root.
8. Quit Switch .
2.2 Running Switch for the first time
Preparing to run Switch
Depending on what you intend to use Switch for, you will need different pieces of information
to get Switch completely up and running. You may need to obtain some of this information from
your system administrator.
• If you have purchased Switch , you'll need your license key to license the application (see
Licensing on page 13).
• If you want Switch to send email messages, you'll need the name and related information
of your outgoing SMTP email server (see mail send preferences in the Switch Reference Guide).
• If you want Switch to receive files through email, you'll need the log-in information for your
POP3 email accounts (see mail receive properties in the Switch Reference Guide).
• If you want Switch to send or receive files through FTP, you'll need URL and log-in information
for the FTP servers (see FTP send and FTP receive properties in the Switch Reference Guide).
2.3 Licensing
From the About Enfocus Switch window, you can:
• start a 30-day trial (see Starting a trial on page 14),
13
Enfocus Switch 09
• activate your license (see Activating licenses on page 15),
• deactivate your license (see the Switch Reference Guide for more information),
• repair your license (see the Switch Reference Guide for more information).
For easiest configuration, the machine running your copy of Switch should be online with full
Internet access while performing licensing tasks.
However, if the machine you are using does not have full Internet access, you can perform
licensing tasks off-line if you:
• have access to Internet e-mail and use of a Web browser on another machine,
• can copy a file received in an Internet e-mail message to the machine you are using (using
a USB flash memory drive, a diskette, an internal network...).
For more information on the off-line procedures, see the Switch Reference Guide.
Before you can activate or deactivate licenses, you should set up an activation account using
the Enfocus website (http://www.enfocus.com/CreateAccount).
Creating an activation account
1. Go to http://www.enfocus.com/CreateAccount.
2. Enter the appropriate information in the fields.
3. If you would like to receive news from Enfocus or be contacted by an Enfocus Certified Partner,
4. Click Create my Account.
5. After a few minutes, check your e-mail program for a new message from Enfocus regarding
6. Once it arrives, open the message and click the link to confirm your e-mail address.
Starting a trial
leave the two bottom checkboxes selected; otherwise, clear them.
activating your new account.
Note:
If you do not receive this e-mail message, you might have to check any spam folders in your
e-mail program as well.
You should receive a message that your account was confirmed successfully in your default
web browser.
14
Once you have created and confirmed your activation account (see Creating an activation account
on page 14), you can start a 30-day trial for your copy of Switch.
• If the computer running your copy of Switch is connected to the Internet, you can start a
30-day trial from that machine.
See Starting a trial on-line on page 15.
• Otherwise, you must create a trial request file and use a computer that is connected to the
Internet to upload it to an activation server.
See the Switch Reference Guide for more information.
Enfocus Switch 09
Starting a trial on-line
You can start a 30-day trial on-line if the computer where your copy of Switch is installed is
connected to the internet.
To start a 30-day trial on-line, do the following:
1. Go to the Trial tab of the About Enfocus Switch window and click Start Trial.
This opens the Activate License Wizard (on PC) or the Activate License Assistant (on Mac).
2. Click Next (on PC) or Continue (on Mac) in the first screen of the Activate License
Wizard/Assistant dialog box.
3. Select On-line activation and click Next / Continue.
4. Enter the name and password of your activation account and click Next / Continue.
Note:
You should have created this activation account in Creating an activation account on page
14.
If you haven’t created an activation account yet, click the Create a new Enfocus Account link
in the Wizard/Assistant and see Creating an activation account on page 14 for instructions.
After you click Next / Continue, a status bar appears while the system communicates with the
activation server. Do not cancel or close the Wizard/Assistant.
A message will appear saying that the trial was completed successfully and that you can now
use the product(s) on your computer.
5. Click Finish / Done.
You will see the number of trial days remaining in the Trial tab of the About Enfocus Switch
window.
Activating licenses
Once you have created and confirmed your activation account (see Creating an activation account
on page 14), you can start activating the licenses using your software’s product keys.
Product keys come from online stores, from product key files you receive from Enfocus, or you
can find them inside product boxes.
Note: Product key files are HTML files. You can double-click them to see what product keys they
contain.
• If the computer running your copy of Switch is connected to the Internet, you can get licenses
for the product keys and activate them from that machine.
See On-line activation on page 16.
• Otherwise, you must create an activation request file and use a computer that is connected
to the Internet to upload it to an activation server.
See the Switch Reference Guide for more information.
15
Enfocus Switch 09
On-line activation
You can activate your product key(s) on-line if the computer where you will use your software
is connected to the internet.
To activate a product key on-line, do the following:
1. Open the Activate License Wizard (on PC) or the Activate License Assistant (on Mac) by either:
• going to the Trial tab of the About Enfocus Switch window and clicking Activate,
• going to Help > Licensing > Activate .
2. Click Next (on PC) or Continue (on Mac) in the first screen of the Activate License
Wizard/Assistant dialog box.
3. Select On-line activation and click Next / Continue.
4. In the Your product keys screen, choose the number of product keys you have to activate and
click Next / Continue.
5. Depending on what you chose in the previous step:
a) If you chose I have one product key, enter the product key in the fields provided. The
cursor automatically advances to the next field as you type.
b) If you chose I have more than one product key, enter each product key on a line, followed
by a comma.
c) Then click Next / Continue.
6. Enter the name and password of your activation account and click Next / Continue.
Note:
You should have created this activation account in Creating an activation account on page
14.
If you haven’t created an activation account yet, click the Create a new Enfocus Account link
in the Wizard/Assistant and see Creating an activation account on page 14 for instructions.
After you click Next / Continue, a status bar appears while the system communicates with the
activation server. Do not cancel or close the Wizard/Assistant.
A message will appear saying that the activation was completed successfully and that you
can now use the product(s) on your computer.
7. Click Finish / Done.
The product and its license will appear in the License tab of the About Enfocus Switch window
(previously called Trial tab).
Moving licenses between computers
To move licenses between computers, do the following:
16
1. Deactivate the licenses on the computer that will not use them anymore.
See the Switch Reference Guide for more information.
2. Copy the product keys file to the computer that will use the licenses.
3. On the computer acquiring the licenses, activate the licenses using the product keys file.
See Activating licenses on page 15.
2.4 Third-party applications
Installing third-party applications
Switch interacts with a number of frequently-used third-party applications through built-in
configurators.
Enfocus Switch 09
For a Switch configurator to work with the corresponding third-party application, follow these
guidelines:
• Obtain a version of the third-party application that is supported by Switch; see version
requirements in the Switch Reference Guide.
• Install the third-party application on the same computer as Switch (it will also be launched
on that computer).
• Use the installer program or installer guidelines supplied with the third-party application.
Note:
You must legally obtain a valid license and installation kit from the application's vendor (or its
representatives) for any third-party application used in conjunction with Switch. Enfocus does
not sell, distribute or support third-party applications.
In most cases you need to license a third-party application through its own user interface. Some
configurators however support licensing the corresponding third-party application from within
Switch. See licensing third-party applications.
Detecting third-party applications
Each Switch configurator implements one or more mechanisms to detect the presence of the
corresponding third-party application.
Often the application is automatically detected when Switch is launched, however in some cases
manual intervention is required.
Detection feedback
As long as its third-party application is not successfully detected, a configurator's icon is
grayed-out (as shown below) in the elements pane and in the canvas. A grayed-out configurator
can be used in a flow design as usual, but the flow can't be activated.
17
Enfocus Switch 09
Automatic detection at startup
When the Switch server starts, it attempts to detect the third-party application using fast
mechanisms (such as querying the operating system registry or checking the default application
path). To limit startup time, Switch does not perform a full file search during startup.
Searching from the elements pane
18
If during startup Switch doesn't detect a third-party application that has been successfully
installed, you can trigger a search for the application through the context menu offered by the
elements pane (as shown above). You can also use this function if you didn't quit and restart
Switch after installing a third-party application.
To search for the third-party application corresponding to a configurator:
1. Bring up the context menu for the configurator's icon in the elements pane.
2. Choose the Search for application menu item in the context menu.
This function first attempts to detect the third-party application using fast mechanisms, and if
that fails, it performs a full file search in the system's program files folder.
Note:
Some configurators do not offer this function, or may not offer the full file search capability.
Enfocus Switch 09
Manually locating the executable
If the search function described in the previous section fails to detect a third-party application
that has been successfully installed, you can manually locate the application through the context
menu offered by the elements pane (as shown in the previous section).
Be careful with this procedure; selecting an unsupported application will have unpredictable
results.
To manually locate a third-party application corresponding to a configurator:
1. Bring up the context menu for the configurator's icon in the elements pane.
2. Choose the Set path to application menu item in the context menu.
3. In the Choose application dialog, browse to the application's executable (or application
bundle)
4. Click Open
Note:
Some configurators do not offer this function.
Licensing third-party applications
You must legally obtain a valid license and installation kit from the application's vendor (or its
representatives) for any third-party application used in conjunction with Switch. Enfocus does
not sell, distribute or support third-party applications.
In most cases you need to license a third-party application through its own user interface.
Trial Versions
Most configurators work with a trial version of the corresponding third-party application. This
allows you to test the combined solution before actually purchasing the products.
Licensing from within Switch
19
Enfocus Switch 09
Some configurators support licensing the corresponding third-party application from within
Switch through the context menu offered by the elements pane.
Entering the license key
To license the third-party application corresponding to a configurator:
1. Bring up the context menu for the configurator's icon in the elements pane.
2. Choose the License application menu item in the context menu.
3. In the Enter application license dialog, enter the license string for the third-party application
4. Press OK.
Note:
only some configurators offer this function.
Verifying the licensing status
To verify the licensing status for the third-party application corresponding to a configurator:
1. Bring up the context menu for the configurator's icon in the elements pane.
2. Choose the Show licensing status menu item in the context menu.
3. Review the message in the Application licensing status dialog.
Note:
only some configurators offer this function.
2.5 Upgrading from a previous version
Stop the Switch server before upgrading
Before installing a new version of Switch , make sure that Switch is not running, including the
Switch server. If you're not sure whether the Switch server is running or not, launch the Switch
designer in the regular way and quit it again. If there are any active flows, Switch will present
a dialog with the option to stop the server.
If you were running the previous version of Switch as a Windows service, you may have to repeat
the setup procedure after installing the upgrade. See running Switch as a service in the Switch
Reference Guide.
One version at a time
Installing a new version of Switch automatically removes the previous version of the same
Switch product flavor. Running two versions of the same Switch product flavor at the same time
20
on the same computer is not supported. This is because the two versions would share the same
preferences and application data.
It is possible though to install and run multiple Switch product flavors in parallel, since each
flavor has its own preferences and application data. For example, you could run FullSwitch 07
and PowerSwitch 08 at the same time on the same computer.
Version change detection
When you first launch Switch after installing a new version, Switch detects the version change
and presents the following dialog:
Enfocus Switch 09
As explained in the dialog message, if you press the "proceed" button Switch makes a backup
of your existing flows and then re-imports them. While re-importing the flows, Switch adjusts
all flow elements and properties so that they conform with this version of Switch. Any problems
are reported to the user. See also importing and exporting flows.
If you press the "cancel" button Switch quits without making any changes to the flows.
Backup location
The automatically exported flows are stored in a folder named for the current date/time inside
the Switch designer's application data, which is system dependent.
For example, on a typical Windows system the location might be:
C:\Documents and Settings\All Users\Application Data\Enfocus\PowerSwitch
Designer\backup\2007-08-18--16-45-01
And on a typical Mac OS X system the location might be:
/Library/Application Support/Enfocus/PowerSwitch
Designer/backup/2007-08-18--16-45-01
Deprecated flow elements
Deprecated flow elements are automatically converted while re-importing existing flows as
described above. See upgrading deprecated flow elements.
Downgrading to a previous version
If you want to return to a previous version of Switch, follow these steps:
1. Export all your flows to a safe place as a backup; see Importing and exporting flows on page
65.
2. Delete all your flows in Switch (not the backup!); see Adding and removing flows on page
62.
21
Enfocus Switch 09
3. Uninstall the newer version of Switch.
4. Install the previous version of Switch.
5. Launch Switch.
6. Import your flows from the backup made by the new version of Switch (when you first launched
it); see backup location above.
22
3. Finding your way around Switch
3.1 Switch application components
Switch offers its functionality through a number of separate applications, each with a distinct
function.
Switch server
The Switch server runs in the background, managed and monitorred by the Switch Watchdog,
to execute flows. It is automatically started and terminated as needed by the Switch designer.
If so requested, the Watchdog can continue running after the user quits the designer.
Since it has no user interface there is little to say about the Switch server and Switch Watchdog.
Although in fact a reference to Switch often really refers to Switch server (especially in the
context of executing flows).
Enfocus Switch 09
See also running Switch Watchdog as a service in the Switch Reference Guide.
Switch designer
The Switch designer offers a comprehensive user interface to design, activate, and monitor
flows. It communicates with and manages the Switch server. The designer and the server must
run on the same computer.
See Workspace overview on page 24 for an introduction to the designer.
23
Enfocus Switch 09
SwitchScripter
SwitchScripter offers a scripting development environment, i.e. it allows creating and testing
script packages for use with Switch. The PowerSwitch installer automatically installs SwitchScripter
as well. Although there is no technical requirement, SwitchScripter usually runs on the same
computer as the designer.
For more information see SwitchScripter on page 41, Scripting concepts on page 123 and Scripting
in the Switch Reference Guide.
SwitchClient
SwitchClient is a light-weight desktop application that allows a user on a different computer to
submit and monitor jobs. Since it usually runs on a different computer, SwitchClient has its own
installer.
For more information see Working with SwitchClient on page 135
3.2 Switch designer
Workspace overview
When you launch the Switch designer it displays its main window, called the workspace, shown
here in its default configuration (design view):
24
Enfocus Switch 09
Toolbar
The toolbar is the strip at the top of the workspace offering a number of tool buttons.
See Toolbar on page 28 for more details.
Panes and views
The workspace contains a number of panes which can be manipulated as distinct entities (show,
hide, resize, move, ...). Examples include the flows pane, the elements pane, and the properties
pane.
25
Enfocus Switch 09
The central area that displays a flow design is called the canvas; it is a special pane because it
has no title bar and it can't be moved from its central position.
One or more panes (optionally including the canvas) combine to make up a workspace
configuration called a view. The currently displayed view is selected by pressing one of the
buttons in the leftmost section of the toolbar.
Configuring the workspace
The workspace offers a number of panes that are displayed in a number of pre-configured views.
Each of the views can be configured at will to display an arbitrary combination of panes. The
contents of a pane persists across views (i.e. the different views display the same instance of
the pane rather than different copies).
Panes can be shown or hidden by choosing the corresponding item in the View > Show panes
menu. Panes can be resized by dragging the separators between them, they can be rearranged
next to one another or overlaid as tabs by dragging their title bar, and they can be undocked as
a floating pane. All configuration settings are persistent across sessions.
The currently displayed view can be returned to its pre-configured settings by selecting View >
Show panes > Reset view .
Views
The workspace offers the following views. The intended function is only a recommendation, since
the user can re-configure the views at will.
Intended functionView nameTool button
Design a flowDesign
Test-run a flowTest
Run a flow in productionRun
Messages
View and export historical
messages
View historical statisticsStatistics
26
Users
Manage SwitchClient users
and their access rights
Enfocus Switch 09
Panes
The workspace offers the following panes, which can be combined at will in the different views
DescriptionPane
Displays and allows interaction with a flow designCanvas
Dashboard
Elements
Files
Folders
Messages
Messages 2, 3
Displays status information on problem jobs or processes, as
reported by the Switch server
Lists the icons representing flow elements that can be dragged
onto the canvas
Serves to view and explore the contents of flow element backing
folders (i.e. mostly jobs)
Can also be used to view the contents of an arbitrary folder in
the file system, but this is not a primary function
Lists all flows known to Switch at the present timeFlows
Serves to browse folders (not files) in the local file system and
allows dragging backing folders to the canvas
Displays log messages produced by the Switch server during flow
execution
Extra messages panes that may be configured with different
settings for filtering or sorting messages
Progress
Properties
Statistics 2, 3
Displays progress information for tasks currently being executed
by the Switch server
Displays the properties of the currently selected flow or flow
element
Displays statistics about job execution by the Switch serverStatistics
Extra statistics panes that may be configured to display a different
set of statistics.
27
Enfocus Switch 09
DescriptionPane
Toolbar
Users
The toolbar is the strip located at the top of the workspace window; it contains a number of tool
buttons to accomplish common tasks. For example, this is the toolbar in the default workspace
configuration (design view):
Tool sets
The tool buttons are grouped in tool sets, which are shown or hidden depending on which panes
are currently shown or hidden. The following table provides an overview of the tool sets and
their function.
Allows managing SwitchClient user names, passwords and access
rights
FunctionShown withTool set
Always
Select a view (design, test, run,
messages, statistics, users). See
Configuring the workspace in
Workspace overview on page
24
Canvas
Canvas
Canvas
Flows pane
Undo and redo the most recent
change for the current flow
See Working with the canvas
on page 68
Copy, paste, and delete flow
elements in the canvas
See Working with the canvas
on page 68
Align flow elements in the
canvas horizontally or vertically
See Working with the canvas
on page 68
Create, duplicate, delete,
import and export flows
See Flows pane on page 33
Lock, UnlockFlows pane
28
Enfocus Switch 09
FunctionShown withTool set
See Flows pane on page 33
Activate, DeactivateCanvas, flows pane
See Flows pane on page 33
Retry a problem job or processCanvas, Dashboard pane
See Viewing flow problems on
page 102
Canvas
Messages (,2,3)
Messages (,2,3)
The canvas is the central workspace area that allows viewing and editing flows. Here's an example
of a simple flow displayed in the canvas:
Export messages, clear
messages
See Messages pane in
Workspace overview on page
24
Refresh statistics, reset
statistics
See Statistics pane in
Workspace overview on page
24
To display a flow in the canvas, select it in the flows pane. To make changes to a flow, ensure
that it is inactive and unlocked. You can drag new flow elements from the elements pane onto
29
Enfocus Switch 09
the canvas, create connections between flow elements, configure flow elements using the
properties pane, and drag flow elements around to adjust the layout of the design.
Elements pane
The elements pane lists the icons representing flow elements (such as folders, connections, tools
and configurators) that can be dragged onto the canvas and become part of a flow design.
To toggle between large and small icons, choose the appropriate context menu item shown for
the elements pane.
Filtering
You can use the Search field on top to filter the Flow Elements. See Filtering on page 40
Favorites
The Favorites section can contain shortcuts to elements in other sections. It looks and functions
like other section headers, but its content is managed by the user.
You can
•
Select Add to favorites from the context menu of an Element to add a shortcut to the Favorites
section
• Drag an Element in the Favorites section to add a shortcut to the Favorites section
•
Select Move up or Move down from the context menu of a shortcut in the Favorites section,
to change the order
• Drag and drop shortcuts in the favorites section to change the order.
•
Select Remove from favorites from the context menu of a shortcut in the Favorites section,
to remove it from the Favorites section
30
Loading...