Switch 2-in-1

FileStatistics class...486CP2 data model...

DefaultEditorsDescriptionProperty namePossible values are:• All folders• No foldersNoneDropdown listDefines a rule for adjustingthe set of folders tha

DefaultEditorsDescriptionProperty name• Don’t include nestedsubfoldersPossible values for“excluding” rule are:• Exclude nestedsubfolders as well• Dont

Value for “Skip these folders”Value for “Process only thesefolders”Property name“Exclude nested subfolders aswell”“Exclude nested subfolders aswell”..

8. Running flows8.1 Monitoring flow executionViewing an active flowAn active flow is currently being executed by Switch server, i.e. it is processing

Scanning folders and checking Mail / FTPSwitch automatically scans the contents of backing folders and checks Mail and FTP in an activeflow at regular

Although editing in the Properties pane is disabled while a flow is active (see activating anddeactivating flows), the status of the "Hold files&

In this example the connections are setup to duplicate the incoming job (one copy in each outputfolder). When the first connection is put on hold, the

Traffic light connections carry data or log information for the same job, so it does not make senseto put a single connection on hold independently. W

New messages are continuously added to the list while Switch is operating. Warning and errormessages are shown in color.Wrap textTo display long messa

Filtering and sorting log messagesFilter fieldsEach column in the Messages pane has a filter field which is placed just above the column header.A filt

1. Copyrights©2011 Enfocus BVBA all rights reserved. Enfocus is an EskoArtwork company.Certified PDF is a registered trademark of Enfocus BVBA; patent

Exporting log messagesThe messages currently displayed in the Messages pane (after filtering) can be exported to anXML file for processing by third-pa

• Choose the "Clear log messages" menu item in the context menu of the Messages pane.A confirmation dialog appears. If you press the "Y

Wrap textTo display long messages on multiple lines (i.e. "wrapped" rather than chopped off): Choose the"Wrap text" menu item in t

Group nodes, if present, are sorted on flow name. The order in which items are sorted withineach group (or within the category if there are no groups)

DescriptionContext menu itemRetries the job or process associated with the selected rowRetry itemFor a group row, retries all items in the associated

• The job has an invalid file format causing a third-party application to issue a fatal errormessage.• The job matches none of the file filters set on

Switch offers various ways to retry a job:• When you select the Problem jobs flow element in the canvas (and it contains problem jobs),the Retry tool

Retrying problem processesThe process of re-enabling a process (or at least attempting to do so) is called retrying the process.It is meaningful to re

9. Metadata9.1 Metadata overviewWhat is metadataIn the Switch context, metadata is descriptive information about a job (file or job folder) in astruct

BenefitsFeatureRead-only access to embedded metadata (EXIF, IPTC,XMP) and file informationVariablesPicking up external metadata (XML, JDF, XMP) fromfo

2. Introduction2.1 Welcome to SwitchThank you for your interest in Enfocus Switch.Switch was born because so many people like you were looking for a s

See Data types on page 292, Formatting on page 293, Indexed variables on page 296, and Stringmanipulations on page 297.Entering textYou can type const

To insert a new variable in the text, proceed as follows:1. In the text field at the bottom, place the text cursor in the location where you'd li

3. Once you are satisfied with the changes, press the "Update variable" button.9.3 Defining a condition with variablesConditional properties

The group and variable listboxes in the pop-up are synchronized with the corresponding dropdownmenus for the currently selected comparison in the main

You cannot remove the first condition since it does not have a logical operator dropdownmenu.• To change the logical operator combining two comparison

Comparison valueComparison operatorsVariable data typeA decimal integer or floating point number,example, "-12" or "0.56"Equal toN

3. Put connections on hold where appropriate to keep jobs from moving too far ahead (seeActivating and deactivating flows on page 73).4. Place sample

9.5 Building a location pathThe “Build location path” dialog offers assistance with building location paths for the variablesin the Metadata group usi

