Version: Copyright World Programming Limited

Size: px
Start display at page:

Download "Version: Copyright World Programming Limited"

Transcription

1 Version: Copyright World Programming Limited

2

3 Contents Introduction... 5 About This Guide... 5 About WPS...5 Users of SAS Software...6 Getting Started... 8 Workbench Basics... 8 WPS Components Cheat Sheets Concepts Eclipse...13 Workbench...13 Perspectives WPS Perspective Views Help View Project Explorer View Properties View Outline View Output Explorer View Results Explorer View Server Explorer View Editor and Output View Progress View Bookmarks View Tasks View Search View Console View Projects Project Definition File Working with Multiple Projects Workspace Scripts Script Names Working with Multiple Scripts Script Colours and Layout Script Writing and Editing Local History Running a Script Managing ODS Output WPS Server...28 The Default WPS Server WPS Server Environment Analyser Tools Analysis Reports Markers Bookmarks Tasks Context-Sensitive Help Tasks Working with Workbench Views...32 Opening a View Closing a View Resizing a View Moving a View Using a Detached View

4 Using a Fast View Maximise a Window Minimise a Window Restore a Window Working with Perspectives Resetting a Perspective Saving a Perspective Deleting a Perspective Opening a Perspective Closing a Perspective Switching Between Open Perspectives Work the Way You Want Working with Projects Creating a New Project Copying a Project Deleting a Project Closing and Opening a Project Exporting A Project Importing Files or Archive Files Importing an Existing Project Switching to a Different Workspace Migrating Existing Scripts or Projects Migrating from Previous Versions of WPS Migrating from SAS Software Working with Files And Folders Creating a New File Closing Files Creating a New Folder Moving an Object Copying Objects Deleting an Object Renaming an Object Working with Editors WPS Editor Text Editor System Editor Default Editor Working with Scripts Creating a New Script Opening a Non-Project Script Opening a Project Script Getting Help While Writing Scripts Run a Script on the Command Line in Windows Run a Script on the Command Line in a Non-Windows Operating System.. 48 Run a Script Inside the Workbench Restart Server Linking the Active Script with the Project Explorer view Working with Server Connections...51 Creating a New Local Server Connection Creating a New Remote SSH Server Connection Exporting Server Connection Definitions to a File Importing Server Connection Definitions from a File Selecting the Default Server Connection Working with Script Output...55 Working with Logs Working with Listing Output Working with HTML Output Clearing the Results Output

5 Working with Data Sets Analysing Scripts and Language Elements Analysis Restrictions Analyse Mainframe Scripts Analyse Script Compatibility Analyse Language Usage Opening Analysis Reports Navigating Analysis Reports Export Analysis Results to Excel Working with Markers...62 Working with Bookmarks Working with Tasks Working with Local History...64 Compare with Local History Replace with Local History Restore from Local History Local History Size and Duration WPS Tips and Tricks...67 Reference License Key Applying a License Key Viewing Your Applied License Details Preferences...68 Preference Filter General General Local History General Text Editors General Text File Encoding WPS WPS Code Injection WPS Code Templates WPS Data Set Viewer WPS Result Options WPS Syntax Coloring WPS Log Syntax Coloring Backing Up Your Preferences Editing and Navigating Undo and Redo Your Edits Find Navigate Back and Forward Go To Your Last Edit Next and Previous Annotation Server Properties Local Server Properties Remote Server Properties Using ODBC...78 Command Line WPS Configuration Files AutoExec files Welcome Pages...84 Legal Notices Reporting problems

6 4

7 Introduction About This Guide Overview This user guide is intended to help you get started with the World Programming System (WPS). It is designed to guide new users through the user interface of WPS, with which you can create, edit and run scripts (i.e. programs written in the language of SAS). This user guide is not designed to train you in the use of the language of SAS. If you are not familiar with the language of SAS there is a wide range of educational and reference material available from many sources. It is not the intention of this guide to teach you every option within WPS. Once you have worked through this guide you should be sufficiently familiar with the system to write your own scripts and to begin processing and analysing data. Notation Whenever you need to type in code the guide will show it like this: /* Hi - here is some code */ PROC OPTIONS; RUN; About WPS In general this guide will use menu options when suggesting you need to interact with WPS, but there are also toolbar buttons and context-menu ooptions for many of these options. Menu and button options will be shown with a font like this. An example of a menu item could be File --> New --> Project. This means you should click on the menu option 'File', then the option 'New' and then 'Project'. Overview The World Programming System (WPS) fundamentally consists of two components: a Graphical User Interface (GUI)/Integrated Development Environment (IDE) known as WPS Workbench a compiler interpreter. This can be run from the command line (CLI) and is used to execute existing scripts (sometimes referred to as running WPS in batch mode). When using WPS Workbench the compiler is run as a server process (known as WPS Server) and is used to process and execute scripts WPS Server WPS Server provides the ability to read and run scripts. WPS Server cannot be launched directly; it is launched by WPS Workbench during operation. WPS Workbench The GUI/IDE, known as the Workbench, provides facilities to manage, create and edit scripts and then to run scripts with the WPS server. The Workbench uses Eclipse, originally written by IBM and now part of an open source project, as the framework for the GUI. 5

8 WPS Workbench is an extension of Eclipse specially designed to allow users to edit and run programs written in the language of SAS. It is worth noting that WPS intentionally leaves the Eclipse environment open for advanced users to plug-in other third-party tools and facilities for source control, Java development, C++ development, XML editing, and a wealth of other uses. Some of the features mentioned in this guide are actually built-in features of Eclipse, but are referred to as features of WPS for simplicity. WPS not only inherits functionality from Eclipse but also has specially designed features and controls to aid script development and use. WPS and SAS Software WPS supports programming language elements from the language of SAS. This means that programs developed in a SAS software environment may be run, edited, shared and saved in WPS and vice versa. Besides a familiar programming langauage, WPS provides a wealth of other features for Users of SAS Software already familiar with using products from the SAS Institute Inc. Users of SAS Software Overview If you are already familiar with other products related to the language of SAS such as software produced by SAS Institute Inc, you will find that the language support in WPS is familiar. You can expect to find many of the same syntax and options for procedures, formats, macros, DATA Steps, etc. WPS will also provide other recognisable features and objects such as logs, data sets, WORK library, etc. Other features may be new to you, such as the Workbench environment itself and the way it handles, or displays objects. You will find that the Workbench has help and reference material to assist you in migrating to WPS. Compatibility with SAS Software Besides being able to read programs written in the language of SAS, WPS is also able to read and write from and to data files used by SAS software. WPS has a wide selection of library engines to allow you to connect to many leading third-party databases. WPS also uses a proprietary data file format known as WPD. As the default data set library engine, WPD datasets are used for the WORK library. Because it is the native data set library engine to WPS, it has the most complete feature support. For example the WPD engine supports indices. Supported Language Elements WPS does not support every element in the language of SAS. The Workbench has Analyser Tools to help determine if any existing language of SAS programs you have contain unknown or unsupported language elements. Please refer to the help guide entitled WPS Reference for Language Elements for details on the syntax of the language elements that are supported by this release of WPS. Existing Programs in the Language of SAS 6

9 WPS uses the name script to refer to a program written in the language of SAS. To use existing scripts within WPS Workbench, you should refer to the Migrating from SAS Software section in this guide. 7

10 Getting Started Workbench Basics Overview The term Workbench is used to describe the whole desktop development environment. The layout of the Workbench can be changed to suit your preference. These layouts are called Perspectives and they contain different views, editors and control what appears in the menus and tool bars. A perspective can be changed by, for example, moving or removing views, resizing views and so on. The default WPS perspective is depicted in the figure below: WPS uses the concept of Projects to hold the files and folders that relate to each other. For example, you might have a project containing programs still under development, another project for monthly reporting applications, and so on. Projects are folders that are themselves held in a parent folder that is refered to as the Workspace. Views Displayed in the WPS Perspective Project Explorer Displays in a tree structure all the projects in your workspace. It allows you to open files for editing and manages the scripts and other files contained in a project. More about the Project Explorer View Editor and Output Displays the contents of a script and allows you to edit it. It can also display the 8

11 output generated by a script such as data sets, logs, HTML, etc. More about the Editor and Output View Outline Displays either the structure of a script (e.g. globals, data steps, procedures and macros) or log (e.g. errors, warnings) that you have open in the Editor and Output view. More about the Outline View Properties Displays the details of objects like project folders, scripts, libraries, data sets, variables, etc. More about the Properties View Output Explorer Displays in a tree structure the output (logs, HTML output, listing output) generated from running a script. It also allows you to open the output into the Editor and Output view. More about the Output Explorer View Results Explorer Displays in a tree structure links to every ODS item generated to the various destinations (e.g HTML or listing) from running a script. Each individual element can be clicked on to see that particular output in the associated Output view. More about the Results Explorer View Server Explorer Displays in a tree structure the libraries and their contents (e.g. data sets, libnames, etc) that have been used by a script that has been run. More about the Server Explorer View Progress Displays the name of the script that is currently being executed or the names of scripts that are queued up, waiting to run. You can also use this view to stop a script running or to remove queued up scripts. More about the Progress View Console Displays any output produced on standard output or standard error by a remote server locally in the Workbench. More about the Console View Help This view is not open by default. If you need help on any particular item in the user interface, context sensitive help is usually availabe by pressing F1, or by using the Help --> Dynamic Help menu option. Note that once you have navigated away 9

12 from the dynamic help page (identified by the title Related Topics), the help view will no longer dynamically update as you move around the user interface. However you can always get context sensitive help on the current item by pressing F1, or by using the Related Topics link at the bottom of the Help view." More about the Help View WPS Server WPS Components The Workbench also manages a feature known as the WPS Server. This is the engine responsible for executing scripts and generating the resulting output, such as the log, listing output, HTML result files and data sets. The WPS Server also maintains an environment of assigned libraries and filerefs, defined macros and macro variables and so on with which all of the running scripts interact. Objects Managed by the Workbench Projects These are the fundamental unit of organisation for resources you wish to use in the Workbench. Typically you would put related scripts together in a project. For example, you might have a project for applications under development, another for monthly reporting jobs, and so on. Scripts Any program written in the language of SAS is refered to as a script by WPS. You can create and edit scripts using the WPS script editor. This editor uses colour coding to highlight different language elements as well as syntax errors. WPS recognises a script as a file with either the extension.sas or.wps. Log When you run a script inside the Workbench, the information generated is stored in the log file. this file can be viewed, printed and saved from within the Workbench. The log generated by WPS is cummulative and contains the results of each script that has been run since WPS Workbench was launched, the WPS Server was last restarted, or the log was last cleared. Listing Output This contains the printed output from any scripts that you have run. For example, this could be a table of data generated by a PROC PRINT statement in a script. Listing output can be viewed, printed and saved from within the Workbench. The listing output generated by the WPS Server is cumulative and contains the output from each script that has been run since WPS Workbench was launched, the WPS Server was last restarted, or the listing was last cleared. HTML Output These are the physical HTML files that a script is programmed to generate. For example, they could be a series of HTML files that show the results of analysing some data, and that have been generated as a result of an ODS HTML statement in a script. HTML output can be opened and viewed within the Workbench. Managed ODS output As described, the ODS (Output Delivery System) can be used to produce text listing and HTML output. Each script can specify when and where its output is stored but it is also possible to have the Workbench manage the process automatically. The default option is for the Workbench to produce managed HTML output. Libraries 10

13 Cheat Sheets These hold the temporary files, data sets, catalogs, etc that are created as a result of running a script. Data Sets The data generated from running a script is stored in data sets. You can view the contents and properties of a data set through various views within the Workbench. About The Workbench is supplied with tutorials that are known as 'cheat sheets'. They are designed to help you get started with using WPS by introducing you to certain tasks and features. A cheat sheet is laid out as a sequence of steps that you undertake. As you progress from one step to the next, the cheat sheet has a help button that you can select to display a related help topic that discusses or guides you through that particular step. Launching a Cheat Sheet Cheat sheets can be launched either from the Welcome pages or from the Workbench's main menu. Launching a Cheat Sheet from the Welcome Pages: 1. Open the Welcome page by selecting the menu item Help --> Welcome. 2. Select the Tutorials page. 3. From the list of available cheat sheets, click on the one you wish to open. Launching a Cheat Sheet from the Workbench Menu: 1. From the main menu select Help --> Cheat Sheets From the list of available cheat sheets, double click on the one you wish to open. Cheat Sheet Quick Toolbar If you launch a cheat sheet from the Workbench menu (not from the Welcome pages), you will get a quick toolbar of buttons specifically for use with the cheat sheet. If you launch a cheat sheet from the Welcome page, you will not get this toolbar. The buttons available in the cheat sheet quick toolbar and tab are listed below: Collapses all the expanded steps except the current step or expands steps to the last expanded state. Click to toggle between these two states. Allows you to select and open another cheat sheet. If you already have a cheat sheet active, it's completion status is automatically saved and then the new selected cheat sheet is opened. You can only every have one cheat sheet open. Minimize the cheat sheet view. Maximize the cheat sheet view. This button is in the tab of the cheat sheet view and as well as closing the view, it saves the status of the active cheat sheet so that your position is not lost. Starting the Cheat Sheet Each cheat sheet has a sequence of steps that always begins with an Introduction step. When you launch a fresh cheat sheet, the Introduction step is expanded so that you can read a brief description about the selected cheat sheet. To start working with the cheat sheet, select Click to Begin at the bottom of the Introduction step. The 11

14 next step is expanded and highlighted. You should also see action buttons at the bottom of the next step, such as Click to Complete. You can now progress through each step in the cheat sheet. Progressing Through the Steps When you have finished working with a particular step, you should select Click to Complete to move to the next step. The next step is automatically highlighted and it becomes the active step. A check mark appears in the left margin of each completed step. Getting Related Help Information To get detailed instructions or related information for a particular step, select the Open Related Help icon in the upper right of that step. The related help will open in a seperate Help window. Open Any Step You can open any step out of sequence whether it is notby simply selecting its expand marked as completed or icon. Any step opened in this way will not change from its completed or uncompleted state. Also notice that steps after the active step do not have a Click to Complete icon. Click on the Expand/Collapse button at the top of the cheat sheet view to collapse back to just the current active step waiting to be completed. Restarting the Cheat Sheet At any time you can restart from the first step. To do this, first open the first step (Introduction) by clicking on its expand icon and then select the Click to Restart icon at the bottom of that step. Any objects (e.g. scripts, projects, etc) that you have already created are not deleted when you restart a cheat sheet. Completing the Cheat Sheet When you finish the last step in a cheat sheet, it automatically goes back to the first step (Introduction). You can either click on the first step's Click to Restart icon or just close the cheat sheet. Closing the Cheat Sheet You can close the active cheat sheet by selecting the Close icon in the cheat sheet's tab. The active cheat sheet saves its completion status when it is closed so that you can continue where you left off when you next re-open it. 12

15 Concepts Eclipse WPS utilises the Eclipse platform as the basic framework for providing the Workbench user interface. Eclipse is an open-source tool originally developed by IBM. It provides an environment for editing and managing files and tasks. It is designed to accomodate plug-ins to perform specific tasks, such as XML editing, Java Development, source control, etc. WPS Workbench is an example of the Eclipse environment supplied with a suite of plug-ins suitable for editing programs written in the language of SAS and running them with the WPS Server. Because the Eclipse platform can accomodate other plug-ins, WPS Workbench has some features that it does not presently utilise but they are included to allow users to add other Eclipse-based plug-ins and extensions. For more information about Eclipse and other available plug-ins, please visit the web site at Eclipse Features Not Used by WPS Under the Project menu, none of the Build or Clean menu items are used by WPS. The Help --> Software Updates menu item will not retrieve updates for the WPS software. These menu items will only retrieve updates to the Eclipse platform itself or other new or updated third-party plug-ins. Workbench The term Workbench refers to the Integrated Development Environment (IDE). This environment utilises the Eclipse platform as the basic framework to provide the Graphical User Interface (GUI). IDE and GUI can be used interchangeably. The customisable layouts that can be utilised in the Workbench are known as Perspectives. As well as the visible objects that the Workbench manages such as Views and the WPS Components, there are other features that the Workbench handles such as the Local History and WPS Servers. Perspectives The position of available views, windows, menu items, and toolbar buttons displayed and the general layout of the WPS Workbench is known as a perspective. A perspective can be customised to look the way you want by moving, resizing, adding or removing different windows and views. The Workbench allows you to save customised perspectives and to switch between different perspectives. Refer to the Working with Perspectives section in this guide for more details about changing the layout of the Workbench. All available perspectives, including any customised perspectives you save, can be 13

16 opened from the Window --> Open Persepective menu. WPS Workbench is supplied with several different perspectives. Only the perspective is described in this section of the guide because it is the only one designed specifically for use with scripts. WPS WPS Perspective A WPS perspective is specifically intended for the task of creating, managing, editing and running Scripts. This perspective is the default used when you first install WPS Workbench. Its layout is depicted in the figure below. You cannot delete or rename the WPS perspective. However, you can save your own screen layout under the same name, thus replacing the original layout. Noteworthy Features By default, this perspective has the following features specifically for tasks concerned with managing or using scripts: Extra toolbar buttons concerned with running scripts. The WPS main menu item. Views for locating and opening script output files. To Display this Perspective Select the menu item Window --> Open Perspective --> Other... --> Development. WPS Views 14

17 The layout of the items with the WPS Workbench application is known as Perspectives and comprises individual windows that contain one or more views. These views display specific types of information and provide specific functions. Many views also have specific toolbars located in the top right of each view. In the Working with Workbench Views section of this guide you can find out how to add, remove, resize or dock individual views in any position on the Workbench. Help View As you select different views of the Workbench you can automatically display relevant help items in the context-sensitive Help view. To Display this View To add this view to the current perspective, select the menu item Window --> Show View --> Other --> Help --> Help. Alternativly, you can press F1 on your keyboard to open this view. Help View Controls Project Explorer View As you navigate about by clicking on the various links and buttons in this Help view, you will see numerous different controls available: Related Topics: If you follow any of the links in the Help view while it is docked inside the Workbench, ensure you click on the Related Topics link (at the bottom of the Help view) to jump back to the actual context-sensitive page (the start page if you like). Otherwise the Help view will not automatically update as you continue to use the Workbench. Show in External Window: This will open a Help window outside of the Workbench with a contents tree view of all available topics. this external view is not context-sensitive. Show in All Topics: This will syncronise the help topic you are looking at with its position in the contents tree view of all available help topics. Bookmark Document: You can add a bookmark to any help page so you can navigate immediatly to that topic again. All your bookmarks are listed via the Bookmarks link at the bottom left of the Help view. Search:Use this facility to search help for specific keywords. The files and folders that can be edited and managed by the Workbench are displayed in a tree structure in the Project Explorer view. To Display this View To add this view to the current perspective, select the menu item Window --> Show View --> Other --> General --> Project Explorer. The Files and Folders Displayed The main file and folder objects that the Projects Explorer displays are: Open projects 15

18 Closed projects Folders Scripts (i.e. any file with the extension.sas or.wps) Other Files (text or unknown file extensions) Any type of file can be put in a project and listed by the Project Explorer. If your computer system recognises the file type, then the appropriate icon is displayed (e.g. a DOS batch file). Note: The Project Explorer only displays projects that are in your current Workspace. Working with Projects The items in a Project map directly to files within the filesystem of the operating system under the project home directory. For more information about the Workbench tools available for manipulate projects please refer to the Working with Projects section in this guide. Working with Files and Folders For more information about the Workbench tools available for manipulating the various objects displayed in a project, please refer to the Working with Files And Folders section in this guide. Operating System Tools As well as the Workbench's tools, you can use your operating system facilities to delete, cut, copy and paste objects into a project. You may need to use the Workbench's refresh tool to refresh the Project Explorer to ensure that objects manipulated in this way are displayed (right mouse click on the project and from the popup menu, select Refresh). Note: If you do use the operating system tools instead of the Workbench tools, you will NOT have the added benefits that Local History provides. Properties View You can display properties of various objects by using the Properties View. To Display this View To add this view to the current perspective, select the menu item Window --> Show View --> Other --> General --> Properties. Views that Interact with the Properties View If you click on an object in one of the views listed below, you will see the appropriate properties for that object displayed in the Properties view: Project Explorer View Server Explorer View Search View Note: Not all objects in the views listed above have viewable properties. Outline View 16

19 To assist in navigating scripts, logs, listing or HTML output the Workbench displays structural elements contained in these files in the Outline view. If you click on a structural element in this view, the relevant line in the file will be highlighted. Opening or giving focus to a script, log, listing or HTML result file will make the Outline view automatically refresh to display the structural elements that are relevent to the file that has focus. To Display this View To add this view to the current perspective, select the menu item Window --> Show View --> Other --> General --> Outline. Script Structural Elements Opening Working with Scripts will make the Outline view display these structural elements: Global Statement DATA Step Procedure Macro You can control which structural elements are displayed in the script's Outline view. In the quick tool bar at the top of this view you will see the structural elements with a diagonal line through them. These buttons will toggle off and on the relevant structural element in the Outline view. Log Structural Elements Viewing the Log will make the Outline view display these structural elements: An individual log entry and the parent node for errors and warnings Error Warning Listing and HTML Structural Elements Viewing the Listing Output or Viewing HTML Output, will make the Outline view display these structural elements: Procedure that generated some tabular output Tabular output Output Explorer View The output files generated from running a script, are listed by, and can be opened from, the Output Explorer view. Note: To view a hierarchical list of results, grouped by server, please use the Results Explorer View. While the Workbench is open, the output from previous runs is not automatically deleted. In order to clear previous output, you can use the WPS --> Clear Log or WPS --> Clear Results or the relevant toolbar buttons or context menus. 17

