TIB Sfire Autsvcs UserManual

5/20/2018 TIB Sfire Autsvcs UserManual

1/45

TIBCO SpotfireAutomation Services 6.5

Users Manual

Revision date: 17 April 2014


2/45

2(45) TIBCO Spotfire Automation Services 6.5

Important Information

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USEOF SUCH EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLETHE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THELICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT

LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE ORFOR ANY OTHER PURPOSE.

USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS ANDCONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTEDSOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT,THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURINGDOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED INTHE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT ORCLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE"LICENSE" FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSETERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCEOF AND AN AGREEMENT TO BE BOUND BY THE SAME.

This document contains confidential information that is subject to U.S. and international

copyright laws and treaties. No part of this document may be reproduced in any form withoutthe written authorization of TIBCO Software Inc.

TIBCO and Spotfire are either registered trademarks or trademarks of TIBCO Software Inc.and/or subsidiaries of TIBCO Software Inc. in the United States and/or other countries. Allother product and company names and marks mentioned in this document are the property oftheir respective owners and are mentioned for identification purposes only. This software maybe available on multiple operating systems. However, not all operating system platforms for aspecific software version are released at the same time. Please see the readme.txt file for theavailability of this software version on a specific operating system platform.

THIS DOCUMENT IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND,EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,

OR NON-INFRINGEMENT. THIS DOCUMENT COULD INCLUDE TECHNICALINACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE PERIODICALLYADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BEINCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC.MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/ORTHE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.

Copyright 1996 - 2014 TIBCO Software Inc. ALL RIGHTS RESERVED.

THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED,DIRECTLY OR INDIRECTLY, BY OTHER DOCUMENTATION WHICHACCOMPANIES THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO ANYRELEASE NOTES AND "READ ME" FILES.

TIBCO Spotfire is covered by U.S. Patent No. 6,014,661 and U.S. Patent No. 7, 216,116.Other patent(s) pending.

TIBCO Software Inc. Confidential Information


3/45

TIBCO Spotfire Automation Services 6.5 3(45)

Contents

1 Introduction 4

2 What is Automation Services? 53 How to Use the Job Builder 73.1 The Job Builder User Interface 7

3.2 Creating a Job File 8

4 Job Builder Tasks 104.1 Apply Bookmark 10

4.2 Export Image 11

4.3 Export to PDF 13

4.4 Open Analysis from Library 21

4.5 Replace Data Table with Information Link 22

4.6 Save Analysis to Library 244.7 Send Email 26

4.8 Set Data Source Credentials 28

4.9 Set Credentials for External Connection 30

4.10 Update Text Area Contents 31

4.11 Automated Library Export and Import 324.11.1 Export Library Items 33

4.11.2 Import Library Items 35

4.11.3 Remap Data Sources 37

4.11.4 Remap Information Services Catalogs and Schemas 40

5 Testing the Job File 42

6 Scheduling an Automation Services Job 446.1 Using the Client Job Sender 44

6.2 Configuring the Client Job Sender 44

6.3 Scheduling the Client Job Sender 45


4/45

Introduction


1 Introduction

Welcome to TIBCO SpotfireAutomation Services!

Automation Services is a tool that is integrated into TIBCO Spotfireand makes it possible to run automated server jobs using TIBCOSpotfire. The Automation Services Job Builder is used to set up filesfor executing these jobs.

Note:This user's manual contains information about the functionalityin TIBCO Spotfire Automation Services. For information aboutfunctionality within the main TIBCO Spotfire product, please consultthe TIBCO Spotfire Users Manual.


5/45

What is Automation Services?


2 What is Automation Services?

Automation Services is a tool for running automated server jobs usingTIBCO Spotfire. A job is a set of tasks that should be performed each

time the job runs. Perhaps you want to open an analysis, export avisualization from that analysis, and send an email about it to anumber of co-workers. Opening an analysis, exporting an image, andsending an email are three examples of tasks that can be performed ina job. The tasks included in Automation Services are described in thismanual. However, Automation Services can be extended with tasksother than those included. Your version of Automation Services maytherefore include more than the tasks described in this manual.

A normal workflow in Automation Services is to start by creating ajob file in the Automation Services Job Builder, edit the file to containthe tasks and settings of your choice, and then make sure the job fileworks as expected by running it locally and on a server. When the job

file works the way you want it to, you can configure it to be executedon a regular basis by using a task scheduler. The tasks defined in thejob file will then be executed automatically according to the schedule.The main focus of this manual is on creating and editing a job file inthe job builder, and will only briefly describe how to set up ascheduled job.