Metadata datasetThis section lists the various datasets associated with the job. You can select the embeddeddataset (which is always available, even i

Location pathFor the choices “XMP/XML/JDF location path” the bottom part of the dialog displays the followingtwo items:• An editable text field labele

PowerSwitchFullSwitchLightSwitchIconGetting more helpHow to get more helpIf you run into a problem while installing or using Switch, there are a numbe

10. Scripting concepts10.1 Scripting overviewPowerSwitch offers a comprehensive scripting environment. With limited scripting experience,a user can su

• Reading and writing XML files and performing XSLT transforms.• Executing a command line application.• Database access.• Webservices interaction.Java

10.2 Putting a script in a flowScript expressionsA script expression is a JavaScript program that gets evaluated in the context of a job (file or jobf

Boolean value exampleAs a second example, the "Include these files" property of a connection leaving a folder allowsa script expression in a

• Use SwitchScripter to develop and test the script expression, and then load it into theappropriate property editor dialog box.SwitchScripter offers

Flow element moduleEntry points are not supported (instead the main body of a script expression is evaluated toobtain a value).The Environment class i

The classes and functions in the Database module offer access to a small but functional subsetof the ODBC API. The DataSource class and Statement clas

a script element, and the package contains an icon, the flow designer uses the icon to displaythe script element in the canvas. Otherwise the flow des

Property definition propertiesEach property definition in the script declaration includes:• A tag used to uniquely identify the property to the script

Language referenceRefer to the Switch JavaScript language reference included with Switch help.Extensions referenceRefer to the Scripting reference on

Script libraryWhile Switch offers many features "out of the box", some situations require additionalcustomization through scripting.The scri

Script packagesStarting with Switch 08, SwitchScripter stores the compiled binary form of the AppleScript in theSwitch script package (in addition to

end tellReferring to third-party applicationIf the name of the target application is constant, and if it does not matter that the targetapplication ge

Language referenceComprehensive reference and introductory information about VBScript can be found on theMicrosoft web site and in widely available li

11. Working with SwitchClient11.1 Preparing for SwitchClientSetting up communicationTo enable PowerSwitch/ FullSwitch to handle connections with Switc

Default values for bidirectional communication:Bidirectional communication (that is, Client – Server – Client communication during filesubmission) req

Other configuration and setupDesign flowsIn PowerSwitch/ FullSwitch, users can design the flows they want to use with SwitchClient. Thenext topic disc

Since this example focuses on SwitchClient features, there is a lot of interaction with humanoperators and little automated processing (other than mov

Setting up a CheckpointSimilarly, a Checkpoint (Visual Proof and Output Jobs in the example flow) offers properties toconfigure its behavior. It can c

Setting up access rightsTo enable Submit points and Checkpoints for a particular user, the PowerSwitch/ FullSwitch usermust also configure the appropr

To add a new user, click the + button and enter the user's information in the fields to the right.Providing an email address enables Switch to se

2.3 Switch product flavorsProduct familySwitch offers an impressive array of features, including:• Visual flow design tools making automated flows eas

User rolesOperators can view their own jobs and additionally can have access rights forcertain (or all) Submit points and Checkpoints. In Checkpoints

SwitchClient displays a list of Submit points through which the user can submit jobs to a flow.The settings in this section determine which Submit poi

11.2 Installing SwitchClientLicensing issuesDistributionSwitchClient is part of the PowerSwitch/ FullSwitch product but it has its own separate instal

3. Double-click the SwitchClient installer to launch it and follow the steps presented by theinstaller.Installing SwitchClient from the internetSwitch

Main windowTo keep things concise, SwitchClient has a single window that supports all its tasks. TheSwitchClient window is displayed when the applicat

The Search box saves the last searches and displays as a hint when typing in the search box.Filters paneThe Filters pane appears at the left of the Sw

2. Selecting Yes in the Launch at system startup pull down menu enables SwitchClient applicationto automatically start when the system is started.3. S

Adding a connectionTo establish a new connection to a copy of PowerSwitch/ FullSwitch on your local network:1. Press the + button at the bottom; a new

3.Options to copy or move a file and options to assemble jobs when multiple jobs are submittedListing Submit pointsSubmit point’s icon and display nam

When user click OK button in this dialog box, jobs are processed. If users click Cancel button inthis dialog box, they are reverted to the Submit job

3. Installing and running Switch3.1 Getting ready to run SwitchSystem requirementsResourcesBy itself Switch doesn’t require a lot of resources.You c

groups by checking multiple columns. The order in which the columns are checked is the orderof the grouping.When un-checking a column in a multiple le

1. In the section on the left, select Alert Jobs to determine the number of jobs waiting in aCheckpoint.2. In the list on the right, select a job for

Handling jobs being held in a CheckpointTo handle a job (that is, move it along the flow) after reviewing it:• Click the button for the appropriate co

processed by clicking the Process all button. If only a single job is selected, the regular Processbutton replaces the Process all button.Note:The lis

As an important exception, the filename extension of the output job reflects the extensionof the replacement job (so that it is possible to provide a

• The appropriate PowerSwitch/ FullSwitch connection has been established; see connecting toSwitch.• The server information has been recently updated;

12. General application reference12.1 LicensingStarting a trial off-lineIf the computer where you will use your software is NOT connected to the inter

6. Save the trial request file.a) Click Save As (PC) or Select... (Mac).b) In the pop-up that opens, browse to the desired location and click Save.Not

2. Click Next / Continue in the first screen of the Activate License Wizard/Assistant dialog box.3. Select Off-line activation again and click Next /

4. Leave Step 1: Create an activation request selected and click Next / Continue.Note:You should have created this activation account in Creating an a

For LightSwitch, locate "LightSwitch Installer"•• For FullSwitch, locate "FullSwitch Installer"• For PowerSwitch, locate "Pow

7. Copy the response file back to the machine running Enfocus Switch and go to that machine.Loading the activation response fileOnce you are back at t

4. A product key file (HTML) is created. You will need this file to activate the license for thisproduct key on another computer.a) Click Save As / S

Note: By default, the activation request file is called requestdeactivate.xml.6. A message will appear saying that Step 1 of the off-line deactivatio

2. Click Next / Continue in the first screen of the Deactivate License Wizard/Assistant dialog box.3. Select Off-line deactivation and click Next / Co

4. Leave On-line Repair selected and click Next / Continue.A status bar appears while the system communicates with the activation server. After that,

4. Verify that the product information contained in the repair request file is correct and clickContinue.5. Depending on the level of security of your

Error during activation / deactivation / repairIf you get the error message: “An error occurred duringactivation/deactivation/repair”, check the versi

If you are using a filesystem monitoring utility such as Radmind on the Macintosh, it can deletethe configuration in the trusted storage area thinking

PowerSwitchFullSwitchLightSwitchFeatureExternal metadata (XML, XMP, JDF) andwritable embedded metadataScript expressions and script elementsScript dev

PowerSwitchFullSwitchLightSwitchFlow elementSet hierarchy pathJob dismantlerUngroup jobSplit Multi- jobAssemble jobGeneric applicationExecute commandT

Installing language packsSelecting the desired languageAfter installing the language pack, perform the following steps for each Switch application(des

PowerSwitchFullSwitchLightSwitchFlow elementFile typeSort jobSort files in jobScript elementRecycle binCommunicationFTP receiveFTP sendMail receiveMai

PowerSwitchFullSwitchLightSwitchFlow elementProcessingVarious configuratorsMetadataXML pickupJDF pickupXMP pickupOpaque pickupApago PDFspy configurato

The Switch server runs in the background (without user interface) to execute flows, monitoredand managed by the Switch Watchdog. In normal circumstanc

Thus while Switch server is running without any user logged in, it cannot access mapped drives.You must ensure that all folders and file paths in the

13. Advanced topics for Designing flows13.1 Flow propertiesDescriptionPropertyThe name of the flow as it is shown in the Flows paneNameA description o

DescriptionPropertyIndicates the overall language environment in which Switch is installed;choices are Western and JapaneseLanguageenvironmentThis set

The sender’s reply address for outgoing email messagesReply email addressFTP proxy preferencesIn case your system environment requires FTP connections

DescriptionPropertyIf set to yes, Switch ensures that all files receive a filename extensioncorresponding to the Mac file type and file creator codes

DescriptionPropertyThe time for which newly arrived jobs must be stable before they areprocessed; to avoid picking up an input job before it has beenP

DescriptionPropertyIf set to yes, send an alert when Switch moves a job into a problemjobs folderProblem job arrivesSend an alert if a job takes more

6. Select a new location for the application data root that offers full access rights to the intendedlimited user(s).7. Switch guides you through the

You can move the application data to another location by changing the value of the first preferencein this group.CleanupSome temporary application dat

DescriptionPropertyThe name of the exported files include the Switch server name (seeinternal communication preferences) and the date in the format:“&

DescriptionPropertyThe port used for communication between Switch Designer andSwitchClient Watchdog, in the range of 1 to 65535.Port for Switch Watchd

Show volume paths used by active flowsWhen editing the Volume list, the Show volume paths used by active flows can be used to listall volume paths cur

The primary output of a processor (i.e. the incoming job with any changes applied by theprocessor) retains the same unique name prefix as the incoming

When a Mac OS X user copies a file from a foreign volume to a Mac-specific volume, the systemlooks for a matching “dot-underscore” file. If one exists

Copying filesWhen Switch copies or moves a file under its own control (for example, between two folders), itensures that all available Mac file type i

Brief tutorialRegexps are built up from expressions, quantifiers, and assertions. The simplest form of expressionis simply a character, example, x or

in the regexp. A word boundary is any non-word character such as a space, a newline or thebeginning or end of the string.Characters and abbreviations

MeaningCharacterThe caret negates the character set if it occurs as the first character,that is immediately after the opening square bracket. For exam

Contents1. Copyrights...112. Introduction...

Before you can activate or deactivate licenses, you should set up an activation account usingthe Enfocus website (http://www.enfocus.com/CreateAccount

If we wish to apply a quantifier to more than just the preceding character we can use parenthesesto group characters together in an expression. For ex

MeaningAssertionA word boundary. For example, the regexp \bOK\b means matchimmediately after a word boundary (example: start of string or whitespace)\

The JavaScript programming interface for each application is documented in the application'ssoftware development toolkit which can be found on th

Writing a user scriptTo write a user script, simply provide the JavaScript statements that should be executed in themain body of the script file. If y

DescriptionVariable• The empty string: each output file is moved along the outgoingconnection as a separate job• The desired name of the job folder: a

$error13.7 AppleScript for applicationsIntroductionQuarkXPress can be scripted through AppleScript (a scripting language offered by Mac OS X). TheSwit

There are always five arguments because there is no mechanism to determine how manyarguments are actually needed by the script.Writing an AppleScript

Return value in case of errorReturn value in case of successActionError message starting with"/ERROR/:"The string "/OK/"CommandErr

return scriptResult end runCommand script: reverse page order in a documentTo reverse the page order in a document, specify the following as a custo

end tell close document 1 without saving on error errmsg number errnum set theResultJobPath to ("/ERROR/:" & errms

4. Enter the name and password of your activation account and click Next / Continue.Note:You should have created this activation account in Creating a

14. Advanced topics for running flows14.1 Scheduling jobsObjectives for scheduling jobsThe Switch job scheduler has the following (sometimes conflicti

Maximum concurrent slots forthis categoryTask types in this categoryTask category“Concurrent file transfers”preferenceFTP, MailNetworkWithin each cate

A job priority is a signed integer number (in the range that can be represented with 32 bits). Ahigher number indicates a higher priority. The default

15. Flow element reference15.1 Basic elementsConnectionConnection is a special flow element that serves to interconnect other flow elements. The netwo

DescriptionFlow element typeConsumes jobs from a flow and possibly transports them to anoutside target (such as an FTP site); a consumer does not allo

DescriptionPropertyDetermines the layout of a connection as it is drawn on the canvasCorner angleConsider the rectangle formed by drawing horizontal a

DescriptionPropertyIf set to yes, a file will move along the connection if the originating processlogged at least one errorError outFolderFolder is a

DescriptionPropertywhile a "Folder nn" name is still in place, the flow element automaticallyadopts the name of the backing folderThe path o

DescriptionPropertyDetermines whether the day of the month is relative to “Start of month’”or “End of the month”Relative toIf set to yes, the folder’s

DescriptionPropertyAll subfolders that match the specified folder filter are ignored for thepurpose of counting the number of jobs residing in this fo

3. Select On-line activation and click Next / Continue.4. Enter the product key and click Next / Continue.5. Enter the name and password of your activ

leaving the others in the problem jobs folder. In any case be careful to avoid endless loops ofjobs that fail over and over again.The problem jobs too

• input• hot• watchedConnectionsSubmit hierarchy does not allow incoming connections.Submit hierarchy injects folder filter properties into its outgoi

DescriptionPropertyThe time-of-day window during which to detect jobs; the valuesare structured as "hh:mm" (hours, minutes) indicating a tim

DescriptionPropertyDefines an optional restriction on the parent or ancestors forthe folder in this rule. Options available are:Restriction• None (def

DescriptionPropertyThe number of upper levels for which not to cleanup subfoldersStarting from this levelArchive hierarchyArchive hierarchy is a consu

DescriptionPropertyleaving the prefixes in place avoids overwriting a previously depositedjob with the same nameDetermines what happens when "Str

DescriptionPropertyDetermines how to combine the new segments with the existing hierarchylocation path:Action• Replace: replace any existing hierarchy

ConnectionsJob dismantler injects folder filter properties into its outgoing connections so that it is possibleto include/exclude certain subfolders i

KeywordsKeywords can be used with the search function above the Elements pane.The keywords for the Ungroup job element are:• hierarchy• folder• subfol

Stored valuePrivate data keyThe relative path of this file within the parent job folder<key>.FilePathSplit Multi-jobRelated Adobe InDesign or Qu

3.4 Third-party applicationsInstalling third-party applicationsSwitch interacts with a number of frequently-used third-party applications through buil

Assemble job is a processor that offers various schemes for assembling a job folder from individualjob files.KeywordsKeywords can be used with the sea

DescriptionPropertyprevious assembly was completed; a value of 0 means this optionis disabledDisplayed when Shceme is Arbitrary files or Custom. A job

DescriptionPropertyThe string is used only for the purpose of determining which jobsbelong together; it has no other meaningA job (using Custom scheme

DescriptionProperty• Add version number: add an incrementing version number atthe end of the filename body for the new job ( “2”, “3”, …“9”, “10”, “11

• the input folder can only have one outgoing connection• the connection cannot be set on hold.• the generic application tool can only have one incomi

Execute command is a processor that executes a system command or a console application withthe specified command-line arguments and output mechanisms.

DescriptionProperties• Result next to input job: the command places the output next tothe input job (i.e. in the same folder)• File at path: the comma

15.2 ToolsCompressCompress is a processor that places the incoming file or a job folder into a compressed ZIP archive.All files in a job folder are pl

• ZIP• RAR• MIMEAny files that are not recognized as an archive are passed through the uncompress tool withoutchange.KeywordsKeywords can be used with

DescriptionPropertyThe script expression can be used to determine a passworddynamically, for example based on the sender of the packed dataIf set to y

Installed tabThis tab provides users with the following options:1.A search field2.An Actions button3.A list of all installed configurators4.Search for

Switch metadataThe Merge PDF tool processes a job folder, so Switch metadata is derived from that folder andnot from the individual PDF files.PDF vers

OrderingIncoming filesHowever, because the page index (including the leading zeroes)appears early in the file name, the alphabetical order will putthe

File namingFor each incoming PDF file, the tool creates a job folder that contains the PDF files resulting fromsplitting the incoming PDF file into se

Resulting filesProperty settings• Prefix = "" • Booklet pages 03-04 of 15.pdf•• ...Suffix = " pages[index]-[LastIndex] of[Total]"•

PropertiesDescriptionPropertiesThe priority assigned to each incoming job; jobs with higherpriority are released first; a greater number indicates a h

DescriptionPropertyThis connection receives a job as long as its target folder’s size doesnot exceedthis limit after adding the job; a zero value mean

1.Determine J, the set of eligible jobs, to include all incoming jobs that have fully arrived andthat have waited for at least the delay specified for

PropertiesDescriptionPropertyThe name of the flow element displayed in the canvasNameOutgoing connection propertiesThe following properties are provid

DescriptionPropertyThe absolute file or folder path of the job to be injected (if a fixedfile path is selected, the selected file is included in the e

• suffix• regular expression• regexpConnectionsRename job allows only a single outgoing connection.PropertiesDescriptionPropertyThe name of the flow e

2.An Actions button3.A list of locally stored packs (example: packs that were downloaded but not yet installed,installed packs appear in the Installed

DescriptionProperty(that is, a single digit unless there are many files colliding to the samename)Determines the first rename action taken:Action 1• N

DescriptionProperty• Portable ASCII: printable 7-bit ASCII less those characters that aren’tallowed in filenames on some systemsDetermines the replace

The keywords for the File type element are:• replace• filename• name• extensionConnectionsFile type allows only a single outgoing connection.Propertie

PropertiesDescriptionPropertyThe name of the flow element displayed in the canvasNameDetermines the scheme used to specify a metadata value:Scheme• Di

The keywords for the Sort files in job element are:• remove• add• replace• order• filename• name• extensionConnectionsSort files in job allows only a

DescriptionPropertyDetermines the rename action taken to make files collate:Rename scheme• Add prefix• Add prefix and suppress digits: each digit grou

• PDF files that are not Certified PDFScript elementScript is a flow element that executes a script program specified by the user to process, produceo

PropertiesDescriptionPropertyThe name of the flow element displayed in the canvasNameThe Switch script package to be attached to this script elementSc

DescriptionPropertyare then deleted until the total size of the jobs in the recycle bin isonce again under the limitThe "Save..." properties

• downloadConnectionsFTP receive does not allow incoming connections.FTP receive injects folder filter properties into its outgoing connections so tha

Searching from the Flow Elements paneIf during startup Switch does not detect a third-party application that has been successfullyinstalled, you can t

DescriptionPropertyfor workflows where the input job is replaced by the processingresult, to avoid triggering endless loops.If set to no, the job will

DescriptionProperty•The Folder name used for matching•The Levels, limiting the range of subfolder levels on whichthe rule applies•A Restriction, based

KeywordsKeywords can be used with the search function above the Elements pane.The keywords for the FTP send element are:• Internet• web• FTP• SFTP• ne

DescriptionPropertyIf set to yes, FTP receive transfers files as binary, otherwise ittransfers them as ASCIITransfer as binaryThe login name for the F

Mail receive is a producer that retrieves email messages from a POP3 and IMAP email server (sothat users can access email accounts like Gmail, Hotmail

DescriptionPropertyIf set to "Yes", the tool checks for new arrivals only during acertain time of the day (specified in the subordinate prop

DescriptionPropertyDefines the "key" that is used to select the appropriate emailinfo from the table provided in the next property; the key

Refer to Email message schema on page 319 for details on the format of the generated metadata.Mail sendMail send is a processor (although conceptually

PropertiesDescriptionPropertyThe name of the flow element displayed in the canvasNameThe subject line for the message.SubjectThe list of destination e

DescriptionPropertyIf set to "Yes", the incoming file or job folder is compressed (zipped) andattached to the email message being sent.Attac

4. Click OpenNote:Some configurators do not offer this function.Licensing third-party applicationsYou must legally obtain a valid license and installa

DescriptionPropertyIf set to "Yes", part of a job’s submit information (as configuredwith the next two properties) is added to its hierarchy

Checkpoint is a processor that holds jobs for human intervention. A SwitchClient user with theappropriate access rights can review jobs in a Checkpoin

DescriptionPropertyIf set to yes, SwitchClient displays an extra button that allows theuser to edit and/or replace jobs with a new version (presumably

Picking up client fields as metadataThe Checkpoint tool picks up metadata fields entered by the SwitchClient user when movingalong a job. Specifically

PropertiesDescriptionPropertyThe name of the flow element displayed in the canvasNameThe subject line for the message.SubjectThe list of destination e

DescriptionPropertyThe URL or IP address of the server from which to retrieve emailServer addressA list of accounts (names and corresponding passwords

Reply from userJob identifier: 0044PAction: Accept...Pack jobPack job is a processor that packs a job and its associated metadata for transmission. Th

DescriptionPropertyIf set to "Yes", the output archive contains a copy of the externalmetadata (that is, all datasets) associated with the j

ConnectionsUnpack job supports outgoing traffic-light connections of the following types:• Data success: carries successfully unpacked jobs, with rest

DescriptionPropertyThe list of identifiers already processed is kept for at least thismany daysKeep info for (days)Monitor confirmationMonitor confirm

Some configurators support licensing the corresponding third-party application from withinSwitch through the context menu offered by the Flow Elements

CommentsConnection typeActionWhen a confirmation is received that does notmatch any of the waiting packed data files orthat is corrupt, it is sent alo

The keywords for the XML pickup element are:• metadata• dataset• assetData modelThe metadata source must be a well-formed XML file with any schema. Th

The keywords for the JDF pickup element are:• metadata• dataset• asset• ticket• adticketData modelThe metadata source must be a JDF file conforming to

• Metadata alongside asset• Metadata in job folder asset• Metadata is assetKeywordsKeywords can be used with the search function above the Elements pa

• Interpret the file format’s structure to track down the packet: this guarantees that the correctpacket has been located and it is usually much faste

Additional properties are shown depending on the selected pickup mechanism; see the descriptionof each mechanism for more information.Apago PDFspyThis

• License Apago PDFspy as described in its documentation, using a valid license key obtainedfrom Apago or from an authorized reseller (Enfocus does no

DescriptionPropertyIn/exclude a complete copy of the XMP packet embedded in thePDF file, if any, with the statistics (XMP)XMP packetExport metadataExp

DescriptionPropertyOpaque data model, the original backing file’s filename extensionis used)XSLT transformXSLT transform is a processor that performs

Log job info is a processor that issues a message to the Switch execution log containing the valueof the specified metadata field. It is intended main

When validation of a license key is unsuccessful, a message box appears displaying the messageThis license key is invalid, does not correspond to the

16. Metadata reference16.1 VariablesUsing variablesSwitch allows the use of variables in the values of many text properties and for defining filefilte

Using sample jobsThe variable-related property editors (Defining text with variables and Defining a condition withvariables) offer a mechanism to sele

See Indexed variables on page 296.Basic syntaxVariable nameIn its simplest form, a variable is specified as follows:[Group.Variable]The variable name

DescriptionData typeText stringTextPossibly localized text string (that is, there may be multiple languageversions)Alt TextSwitch always uses the defa

Representation as a text stringDescription of data type/Formatting argumentData typeDecimal floating point representation with thespecified number of

OutputExpressionthe second with a leading zero (00 to 59)ssthe milliseconds without leading zeroes (0 to 999)zthe milliseconds with leading zeroes (00

• Then the value is converted to the data type appropriate for the comparison type (example:string, number, ...); as indicated in the table above.See

Evaluates toText in a property [email protected], [email protected][Job.EmailAddress:Separator=","]The email addresses for this job are

ResultValueArgumentThe first substring that matches theregular expressionRegular expression (use anchors tomatch start or end of string)SearchSee also

SourceType of informationGroupSwitch settings, systemenvironmentClient connection attributes like user name,IP, user roleConnectionDoc groupThese vari

Canvas...37Flow Elements pane...

It is possible though to install and run multiple Switch product flavors in parallel, since eachflavor has its own preferences and application data. F

Photoshop File InfolabelAcrobatDocumentPropertieslabelXMP location pathData typeVariable nameOrigin / Credit IPTCStatus / Providerphotoshop:CreditText

The Mail receive flow element associates this information with the job as a metadata dataset.Refer to Email message schema on page 319 for details on

TIFF tagXMP location pathData typeVariable name0x0112tiff:OrientationIntegerImage.Orientation0x0106tiff:Photometric InterpretationIntegerImage.Photome

Photoshop File Info labelXMP location path (*)Data typeVariable nameIPTC Contact / Creatordc:creator/*[1]TextIptc.CreatorIPTC Contact / Creator’s JobT

Scripting API equivalentData typeVariable nameJob.getExtension()TextJob.ExtensionJob.getFileCount()IntegerJob.FileCountJob.getHierarchyPath()Text Inde

The variale [Job.NestedName:Prefix="-> ",Indent=". "] might be replaced by thefollowing lines:-> My job folder -> . First

ValueArgumentThe name of the external dataset to be accessed, or empty/missing toindicate the embedded datasetDatasetThe data model used for querying

EXIFF tagXMP location pathData typeVariable name0xA408exif:ContrastIntegerPhoto.Contrast0xA401exif:CustomRenderedIntegerPhoto.CustomRendered0x9004 &am

EXIFF tagXMP location pathData typeVariable name--aux:LensTextPhoto.Lens0x9208exif:LightSourceIntegerPhoto.LightSource0x9205exif:MaxApertureValueRatio

Supported forData typeVariable nameAll supported formatsIntegerStats.NumberOfPagesJPEG, TIFF, PNGIntegerStats.SamplesPerPixelJPEG, TIFF, PNGIntegerSta

4. Finding your way around Switch4.1 Switch application componentsSwitch offers its functionality through a number of separate applications, each w

Supported forData typeVariable namePDFIntegerStats.TrimBoxWidthPDFIntegerStats.TrimBoxHeightPDFIntegerStats.ArtBoxWidthPDFIntegerStats.ArtBoxHeightPDF

to “00001”. Next time, it will evaluate to “00002” and so forth. After the counter reaches “99999”it circles back to “00000”.The most recently used va

ReferenceDescriptionFormatExif Version 2.2 specification datedApril 2002 (JEITA CP-3451)A binary format designed to storeinformation about a photograp

Supported file formatsThe following table lists the embedded metadata capabilities for the supported file formats.Image datasynchr.EXIF & IPTCsync

• Locate the primary embedded XMP packet and parse it into an XMP object model; if there isno XMP packet start with an empty XMP object model.• Read t

Picking up metadataSwitch allows permanently associating metadata with a job moving through the flow (by storinga reference to it in the job's in

Scripting APIQuery mechanismDescriptionData modelDataset class, XMLdata modelXPath 1.0expression and/orlocation pathAny well-formed XML file (with orw

Defaultdataset nameData modelPickup toolSourceProfessional configurator (with XMLreport); then XML pickupLogOpaqueAny configurator with outgoing traff

Metadata in job folder assetThe asset (which is always a job folder) is placed in one of the pickup tool’s input folders andthe metadata source (which

DescriptionPropertyA script expression that evaluates to the file or folder path referring tothe asset to be copied (*)Asset pathDetermines whether th

SwitchClientSwitchClient is a light-weight desktop application that allows a user on a different computer tosubmit and monitor jobs. Since it usually

to, cc, and reply-to addresses and the complete email body text. This dataset is then associatedwith the job ticket for all files delivered by the mes

DescriptionData typeElement nameFor FTP, the complete target URL for the jobTextDestinationFor Mail, the list of destination email addressesThe name o

DescriptionData typeElement nameAn indication of the origin of the processed jobbefore it was injected in the flow; for example, aTextJobOriginSubmit

The property editor for editable metadata fields allows creating an ordered list of field definitions(using the buttons under the listbox on the left-

DescriptionPropertyIn case "Data type" is Dropdown list with dynamically generated content,this default value might not correspond with one

fields are grayed-out, except the Show if parent equals ... property, the Read only property andthe Display metadata field property.Behavior of update

DescriptionPropertyThe label shown in front of the fieldLabelA hint displayed when the cursor hovers over the fieldDescriptionThe field’s data type: B

Element is presentDescription of element contentsElement nameIf type is string and ifregexp is not blankA regular expression that matches the valuesal

Location pathsA location path is a sequence of one or more location steps separated by a slash. Each locationstep in turn (from left to right) selects

selects the parent of the context node../@langselects the lang attribute of the parent of the context nodepara[@type="warning"]selects all p

ToolbarThe toolbar is the strip at the top of the workspace offering a number of tool buttons.See Toolbar on page 36 for more details.Panes and viewsT

evaluates to the number of field elements in the document, regardless of their position in thenode treecount(/doc/chapter[5]/section)evaluates to the

XMP location path syntaxAn XMP location path points to a specific node in an XMP node hierarchy (whether the nodeexists or not).An XMP location path i

ExamplesThe following examples address properties in the XMP Dublin Core schema, which is usuallyassociated with the "dc" prefix. Thus these

17. Developing scripts17.1 Using SwitchScripterFinding your way around SwitchScripterTo launch SwitchScripter:• Double-click the SwitchScripter applic

DescriptionWorkspace areaContains tool buttons for the most frequently used functionsToolbarAllows editing the script declaration, defining support fo

DescriptionToolShow or hide the Messages paneMessages paneEditDescriptionToolUndo the most recent text editing operation in the Program pane(supports

The Declaration pane allows viewing and editing the information in the script declaration forthe script package. When you select an item in the Declar

The information setup through the Fixture pane defines a simulated run-time environment forscript testing purposes, including:• The values of the prop

DescriptionPropertyThe absolute path to the file or folder for this input jobFile or folderDefines whether this input job is indeed included in the si

DescriptionPropertyFor traffic-light connections, determines whether this connectioncarries data files or log filesCarry this type of filesFor traffic

The central area that displays a flow design is called the canvas; it is a special pane because ithas no title bar and it can't be moved from its

The Properties pane allows viewing and editing the properties for the currently selected item inthe Declaration pane or in the Fixture pane. The prope

6. Press the "Save" tool button to save your script package with an appropriate name in a locationof your choice.7. Verify the operation of

Script expressionsA script expression is a brief JavaScript program used to calculate the value of a flow elementproperty. Users can enter a script ex

3. Click the "View declaration/fixture pane" tool button to reveal the Fixture pane.4. In the Fixture pane, configure the basic fixture sett

3. In the Fixture pane, configure the basic fixture settings and at least one incoming job toreflect a relevant test scenario. If the script expressio

Load actionPlug-in typePasswordLoads the plug-in with thefollowing changes:Third-partyValid scripted plug-in passwordbut not one of the built-inpasswo

The Switch installer places a number of built-in scripted plug-ins in the appropriate location.Accessing resourcesA scripted plug-in can obtain the ab

The getApplicationLicensing entry point serves to provide feedback about the third-partyapplication licensing state through a context menu on the scri

• Conversely a configurator may define the licenseApplication entry point without defining the“ApplicationLicense” property in case it does not need a

In this option the user enters a license key in a Switch dialog box that is accessed through acontext menu item on the configurator’s icon in the Elem

PanesThe workspace offers the following panes, which can be combined at will in the different viewsDescriptionPaneDisplays and allows interaction with

Stored in exportedflowReference in SwitchStorage modelNameNameIn a private repository (database) controlled bythe third-party application and only acc

Error handlingThe third-party application should clearly document how Switch can discriminate between:• Successful execution versus failure to execute

A Switch configurator can NOT control an application that requires a different folder watched foreach configuration setup.Preferably the third-party a

If this is not feasible, at the very least the encoding used must be well-defined and documented,and it should follow these guidelines:• Text that may

DescriptionPropertyIf set to yes, the script package includes a JavaScript program andthe corresponding tab in the program pane is enabledInclude Java

DescriptionPropertyThe name of the execution group in which instances of this scriptreside; the precise interpretation depends on the selected executi

Script expressionsScript expressions may be evaluated in parallel with each other and with other scripts. Scriptexpressions should not have side effec

serialized mode execution is serialized but consecutive invocations may happen in differentthreads).• The contents of the predefined global script var

Example usageInformation can bepreserved acrossinvocationsInstances insame groupare serializedExecutionmodeControl a command-line application thatis l

DescriptionPropertyThe validation method for the value of this property, which is one of:Validation• None: perform no validation for this property• St

DescriptionPaneAllows managing SwitchClient user names, passwords and accessrightsUsersToolbarThe toolbar is the strip located at the top of the works

Other property editorsThe “Editor 2/3/4/5” properties of a property definition offers the choices listed in the followingtable. Most of these property

Resulting valueProperty editorThe file path to a property set edited by a third-party application; seeexternal property editorExternal editorExtra pro

it is not strictly true for all data types; for example a file path becomes invalid when the targetfile is removed.Properties that contain a variable

Design-time validation requires that the value…Property editorN/A (if the value contains no variables: Is non-empty)Single-line text withvariablesN/A

Run-time validation schemeProperty editorSame as design-time schemeLiteralSame as design-time schemeChoose fileSame as design-time schemeChoose folder

For the first two editors, validation is always performed at design time. For the last two editors,validation is performed at run time (except if the

DescriptionPropertyThe argument string passed to the application when there is apre-existing property set to be edited, after substituting all occurre

18. Scripting reference18.1 Scripting API - IntroductionThe Switch scripting API (application programming interface) provides script elements and scri

AvailabilityDescriptionModuleAll scriptinglanguagesAccessing script flow element properties, includingincoming and outgoing connectionsMoving jobs fro

Identifiers, variables and constantsJavaScript identifiers match the regexp pattern [_A-Za-z][_A-Za-z0-9]*. Identifiers areused for variables, constan

FunctionShown withTool setSee Messages pane inWorkspace overview on page32Allows managing SwitchClientuser names, passwords andUsersaccess rights. All

function y() { return m_y; } function r() { return m_r; }}class ColorCircle extends Circle { var m_rgb; function Colo

with the object they are assigned to, so even though the object (obj in the above example) getsthe property myProperty, it does not mean that other ob

Example:var m2 = mammals[2]; mammals[2] = "gorilla"; var thing = things[2][1]The first statement retrieves the value of the third item of th

Reverses the items in the array. var x = new Array( "a", "b", "c", "d" ); x.reverse(); // x == [ "

the number of items to delete) and there must be no new itemsgiven. var x = new Array( "a", "b", "c", "d" )

// time flies.. var date2 = new Date(); var timedifference = date2.getTime() - date1.getTime();Static Date FunctionThis is a static function that pars

Returns the year using local time. var d = new Date( 1975, 12, 25 ); var x = d.getYear(); // x == 1975getYear( ) : NumberReturns the hours u

Returns the number of milliseconds since midnight on the 1st January1970 using local time. var d = new Date( 1975, 12, 25, 22, 30 ); var x =

Sets the seconds to the specified seconds, which must be in therange 0..59, in local time. The milliseconds past the seconds(optMilliseconds) can also

Number ConstructionNumbers are not normally constructed, but instead created by simple assignment, example:var x = 3.142;Number PropertiesThe maximum

To toggle between large and small icons, choose the appropriate context menu item shown forthe Flow Elements pane.FilteringYou can use the Search fiel

The height of the rectangle.height : NumberThe position of the top of the rectangle. This is defined astop = y.top : NumberThe position of the bottom

Moves the rectangle so that its left property is equal topos.moveLeft( pos : Number )Moves the rectangle so that its right property is equal topos.mov

A regular expression can be set to global either by setting the globalproperty on a regexp object or by specifying a trailing g in the pattern. var

re.pos(1); // returns 6, position of "John Doe" re.pos(2); // returns -1, no more capturesSizeA Size object represents a two-dimensi

String FunctionsReturns the character in the string at position pos. If theposition is out of bounds, undefined is returned.charAt( pos : Number ) : S

Returns true if the string is empty, that is, has a lengthof 0; otherwise returns false.isEmpty() : BooleanReturns a substring containing the length l

• f - format as [-]9.9• g - use e or f format, whichever is the most concise• G - use E or f format, whichever is the most conciseWith 'e',

Returns the arccosine of the given number in radiansbetween 0 and Math.PI. If the number is out of range,returns NaN.acos( number : Number ) : NumberR

Returns a pseudo-random floating point number between0 and 1. Pseudo random numbers are not truly randomrandom() : Numberbut may be adequate for some

Built-in variablesThis is an array of the arguments that were passed to the function. Itonly exists within the context of a function. function sum() a

DescriptionSectionConfigurators for third-party applications for processing jobsConfiguratorsBuilt-in tools for working with metadata, including XMLMe

var h = parseInt( "0xFF" ); // h == 255 var x = parseInt( " 459xyz " ); // x == 459Built-in operatorsJavascript offers

var variable = expression;The assignment operator is used to assign the value of an expressionto the variable.= operatorIt is an error to attempt to a

and the value of the variable and assigns the result to the variable.variable <<= expression;This operator performs a bit-wise left shift on the

operand1 + operand2This operator returns the result of adding the two operands (operand1 andoperand2).+ operatorSee also + string operator.++operand;

These operators provide string functions using operators. Many other string functions are available,see String.str1 + str2This operator returns a stri

operand1 == operand2Returns true if the operands are equal; otherwise returns false.== operator operand1 != operand2Returns true if the operands are n

operand2).operand1 | operand2Returns the result of a bit-wise OR on the operands (operand1 andoperand2).| operator~ operandReturns the bit-wise NOT of

The JavaScript function operator supports closures, for example: function make_counter( initialValue ) { var current = initialValue;

function min() { return this._min; } function setMax( value ) { this._max = value; } function setMin( value ) { this._min = va

Example:class Area { static var count = 0; var _name; function Area( name ) { this._name = name; this.count++ } function destroy() { t

Working with the canvas...76Working with flow elements...

Information displayedRow representsIconFile info; Job infoA job file (*)Folder infoA regular folderFile infoA regular fileFile pane columnsThe rows in

varvar variableName; var anotherVariableName = InitialValue;This keyword is used to declare and optionally initialize variables. If just the variableN

break red; } } }caseswitch ( expression ) { case Value: Statements; break; default: DefaultSta

continuefor ( var i = 0; i < limit; i++ ) { if ( condition ) { continue; } Statements; }This keyword is used within the context

x += 5; if ( x == 50 ) continue; debug( x ); } while ( x < 100 );The example outputs 5, 10, 15, ..., 45, 55, 60, 65, ..., 95.Se

ifif ( expression1 ) { // statements1 } else { // elsestatements } if ( expression1 ) { // statements1 } else if ( expression2 ) { //

If the return statement is followed by an expression (optExpression) the value of the expressionis returned to the caller.Example:function inRange( v,

a break statement and execution "falls through" to case 4. If expr is not 1, "two", 3 or 4 thenthe default case will be matched an

Catch blocks come in two varieties, unqualified and qualified. An unqualified catch block hasthe form:catch ( e ) { /* statements */ }and a qualified

Example:var i = 10; while ( i > 0 ) { debug( i ); i--; }See also continue and break.withwith ( QualifyingName ) { Statements; }This key

CodecA codec (short-hand for "code-decode") specifies the text encoding used to represent a Unicodestring as a sequence of 8-bit bytes. Vari

DescriptionColumnThe date/time the job entered the state currently attached to it, or blank ifthere is none (a state can be attached to a job through

When the codec is set to UTF-8, the utility module does not output a BOM. This is the standardbehavior expected by most applications.When the codec is

Constructs a new byte array by converting a sourcestring with the specified codec; see text encoding.ByteArray ( source : String, codec :String ) : By

If the privateKeyPath argument is missing or null, the private key builtinto Switch is used instead. The resulting signature allows a receiver toverif

DescriptionAccess modeOpens the file in write-only mode; if this flag is used with Append, thefile is not truncated; but if used on its own (or with T

Returns true if it can be assumed that the file has arrived accordingto the heuristic describe above; otherwise returns false. The stabilityperiod is

ImplementationDescriptionModelimmediately and leavethe follow-up to thetimerFired entry pointStatic Text I/O functionsReads and returns the contents o

The fullName of the file, including path, name, andextension.fullName : StringThe name of the file, excluding its path and extension.baseName : String

Deletes the file if possible; otherwise throws an exception.remove()Member Text I/O functionsReads one character from the file if possible; otherwise

DescriptionFilterSpecList directories onlyDir.DirsList files onlyDir.FilesList disk drives onlyDir.DrivesDo not list symbolic linksDir.NoSymLinksList

DescriptionSortSpecSort case-insensitivelyDir.IgnoreCaseStatic propertiesThe current directory.current : StringThe home directory.home : StringThe roo

FilteringYou can use the Search field on top to filter the Flows. See Filtering on page 48ActionsThe Actions drop-down list contains all the items tha

A hasArrived() function often returns only after a delay of at least the stability period. Howeverif it can be determined right away that the file has

Contains the canonical path, i.e. a path without symbolic links orredundant "." or ".." elements.canonicalPath : StringTrue if the

Deletes the directory dirName if possible; otherwise throwsan exception.rmdir( dirName : String )Deletes this directory if possible; otherwise throws

Static functionsExecutes command synchronously and passes stdin to itsstandard input if specified. When the program ends its outputexecute( command :

Contains the exitStatus of the program when it has finished.This property is read-only.exitStatus : NumberMember functionsTries to run a process for t

Writes the data buffer to the standard input stream of this process.The process may or may not read this data.writeToStdin( buffer :String )Closes the

18.4 XML moduleNode classNode is the abstract base class for the Document, Element, Text, and Comment classes. A Nodeobject represents a node in the X

Evaluates an XPath 1.0 expression in the node’s contextand converts the result to a numeric value with theXPath 1.0 number() function.evalToNumber( xp

Child nodesA Document can directly contain any number of Comment nodes (including the XML declaration,which if present is always the first node of the

Creating new objectsReturns a new empty prefix map object.createEmptyMap( ) : MapReturns a new prefix map object that already contains allmappings tha

DescriptionGroupFlowThe flow can’t be activated because it contains a designerrorThe flow is being activatedThe flow is active, i.e. it is being execu

Returns the list of child nodes of this element, indocument order or an empty list if the element has nochild nodes.getChildNodes( ) : NodeListReturns

Text contentReturns the text content of this node.getValue( ) : StringComment classA Comment object represents an XML comment node.Comment inherits fr

Returns the item in the list at the specified (zero-based)index. If the index is out of range, the function returnsnull.getItem( index : Number ) : No

Static FunctionsInitiates a remote procedure call (RPC) or sends an XMLmessage to a SOAP HTTP endpoint, waits for the endpoint toreply (synchronous pr

An exception is thrown if the request object does not conform,when the SOAP endpoint returns a SOAPFault or when there is afailure from the underlying

save attachment to the disk filesaveAttachment(index : Number, file-path :String) : BooleansaveAttachment(id : String, file-path : String) :Booleanset

DescriptionParameterOne of “PasswordText” or “PasswordDigest”.passwordtypeQualified namesIn the request object, a qualified name is specified as a str

DescriptionPropertyThe SOAP type (as a qualified type name) that will be used for the valuewhen generating the SOAP message; this is useful when a dat

CommentsJavaScript typeSOAP typeDatexsd:dateTimeSingle-dimension arrays onlyArraySOAP-ENC:ArrayAll items must have the same data type, which mustbe bo

• data-codec: affects STRING and BINARY data fields when retrieved as a string.The codecs established with the connect() function are used for all Sta

Folders paneThe Folders pane serves to browse folders (not files) in the local file system and allows draggingbacking folders to the canvas.You can us

Algorithm to determine codecItemspecifies a data-codec other than UTF-16, use that codec. Otherwise uselatin-1DataSource classBackgroundODBC (Open Dat

A disconnected data source can be reconnected by callingconnect().Switch automatically disconnects a data source when exiting theentry point in which

Executing SQL statementsExecutes the specified SQL statement on the associated data source,and stores the results.execute( sql : String ): BooleanRetu

• BINARY: character string in unknown encoding, or binarydata, or unsupported data typeReturns the size in bytes needed to store the data in the speci

Supported conversionsBinaryStringDateNumberColumn datatypeNot supportedDecimalrepresentation ofthe numberNot supportedStraightforward (*)INTEGERNot su

This entry point is invoked each time a new job arrives in one of theinput folders for the script element. The newly arrived job is passedto the entry

Returns true if the value of the specified property is deemedvalid, false otherwise.If this entry point is absent, it is considered to return false.In

plug-in these entry points are never invoked. See also creating a scripted plug-in, configuratorguidelines and detecting third-party applications.Is i

The entry point returns true if initialization was successful and false if itis not able to initialize appropriately. In the latter case Switch marks

between the regular functions and the cleanup function is possible through the global dataaccess functions of the Environment class, but this is restr

New messages are continuously added to the list while Switch is operating. Warning and errormessages are shown in color.Type search strings in the fil

DescriptionDisplay typeNumeric typeA formal message that marks the completion of a task for whicha start message was previously issuedEnd6An informati

Maintaining global dataThe data accessed by these functions is stored in a global repository that is part of the persistentstate of the flow execution

Releases the current global data lock, if any. Does nothing if thereis no current lock.unlockGlobalData( )Switch automatically releases the current lo

multiple licenses are activated, the license with the longest licensetime period is used.Returns the name of the currently active language preference,

Mac OS X automatically adds an entry to its application databasewhen an application bundle is installed or copied to the system.Thus on Mac OS X the f

Returns an absolute path tofolderIDThe resource folder is intended for use byscripted plug-ins (see creating a scriptedplug-in) and should not be used

This function does not differentiate between prerelease and releasebuilds.This function was introduced in Switch 08 update 6. If a script maybe hosted

provides a list of passwords for opening password-protectedarchives.Returns true if successful, false if not (in which case anappropriate error messag

Client connectionReturns the valid ClientConnection object if the script code is executed inthe context of a client connection, otherwise null is retu

Returns a list of Connection instances representing the incomingconnections forthe flow element associated with this script. The listgetInConnections(

For more information, see Viewing processes on page 111.Properties paneThe Properties pane shows all properties for the selected flow in the Flows pan

instead. If the argument is null or missing, and there is no current job,and the property value is non-static, this function returns null.Returns the

Returns a list of Job instances representing all of the jobs currentlywaiting in the input folders for the specified incoming connection. Samesemantic

because it is waiting for an external event, can invoke this functionat regular intervals to determine whether it should abort its operation.Connectio

for an outgoing connection) as displayed in the canvas; this may bean empty string.Accessing injected propertiesThe connection class offers the same f

• Create the output(s) in the temporary location.• Call one of the sendTo functions for each output.If the incoming job is passed along without change

A file matches if its filename extension and/or its Mac file type(after conversion) match the specified filename extension. A foldermatches if any of

To successfully complete processing of a job, the script must call exactly one sendTo() functionfor each generated output file/folder (i.e. there may

• One of the temporary paths returned by Job.createPathWithName/Extension().• A file inside a folder located at one of the temporary paths, which is u

Sends a file/folder to all outgoing connections with a file filterthat matches the file/folder being sent. If there is no suchsendToFilter( path : Str

LoggingSwitch automatically issues the appropriate log messages when a script invokes the one of theJob.sendTo() or Job.fail() functions. A script can

For more information, see Working with properties on page 85.Activity monitorSwitch offers five panes to monitor activity/ manage workload. These are:

The update functions do not affect jobs that have already been sent (by calling one of theJob.sendTo() functions). They do affect any jobs that will b

has been held in some location for a long time, to avoid thatthe job would be unduly processed before other jobs.Managing external metadata datasetsTh

• A read-only dataset if the “writable” argument is set to false or if Switch does not supportupdating metadata for the file format of the backing fil

Returns the most recent Occurrence instance of the specifiedtype associated with the job, or null if there is no suchgetMostRecentOccurrence( type: St

missing, null or the empty string, the user’s default system font locationis used instead.Undoes the effect of any prior invocations of activateFonts(

Returns the name of the flow element (as displayed in the canvas)causing this occurrence.getElement( ) : StringReturns an indication of the origin of

Note:This function returns the localized message derived from the operationattribute and the relevant message arguments using the algorithmused for lo

With the default prefix map the query expression can use any of the prefixes that occur in thebacking file. While this is certainly not according to t

Creating prefix mapsReturns a new empty prefix map object.createEmptyMap() : MapReturns a new prefix map object that already contains all mappings tha

Result data typesThe value of an XPath expression can have several data types (a node set with several elements,the text value of an attribute, a numb

For more information see Activity monitor and workload management on page 114.Users paneThe Users pane allows managing the access rights of users acce

Generic XPath queryingThe JDF data model implementation offers two types of query mechanisms. The first mechanismallows evaluating an arbitrary XPath

into a single string. Leading and trailing whitespace isremoved. Whitespace including linebreaks may occur in thebody of the string.Same as getString

Returns true if there is a structure property at theXMP location path.hasStruct( xmp-path : String, prefix-map :Map ) : BooleanReturns true if there i

a "generic" language that may be used if there is no specific language match. The genericlanguage must be a valid RFC 3066 primary subtag or

• When the entry point in which the dataset was created returns.Setting leaf valuesThe set functions described below set the value of a leaf property.

modified. If the array only has 1 existing item (which is not x-default),an x-default item is added with the given value.If the selected item is from

Removing propertiesRemoves the property at the specified XMP location pathand the complete sub-tree rooted at the property. If theproperty does not ex

matches if its filename extension and/or its Mac file type(after conversion) match the specified filename extension.This function does not examine the

DescriptionFilename extensionQuickTime movieMOVMP3 soundMP3Adobe PDF (Portable Document Format)PDFPNG imagePNGAdobe PostScriptPSAdobe PhotoshopPSDTIFF

Returns the requested statistic as a date-time.getDate( query : String ) : DateData type conversionsDateBooleanNumberStringStatistic datatypeInterpret

The set of items shown in the list adjusts with each keystroke in the search field, showing onlyitems that satisfy the search term(s).If the search fi

DescriptionSupported forData typeStatistic nameThe name of ICC color profile used, if anyJPEG, TIFF,PNGStringICCProfileA list of the names of all colo

DescriptionSupported forData typeStatistic nameThe method used to protect thedocument; possible values: "None","Password", "C

DescriptionData typeStatistic nameThe contents of the PDF/X version key in the document,or the empty string if there is no such key; one of thefollowi

DescriptionData typeStatistic name• CompositeCP2 data modelThe CP2 data model (part of the metadata module) describes a class that inherits all functi

It is perfectly valid however to access any other XMP metadata (i.e. unrelatedto Certified PDF 2) using the regular XMP access functions on the CP2 da

(not counting any sessions automatically added while obtaining thedataset); returns false otherwise.If hasValidSignature() returns true, hasPreviousSe

Note: After implementation, the scripting API should remove any PDF objectsassociated as private data with removed or stripped sessions or with remov

Certificates other than those associated with the active session cannotbe updated. It is possible however to completely remove any certificate.Note:

class properties). Such a class may need to be implemented within thetoolkit (so that special hacks can be applied).Removes the certificate at the spe

ExposurePropertyObjectNot exposedCP2:session_idCP2:start_byteSessionCP2:user_id_refRead-onlyCP2:start_timeCP2:end_timeSessionRead-onlyCP2:tool_idCP2:t

Scripted plug-in...13810.3 Scripting languages...

Distribution and licensingSwitchScripter is part of the PowerSwitch product and is automatically installed as a separateapplication by the PowerSwitch

zones must be added. Adding an editing zone to a session has thefollowing effect on any certificates that are sensitive to that zone:• If the certific

For a CP2 dataset, the “cp2” prefix (with corresponding namespace)is always included in the map, even if the underlying XMP does notcreateDefaultMap(

For each localized property the scripting API offers a getter and a setter workingwith a single string value:Work with asingle value• The getter retur

the complete set of language alternates for each item. Thereturned AltText objects are read-only.Returns the user object referenced by this session (t

Sets the user-supplied comment that describes thechanges to the PDF file during this session (CP2:comment).setComment( value : String )This function s

Returns the human-readable description of thiscertificate’s type and version (CP2:type_desc). ThisgetTypeDescription( ) : Stringfunction returns the E

Returns the human-readable description of the stateof this certificate (CP2:state_desc). This functiongetStateDescription( ) : Stringreturns the Engli

Returns true if this certificate is valid, false otherwise.A certificate in any session other than the activeisValid( ) : Booleansession is valid if a

appropriate setters on an AltText object obtained withgetImplementationDescription().Sets the human-readable description of the statement madeby this

getCountry( ) : StringgetEMail( ) : StringgetPhone( ) : StringgetFax( ) : StringReturns the user-supplied message associated withthis user (CP2:messag

5. Creating and executing a flow5.1 Performing the tutorialIn this tutorial we will build a simple flow in order to demonstrate designing and executin

Recommended forEncodingStorage formStorage typeshort data streamsBinaryBase64 encodedstreambase64longer data streamsBinaryPDF object data stream(i.e.

Places a private data item of storage type “base64” or “ref” in thecollection with the specified tag and contents. If an item with theput( tag : Strin

These helper classes offer functions to access the items in the list, identical to the functionsoffered by the list classes in the flow element module

19. Data Collecting Wizard19.1 Task descriptionThe Data collecting wizard tool helps in collecting data from files which may be required by thesupport

Therefore the tool exists in two places: as a functional part of Designer and also as a standaloneexecutable.The standalone Wizard is called PowerSwit

a.‘Logs’ – Server logs in .db3 file (entire folder "<app_data_root>\logs"). This checkbox isenabled so users can deselect it if requir

Note: Flows are not exported as "sflows" files but as raw data, that is the following foldersare placed as is in the zip package:"<

The Next button is disabled. Exit the Switch application and relaunch the wizard from thestandalone executable and proceed as explained earlier.19.4 R

IndexAActivatingextraclientlicense 22Activationlicenses 21Advanced topics 86, 184alttext class 511AppleScript 139compiled binaries 139extensions 139Ap

Flows (continued)importing 74layout 82library 13locking 72managing 61markers 69metadata 280new 61organizing 68processes 111processing 280properties 70

5.3 Adding the input folder1. Make sure the tutorial flow is selected in the Flows pane.2. In the Elements pane, make sure the "Basics" grou

LLicensing 19, 21, 27, 152, 166, 173, 348activation 21issues 152repairing licenses 173third-party applications 27, 348List classes 511Log job info 288

Rename job 248resultingzippackage 517roles 150Running Switch 16, 18, 19, 29, 181first time 19limited user 18service 181versions 29SScript element 256S

Support 14Switch product family 15Switch server 156, 181Switch User Group 14Switch Watchdog 181SwitchClient 50, 143, 150, 152, 153, 155, 156, 159, 164

Your flow should now look like this:3. We now need to connect our folders. To connect the "Input Folder" and the "PDF Files" folde

7. Click on the "Define File Types" item in the list.The file type editor appears.8. In the file type editor, move the "Adobe PDF (*.pd

The solution to this is to create a "user-managed" folder for our drop folder. This will be a folderon the network (or local computer) in a

If you do not have access to an FTP server you can safely skip this step and go on with the nextstep in the tutorial.1. In the Elements pane scroll do

5.7 Testing the partial tutorial flowNow that we are this far, it is time to test our partial tutorial flow.1. Drop two files on the FTP server, one P

To remove this unique name prefix at the end of a flow, set the strip unique name property forthe final folder to yes.Proceed to the next topic: Deliv

5. Proceed to the next topic: Sending files via email.5.9 Sending the non-PDF files via emailTo finish the tutorial flow, you are going to use two add

13.2 Preferences...184User interface preferences...

All other values can remain set to their default value for the purpose of this tutorialYou have now just created a flow which sends out email messages

6. Managing flows6.1 Creating a new flowCreating a new flowTo create a new flow, follow one of these steps:• Click the Create new flow... tool button;

creates a flow which will allow you to receive files through FTP and/oremail, sort all incoming files in folders based on file type and file namesand

Note: The above dialog box appears only if you had selected "Receive and sort files" for type offlow.Configuring an FTP serverUse this dial

Configuring an email serverUse this dialog box to configure an email account from which you want to receive files.See Mail receive on page 263 for mor

Note: The above dialog box appears only if you had selected "Receive and sort files" for type offlow.Configuring a sorting ruleUse this dia

See Specifying file filters on page 97 for more information on filtering and filename patterns.Sending notificationsThis flow wizard screen allows you

Finishing upThis flow wizard screen displays the summary of all the settings configured so far. Review thesettings and click Finish buttton to create

All flow elements are configured with appropriate property values. Modify and further expandthe flow at will using any of the flow design tools offere

Adding a groupYou can use groups to organize flows into a structure resembling a tree, much like files in a foldertree. A group can contain flows and

Uncompress...237Merge PDF Pages...

1. Select the flows you want to mark.2. Choose the Set marker menu item in the context menu of the Flows pane, and select one ofthe markers in the sub

Adding flows• See Creating a new flow on page 61• See Importing flows on page 74Duplicating flowsTo make a copy of one or more existing flows, select

Click Yes button to delete the flow, or No to retain the flow.Locking and unlocking flowsA flow in the Flows pane can be locked for editing.When a flo

Unlocking flowsTo unlock one or more flows, select the flow(s) in the Flows pane, and perform one of thesesteps:• Choose the Flow > Unlock menu ite

• Choose the Deactivate menu item in the contextual menu of the Flows pane.Importing and exporting flowsFlows can be exported to make a backup or to s

• Double-click the file; this will launch Switch if it is not yet running and import the flow.• Drag and drop the file on to the Flows pane in Switch;

7. Designing flows7.1 Basic conceptsWorking with the canvasThe canvas is the central workspace area that allows viewing and editing flows. The canvasa

When two or more flows are selected, the canvas displays a tile for each flow. A tile is ascaled-down version of the flow design similar to a thumbnai

Editing a flowBefore making changes to a flow:• Ensure that the flow is inactive and unlocked; an active or locked flow is displayed with adarkened ba

Inserting a flow element on an existing connectionYou can insert a flow element on an existing connection, putting the new flow element inbetween the

Doc group...299Email group...

Selecting flow elementsTo select a flow element, click it in the canvas. There is visual feedback to indicate the selecteditem. In the first example s

1. Select the flow element on the canvas (ensure only one flow element is selected)2. Click the flow element name on the canvas3. Enter the new name o

The FTP server address and corresponding login information fields are empty, causing the alerticon to appear. (Switch provides meaningful default valu

After adding a new connection, it is drawn as a straight line between the two flow elements, asindicated in the upper left corner in the above example

When pasting flow elements into a flow, Switch renames the new flow elements if needed toavoid name clashes between backing folders.• To copy one or m

• Choose the Edit > Redo menu item.Working with propertiesProperties paneThe Properties pane shows all properties for the selected flow in the Flow

Pressing the button displays the property editor dialog for the property. For example:Update the fields offered by the dialog box and click Ok button

Select one of the group names in the leftmost list to access the preferences in that group.Individual properties are displayed and can be edited in a

certain level (specified in a property), and injects those files into the flow along its outputconnection(s). The injected files are placed in the out

To inject a job folder in a flow, you need an active flow. Otherwise it will take the folder pathof this folder as its new input folder and will treat

18.1 Scripting API - Introduction...36718.2 JavaScript Reference...

To create a job with (nested) subfolders, you can use the same mechanisms as described abovefor archive hierarchies. See Using hierarchy info on page

• Certain flow design changes (turn off “leave originals”; change backing folder) automaticallyclear the list when the flow is next activated.Configur

See also Working with folders on page 87.Hierarchy location pathThe hierarchy location path (stored in a job's internal job ticket) consists of z

• Proof and Original are configured to add their own folder name at the bottom of the hierarchylocation path.• Archive is configured to accept two sub

This editor allows entering a single set of email info consisting of a list of email addresses anda segment of body text. It is used, for example, for

If the mapping table contains an entry for the special key <all> with non-empty emailinformation, this is added for all jobs regardless of their

subfolder names in the job's nested subfolder path is used as a key in the mapping table. Theemail information for all matches is combined and as

Example flow on receiver’s sideSpecifying file filtersSeveral Switch tools offer file or folder filter properties, including for example:• the "I

DescriptionFilter typeMatches all files and job folders not moved by any otherconnection (see All other files for more details)All other filesA predef

A flow element can have more than one outgoing connection that uses the "All other files" filter.In that case all of these connections match