Sage MAS 90 Eclipse Set Up For Development Partners using MKS 1/23/2009

Part 1 Installation

Part 2 Configuration

Part 3 Operation

Appendix

Part 1 Installation
Part 1 Step 1 of 4 Install/Verify Java
To run Eclipse, version 5 or higher of the Java Runtime Environment (JRE) is required. To test which version of the JRE is installed on your workstation, click the following link: Java Test If you do not already have the JRE installed on your workstation or if your installed version is below version 5, download and install it from the above test site or from the following site: Java for Windows

Part 1 Step 2 of 4 Install Eclipse

Eclipse and the ProvideX/MAS plug-ins are combined into a distribution file that must be extracted to your local Program Files folder. 1. Browse to this ProvideX site: ProvideX Eclipse Install Click on the Eclipse ProvideX Plug-in Installation Notes for details on how to download Eclipse and how to install the ProvideX Plug-in. Click on the Eclipse Downloads link to download Eclipse

2. We recommend installing Eclipse to the C:\Program Files folder. Note: For this document, Eclipse was installed to C:\Temp\Eclipse If using WinZip, make sure Use folder names is turned on. Upon completion, you will have a ..\Eclipse folder, with several folders underneath it. There is no setup program for Eclipse, so extracting the zip file completes the installation of Eclipse.

Sage MAS 90 and MAS 200

Copyright 2009 Sage Software, Inc. All rights reserved.

Page 1 of 22

Eclipse Setup

Part 1 Step 3 of 4 MKS Source Integrity Environment Variables

The MAS plug-in for Eclipse is required if MAS 90 Source code will be compiled using Eclipse. The MAS plug-in establishes the components and settings necessary for working with the Sage MAS 90 and MAS 200 Source Code. Note: The process for installing the MAS Plug-in may very depending on the version of Eclipse that is installed. 1. Help Software Updates 2. Select Available Software and then select the ProvideX update site http://www.sagemas.com/lp/sagemas/eclipse/ and then select\expand the MAS 90, MAS 200 Plug-in

3. Select Install 4. Select the current versions of the ProvideX Plug-in for Eclipse and the MAS plug-in and click next.

Sage MAS 90 and MAS 200

Copyright 2009 Sage Software, Inc. All rights reserved.

Page 2 of 22

Eclipse Setup

5. 6.

Accept the license agreement and click Finish When prompted, say Yes to restart Eclipse

Sage MAS 90 and MAS 200

Copyright 2009 Sage Software, Inc. All rights reserved.

Page 3 of 22

Eclipse Setup

Part 1 Step 4 of 4 MKS Source Integrity Environment Variables

In order for the Source Integrity Eclipse plug-in to function correctly, two Windows environment variables must be set: ECLIPSE_INSTALL_ROOT SI_ECLIPSE_FEATURE Eclipse installation root directory MKS Integrity Client Eclipse 3.0 integrations directory

1. Run Windows Control Panel and select System. You can also right-click on the desktop My Computer icon and select Properties.

2. Go to the Advanced tab and click [Environment Variables]. 3. Under System variables, click [New] and define this variable: a. Variable name: b. Variable value: ECLIPSE_INSTALL_ROOT The root install location of Eclipse, which should be C:/Program Files/Eclipse, as described above in Step 2. Note that MKS requires the use of forward-slashes in the path. c. Click [OK] to save the variable.

4. Click [New] again, and define the second MKS variable: a. Variable name: b. Variable value: SI_ECLIPSE_FEATURE The full path to the eclipse_3.0 folder found under the MKS IntegrityClient-integrations-IBM program files folder. Example: C:/Program Files/MKS/IntegrityClient/integrations/IBM/eclipse_3.0 You must also use forward-slashes when setting the value for this variable. c. Click [OK] to save the variable.

d. Click [OK] to close the Environment Variables window. e. Click [OK] to close System Properties.

Sage MAS 90 and MAS 200

Copyright 2009 Sage Software, Inc. All rights reserved.

Page 4 of 22

Eclipse Setup

Part 2 Configuration
Part 2 Step 1 of 5 Run Eclipse
1. Create a shortcut to run Eclipse. Open c:\Program Files\Eclipse, then perform any or all of the following: Right-click on eclipse.exe and select Pin to Start menu. To create a desktop shortcut, drag eclipse.exe to your desktop then choose Create Shortcuts Here. Drag eclipse.exe to the Quick Launch toolbar to create a shortcut on the taskbar.

2. Run Eclipse from one of the shortcuts, or go to the Program Files\Eclipse folder and run eclipse.exe. 3. The first time your run Eclipse, you will be prompted to Select a workspace. a. For Workspace, you must accept the default Documents and Settings workspace folder. b. In addition, select the Use this as the default and do not ask again option.