20 Alternatively you can use the Restart Server feature. To Display this View To add this view to the current perspective, select the menu item Window --> Show View --> Other --> WPS --> Output Explorer. Output Output items are associated with, and listed underneath the server on which they were generated. The following output items is always shown under each server whether any scripts have been run yet or not: Log output The following output items may be shown under a server if that server has run scripts that have generated output of one or more of the following types: Listing output HTML output Once you run a script that generates output of one of the above types, you will see the related output nodes appear below the WPS server they were generated by. There will only ever be at most one node shown for each type of output under each registered WPS Server. This represents all the cumulative output of that type generated by that particular server. Double clicking on one the output nodes will open the associated output of that type for that WPS server in it's relevant editor. If the output type is anything other than log output then at the same time as the output is opened in the editor, you will also see the individual result elements listed in the Results Explorer View which you can use to navigate the output. Working With Script Output For details about listing, opening, printing or saving the logs or results output please refer to Working with Script Output. Results Explorer View This view contains hierarchical links to all the results from every script that has been executed, grouped by server, since the last time that server was started or restarted Note: To view all output, including the log, please use the Output Explorer View. To Display this View To add this view to the current perspective, select the menu item Window --> Show View --> Other --> WPS --> Results Explorer. Output Once a script is run an entry will appear under the relevant server for every proc that produced output. For example PROC PRINT will produce an entry named "The print procedure." Expand this link to find links to each type of output specified. Output types can be: WPS managed HTML output 18

21 WPS managed Listing output Manually managed HTML output Manually managed Listing output For more information about what WPS managed and manually managed results means please see: Managing ODS Output To change which outputs are produced by default please see: WPS Result Options Working With Script Output For details about listing and opening data sets, please refer to Working with Script Output. Server Explorer View All file references, libraries, catalogs and data sets that have been generated as a result of running a script are listed by, and can be opened from, the Server Explorer view. While the Workbench is open, the file references and library contents from previous runs are preserved. In order to clear the state of a Server, you need to use the Restart Server feature. To Display this View To add this view to the current perspective, select the menu item Window --> Show View --> Other --> WPS --> Server Explorer. Objects Displayed Assuming you have run a script, you should see a simple hierarchy displayed: Server node: The root node that represents the WPS installation were you are running your scripts. This is probably a Local installation of WPS. Libraries: A parent node for individual library items. Library: A collection of catalogs and/or data sets. Catalog: A collection of user defined items such as formats and informats. Data Set: A data file containing numeric and/or character fields. Data Set View: A data set that is created by executing a view in the source data. Numeric Data Set Field: A data set field that contains numeric values. Character Data Set Field: A data set field that contains character values. FileRefs: The parent node for fileref items. FileRef: An individual reference to a file. You may see a library node called WORK. This represents the default temporary library used if one is not specified in a script. If you use the LIBNAME statement in a script to specify your own library name, then you will see a library node with the specified name listed in the Server Explorer view. Working With Script Output 19

22 For details about listing and opening data sets, please refer to Working with Script Output. Properties With the exception of the Libraries and FileRefs nodes, if you select any other item in the Server Explorer view, you will see information about that item displayed in the Properties View. You can also get more detailed properties about certain items in the Server Explorer view. Right mouse click on an item and from the popup menu, select the Properties option if it is enabled (i.e. there are properties available for the selected item). Below are the items that this option works with and the sort of information you can expect to see. Server Properties Software: Information about the WPS software such as the version number. License: Full details about your license key. System Options: The currently applied system options. For more information about this topic, please refer to the Configuration Files section in this guide. Library Properties General: The Name, Engine and Physical Location values together with Readonly and Temporary flags. Members: A table of information about the members of the catalog showing the member name and member type. Catalog Properties Entries: A table of information about theentries in the catalog showing the entry name, entry type and description. General: Name of the catalog. Catalog Entry Properties General: Name, type, description, creation and modification time of the entry. Data Set and Data Set View Properties General: The field count and number of observations. Columns: A table of information about the data set fields including name, type, length, label, format and informat. Editor and Output View When you open any type of file in the Workbench e.g. scripts, logs, output, data sets, text files, etc, they are opened as tabs in the Editor view. The Editor is always open and cannot be closed. However, you can close individual files that are open in the Editor. Because the editor cannot be closed and is always available, the Editor view is not listed under the Window --> Show View menu. It is possible to split the Editor view so that you can view and/or modify two or more files at once. This is useful for comparing contents of two files for example. Once a file has been opened in the Editor you may or may not be allowed to edit (make changes to) it depending on the type of file it is, and how or from where it was opened. 20

23 You cannot edit logs and output files opened from the Output Explorer View. You cannot edit a data set opened from the Server Explorer View. Files opened from the Project Explorer View can normally be edited. You can even select which editor to use when opening the file as discussed in the Working with Editors section of this guide. Progress View When you are Running a Script, it is listed as executing in the Progress view. While a script is executing, there is also a progress indicator displayed in the lower right hand corner of the Workbench. This lower right indicator is displayed regardless of whether you have the Progress view open or not. To Display this View To add this view to the current perspective, select the menu item Window --> Show View --> Other --> General --> Progress. Working with the Progress View For more details about working with the Progress view, please refer to the following sections in this guide Stopping a Run. Bookmarks View You can add Bookmarks on any line inside a script, or indeed inside any file that you can open and edit with the Workbench. To list and navigate between your bookmarks, you need to use the Bookmarks view. Note: This view will list all bookmarks regardless of whether the scripts are open or not. However, it will not list bookmarks from scripts in a closed project. To Display this View To add this view to the current perspective, select the menu item Window --> Show View --> Other --> General --> Bookmarks. Tasks View You can add Tasks (reminders) against any line in a script and associate them with notes and a priority level. To list, update and navigate between any tasks you have added, you need to use the Tasks view. Note: The Tasks view will list tasks regardless of whether the scripts are open or not. It will not list those from scripts in a closed project. To Display this View To add this view to the current perspective, select the menu item Window --> Show View --> Other --> General --> Tasks. Search View 21

24 The results of performing a search are displayed in the this view to open the file right where the item appears. Search view. You can use Console View To Display this View To add this view to the current perspective, select the menu item Window --> Show View --> Other --> General --> Search. Types of Search The main menu option Search --> variety of functionality: Search is a flexible tool that provides a wide Search for a text string contained in any file in any open project in the Workbench. You can use wild cards in the search pattern. Search for files of a certain pattern contained in any open project in the Workbench. Search and replace text contained in any file in any open project in the Workbench. Note: The Search view opens automatically to display the results of a search. The Console view is not currently used if you are only running scripts on a local server. In this situation it will remain blank. It can, however be extremely useful if you are running your scripts on a remote server. In this scenario, all standard output and standard error output produced by the remote server will be echoed into the Console view. An example of it's use could be to run an X statement in your script on the remote server which might be requesting a listing of the contents of a particular directory. In this case the output from running the X statement will be displayed in the Console view. It is also extremely valuable when a remote server fails to start, or terminates abnormally. In this situation error text is typically displayed in the Console view. To Display this View To add this view to the current perspective, select the menu item Window --> Show View --> Other --> General --> Console. Projects As far as the Workbench is concerned, a project is a parent folder that contains other objects such as Scripts, files, folders, etc. This parent or project folder is defined by a project definition file called.project. The items in a Project map directly to files within the filesystem of the operating system under the project home directory. There is no limit to the number of projects you can have open within WPS Worbench or to the number of folders and files a project may contain. Files may also be of any type. 22

25 More information about using files, folders, projects, etc can be found in the Working with Projects section of this guide. All projects belong in a Workspace. You can only work with one workspace at a time within the Workbench but you can switch between different ones as desired. The Project Explorer View is used to display and manage the current workspace and the projects it contains. Project Definition File In the root directory of a project is a project definition file called.project. This file contains information about the project that is used internally by the Workbench. This file is not normally displayed by the Project Explorer View. If you look at the project folder outside of the WPS Workbench, you will see this file. CAUTION: Do not move this file from the root directory of the project folder Do not delete or edit this file Do not copy, move or import this file into another project folder Working with Multiple Projects More than one project can be open at any one time in the Workbench. There are many ways to end up with multiple projects in the Workbench: Creating a New Project Importing an Existing Project Copying a Project Note: You can move, copy, cut and paste items between projects. For more information about using these facilities in the Workbench, please refer to the Working with Files And Folders section in this guide. Workspace The term Workspace refers to the container that holds your Projects. It is possible to use any folder on any drive that your computer can access as a workspace. The workspace must have a physical location. However, projects within a workspace can, but do not necessarily have to reside beneath the parent workspace folder. On Windows, the default location of the workspace when WPS is first installed is your 'My Documents' folder with the following directory structure: WPS Workspaces\Workspace1 On UNIX and linux platforms the default location of the workspace is the directory that your $HOME environment variable is set to, again with the following directory structure: WPS Workspaces\Workspace1 Please refer to the section in this guide called Switching to a Different Workspace to 23

26 see how to change the workspace location. Scripts A script is a program written in the language of SAS. You can create and edit scripts in the Workbench using the WPS Editor. This editor uses colour coding to highlight errors and to help distinguish the various keywords, variables, values etc that make up a program. To assist navigation the Workbench displays the structural elements of a script in the Outline View. Quick Difference Indicators As you modify a script, quick difference indicators automatically appear in the left hand white border of the script. They show that something is different in that line of code from when it was last saved. A change has been made to the line of code. If you hover your mouse over this coloured indicator in the left hand border it will display the section of code as it was before you made the change. A new additional line of code. The position where one or more lines of code have been deleted. Note: When you save a script the quick difference indicators will be cleared from the margin. You can navigate between quick difference indicators in an individual script by using the Next Annotation and Previous Annotation controls. Script Names A script can have any name you desire (subject to your operating system's restrictions) but it must have a file extension of.wps or.sas. Files with either of these extensions are handled the same way by WPS and indicate that the file contains a program written in the language of SAS. When Creating a New Script, the Workbench will automatically suggest a new name but you can type in any name you desire. If you do not specify an extension the script will automatically be created with the extension.sas. Working with Multiple Scripts You can have as many projects open in your Workbench as you like and each of these projects can contain any number of scripts. You can open any number of scripts and other files from the differenent projects in the Editor window. For each script that is open, a corresponding tab is displayed in the top of the Editor window. An open script can be given focus in the editor window by clicking on its tab. Script Colours and Layout 24

27 Colours used to display language elements in a script and various other display and file controls are all Workbench preferences that can be viewed and modified. Colour Coding of Language Elements The colours used to display language elements in a script are controlled by the WPS Syntax Coloring preferences. Script Layout The layout of a script, whether to display line numbers, and indeed a whole number of other display controls can all be user defined. Refer to the General Text Editors section for more details. Script Writing and Editing Although it is possible to open a script with various editors provided with the Workbench, only the WPS Editor will provide features specifically for writing and editing language of SAS programs. Help With Language Elements There are several ways that you can get help while you are creating or modifying a script: Refer to the Wps Reference for Language Elements guide supplied with WPS. This is supplied as a pdf file and also can be accessed from the Workbench menu Help --> Help Contents --> and then selecting Wps Reference for Language Elements from the left hand contents menu of the Help window. Use the context-sensitive help feature to get Dynamic Help for Language Elements, i.e. automatically display a list of relevant topics from the Wps Reference for Language Elements guide. Using Script Content Assist feature to automatically get WPS to finish writing a particular language element. Left Hand Script Border The left hand borders of the Editor view are used to display different features. In the grey border you will see annotations. In the white border you will see the expand and collapse controls for blocks of related language items. The white border is also used to display quick difference indicators. Quick difference indicators are useful for showing you what edits you have made recently to a given line of a script. When you change a line of code a quick difference indicator will appear as a coloured block in the left hand side of the white border to the left of the script editor. If you hover the mouse over this coloured block a popup window will show you what the code looked like before you changed it. Annotations An annotation is a marker displayed in the left hand grey border of a script that is open in the Editor view. The annotations that you may see displayed are: Bookmarks 25

28 Tasks Search results Adding markers and performing searches is described in Markers. You navigate between annotations in an individual script by using the Annotation and Previous Annotation controls. Next Local History The Workbench maintains a manipulated in the Workbench. local history of modifications to scripts or other files Even when you close the Workbench and re-open it the local history is preserved. Copying a script also copies its history but only if you use the copy tools provided by the Workbench. History of Edits Each time you save a file in the Workbench, a snapshot of the current contents of the file is added to the Workbench's local history. If you modify a file outside of the Workbench there will be no record added to the history. This history provides the ability to take any of your current scripts and Compare with Local History or even to Replace with Local History to take the file back to a previous edited version. Each modification in the local history is uniquely represented by the date and time the file was saved. History of Deletions Each time you delete a script or file using the Workbench's facility to Deleting an Object, the edit history of the item being deleted is 'transferred' to the local history of the containing project or folder. This not only allows you to recover or Restore from Local History the item in the project or folder, but also to choose which state from the item's history to restore. Local History Preferences Local History Size and Duration controls how long to keep the local history, how many entries to keep in the history and the maximum file size that can be recorded. Running a Script You can run a script either from inside the Workbench or from a command line outside of the Workbench. However you run a script, they are always executed by the WPS compiler/interpreter. Running Inside the Workbench When you Run a script inside the Workbench you must wait for one script to finish running before you can execute another. The exception to this is if you have registered more than one WPS Server in which case you can have one script running per WPS Server concurrently. The state from previous runs is preserved and so subsequent runs can interact with 26

29 the prior state. Output Explorer view. While the Workbench is open, the output from previous runs is not automatically deleted. In order to clear previous output on a given WPS Server, you can use the WPS --> Clear Log or WPS --> Clear Results or the relevant toolbar buttons or context menus. Alternatively, to clear all previous output and completely clear the state of a WPS Server including emptying the WORK library and deassigning all macro definitions and libraries, can Restart Server. Running Outside the Workbench When you run a script from a command line outside of the Workbench, the WPS compiler/interpreter is invoked directly. The progress or output files generated by running a script this way cannot be seen inside the Workbench unless the resulting files are imported manually into the Workbench. More Information For more details on how to actually run scripts from inside the Workbench or outside from a command line, please refer to Running Scripts. To see how you can list and open the output (i.e. logs, datsets, results, etc) generated from running a script, please refer to Working with Script Output. For details about various preferences that can be specified regarding running scripts, please refer to WPS. Managing ODS Output Once you have run a script that produces some output using ODS you can view the results in the Results Explorer View. The management of which ODS destinations WPS outputs to, and the location of the output generated can either be managed by yourself with explicit ODS statements in your code, or you can leave the Workbench to manage the results automatically. The choice as to whether you want the Workbench to manage ODS output for you or not really depends on whether you require to have complete control of all your output and it's location or not. For example, if the script you are running in the Workbench will be run longer term in a batch environment (depending on your environment see Run a Script on the Command Line in Windows or Run a Script on the Command Line in a Non-Windows Operating System ) then the script itself will have to control the ODS destinations and locations it writes to, otherwise it will not function correctly within the batch environment. In this case you will not want the Workbench to automatically manage results. If you are predominantly working day to day with your scripts in the Workbench in an interactive fashion and are more interested in seeing the results presented nicely and easily in the Workbench, rather than being concerned with where they are generated to, then automatic management will be a useful feature for you. By default WPS controls results automatically, and sets the default ODS destination to HTML. This setting can be changed by modifying the Result Option preference accessible via Window --> Preferences --> WPS --> Result Options. Please see WPS Result Options for details about the settings available for this preference. 27

30 WPS Server In order to run a script (see Running a Script ), the Workbench requires a connection to a WPS Server. The term Server here is used to refer to a server process. The process may be running on the local workstation machine, or may be running on an installation of WPS on a remote machine. There are two basic types of server connections, Local Server Connections and Remote Server Connections. The term Local Server Connection refers to a connection to a server process running on the local machine. With a typical workstation installation of WPS there will be a single local server connection called Local and this server will be started by default when the Workbench is started. Further local server connections can be created if required (see Creating a New Local Server Connection ) or the local server connection can be deleted if required, although the functionality of the workbench may be restricted as a result. Creating multiple local server connections requires no further licensed WPS products and the only restriction on the number of local server connections that can be created is the local machine resources. One reason that you might want to create multiple local server connections is to configure them with different startup options, for example different values of LOCALE or ENCODING. The term Remote Server Connection refers to a connection to a server running on a remote machine. Such a set up will require a licensed WPS server installation on the remote machine. Setting up remote server connections gives the user the ease of use of the Workbench at their local workstation while giving them access to the processing power of a remote server machine. Multiple connections can be made to the same remote machine if necessary in the same way that multiple local server connections can be made. Multiple users can have remote server connections configured to the same machine, with the only restriction being the resources on that machine. Remote server connections can be created by following the steps in Creating a New Remote SSH Server Connection The list of servers that are defined is stored within the Workspace. For convenience, when moving between workspaces, or to share server definitions within a work group server definitions can be exported to an external file (see Exporting Server Connection Definitions to a File ) and imported from a file previously created in such a way (see Importing Server Connection Definitions from a File ). The Server Explorer View will show the list of server connections that are currently defined in the Workbench. Through this view you can define new server connections, edit the properties of a server connection, delete server connections and export and import server connections The Default WPS Server One of the defined servers is always set as the default server. This server is shown in bold in the Server Explorer View. The default server is the one that is acted upon by default when, for example, you run a script using the Run toolbar icon. The toolbar icons Run, Stop, Clear Log, Clear Results and Restart Server and their associated keyboard shortcuts all act on the default server. 28

31 WPS Server Environment The environment maintained by a server is initialised on startup of the server. A typical workstation installation of WPS Workbench will come with a single local server configured that is launched when the Workbench is opened and is terminated when the Workbench is closed down. All libraries, datasets and macro variables are persisent meaning that once assigned during the execution of a script they are available to other scripts that are run during the same workbench session. Log output is cumulative and shows information and any errors from each script that has been run during the current session. It can be cleared using the Clear Log option. Listing output, like log output, is cumulative and shows the results of every script run in the current session. HTML output similarly shows the results of scripts but is not cumulative. Listing and HTML output can be cleared using the Clear Results option. The server utself can also be restarted, using the Restart Server option. This will clear the log as well as any listing and HTML output. It will also delete any temporary files and deassign all libraries, datasets and macro variables etc that may have been set up on the server. Viewing the Output Generated by the WPS Server The Output Explorer View will display all the log, listing output and HTML result files that have been generated. The output. Results Explorer View will display a hierarchical list of listing and HTML The Analyser Tools Server Explorer View will display all the libraries, data sets and file references that are being maintained in the WPS Server environment. The Workbench has tools that can scan existing programs written in the language of SAS. These will generate reports that can help to indicate which of your existing programs written in the language of SAS will run unchanged in WPS, which programs may need some modification, and which programs contain language elements that are vital but not yet supported by WPS. Running Analyses It is possible to analyse single Scripts or multiple Projects containing hundreds of scripts. Even when analysing hundreds of scripts, an analysis report is often generated in less than a few minutes without the need to actually run the scripts or connect to any data sources. Analyse Script Compatibility To determine if your exisitng scripts or projects contain any unsupported language elements. 29

32 Analyse Language Usage To list every single language element that has been used in selected scripts or projects. The analysis will indicate which elements are supported and which are unsupported. You can use the Workbench's code analyser on the Windows platform to Analyse Mainframe Scripts. Whichever method you choose to analyse your existing scripts or projects an appropriate analysis report will be generated and automatically opened in the Workbench. Analysis Reports Markers Script Compatibility Report A script compatibility analysis report contains only details about unsupported language elements used in scripts. It does not report any supported language elements that were used in the script(s). This style of report is generated when you Analyse Script Compatibility. Language Usage Report A language usage analysis report contains details about all language elements of the language of SAS that are used in scripts, i.e. both supported and unsupported elements. This style of report is generated when you Analyse Language Usage. Related Topics: Analysis Restrictions Opening Analysis Reports Navigating Analysis Reports Export Analysis Results to Excel Markers are objects that can be associated with any script. The two types of marker in the Workbench are: Bookmarks Tasks These markers are listed in their respective marker view and also in the left hand margin or gutter of an open script. Bookmarks A bookmark is an anchor that you can specify so that you can quickly navigate back to that point at any time in the future. There is no limit to the number of bookmarks that you can create. Using the Edit --> Add Bookmark menu you can either add a bookmark on a particular line within a script, or against an individual script file listed in the Project Explorer View. For 30

33 lines within a file you can also use the context menu Add Bookmark... from the gutter. You can then list and navigate between all your bookmarks via the Bookmarks View ( Window --> Show View --> Other --> General --> Bookmarks ). You can even jump between bookmarks in different scripts in different projects. If you export a project, the bookmarks are not exported with it. Please refer to the section in this guide called Working with Bookmarks to see how to create, navigate and manage bookmarks. Tasks A task marker represents a reminder about a work item. Against any line within a script you can add a task and associate a short description and priority level of high, normal or low. There is no limit to the number of task marks you can add inside a script. You cannot add a task against an individual script file. You can then list and navigate between all your tasks via the Tasks View ( Window --> Show View --> Other --> General --> Tasks ). The Tasks view also allows you to change priority levels, edit the description and either tick or un-tick the task. You can even jump between task marks in different scripts in different projects. If you export a project, the tasks are not exported. Please refer to the section in this guide called Working with Tasks to see how to create, navigate and manage task marks. Context-Sensitive Help If you encounter a view you do not understand, use the context-sensitive help (ensure the view in question has focus by clicking on it and then press F1 on your keyboard). The Help view will display a short description about the view and list related topics. Leave the Help view open to see information on other Workbench views when you focus on them. Note: After following a link clicking on the Related Topics link (at the bottom of the Help view) returns to the original context sensitive help page. Otherwise the Help view will not automatically update as you continue to use the Workbench. Dynamic Help for Script Writing When you have a script open, the context sensitive help is also able to offer dynamic help about language elements. Either add a new language element to a script or point to an already written element and the Help view will update to show related topics. 31

34 Tasks Working with Workbench Views You can manipulate the individual Windows and Views of the Workbench to create your own customized Perspectives. This section of the guide describes how to manipulate the individual views. Opening a View To open a view in the Workbench: 1. Select the menu option Window --> Show View. 2. To see a complete list of views, select Other... from the drop-down menu. You will be presented with a list of all the available views grouped under category folders. 3. Highlight the view you wish to open. 4. Press the OK button to complete the task. The view you select will open (if it was not already open) and will automatically be given focus. It's opening position in the Workbench will be the same position that it was in when it was last closed. Closing a View Resizing a View Moving a View To close a view that is open in the Workbench: 1. Make sure the view is active by clicking on its tab. 2. Click on the close icon in the tab of that view. With the exception of the Editor and Output view, if you close all the views in a particular window, the window itself disappears and an adjacent window expands to take up the space. You have to re-size a window in order to re-size all the views it contains: 1. Move your mouse over the border between two windows until the cursor changes to the resize icon. 2. Press your left mouse button and keep it pressed while you drag the window border to make it larger or smaller. 3. Release the mouse button to complete the resize operation. You can either move an individual view or you can move an entire window and all the views it contains: To Start Moving an Individual View: 1. Right mouse click on the view's tab to display it's pop-up menu. 2. Select Move --> View. To Start Moving a Window (and all the views it contains): 32

35 Using a Detached View 1. Right mouse click on on any of the view tabs in the window to display a pop-up menu. 2. Select Move --> Tab Group. As you move a view or window, you get options as to where you can place them: To Merge With an Existing Workbench Window: 1. Move the view or window over an existing window until you see the drop icon. If you do not see the drop icon then you cannot merge with the particular window you are over. 2. Click your mouse to merge the view or window you are dragging. To Create a New Docked Window Inside the Workbench: 1. Move the view or window close to a border of an existing Workbench window until you see the cursor point to where it can create a new docked window. 2. Click your mouse and you will create a new docked window. To Create a Detached Window Outside the Workbench: 1. Move the view or window outside of the Workbench and you will see the cursor change to the detach window icon. 2. If you click when you see this icon you will create a new window that is detached outside of the Workbench. You can detach from the Workbench window any individual view into its own window. The exception is that you cannot detach scripts, logs or any other files that open in the editor area of the Workbench. To Detach a View: 1. Make sure the view is active by clicking on its tab. 2. Right mouse click on the tab and from the popup menu select Detached. 3. The view will now appear in its own window above where it was initially docked in the Workbench. 4. You can now move and resize this window as you would any other window on your screen. To Re-Attach a View: 1. Right mouse click on the detached view's tab ( not the window's title bar but the tab inside the window). 2. From the popup menu select the ticked Detached option. 3. The detached view should now revert back to being docked in the Workbench. Note: If you close a detached view, it will still be detached when you next open it. Using a Fast View You can hide a view in the Workbench but still have it available as an icon to open it up when you need it. This is known as a Fast View and its behavior is not the same as just minimizing or maximizing a view. Fast Views can be made of any view except scripts, logs or any other file that is open in the Editor and Output View. To Create a Fast View: 1. Right mouse click on the view's tab. 33