A job file is an XML file that you can create and edit in theAutomation Services Job Builder, which can be reached from theTools menu in Spotfire. In the job builder you can select tasks in theorder they should be performed and specify settings for each of thetasks. The image below shows the job builders graphical userinterface, which is described further in How to Use the Job Builderon page 7and Job Builder Tasks on page 10.


6/45

What is Automation Services?


An Automation Services job may be defined in a number of differentways. One common way to set up an Automation Services job is toopen an analysis, save it to the library, and finally send an email withthe updated file to a number of recipients.

Another common way to set up a job file is to start by opening ananalysis from the library, then export an imageone showing salesfigures, for exampleto the web server start page. By setting up thejob to run every night, the start page will be loaded with the latestsales figures every morning.


7/45

How to Use the Job Builder


3 How to Use the Job Builder

3.1 The Job Builder User Interface

To reach the Automation Services Job Builder:

1 Open TIBCO Spotfire.

2 Open the Toolsmenu and select Automation Services Job Builder.

Response: The job builder is opened.

In the job builder, you can create new job files or open and editalready existing ones. Open the Filemenu in the job builder to open afile or to save it. The job builder consists of two parts. The top part iswhere you can add tasks and arrange them in the order in which theyshould be executed. In the example above, seven tasks have beenadded to the task list. The bottom part is where you can adjust the

settings for each of the tasks. In the example, Export Image has beenselected in the list, and in the bottom part of the job builder, thesettings applicable to Export Image are displayed.


8/45

Option Description

File Open this menu to save, open or create a new job

file, or to exit the job builder.

Tools Open this menu to test a file locally or on theserver, or to set a web service URL. From the

Tools menu you can also insert a fielda

timestamp, for examplein a file name or any

text field, such as in an email message.

Add Open this menu and select a taskto add to thejob.

Note:A new task is always added last in the list.

Use the Move Upand Move Downbuttons to

change the order of the list. The order of the tasksin the list determines the order in which they will

be executed.

Note:A job should generally start by opening an

analysis. To learn more about creating jobs in the

job builder, see Creating a Job File on page 8.

Remove Removes the selected taskfrom the job list.

Move Up Moves the selected taskup in the list.

Move Down Moves the selected taskdown in the list.



Top part of the job builder

Bottom part of the job builder

In this part of the job builder you can define settings for the tasks.Select the task you want to change the settings for by clicking on it inthe list. The settings for each available task are described in JobBuilder Tasks on page 10.

3.2 Creating a Job File

The job file is an XML file and can therefore be edited in any texteditor, such as Notepad, but the easiest way to create and set up a jobfile is to use the Automation Services Job Builder.

To create a job file in the Automation Services Job Builder:

1 Open the Automation Services Job Builderfrom the Toolsmenu inTIBCO Spotfire.

2 Select a task from the Addmenu.

Note:Any job containing tasks that interact with an analysis mustbegin with the Open Analysis from Library task. In this task, you


9/45



must click the Loadbutton to load the analysis. Otherwise, the jobwill not work as intended.

3 Adjust the settings for the task in the bottom part of the job builder.

4 Repeat steps 2 and 3 until you are satisfied with the task list andsettings.

5 Save the file to a location of your choice.

To learn more about the different tasks included in AutomationServices, see Job Builder Tasks on page 10.


10/45

Job Builder Tasks


4 Job Builder Tasks

The tasks included in the Automation Services Job Builder aredescribed in this manual. If your version includes other tasks than

those described here, contact your Spotfire administrator to get moreinformation on how to use those tasks.

4.1 Apply Bookmark

You can apply bookmarks to your job files to highlight differentaspects of a data set. You may, for example, have an analysis file withsales data for a department store, and you want the manager for eachof the departments to get a weekly update on their respectivedepartment. If you create one job file for each department in the storebased on the same analysis file, and then apply different bookmarks in

each job file, each manager will get a different view of the analysisfile when the jobs are run.


11/45

Option Description

Bookmark Specifies the bookmark to apply. All the

bookmarks in the analysis are listed in the

dropdown list.

Job Builder Tasks


4.2 Export Image

You can export an image from an analysis file to a destination of yourchoice. If you want to make sure the image is saved as a new image

each time the job is executed, you can use the Insert Fieldoption inthe Tools menu. Place the cursor at the desired location in the filename part of the Destination Path and select Insert Field to add anautomatically updated timestamp to the file name, thus making itunique.


12/45

Option Description

Destination path Specifies the location and file name of the image

to export.

Browse... Opens a dialog where you can specify a file name

and a location for the image file.

Visualization Specifies which visualization to export.

Note: The exported image will only include the

currently visible content.

Width Specifies the width, in pixels, that the exported

image should have.

Height Specifies the height, in pixels, that the exported

image should have.

Job Builder Tasks



13/45

Job Builder Tasks


4.3 Export to PDF