Part 2 Step 2 of 5 MKS Plug-In Setup

1. From the Eclipse menu, choose Help Software Updates Find and Install. 2. Select Search for new features to install, then click [Next]. 3. On the Install window, click [New Local Site]. 4. Browse to the eclipse subfolder below the location specified in Part 1 - Step 3.4 for SI_ECLIPSE_FEATURE. Example: C:/Program Files/MKS/IntegrityClient/integrations/IBM/eclipse_3.0/eclipse

Sage MAS 90 and MAS 200

Copyright 2009 Sage Software, Inc. All rights reserved.

Page 5 of 22

Eclipse Setup

5. Change the name of the local site to MKS Plug-In, then click [OK]:

6. When you return to the Install window, select the MKS Plug-In checkmark and clear all others, then click [Finish]. 7. On the Search Results window that follows, select the MKS Plug-In:

8. Click [Next].
Sage MAS 90 and MAS 200
Copyright 2009 Sage Software, Inc. All rights reserved.

Page 6 of 22

Eclipse Setup

9. On the license window, accept the terms of the license agreement and click [Next]. 10. Finally, click [Finish] to install the plug-in. 11. When prompted, restart Eclipse. After restarting, if the MKS plug-in installed correctly, a Source Integrity menu will be found on the Eclipse menu bar:

Part 2 Step 3 of 5 MKS Label Decorations

1. From the Eclipse menu, choose Window Preferences. 2. General Appearance Label Decorations a. Select MKS Source Integrity:

Do not click [OK] to close preferences, since additional preference settings need to be checked or modified, as described in the following sections.

Part 2 Step 4 of 5 ProvideX Plug-In Setup

1. Preferences ProvideX a. For ProvideX Executable, select PvxWin32.Exe from an MKS sandbox or MAS 90 installation. Make sure a developer activation key is found in the Lib\Keys folder under the path where PvxWin32.Exe is selected. Also make sure the Nomads designer is installed in the same location as the selected interpreter.

b. Leave the Eclipse Listener port set to 10000.

Sage MAS 90 and MAS 200
Copyright 2009 Sage Software, Inc. All rights reserved.

Page 7 of 22

Eclipse Setup

2. Preferences ProvideX+Builder a. Select Only compile files associated with ProvideX Editor b. Select Compile Files that have no File extension c. Clear all other options

3. Preferences ProvideX+Builder+Options a. Select Check logical structure during build b. Select Allow mixed case for variable names and line labels c. Clear all other options Note: The Enable Access to build process extensions for MAS option is set and disabled. This option must exist and be enabled if working with Sage MAS 90 and MAS 200 Source Code

Sage MAS 90 and MAS 200

Copyright 2009 Sage Software, Inc. All rights reserved.

Page 8 of 22

Eclipse Setup

4. Preferences ProvideX+Nomads a. Set Default suffix for Nomads library files to LIB M4L (enter a space between LIB and M4L). b. Select the Quarter and 4D options.

Sage MAS 90 and MAS 200

Copyright 2009 Sage Software, Inc. All rights reserved.

Page 9 of 22

Eclipse Setup

Part 2 Step 5 of 5 Eclipse Preferences

Eclipse allows you to change the workspace environment to suit your individual needs and preferences. For MAS development, there are a few preferences that must be set identically by all developers. For example, the number of spaces-per-tab must be set to 4, and using spaces-for-tabs must be turned off.

Editor Tabs and Line Numbers

1. Preferences General+Editors+Text Editors a. Set Displayed tab width to 4 b. Turn off Insert spaces for tabs c. Turn on Show line numbers

This is also the preference screen where you can change the editor Background color, if you wish.

Editor Font
If you wish to change the font used by the editor, do the following. 1. Preferences General+Appearance+Colors and Fonts a. b. Select Basic Text Font Click [Change] and select a font ( my personal favorite: Consolas )

Sage MAS 90 and MAS 200

Copyright 2009 Sage Software, Inc. All rights reserved.

Page 10 of 22

Eclipse Setup

ProvideX Syntax Highlighting

1. Preferences ProvideX+Editor a. Select a keyword group and change its color and attributes

Click [OK] to save and close the Preference window.

Sage MAS 90 and MAS 200

Copyright 2009 Sage Software, Inc. All rights reserved.

Page 11 of 22

Eclipse Setup

Part 3 Operation
Part 3 Step 1 of 8 MAS Perspective
An Eclipse perspective defines the set of views and their layout in the Workbench window. The MAS perspective is aimed at configuring the workspace environment to best suit MAS development needs. 1. From the Eclipse menu, choose Window Open Perspective Other 2. Select MAS 90/200, then click [OK]:

3. The MAS perspective consists of the following views: Navigator PVC Outline Editor Views