36 Maximise a Window Minimise a Window Restore a Window 2. From the popup menu select Fast View. 3. The view will collapse and appear as an icon in a tab at the edge of the Workbench. The default position is the lower left bottom edge of the Workbench. Note: Any other views that are made into a fast view will also collapse and appear as an icon in the same tab along the edge of your Workbench. To Open a Fast View: 1. Click on the view's icon in the fast view tab. 2. By default, it will open on the left-hand side of the Workbench. Note: The opened fast view will partially hide any other windows or views that are underneath it. Different Ways To Close a Fast View: Method 1: Click on any part of the Workbench other than the fast view. Method 2: Click on the fast view's Minimize icon Method 3: Re-press the view's icon in the fast view tab. To Change a Fast View Back Into a Normal Docked View: 1. Right mouse click on the view's icon in the fast view tab. 2. From the popup menu select the ticked Fast View option. 3. The view should return back to a normal docked view in the Workbench. To maximise a window or view so that fills the entire Workbench either: click on the Maximise button of the relevant window or view double click on the window's toolbar or the view's tab To minimise a window or view: click on the Minimise button of the relevant window or view Please note that minimising a window will collapse it leaving only the tabs of the views it contains visible. It also minimises in its docked position but does not show a tab or icon at the bottom of the Workbench. To restore a window that has been maximised either: click on the Restore button of the relevant window or view double click on the window's toolbar or the view's tab To restore a window that has been minimised either: click on the Restore button of the relevant window or view click on the tab for the relevant window or view Working with Perspectives You can customise any of the supplied Perspectives and save them to create your own. You can also swap between any saved perspectives while you are working. To get the most out customising a perspective, you should also read the section in this guide concerned with Working with Workbench Views to learn how to change the layout and position of individual views and windows within a perspective. This section of the guide describes the various ways you can manipulate perspectives. 34

37 Resetting a Perspective Saving a Perspective Deleting a Perspective At any time you can reset a perspective back to how it was last saved: 1. Select the menu option Window --> Reset Perspective. 2. Press the OK button to confirm you want to reset it. If you have changed the layout of a perspective, you can save it under a user defined name for future use: 1. Click on the menu option Window --> Save Perspective As. 2. You must now give the perspective a name. Either enter a new name or use the name suggested. 3. Press the OK button to continue. 4. (Optional) If a perspective is already saved with the name you have just entered, you will be asked if you want to overwrite it with the new perspective layout. Note: A perspective gets its icon from the one that you had open when you saved it. To delete a perspective: Opening a Perspective 1. Click on the menu option Window --> Preferences. 2. From the left hand tree view on the Preferences window, select General --> Perspectives. 3. From the list of Available perspectives click on the perspective you wish to delete. 4. Select the Delete button to permanently remove the perspective. 5. Click the OK button to close the Preferences window. Note: You can only delete user created perspectives. In other words, you cannot delete a perspective that was supplied with WPS. To open a different perspective: 1. Select the menu option Window --> Open Perspective. 2. To see a complete list of perspectives, select Other... from the drop-down menu. You will be presented with a list of all the available perspectives. 3. Highlight the one you wish to open. 4. Press the OK button to complete the task. When you open a perspective, the Workbench will display its name and icon near the top left (by default) of the Workbench. If you have other perspectives open at the same time, they will be listed in this area also so you can click on them quickly to change between them. Closing a Perspective To close a perspective that is open in the Workbench: 1. If you have more than one perspective open, make sure your Workbench is displaying the one you wish close by clicking on its quick button (the default position of open perspective quick buttons is near the top left). 2. From the main menu select the option Window --> Close Perspective. 35

38 Switching Between Open Perspectives Work the Way You Want If you have more than one perspective open you can quickly switch between them: 1. Locate on your Workbench where the open perspectives are listed. The default position for this list is near the upper left of the Workbench. They are listed with their individual icon and name to the right of the Open Perspective icon. 2. Click on one of the perspectives listed. The Workbench will switch to that perspective. WPS will remember when you next open the Workbench, exactly how the windows and views were arranged, etc, when you last closed it. You do not even have to save a perspective to ensure that this happens. This ensures that your favourite soon as you open the Workbench. perspective is immediately available for you as Working with Projects The Workbench has facilities for managing existing deleting them. Projects and for creating or This section of the guide describes how to use these facilities. Creating a New Project Copying a Project To create a new project: 1. To ensure you can see what happens when you create a new project, make sure you have the Project Explorer view open ( Window --> Show View --> Other... --> General --> Project Explorer ). 2. Select the File --> New --> Project menu option. You will see the first page of the New Project wizard. 3. Expand the General folder and highlight the Project node. 4. Now select the Next button. 5. Enter the new Project name. If the name of the new project is not an existing folder, a new folder will be created. If a folder with the same name already exists, it will be used by the new project. 6. (Optional) If you want to change the default location of the new project, clear the Use default checkbox and specify the new Directory. CAUTION: If you choose a directory outside of the current active Workspace, the project will not physically be contained within the active workspace folder even though it will be the current active workspace that displays the project in the Workbench. 7. Click the Finish button to create the new project. 36

39 You can use the Workbench's Copy and Paste facility to create a new project based on an existing project. For general information about this facility, please refer to the Copying Objects section in this guide. Deleting a Project To delete a project: 1. Ensure you have the Project Explorer view open ( Window --> Show View --> Other... --> General --> Project Explorer ). 2. Right click on the project and from the popup menu select Delete. 3. A message should be displayed, prompting you to select one of the following options: Also delete contents under <project path>: This option will permanently remove the project folder and all its contents from the file system. Do not delete contents: This option simply stops displaying the project in the Workbench. If you use this last option, you can at a later date use the File --> Import --> General --> project in the Workbench. Existing Project into Workspace feature to re-display the 4. Click the Yes button to proceed with the delete. Closing and Opening a Project When you have multiple open projects in the Workbench, you might like to close some projects to make sure you don't accidentaly manipulate the wrong scripts. To Close a Project: 1. Ensure you have the Project Explorer view open ( Window --> Show View --> Other --> General --> Project Explorer ). 2. Highlight the project you wish to close. 3. Now select from the main menu Project --> Close Project. As well as collapsing the tree under the closed project in the Project Explorer view, any scripts or other files that were open in the Workbench's Editor view are automatically closed. To Re-Open a Project: 1. Open the Project Explorer view ( Window --> Show View --> Other --> General --> Project Explorer ). 2. Highlight the closed project 3. select from the main menu Project --> Open Project. Exporting A Project To make a copy or backup of a project and all the files and folders it contains: 1. Ensure you have the Project Explorer view open ( Window --> Show View --> Other --> General --> Project Explorer ). 37

40 2. Highlight the project you wish to export. 3. Select the main menu item File --> Export. The Export window will open. 4. From the Export window, expand the tree under the General node. 5. Select one of the following Export Destination types: File System - Make a copy of your project folder and the files and subfolders it contains. Archive File - Create a single compressed zip file in the export location. The Workbench has the ability to read and write zip files without the need for any additional installed software such as WinZip. 6. Click the Next button. 7. (Optional) You can now select or de-select any files and folders that you wish to export. Because you highlighted a project before you began the export process, this is the one selected for exporting along with all the objects it contains. If you want to change your selection, you could click the Deselect All button to make sure nothing is selected and then in the left hand window, tick the project you want to export and this will ensure that all the objects it contains are selected. Experiment with the other options to select specific files and folders. 8. In the To Directory, use the Browse button to select the location where you want to place the export. 9. Click on the Finish button to start the export process. You now have a backup of our project. Depending on which Export Destination you selected, if you look at the location where you exported too, you can either see a zip file or all the copied files and folders in the project folder. Importing Files or Archive Files To import files from either an archive file (such as a zip file) or from the file system: 1. You need to import into an existing project. If you do not have an existing project you need to refer to the Creating a New Project section. 2. To start the import process, select the main menu item File --> Import. The Import window will open. 3. From the Import window, expand the tree under the General node. 4. Highlight one of the following options: File system: Use this if the files and folders to import are not archived in a zip file. Archive file: Use this if the files and folders to import are archived in a zip file. 5. Click on the Next > button. 6. Now, depending on which option you selected previously, set the From directory or From archive file. Use the Browse button to select the archive file or the location of the folder holding the files you want to import. 7. When you have set the From directory or From archive file, you should see a list of the files and folders that are available to import. Ensure there is a tick next to the objects you wish to import. Tip: You probably do not want to select the parent folder of the files to import, otherwise you will end up with your imported files inside a sub-folder in your new project. Restriction: Do not import a project definition file (.project ), otherwise it will overwrite the one in the project you are about to select in the next step as the 'Into Folder'. 38

41 8. Use the Browse button to set the import Into folder. 9. Click the Finish button to continue. Importing an Existing Project To import an exisiting project into the Workbench: 1. From the main menu select File --> Import. The Import window will open. 2. From the Import window expand the tree under the General node. 3. Highlight the Exisiting Project into Workspace option. 4. Click on the Next > button. 5. Choose one of the following options: Select root directory: Use this if the files and folders to import are not archived in a zip file. Select archive file: Use this if the files and folders to import are archived in a zip file. If the file or folder you just browsed for is a valid project you will see it listed in the Projects section of this panel. 6. Click the Finish button to start the import process. Switching to a Different Workspace To switch to a different Workspace so you can display or create a different group of projects: 1. So that you can see the outcome of switching Workspaces, first ensure you have the Project Explorer view open ( Window --> Show View --> Other --> General --> Project Explorer ). 2. Select from the main menu File --> Switch Workspace --> Other. You will see the Workspace Launcher window. 3. Use the Browse button to select a different Workspace. You will see the Select Workspace Directory window. 4. You can now either select an existing workspace or create a new one. Select an Existing Workspace: If the workspace folder already exists, simply use the tree view to highlight the existing folder. Create a New Workspace: Use the Make New Folder button to create a new workspace folder. You can create a new workspace folder on any drive and/or in any existing directory. 5. Once you have selected which workspace folder to use, click on the OK button to close the Select Workspace Directory window. 6. Click on the Workspace Launcher window's OK button to start the switch. This will cause the Workbench to automatically close and restart with the new workspace. Migrating Existing Scripts or Projects This section of the guide is aimed specifically at users who have existing Projects or Scripts created using either software from SAS Institute Inc. or earlier versions of WPS and want to use these existing objects with the latest version of WPS. Migrating from Previous Versions of WPS 39

42 Introduction Any existing scripts do not need to be modified to work with the latest version of WPS. Typically Projects created with earlier versions of WPS can be opened and used by later versions of WPS without any additional action. Import an Existing Project If you have chosen to use a new Workspace for your new version of WPS. You can access an existing project by pointing WPS Workbench to where it is located. This can be done by using the Import feature. When importing existing projects the files do not need to be moved to the same location as the main project as WPS Workbench keeps track of where all the contained files are located. If you do wish to keep all the files together then a simple copy/paste to the desired location will accomplish this. Now we will discuss the actual import process: 1. If you have the welcome pages open, you should open the Workbench's main working screen. 2. So that you can see the outcome of performing an import, ensure you have the Workbench's Project Explorer view open ( Window --> Show View --> Other --> General --> Project Explorer ). 3. From the Workbench's main menu, select File --> Import. The Import window will open. 4. From the Import window, expand the tree under the General node. 5. Highlight the Exisiting Project into Workspace: option. 6. Click on the Next > button. 7. Now define Select root directory by using the Browse button to point to the existing project folder. If the folder you just browsed for is a valid project you will see it listed in the Projects section of this panel. 8. Click the Finish button to perform the import. You will see the imported project listed in the Project Explorer view. 9. If the imported project was originally created in any release of WPS version 2, then you can jump to the last step that starts (Finished). If the imported project was originally created with a release of WPS earlier than version 2.0 then you must complete all the steps below. 10. In the Project Explorer view, ensure the imported project is expanded so you can see the.project definition file 11. Now you need to edit the project's definition file so you can run the scripts in this release of WPS. Double click on the.project file and you will see it open in the editor view. 12. Edit the line that says <nature>com.wpc.wpl.ui.nature</nature> to <nature>com.wpc.wps.ui.nature</nature> 13. Select the main menu item File --> Save to save the edits you have made. 14. (Finished) You now have the old project displayed in the Workbench with all your existing scripts ready to edit and run. Migrating from SAS Software Introduction If you already have Scripts (programs written in the language of SAS) developed with 40

43 other products e.g. from SAS Institue Inc, there is no conversion process that you have to undertake in-order to use these scripts with WPS. Any file with the extension.sas is assumed to be a script written in the language of SAS that the Workbench can open, edit and run. Create a Workbench Project for your Scripts To take full advantage of Workbench features such as local history you should keep your scripts in a Projects. There are several ways to achieve this; here is one posible way: 1. Outside of WPS Workbench, make a new folder in your workspace directory (the default workspace directory is C:\Documents and Settings\<username>\My Documents\WPS Workspaces\Workspace1). Note: The name of this new folder will also be the exact name you will use when you create a new project inside WPS in one of the next steps. 2. Now use your operating system's tools to copy your exisitng scripts into this new folder. 3. If you have the welcome pages open, you need to close the welcome pages so you can use the Workbench. Click on the big Workbench icon which is displayed near the top right of the welcome screen. 4. Now we will create a new Workbench project so you can open your scripts with the Workbench. From the Workbench menu, select the File --> New --> Project... menu option. You will see the first page of the New Project wizard. 5. Expand the General folder and highlight the Project node. 6. Now select the Next > button. 7. Enter the new Project name (remember to use the same name as the new folder you created in step 1). 8. Click the Finish button to create the new project. You now have a project in the Workbench that contains all your existing scripts. Another way to achieve this is to create a new Project using the File --> New --> Project... menu option. Then, using a filesystem explorer in your operating system simply drag existing files from the filesystem and drop them onto the newly create Project in the Workbench. You can also use copy and paste to do the same thing. Check Script Compatibility Before trying to execute your existing scripts in WPS it is recomended that you first use the Workbench Analyser Tools to determine if your existing programs in the language of SAS contain any language elements that are unsupported or unknown to this release of WPS. Analysing scripts, even hundreds of scripts at a time, can take less than a few minutes to complete and can therefore be quicker than trying to execute long-running scripts only to find that some changes may be required. It is also worth pointing out that simply opening Working with Scripts in the Workbench will also display unknown or unsupported language elements in red. Note that, although they are generally very accurate, the Analyser Tools are not guaranteed to be 100% accurate due to the nature of the syntax of the language of SAS making this difficult to achieve. Using your Scripts in the Workbench For more details on how to use your scripts in the Workbench, please refer to the Working with Scripts section in this guide. 41

44 Working with Files And Folders In this section of the guide we will look a little closer at how you can manipulate the various objects that are contained in Projects. Creating a New File Closing Files WPS Workbench allows you to create any type of new file: 1. Select the menu option File --> New --> File. 2. In the window that opens, select the project or folder where you wish to create the new file. 3. Near the bottom of the window, type in the new file name. File Extensions: If you specify a file extension and it is one that the system knows about (e.g..wps or.sas are treated as a script,.doc is regarded as a Microsoft Word document) then the new file will be associated with the appropriate editor. If no file extension is specified or the extension is not one that the system recognises, the default action is to associate the new object with the WPS Workbench Text Editor. 4. Press the Finish button to complete the task. Any file that is opened in the Editor view has a tab labelled with the file name. To stop displaying the file in the Editor, move the mouse over the tab and then selecting the close button that appears to the right of the name. To find out the different ways you can open a file, you should read the Working with Editors section in this guide. Creating a New Folder Moving an Object You can have any number of folders and sub-folders in a project. 1. Select the menu option File --> New --> Folder. 2. In the window that opens, select the project or folder where you wish to create the new folder. 3. Near the bottom of the window, type in the new Folder name. 4. (Optional) Click on the Advanced button and enable the option to Link to folder in the file system. Then use the Browse button to select an existing folder in another project, or even just select an actual existing project folder. Note: This step creates a new shortcut to the existing folder. You will not physically have a new folder in your project. 5. Press the Finish button to complete the task. To move any object from one project to another: 1. Ensure you have the Project Explorer view open ( Window --> Show View --> Other --> General --> Project Explorer ). 42