You can export parts of an analysis to PDF, to a destination of yourchoice on the machine running Automation Services. You can choosebetween two different types of PDF export. Either you can exportselected visualizations or pages as they currently appear in theanalysis. Or, you can export based on bookmarks. With bookmarksexport, you can export all the bookmarks of interest, in one singleexport operation and to one single document. Each of the bookmarkswill automatically be applied in turn during the export, and theresulting PDF document will contain one version of the analysis (orparts of it) for each bookmark.If you want to make sure the document is saved as a new file eachtime the job is executed, you can use the Insert Fieldoption in theToolsmenu. Place the cursor at the desired location in the file namepart of the Destination path and select Insert Field to add anautomatically updated timestamp to the file name, thus making it

unique.


14/45

Job Builder Tasks


General Tab

On the General tab you specify what parts of the analysis to export,what to include and you can also define the preferred layout.

Option Description

Destination path Specifies the location (on the machine running

Automation Services) and file name of the

exported PDF file.

... Opens a dialog where you can specify a file nameand a location for the PDF file.

Note:The file will be saved to the machine

running Automation Services, even though the

Save dialog will show folders on your local

computer. Therefore you need to make sure the

folder you select as destination folder actually

exists on that machine, and that you have writing

permissions on the selected folder.


15/45

Job Builder Tasks


Export what Defines which parts of the analysis to export. See

Result from regular PDF export and Result from

export based on bookmarks in the online help,

respectively, for more information about what the

options in this drop-down list mean for the

different export types.Note: If you export bookmarks, then the PDF will

contain one set of PDF pages for each bookmark.

For example, if you export three bookmarks and

select All pages, then you will get a PDF

document containing all the pages in the analysis

times three. That is, one set of all analysis pages

for each of the bookmarks. The descriptions of

the drop-down list options below are based on

regular export where each page or visualization

appears only once in the resulting PDF.

Activevisualization

Exports the active visualization in the analysis (orin the bookmark, for bookmark export) to a single

page in a PDF document.

Note:Tables and trellised visualizations may be

extended to more than one page.

Active page Exports all the visualizations on the active page in

the analysis (or in the bookmark, for bookmark

export) to a single page in a PDF document.

Active page (new

page for each

visualization)

Exports all the visualizations on the active page in

the analysis (or in the bookmark, for bookmark

export) to one or more pages in a PDF document.

Each visualization on the active page will beexported to a new page in the PDF document.



All pages Exports all the visualizations on all the pages in

the analysis. Each page will be exported to a new

page in the PDF document.

All pages (new

page for each

visualization)

Exports all the visualizations on all the pages in

the analysis. Each visualization in the analysis

will be exported to a new page in the PDF

document.



Details-on-

Demand

Exports the Details-on-Demand to one or more

pages in a PDF document. Select the check box

Trellis panels and table rows not visible on screen

if you want to export all the data in Details-on-

Demand, including data that is not visible.


16/45

Job Builder Tasks


Advanced Tab

On the Advanced tab, you can change the graphics settings of theitems you have selected and you can also add headers or footers to theresulting PDF.

Use entire page When exporting to PDF from Automation

Services, this option is not applicable. This is due

to the fact that the exported parts of the analysis

do not have any proportions when the user

interface is not available. Therefore, the result

will always be that the exported parts of theanalysis are redrawn to fill the entire space of the

selected page layout

Include

Visualization title Select whether or not you want the visualization

titles to be included in the export.

Description Select whether or not you want hidden

visualization descriptions to be included in the

export. The description will only be visible for

visualizations where a description has been

entered. If the description is visible in the

visualization or legend, it will automatically beincluded in the export as a part of the

visualization.

Note: A long description may be cut off when

you export to PDF.

Filter settings Select whether or not you want the filter settings

to be included in the export as textual

information. Only the values of the modified

filters will be listed.

Page title Select whether or not you want the page titles to

be included in the export.

Trellis panels and

table rows not visible

on screen

Select whether or not to include non-visible data

in trellis panels and tables in the export. If a table

contains too many rows to fit on one page in the

PDF document, it will be extended to the

following pages. Similarly, a trellised

visualization with many panels will be extended

to the following pages.

Note:Not available if you select to export Active

page or All pages. You must select an option

where each visualization is exported to a new

page.

Options

Page layout Defines the size and orientation of the pages in

the resulting PDF document.


17/45

Job Builder Tasks


Option Description

Graphics settings

Items to export Lists the parts of the analysis that will be included

in the export. The items in the list may refer to

pages, visualizations, or the Details-on-Demand

depending in the selection you have made under

Export what on the General tab.Name Shows the names of the pages or visualizations to

export.


18/45

Job Builder Tasks


Graphics Mode Allows you to change which graphics mode each