Top-Left Bottom-Left Top-Right Bottom-Right

Tree view of projects and their members Components of current program being edited Program editor Program errors and warnings, Nomads library information, etc.

4. Each view in the perspective can be resized, maximized, hidden, detached, and moved to another location. If you rearrange the perspective and want to restore it to its default settings, click Window Reset Perspective or right-click on the perspective name at the top-right of the Workbench window and click Reset:

Sage MAS 90 and MAS 200

Copyright 2009 Sage Software, Inc. All rights reserved.

Page 12 of 22

Eclipse Setup

5. If the Eclipse Welcome view is still visible when selecting the MAS perspective, close it by clicking its X button:

You can restore the Welcome view by choosing Help Welcome

Part 3 Step 2 of 8 Create a MAS Project

Eclipse uses a project metaphor for managing source files and compiled builds. For MAS development, an Eclipse project equates to an MKS sandbox. 1. Choose File New ProvideX Project 2. Enter a project name. For consistency, the suggested naming standard is to use simple numbers that equate to the MAS 90 level, such as 430 or 440 or 500. When creating sandboxes for service level releases, use dots to segregate the main level from the service level, such as 430.1 or 440.2.

3. Leave the workspace, source and output directories set to their default values. 4. For Compiler, specify the appropriate PvxWin32.Exe for the MAS 90 release. 5. Password, Owner, and Flags must remain blank.

Sage MAS 90 and MAS 200

Copyright 2009 Sage Software, Inc. All rights reserved.

Page 13 of 22

Eclipse Setup

6. Click [Finish] to create the project, after which it should be visible in the upper-left Navigator view:

Part 3 Step 3 of 8 Turn Off Automatic Builds

Before assigning an MKS sandbox to a MAS project, click on Project Build Automatically to remove its checkmark so that automatic builds are not turned on:

Part 3 Step 4 of 8 Assign an MKS Sandbox to the MAS Project

1. Right-click on a ProvideX project and select Team Share Project

Sage MAS 90 and MAS 200

Copyright 2009 Sage Software, Inc. All rights reserved.

Page 14 of 22

Eclipse Setup

2. On the Share Project window, select MKS Source Integrity, then click [Next]:

If MKS Source Integrity does not appear on this window - or if Eclipse jumps straight into CVS or Subversion setup - you do not have the MKS plug-in installed correctly. Refer to Part 1 Step 3 and Part 2 Step 2 for MKS plug-in installation instructions.

3. Select Create a sandbox, then click [Finish]:

MKS connects to the Source Integrity server and starts up the Create Sandbox Wizard. You may be prompted for your MKS user name and password if you have not specified them in the MKS preferences. To configure your MKS client to connect automatically, see Appendix A.

4. In the Create Sandbox Wizard window, click [Select]. 5. Select a mas90.pj project:

Sage MAS 90 and MAS 200

Copyright 2009 Sage Software, Inc. All rights reserved.

Page 15 of 22

Eclipse Setup

You must select the top-level mas90.pj project or the MKS Eclipse integration will not work. Do not select the Src.pj subproject or any other module subproject. If you need a sandbox based on a single module or subset of modules, you must create the sandbox from mas90.pj then delete any unwanted subprojects.

6. Click [OK] to close the selection window. 7. Click [Next]. 8. The Sandbox Location defaults to your projects workspace folder:

Do not change the sandbox location or the MKS Eclipse integration will not work.

9. Click [Finish] to create the sandbox. 10. You will be prompted to recurse into subprojects. To conserve disk space and speed up the sandbox build process, you may wish to do this selectively, skipping demo data and other projects that you do not need in your sandbox. You cannot resynchronize files from within the MKS Eclipse integration. If you do not synchronize files when creating the sandbox, you must use the MKS Integrity Client to synchronize files.

11. After the build process finishes, to conserve space and to make the project easier to view and manage, expand the project in the Navigator view, then right-click on a subproject and select [Delete]. Some subprojects that consume a lot of space, yet are not needed by many developers include: Demo data MAS_ABC, MAS_ABX, MAS_EED, MAS_FDD MAS_System Reports Dictionaries Help Launcher Readme Reports Tutorials

Sage MAS 90 and MAS 200

Copyright 2009 Sage Software, Inc. All rights reserved.

Page 16 of 22

Eclipse Setup

Part 3 Step 5 of 8 Perform a Clean Build on the MAS Project

When you save changes to a program under a MAS src project, the ProvideX builder compiles and saves it into the compiled folder. Nomads libraries and other non-program files are copied into the compiled folder when saved. After assigning the MKS sandbox resources to the MAS project, you must do a clean build. 1. From the menu, select Project Clean

2. Select the project you want to build, then press [OK].

