Embed Size (px)
Citation preview
SSA® Service Scheduler 2.2
Escrow Document
Copyright © 2004 by Baan International B.V., a subsidiary of SSA Global Technologies, Inc.
All rights reserved. No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any way or by any means, including, without limitation, photocopying or recording, without the prior written consent of BaanTM International B.V.
Important Notices
The material contained in this publication (including any supplementary information) constitutes and contains confidential and proprietary information of Baan International B.V.
By gaining access to the attached, you acknowledge and agree that the material (including any modification, translation or adaptation of the material) and all copyright, trade secrets and all other right, title and interest therein, are the sole property of Baan International and that you shall not gain right, title or interest in the material (including any modification, translation or adaptation of the material) by virtue of your review thereof other than the non-exclusive right to use the material solely in connection with and the furtherance of your license and use of software made available to your company from Baan International pursuant to a separate agreement (“Purpose”).
In addition, by accessing the enclosed material, you acknowledge and agree that you are required to maintain such material in strict confidence and that your use of such material is limited to the Purpose described above.
Although Baan International has taken due care to ensure that the material included in this publication is accurate and complete, Baan International cannot warrant that the information contained in this publication is complete, does not contain typographical or other errors, or will meet your specific requirements. As such, Baan International does not assume and hereby disclaims all liability, consequential or otherwise, for any loss or damage to any person or entity which is caused by or relates to errors or omissions in this publication (including any supplementary information), whether such errors or omissions result from negligence, accident or any other cause.
Baan International B.V., is a wholly owned subsidiary of SSA® Global TechnologiesTM, Inc.
Trademark Acknowledgments
SSA Global, SSA and the SSA Global logo are trademarks of SSA Global Technologies, Inc. in the United States and/or other countries. Baan is a trademark of Baan International B.V., in the United States and/or other countries.
All other company, product, trade or service names referenced may be registered trademarks or trademarks of their respective owners.
Publication Information
Document code : P3557A US
Release : SSA® Service Scheduler 2.2
Document title : Escrow Document
Publication date : July 04
Table of Contents
Chapter 1 Introduction .................................................................................................................. 1-1 About escrow................................................................................................................................. 1-1
Chapter 2 Overview ....................................................................................................................... 2-1 SSA Service Scheduler architecture ............................................................................................. 2-2 SSA Service Synchronizer ............................................................................................................ 2-2 SSA Service Scheduler ................................................................................................................. 2-3
Chapter 3 Resources..................................................................................................................... 3-1 Hardware requirements................................................................................................................. 3-1 Software requirements .................................................................................................................. 3-2 Other requirements........................................................................................................................ 3-2
Chapter 4 SSA Service Scheduler ............................................................................................... 4-1 bssmfc1.dll..................................................................................................................................... 4-2 Scheduler.exe................................................................................................................................ 4-7 resbss20.dll.................................................................................................................................. 4-11 Important notes............................................................................................................................ 4-17
ii | Table of Contents
About this Guide
This document is the Escrow Document for SSA Service Scheduler and is intended to meet the obligations of SSA Global customers with regard to escrow requirements.
This document contains the following chapters:
Chapter 1, “ Introduction,” provides an introduction to the SSA Service Scheduler.
Chapter 2, “Overview,” describes the architecture of the Service Scheduler.
Chapter 3, “Resources,” provides information with regard to the minimum hardware and software requirements to set up development/maintenance environment for SSA Service Scheduler 2.2 Product.
Chapter 4, “SSA Service Scheduler,” describes the process to build the Service Scheduler Application from the provided sources.
Send us your comments We continually review and improve our documentation. Any remarks/requests for information concerning this document or topic are appreciated. Please e-mail your comments to [email protected].
In your e-mail, refer to the document number and title. More specific information will enable us to process feedback efficiently.
iv | About this Guide
About escrow
SSA Global uses DSI Technology, previously named Fort Knox Escrow Services in the United States, to meet its obligations to its customers in regard to escrow requirements. The escrow license agreements require SSA Global to place the source code of the SSA Global products and other materials required to rebuild and to maintain the SSA Global products in escrow.
In the arrangement, DSI Technology holds the SSA Global products source code in escrow as long as SSA Global supports the source code. If SSA Global fails to support the product, DSI Technology is permitted to release the proprietary materials to the customer. The customer, or licensee, can then employ the deposit materials to support the licensed SSA Global product. The release of the source code to the customer occurs only if the terms of mutually acceptable, predetermined escrow license agreements are met.
1Chapter 1 Introduction
1-2 | Introduction
This chapter provides an overview of the product SSA Service Scheduler 2.2.
SSA Service Scheduler 2.2 is an advanced, GUI-based, intuitive application that is useful for most service-oriented business organizations in their day-to-day activities. Common tasks, such as to plan, schedule or reschedule, and dispatch service tasks to field engineers can now be handled with ease. In addition, this application provides a high degree of flexibility, because this application can be personalized as demanded by business and/or user needs.
SSA Service Scheduler Assistant 1.1 is also shipped along with SSA Service Scheduler 2.2. SSA Service Scheduler Assistant 1.1 is a tool to help schedule engineers, based on objectives. SSA Service Scheduler Assistant 1.1 also helps you find the best engineer to perform a particular service order or to find the next best service order for a free engineer. Service Scheduler Assistant has a separate Escrow document. For this reason, this document does not cover the SSA Service Scheduler Assistant.
2Chapter 2 Overview
2-2 | Overview
SSA Service Scheduler architecture
Figure 2-1 SSA Service Scheduler architecture
As shown in this figure, the Service Scheduler Assistant and the Service Scheduler form the major components of SSA Service Scheduler Product. The Service Scheduler Assistant is a separate component and is not discussed here. The SSA License Manager handles the licensing of this product, formerly known as Baan CIT License Manager. A completely separate Installation Guide is available to install and configure the SLM Server/Client, formerly known as BCLM. The following sections provide a brief description of these application components.
SSA Service Synchronizer
The primary task of this application is to handle the synchronization of the Service Scheduler database, implemented as a database on SQL Server 2000 or Oracle 8.1.7, with the corresponding SSA Baan ERP database. This application uses the SSA Baan OpenWorldX (BOW) 2.3 technology as the middleware technology to implement its functionality. The data flow between SSA Service Synchronizer 2.2 and SSA Baan ERP is unidirectional.
Overview | 2-3
In other words, the data is brought from the SSA Baan ERP database using SSA Baan OpenWorldX Business Object Interfaces (BOIs) and then updated to the Service Scheduler database.
SSA Service Scheduler
This application provides all the functionality related to service schedule, dispatch, and other related functionality with proper visual interface. The primary data source for this component is the Service Scheduler database. This component connects to the Service Scheduler database with the use of the System DSN. The data that is read from the database is properly formatted and displayed on the user interface of this application.
2-4 | Overview
This chapter provides details about the minimum hardware and software requirements to set up development/maintenance environment for SSA Service Scheduler 2.2.
Hardware requirements
166 MHz or higher Pentium-compatible CPU
Minimum of 256 megabytes (MB) of RAM recommended
Network Connectivity.
4 GB hard disk
3Chapter 3 Resources
3-2 | Resources
Software requirements
Microsoft Visual C++ 6.0 with SP5 of Visual Studio. This software is essential to run the application on Windows XP.
Microsoft Visual Source Safe 6.0 for source control
Microsoft Data Access Components 2.5 (MDAC 2.5)
Microsoft OLE DB driver for Microsoft SQL Server 2000 or Microsoft OLE DB driver for Oracle. The Oracle driver supported is version 8.1.7.6.
SSA Baan Windows Client (7.1c.137)
HTML Help
Other requirements
Access to SSA Baan ERP 5.0c environment with Service Pack 11 or later
SSA Baan OpenWorldX Adapter 2.2 or 2.3 Connector for Java
SQL Server 2000 or Oracle 8.1.7
SLM Client installation. The version must be at least 1.1.
This chapter describes the process of building the Service Scheduler Application from the provided sources.
The Service Scheduler Application consists of the application executable, Scheduler.exe, and a supporting DLL, bssmfc1.dll. These two components are separate but dependent projects. Further, the language dependent part of the application is built as a separate component, resBSS20.dll, to enable easy translation to other languages. The following sections describe each of these parts separately.
Note
You must build Bssmfc1.dll before you build Scheduler.exe. To build Bssmfc1.dll, follow the procedure in the following section.
4Chapter 4 SSA Service Scheduler
4-2 | SSA Service Scheduler
bssmfc1.dll
To build this DLL, you can use the Visual C++ 6.0 project bssmfc1.dsp. You can find this project in the following directory structure:
Figure 4-1 Source files directory structure
Open this folder and select the bssmfc1.dsp file to open the project in Microsoft Visual C++ 6.0:
Figure 4-2 Bssmfc1 Project
The Workspace Visual C++ creates shows the following:
Figure 4-3 Bssmfc1 Workspace contents
SSA Service Scheduler | 4-3
Before building, you must select the correct Project Configuration for the build. To set the build configuration, on the Build menu, click Select Active Configuration. Here, the Release and Debug options are available. When Bssmfc1.dll is compiled in Release, Scheduler.exe must be compiled in Release too, and the same applies for Debug build. The build option selected for Bssmfc1.dll must match with the option chosen for Scheduler.exe.
Figure 4-4 To select active configuration
To build the application, on the Build menu, select the Rebuild All option.
4-4 | SSA Service Scheduler
Figure 4-5 To build Bssmfc1.dll
After you build bssmfc1.dll, two files are created: bssmfc1.lib and bssmfc1.dll. These files are placed in the Release or Debug folder in the development tree, depending on which build configuration you choose.
Figure 4-6 Directory structure after the build
SSA Service Scheduler | 4-5
To compile and run scheduler.exe properly, be sure to perform the following steps carefully:
1 Copy Bssmfc1.dll to the Windows System folder in the Windows installation directory (probably this is c:\winnt\system32).
Figure 4-7 Windows System32 directory
2 Copy Bssmfc1.lib to the MFC\LIB folder in the Visual C++ 6.0 installation
directory. The default directory is:
Figure 4-8 Default MFC\LIB directory
4-6 | SSA Service Scheduler
3 Copy the header files CheckComboBox.h, SortClass.h, and Splitterwndex.h of the bssmfc1 project, which are present in the root of the development tree of bssmfc1:
Figure 4-9 Three header files to be copied
Copy these header files to the MFC\Include directory of the Visual C++ installation directory. The default directory is:
Figure 4-10 Default MFC\Include directory
SSA Service Scheduler | 4-7
Scheduler.exe
Before you build the Scheduler Application, you must copy the file htmlhelp.h to the MFC\Include folder of the Visual C++ installation, and htmlhelp.lib to the MFC\LIB folder. For the exact paths, look for the previous figures given for bssmfc1.dll.
These two files are part of the HTML Help Workshop installation, so you must first install this application. The htmlhelp.h file is stored in the Include directory of this installation, and the htmlhelp.lib file is present in the Lib directory.
To build the Scheduler.exe executable, you can use the Visual C++ 6.0 project scheduler.dsp. You can find the project in the following directory structure:
Figure 4-11 Source files directory structure
Open this folder, and select the file scheduler.dsp to open the project in Microsoft Visual C++ 6.0:
Figure 4-12 Scheduler Project
4-8 | SSA Service Scheduler
The Workspace that is created by Visual C++ looks like the following:
Figure 4-13 Scheduler Workspace contents
SSA Service Scheduler | 4-9
Before you build Scheduler.exe, first verify if the Active Project Configuration is the same as the Configuration used previously to build Bssmfc1.dll. To check the active configuration, on the Build menu, click Set Active Configuration and, in the dialog box that appears, select the correct Configuration, if not already selected.
Figure 4-14 Select Active Configuration
4-10 | SSA Service Scheduler
After you select the correct configuration, to start the build process, on the Build menu, click Rebuild All:
Figure 4-15 Building Scheduler.exe
After a successful build, an executable is created in the ...\release or ...\debug directory in the development tree, depending on which build configuration has been used:
Figure 4-16 Directory structure after the build
SSA Service Scheduler | 4-11
resbss20.dll
Resbss20.dll is the compiled version of the resource file. For the English version of Service Scheduler, this DLL is not required, because the English version of the resource file is already incorporated in the Scheduler.exe itself. However, this DLL will be the only source to translate the Service Scheduler software to other languages. Therefore, whenever a change is made in the resource file, you must take the appropriate actions in regard to translations.
Important to remember is that a strict dependency exists between the resource file and this DLL. Only translate to other languages if no change is planned to the resource file any longer, otherwise, the changes will not be present in the translated versions.
The Project file for Resbss20.dll is present in a subdirectory of the Scheduler project, called RESBSS20. To open the project in Visual C++, open the file resbss20.dsp in this subdirectory:
Figure 4-17 Location of resBSS20.dsp in the directory structure
4-12 | SSA Service Scheduler
After you load the project in Visual C++, the Workspace looks like the following:
Figure 4-18 Resbss20 Workspace contents
Before you build resbss20.dll, check the Active build configuration for this project. This must always be Release, because this configuration will only be used to translate the final version of the product, which must also be compiled in release mode.
SSA Service Scheduler | 4-13
To set the Active Configuration, on the Build menu, click the Set Active Configuration option:
Figure 4-19 Selecting Active Configuration
On the Build menu, select Rebuild All option, to build Resbss20.dll.
Figure 4-20 Building resBSS20.dll
4-14 | SSA Service Scheduler
After the build is completed successfully, the file resBSS20.dll is stored in the ...\Release subdirectory of the resbss20 development tree:
Figure 4-21 Location of resBSS20.dsp in the directory structure
You can use this file for translation. For each supported language, a separate file must be created. The naming convention is resBSSXY.dll. Based on the regional/locale setting of the user, XY is the two-digit language number. To extend the supported languages by the Service Scheduler application, copy the corresponding language resource file to the ...\Lang subdirectory of the SSA Service Scheduler installation directory.
Figure 4-22 SSA Service Scheduler folder
SSA Service Scheduler | 4-15
Subsequently, take the following steps to set your regional settings to the same language as that to which the BSS DLL is translated:
1 Open Control Panel.
2 Select Regional Settings or Regional Options.
3 Change the language:
Figure 4-23 Regional Options in Control Panel (Windows 2000)
4-16 | SSA Service Scheduler
Open the Regional options or Regional Settings dialog box, and select the correct country in the Your Locale drop-down box (Windows 2000), or just the drop-down box on the first tab (Windows NT 4.0).
Figure 4-24 Regional Options Dialog (Windows 2000)
Now, the SSA Service Scheduler must be able to recognize the new language, and will show the language-dependent components, including the strings and dialogs, in the new language.
SSA Service Scheduler | 4-17
Important notes
As described previously, the build mode (debug or release) of Scheduler.exe must match with the build mode of Bssmfc1.dll. If you must switch between these builds modes, for example, after you use the debug mode, if the user wants to test in release mode, the user must first build Bssmfc1.dll again. The new version must be copied to the Windows System folder again, as described in the explanation of the exact location in the part of Bssmfc1.dll in this chapter. Using a debug version of Bssmfc1.dll together with a release version of Scheduler.exe will result in errors.
When delivering the final version to the users, Scheduler.exe, bssmfc1.dll and resbss20.dll must be compiled in Release mode. Resbss20.dll can then be used for translation to other languages.
4-18 | SSA Service Scheduler