item will be exported as: Vector or Raster. This

can be useful if you need to keep the file size

down.

Note: Using raster graphics does not always

result in a smaller file size, but if the file becomesvery large when exporting as vector graphics, you

can try exporting as raster graphics instead.

All Vector Graphics Click this button to set all the items in the list to

be exported using vector graphics.

Note:3D scatter plots are always exported as

raster graphics.

All Raster Graphics Click this button to set all the items in the list to

raster graphics.

Raster graphics

quality (5.0 highest)

Lets you specify the quality of the export for parts

of the analysis that will be exported as rastergraphics. This can be useful if you need to keep

the file size down. You can specify a value from

1.0 to 5.0, where 1.0 is the lowest quality and will

result in a smaller file size.

Note: Using raster graphics will always result in

lower quality than vector graphics, even if you set

the raster graphics quality to the highest possible

value. However, using raster graphics does not

always result in a smaller file size.

Header options

Display pageheader

Select this check box if you want to include aheader on each page in the resulting PDF

document.

Header height Enter a number between 10 and 100 to adjust the

height of the header.

Left, Center, Right Make a selection from the drop-down lists Left,

Center, and/or Rightto specify which positions

to place the header content, and what to include in

the header. The following options are available:

Custom text(enter the text of your choice in the

field below the drop-down list), Page number,

Current date, and Current date and time. Font Settings... Opens a dialog where you can specify font, style,

and size for the header. The current font settings

are displayed to the right of the button.

Footer options

Display page footer Select this check box if you want to include a

footer on each page in the resulting PDF

document.


19/45

Job Builder Tasks


Bookmarks Tab

The Bookmarks tab is only used when you want to export differentviews of the analysis which are defined by selected bookmarks. Whenselecting this option each of the bookmarks will automatically beapplied in turn, and the resulting PDF will contain one version of theanalysis (or parts of it) for each bookmark. See Exporting Bookmarksto PDF in the TIBCO Spotfire online help for more information aboutthe result from export based on bookmarks.

Footer height Enter a number between 10 and 100 to adjust the

height of the footer.

Left, Center, Right Make a selection from the drop-down lists Left,

Center, and/or Rightto specify which position to

place the footer content, and what to include in

the footer. The following options are available:Custom text(enter the text of your choice in the

field below the drop-down list), Page number,

Current date, and Current date and time.

Font Settings... Opens a dialog where you can specify font, style,

and size for the footer. The current font settings

are displayed to the right of the button.


20/45

Option Description

Export selected views

based on bookmarks

Select this check box to enable export to PDF

based on bookmarks. Choose which parts of the

analysis to export on the General tab.

[List of available

bookmarks]

Select the bookmarks you want to export.

Select All Click to select all the bookmarks in the list.

Deselect All Click to deselect all the bookmarks in the list.

Job Builder Tasks



21/45

Job Builder Tasks


4.4 Open Analysis from Library