If you synchronized the MKS HOME subproject, during the build process you will be prompted for passwords for various ProvideX programs. There are also a few SOA programs that use passwords. You will need to press [Cancel] when prompted for a password, unless you know the correct password.

Part 3 Step 6 of 8 Turn On Automatic Builds

After the clean build finishes, click on Project Build Automatically to turn automatic builds back on.

Sage MAS 90 and MAS 200

Copyright 2009 Sage Software, Inc. All rights reserved.

Page 17 of 22

Eclipse Setup

Part 3 Step 7 of 8 Link a ProvideX Project to a MAS 90 Build

The UltraEdit Syntax Checker saves program files into a MAS 90 build area, making it easy to keep a test installation of MAS 90 updated as changes are made to programs. With the ProvideX Eclipse plug-in, both programs and Nomads libraries can be copied into a MAS 90 build area during the Pvx build process. 1. Choose File New Other 2. Under ProvideX Wizards, select New Builds Project, then click [Next]:

3. For MAS Project, click [Browse] and select a MAS project name. 4. For Builds Project name, enter Builds. 5. Under Directory, click [Browse] and select the MAS90 folder of a build.

6. Cick [Finish] to create the builds project and link the Pvx build process to the MAS project so that it updates the specified build directories. 7. In the Navigator view, you should now see the Builds project:

Sage MAS 90 and MAS 200

Copyright 2009 Sage Software, Inc. All rights reserved.

Page 18 of 22

Eclipse Setup

8. Expand the Builds node and youll find a MAS90 linked folder. In the Navigator, a linked folder such as this provides an explorer view of a file system. You can traverse the folder hierarchy and open/rename/delete files from this view.

Edit Build Project

1. To edit the build links for a MAS project, right-click on the compiled folder under the project, and select Properties:

2. Select ProvideX, then use the [Add], [Search] and [Remove] buttons to modify the MAS 90 builds that get updated when changes are made to the project.

Part 3 Step 8 of 8 MKS Usage within Eclipse

1. In the Navigator view, select a sandbox under a MAS project and navigate the tree view to locate resources. Resources are programs, Nomads libraries, and other files stored in the MKS repository. There are 2 folders under each MAS project: compiled Used by the ProvideX builder to store compiled versions of the source code. You should not access or edit files in this folder it is exclusively used by the ProvideX builder. If the files in this folder get deleted, you must perform a clean build as described in Part 3 Step 5. This folder contains the members of your MKS sandbox, arranged under module subprojects. It is from within this folder that you edit programs and Nomads libraries, and interact with MKS to check out and check in sandbox members.

src

2. Adjacent to each sandbox member in the src folder is its current MKS version along with the name of the person to whom it is checked out. In the following example, the IM_CommonSelectUI.pvc program in my IM sandbox is at version 1.10 and is currently checked out to Justin:

Sage MAS 90 and MAS 200

Copyright 2009 Sage Software, Inc. All rights reserved.

Page 19 of 22

Eclipse Setup

Label decorations identify various states of each member: The resource is a member of an MKS project Locked by me Locked by another user Working file has changed Revision is out of sync

3. To access the various MKS processes that are available, right-click on a project resource and select Team:

These same processes are also available from the Source Integrity menu on the Eclipse menu bar:

Sage MAS 90 and MAS 200

Copyright 2009 Sage Software, Inc. All rights reserved.

Page 20 of 22

Eclipse Setup

 Many Integrity Client functions are not available from within Eclipse. For example, you can check members out and back in, but you cannot unlock a member that you have checked out. To do this, select Launch Source Integrity from the Team menu and maintain the member using the Integrity Client. You cannot resynchronize entire projects from within Eclipse. You must use the Integrity Client to do mass resynchronizations for an entire project or subproject. After doing so, the changes will be reflected in your Eclipse project. To remove the read-only attribute of an MKS resource, right-click on it, select Properties Resource, then clear the Read only checkbox.

Sage MAS 90 and MAS 200

Copyright 2009 Sage Software, Inc. All rights reserved.

Page 21 of 22

Eclipse Setup

Appendix
Appendix A MKS Automatic Connection
It is not necessary to run the MKS client when accessing MKS projects in Eclipse, since the plug-in will connect to the MKS server as needed. The first time a connection is made to MKS, you are prompted for a user name and password, unless you have predefined this information in MKS.

Set Up an Unprompted Connection to MKS

1. Start the MKS Integrity Client. 2. Choose File Edit Preferences

3. Select Source Integrity Connection. 4. Enter your user name and password, and clear the prompt-for checkboxes:

5. Click [OK] to save and exit.

Sage MAS 90 and MAS 200

Copyright 2009 Sage Software, Inc. All rights reserved.

Page 22 of 22

Eclipse Setup