45 2. Move your mouse over the object you wish to move. 3. Press your left mouse button and keep it pressed as you start to drag the object. 4. Release the mouse button to drop the object onto another project or folder that you can see. Tip: You can even drag and drop between Microsoft Windows Explorer and the Workbench Project Explorer. Copying Objects To copy any object from one project to another: 1. Ensure you have the Project Explorer view open ( Window --> Show View --> Other --> General --> Project Explorer ). 2. Click on the object you wish to copy. 3. From the main menu select the option Edit --> Copy. 4. Then click on the project or folder where you want to make the new copy. 5. From the main menu select the option Edit --> Paste. 6. Only if you try to paste into the same location that you copied from, you will be prompted to enter a new name. Tip: You can cut and paste between the Microsoft Windows Explorer and the Workbench Project Explorer view. Deleting an Object Renaming an Object Deleting an actual project is discussed in Deleting a Project. Their behaviour when being deleted is slightly different to that discussed below. To delete any object from a project: 1. Ensure you have the Project Explorer view open ( Window --> Show View --> Other --> General --> Project Explorer ). 2. Click on the object you wish to delete. 3. From the main menu select the option Edit --> Delete. 4. Press OK to confirm you wish to procede with the delete. Note: If you delete objects using the Workbench Project delete facilities rather than Operating System delete tools, you can use the Workbench feature discussed in Restore from Local History. Note: Files that you work with that are not contained within a Project in the Project Explorer will not be able to use features such as local history. These features rely on the file belonging to a Project. Such Project files are known as "resources" within the workbench. To rename a project, or even the project itself: 1. Ensure you have the Project Explorer view open ( Window --> Show View --> Other --> General --> Project Explorer ). 2. Click on the object you wish to rename. 3. From the main menu select the option File --> Rename. 4. The highlighted object now allows you to type in the new name. 43

46 5. Press Enter on your keyboard when you have finished typing. Note: You cannot rename an object by simply clicking on it like you are able to in Microsoft Windows explorer. Working with Editors In any of the Perspectives supplied with the Workbench or that you have created, there is always an Editor and Output View. In this section of the guide we will look a little closer at the various ways of opening files with different editors into this view. WPS Editor Text Editor System Editor The WPS Editor provides features suitable for editing scripts (programs written in tha language of SAS), such as colour coding of the language elements. Only files with an extension.wps or.sas can be opened in this editor. Scripts can belong to a Project or scripts can be opened directly from the filesytem. Scripts opened from a Project allow additional workbench features to be accesed including local history. However using Projects is ncessarily not suitable for all situations. To open a script in the WPS Editor: 1. If your script belongs to a project ensure you have the Project Explorer view open ( Window --> Show View --> Other --> General --> Explorer ). 2. Right mouse click on the script you wish to open. 3. From the popup menu select Open With --> WPS Editor. Project 4. If your script does not belong to a project you can drag a file into the Workbench from the operating system filesystem explorer or other external tool. You can also use the File --> Open File... menu option. The Workbench has a basic 'text' editor. You can open a script with this editor but the contents will be treated as regular text, i.e., no features are available in this editor for colour coding or editing language elements. To open a file in the Text Editor: 1. Ensure you have the Project Explorer view open ( Window --> Show View --> Other --> General --> Project Explorer ). 2. Right mouse click on the file you wish to open. 3. From the popup menu select Open With --> Text Editor. If a file has an extension registered to an application installed on your computer (e.g..doc may be registered to Microsoft Word), then the System Editor will launch that application with the file in a new window outside the Workbench. To open a file with the System Editor: 1. 44

47 Project Explorer view open ( Window --> Show View --> Other --> General --> Project Explorer ). 2. Right mouse click on the file you wish to open. 3. From the popup menu select Open With --> System Editor. Default Editor Working with Scripts This is the default selection when you double click on a file. The Workbench either attempts to open the file with the application associated to that file type or it opens it with the editor that the particular file was last opened with. To open a file with the Default Editor: 1. Ensure you have the Project Explorer view open ( Window --> Show View --> Other --> General --> Project Explorer ). 2. Ensure you can see the file you wish to open. 3. Either double click on the file, or right mouse click on the file and from the popup menu select Open With --> Default Editor. This section of the guide describes the tools associated with editing and running Scripts and the output they generate. Creating a New Script To create a brand new script: 1. Select from the main menu the option File --> New --> Script. You will see the New Script wizard open. 2. Select the project or folder in which to create your new script. 3. Now you need to give the new script a name. The Workbench will suggest a name such as Script1.sas. If there is aleady a script using this name, then it will suggest Script2.sas, etc. If you want to type in another name, you might like to refer to the section in this guide called Script Names. 4. (Optional) Click on the Advanced button and enable the option to Link to file in the file system. Then use the Browse button to select an existing script from any project. Note: This step creates a new shortcut to the existing script. You will not physically have a new script in your project. 5. Press the Finish button to complete the task. You will see the new script appear in the Project Explorer view and it will automatically open in the Editor window ready for you to start typing in code. Opening a Non-Project Script To open a script that does not belong to a Project: 1. Depending on your operating system you may be able to double-click on files in 45

48 an an external filesystem explorer with the appropriate file extension (e.g..sas) to open a file in the Workbench editor. 2. Right mouse click on the script you wish to open. 3. From the popup menu, select Open With --> WPS Editor. The script will open in the script editor window where you can edit it or simply view it's content. Note: Files not belonging to a Project do not benefit from certain features of the Workbench such as local history. We recommend that where possible files are opened from within a Project. See Opening a Project Script Opening a Project Script To open a script that belongs to a Project: 1. Ensure you have the Project Explorer view open ( Window --> Show View --> Other --> General --> Project Explorer ). 2. (Optional) Expand the tree view of the project containing the script you are interested in. 3. Right mouse click on the script you wish to open. 4. From the popup menu, select Open With --> WPS Editor. The script will open in the script editor window where you can edit it or simply view it's content. Note: It is also possible to open files that do not belong to a Project. See Opening a Non-Project Script. Getting Help While Writing Scripts There are several ways that the Workbench can offer assistance while you are writing a script. Dynamic Help for Language Elements To automatically display a list of relevant topics from the Wps Reference for Language Elements guide while you are writting or editing a script: 1. Unless you already have the context-sensitive Help view open in the Workbench, press F1 on your keyboard to open it. 2. As you type in a new word or point to an existing word within a script, as soon as the Workbench thinks it recognises it, the Help view will automatically list relevant topics from the WPS Reference For Language Elements guide. 3. Click on one of the listed topics to display the relevant section from the WPS Reference For Language Elements guide in the Help view 4. When you have finished reading the help, click on the Related Topics link (at the bottom of the Help view) to return to the context-sensitive help page or the view will not update automatically as you continue to use the Workbench. Using Script Content Assist The WPS Editor provides a content assist feature that can suggest language elements which you can select and are then automatically typed into your script: 1. Type a word into a script that expects to have more language elements following it. For example type the word PROC. (Presently the content assist feature only works for the word PROC) 46

49 2. After the word type a single space character. 3. Now press CTRL + SPACEBAR. If there are any expected language elements after the word you typed in step 1, then a popup list is displayed of these expected language elements. 4. (Optional) You can filter the list by typing in the first letter(s) of the language element you think you want to use. 5. Double click on the language element you want and it will appear in your script. Run a Script on the Command Line in Windows Command Line WPS To run a script from a command line you need to use the application called wps. The executable can be found in the bin directory where WPS was installed. Running wps on its own will not do anything, so you will need to pass it some additional instructions in the following form: wps <options> <scriptfilename> Please refer to the Command Line WPS section for more details about the <options> that can be specified. Also, the Configuration Files section has more details about configuration files containing system options that are used when you run scripts. Windows command line execution By way of an example, if you wish to run a script called 'Script1.sas' that is in the D:\Work\WPS Scripts directory. In a command window change directory to where WPS is installed and then to the bin directory. Then type: wps "D:\Work\WPS Scripts\Script1.sas" Script Results Generated by wps When a script is run using wps, any results that are generated are automatically captured into a file called <scriptfilename>.lst. For example if we ran a script called Script1.sas, in the same folder as this script we would end up with a file called Script1.lst that contained the results output. You can open this file with any text editor of your choice. Create a batch file to call WPS If you wish to be able to run a script or scripts using the same options each time then it is advisable to create a batch file to do this for you. If WPS is installed at C:\Program Files\World Programming WPS 3 and your script, as above, is at d:\work\wps Scripts then you could create a batch file called RunScripts.bat containing : set WPSLOC=C:\Program Files\World Programming WPS 3 set PRJLOC="D:\Work\WPS Scripts" "%WPSLOC%\bin\wps" "%PRJLOC%\Script1.sas" One benefit of the way in which the example scripts is that they use fully qualified paths meaning they can be executed from anywhere on your machine and will still work. 47

50 Create a Log File When running wps, it is useful to capture the log information so you can check to see if any errors or problems were encountered. This can be accomplished by redirecting the output of the script to a file. For example, to modify the above example to redirect the output to a file called Script1.log then change the example code to: set WPSLOC=C:\Program Files\World Programming WPS 3 set PRJLOC="D:\Work\WPS Scripts" "%WPSLOC%\bin\wps" "%PRJLOC%\Script1.sas" > "d:\work\wps Logs\Script1.log" Once the batch file is run the the file Script1.log will be in the specified directory and can be viewed with the text editor of your choice. N.B. redirecting output in this manner will mean that it will not be shown in the terminal it was executed from. Every time you capture the log information into a file with the same name, the file will be re-created. In other words, log information is not appended to the same file; it only shows details from the latest run. If you do wish for the new log to be appended then change the redirection symbol ">" to ">>". For example: "%WPSLOC%\bin\wps" "%PRJLOC%\Script1.sas" >> "d:\work\wps Logs\Script1.log" Tip: Since log files can be too large to look for errors by hand a simple search for error to find out if the script executed correctly. Run a Script on the Command Line in a Non-Windows Operating System Command Line WPS To run a script from a command line you need to use the application called wps. The executable can be found in the bin directory where WPS was installed. Running wps on its own will not do anything, so you will need to pass it some additional instructions in the following form: wps <options> <scriptfilename> Please refer to the Command Line WPS section for more details about the <options> that can be specified. Also, the Configuration Files section has more details about configuration files containing system options that are used when you run scripts. Command line execution By way of an example, if you wish to run a script called 'Script1.sas' that is in the /home/user/scripts directory. In a command window change directory to where WPS is installed and then to the bin directory. Then type: wps "/home/user/scripts/script1.sas" Script Results Generated by wps When a script is run using wps, any results that are generated are automatically captured into a file called <scriptfilename>.lst. For example if we ran a script called Script1.sas, in the same folder as this script we would end up with a file called 48

51 Script1.lst that contained the results output. You can open this file with any text editor of your choice. Create a shell file to call WPS If you wish to be able to run a script or scripts using the same options each time then it is advisable to create a shell file to do this for you. Assuming WPS is installed in the directory /tools/wps and your script is located in the /home/user/scripts then you could create a text file RunScripts.sh containing: export WPSLOC=/tools/wps export PRJLOC=/home/user/scripts "$WPSLOC/bin/wps" "$PRJLOC/Script1.sas" N.B. The file will need the correct permissions before being executable. To make this batch file run more than one script, copy the last line and modify it to run the new script. One benefit of the way in which the example scripts is that they use fully qualified paths meaning they can be executed from anywhere on your machine and will still work. Create a Log File When running wps, it is useful to capture the log information so you can check to see if any errors or problems were encountered. This can be accomplished by redirecting the output of the script to a file. For example, to modify the above examples to redirect the output to a file called Script1.log change the example code to: export WPSLOC=/tools/wps export PRJLOC=/home/user/scripts "$WPSLOC/bin/wps" "$PRJLOC/Script1.sas" > "/home/user/logs/script1.log" Once the batch file is run the the file Script1.log will be in the specified directory and can be viewed with the text editor of your choice. N.B. redirecting output in this manner will mean that it will not be shown in the terminal it was executed from. Every time you capture the log information into a file with the same name, the file will be re-created. In other words, log information is not appended to the same file; it only shows details from the latest run. If you do wish for the new log to be appended then change the redirection symbol ">" to ">>". For example: "$WPSLOC/bin/wps" "$PRJLOC/Script1.sas" >> "/home/user/logs/script1.log" Tip: Since log files can be too large to look for errors by hand a simple search for error to find out if the script executed correctly. Run a Script Inside the Workbench To run a script inside the Workbench: 1. Select the script you want to run by one of the following methods: from the Project Explorer view, highlight the script you want to run. ensure the script you want to run is open in the editor window and has 49

52 Restart Server focus. 2. If the script was already open and you have part of the script highlighted then the select part will be executed and not the whole script. 3. From the main menu, select WPS --> Run --> local or substitute the name of your Server in place of local. While the script is executing, you will see at the bottom right of the Workbench an indication that the run is in progress. Note: For details about various preferences that can be specified with respect to running scripts, please refer to WPS. Remember: When you run a script it can interact with other data sets, file references, etc, that have been previously created. To clear the state of the Server you can Restart Server. If you have more than one Server registered in the Workbench one of the Servers will be set as the default. The default Server is highlighted in bold is always shown at the top of the list of Servers in the Server Explorer View. You can run scripts on any Server with easy options for running on the default Server. Run Part of a Script You can select a group of lines in a script and run them: 1. Make sure the script you are interested in is open and has been given focus. 2. Highlight the section of code in the script you wish to run. 3. From the main menu select WPS --> Run --> local or substitute your Server for local if necessary. While the script is executing, you will see at the bottom right of the Workbench an indication that the run is in progress. Note: For details about various preferences that can be specified related to performing a run, please refer to Setting WPS Preferences. Remember: When you run selected lines from a script they can interact with other data sets, file references, etc, that have been previously created. To clear the state of the Server you can Restart Server feature. Stopping a Run If a script is running and you want to stop it before it has finished executing: 1. From the main menu, select the WPS --> Cancel --> local option. Substitute server name for local if you are not using the default local server. 2. You can alternatively use the button in the Progress view 3. When the progress indicator in the lower right corner of the Workbench disapears, the script has stopped running. Depending on the particular step that the script is executing, it may not stop immediately. The log will contain a message similar to ERROR: Execution was cancelled. If you wish to clear the log, all results, file references, libraries, data sets etc you need to restart the WPS Server. Doing so means that scripts will no longer be able to interact with any objects created prior to the restart. 50

53 Each time you open the Workbench, the WPS Server is automatically restarted. Manual Restart Rather than closing and re-opening the Workbench, you can manually restart the WPS Server: 1. Restarting a server can be instigated in a number of ways: From the main menu, select the WPS --> Restart Server --> local option. Replace local with your Server name if you are not using the default local Server. Right click on the required server in the Output Explorer View and choose Restart from the pop-up menu. If it is the default server you are trying to restart then you can use the keyboard shortcut (by default Ctrl-Alt-S) 2. A confirmation window will be displayed with an option Run termination commands and clear WORK libray. If this option is selected, then any running script will be stopped and the system will clear everything including listing output, HTML output, log, data sets, catalogs, filerefs, etc for that Server. If this option is not selected, then the system will restart the Server but will not clear the contents of the WORK library. 3. Press OK to proceed with the restart. 4. The items in the Output Explorer view and Server Explorer view will be cleared accordingly. Note: It is possible to just Clear the Log or to just Clearing the Results Output and keep all the other output. Linking the Active Script with the Project Explorer view If you have several scripts from different projects open in the Editor view, you can configure the Project Explorer view to automatically expand a project's contents so that the relevant script in the Explorer's tree view is highlighted every time you select an open script in the Editor view. 1. Ensure you have the Project Explorer view open ( Window --> Show View --> Other --> General --> Project Explorer ). 2. From the Project Explorer's button bar, click the Link with Editor button. This will either toggle this feature on or off. Working with Server Connections This section of the guide describes various tasks associated with managing server connection definitions. Creating a New Local Server Connection The WPS Workbench allows you to have multiple local server connections defined. For more information on the concepts involved see WPS Server 1. Ensure that the Server Explorer View view is visible 2. If you already have one or more server connections defined, select one of them in the Server Explorer view, right click to show the context menu, and select New --> Server Connection... If you have no servers defined at all, then select New Server Connection... from the context menu 51

54 3. In the resulting wizard, select the Local option, as shown below 4. On the subsequent page, enter a suitable connection name (this must be different from the names of any existing connections), and choose whether you would like to start the connection immediately, and whether you would like to start the connection each time the workbench is started. 5. Press Finish to complete the wizard and create the new server definition There will now be an entry in the Server Explorer view for your new server connection. You can then follow the steps in Editing Server Startup Properties to configure startup options for the server. Creating a New Remote SSH Server Connection You will need to have access to a UNIX machine with a licensed WPS server installation. You will need to ensure that you have SSH access to the machine, and that you know the location of the WPS installation on that machine. You may need to contact the machine administrator to get this information and to ensure that you have access. You can connect a WPS workbench running on your workstation to a server copy of WPS running on a supported UNIX platform, and harness the power or that machine to perform computation. For more information on the concepts involved see WPS Server Note that you don't need any extra software installed in your workstation, in particular you do not need a separate SSH client installation. It can be useful to have an SSH 52

55 client installed however to independently verify that you can indeed connect to the remote machine using SSH. 1. Ensure that the Server Explorer View view is visible 2. If you already have one or more server connections defined, select one of them in the Server Explorer view and then right click to show the context menu, and select New --> Server Connection... If you have no servers defined at all, then select New Server Connection... from the context menu, again by right clicking in the Server Explorer View. 3. In the resulting wizard, select the Remote SSH option, as shown below, and click Next 4. On the subsequent page, type in the hostname or IP address of the remote machine to which you wish to connect. If you wish to specify a port other than the default 22, this can be specified in the field provided. The connection name will automatically be changed as you type the hostname to that of the hostname, but you can change the connection name to something more suitable if required (connection names must be unique, so if you are creating multiple connections to the same host you will need to modify the connection name). 5. Enter the user name which you want WPS to make the SSH connection to the remote machine with. 6. In the "Base WPS Install directory" entry box, enter the directory in which WPS is installed on the remote machine. This is the directory containing the bin, doc, plugins and other WPS directories. 7. Decide whether you want the connection to be started now, and whether you want the server to be started automatically when the workbench is started by checking the relevant checkboxes. 8. The wizard should look something like the following: 53

56 At this point you can press Finish to complete the wizard and create the new server definition, or you can continue to the next page where it is possible to define more advanced startup options. 9. If you selected to start the server immediately, you may be prompted to confirm the identity of the hosts RSA fingerprint. If you encounter this dialog, contact your systems administrator. The first time you attempt to connect to a particular host machine you will encounter this message and you will need to confirm the host key with your systems administrator. Once the host key has been confirmed it is stored in the Workbench and subsequent attempts to connection to the same host machine will not require this to be reconfirmed. Assuming that the host key is confirmed by your system administrator, then click Yes 10. If you selected to start the server immediately you will now most likely be prompted for a password to authenticate yourself to the host machine. Your systems administrator will have provided you with the required password. Enter this password in the entry box in the Password Required dialog and click OK There will now be an entry in the Server Explorer view for your new server connection. You can then follow the steps in Editing Server Startup Properties to configure startup options for the server. Exporting Server Connection Definitions to a File To simplify sharing server definitions within a work group, or to enable you to copy server definitions between workspaces, you can export server definitions to a file such that then can then be imported into another workspace. 1. Ensure that the Server Explorer View view is visible 2. Select the servers that you wish to export from the list in the Server Explorer view. 3. From the the right click menu select Export Using the file selection dialog enter the name of the file that you wish to create. This file will contain the exported server definitions in XML form. The server definitions will be saved to the selected file. This file can then be distributed amongst your work group, or imported directly into another workspace on your machine. To import the server definitions into a workspace see Importing Server Connection Definitions from a File Importing Server Connection Definitions from a File This task assumes that you have previously exported some server definitions to a file, or have been provided with an export file created by someone else in your work group 54

57 1. Ensure that the Server Explorer View view is visible 2. If you already have one or more server connections defined, select one of them in the Server Explorer view, right click to show the context menu, and select Import... If you have no servers defined at all, then select Import Server Connection... from the context menu 3. Using the file selection dialog select the file containing the previously exported server definitions. The server connection definitions will be imported from the selected file. If there are any name clashes, the imported server definition will be renamed automatically so that it has a unique name within your list of servers. Selecting the Default Server Connection Within the list of servers that you have defined, one is always marked as the default server. If you define multiple server definitions you may want to change this default. See The Default WPS Server for more information on the concept of the default server 1. Select the server that you wish to make the default in the Server Explorer view and right click to show the context menu. From the context menu select Set as Default Server. If this option is not enabled, then the selected server is already the default server, or you selected more than one server. The selected server will now be the default server, and will be shown in bold in the Server Explorer view, and will always appear first in the lists of servers. Working with Script Output Working with Logs This section of the guide looks at the features for locating and manipulating the results (HTML and listing), logs and data sets that are generated as a result of running a script. This section of the guide looks at the features for locating and manipulating the output. Viewing the Log log To display the information contained in the log: 1. Ensure you have the Output Explorer view open ( Window --> Show View --> Other --> WPS --> Output Explorer ). 2. Right mouse click on the Log node and from the popup menu select Open. 3. Alternatively double-click on the Log node. If you have performed several runs, the previous log information will be concatenated into the same log. You can Clear the Log to ensure that when you next run a script, the log only contains information for that run. If the log contains a lot of information, you may refer to the Navigating the Log section in this guide. Tip: You can control how the different items (e.g. errors, warnings, notes, etc) are displayed in a log viewed in the Workbench. Please refer to WPS Log Syntax Coloring preferences for more details. If you have more than one Server registered in the Workbench then a separate log 55