A job file should generally start with a task that opens an analysis file.The file that is opened is the file that the job is based on, and on whichall the tasks are performed. If you want to use an analysis file that isalready open in Spotfire, you can click Set to Current. If you haveopened a job file that is based on an analysis file that is not currentlyopen you can click Loadto open that file in Spotfire. You can use aconfiguration block to configure the initial state of the analysis filethat you want to open, such as applying a bookmark, or setting a filterto the analysis before it is opened. To learn more about configurationblocks, see Spotfire Technology Network (http://stn.spotfire.com/stn/Tasks/CreatingConfigurationBlock.aspx).

Option Description

Path Specifies the location and file name of the file to

open.

Set to Current Sets the path to refer to the analysis that is

currently open in Spotfire.


22/45

Job Builder Tasks


4.5 Replace Data Table with Information Link

You can replace the contents of a data table with the contents of aprompted information link. You can then set parameters for theinformation link to filter by. For example, you can set it up to showonly the column values that are greater than a specified value, orbetween two values.

Load Opens the analysis that is specified in the Path

field.

Note:If the Open Analysis from Library task

is preceded by the Set Data Source

Credentials task or the Set Credentials for

External Connection task it is not possible toload the file using this button. It is therefore

not possible to edit any following tasks, for

example the Export Image task, either. To be

able to do this, open the file from the File

menu in TIBCO Spotfire before proceeding

with setting up additional tasks.

Browse... Opens a dialog where you can select which file to

open from the library.

Configuration block Optionally, provide a configuration block to

specify the initial state of the analysis. Aconfiguration block is a piece of code that lets you

define which page should be active in the analysis

when opened, for example, or allows you to apply

a specific bookmark.

Example:

SetPage(pageTitle = "Overview");

ApplyBookmark(bookmarkName ="UserRegionOnly");

Note: This is an advanced feature. See Spotfire

Technology Network (http://stn.spotfire.com/stn/

Tasks/CreatingConfigurationBlock.aspx) to learn

more about using configuration blocks.


23/45

Job Builder Tasks


Option Description

Data table to replace Specifies the data table that you want to replace

with an information link.

Information link Shows the path to the selected information link.

Note:The information link must have prompts in

order to be useful. If you want to use

parameterized information links instead, you can

specify that in a configuration block when you

open the analysis from the library. See OpenAnalysis from Library on page 21. To learn

more about using information links, see TIBCO

Spotfire Users Manual.

Browse... Opens a dialog where you can browse to locate

the information link of interest.


24/45

Job Builder Tasks


4.6 Save Analysis to Library

This task saves the analysis to a location of your choice in the library.To save a unique analysis each time the job runs, instead of replacingthe existing one, you can use Insert Fieldin the Toolsmenu. Placethe cursor at the desired location in the file name part of the Save aspath and select Insert Field to add an automatically updatedtimestamp to the file name, thus making it unique.

Information link

parameters

Lists the columns with parameters of the selected

information link.

Edit... Opens the Edit Information Link Parameters

dialog where you can set parameters for the

selected column. See below.

Option Description

Column name Displays the name of the column for which you

are currently editing parameters.

Data type Allows you to set the data type of the column.

Expression Allows you to set the expression that decides how

the column value should be compared to the

values set in this dialog, and thus, how the data

will be filtered.

List of values Lists the values that you want to filter by. The

value you enter here will replace the %Value% inthe selected expression above.


25/45

Job Builder Tasks


Option Description

Save as Specifies the location and name of the file to save.

Embed data in

analysis

Select this check box to embed the data in the

analysis.

Remove any

previously existing

bookmarks

Select whether or not previously existing

bookmarks should be removed when the analysis

is saved to the library. Note that if you select this

check box bookmarks that have been added by

other users will be removed.

Description Optionally, type a description of the analysis.

Keywords (separated

by semicolons)

Optionally, type one or more keywords specific to

the contents of the analysis.


26/45

Job Builder Tasks


4.7 Send Email

A job can be set up to send an email to a number of recipients when itis executed. You can write a message with included images, attach ananalysis, and add links to the web player and library. Below is anexample of an email that was sent in a job.

If you test a job that includes a Send Email task by executing itlocally, some things will not work. To read more about executinglocally and on the server, see Testing the Job File on page 42.

Note:Make sure that the machine and user running the AutomationServices service has access to the SMTP server and that it is notblocked by any antivirus software.


27/45

Job Builder Tasks


Option Description

To Type the email addresses to which the email

should be sent.

Note:You can enter many addresses in the field.

The separator to use depends on the regional

settings of your computer.

Select Click to open a dialog where you can select

recipients from your LDAP directory.

Note:This will only work if you have an LDAP

directory.

Subject Enter a subject for the email in this field.

Message Enter the body text of the email in this field.


28/45

Job Builder Tasks


4.8 Set Data Source Credentials

If you are going to open an analysis or information link requiring datasource authentication, you can specify the credentials to use with thistask. This task should be performed before any Open Analysis fromLibrary or Replace Data Table with Information Link tasks. In orderto secure the login credentials, you must encrypt them using an X.509Certificate. Note that you need to add one Set Data SourceCredentials task for each data source that requires authentication.

Add library link Select this check box if you want to include a link

to the analysis in the library.

Optionally, enter a text for the link in the text field

such as: Click to open analysis from the library.

If you leave the field blank the link will be shown

as the actual path to the library.

Add Web Player link Select this check box if you want to include a link

to the analysis in the web player.

Optionally, enter a text for the link in the text

field, such as: Click to open analysis in TIBCO

Spotfire Web Player. If you leave this field blank

the link will be shown as the actual path.

Attach analysis (with

embedded data)

Select this check box if you want the analysis to

be attached in the email.

Added visualization

images

You can include images from visualizations in the

email. The images will be shown in the messagebody.

Note:The data will be embedded.

Add Open this menu to select which visualization

images to add.

Remove Removes the selected image from the list.


29/45

Job Builder Tasks


Option Description

X.509 Certificate

subject

Select a valid X.509 certificate. This is used to

protect the security of the passwords used to

connect to data sources. The valid certificates that

are installed locally on your computer are listed in

the drop-down list.

Note:The selected certificate must also be

installed on the server that runs the Automation

Services jobs.

Data source Specifies the selected data source.

Browse... Opens a dialog where you can select the data

source to which you want to connect.

Username Specifies the username to use when connecting to

the specified data source.

Password Specifies the password.


30/45

Job Builder Tasks


4.9 Set Credentials for External Connection

If you are going to open an analysis requiring authentication forexternal data sources, that is, any of the Spotfire Data Connectors,you can specify the credentials to use with this task. This task shouldbe performed before any Open Analysis from Library task. In order tosecure the login credentials, you must encrypt them using an X.509Certificate. Note that you need to add one Set Credentials for ExternalConnection task for each credentials profile. The credentials profilesare used to connect a username and password to an external datasource used in a specific analysis.

Option Description

X.509 Certificate

subject



connect to the external data sources. The valid

certificates that are installed locally on your

computer are listed in the drop-down list.



Services jobs.


31/45

Job Builder Tasks


4.10 Update Text Area Contents

If the analysis has text areas, you can set up the job file to change thecontents of these text areas. For example, you can insert time and dateby using the Insert Fieldoption in the Toolsmenu. Place the cursorat the desired location and select Insert Field to add an automatically

updated timestamp in the file name, thus making it unique.

Credentials profile Specifies the name of the credentials profile.

Make sure that the profile matches a profile saved

in the analysis file. The profile used in an analysis

is saved in the Data Connection Properties dialog

in TIBCO Spotfire.

Username Specifies the username for the profile to use whenconnecting to the data source.

Password Specifies the password for the profile.


32/45

Job Builder Tasks


Any new content will completely replace any older content of theText Area.

Option Description

Text area to update Defines which text area in the analysis to change

the content for.

New content Enter the new content for the text area in this

field.

Note:The new content will completely replace

any older content.

4.11 Automated Library Export and ImportYou can create jobs in Automation Services to automate libraryexport and import. This can be useful if you want to migrate yourSpotfire library, in part or in its entirety, from one system to another,such as, from a test environment to a production environment.

Typically, you would need to create and run two job files in order tomove library items from a test system to a production system.


33/45

Job Builder Tasks


The first job exports the library items of interest from the test systemto file. This is done with the job builder task Export Library Items. Azip archive containing the exported library items will be created whenthe job runs.

The second job imports the contents in the zip archive to theproduction system. Usually, you also need to remap the connectionstrings and/or passwords of the data sources during import. Toperform both the import and the remapping in this job, use the two jobbuilder tasks Import Library Items and Remap Data Sources.

The job builder tasks are described in Export Library Items onpage 33, Import Library Items on page 35, and Remap DataSources on page 37respectively.

For more information about exporting and importing the library, andwhat you need to prepare before you attempt this, see SpotfireTechnology Network

(http://stn.spotfire.com/stn/Tasks/AutomatingLibraryExportAndImport.aspx).

Note:The Automation Services tasks that handle Library export andimport take longer to execute than other Automation Services tasks. Itis therefore important that you increase the timeout period of theexport and import tasks before you attempt to run them.See Spotfire Technology Network (http://stn.spotfire.com/stn/Tasks/AutomatingLibraryExportAndImport.aspx) for instructions on how tochange the timeout period.

4.11.1 Export Library Items

The Export Library Items task lets you select from which libraryfolder to export items. The folder and its contents will be saved as azip archive when the job runs. This zip archive will be placed in aspecific folder on a specific machine. This folder is called the SharedDisk Location. In an environment with only one TIBCO SpotfireServer, this folder is by default located on the TIBCO Spotfire Servermachine in the folder /tomcat/application-data/library/. In an environment with more than oneSpotfire Server, one of them is dedicated to hold Library exports. Seethe TIBCO Spotfire Server Installation and Configuration Manualfor more information about how to set this up.

Note: To export a folder and its contents to file you must haveBrowse + Access permissions for the folders you want to export. Youmust also be a member of the Library Administrator group. SeeTIBCO Spotfire Users Manual to learn more about the Library


34/45

Job Builder Tasks


Administrator and permissions.

Option Description

Export from library

folder

Specifies the location and name of the folder toexport from the library.

Browse... Opens the Browse Library dialog where you canlocate the library folder from which you want toexport items. Only available if you are connectedto the library.


35/45

Job Builder Tasks


4.11.2 Import Library Items

The Import Library Items task lets you specify a zip archive to importlibrary items from, as well as a location in the library to import to.You can only import zip archives containing appropriate librarycontent. It is not possible to import a single analysis.

To avoid accidentally overwriting any existing items in the library,before you start importing items we recommend that you read thesection How Are Conflicts Resolved? in TIBCO Spotfire Users

Manual.

Note: In cases where a user opens Automation Service Job Builderto configure Import Library Itemsand selects the option to Includepermissions, the files are moved, instead of copied, from the sourcedirectory. This library import conflict mode behavior results becausethe import task is defined to adhere to keep newconflict resolutionmode and a GUID conflict results in the operation. Since the newestversion is in the target directory, the files in the source directory arediscarded.

Note: When you are importing information model elements, theelements should not be accessed from the library or from Information

Designer until after the import task is complete. If the import takesplace on a server used by others, we recommend either no externalaccess is allowed during the import or that the information model istemporarily imported into a folder with no access permissions forother users. After the import has been performed, the permissions forthe import folder can be changed, or the resulting elements can bemoved to another place in the library.

Note:To import any content into the library from file, you must haveBrowse + Access + Modify permissions for the destination folder and

Export to file Specifies a name for the file that will be created.The file will be saved as a zip archive on theserver. See above for more information aboutwhere the file will be saved.Note:The format of the entire file name will be

fileName.part0.zip. However, you should alwaysspecify the name without file name extensionssuch as .part0 or .zip.Note: To include all the exported items, severalzip archives may be created from one singleexport. The middle part of the file name willreflect this: fileName.part0.zip, file-Name.part1.zip, fileName.part2.zip, and so on.

Export items of type Specify the type of items you want to export if

you want to limit the export to only a certain type.

Include permissions Select whether or not to include the selectedlibrary folder permissions.


36/45

Job Builder Tasks


be a member of the Library Administrator group. See TIBCO SpotfireUsers Manual to learn more about the Library Administrator andpermissions.

Option Description

Import from file Specifies the name of the file to import. The file

must be a zip archive containing appropriate

library content.

Note:The format of the entire file name is

fileName.part0.zip. However, you should always

specify the name without any file name

extensions such as .part0 or .zip.

Note:If the zip archive is located in a subfolder to

the Shared disk location folder you must providethe subfolder name as well. Example:

subfolderName/fileName.

Import to library

folder

Specifies the location and the name of the folder

in the library to which you want to import the

library items.


37/45

Job Builder Tasks


4.11.3 Remap Data SourcesWhen you migrate library items from one system to another, it islikely you will have to remap the connection strings and/or passwordsof the data sources when you import them to the new system. Use theRemap Data Sources task in the same job file as the Import LibraryItems task to achieve this.

Browse... Opens the Browse Library dialog where you canselect the folder in the library to which you wantto import. Only available if you are connected tothe library.

Import items of type Specify the type of items you want to import if

you want to limit the import to only a certain typeof items.

Include permissions Select this check box if you want to include

permissions, if such are stored in the file. If you

do not include any permissions, the imported

items will inherit the permissions of the

destination folder.

Ignore empty folders Select this check box if you do not want to import

any empty library folders.


38/45

Job Builder Tasks


Option Description

X.509 certificate

subject



connect to data sources when exporting and

importing them. The valid certificates that are

installed locally on your computer are listed in the

drop-down list.



Services jobs.

For more information, see Spotfire Technology

Network (http://stn.spotfire.com/stn/Tasks/

AutomatingLibraryExportAndImport.aspx).

Data sources library

folder

Defines the location of the library folder

containing the data sources that need to be

repmapped.

Note:This is optional. However, if you do not

specify a library folder, you must include the

entire path for each data source you add.


39/45

Job Builder Tasks


Browse... Opens the Browse Library dialog where you can

select a library folder. Only available if you are

connected to the library.

Data sources Lists the currently added data sources.

Note:If you have not specified a Data sources

library folder, you must include the entire path foreach data source you add.

Add... Opens a dialog that lets you specify a new data

source. See below.

Edit... Opens a dialog that lets you edit the selected data

source. See below.

Remove Removes the selected data source from the list.

Import... Opens a dialog that lets you select a previously

exported file. All the data sources included in the

file will be added to the list.

Connection string Specifies the current connection string for theselected data source. Enter a new connection

string in the text field to change it.

Reset Resets the modified connection string to the one

that was originally set for the selected data

source.

Password The current password for the selected data source.

Change... Opens a dialog that lets you enter a new password

for the selected data source.

Reset Resets the modified password to the one that was

originally set for the data source.

Option Description

Name Enter a name for the new or edited data source.

In library folder Displays the location and name of the library

folder containing the data source.


40/45

Job Builder Tasks


4.11.4 Remap Information Services Catalogs and

Schemas

When you migrate library items from one system to another, you may

have to remap Information Services catalogs or schemas. Use theRemap Information Services Catalogs and Schemas task to achievethis.Note:You must have Java installed to perform this task.

Option Description

Original export file Specifies the original (input) export file.

Note:Use the path to the file on the server thatwill run the task, not on your computer, if you

have the file there as well.

Remapped export

file

Specifies the remapped (output) data export file.

Note:Use the path to the file on the server that

will run the task, not on your computer.

Add... Opens a dialog where you can enter a new

remapping.


41/45

Job Builder Tasks


Edit... Opens a dialog where you can edit the selected

remapping.

Import... Opens a dialog where you can select a local

version of the original (input) export file and

import the existing catalogs or schemas from it.


42/45

Testing the Job File


5 Testing the Job File

When you have set up a job file, you should always make sure itworks as expected by executing it locally before you run it on a

server. When you have checked that it works both locally and on theserver you can set it up to run regularly with a task scheduler. Beforeyou run the job on a server, make sure you have set the correct webservice URL.

To set the web service URL:

1 Open the Toolsmenu and select Web Service URL....

2 In the dialog that opens, enter the web service URL.

Comment: Normally the URL looks like this: http://servername/SpotfireAutomation/JobExecutor.asmx

You can always check if the URL is correct by pasting it into a webbrowser. You should then see a page like the one below:

If the URL does not work, contact your Spotfire administrator.

To execute locally for testing:

1 Open the job file you want to test locally.

2 Open the Toolsmenu and select Execute Locally for Testing.

Response: If the job does not include the task Send Email, continue tostep 6. If the job includes Send Email, continue to step 3.

3 In the dialog that appears, enter the name of your SMTP host, thenclick OK.

4 In the dialog that appears, enter the sender address, then click OK.

Response: If no Web Player link is included in the email, continue tostep 6. If a Web Player link is included, continue to step 5.

5 In the dialog that appears, enter the name of the Web Player serverand click OK.


43/45

Testing the Job File


6 When the job is finished, click Closein the dialog.

7 Check that all the tasks were executed as expected, and then test thejob on the server.

To execute on server:

1 Open the job file you want to execute on the server.

2 Open the Toolsmenu and select Execute on Server.

3 When the job has finished, check that all the tasks were executed theway you expected before you set it up in a task scheduler.

Running Multiple Jobs Simultaneously

It is possible to run several jobs simultaneously on the server byexecuting several jobs from the Tools menu. When you run a job onthe server the Execution Report dialog is shown, showing you the

progress of the job. To hide this dialog click Run in background inthe Execution Report dialog.

To view the progress of hidden running jobs click the RunningServer Jobsmenu and select the jobs you want to see the ExecutionReport dialog for. If several dialogs are open, it is possible to close allof them by selecting Close All Jobsin the Running Server Jobsmenu.

Note:If any of the jobs are still running when you select the Close AllJobs menu item, or if you close the Automation Services dialog, youwill be prompted on whether you want to close the jobs or not. If youdo, the jobs will still run on the server, but you will not be able to seeif the job executed properly.


44/45

Scheduling an Automation Services Job


6 Scheduling an Automation

Services Job

When you create a job using the Job Builder, the job can either beexecuted immediately, or set up to be executed periodically. The lattermethod uses a tool calledSpotfire.Dxp.Automation.ClientJobSender.exe. This tool is found inthe Automation Services Installer kit, together with its configurationfile Spotfire.Dxp.Automation.ClientJobSender.exe.config. Installthese two files onto any machine that can communicate via HTTP (orHTTPS, if you have set this up) with the Automation Services webserver. The executable file and the config file must reside in the samedirectory.

6.1 Using the Client Job SenderTo use the Client Job Sender, you must have a job file created with theJob Builder. The Client Job Sender takes two arguments whenexecuted: The URL to the Job Executor on the Automation Servicesweb server, and the full path to the job file to be executed.

Example:

C:> C:\Program Files\TIBCO Spotfire\Spotfire.Dxp.Automation.ClientJobSender.exe http://automationservicesserver/SpotfireAutomation/JobExecutor.asmx C:\Temp\jobfile.xml

To run the jobs asynchronously, that is, without waiting for the result

of the job, add asyncat the end of the example above. This can beuseful if you want to run several jobs simultaneously.

Note:When running the jobs asynchronously with the Client JobSender it is not possible to see if the job executed properly.

6.2 Configuring the Client Job Sender

The configuration fileSpotfire.Dxp.Automation.ClientJobSender.exe.config is a standardxml configuration file. It can be used to set the timeout when trying to

connect to the Automation Services web server, and what sort of SSL(HTTPS) errors generated by the Automation Services web server tobe shown, if any.

To configure these settings, open the file in a text editor and find thelines

and


45/45

Scheduling an Automation Services Job


respectively. To make changes, edit value. The timeout is given inseconds, and the SSL errors as a comma separated list.

Example:

and

6.3 Scheduling the Client Job Sender

To schedule a job to be executed with the Client Job Sender, useWindows Task Scheduler. Create a new task that executes the ClientJob Sender, provide arguments to it as described above, and set it torun periodically as needed. For more information about how to usethe Windows Task Scheduler, refer to Microsofts documentation onthe feature.

Documents

TIB Sfire Autsvcs UserManual