58 window will be opened for each Server log that you view. Navigating the Log If you have performed several runs and have not used Restart Server or Clear the Log, then each output will have been appended log in order of execution. To navigate the information contained in the log file: 1. Ensure you are Viewing the Log. 2. Now ensure you have the Outline view open ( Window --> Show View --> Other --> General --> Outline ). 3. In this view you will see nodes for all previous log entries with the times they were created. You may also see error or warning nodes. Click on any of these nodes and the corresponding section in the log file will be displayed. Saving the Log to a File To save the log to a file: 1. Ensure you have the Output Explorer view open ( Window --> Show View --> Other --> WPS --> Output Explorer ). 2. Right mouse click on the Log node and from the popup menu select Save As Alternatively, open the Log in the editor Viewing the Log and right mouse click on the editor window and select. Save As. With the log open in the editor you can also use the File --> Save As... menu option. Printing the Log It is currently not possible to print directly from the Log within the Workbench. To print the Log: 1. First save the log file (see Saving the Log to a File ) 2. Load the file with any text editor (including WPS Workbench). 3. Use the print option from the chosen editor Note: The ability to print the log directly from the Workbench will be added shortly. Clear the Log To clear the contents of the log: 1. From the main menu, select the WPS --> Clear Log option. 2. The log file will now be blank. Tip: You can use the keyboard shortcut Ctrl + Alt + L Tip: If you have only one Server registered as is normally the case with a standard workstation installation of WPS Workbench, then the Clear Log action will always clear the log for that server. Tip: If you have more than one Server registered then the Clear Log menu action will clear the log for the default Server unless a different Server or Server log is selected and has focus. If in doubt use the tooltip for the toolbar button to show which log will be cleared. Working with Listing Output This section of the guide looks at the features for locating and manipulating the listing output. Viewing the Listing Output 56

59 To view the listing output: 1. Ensure you have the Output Explorer view open ( Window --> Show View --> Other --> WPS --> Output Explorer ). 2. Right mouse click on the Listing node and from the popup menu select Open. 3. Alternatively double-click on the Listing node. The listing output will open and be given focus. If you have performed several runs, the previous listing output will be concatenated into one listing file. If you wish to clear the listing then you can use: Clear Results (which will also clear any HTML output) Restart Server (which will clear the log, all results, data sets, library and file references etc.) If you have more than one Server registered in the Workbench then a separate listing window will be opened for each Server listing that you view. Navigating the Listing Output To navigate the output contained in the listing file: 1. Ensure you are Viewing the Listing Output. 2. Now ensure you have the Outline view open ( Window --> Show View --> Other --> General --> Outline ). 3. In this view you will see nodes for the various procedures and tables that are contained in the listing output file. Click on any of these nodes and the corresponding section in the listing file will be displayed. Saving the Listing Output to a File To save the listing output to a file: 1. Ensure you have the Output Explorer view open ( Window --> Show View --> Other --> WPS --> Output Explorer ). 2. Right mouse click on the Listing node and from the popup menu select Open. The listing output will open and be given focus. 3. Alternatively, open the Listing in the editor Viewing the Listing Output and right-click on the editor window and select. Save As. With the Listing open in the editor you can also use the File --> Save As... menu option. Printing the Listing Results Printing the listing output can be achieved in three different ways. First ensure you have the listing view open, and that it has the focus, then: Working with HTML Output right click in the view. From the pop up menu choose Print. press Ctrl-P (Cmd-P on MacOS). use the menu option File --> Print. This section of the guide looks at the features for locating and manipulating the HTML output. 57

60 Viewing HTML Output To view HTML output: 1. Ensure you have the Output Explorer view open ( Window --> Show View --> Other --> WPS --> Output Explorer ). 2. Expand the Results node so you can see the HTML node. 3. Right mouse click on the HTML node and from the popup menu select Open. 4. Alternatively double-click on the HTML node. The HTML output file will open and be given focus. If you have performed several runs, previous HTML output may be concatenated in the output you are looking at. Performing a Restart Server will ensure that when you next execute a script, the HTML output are only for that run. If the listing output contains a lot of information, you may want to refer to the Navigating HTML Output section in this guide. Navigating HTML Output If you have performed several runs and have not used Restart Server or cleared the HTML output, the previous HTML output will be available. If you have opted to have the HTML output automatically managed by the Workbench (the default) then each run will create a new HTML file. The outline view of the HTML output provides access to all HTML output created in this way. To navigate the output contained in the HTML file: 1. Ensure you are Viewing HTML Output. 2. Now ensure you have the Outline view open ( Window --> Show View --> Other --> General --> Outline ). 3. In this view you will see nodes for the various procedures and tables that are contained in the HTML result file. Click on any of these nodes and the corresponding section in the HTML output will be displayed. Saving the HTML Output to a File To save the HTML output to a file: 1. Ensure you have the HTML output you want to save open in the editor window. 2. Right-click on the editor window and select Save As Alternatively, with the HTML output open in the editor you can also use the File --> Save As... menu option. Note: HTML output are stored in separate files - one for each run. You can only save the contents of one run at a time. Make sure you have the portion of HTML you want to save shown in the editor.. Remember: It is not possible to save using a right-click on the HTML node of the output explorer because this could refer to many individual HTML files making up the entire HTML output. Printing the HTML Output To print the HTML output: 1. Open the HTML output that you wish to print in the Workbench editor. You can 58

61 use the outline view to select the part of the HTML file you wish to print. 2. Right mouse click on the editor window and select Print. The standard operating system print dialog window will open. 3. Alternatively, with the HTML output open in the editor you can use the main menu option File Print. The standard operating system print dialog window will open. Note: A single HTML output file is created for each run within the Workbench. You can only print the HTML output of one run at a time. See Running a Script for more information about runs. Clearing the Results Output Working with Data Sets To clear all the reults output: 1. From the main menu, select the WPS --> Clear Results option. 2. All listing output and HTML output will be cleared. Tip: You can use the keyboard shortcut CTRL + ALT + O Tip: If you have only one Server registered, as is normally the case with a standard workstation installation of WPS Workbench, then the Clear Results action will always clear all results for that server. Tip: If you have more than one Server registered then the Clear Results menu action will clear all the results for the default Server unless a different Server is selected and has focus. If in doubt use the tooltip for the toolbar button to show which results will be cleared. This section of the guide looks at the features for locating and manipulating sets. Viewing the Contents of a Data Set data To display the observations contained in a data set: 1. Ensure you have the Server Explorer view open ( Window --> Show View --> Other --> WPS --> Server Explorer ). 2. Expand the tree view under the Libraries node until you can see the data set node you wish to open. 3. Right mouse click on the data set node and from the popup menu select Open. 4. Alternatively double-click on the data set node. Tip: You can display labels in the column headers of a data set you are veiwing in the Workbench. Please refer to WPS Data Set Viewer preferences for more details. Clearing the Data Sets You cannot just clear the data sets on there own. The process to clear data sets, unavoidably means that you also end up clearing all the other output such as the HTML output, listing output, log entries, libraries, file references, etc. In order to clear all the output, you need to use the Restart Server feature. 59

62 Analysing Scripts and Language Elements This section of the guide describes how to use the various Analyser Tools and Analysis Reports. Analysis Restrictions Restrictions on Using The Analyser Tools In order to run an analysis, scripts must be located in Workbench Projects on a Windows computer. You do not have to worry about the connection or availability of any data sources as the code analyser does not actually execute scripts to perform an anlayses and generate a report. The analyser will still report on the syntax you use for data connectivity, etc. You can use the Workbench's code analyser on the Windows platform to Analyse Mainframe Scripts. Restrictions on Language Elements Analysed and Reported The code analyser will not report on incorrect syntax or on language elements that are unknown in the language of SAS. Although WPS does support the use of macro language elements and library engines (data access), the analysis reports presently do not contain information on these particular items. For a complete list of the macro language elements and the library engines and options that are supported by this release of WPS, please refer to the Macro Processor and Library Engine sections in thewps Reference For Language Elements guide. When generating Script Compatibility Analysis Reports, if the analyser encounters an unsupported procedure, it just reports that as a problem and does not report on any of that particular procedure's options that have been used. However, when generating Language Usage Analysis Reports, the same unsupported procedure is reported along with any unsupported options that were also encountered. Although WPS Workbench cannot be used on a mainframe it the Language Analyser can still be used to check scripts for this operating system. Analyse Mainframe Scripts The code analyser is a feature of the Workbench and cannot therefore be used on platforms on which the Workbench is not supported. However, if Scripts are moved from a Mainframe to a system running the Workbench, the code analyser is still able to report on all language elements including those specific to the z/os platform. When scripts are moved from a mainframe to a non-mainframe (distributed) system, note that before the script can be analysed you need to ensure that: Any line numbers have been removed All scripts are converted from EBCDIC to ASCII Each script file is given a file extension of.sas Refer to the Analysis Restrictions section for more details about analysing your scripts. 60

63 Once you have moved your Mainframe scripts to the Windows platform, you can either Analyse Script Compatibility or Analyse Language Usage. Analyse Script Compatibility To analyse one or more scripts to see if the language elements they contain are supported in this release of WPS: 1. Files to be analysed must be selected from the Project Explorer view. Ensure you have this view open ( Window --> Show View --> Other --> General --> Project Explorer ). 2. Select the files you wish to analyse: Either, highlight one or more scripts. You can select scripts from different projects. Or, highlight a project to analyse all the scripts it contains. You can select more than one project. 3. Right mouse click over any of the highlighted items and from the popup menu select Analyse --> Script Compatibility. When the analysis has finished, a automatically open in the Workbench. Related Topics: Analysis Restrictions Navigating Analysis Reports Export Analysis Results to Excel Script Compatibility Analysis report will Analyse Language Usage To report on all the supported and unsupported language elements used in one or more scripts: 1. Files to be analysed must be selected from the Project Explorer view. Ensure you have this view open ( Window --> Show View --> Other --> General --> Project Explorer ). 2. Select the files you wish to analyse: Either, highlight one or more scripts. You can select scripts from different projects. Or, highlight a project to analyse all the scripts it contains. You can select more than one project. 3. Right mouse click over any of the highlighted items and from the popup menu select File --> Analyse --> Language Usage. When the analysis has finished, a automatically open in the Workbench. Related Topics: Analysis Restrictions Navigating Analysis Reports Export Analysis Results to Excel Language Usage Analysis report will Opening Analysis Reports 61

64 An analysis report can only be opened by virtue of performing one of the following types of anlaysis: Analyse Script Compatibility Analyse Language Usage Depending on the type of analysis you perform, the end result is to automatically open either a Script Compatibility Analysis report, or a Language Usage Analysis report. Both types of report will only display the results of the latest analysis. In other words, you cannot have open more than one of each type of analysis report. Once you close an anlayses report, it is lost until you either re-run the analyses again or you Export Analysis Results to Excel. Navigating Analysis Reports Drilling Down to Subset Pages Drilling Down: If you move your mouse over an item in the report and your cursor changes to a pointing hand, then the item can be clicked. A single mouse click will drill down to display a subset page of results specific to that item. Drilling Back Up On a subset page, there is always an underlined link at the top of the page that you can click to drill back up to the previous page. Expanding and Collapsing Report Sections Expanding: If you see an that section of the report. icon to the left of a title, you can click on this to expand Collapsing: If you see an (or hide) that section of the report. Opening Scripts From a Report icon to the left of a title, you can click on this to collapse When you drill down to one of the lowest subset pages of a report, the page will always display a list of locations where the language element occures in a script. Click on one of these locations to open the appropriate script at the line where the language element occurs. Export Analysis Results to Excel The results of an analysis can be exported to a Microsoft Excel Spreadsheet: 1. Ensure you have an analysis report open in the Workbench as a result of performing one of the following: Analyse Script Compatibility Working with Markers Analyse Language Usage 2. Ensure you are looking at the first page of the analysis report. 3. At the top of the first page, click on the Export results to Excel option. You will see the Save As window open. 4. Enter the desired File name and select where you want to create the Excel spreadsheet. 62

65 The Workbench has two types of marker that you can work with, tasks. bookmarks and Working with Bookmarks The Workbench has facilities that allow you to add Bookmarks against or inside a script. The Workbench provides you with tools to create, manage and navigate between bookmarks. This section of the guide describes how to use these facilities. Adding a Bookmark Against a Script File To add a new bookmark against an individual script file: 1. Make sure you can see the script listed in the Project Explorer view ( Window --> Show View --> Other --> General --> Project Explorer ). 2. Right mouse click on the script and from the popup menu select Add Bookmark. 3. You will need to enter a name/description for future reference. Notice how the line of code is the default description. 4. Press OK to finish. Adding a Bookmark Within a Script To add a new bookmark on a particular line within a script: 1. Open a script in the Editor window. 2. Move your cursor into the grey border ( not the white border) immediately to the left of the line you wish to mark. 3. Right mouse click and from the popup menu select Add Bookmark. 4. You will need to enter a name/description for future reference. Notice how the line of code is the default description. 5. Press OK to finish. You will now see in the border a Deleting a Bookmark bookmark tag. To delete a bookmark: 1. Open the Bookmarks view ( Window --> Show View --> Other --> General --> Bookmarks ). 2. If you click on the bookmark's description, the Workbench will assume you are trying to edit it. So, for this step, right click on the bookmark in a column other than the description. 3. From the popup menu select Delete. Navigating Between Bookmarks To navigate between the various bookmarks (i.e. display the script at the appropriate line in the editor window): 1. Open the Bookmarks view ( Window --> Show View --> Other --> General --> Bookmarks ). 2. Right mouse click anywhere on the bookmark line and from the popup menu select Go To. 63

66 Double clicking on the line will also open it. 3. The script will open (if it was closed) and be given focus on the Workbench. Working with Tasks The Workbench has a facilities that allow you to add Tasks inside a script. The Workbench provides you with tools to create, manage and navigate between task marks. This section of the guide describes how to use these facilities. Adding a Task To add a new task mark on a particular line within a script: 1. Open a script in the Editor window. 2. Move your cursor into the grey border ( not the white border) immediately to the left of the line you wish to mark. 3. Right mouse click and from the popup menu select Add Task. 4. Enter a description. Notice how the line of code is the default description. 5. Enter a priority level (high, normal or low). 6. Press OK to finish. You will now see in the border a Deleting a Task task mark. To delete a task: 1. Open the Tasks view ( Window --> Show View --> Other --> General --> Tasks ). 2. If you click on the task description, the Workbench will assume you are trying to edit it. So, for this step, right click on the task in a column other than the description. 3. From the popup menu select Delete. Navigating Between Tasks To navigate between the various task marks (i.e. display the script at the appropriate line in the editor window): 1. Open the Tasks view ( Window --> Show View --> Other --> General --> Tasks ). 2. Right mouse click anywhere on the task line and from the popup menu select Go To. Double clicking on the line will also open it. 3. The script will open (if it was closed) and scroll to the appropriate line. Working with Local History The Workbench maintaines a Local History about the edits and deletions of scripts within Projects manipulated in the Workbench. This history can be used to compare or even revert back to previous versions of the same script. This section of the guide discusses using this feature. 64

67 Compare with Local History To compare a current saved script with a previous version: 1. Select the script you want to investigate: Either use the Project Explorer view and highlight the script or open the script and make sure it has been given focus. 2. Right click on the script and from the popup menu select Compare With --> Local History. The Compare with Local History window will open. 3. In the top part of this window, labeled Local History, select a particular day and time to compare with. The current version and previous version are displayed with the differences highlighted. Replace with Local History 4. Use the Select Next Change and Select Previous Change buttons to jump between the differences. 5. Click the OK button when you have finished comparing. To revert a script in a Project back to a previous saved version: 1. Select the script you want to replace: Either, use the Project Explorer view and highlight the script. Or, open the script and make sure it has been given focus. 2. Right click on a script and from the popup menu select Replace With --> Local History. The replace with Local History window will open. 3. In the top part of this window, labeled Local History, select a particular day and time to compare with. The current version and previous version are displayed with the differences highlighted. 4. Use the Select Next Change and Select Previous Change buttons to jump between the differences. 5. (Optional) You could just highlight and copy a portion of text from a previous version and then press the Close button in the window's upper right hand corner. Now you can paste your piece of text into another script. 6. Click the Replace button to complete the task. Tip: You cannot use the Replace with Local History features with any file that does not belong to a Workbench Project. Restore from Local History A script or any other file that has been deleted using the Workbench's delete facility can be un-deleted: 1. Ensure you have the Project Explorer view open ( Window --> Show View --> Other --> General --> Project Explorer ). 65

68 2. Right click on a folder or project script and from the popup menu select Restore from Local History. The Restore from Local History window will open. 3. Select the script you want to undelete. 4. If you don't want to undelete just the last state of the script, highlight the script and then you can select any other edition from the the right hand side of the dialog. The bottom pane of the dialog shows the contents of the state. 5. Click the Restore button to procede with the un-delete. Local History Size and Duration local history list on By default, the Workbench keeps seven days of local history for each individual Project script and a maximum of fifty entries per script. There is also a default of 1 MB of storage allocated for each script's local history. All of these settings can be changed and are discussed in the General Local History preferences section. 66

69 WPS Tips and Tricks Using ODBC Learn how to use an ODBC connection in a script. WPS Data Set Viewer Make your data sets display labels for column names. WPS System Options Override any default system options set when you startup the Workbench. WPS WORK Location Change the system option for the WORK location. WPS LOCALE Setting Change the system option for the LOCALE value. 67

70 Reference License Key WPS requires a valid license key to operate. Only when a license key has been applied will you be able to use WPS to run any programs written in language of SAS. A license key is provided in a separate file to the WPS software installation file and will have a name similar to YourCompanyName_v2-0_Win32.wpskey. This section of the guide looks at how you can apply a new licence key or how to look up the details of the license key that is already applied to your installation. Applying a License Key To apply a new license key to your WPS installation: 1. Before applying a license key, ensure you have administrator privileges on your computer. 2. Select the Workbench menu item Help --> Apply License. The Apply License window will be displayed. 3. Click on the Import from file... button. 4. Locate your license key file and then select the Open button. You should see the contents of the license key file displayed. 5. Select the Finish button to apply the license. Viewing Your Applied License Details To view the details of the license key that has been applied to your WPS installation: 1. Select the Workbench menu item Help --> View License. The License Key information window will be displayed. 2. When you wish to close this window, click on the OK button. Preferences There are many user settings, controls and defaults that you can adjust and specify from the Window --> Preferences panel. In this section of the WPS guide we will focus on those preferences that have an effect on how Scripts are edited, displayed, run, etc. Any preference that is not described in this WPS guide can be looked up in the Eclipse specific Workbench User Guide. Preference Filter The preferences window has a filter function which can help you find preference pages quickly: Once you have opened the Window --> Preferences panel, you can see the filter function near the top left. It is a text box with the words type filter text. By way of an example, type into this box the word log one letter at a time and see how the preference window filters the available pages who's title contain the text you have 68

71 typed in as a filter. To stop filtering, click on the Clear button and you will see all available preference items re-displayed in the tree view. General Under Window --> Preferences --> General are controls that not only affect Scripts, but also affect other types of files and other general aspects of the Workbench. Here are some of the items that you can control that have an effect on scripts: Always Run in Background Some operations such as running a script, or refreshing a project containing a lot of files, can take a long time to execute. When the Run in Background option is enabled, it allows such tasks to execute without displaying the Executing dialogue window. If this option is left unchecked the dialog box that appears when running a script has a button that will run that script in the background. Show heap status When this option is selected the amount of memory that WPS Workbench is using appears in the bottom right corner of the window. Open Mode General Local History This preference controls the way you click on objects in the Workbench with either a single click or a double click of your mouse. Under Window --> Preferences --> General --> Workspace --> Local History are the controls that you can set regarding the Local History. Days to Keep Files General Text Editors The number of days that you want to keep records for any one script. For example, if you type 20, then a history of saved states from the last twenty days would be kept. The default value is 7 days. Maximum Entries per File The number of states to keep for any one script. When you exceed the number of entries per file, the oldest changes are discarded to make room for the newer changes. The default is 50 entries per file. Maximum File Size (MB) The maximum file size (in MB) of a script for which a local history should be kept. If the size of the script exceeds the maximum amount of file size allocated, no local history is kept for it. The default size is 1MB. Under Window --> Preferences --> General --> Editors --> Text Editors are the controls that you can set regarding the various features that are used when editing or viewing scripts. The sort of things you can set are: 69

72 Tab Width Undo history size Colours (highlighting, current line, background, etc) Show line numbers Note: Details about the colours used to display language elements in a script can be looked up or defined under the WPS Syntax Coloring preferences. General Text File Encoding In order to display and save scripts and files that contain non English characters, you may need to set an appropriate text file encoding value. This can be done at a global level or at a project level. Setting Encoding at a Global Level To set an encoding value at a global level that is used by all projects and therefore by all scripts: 1. Select the menu item Window --> Preferences. The Preferences window will be displayed. 2. In the left hand menu, expand the General --> Workspace node. 3. On the right of the window, you should see controls for setting the Text File Encoding value. For English systems, this is usually set to Default (Cp1252). 4. Enable the Other text file encoding option and select your desired value from the drop down list of available values. 5. Now, select the OK button to apply your change. Note: You may want to also specify an appropriate WPS LOCALE Setting. Setting Encoding at a Project Level To set an encoding value only for scripts contained in a specific project: 1. Ensure you have the Project Explorer view open ( Window --> Show View --> Other --> General --> Project Explorer ). 2. Click on the desired project. 3. From the main menu select the option File --> Properties. The Properties window for the selected project will be displayed. 4. On the left of the Properties window, ensure the Resource option is selected. 5. On the right of the window, you should see controls for setting the Text File Encoding value. The default option selected is Inherited from container(x), where (x) would be the value set at a global level as described above. 6. Enable the Other text file encoding option and select your desired value from the drop down list of available values. 7. Now, select the OK button to apply your change. Note: You may want to also specify an appropriate WPS LOCALE Setting. WPS Under Window --> Preferences --> WPS are the controls that control some general aspects of the WPS workbench behaviour. Scripts : Save all modified files before running a script This preference controls whether WPS will save any unmodified scripts before a script is run. The behaviour can be one of : Always, Never or Prompt. The default for this option is Prompt. This causes a dialog to be shown whenever you attempt to run a script. 70

73 If you have a complex program that consists of a number of source files then it is recommended that this preference be set to Always. Consider the case where you might have two source files and the first uses a %INCLUDE statement to include the contents of the second. This is one method in which a large program can be built up from a number of smaller source files. In this case the %INCLUDE will read the contents of the file as they appear on the disk, and any unsaved changes that you might have in the script editor will not be seen by your program. When you are editing a script and run it using the Run button however, it is the current text in the editor that is submitted, and not the contents of the file, so unsaved changed will be executed. Close all open data sets before running a script Sets how WPS deals with closing open data sets when running a script. The behaviour can be one of: Always, Never or Prompt. The default for this option is Prompt Having data sets open in the data set viewer can cause problems if you attempt to run a script that tries to create a new version of the data set. For this reason it is recommended that this option be set to Always to avoid such problems. Show log when an error is encountered running a script Sets whether WPS shows the log file when an error is encountered in a script. The behaviour can be one of: Always, Never or Prompt. The default for this option is Prompt which causes a prompt to be shown the first time an error is encountered in a running script. Close all open datasets when deassigning a library Controls whether WPS will automatically close any data sets that may be open in a library when you deassign a library by selecting the Delete item from the context menu in the Server Explorer view. The behaviour can be on of: Always, Prompt. The default for this option is Prompt which will cause a prompt when you attempt to deassign a library and there are data sets open Confirm deletions This option controls whether WPS will ask for confirmation when you use the Delete item from the context menu in the following actions: delete a server definition to delete a data set, catalog or view from with a library to deassign a library to deassign a fileref to delete a catalog entry from with a catalog Confirm server restart Server Explorer to do one of the This option controls whether WPS will ask for confirmation when you select a server in the Server Explorer and restart the server from the context menu. Autoscroll the log This option controls whether WPS will automatically scroll the log view or not Autoscroll the listing This option controls whether WPS will automatically scroll the listing view or not. Temporary File Location 71

74 Contains the directory location where the Workbench will store temporary files. For example the log files created during execution of a script are stored in this directory, as are any ODS HTML results generated by a script. You may find that you need to modify this setting if the default value points to a location with space restrictions for example. Log files created during execution can be large and you may find you encounter space problems. WPS Code Injection Under Window --> Preferences --> WPS --> Code Injection are the controls that allows for code to be run automatically before and after any script Enable custom pre-code injection When this option is enabled the code in the following textbox is executed before any script is run. This option provides a facility similar to the INITSTMT system option, except here the code is automatically run before each script that is submitted. The INITSTMT system option is only processed on server startup. The preferences page WPS Result Options controls whether code is automatically injected to set up ODS destinations so that you can easily view the results of your programs in, for example, HTML. However the set up that it performs may not be suitable for you, and in that case you can use the customer code injection facility here to set up ODS destinations in a more suitable way. Enable custom post-code injection When this option is enabled the code in the following textbox is executed after any script is run. This option provides a facility similar to the TERMSTMT system option, except here the code is automatically run after each script that is submitted. The TERMSTMT system option is only processed on server shutdown. WPS Code Templates Window --> Preferences --> WPS --> Code Templates is used to allow code shortcuts to be entered. These templates can be accessed through the normal code completion key sequence (typically Ctrl+Space). For example if you define a code template with the name template1, you can type temp Ctrl+space and the code completion feature will match temp against the list of code templates, find your template called template1 and substitute it with whatever you defined as the substitution text for the template. If there are more than one code template whose names start temp then you will be presented with a selection dialog to choose which template you would like to substitute. The substitution pattern can be as simple or as complex as you like. It could just be a single word, for example you could define a code template to expand to the name of a frequently used data set whose name is difficult to type. A code template could also define a large amount of text, for example a boilerplate invocation of a particular procedure. You can export code templates to an external file, or import them from a previously exported file. This allows you to share code templates with colleages, or to copy code 72

75 templates that you have defined between workspaces. WPS Data Set Viewer Under Window --> Preferences --> WPS --> Data Set Viewer you can set your default preferences concerned with viewing a data set in the Workbench. Show labels for column names Toggle on/off the option to display labels in the column headers of a data set that is viewed in the Workbench rather than the column names. WPS Result Options Under Window --> Preferences --> WPS --> Result Options are the controls for controlling output types Automatically Manage Result Types If this preference is set to No then there will be no ODS (Output Delivery System) destinations set up by default, and all procedure output will come out in the LISTING destination. This behaviour reflects what happens when you run a script from an operating system command line using the wps executable. You may want to use this setting if you have programs that are ultimately designed to be run from the command and set up their own ODS destinations. If this preference is set to Yes, then the Workbench will automatically manage ODS destinations based on the check boxes that are ticked in the Result Types section. The destinations are activated by injecting relevant ODS statements before and after each script is submitted. Note: Even if automatic management is chosen it is still possible to define custom ODS destinations as usual. WPS Syntax Coloring Under Window --> Preferences --> WPS --> Syntax Coloring are controls you can specify regarding how to display the language items contained in a script (e.g. data lines, comments, formats, etc). For each different type of language item contained in a script, you can specify attributes for Colour, Background Colour and if the item should be displayed in Bold. WPS Log Syntax Coloring Under Window --> Preferences --> WPS --> Log Syntax Coloring are the preferences you can set regarding how to display the different items contained in a log file (e.g. errors, notes, warnings, etc). For each different type of item contained in a log, you can specify attributes for Colour, Background Colour and if the item should be displayed in Bold. Backing Up Your Preferences 73

76 To save your preferences to a backup file, use the File --> Export --> General --> Preferences feature. To import preferences from a backup file, use the File --> Import --> General --> Preferences feature. Editing and Navigating There is a wealth of tools and functions provided by the Workbench to help with editing and navigating about Scripts. In this section of the guide we will look at some of the more commonly used features. Undo and Redo Your Edits You can undo script edits step by step by using the main menu option Edit --> Undo (or press CTRL + Z on your keyboard). You can step through re-doing any undone edits by using the main menu option Edit --> Redo (or press CTRL + Y on your keyboard). Find You can find any text string in an individual script that you have open by using the main menu option Edit --> Find/Replace (or press CTRL + F on your keyboard). This feature also allows you to do a find and replace within the open script. Navigate Back and Forward The main menu options Navigate --> Back and Navigate --> Forward are analogous to the back and forward buttons on a web browser: Back navigates to the previous resource that was viewed in an editor window. Forward navigates to undo the effect of the previous Back command. Unlike a web browser, when you close and re-open WPS Workbench, it still has the navigational information. Go To Your Last Edit The main menu option Navigate --> following: Last Edit Location will automatically do the Open a script (if it is closed). Highlight the line you last edited. Place your edit cursor at the end of the piece of text you edited. Next and Previous Annotation 74

77 Although the menu items Next Annotation and Previous Annotation would appear to imply that this feature is for annotations only, you can actually use these controls to navigate between annotations and quick difference indicators in any individual script that is open in the Editor view. What is an Annotation? An annotation is a marker in the left hand grey border of a script: Bookmarks Tasks Search results What is a Quick Difference Indicator? A quick difference indicator in the left hand white border of a script shows that something is different in that line of code from when it was last saved: A change has been made to the line of code. A new additional line of code. The position where one or more lines of code have been deleted. Navigating Between Annotations and Quick Difference Indicators You can navigate between annotations in an individual script that is open by using the main menu options Navigate --> Next and Navigate --> Previous (or press the respective keyboard options CTRL +. and CTRL +,). As well as using these menu and keyboard options, you can also use the buttons in the Workbench's main button bar for Next Annotation and Previous Annotation. Configure Which Markers and Indicators To Navigate Between To the right of each of the next and previous annotation buttons in the main button bar are drop-down menus. You can use these menus to select which markes and indicators you want to navigate between. Server Properties There are many properties that you can set and adjust that help specialise how the WPS server behaves. The properties available differ slightly depending on whether your server is local or remote (see WPS Server for more information about local and remote servers) and are accessed by selecting the server you wish to change the properties of in the Server Explorer View, then by right clicking and selecting Properties from the context menu. Depending on whether your server is a local or remote server please continue by selecting the relevant topic below. Local Server Properties The following properties and information are available for a local server. The list of items on the left of the Properties dialog are explained below. Some items are only available when the server is running, and where that is true it is nted in the sections below. 75

78 Environment This lists the environment variables that are set on the local machine. This is not modifiable here and is purely for information. This item is only available when the server is running. Launch Options Here is where you can specify any environment variables that you would like set before the server is started. By clicking the New button you can specify an environment variable name and the value you would like it set to. The item will then appear in the list. You can also then Edit... and Remove any environment variables you have created. License Information This shows the setinit information for the server, such as the products that are licensed, the amount of grace or warning time on the license, and the date that the license expires. This item is only available when the server is running. Macro Variables This lists the macro variables and their values that are set on the local WPS server. This is not modifiable here and is purely for information. This item is only available when the server is running. Software This lists information about the local WPS server itself, such as it's version and the operating system it is running on. This is not modifiable here and is purely for information. This item is only available when the server is running. Startup Options The Working directory for execution entry is where you to specify the working directory for the server. This is where the server considers itself to be running from and can affect things like where output is generated to or, for example, if you have %INCLUDE statements in your code with relative paths in them, then it is important that you start the server in the correct directory to allow those %INCLUDE statements to find the files they are including. The Startup System Options pane is where you can specify any WPS options that you would like to pass the server to process on startup. The options available here are typically any of those that can be passed directly to WPS on the command line. If you click Add... you will get a new popup dialog that lists all the options that can be set. Select the option you wish to set and click OK and you will see it added to the list. You can then edit the value of the option. You can also Remove any options you have set. System Options This lists the values of all the system options that are set on the server along with their values. This is the same information you would get if you ran a PROC OPTIONS statement. This is not modifiable here and is purely for information. This item is only available when the server is running. Remote Server Properties 76

79 The following properties and information are available for a remote server. The list of items on the left of the Properties dialog are explained below. Some items are only available when the server is running, and where that is true it is noted in the sections below. Environment This lists the environment variables that are set on the remote machine. This is not modifiable here and is purely for information. This item is only available when the server is running. License Information This shows the setinit information for the server, such as the products that are licensed, the amount of grace or warning time on the license, and the date that the license expires. This item is only available when the server is running. Macro Variables This lists the macro variables and their values that are set on the remote WPS server. This is not modifiable here and is purely for information. This item is only available when the server is running. Remote Connection Options This is where you set up the connection setting for the remote server. The Hostname, Port and User name entries allow you to specify the machine hostname or IP address of the remote server, the SSH port (defaults to 22 if not specified), and the user name you wish to connect to it with. The Auto start server check box controls whether the server is automatically started when the Workbench is started up. The Enable Compression check box controls whether the ssh connection, and as a result the protocol traffic between the Workbench and the remote server is compressed or not The Use SSH Port Forwarding check box controls whether the ssh connection uses ssh port forwarding to send standard in and out information between the remote server and the workbench or not. This requires your ssh daemon to be running with "AllowTcpForwarding yes" specified in the config file. If this is not enabled in your ssh daemon configuration you should leave this unchecked or speak to your systems administrator to get it enabled. The Verify host name check box simply checks that the host you have specified in the Hostname entry exists. If you are in the process of setting up the remote host, or you know that it will exists at some point, then you can uncheck this check box and the Workbench will allow you to save the settings. Otherwise you will get an error and will be required to specify a host that exists. Advanced Connection Options There are circumstances where it is necessary to control the list of environment variables that the remote server will inherit when it is started. By default the server process will just inherit the default interactive shell environment for the user under whose ID the server is being started. 77

80 An example would be the environment variables required in order to set use a database library engine. Typically this will require that the database client shared libraries be added to the LD_LIBRARY_PATH so that they can be loaded by the wps software. One way to do this is to modify the /etc/profile or ~/.profile file in order to add the required directories to the LD_LIBRARY_PATH. However this may not always be desirable. An alternative is so put any required environment variables into a dedicated shell script and "source" it before invoking the remote server executable. So for example if you were to put the environment modifications into a shell script called ~/wpsenv.sh, then in the Advanced Connection Options page you can put Using ODBC. ~/wpsenv.sh into the text box on this page. Any commands you enter here are invoked before the remote server is executed. The initial. here is necessary to ensure that a sub-shell is not used to invoke the shell script, and that the environment variables that are set by the ~/wpsenv.sh shell script affect the environment of the remote server process. The output from any commands that you execute in this way can be seen in the Console View Software This lists information about the local WPS server itself, such as it's version and the operating system it is running on. This is not modifiable here and is purely for information. This item is only available when the server is running. Startup Options The Working directory for execution entry is where you to specify the working directory for the remote server. This is where the server considers itself to be running from and can affect things like where output is generated to or, for example, if you have %INCLUDE statements in your code with relative paths in them then it is important that you start the server in the correct directory to allow those %INCLUDE statements to find the files they are including. The Startup System Options pane is where you can specify any WPS options that you would like to pass the server to process on startup. The options available here are typically any of those that can be passed directly to WPS on the command line. If you click Add... you will get a new popup dialog that lists all the options that can be set. Select the option you wish to set and click OK and you will see it added to the list. You can then edit the value of the option. You can also Remove any options you have set. System Options This lists the values of all the system options that are set on the server along with their values. This is the same information you would get if you ran a PROC OPTIONS statement. This is not modifiable here and is purely for information. This item is only available when the server is running. Although this guide is primarily concerned with topics regarding how to use the Workbench features, this section is about using the language element libname within a script. It has been included in this guide for convenience to readers. 78

81 ODBC can be used to connect many different types of data sources. By way of an example we will discuss how to use it to connect to a DB2 source. First, outside of WPS, set up the local DB2 client (either just a client or full DB2) to make the connection to the remote DB2. Then set up a local ODBC datasource and configure it with that DB2 connection. Now in a script, you can type the following statement: libname l ODBC dsn=<odbc-datasource-name> user=<userid> pwd=<password>; You can then refer to tables in the userid's schema by just saying, for example: data people; set l employee; This example will copy the table called employee from the userid's schema to a local data set called people. You would now be able to browse the local data set from the Workbench. WPS also supports a schema option on libname: libname l ODBC dsn=<odbc-datasource-name> user=<userid> pwd=<password> schema=<whatever>; and then when you say: data people; set l employee; Command Line WPS it refers to the table in the whatever schema. Besides being able to use WPS in Workbench mode (i.e from the graphical user interface), you can also use the system in command line mode. This provides a way of running scripts outside of the Workbench which is often refered to as running in batch mode. You cannot compile scripts into run-time jobs. To use WPS from a command line you need to execute wps.exe on Windows, or wps on any of the Unix based platforms. This executable is located in the bin directory of the WPS installation. The following examples assume a Windows environment, hence the use of wps.exe. wps.exe <options> <scriptfilename> The <options> can be a list of either: -optionname [optionalvalue] 79

82 -config <configfilename> -set <envvarname> <envvarvalue> Scripts When you run a script using wps, the <scriptfilename> should always be the last parameter you define. In fact, when wps executes, the first parameter that is encountered which does not start with a dash (-) will be considered to be the name of the script to run. Options To explicitly set a system option to use with wps, you should specify: wps.exe -optionname [optionalvalue] <scriptfilename> You can pass as many optionname system options to wps as you desire. You can only pass wps single valued options on the command line. It does not allow parentheses. You can quote values with spaces in, but the quotes will be removed. Configuration Files System options can be defined in a configuration (config) file and the file explicitly referenced when executing wps: wps.exe -config <configfilename> <scriptfilename> Please refer to the Configuration Files section for a more detailed discussion about configuration files and the order in which they are processed. Note: When running script using wps, any WPS System Options that have been setup as a preference under the graphical user interface, will be ignored. Environment Variables To set an environment variable to use with wps: wps.exe -set <envvarname> <envvarvalue> <scriptfilename> You can set as many environment variables as you want but wps only allows single valued values on the command line. It does not allow parentheses. Output Log Information When you run a script with wps, the log information about the run is automatically sent to the DOS window in which WPS is running. Once the script has finshed running and the DOS window closes, this log information is lost. To capture the log information you need to send it to an external file: wps.exe <options> <scriptfilename> > <logfilename> Capturing the log information in this way means it will no longer be displayed in the 80

83 DOS window as the script is running. Every time you capture the log information into a file with the same name, the file will be re-created. In other words, log information is not appended to the same file; it only shows details from the latest run. Results Output Configuration Files When a script is run using wps, any results generated by the script are automatically captured into a file called <scriptfilename>.lst created in the same directory as the script. For example we would get a file called Script1.lst if we ran a script called Script1.sas. You can open this results file with Windows Notepad. Example of Using command Line WPS An example of how to use wps to run a script and how to see the log and listing output generated from the run can be found in this guide under the section called Run a script on the command line. Configuration files are files that contain system options that control the initial WPS environment. Configuration files are used during WPS initialisation when WPS is run from the command line, and when the Workbench is being used. A configuration file is a simple text file that you can open in a text editor to add, remove or change system options to suit your needs. There is a base configuration file that is included with the WPS installation, called wps.cfg and it is located in the directory where WPS is installed. It is recommended that this file be left untouched and one of the override mechanisms below be used it any modifications need to be made. A number of configuration files can be processed during WPS initialisation, each of which may set some of the same options. If an option is set in more than one place the last one processed will have precedence. Options set on the command line, or options set in the Startup Options configuration panel for a server will overide any settings that are set in the configuration files. WPS Initialisation Procedure for Windows When WPS is invoked, the following initialisation procedure occurs: 1. WPS checks the operating system environment variable WPS_SYS_CONFIG. If it exists then the specified configuration file is processed first. The processing of this file doesn't affect whether the default configuration files are loaded. 2. Any files specified via the -config option on the command line, or specified in the Startup Options configuration panel for a server will be processed next. If any configuration files are specified in -config options in this way, then the default configuration files listed below are not loaded, and instead the process jumps straight to the processing of WPS_USER_CONFIG (step 4). Note that overriding the default configuration file processing, specifically the loading of the wps.cfg file in the WPS installation directory must be done with care. There are many required options in the base wps.cfg file. If you choose to use the -config option it is recommended that you either take a copy of the base wps.cfg file and modify it to suit, or you make sure to include the base wps.cfg file in your customer configuration file and then override any settings you need, for example: 81

84 -set wpshome 'somewhere' -config!wpshome/wps.cfg /* And now set any options you want */ 3. Then WPS checks for a number of default configuration files. These are processed in the following order: a. wps.cfg in the WPS installation directory b. My Documents/My WPS Files/.wps.cfg c. My Documents/My WPS Files/wps.cfg d. My Documents/My WPS Files/.wpsv3.cfg e. My Documents/My WPS Files/wpsv3.cfg f. wps.cfg in the current directory g. wpsv3.cfg in the current directory 4. WPS checks for the environment variable WPS_USER_CONFIG. If it exists then the specified configuration file is processed. 5. WPS checks for the environment variable WPS_OPTIONS. If it exists, then any options that are specified in WPS_OPTIONS are processed. The syntax of this environment variable is the same as if the options are specified on the command line. 6. Any options specified on the command line are then processed. WPS Initialisation Procedure for UNIX platforms When WPS is invoked, the following initialisation procedure occurs. 1. All configuration files specified via -config options on the command line or in the Startup Options configuration panel for a server are processed first. If any configuration files are loaded in this way, then the list of default configuration variables in step 4 are not loaded. 2. WPS then checks the WPS_OPTIONS and WPS_V3OPTIONS environment variables for -config options and processes those files. If any configuration files are loaded in this way, then the list of default configuration variables in step 4 are not loaded. Note that this step is skipped if the -NOCONFIG option is specified on the command line. 3. WPS then checks the following environment variables, and if they exist loads the configuration files named by them (the environment variables are expected to name a single configuration file each): a. WPS_CONFIG b. WPS_V3CONFIG If any configuration files are loaded in this way, then the list of default configuration variables in step 4 are not loaded. Note that this step is skipped if the -NOCONFIG option is specified on the command line. 4. Assuming that no configuration files have yet been loaded, the list of default configuration files is loaded. The following files are loaded in the order shown: wps.cfg in the WPS installation directory wps_local.cfg in the WPS installation directory. This file can be editted to provide site specific overrides of various options..wps.cfg in your home directory wps.cfg in your home directory.wpsv3.cfg in your home directory wpsv3.cfg in your home directory wps.cfg in the current directory wpsv3.cfg in the current directory 5. WPS checks for the environment variable WPS_OPTIONS. If it exists, then any options that are specified in WPS_OPTIONS are processed. The syntax of this environment variable is the same as if the options are specified on the command line. 6. WPS checks for the environment variable WPS_V3OPTIONS and processes it in the same way. 7. Any options specified on the command line are then processed. 82

85 There are also so-called "restricted" configuration files that will always be processed. Any options in these files cannot be changed by any other method. The files are based on the user's userid and groupid. For example if the user is <user> and the group is <group> then the following configuration files will be processed: misc/rstropts/rwps.cfg in the WPS installation directory misc/rstropts/groups/<group>_rwps.cfg in the WPS installation directory misc/rstropts/users/<user>_rwps.cfg in the WPS installation directory Getting Information About the Startup Procedure It is possible to check which config files have been processed by checking the CONFIG system option. You can do this by invoking a simple PROC OPTIONS statement as follows: proc options option=config; run; When using the Workbench you can get thie information in the following way. Ensure that you have the Server Explorer View open and right click on the Server icon and choose Properties from the pop-up menu. In the Properties dialog, choose System Options and you will see the values of all system options for the server. Scrolling down to CONFIG will show all the configuration files that were used. You can also set the VERBOSE system option on the command line, or in the Startup Options configuration panel for a server and WPS will generate information in the normal log output indicating which configuration files were processed and which system options were set. To set the VERBOSE option in the workbench, take the following steps. From the Startup Options screen it is possible to change the values that System Options will be set to when the Workbench is loaded. For example: 1. Open the Properties for the relevant server 2. Select Startup Options from the list ov available pages on the left hand side 3. Click Add Scroll down the list and find the VERBOSE option and click OK. 5. Click on the dropdown box under Value and change the value from false to true. 6. Click OK 7. A message box will appear stating that the change will not occur until the server is restarted. Click Yes to perform the restart. 8. Check the log (see Working with Logs ) and the change to the VERBOSE option means that the processed configuration files and the system options will be shown there when the Workbench starts. AutoExec files AutoExec files are scripts that are automatically executed when WPS is started. This can be used for an number of purposes e.g. setting up common libnames so that they do not need to added to each script that is run. Using the command line version (see Run a script on the command line ) means that the file will be executed each time wps is run. When using the Workbench the file will be executed when WPS is first launched and each time the server is restarted. The Workbench also offers the chance to have code that is run before and/or after each script. Please see WPS Code Injection for more details. 83

86 Specifying an AutoExec file WPS will automatically look for a file called autoexec.sas in a number of directories depending on your operating system. Windows WPS will look in the follow directories: (current directory) My Documents paths specified in the PATH environment variable the root directory of the current drive e.g. C:\ the directory where WPS is installed Other operating systems WPS will look in the follow directories: (current directory) $HOME the directory where WPS is installed Specifying a different file If you wish to run a file that is called something else or is in a non-standard directory then this can be achieved by setting the AUTOEXEC system option. This can can be done via Configuration Files. If using the Workbench then it can also be done using server properties. Ensure you have the Output Explorer View or Results Explorer View open and right click on the Server icon and choose Properties from the pop-up menu. From there choose Startup Options from the dialog box that is shown then : Click Add... Scroll down the list and find the AUTOEXEC option and click OK. Click on the box under Value and then type the path to the file that you wish to be used. Alternatively click... and type it into the dialog box that is shown. Click OK A message box will appear stating that the change will not occur until the server is restarted. Click Yes to perform the restart. Once the server has been restarted then the file you have specified will have been executed. Please note that if a default autoexec.sas is found and executed then the AUTOEXEC system option will be changed to point to that file. Welcome Pages About The welcome pages display introductory information about WPS Workbench. The pages are grouped into the following sections: Welcome: Allows you to display this page. Overview: Displays topics that will help introduce you to the system. Tutorial: Lists available tutorials (known as 'cheat sheets') that you can launch to provide step by step guidence in using WPS software. What's New: Displays information about new features, about how to migrate from SAS software or previous versions of WPS software and also provides a link to the download site where you can get updates to the WPS software. 84

87 These icons are normally displayed at the top of the welcome pages, apart from the start page when they are displayed in the middle of the screen. Simply click on the appropriate icon to display the associated page. Closing and Opening the Welcome Pages When you want to close the welcome pages so you can use the Workbench, click on the big Workbench icon which is displayed near the top right of the welcome screen. You can re-open the welcome pages at any time by selecting the menu item Help --> Welcome. Other Controls Located near the top right of the welcome pages are navigation and size control buttons. Navigation Buttons: These behave much like the buttons on a normal web browser. Home: Go to the start page. Back: Go back to the last page. Forward: Go forward to the previous page. Size Control Buttons: These change the size of the welcome pages within WPS Workbench. Minimize: Shrink the welcome pages to their minimum size. This will reveal other windows that are open. Restore: Make the welcome pages go back to a normal docked view along-side the other open windows. Maximize: Expand the welcome pages to fit the entire Workbench and hide any other open windows. 85

88 Legal Notices General acknowledgements: SAS and all other SAS Institute Inc. product or service names are registered trademarks or trademarks of SAS Institute Inc. in the USA and other countries. indicates USA registration. World Programming Limited is not associated in any way with the SAS Institute. All other trademarks are the property of their respective owner. WPS is not the SAS System. The phrase "language of SAS" used in this document is used in a generic sense to describe the computer language often called "the SAS language". Third Party Software WPS includes software developed by third parties. For more details, please refer to the acknowledgments.txt file in the root directory of your installation. If you use WPS on a UNIX platform this file will be called THANKS. 86

89 Reporting problems Known issues There are currently no known critical issues with WPS Workbench. If you encounter problems please follow the instructions below. Getting support How you access technical support for your WPS software depends on how you purchased your software. You can rest assured that WPS always comes with maintenance and support. If you made a standard purchase of WPS software you will have an annual subscription license that entitles you to unlimited free upgrades throughout the twelve months, and free support via support@teamwpc.co.uk. We always respond promptly to support and will do our best to work within an acceptable timescale. Larger customers may have additional support arrangements in place. In this case we may often provide access to our online Issue Tracking System. Your organisation may have nominated super users through which all technical support requests are handled. Resolutions to problems may include suggested workarounds or may require you to update your WPS software installation. Due to the complex nature of the language of SAS it may require some interaction between World Programming and you to identify and resolve the cause of the problem. Stack Trace If an error occurs within the WPS server then you will see a messagebox informing you that the server has terminated unexpectedly. It will also open the Console View and display the stack trace in red, looking something like the following: The text in red is what would need to be highlighted and and passed on as part of the 87

WPS Workbench. user guide. "To help guide you through using the WPS user interface (Workbench) to create, edit and run programs"

WPS Workbench. user guide. To help guide you through using the WPS user interface (Workbench) to create, edit and run programs WPS Workbench user guide "To help guide you through using the WPS user interface (Workbench) to create, edit and run programs" Version: 3.1.7 Copyright 2002-2018 World Programming Limited www.worldprogramming.com

More information

WPS Workbench. user guide. To help guide you through using WPS Workbench to create, edit and run programs. Workbench user guide Version 3.

WPS Workbench. user guide. To help guide you through using WPS Workbench to create, edit and run programs. Workbench user guide Version 3. WPS Workbench user guide To help guide you through using WPS Workbench to create, edit and run programs Version: 3.3.4 Copyright 2002-2018 World Programming Limited www.worldprogramming.com Contents Introduction...7

More information

At the shell prompt, enter idlde

At the shell prompt, enter idlde IDL Workbench Quick Reference The IDL Workbench is IDL s graphical user interface and integrated development environment. The IDL Workbench is based on the Eclipse framework; if you are already familiar

More information

Embarcadero PowerSQL 1.1 Evaluation Guide. Published: July 14, 2008

Embarcadero PowerSQL 1.1 Evaluation Guide. Published: July 14, 2008 Embarcadero PowerSQL 1.1 Evaluation Guide Published: July 14, 2008 Contents INTRODUCTION TO POWERSQL... 3 Product Benefits... 3 Product Benefits... 3 Product Benefits... 3 ABOUT THIS EVALUATION GUIDE...

More information

Eclipse Quick Reference Windows Hosted

Eclipse Quick Reference Windows Hosted Eclipse Quick Reference Windows Hosted Menus and Keyboard Shortcuts (some menus/items can be hidden in any perspective) File Menu New Open Path Open File Close Close All Save Save As Save All Revert Move

More information

DS-5 ARM. Using Eclipse. Version Copyright ARM. All rights reserved. ARM DUI 0480L (ID100912)

DS-5 ARM. Using Eclipse. Version Copyright ARM. All rights reserved. ARM DUI 0480L (ID100912) ARM DS-5 Version 5.12 Using Eclipse Copyright 2010-2012 ARM. All rights reserved. ARM DUI 0480L () ARM DS-5 Using Eclipse Copyright 2010-2012 ARM. All rights reserved. Release Information The following

More information

The Road to CCSv4. Status Update

The Road to CCSv4. Status Update The Road to CCSv4 Status Update Code Composer Studio v4 Summary What is it? Major upgrade to CCS Major architectural changes Based on Eclipse open source software framework New registration/licensing/updating

More information

with TestComplete 12 Desktop, Web, and Mobile Testing Tutorials

with TestComplete 12 Desktop, Web, and Mobile Testing Tutorials with TestComplete 12 Desktop, Web, and Mobile Testing Tutorials 2 About the Tutorial With TestComplete, you can test applications of three major types: desktop, web and mobile: Desktop applications - these

More information

Getting Started with Fedora

Getting Started with Fedora Getting Started with Fedora Author: Nah Soo Hoe GETTING STARTED In order to start using your system you will usually have to perform what is known as a user login. This procedure is necessary to identify

More information

IBM Rational Rhapsody Gateway Add On. User Manual

IBM Rational Rhapsody Gateway Add On. User Manual User Manual Rhapsody IBM Rational Rhapsody Gateway Add On User Manual License Agreement No part of this publication may be reproduced, transmitted, stored in a retrieval system, nor translated into any

More information

Server Edition USER MANUAL. For Mac OS X

Server Edition USER MANUAL. For Mac OS X Server Edition USER MANUAL For Mac OS X Copyright Notice & Proprietary Information Redstor Limited, 2016. All rights reserved. Trademarks - Mac, Leopard, Snow Leopard, Lion and Mountain Lion are registered

More information

Managing Your Website with Convert Community. My MU Health and My MU Health Nursing

Managing Your Website with Convert Community. My MU Health and My MU Health Nursing Managing Your Website with Convert Community My MU Health and My MU Health Nursing Managing Your Website with Convert Community LOGGING IN... 4 LOG IN TO CONVERT COMMUNITY... 4 LOG OFF CORRECTLY... 4 GETTING

More information

IBM Rational Rhapsody Gateway Add On. User Guide

IBM Rational Rhapsody Gateway Add On. User Guide User Guide Rhapsody IBM Rational Rhapsody Gateway Add On User Guide License Agreement No part of this publication may be reproduced, transmitted, stored in a retrieval system, nor translated into any

More information

Desktop & Laptop Edition

Desktop & Laptop Edition Desktop & Laptop Edition USER MANUAL For Mac OS X Copyright Notice & Proprietary Information Redstor Limited, 2016. All rights reserved. Trademarks - Mac, Leopard, Snow Leopard, Lion and Mountain Lion

More information

Skills Funding Agency

Skills Funding Agency Provider Data Self-Assessment Toolkit (PDSAT) v17 User Guide Contents Introduction... 2 Compatibility and prerequisites... 2 1. Installing PDSAT... 3 2. Opening PDSAT... 6 2.1 Opening Screen... 6 2.2 Updates...

More information

OpenForms360 Validation User Guide Notable Solutions Inc.

OpenForms360 Validation User Guide Notable Solutions Inc. OpenForms360 Validation User Guide 2011 Notable Solutions Inc. 1 T A B L E O F C O N T EN T S Introduction...5 What is OpenForms360 Validation?... 5 Using OpenForms360 Validation... 5 Features at a glance...

More information

A Guided Tour of Doc-To-Help

A Guided Tour of Doc-To-Help A Guided Tour of Doc-To-Help ii Table of Contents Table of Contents...ii A Guided Tour of Doc-To-Help... 1 Converting Projects to Doc-To-Help 2005... 1 Using Microsoft Word... 10 Using HTML Source Documents...

More information

Introduction. Archi is a free, open source, cross-platform tool to create ArchiMate models.

Introduction. Archi is a free, open source, cross-platform tool to create ArchiMate models. Version 4.2 Introduction Archi is a free, open source, cross-platform tool to create ArchiMate models. The Archi modelling tool is targeted toward all levels of Enterprise Architects and Modellers. It

More information

Stamina Software Pty Ltd. TRAINING MANUAL Viságe Reporter

Stamina Software Pty Ltd. TRAINING MANUAL Viságe Reporter Stamina Software Pty Ltd TRAINING MANUAL Viságe Reporter Version: 2 21 st January 2009 Contents Introduction...1 Assumed Knowledge...1 Pre Planning...1 Report Designer Location...2 Report Designer Screen

More information

1 Overview. 1 Overview. Contents. 1.1 Table of Contents Table of Contents

1 Overview. 1 Overview. Contents. 1.1 Table of Contents Table of Contents 1 Overview Contents 1. 1.1 Table of Contents 1 Overview Papyrus is an environment for editing any kind of EMF model, particularly supporting UML 2 ( Unified Modeling Language (UML) version 2.4.1 ) and

More information

Infor LN Studio Application Development Guide

Infor LN Studio Application Development Guide Infor LN Studio Application Development Guide Copyright 2016 Infor Important Notices The material contained in this publication (including any supplementary information) constitutes and contains confidential

More information

FrontPage Help Center. Topic: FrontPage Basics

FrontPage Help Center. Topic: FrontPage Basics FrontPage Help Center Topic: FrontPage Basics by Karey Cummins http://www.rtbwizards.com http://www.myartsdesire.com 2004 Getting Started... FrontPage is a "What You See Is What You Get" editor or WYSIWYG

More information

Embarcadero DB Optimizer 1.0 Evaluation Guide. Published: July 14, 2008

Embarcadero DB Optimizer 1.0 Evaluation Guide. Published: July 14, 2008 Published: July 14, 2008 Embarcadero Technologies, Inc. 100 California Street, 12th Floor San Francisco, CA 94111 U.S.A. This is a preliminary document and may be changed substantially prior to final commercial

More information

Using Eclipse for Java. Using Eclipse for Java 1 / 1

Using Eclipse for Java. Using Eclipse for Java 1 / 1 Using Eclipse for Java Using Eclipse for Java 1 / 1 Using Eclipse IDE for Java Development Download the latest version of Eclipse (Eclipse for Java Developers or the Standard version) from the website:

More information

Assignment 1. Application Development

Assignment 1. Application Development Application Development Assignment 1 Content Application Development Day 1 Lecture The lecture provides an introduction to programming, the concept of classes and objects in Java and the Eclipse development

More information

Business Insight Authoring

Business Insight Authoring Business Insight Authoring Getting Started Guide ImageNow Version: 6.7.x Written by: Product Documentation, R&D Date: August 2016 2014 Perceptive Software. All rights reserved CaptureNow, ImageNow, Interact,

More information

A Guide to Quark Author Web Edition 2015

A Guide to Quark Author Web Edition 2015 A Guide to Quark Author Web Edition 2015 CONTENTS Contents Getting Started...4 About Quark Author - Web Edition...4 Smart documents...4 Introduction to the Quark Author - Web Edition User Guide...4 Quark

More information

Your password is: firstpw

Your password is: firstpw SHARE Session #9777: WebSphere and Rational Developer Hands-on-Labs Building Java application on System z with RDz Lab exercise (estimate duration) Part 1: Your first Java application on z/os (~35 min).

More information

Module 3: Working with C/C++

Module 3: Working with C/C++ Module 3: Working with C/C++ Objective Learn basic Eclipse concepts: Perspectives, Views, Learn how to use Eclipse to manage a remote project Learn how to use Eclipse to develop C programs Learn how to

More information

A Guided Tour Through the SAS Windowing Environment Casey Cantrell, Clarion Consulting, Los Angeles, CA

A Guided Tour Through the SAS Windowing Environment Casey Cantrell, Clarion Consulting, Los Angeles, CA A Guided Tour Through the SAS Windowing Environment Casey Cantrell, Clarion Consulting, Los Angeles, CA ABSTRACT The SAS system running in the Microsoft Windows environment contains a multitude of tools

More information

Bombardier Business Aircraft Customer Services. Technical Publications. SmartPubs Viewer 3.0 User Guide. Updated January 2013 [2013]

Bombardier Business Aircraft Customer Services. Technical Publications. SmartPubs Viewer 3.0 User Guide. Updated January 2013 [2013] Bombardier Business Aircraft Customer Services Technical Publications SmartPubs Viewer 3.0 User Guide Updated January 2013 [2013] Table of Contents Application Views... 5 Collection View... 5 Manual View...

More information

Welcome Application. Introducing the Visual Studio.NET IDE. Objectives. Outline

Welcome Application. Introducing the Visual Studio.NET IDE. Objectives. Outline 2 T U T O R I A L Objectives In this tutorial, you will learn to: Navigate Visual Studio.NET s Start Page. Create a Visual Basic.NET solution. Use the IDE s menus and toolbars. Manipulate windows in the

More information

Server Edition. V8 Peregrine User Manual. for Linux and Unix operating systems

Server Edition. V8 Peregrine User Manual. for Linux and Unix operating systems Server Edition V8 Peregrine User Manual for Linux and Unix operating systems Copyright Notice and Proprietary Information All rights reserved. Attix5, 2015 Trademarks - Red Hat is a registered trademark

More information

Introduction to IBM Data Studio, Part 1: Get started with IBM Data Studio, Version and Eclipse

Introduction to IBM Data Studio, Part 1: Get started with IBM Data Studio, Version and Eclipse Introduction to IBM Data Studio, Part 1: Get started with IBM Data Studio, Version 1.1.0 and Eclipse Install, work with data perspectives, create connections, and create a project Skill Level: Intermediate

More information

Introduction to IBM Data Studio, Part 1: Get started with IBM Data Studio, Version and Eclipse

Introduction to IBM Data Studio, Part 1: Get started with IBM Data Studio, Version and Eclipse Introduction to IBM Data Studio, Part 1: Get started with IBM Data Studio, Version 1.1.0 and Eclipse Install, work with data perspectives, create connections, and create a project Skill Level: Intermediate

More information

IBM ILOG OPL IDE Reference

IBM ILOG OPL IDE Reference IBM ILOG OPL V6.3 IBM ILOG OPL IDE Reference Copyright International Business Machines Corporation 1987, 2009 US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP

More information

Caja File Manager. Desktop User Guide

Caja File Manager. Desktop User Guide Caja File Manager Desktop User Guide Desktop User Guide» Working with Files This chapter describes how to use the Caja file manager. Introduction Spatial Mode Browser Mode Opening Files Searching For Files

More information

Press the Plus + key to zoom in. Press the Minus - key to zoom out. Scroll the mouse wheel away from you to zoom in; towards you to zoom out.

Press the Plus + key to zoom in. Press the Minus - key to zoom out. Scroll the mouse wheel away from you to zoom in; towards you to zoom out. Navigate Around the Map Interactive maps provide many choices for displaying information, searching for more details, and moving around the map. Most navigation uses the mouse, but at times you may also

More information

Marthon User Guide. Page 1 Copyright The Marathon developers. All rights reserved.

Marthon User Guide. Page 1 Copyright The Marathon developers. All rights reserved. 1. Overview Marathon is a general purpose tool for both running and authoring acceptance tests geared at the applications developed using Java and Swing. Included with marathon is a rich suite of components

More information

Concordance Basics. Part I

Concordance Basics. Part I Concordance Basics Part I 1 Getting Started 1 Familiarity with the Concordance environment is the first step in learning the multi-faceted features of this powerful program. This chapter focuses on learning

More information

Eclipse Tutorial. For Introduction to Java Programming By Y. Daniel Liang

Eclipse Tutorial. For Introduction to Java Programming By Y. Daniel Liang Eclipse Tutorial For Introduction to Java Programming By Y. Daniel Liang This supplement covers the following topics: Getting Started with Eclipse Choosing a Perspective Creating a Project Creating a Java

More information

MS PowerPoint Useful Features. Choose start options. Change Office backgrounds and colours

MS PowerPoint Useful Features. Choose start options. Change Office backgrounds and colours MS PowerPoint Useful Features Note: Depending on your installation of MS Office, the screens you see on your PC may vary slightly from those shown on this fact sheet. Choose start options The first time

More information

Customized Enterprise Installation of IBM Rational ClearCase Using the IBM Rational ClearCase Remote Client plug-in and the Eclipse SDK

Customized Enterprise Installation of IBM Rational ClearCase Using the IBM Rational ClearCase Remote Client plug-in and the Eclipse SDK Customized Enterprise Installation of IBM Rational ClearCase Using the IBM Rational ClearCase Remote Client plug-in and the Eclipse SDK Fred Bickford IV Senior Advisory Software Engineer IBM Rational Customer

More information

Introducing Microsoft Office Specialist Excel Module 1. Adobe Captivate Wednesday, May 11, 2016

Introducing Microsoft Office Specialist Excel Module 1. Adobe Captivate Wednesday, May 11, 2016 Slide 1 - Introducing Microsoft Office Specialist Excel 2013 Introducing Microsoft Office Specialist Excel 2013 Module 1 Page 1 of 25 Slide 2 - Lesson Objectives Lesson Objectives Understand what Microsoft

More information

QuickStart Guide MindManager 7 MAC

QuickStart Guide MindManager 7 MAC QuickStart Guide MindManager 7 MAC Contents Welcome to Mindjet MindManager...... 1 Technical Support and Registration... 1 About this User Guide............... 1 Learn about MindManager and maps... 2 What

More information

Enterprise Architect. User Guide Series. Ribbons. Author: Sparx Systems Date: 27/05/2016 Version: 1.0 CREATED WITH

Enterprise Architect. User Guide Series. Ribbons. Author: Sparx Systems Date: 27/05/2016 Version: 1.0 CREATED WITH Enterprise Architect User Guide Series Ribbons Author: Sparx Systems Date: 27/05/2016 Version: 1.0 CREATED WITH Table of Contents Ribbons 4 File Management 6 Show Panel 8 Start Ribbon 12 Using the Explore

More information

StarTeam File Compare/Merge StarTeam File Compare/Merge Help

StarTeam File Compare/Merge StarTeam File Compare/Merge Help StarTeam File Compare/Merge 12.0 StarTeam File Compare/Merge Help Micro Focus 575 Anton Blvd., Suite 510 Costa Mesa, CA 92626 Copyright 2011 Micro Focus IP Development Limited. All Rights Reserved. Portions

More information

Server Edition USER MANUAL. For Microsoft Windows

Server Edition USER MANUAL. For Microsoft Windows Server Edition USER MANUAL For Microsoft Windows Copyright Notice & Proprietary Information Redstor Limited, 2016. All rights reserved. Trademarks - Microsoft, Windows, Microsoft Windows, Microsoft Windows

More information

Data Express 4.0. Data Subset Extraction

Data Express 4.0. Data Subset Extraction Data Express 4.0 Data Subset Extraction Micro Focus The Lawn 22-30 Old Bath Road Newbury, Berkshire RG14 1QN UK http://www.microfocus.com Copyright Micro Focus 2009-2014. All rights reserved. MICRO FOCUS,

More information

Creating a new CDC policy using the Database Administration Console

Creating a new CDC policy using the Database Administration Console Creating a new CDC policy using the Database Administration Console When you start Progress Developer Studio for OpenEdge for the first time, you need to specify a workspace location. A workspace is a

More information

Quick Guide FAST HR. For more resources, including a guide on FAST HR codes, visit # Instructions Screenshot

Quick Guide FAST HR. For more resources, including a guide on FAST HR codes, visit   # Instructions Screenshot Tips & tricks This quick guide describes basic navigation within the FAST HR reporting tool, including how to use filter options, format columns and export reports. For more resources, including a guide

More information

A QUICK OVERVIEW OF THE OMNeT++ IDE

A QUICK OVERVIEW OF THE OMNeT++ IDE Introduction A QUICK OVERVIEW OF THE OMNeT++ IDE The OMNeT++ Integrated Development Environment is based on the Eclipse platform, and extends it with new editors, views, wizards, and additional functionality.

More information

Introduction to IBM Rational HATS For IBM System i (5250)

Introduction to IBM Rational HATS For IBM System i (5250) Introduction to IBM Rational HATS For IBM System i (5250) Introduction to IBM Rational HATS 1 Lab instructions This lab teaches you how to use IBM Rational HATS to create a Web application capable of transforming

More information

Embarcadero DB Optimizer 1.5 Evaluation Guide. Published: March 16, 2009

Embarcadero DB Optimizer 1.5 Evaluation Guide. Published: March 16, 2009 Embarcadero DB Optimizer 1.5 Evaluation Guide Published: March 16, 2009 Contents INTRODUCTION TO DB OPTIMIZER... 4 Product Benefits... 4 ABOUT THIS EVALUATION GUIDE... 6 SESSION 1: GETTING STARTED WITH

More information

User Guide. Product: GreenFolders. Version: 3.8

User Guide. Product: GreenFolders. Version: 3.8 User Guide Product: GreenFolders Version: 3.8 Release Date: October 2014 GreenFolders 3.8 User Guide Introduction Table of Contents 1 Introduction... 6 2 General Information... 7 2.1 Login Procedure...

More information

Chapter 2 Using Slide Masters, Styles, and Templates

Chapter 2 Using Slide Masters, Styles, and Templates Impress Guide Chapter 2 Using Slide Masters, Styles, and Templates OpenOffice.org Copyright This document is Copyright 2007 by its contributors as listed in the section titled Authors. You can distribute

More information

Zend Studio 3.0. Quick Start Guide

Zend Studio 3.0. Quick Start Guide Zend Studio 3.0 This walks you through the Zend Studio 3.0 major features, helping you to get a general knowledge on the most important capabilities of the application. A more complete Information Center

More information

Tutorial: Maintaining an ILE COBOL application: Introducing a new level of server tool integration for iseries application development

Tutorial: Maintaining an ILE COBOL application: Introducing a new level of server tool integration for iseries application development Page 1 of 165 Tutorial: Maintaining an ILE COBOL application: Introducing a new level of server tool integration for iseries application development About the tutorial This tutorial through a series of

More information

Bucknell University Digital Collections. LUNA Insight User Guide February 2006

Bucknell University Digital Collections. LUNA Insight User Guide February 2006 Bucknell University Digital Collections LUNA Insight User Guide February 2006 User Guide - Table of Contents Topic Page Number Installing Insight. 2-4 Connecting to Insight 5 Opening Collections. 6 Main

More information

Server Edition. V8 Peregrine User Manual. for Microsoft Windows

Server Edition. V8 Peregrine User Manual. for Microsoft Windows Server Edition V8 Peregrine User Manual for Microsoft Windows Copyright Notice and Proprietary Information All rights reserved. Attix5, 2015 Trademarks - Microsoft, Windows, Microsoft Windows, Microsoft

More information

ARM DS-5. Eclipse for DS-5 User Guide. Version 5. Copyright ARM. All rights reserved. ARM DUI0480Q

ARM DS-5. Eclipse for DS-5 User Guide. Version 5. Copyright ARM. All rights reserved. ARM DUI0480Q ARM DS-5 Version 5 Eclipse for DS-5 User Guide Copyright 2010-2015 ARM. All rights reserved. ARM DUI0480Q ARM DS-5 ARM DS-5 Eclipse for DS-5 User Guide Copyright 2010-2015 ARM. All rights reserved. Release

More information

TRAINING GUIDE. Web App End User Training

TRAINING GUIDE. Web App End User Training TRAINING GUIDE Web App End User Training Web Application End-User Training In this booklet, we will introduce you to the Lucity Web application. The Web system allows you to utilize customized views, forms,

More information

TI Connect CE Software

TI Connect CE Software TI Connect CE Software This guidebook applies to version 5.2. To obtain the latest version of the documentation, go to education.ti.com/go/download. Legal Information Important Information Texas Instruments

More information

Enterprise Architect. User Guide Series. Ribbons. Author: Sparx Systems Date: 15/07/2016 Version: 1.0 CREATED WITH

Enterprise Architect. User Guide Series. Ribbons. Author: Sparx Systems Date: 15/07/2016 Version: 1.0 CREATED WITH Enterprise Architect User Guide Series Ribbons Author: Sparx Systems Date: 15/07/2016 Version: 1.0 CREATED WITH Table of Contents Ribbons 4 File Management 6 Show Panel 8 Start Ribbon 12 Using the Explore

More information

CA Gen. Gen Studio Overview Guide. Release 8.5. Third Edition

CA Gen. Gen Studio Overview Guide. Release 8.5. Third Edition CA Gen Gen Studio Overview Guide Release 8.5 Third Edition This Documentation, which includes embedded help systems and electronically distributed materials (hereinafter referred to as the Documentation

More information

Interface. 2. Interface Adobe InDesign CS2 H O T

Interface. 2. Interface Adobe InDesign CS2 H O T 2. Interface Adobe InDesign CS2 H O T 2 Interface The Welcome Screen Interface Overview The Toolbox Toolbox Fly-Out Menus InDesign Palettes Collapsing and Grouping Palettes Moving and Resizing Docked or

More information

Using Sitecore 5.3.1

Using Sitecore 5.3.1 Using Sitecore 5.3.1 An End-User s Guide to Using and Administrating Sitecore Author: Sitecore Corporation Date: December 12, 2007 Release: Rev. 1.0 Language: English Sitecore is a registered trademark.

More information

Chapter 3. HDL Editor. Introduction. Figure 3-1. HDL Editor Welcome Screen. Introduction 3-1

Chapter 3. HDL Editor. Introduction. Figure 3-1. HDL Editor Welcome Screen. Introduction 3-1 Introduction 3-1 Chapter 3 HDL Editor Introduction The HDL editor is used for entering and editing designs expressed by ABEL and VHDL programs statements. The HDL editor is invoked by clicking on the HDL

More information

Outlook Quick Start Guide

Outlook Quick Start Guide Getting Started Outlook 2013 Quick Start Guide File Tab: Click to access actions like Print, Save As, etc. Also to set Outlook Options. Quick Access Toolbar: Add your mostused tool buttons to this customizable

More information

Teamcenter 11.1 Systems Engineering and Requirements Management

Teamcenter 11.1 Systems Engineering and Requirements Management SIEMENS Teamcenter 11.1 Systems Engineering and Requirements Management Systems Architect/ Requirements Management Project Administrator's Manual REQ00002 U REQ00002 U Project Administrator's Manual 3

More information

TeXnicCenter v1 Beta Frank Van Puyvlde ICT for Research K.U.Leuven

TeXnicCenter v1 Beta Frank Van Puyvlde ICT for Research K.U.Leuven TeXnicCenter v1 Beta 7.01 Frank Van Puyvlde ICT for Research K.U.Leuven March 2008 Contents 1 TeXnicCenter Installation 2 1.1 Installing TeXnicCenter........................... 2 1.2 TeXnicCenter and a

More information

DB2 for z/os Stored Procedure support in Data Server Manager

DB2 for z/os Stored Procedure support in Data Server Manager DB2 for z/os Stored Procedure support in Data Server Manager This short tutorial walks you step-by-step, through a scenario where a DB2 for z/os application developer creates a query, explains and tunes

More information

In this lab, you will build and execute a simple message flow. A message flow is like a program but is developed using a visual paradigm.

In this lab, you will build and execute a simple message flow. A message flow is like a program but is developed using a visual paradigm. Lab 1 Getting Started 1.1 Building and Executing a Simple Message Flow In this lab, you will build and execute a simple message flow. A message flow is like a program but is developed using a visual paradigm.

More information

Section Editor Quick Start. Schoolwires Academic Portal Version 4.0

Section Editor Quick Start. Schoolwires Academic Portal Version 4.0 Schoolwires Academic Portal Version 4.0 TABLE OF CONTENTS The Basics about Your Schoolwires Website...1 Website Navigation Elements...1 Prior to Signing In...1 After Signing In...2 Channel bar...2 Site

More information

Module 4: Working with MPI

Module 4: Working with MPI Module 4: Working with MPI Objective Learn how to develop, build and launch a parallel (MPI) program on a remote parallel machine Contents Remote project setup Building with Makefiles MPI assistance features

More information

Tutorial: De Novo Assembly of Paired Data

Tutorial: De Novo Assembly of Paired Data : De Novo Assembly of Paired Data September 20, 2013 CLC bio Silkeborgvej 2 Prismet 8000 Aarhus C Denmark Telephone: +45 70 22 32 44 Fax: +45 86 20 12 22 www.clcbio.com support@clcbio.com : De Novo Assembly

More information

BackupVault Desktop & Laptop Edition. USER MANUAL For Microsoft Windows

BackupVault Desktop & Laptop Edition. USER MANUAL For Microsoft Windows BackupVault Desktop & Laptop Edition USER MANUAL For Microsoft Windows Copyright Notice & Proprietary Information Blueraq Networks Ltd, 2017. All rights reserved. Trademarks - Microsoft, Windows, Microsoft

More information

1. WELDMANAGEMENT PRODUCT

1. WELDMANAGEMENT PRODUCT Table of Contents WeldManagement Product.................................. 3 Workflow Overview........................................ 4 Weld Types.............................................. 5 Weld

More information

Microsoft Windows 10. Quick Reference. Watsonia Publishing 47 Greenaway Street Bulleen VIC 3105 Australia

Microsoft Windows 10. Quick Reference. Watsonia Publishing 47 Greenaway Street Bulleen VIC 3105 Australia Watsonia Publishing 47 Greenaway Street Bulleen VIC 3105 Australia www.watsoniapublishing.com info@watsoniapublishing.com Quick Reference Course Code: INF1440 Table of Contents Chapter 1: Starting With

More information

Work Smart: Microsoft Office 2010 User Interface

Work Smart: Microsoft Office 2010 User Interface About the Office 2010 User Interface You can use this guide to learn how to use the new features of the Microsoft Office Ribbon. Topics in this guide include: What s New in the Office 2010 User Interface

More information

Prerequisites for Eclipse

Prerequisites for Eclipse Prerequisites for Eclipse 1 To use Eclipse you must have an installed version of the Java Runtime Environment (JRE). The latest version is available from java.com/en/download/manual.jsp Since Eclipse includes

More information

Maintain an ILE RPG application using Remote System Explorer

Maintain an ILE RPG application using Remote System Explorer Maintain an ILE RPG application using Remote System Explorer ii Maintain an ILE RPG application using Remote System Explorer Contents Maintain an ILE RPG application using Remote System Explorer.......

More information

MAXQDA and Chapter 9 Coding Schemes

MAXQDA and Chapter 9 Coding Schemes MAXQDA and Chapter 9 Coding Schemes Chapter 9 discusses how the structures of coding schemes, alternate groupings are key to moving forward with analysis. The nature and structures of the coding scheme

More information

Colligo Engage Outlook App 7.1. Connected Mode - User Guide

Colligo Engage Outlook App 7.1. Connected Mode - User Guide 7.1 Connected Mode - User Guide Contents Colligo Engage Outlook App 1 Benefits 1 Key Features 1 Platforms Supported 1 Installing and Activating Colligo Engage Outlook App 2 Checking for Updates 3 Updating

More information

2.2 - Layouts. Bforartists Reference Manual - Copyright - This page is Public Domain

2.2 - Layouts. Bforartists Reference Manual - Copyright - This page is Public Domain 2.2 - Layouts Introduction...2 Switching Layouts...2 Standard Layouts...3 3D View full...3 Animation...3 Compositing...3 Default...4 Motion Tracking...4 Scripting...4 UV Editing...5 Video Editing...5 Game

More information

Introduction to Windows 10 Part 1

Introduction to Windows 10 Part 1 Introduction to Windows 10 Part 1 Higham and Rushden U3A In this presentation we will have a quick look at the following: Starting Windows 10 Typical desktop layout Start screen Cortana and Search Taskbar

More information

Contents. Common Site Operations. Home actions. Using SharePoint

Contents. Common Site Operations. Home actions. Using SharePoint This is a companion document to About Share-Point. That document describes the features of a SharePoint website in as much detail as possible with an emphasis on the relationships between features. This

More information

Attix5 Pro Storage Platform Console

Attix5 Pro Storage Platform Console Attix5 Pro Storage Platform Console V7.0.1 User Manual for Microsoft Windows Your guide to managing the Attix5 Pro backup environment using the Storage Platform Console. 0 Copyright notice and proprietary

More information

Section 1 Getting Started

Section 1 Getting Started Section 1 Getting Started ECDL Section 1 Getting Started By the end of this section you should be able to: Understand PowerPoint Principles Start PowerPoint Use an Installed Template Recognise the Screen

More information

Quick Start Guide - Contents. Opening Word Locating Big Lottery Fund Templates The Word 2013 Screen... 3

Quick Start Guide - Contents. Opening Word Locating Big Lottery Fund Templates The Word 2013 Screen... 3 Quick Start Guide - Contents Opening Word... 1 Locating Big Lottery Fund Templates... 2 The Word 2013 Screen... 3 Things You Might Be Looking For... 4 What s New On The Ribbon... 5 The Quick Access Toolbar...

More information

User Guide Zend Studio for Eclipse V6.1

User Guide Zend Studio for Eclipse V6.1 User Guide Zend Studio for Eclipse V6.1 By Zend Technologies, Inc. www.zend.com Disclaimer The information in this help is subject to change without notice and does not represent a commitment on the part

More information

USER GUIDE MADCAP FLARE Accessibility

USER GUIDE MADCAP FLARE Accessibility USER GUIDE MADCAP FLARE 2018 Accessibility Copyright 2018 MadCap Software. All rights reserved. Information in this document is subject to change without notice. The software described in this document

More information

BASIC USER TRAINING PROGRAM Module 5: Test Case Development

BASIC USER TRAINING PROGRAM Module 5: Test Case Development BASIC USER TRAINING PROGRAM Module 5: Test Case Development Objective Student will have an understanding of how to create, edit and execute a Test Case from Develop a Test Case Activity Page. Student will

More information

There are six main steps in creating web pages in FrontPage98:

There are six main steps in creating web pages in FrontPage98: This guide will show you how to create a basic web page using FrontPage98 software. These instructions are written for IBM (Windows) computers only. However, FrontPage is available for Macintosh users

More information

P6 Professional Reporting Guide Version 18

P6 Professional Reporting Guide Version 18 P6 Professional Reporting Guide Version 18 August 2018 Contents About the P6 Professional Reporting Guide... 7 Producing Reports and Graphics... 9 Report Basics... 9 Reporting features... 9 Report Wizard...

More information

Report Designer Report Types Table Report Multi-Column Report Label Report Parameterized Report Cross-Tab Report Drill-Down Report Chart with Static

Report Designer Report Types Table Report Multi-Column Report Label Report Parameterized Report Cross-Tab Report Drill-Down Report Chart with Static Table of Contents Report Designer Report Types Table Report Multi-Column Report Label Report Parameterized Report Cross-Tab Report Drill-Down Report Chart with Static Series Chart with Dynamic Series Master-Detail

More information

Product Overview. All text and design is copyright 2009 Seavus, All rights reserved

Product Overview. All text and design is copyright 2009 Seavus, All rights reserved Product Overview All text and design is copyright 2009 Seavus, All rights reserved TABLE OF CONTENT 1. WELCOME TO SEAVUS DROPMIND 2 1.1 INTRODUCTION... 2 2 SEAVUS DROPMIND FUNCTIONALITIES 4 2.1 BASIC FUNCTIONALITY...

More information

Parish . User Manual

Parish  . User Manual Parish Email User Manual Table of Contents LOGGING IN TO PARISH EMAIL... 3 GETTING STARTED... 3 GENERAL OVERVIEW OF THE USER INTERFACE... 3 TERMINATE THE SESSION... 4 EMAIL... 4 MESSAGES LIST... 4 Open

More information

5.2. Click these tabs to jump to the Table of Contents, Index or start of each chapter.

5.2. Click these tabs to jump to the Table of Contents, Index or start of each chapter. 5.2 Click this button to advance to the next page. Click this button to return to the previous page. (Since this is the starting page, the [Back] button cannot be used.) Click these tabs to jump to the,

More information

Enterprise Architect. User Guide Series. Portals. Author: Sparx Systems. Date: 19/03/2018. Version: 1.0 CREATED WITH

Enterprise Architect. User Guide Series. Portals. Author: Sparx Systems. Date: 19/03/2018. Version: 1.0 CREATED WITH Enterprise Architect User Guide Series Portals Author: Sparx Systems Date: 19/03/2018 Version: 1.0 CREATED WITH Table of Contents Portals 3 Perspective Portal 6 Workspace Portal 7 Window Portal 9 Status

More information