Language-driven interface for an automated testing framework

[0001] The present invention relates to scripting and more particularly to automated scripting solutions.

[0002] Newly developed software programs must be thoroughly tested in order to eliminate as many “bugs” or errors as possible before the software is released for widespread public use. Accordingly, development of software is largely a trial and error process. Several different methods for testing software programs have been developed. One conventional approach, generally referred to as beta testing, involves distributing the program, typically under a non-disclosure agreement, to a group of users who use the program for a period of time and report any errors which are encountered to the software developer. Although this type of testing is commonly used in the software industry, it is often found to be very time consuming, adversely affecting the scheduled release of products incorporating the software program. In addition, beta testing can be extremely difficult to control, particularly when a large number of users are provided the beta version of the software. Furthermore, due to the non-systematic use of the program, there is no guarantee that every error, or even most errors, will be identified with this approach, even under circumstances where a large number of users are using the software.

[0003] As software is developed on and runs on computers, it is not surprising to find that many of the techniques for automating the testing of software have been implemented in digital computers. A common approach for testing software is the use of test suites. Test suites compare “known good” outputs of a program (for a given set of input) against the current output. Tests that check program file output are easy to implement and can be automated with shell scripts (e.g., Expect available on the Internet). For programs with user interfaces that communicate to standard input/output devices (stdin/stdout), a similar method may be employed. Capture/playback tools are available for recording keyboard input and program output as a person tests a program.

[0004] Much of the code written today is for software products with a graphical user interface (GUI), such as Microsoft.RTM. Windows.TM. In fact, much of software development itself is done within a graphical user interface, with software tool vendors providing products which allow software developers to develop GUI software using visual programming techniques. The Quality Assurance (QA) engineer faces more complex problems when testing GUI software. In particular, GUI programs must behave correctly regardless of which video mode or operating environment is being employed.

[0005] Intuitively, testing user interfaces should not be as difficult as testing a complex internal engine, such as a compiler or a real-time, multi-user operating system. In practice, however, user interface (UI) testing is the most challenging part of the QA process. This problem stems largely from the difficulty in automating UI tests. Tests for complex engines, in contrast, are often command-line programs whose testing can easily be automated using simple batch execution. Thus despite the plethora of present day tools for automating program testing, the task of developing, maintaining and analyzing the results of UI tests remains an arduous task.

[0006] The basic steps traditionally employed to test user interfaces may be summarized as follows. First, the application being tested is controlled by placing it into a specific state using either pre-recorded keyboard or mouse device actions, or entering input through a test script. Next, the then-current state of the application is recorded by taking a screenshot (e.g., capturing a screen bitmap). Finally, the captured screenshot is compared with a baseline screenshot that is known to be valid.

[0007] The approach is far from ideal, however. Consider, for instance, the determination of whether the state of a check box is valid within a specific dialog box. Here, the QA engineer must take a screenshot of that check box and compare it with the expected image. Thus, testing of even the simplest component is laborious. Moreover, the approach itself is prone to error. A change of just a few pixels across all windows—a common occurrence in GUI software development—causes all tests to fail. Consequently, as software becomes more and more complex, it becomes less and less feasible to test user interface tasks with present-day screen comparison methodology.

[0008] The software testing phase is a critical phase in the software development process. During the software development process, the software testing phase occurs after the software has been designed, implemented in a programming language, and tested to a limited degree. During the testing phase, software testers test the software extensively to ensure that the software meets all of the requirements it is intended to meet. In order to accommodate simultaneous testing of several different software packages by several testers, multiple test machines are often implemented. Different types of software packages may need to be tested on different types of test machines, such as, for example, test machines with different hardware configurations and/or different operating systems. When a large number of software testers are required to share common resources for software testing, provisions must be made for scheduling the tests in order to efficiently manage these shared resources. The efficient management of these shared resources may also require that tests and the results of the tests be recorded so that the tests can be used repeatedly if needed and so that the results of the tests can be analyzed and subsequently used for comparison with the results of tests performed at a later time.

[0009] In an effort to maximize efficiency in the handling of test scheduling and test execution, attempts have been made to automate software testing by using a server to manage test machines and to allocate test packages among the test machines in accordance with a schedule. Generally, these types of systems pre-allocate tasks to test machines by calculating the current and scheduled loads on the test machines and scheduling the tasks so that they are performed in a time-efficient manner. For example, Sun Microsystems, Inc. has proposed an automated task-based scheduler for use with UNIX platform systems which allows users operating “client” machines to schedule tests to be executed on “target” machines. A central server receives a request from a client machine to perform a task. The server maintains information relating to all currently scheduled tasks on all target machines in a “status” database. The server maintains information relating to the expected duration of each test package and other test package attributes in a “packages” database.

[0010] When the server receives a request to perform a task from a client machine, the server determines the loads on each of the target machines which are suitable for performing the task. The loads are determined based on the expected duration of each test package. The server then schedules the task on the target machine with the least current load. A task file created at the client machine and copied to the server includes priority information relating to the task requested by the client machine. Once the server has selected a target machine for the task, the task file is copied to the selected target machine. The target machine selects a task to be performed based on this priority information contained in the task file copied to the target machine. Once a task is completed, the results are copied back to the server which compares them to a set of “golden results” and creates a comparison report which is mailed back to the user that requested the test.

[0011] To test the functionality of a computer system, automated testing may use an automation testing tool that emulates user interactions. A database may store words each having a colloquial meaning that is understood by a general population. For each of these words, the database may store associated computer instructions that can be executed to cause a computer to perform the function that is related to the meaning of the word. During testing, a word may be received having a colloquial meaning that is understood by a general population. The database may be queried for the received word and the set of computer instructions may be returned by the database. The automated testing tool may then perform the function related to the colloquial meaning of the word. The words stored in the database may be in English or another language.

[0095] FIG. 1 is a flowchart illustrating a method 100 for affording an automated scripting solution for enterprise testing in accordance with one embodiment of the present invention. First, in operation 102, a table-driven automated scripting architecture is provided. Then, in operation 104, a test script is developed using the table-driven automated scripting architecture. A synchronized execution of the test script is then performed as indicated in operation 106. In operation 108, metrics of the synchronized execution of the test script are outputted.

[0096] The present invention has been developed and implemented to automate regression testing of host applications. Among other roles, the present invention can be used in an Integration Test (IT) phase to develop a more robust and systematic process for executing test scripts during certification testing. The present invention is a two-tier application, consisting of a database (Microsoft Access 97 or SQL Server) and an automation tool (Mercury Interactive WinRunner). The present invention reduces testing time and allows the testing team to detect and log more application issues, ensuring quality software delivery.

[0097] The present invention provides data-driven test scripts with an English-based, form-driven user interface. The present invention data architecture divides and stores test script information (steps, actions, application widgets, etc.) into separate, reusable components. The table relationships between these components provide the capability to develop easily maintained, data-driven test scenarios.

[0098] Traditional testing tools are manual and require long hours of slow and tedious testing. The few automated tools that do exist have limited flexibility and hard coded scripts.

[0099] In contrast, the present invention's unique and innovative features yield exceptional benefits in both scope and time. Organizational benefits include: increased development productivity, higher issue counts and shorter development cycles.

[0100] FIG. 2 is a schematic diagram illustrating one exemplary system architecture 200 of the present invention, in accordance with one embodiment of the present invention. The system architecture 200 includes a client script system 202 and a server script system 204. The client script system 202 includes a client computer 206, ASA modules 208, test script automator 210, and test script documentation 212. The server script system 204 includes a database 214, on-line help documentation 216, and metrics statistical reports 218.

[0101] In use, the client computer 206 updates test script data located Qn the database 214 utilizing an ODBC connection. The test script data is further passed to the ASA modules 208 via an SQL query. The ASA modules 208 then process the test script data and pass the processed data to the test script automator 210. Automated execution of the processed test script data is then performed by the test script automator 210, which is connected to a host application executing on the client computer 206.

[0102] In addition, the client computer 206 may be utilized to obtain the on-line help documentation 216 located on the server system 204. The server system also stores the metrics statistical reports 218 after execution of each test cycle. Finally, test script data is dynamically converted into English-based, test script documentation 212.

[0103] A preferred embodiment of a client computer system 206 in accordance with the present invention is preferably practiced in the context of a personal computer such as an IBM compatible personal computer, Apple Macintosh computer or UNIX based workstation. A representative hardware environment is depicted in FIG. 3, which illustrates a typical hardware configuration of a client computer 206 in accordance with a preferred embodiment having a central processing unit 310, such as a microprocessor, and a number of other units interconnected via a system bus 312. The workstation shown in FIG. 3 includes a Random Access Memory (RAM) 314, Read Only Memory (ROM) 316, an I/O adapter 318 for connecting peripheral devices such as disk storage units 320 to the bus 312, a user interface adapter 322 for connecting a keyboard 324, a mouse 326, a speaker 328, a microphone 332, and/or other user interface devices such as a touch screen (not shown) to the bus 312, communication adapter 334 for connecting the workstation to a communication network (e.g., a data processing network) and a display adapter 336 for connecting the bus 312 to a display device 338. The workstation typically has resident thereon an operating system such as the Microsoft Windows NT or Windows/95 Operating System (OS), the IBM OS/2 operating system, the MAC OS, or UNIX operating system. Those skilled in the art will appreciate that the present invention may also be implemented on platforms and operating systems other than those mentioned.

[0104] A preferred embodiment is written using JAVA, C, and the C++ language and utilizes object oriented programming methodology. Object oriented programming (OOP) has become increasingly used to develop complex applications. As OOP moves toward the mainstream of software design and development, various software solutions require adaptation to make use of the benefits of OOP. A need exists for these principles of OOP to be applied to a messaging interface of an electronic messaging system such that a set of OOP classes and objects for the messaging interface can be provided.

[0105] OOP is a process of developing computer software using objects, including the steps of analyzing the problem, designing the system, and constructing the program. An object is a software package that contains both data and a collection of related structures and procedures. Since it contains both data and a collection of structures and procedures, it can be visualized as a self-sufficient component that does not require other additional structures, procedures or data to perform its specific task. OOP, therefore, views a computer program as a collection of largely autonomous components, called objects, each of which is responsible for a specific task. This concept of packaging data, structures, and procedures together in one component or module is called encapsulation.

[0106] In general, OOP components are reusable software modules which present an interface that conforms to an object model and which are accessed at run-time through a component integration architecture. A component integration architecture is a set of architecture mechanisms which allow software modules in different process spaces to utilize each others capabilities or functions. This is generally done by assuming a common component object model on which to build the architecture. It is worthwhile to differentiate between an object and a class of objects at this point. An object is a single instance of the class of objects, which is often just called a class. A class of objects can be viewed as a blueprint, from which many objects can be formed.

[0107] OOP allows the programmer to create an object that is a part of another object. For example, the object representing a piston engine is said to have a composition-relationship with the object representing a piston. In reality, a piston engine comprises a piston, valves and many other components; the fact that a piston is an element of a piston engine can be logically and semantically represented in OOP by two objects.

[0108] OOP also allows creation of an object that “depends from” another object. If there are two objects, one representing a piston engine and the other representing a piston engine wherein the piston is made of ceramic, then the relationship between the two objects is not that of composition. A ceramic piston engine does not make up a piston engine. Rather it is merely one kind of piston engine that has one more limitation than the piston engine; its piston is made of ceramic. In this case, the object representing the ceramic piston engine is called a derived object, and it inherits all of the aspects of the object representing the piston engine and adds further limitation or detail to it. The object representing the ceramic piston engine “depends from” the object representing the piston engine. The relationship between these objects is called inheritance.

[0109] When the object or class representing the ceramic piston engine inherits all of the aspects of the objects representing the piston engine, it inherits the thermal characteristics of a standard piston defined in the piston engine class. However, the ceramic piston engine object overrides these ceramic specific thermal characteristics, which are typically different from those associated with a metal piston. It skips over the original and uses new functions related to ceramic pistons. Different kinds of piston engines have different characteristics, but may have the same underlying functions associated with it (e.g., how many pistons in the engine, ignition sequences, lubrication, etc.). To access each of these functions in any piston engine object, a programmer would call the same functions with the same names, but each type of piston engine may have different/overriding implementations of functions behind the same name. This ability to hide different implementations of a function behind the same name is called polymorphism and it greatly simplifies communication among objects.

[0110] With the concepts of composition-relationship, encapsulation, inheritance and polymorphism, an object can represent just about anything in the real world. In fact, one's logical perception of the reality is the only limit on determining the kinds of things that can become objects in object-oriented software. Some typical categories are as follows:

• [0111] Objects can represent physical objects, such as automobiles in a traffic-flow simulation, electrical components in a circuit-design program, countries in an economics model, or aircraft in an air-traffic-control system.
• [0112] Objects can represent elements of the computer-user environment such as windows, menus or graphics objects.
• [0113] An object can represent an inventory, such as a personnel file or a table of the latitudes and longitudes of cities.
• [0114] An object can represent user-defined data types such as time, angles, and complex numbers, or points on the plane.

[0115] With this enormous capability of an object to represent just about any logically separable matters, OOP allows the software developer to design and implement a computer program that is a model of some aspects of reality, whether that reality is a physical entity, a process, a system, or a composition of matter. Since the object can represent anything, the software developer can create an object which can be used as a component in a larger software project in the future.

[0116] If 90% of a new OOP software program consists of proven, existing components made from preexisting reusable objects, then only the remaining 10% of the new software project has to be written and tested from scratch. Since 90% already came from an inventory of extensively tested reusable objects, the potential domain from which an error could originate is 10% of the program. As a result, OOP enables software developers to build objects out of other, previously built objects.

[0117] This process closely resembles complex machinery being built out of assemblies and sub-assemblies. OOP technology, therefore, makes software engineering more like hardware engineering in that software is built from existing components, which are available to the developer as objects. All this adds up to an improved quality of the software as well as an increased speed of its development.

[0118] Programming languages are beginning to fully support the OOP principles, such as encapsulation, inheritance, polymorphism, and composition-relationship. With the advent of the C++ language, many commercial software developers have embraced OOP. C++ is an OOP language that offers a fast, machine-executable code. Furthermore, C++ is suitable for both commercial-application and systems-programming projects. For now, C++ appears to be the most popular choice among many OOP programmers, but there is a host of other OOP languages, such as Smalltalk, Common Lisp Object System (CLOS), and Eiffel. Additionally, OOP capabilities are being added to more traditional popular computer programming languages such as Pascal.

[0119] The benefits of object classes can be summarized, as follows:

• [0120] Objects and their corresponding classes break down complex programming problems into many smaller, simpler problems.
• [0121] Encapsulation enforces data abstraction through the organization of data into small, independent objects that can communicate with each other. Encapsulation protects the data in an object from accidental damage, but allows other objects to interact with that data by calling the object's member functions and structures.
• [0122] Subclassing and inheritance make it possible to extend and modify objects through deriving new kinds of objects from the standard classes available in the system. Thus, new capabilities are created without having to start from scratch.
• [0123] Polymorphism and multiple inheritance make it possible for different programmers to mix and match characteristics of many different classes and create specialized objects that can still work with related objects in predictable ways.
• [0124] Class hierarchies and containment hierarchies provide a flexible mechanism for modeling real-world objects and the relationships among them.
• [0125] Libraries of reusable classes are useful in many situations, but they also have some limitations. For example:
• [0126] Complexity. In a complex system, the class hierarchies for related classes can become extremely confusing, with many dozens or even hundreds of classes.
• [0127] Flow of control. A program written with the aid of class libraries is still responsible for the flow of control (i.e., it must control the interactions among all the objects created from a particular library). The programmer has to decide which functions to call at what times for which kinds of objects.
• [0128] Duplication of effort. Although class libraries allow programmers to use and reuse many small pieces of code, each programmer puts those pieces together in a different way. Two different programmers can use the same set of class libraries to write two programs that do exactly the same thing but whose internal structure (i.e., design) may be quite different, depending on hundreds of small decisions each programmer makes along the way. Inevitably, similar pieces of code end up doing similar things in slightly different ways and do not work as well together as they should.

[0129] Class libraries are very flexible. As programs grow more complex, more programmers are forced to reinvent basic solutions to basic problems over and over again. A relatively new extension of the class library concept is to have a framework of class libraries. This framework is more complex and consists of significant collections of collaborating classes that capture both the small scale patterns and major mechanisms that implement the common requirements and design in a specific application domain. They were first developed to free application programmers from the chores involved in displaying menus, windows, dialog boxes, and other standard user interface elements for personal computers.

[0130] Frameworks also represent a change in the way programmers think about the interaction between the code they write and code written by others. In the early days of procedural programming, the programmer called libraries provided by the operating system to perform certain tasks, but basically the program executed down the page from start to finish, and the programmer was solely responsible for the flow of control. This was appropriate for printing out paychecks, calculating a mathematical table, or solving other problems with a program that executed in just one way.

[0131] The development of graphical user interfaces began to turn this procedural programming arrangement inside out. These interfaces allow the user, rather than program logic, to drive the program and decide when certain actions should be performed. Today, most personal computer software accomplishes this by means of an event loop which monitors the mouse, keyboard, and other sources of external events and calls the appropriate parts of the programmer's code according to actions that the user performs. The programmer no longer determines the order in which events occur. Instead, a program is divided into separate pieces that are called at unpredictable times and in an unpredictable order. By relinquishing control in this way to users, the developer creates a program that is much easier to use. Nevertheless, individual pieces of the program written by the developer still call libraries provided by the operating system to accomplish certain tasks, and the programmer must still determine the flow of control within each piece after it's called by the event loop. Application code still “sits on top of” the system.

[0132] Even event loop programs require programmers to write a lot of code that should not need to be written separately for every application. The concept of an application framework carries the event loop concept further. Instead of dealing with all the nuts and bolts of constructing basic menus, windows, and dialog boxes and then making these things all work together, programmers using application frameworks start with working application code and basic user interface elements in place. Subsequently, they build from there by replacing some of the generic capabilities of the framework with the specific capabilities of the intended application.

[0133] Application frameworks reduce the total amount of code that a programmer has to write from scratch. However, because the framework is really a generic application that displays windows, supports copy and paste, and so on, the programmer can also relinquish control to a greater degree than event loop programs permit. The framework code takes care of almost all event handling and flow of control, and the programmer's code is called only when the framework needs it (e.g., to create or manipulate a proprietary data structure).

[0134] A programmer writing a framework program not only relinquishes control to the user (as is also true for event loop programs), but also relinquishes the detailed now of control within the program to the framework. This approach allows the creation of more complex systems that work together in interesting ways, as opposed to isolated programs, having custom code, being created over and over again for similar problems.

[0135] Thus, as is explained above, a framework basically is a collection of cooperating classes that make up a reusable design solution for a given problem domain. It typically includes objects that provide default behavior (e.g., for menus and windows), and programmers use it by inheriting some of that default behavior and overriding other behavior so that the framework calls application code at the appropriate times.

[0136] There are three main differences between frameworks and class libraries:

• • [0137] Behavior versus protocol. Class libraries are essentially collections of behaviors that you can call when you want those individual behaviors in your program. A framework, on the other hand, provides not only behavior but also the protocol or set of rules that govern the ways in which behaviors can be combined, including rules for what a programmer is supposed to provide versus what the framework provides.
  • [0138] Call versus override. With a class library, the code the programmer instantiates objects and calls their member functions. It's possible to instantiate and call objects in the same way with a framework (i.e., to treat the framework as a class library), but to take full advantage of a framework's reusable design, a programmer typically writes code that overrides and is called by the framework. The framework manages the flow of control among its objects. Writing a program involves dividing responsibilities among the various pieces of software that are called by the framework rather than specifying how the different pieces should work together.
  • [0139] Implementation versus design. With class libraries, programmers reuse only implementations, whereas with frameworks, they reuse design. A framework embodies the way a family of related programs or pieces of software work. It represents a generic design solution that can be adapted to a variety of specific problems in a given domain. For example, a single framework can embody the way a user interface works, even though two different user interfaces created with the same framework might solve quite different interface problems.

[0140] Thus, through the development of frameworks for solutions to various problems and programming tasks, significant reductions in the design and development effort for software can be achieved. A preferred embodiment of the invention utilizes HyperText Markup Language (HTML) to implement documents on the Internet together with a general-purpose secure communication protocol for a transport medium between the client and the Newco. HTTP or other protocols could be readily substituted for HTML without undue experimentation. Information on these products is available in T. Bemers-Lee, D. Connoly, “RFC 1866: Hypertext Markup Language—2.0” (November 1995); and R. Fielding, H, Frystyk, T. Berners-Lee, J. Gettys and J.C. Mogul, “Hypertext Transfer Protocol—HTTP/1.1: HTTP Working Group Internet Draft” (May 2, 1996). HTML is a simple data format used to create hypertext documents that are portable from one platform to another. HTML documents are SGML documents with generic semantics that are appropriate for representing information from a wide range of domains. HTML has been in use by the World-Wide Web global information initiative since 1990. HTML is an application of ISO Standard 8879; 1986 Information Processing Text and Office Systems; Standard Generalized Markup Language (SGML).

[0141] To date, Web development tools have been limited in their ability to create dynamic Web applications which span from client to server and interoperate with existing computing resources. Until recently, HTML has been the dominant technology used in development of Web-based solutions. However, HTML has proven to be inadequate in the following areas:

• • [0142] Poor performance;
  • [0143] Restricted user interface capabilities;
  • [0144] Can only produce static Web pages;
  • [0145] Lack of interoperability with existing applications and data; and
  • [0146] Inability to scale.

[0147] Sun Microsystem's Java language solves many of the client-side problems by:

• • [0148] Improving performance on the client side;
  • [0149] Enabling the creation of dynamic, real-time Web applications; and
  • [0150] Providing the ability to create a wide variety of user interface components.

[0151] With Java, developers can create robust User Interface (UIl) components. Custom “widgets” (e.g., real-time stock tickers, animated icons, etc.) can be created, and client-side performance is improved. Unlike HTML, Java supports the notion of client-side validation, offloading appropriate processing onto the client for improved performance. Dynamic, real-time Web pages can be created. Using the above-mentioned custom UI components, dynamic Web pages can also be created.

[0152] Sun's Java language has emerged as an industry-recognized language for 2 “programming the Internet.” Sun defines Java as: “a simple, object-oriented, distributed, interpreted, robust, secure, architecture-neutral, portable, high-performance, multithreaded, dynamic, buzzword-compliant, general-purpose programming language. Java supports programming for the Internet in the form of platform-independent Java applets.” Java applets are small, specialized applications that comply with Sun's Java Application Programming Interface (APT) allowing developers to add “interactive content” to Web documents (e.g., simple animations, page adornments, basic games, etc.). Applets execute within a Java-compatible browser (e.g., Netscape Navigator) by copying code from the server to client. From a language standpoint, Java's core feature set is based on C++. Sun's Java literature states that Java is basically, “C++ with extensions from Objective C for more dynamic method resolution.”

[0153] Another technology that provides similar function to JAVA is provided by Microsoft and ActiveX Technologies, to give developers and Web designers wherewithal to build dynamic content for the Internet and personal computers. ActiveX includes tools for developing animation, 3-D virtual reality, video and other multimedia content. The tools use Internet standards, work on multiple platforms, and are being supported by over 100 companies. The group's building blocks are called ActiveX Controls, small, fast components that enable developers to embed parts of software in hypertext markup language (HTML) pages. ActiveX Controls work with a variety of programming languages including Microsoft Visual C++, Borland Delphi, Microsoft Visual Basic programming system and, in the future, Microsoft's development tool for Java, code named “Jakarta.” ActiveX Technologies also includes ActiveX Server Framework, allowing developers to create server applications. One of ordinary skill in the art readily recognizes that ActiveX could be substituted for JAVA without undue experimentation to practice the invention.

[0154] FIG. 4 is a flow chart illustrating a method 400 for affording a table-driven automated scripting architecture in accordance with one embodiment of the present invention. First, in operation 402, test script information is divided into a plurality of components. Then, in operation 404 the components are stored into a database. A relationship between the components is identified using a table, as indicated in operation 406. Test scenarios involving the components are then developed based on the relationship. See operation 408.

[0155] In one aspect of the present invention, the test script information relates to at least one of either steps and/or actions. The test scenarios are typically data-driven. In addition, the test scenarios may be developed using an English-based interface. As an option, the interface may be accessed utilizing a network. Also optionally, D 20 the architecture is a two-tier architecture.

[0156] The table-driven architecture inherent within the present invention is what makes it such a unique innovation. This feature provides benefits such as simplified test script development and maintenance, inherent GUI testing Best Practices, and reduced training time via English-based GUI interface. The table-driven architecture further allows the capability to quickly load data, flexible test cycle planning, real-time and statistical test status reporting, and essentially 100% test script execution accuracy.

[0157] FIG. 5 is a flowchart illustrating a method 500 for affording improved accuracy in an automated scripting framework in accordance with one embodiment of the present invention. First, in operation 502, a relationship is identified between test script components. Next, in operation 504, test scenarios involving the components are developed based on the identified relationship. A plurality of predefined actions are then provided as indicated in operation 506. The test scenarios are then uniformly executed utilizing the predefined actions. See operation 508. In one aspect of the present invention, the cause of errors raised while executing the test scenarios is analyzed. In another aspect, the test scenarios are data-driven. Optionally, the test scenarios may be developed using an English-based interface. Also optionally, the interface may be accessed utilizing a network. Execution of scripts by hand is plagued by error (skipped steps, misread script, etc.) Script automation has the inherent advantage of consistency. Uniform execution provides value to the testing effort. To that end, the present invention's predefined suite of standard actions ensures that every user-widget interaction is executed consistently. Other advantages of this consistency include issue identification/cause analysis and issue recreation.

[0158] FIG. 6 is a flowchart illustrating a method 600 for affording application independence in an automated scripting framework, in accordance with one aspect of the present invention. In an initial operation 602, a database including test criteria is provided. Then, in operation 604, a relationship between test script components is identified based on the test criteria. Test scenarios for an application involving the components are then developed independent of the application based on the identified relationship as indicated in operation 606.

[0159] In one embodiment of the present invention the test criteria is business rules. Optionally, the test criteria may be test conditions.

[0160] In another embodiment of the present invention, the test scenarios are stored for delayed execution. The test scenarios may be data-driven. In addition, the test scenarios may be developed using an English-based interface. Further, the framework may utilize a two-tier architecture.

[0161] Conventional automated testing software requires the host application to be running while the user is creating each test script. In the instance where the host application is malfunctioning or has not yet been developed, test scripts may still be developed in the present invention, without the application, in accordance with system requirements. The scripts may be executed at a later date when the host application has been completed and/or is functioning normally.

[0162] The present invention scripts can be executed with minimal knowledge of application functionality, testing experience and supervision. The tool itself is English-driven and the business rules and test conditions for the application are retained in the present invention, not the user.

[0163] FIG. 7 is a flowchart illustrating a method 700 for affording test development in an automated scripting framework, in accordance with an embodiment of the present invention. First, in operation 702, a database including business rules is accessed. Next, in operation 704, a relationship between test script components is identified based on the business rules. As shown in operation 706, test scenarios involving the test script components are then developed based on the identified relationship. The test scenarios are accessed utilizing an English-driven interface via a network. See operation 708

[0164] In one aspect of the present invention, the test scenarios are data-driven. Optionally, the test scenarios may be developed using the English-driven interface. Also optionally, the interface is accessed utilizing a network. Further, the framework may utilize a two-tier architecture.

[0165] With the present invention, the creation of automated test scripts no longer requires recording or coding. Using the form-driven, english-based interface is intuitive, providing ease of use, simplified training, reduced learning curve and increased productivity.

[0166] FIG. 8 is a flowchart illustrating a method 800 for affording synchronization in an automated scripting framework, in accordance with an aspect of the present invention. First, in operation 802, script data is received utilizing a language-driven interface. Then, in operation 804, reports having user readable sentences are created based on the received script data. The received script data is then translated into automation code as indicated in operation 806. In operation 808, automated testing is provided utilizing the automation code.

[0167] In one embodiment of the present invention, the reports are created as hard copies. Optionally, the received script data is translated into automation code using relational table values. In another embodiment, the script data may be divided into a plurality of components stored in a database. Further, the database may reside on a remote server.

[0168] The present invention scripts have the distinct advantage of simultaneously being both paper-based and automation-ready at all times. Once script data is entered in the tool, pre-defined reports present the data as readable sentences while relational table values translate the data into automation code.

[0169] FIG. 9 is a flowchart illustrating a method 900 for affording test maintenance in an automated scripting framework in accordance with an embodiment of the present invention. In an initial operation 902, a plurality of test scripts are developed. Next, in operation 904, the plurality of test scripts are stored in a centrally located database. A user is then allowed to edit a specific test script located on the centrally located database as indicated in operation 906. The user edits the specific test script are then propagated to each of the plurality of test scripts, in operation 908.

[0170] In one aspect of the present invention, the user edits to the specific test script are propagated to each of the plurality of test scripts simultaneously. In another aspect, the plurality of test scripts are utilized to develop test scenarios.

[0171] In an embodiment of the present invention, the test scenarios are developed using an English-based interface. In another embodiment, the interface is accessed utilizing a network. In a further embodiment, the framework utilizes a two-tier architecture.

[0172] The present invention's relational database architecture significantly simplifies and reduces script maintenance. Edits are propagated instantly to all scripts. Also, all data is centrally located and easily created/edited.

[0173] FIG. 10 is a flowchart illustrating a method 1000 for affording metrics in an automated scripting framework, in accordance with an embodiment of the present invention. First, in operation 1002, a user is allowed to plan a test cycle for later execution. Next, in operation 1004, ownership of the test cycle is assigned. The test cycle is then executed to produce an execution performance of the test cycle, as shown in operation 1006. A statistical report of the execution performance of the test cycle is generated. See operation 1008.

[0174] In one aspect of the present invention, the statistical report is generated after the test cycle is executed. In another aspect, the statistical report is generated real-time during execution of the test cycle.

[0175] In one embodiment of the present invention, the statistical report is generated as a word processor document. Optionally, the statistical report may be generated as an HTML file. Also optionally, the statistical report is displayed on a computer display device.

[0176] The Resources eCommerce Technology Architecture (ReTA) is a solution that allows the use of packaged components to be integrated into a client based eCommerce solution. Before the present invention, the Resources architecture offerings provided services that supported the construction, execution and operation of very large custom built solutions. In the last few years, client needs have shifted towards requirements for solutions that continually integrate well with third party applications (i.e., data warehouse and portion of the present description management systems). Previous engagements have proven that it is difficult to integrate these applications into a new solution. As application vendors continue to produce new releases that incorporate technical advancements, it is even more difficult to ensure that these integrated applications continue to work with a given solution.

[0177] The ReTA approach to constructing, executing and operating a solution emphasizes the ability to change solution components with minimal impact on the solution as a whole. From this approach, ReTA views third party applications as another component in the overall solution. ReTA is component based, which means the engagement can choose to take only the pieces it needs to meet its specific business requirements. ReTA is especially suited to building small applications, implementing tools and packages, integrating applications and web enabling applications.

[0178] The present invention provides the ability to generate statistical reports of past execution performance, plan and assign ownership of future test cycles, and conduct real-time status reporting during test execution. These reports can also be output as various media, including MS Word and HTML.

[0179] Automated execution of application tests using the present invention is much faster than manual execution. Additionally, manual script execution is tedious, labor-intensive and prone to error. With the present invention, clicking, typing, etc. are executed at a rate of approximately one second per step.

[0180] The present invention further provides the ability to generate statistical reports of past execution performance, plan and assign ownership of future test cycles, and conduct real-time status reporting during test execution.

[0181] In one embodiment, the present invention is application software, written in a programming language such as VBA 6.0, which works cooperatively with Mercury Interactive's WinRunner to perform its automated testing function.

Site Server Framework Execution Architecture

[0182] To connect to a Site Server, a COM component (UserSS) is used to make calls to Site Server's API. The ReTA UserSS component allows the developer to access Site Server's Personalization and Membership Services without any knowledge of Site Server's API.

[0183] In a Site Server framework architecture, the UserSS COM component connects to the Site Server. The UserSS component uses Site Server's Personalization and Membership; UserSS also performs security as well on a Commerce Site. The ReTA framework uses the UserSS layer to provide access to Site Server. The UserSS layer provides the following benefits:

• • [0184] It insulates the application developer from Site Server's API.
  • [0185] It provides functionality for using Site Server's Personalization and Membership Services.
    Site Server Framework Development Architecture
    UserSS Interface Methods

[0186] The UserSS component interfaces with the SiteServer personalization and membership services. This component uses SiteServer to handle the user security, role and preferences.

Methods

[0187] The IAFUser, IAFUserPreferences, and IAFUserRole interfaces define the access to the AFUserSS component. These interfaces support the following methods:

[0188]

Method	Description
Init	This method initializes the UserSS Component.
GetUserID	This method returns a string value representing the user
	id. SiteServer's API is used to obtain this value.
GetUserName	This method returns a string value representing the user's
	name. SiteServer's API is used to obtain this value.
GetRealName	This method returns a string value representing the user's
	real name. SiteServer's API is used to obtain this value.
GetPref	This method takes as input a preference label and returns
	a string value representing the user's preference value.
	SiteServer's API is used to obtain this value.
SetPref	This method accepts two parameters (String
	thePrefLabel, String thePreValue). The preference is set
	that matches the “thePrefLabel” passed in.
GetRoleID	This method returns the current users Role id.
GetRoleName	This method returns the current user's role name.
GetRolePref	This method takes as input a preference label returns the
	current user's role preference value.
SetRolePref	This method sets the current user's role preference

Site Server Personalization and Membership/Directory Membership Manager

[0189] This portion of the description describes the required settings in Site Server Commerce Edition used by the ReTA frameworks. This portion of the description also describes the steps involved in creating the required settings.

ReTA Required Settings

[0190] The Membership Directory Manager is used to manage administration and access control for Membership Directory objects, including users and groups, and schema objects. The Membership Directory stores objects used by all Site Server features.

[0191] The ReTA UserSS framework requires schema objects to be created. The schema objects required by the ReTA Frameworks are: Roles container, RoleName attribute, username attribute, webUserId attribute, and a Role class.

Required Container, Class, and Attribute Setup Instructions

[0192] Users may have different roles within the system. In Site Server ReTA takes advantage of this by creating a Container “Roles” that contains different “Roles” or different objects of the class “Role”. These “Roles” have attributes such as a default start page. Therefore different “Roles” (different objects of the class “Role”) such as “Operator” or “Customer” may both have a default start page attribute that may point to different URL's.

[0193] The Site Server portion of the present description details how to setup a Container, “Class, and Attributes. The following lists the steps involved to setup the required attributes for the ReTA Frameworks to integrate with Site Server.

[0194] Using the Site Server Console, right click on the Membership Directory Manager folder.

• • [0195] Select New—Container, then type in Roles for the Container name.
  • [0196] FIG. 11 illustrates the creating of Container “Roles”. Right click on Membership Directory Manager 1100 and select New 1102—Container 1104. After creating the Container “Roles”, create the attribute “DefaultStartPage”, “username”, webUserId”, and “RoleName” in the Schema. To create these attributes expand the Admin Container under the Membership Directory Manager.
  • [0197] Right click on the Schema folder 1200 and select New 1202—Attribute 1204 (See FIG. 12)
  • [0198] Define the class “Role” the same way by right clicking on Schema and selecting New-Class.
  • [0199] Select the “common-name” as a required attribute, also select the “DefaultStartPage” as an attribute but do not make it required.
  • [0200] Create the Roles for our Application, “Operator” and “Customer”.
  • [0201] See FIG. 13, which illustrates the adding of different Roles. Right click the Roles Container 1300 under the Membership Directory Manager folder 1302. Select New 1304—Object 1306, select “Role” for the class of object to create, type the name of the object i.e. “Operator”, add the attribute 0דDefaultStartPage” by clicking Add Attribute button and enter the URL.
  • [0202] Once these have been created, a member of the system can be assigned to a “Role” and the ReTA Framework required attributes can be added to the user. FIG. 14 illustrates an example showing the attributes 1400 of member “Joe Bloggs” (Note RoleName).

[0203] FIG. 15 illustrates a method 1500 for handling events in a system. In operation 1502, an event which includes metadata is recognized. Next, in operation 1504, the metadata of the event is read and, in operation 1506 a table look-up is performed for information relating to the event based on the metadata. The information includes a severity of the event and further information such as a type of the event, and a location where the event occurred. In operation 1508, a message is displayed either in-line in a currently depicted display or in a separate display based on the severity of the event.

[0204] Optionally, the event may additionally be indicated to components of the system other than the component in which the event occurred. The type of the event may be a database error, an architecture error, a security error, and/or an application error. Further the location of the event may be at least one of a method and an object where the event occurred. Also, the information may further relate to a code associated with the event.

[0205] The message may include the information relating to the event. In additionally, the message may also include a time during which the event occurred. Further, the message may include a string altered based on a user profile. The following material provides a more detailed description of the above-described method.

[0206] This portion of the present description details the ReTA Event Handler framework design from the perspective of the application developer. The role of this framework is to provide services to manage the informational, warning and error events that an application may raise. These services include:

• • [0207] Presenting the user with an understandable event explanation.
  • [0208] Informing other Components when errors happen (for example to restore transactional data to a consistent state) using a Publish/Subscribe mechanism.
  • [0209] Logging informational, warning and error event messages.

[0210] The Event Handler uses an Event Reference meta-data database table to maintain information about the types of events in an application and the policy for dealing with them. This gives a flexible approach and the event messages, the severity and other policies for the events can be changed during operations.

Phase 2—Event Handler Enhancements

[0211] For phase 2, Event Handler consists of the following enhancements:

• • [0212] The Event Handler framework is componentized. It no longer maintains references to any of the other framework components. Internally, the Event Handler continues to use the persistence light framework to log events to the database.
  • [0213] As in phase 1, it can be used as a Session level component. As an enhancement for phase 2, the Event Handler framework can be used as a stateless page level component. This means that a new instance of the component is created at the beginning of each ASP page and is released at the end of each page.
  • [0214] The Event Handler framework no longer requires Event Collection components as parameters to implement event handling, which only allowed handling events at the page level. In phase 2, the new method “processSingleEvent” takes the parameters of a single event as its input, which enables handling events at the occurrence of the event.
  • [0215] As in phase 1, The Event Handler can format error descriptions in HTML. As A an enhancement for phase 2, the Event Handler can return the error message as a string and enables the application to implement client specific formatting (HTML or other).
  • [0216] The process event method no longer calls the ASP redirect method. Instead, it returns the severity level code. On return, the application logic determines whether to redirect to the error page or display the error in-line in the current page.
  • [0217] The Translator is no longer a separate component. Instead, it is a Java class inside the Event Handler component.
    Event Handler Framework
    Description

[0218] With reference to FIG. 15.1, the ReTA Event Handler Framework 1530 manages the informational, warning and error events that an application raises. The following describes the ReTA event handling sequence:

• [0219] 1) The event(s) occurs
  • [0220] When an event occurs the following event information is recorded:
    • [0221] event type (defined in database Event Reference table), for example:
      • [0222] database error
      • [0223] security error
      • [0224] architecture error
      • [0225] application error
    • [0226] event location:
      • [0227] method and object name where the event occurred
    • [0228] event code (sub-type):
      • [0229] SQL error code,
      • [0230] application error code—mapped to a unique description in the database
      • [0231] architecture error code—mapped to a unique description in the database
    • [0232] event context:
      • [0233] Any relevant information about when the event occurred stored in a tagged
      • [0234] name value pair format. Eg.
      • [0235]  [OrderNumber=1] [Description=“Repeat Order”]
  • [0236] If the event occurs within a Java class inside a COM object, use the Java exception mechanism by throwing an AFEventException. If the exception occurs elsewhere, call the add method on the Event Collection passing the event information.
  • [0237] Each method defining a COM component interface captures these event exceptions and either adds them to an Event Collection component or directly calls a method on the Event Handler component.
  • [0238] Events are processed from the ASP page by calling the process method of the Event Handler. Events can also processed from the point where the event occurred by calling the “processSingleEvent” method of the Event Handler.
• [0239] 2) The Event Handler processes the event(s):
  • [0240] For each event, set the user id and current page
  • [0241] For each event, retrieve the event severity from the event handler's “translator” class. This class caches in memory all event descriptions and severity levels retrieved from the event reference database table.
  • [0242] Add the events to the Event Handler context.
  • [0243] Implement the persistence policy on the events—events are logged in a batch.
  • [0244] Return the severity of the most severe event to the caller. The caller is responsible for either redirecting to the error page or displaying the event in-line in the Current Page.
• [0245] 3) Display the event:
  • [0246] Use the Event Handler component to generate the error message. This message can contain context information describing when the event was created.
  • [0247] Create the HTML formatting and display the event message.
  • [0248] The Error Message is either displayed in-line in the current page or in a separate error page.
• [0249] 4) The Event Handler generates error display message:
  • [0250] Get the event with the highest severity level from its event context.
  • [0251] If the most severe event is “fatal”, display the user description associated with the event. Broadcast a SESSION_ABORT message using the Publish/Subscribe mechanism. Any component that is interested in these events must implement the IAFEventListener interface and register with the Event Broadcaster component as interested. To do this they call the addListener method of the Event Handler component.
  • [0252] If the most severe event is “logical unit of work”, display the user description associated with the event. Broadcast an ACTIVITY-ABORT message using the Publish/Subscribe mechanism.
  • [0253] If the most severe event is “warning”, display the user description associated with the event.
  • [0254] Note: The user event descriptions are retrieved from the database either on session start or on demand and are cached by the Translator class. When generating the event description page, this description is requested from the Translator. Event descriptions can have embedded context parameters. When generating the event description page, the event handler replaces these parameters with their values specified when creating the event.
    Database Tables

[0255] The Event Handler uses two database tables: The To_AF_EventReference 1534 is a static table that describes the Event meta-data, giving the policies for each event type. The policies include:

• • [0256] The message that is displayed to the user. These messages can contain data from the Context that is included when the event is generated.
  • [0257] The severity of the event. The severity can be Information, Warring, Error and Fatal.
  • [0258] Whether to persist the event in the database event log.

[0259] The T_AF_EventLog 1536 contains the log of the events that occurred. The following information is logged:

• • [0260] Event type and Code
  • [0261] The location where the event occurred. I.e. ASP, Object name and Method Name.
  • [0262] The user that raised the event.
  • [0263] The datestamp.
  • [0264] The context information giving other information about what caused the event.
    Services

[0265] The Event Handler Framework provides the following services:

[0266]

	Service	Detail
	Register event	Create event
		Maintain event reference
	Process event	Information
		Warning
		Logical Unit of Work
		Fatal
	Display events	Translate event
		Inform user
	Persist event	Log event to database

Components and Classes

[0267] The Event Handler Framework implements these services through the following COM and Class objects:

[0268]

Component	Service
AFEvent	Handle events generated by the system
Handler
AFEvent	Contains a collection of events (AFEventException)
Collection
AFResult	Defines the result returned by a method execution.
Class
AFEvent	Contains single event information.
Exception
AFEvent	Contains event reference information from database table
Reference	T_AF_EventReference
AFTranslator	Returns event reference information based on the event
	type and event code.
AFPersistable	Note: multi-language translation functionality not
Event	implemented
	This is the persistable class containing the information
	for a single event. It is a sub-class of the Persistence
	PersistableObj class. The persistance mechanism can
	insert, delete, select and update objects of this class in the
	database. This class persists event information the
	T_AF_EventLog table.

[0269] These components and classes are described in detail in the following sub-portion of the description.

AFEventHandler

[0270] The AFEventHandler component 1538 handles the events generated by the sys tem. Depending on the severity level, the event handler may redirect the user to another ASP page and may abort the activity or session. The event handler also determines whether and when to log an event.

Methods

[0271] The IAFEventHandler interface defines the access to the AFEventHandler component. This interface supports the following methods:

[0272]

Method	Description
PersistAllEvents	Persist all the events stored by the event
	handler to the database.
ProcessSingleEvent	Gather associated event information. Call the
	add method to persist the events in the event
	log. Return the event severity to the caller.
	This method is called either from the ASP page
	or from a Java class where the Event was
	trapped.
Process	Examine the events and gather associated
	event information. Call the add method to
	persist the events in the event log. Return the
	event severity of the most severe event to the
	caller. The application developer calls this
	method from an ASP page to check the events
	generated during the scripting logic execution.
Generate	Return generated HTML which describes the
	severity of the error, gives the target URL
	(depending on the severity - previous page,
	activity start page or home page) and an error
	log. The Event Handler page calls this
	method.
Initialize	The application developer can invoke this
	method to load all event descriptions in
	memory (normally used to speed access during
	user session).
GetErrorDescription	Return error message as a string, which
	describes the severity of the error. This allows
	the application to determine the HTML
	formatting used to display an error.
HasFatalError	If the event handler contains at least one fatal
	error, returns true.

AFEventCollection

[0273] The AFEventCollection component contains a collection of events.

Methods

[0274] The IAFEventCollection interface defines the access to the AFEventCollection component. This interface supports the following methods:

[0275]

Method	Description
SpecifySubActivity	Attach the sub-activity to all events contained
	in the event collection.
GetSubActivity	Return the sub-activity attached to all events
	contained in the event collection.
Add	Add an event to the event collection.
Get	Return the requested event.
NumberOfEvents	Return the number of events in the collection.
Clear	Clear all the events from the collection.

AFResult

[0276] The AFResult component defines the result return by a method execution.

Methods

[0277] The LAFResult interface defines the access to the AFResult component. This interface supports the following methods:

[0278]

	Method	Description
	GetResult	Return the result.
	AddResult	Add a result.
	AddResultString	Add the result as a string.
	GetResultString	Return the result as a string.

AFT transistor

[0279] The AFTranslator class returns event reference information (based on the event type and event code.

Methods

[0280] The AFTranslator class has the following methods:

[0281]

Method	Description
GetEventTranslation	Return the description for this event.
GetEventSeverity	Return the severity level for this event.
GetEventPersist	Return flag that defines whether to persist this
	event.
GetUserDescription	Return the user description for this event
	description is displayed to the user.
GetDescription	Return the description for this event. This
	description is user by the technical support
	team to analyze error.
Start	Initialize component.

AFEventException

[0282] The AFEventException class contains the event exception information and is added to the AFEventCollection component for processing by the AEFEventHandler component.

Methods

[0283] The following AFEventException class methods are important for the application developer to understand:

[0284]

Method	Description
AFEventException	Create the event exception class and populate
	it with
	event type:
	database error
	Java error
	security error
	architecture error
	application error
	event location:
	method and object name where the event
	occurred
	event code (sub type)
	SQL error code,
	Application error code - mapped to a unique
	description in the database
	Architecture error code - mapped to a unique
	description in the database
	event context:
	value of specific object
AddToCollection	Add the current event to an event collection.

AFEventReference

[0285] The AFEventReference component 1540 contains the event reference information that is defined by the application through database table T_AF_EventReference. The architecture reads the event reference data into memory on session start.

[0286]

T_AF_EventReference:
Column name	Description
Id	Unique id
Type	The event type
Code	The event code
SeverityLevel	The event severity level:
	1:Information
	2:Warning
	3:Abort the activity
	4:Fatal, close the session
Persist	1:if the event should be persisted in the event log.
	0:if the event should not be persisted
Description	Event description showed to the operator
UserDescription	Event description shown to the user. This description
	can contain contextual information, which is specified
	by adding tag like [ParameterName] in the
	description. These tags are replaced by the event
	framework when displaying the event to the user.
Language	Language of the description. This may be used by the
	multi-language framework when developed. At this
	time, set to ‘English’.
Context	Event context default value.

AFPersistableEvent

[0287] The AFPersistableEvent 1542 contains the event information captured during the application execution that is persisted to the database table T_AF_EVENTLOG.

[0288]

T_AF_EVENTLOG:
	Column name	Description
	Id	Unique id
	Type	The event type
	Code	The event code
	SeverityLevel	The event severity level:
		1:Information
		2:Warning
		3:Abort the activity
		4:Fatal, close the session
	SubActivityLevel	Name of Sub Activity where event occurred.
	MethodName	Name of class method where event occurred.
	ObjectName	Name of class where event occurred.
	ASP	Name of ASP page where event occurred.
	Context	Event context default value.
	UserID	ID of user logged in when event occurred.
	LastUpdate

[0289] FIG. 16 depicts a method 1600 for managing user information. A site server is provided in operation 1602. The side server has information stored on it including preferences, roles, and details relating to users. A database separate from the site server is provided in operation 1604. The database has information stored thereon including preferences, roles, and details relating to the users. In operation 1606, an identity of one of the users is authenticated. A single interface is displayed in operation 1608, which provides the user access to both the site server and the database upon authentication of the identity of the user. In operation 1610, the user is allowed to view and change the information that is stored on the site server and the database and that is associated with the user. The single interface is tailored in operation 1612 based on the information associated with the user.

[0290] The identity of the user may be authenticated by verifying a user name and a password, a secure sockets layer (SSL) certificate, and/or a log-in form. Further, the preferences relating to the users may include a currency in which monetary values are displayed and a language in which text is displayed. Also, the roles relating to the users may include a customer, a manager, and an employee. Additionally, the details of the users may include a user name and a legal name. The following material provides a more detailed description of the above-described method.

[0291] This portion of the present description details the ReTA User framework design from the perspective of the application developer. The primary role of this framework is to provide services that allow the application developer to maintain user preferences, roles and security.

[0292] In regards to security, the User framework provides User Authentication services through any of the standard Internet Information Server security methods:

• • [0293] Username/Password sent in clear text.
  • [0294] SSL Certificates
  • [0295] Windows NT Challenge/Response (Intranet only)
  • [0296] HTML Forms login (Site Server version only)

[0297] Once the user has been authenticated, the User framework provides services for accessing:

• • [0298] User information—NT username, Real Name.
  • [0299] User Preference information—For example Language, Currency (These are configurable)
  • [0300] User Role information (e.g. Customer, Manager, Employee)
  • [0301] User Role Preference information

[0302] There are two implementations of the User Component: One is database driven and the other interfaces with Site Server Personalization and Membership directory.

User Framework

Description

[0303] With reference to FIG. 16.1, the User framework 1630 enables two approaches to maintaining user information. The framework supports two approaches by exposing a single set of interfaces that can be used by either of the two user framework components. With the AFUserSS component 1632, the framework interfaces with the Microsoft Site Server products Personalization and Membership Directory. For this user component, SiteServer holds and manages user information. With the AFUserDB component 1634, the framework interfaces with database tables. For this user component, database tables define the user information.

Services

[0304] The User Framework provides the following services:

[0305]

	Service	Detail
	User Information	User Role
	Maintenance	User RoleName
		User Preferences
		User Role Preferences
		User Id
		User Name
		User RealName.

Components

[0306] The User Framework implements these services through the following COM objects:

[0307]

Component	Service
AFUserDB	User information maintained through the following
	database tables.
	T_AF_USERNAME,
	T_AF_USERPREFERENCES
	T_AF_USERROLES
AFUserSS	User information maintained through SiteServer.

[0308] These components are described in detailed in the following sub-portions of the description.

AFUserDB

[0309] The AFUserDB component holds the user role, preferences and details retrieved from the database. When created the user component retrieves the user NT login name, user details and constructs the user preference and user role objects.

Methods

[0310] The IAFUser, IAFUserPreferences and LAFUserRole interfaces define the access to the AFUserDB component. These interfaces support the following methods:

[0311]

Method	Description
Init	This method retrieves the user's NT name, user details
	from the database, constructs the preference object and
	constructs user's role object.
GetUserID	Returns the user id.
GetUserName	Returns the user's NT account name.
GetRealName	Returns the user's real name.
GetPref	Returns user's preference based on label passed to this
	method.
SetPref	This method sets the user's preference to the 2nd
	parameter passed in.
GetRoleID	Returns the user's role ID.
GetRoleName	Returns the user's role name.
GetRolePref	Returns role preference.
SetRolePref	This method sets the current user's role preference

AFUserSS

[0312] The UserSS component interfaces with the SiteServer personalization and membership services. This component uses SiteServer to handle the user security, role and preferences.

Methods

[0313] The IAFUser, IAFUserPreferences, and LAFUserRole interfaces define the access to the AFUserSS component. These interfaces support the following methods:

[0314]

Method	Description
Init	This method returns a zero integer. It is here for
	compatibility with the UserDB component.
GetUserID	This method returns a string value representing the user
	id. SiteServer's API is used to obtain this value.
GetUserName	This method returns a string value representing the user's
	name. SiteServer's API is used to obtain this value.
GetRealName	This method returns a string value representing the user's
	real name. SiteServer's API is used to obtain this value.
GetPref	This method returns a string value representing the user's
	preference. SiteServer's API is used to obtain this value.
SetPref	This method accepts two parameters (String
	thePrefLabel, String thePrefValue). The preference is set
	that matches the “thePrefLabel” passed in.
GetRoleID	This method returns the current user id.
GetRoleName	This method returns the current user's role name.
GetRolePref	This method returns the current user's role preference.
SetRolePref	This method sets the current user's role preference

[0315] FIG. 17 illustrates a method 1700 for managing business objects in a system that includes a plurality of sub-activities which each include sub-activity logic adapted to generate an output based on an input received from a user upon execution, and a plurality of activities which each execute the sub-activities in a unique manner upon being selected for accomplishing a goal associated with the activity. First, in operation 1702, an identifier and a reference to a business object are received from one of the sub-activities upon the execution thereof. In operation 1704, a database is accessed and data from the database is retrieved based on the identifier. The business object is created and populated with the data retrieved from the database in operation 1706.

[0316] The data may be stored on the database in tables. Further, the created business object may replace an existing business object. Additionally, the identifier may identify a customer and the business object may be a customer object. Also, a business object referenced by one of the sub-activities may be removed upon the execution thereof.

[0317] The business object may be a Visual Basic business object. In another aspect of the present invention, the business object may be a Java business object. The following material provides a more detailed description of the above-described method.

[0318] This portion of the present description details the ReTA Persistence framework design from the perspective of the application developer. The role of this framework is to provide services that interact with application database(s) to create, retrieve, update and delete business objects.

Persistence Framework

Description

[0319] The ReTA Persistence framework provides a transparent and flexible mapping of the business object attributes to relational database tables. To implement this “business object to database table” mapping, the framework is tightly integrated with all business objects. The framework exposes abstract methods that the application developer implements in the business objects. In contrast with the other ReTA frameworks, the Persistence framework is not implemented as a separate component.

[0320] The Persistence framework is a set of local language classes available in Java or Visual Basic. FIG. 17.1 shows a SubActivity component 1730 using the Persistence framework 1732 to retrieve a Customer Object 1734 from the Database.

Services

[0321] The Persistence Framework provides the following services:

[0322]

Service	Detail
Database Connection	Uncouple database connection from application
Database mapping	Map an object to a database table
Object query	Trigger queries on objects
	Easily iterate through the results
Record locking	Optimistic locking
Encryption	Encode Database User Name and Password
	Note: Encoding implemented only once (as part
	of system set up).
	Decode Database User Name and Password
	Note: Used by persistence framework during all
	database accesses.

Classes

[0323] The Persistence Framework implements these services through the following Java or Visual Basic Classes:

[0324]

Java Class	Service
AFPL	This is the superclass of all Java Persistable Objects in
PersistableObj	the application. Application developers create a subclass
	for each Business Object and implement all the abstract
	methods that this class defines.
AFPLExtent	Provides the mapping between the business object and its
	associated database table and manages the database
	connection.

[0325]

Visual
Basic Class	Service
VBPersistObj	This is the interface class that all Persistable VB must
	implement. Application developers create a subclass for
	each Business Object and implement all the methods that
	this class defines.
VBExtent	Provides the mapping between the business object and its
	associated database table and manages the database
	connection.

[0326] These classes are described in detailed in the following sub-portions of the description.

AFPLPersistableObj

[0327] The AFPLPersistableObj abstract class contains methods called by the application developer objects to manage attribute values common to all persistable business objects (user id and last update timestamp). In addition, the AFPLPersistableObj class represents the superclass of a persisted object. In order to persist a business class; the application developer extends AFPLPersistableObj and implements the AFPLPersistableObj abstract methods.

[0328] The AFPLPersistableObj defines the following methods:

[0329]

Method	Description
addColumnName	Return the column names common to all
	persistable business objects (user id and last
	update timestamp). The application developer
	invokes this method from the constructor
	method of a business object.
addPersistedAttributes	Return attributes common to all persistable
	business objects (user id and last update
	timestamp). The application developer
	invokes this method from the
	getPersistedAttributes method of a business
	object.
isEqual	Abstract method that all Business Objects must
	implement. If the passed in attribute is one of
	the attributes common to all persistable
	business objects (user id and last update
	timestamp), compare the passed in value to the
	currently held attribute value. The application
	developer should also invoke the superclass
	isEqual.
newFrom	Abstract method that all Business Objects must
	implement. Populate the Business Object using
	the result set passed as an attribute. The
	application developer should also invoke the
	superclass newFrom method to populate the
	UserId and lastUpdate attributes.
attributeGet	Abstract method that all Business Objects must
	implement. Return the value of the attribute
	passed as parameter
attributeSet	Abstract method that all Business Objects must
	implement. Set the value of the attribute passed
	as parameter
setUserId	Set the user id value
getUserId	Return the user id value
setTimeStamp	Set the last update timestamp value
getTimeStamp	Return the last update timestamp value.
setUserIdTimeStampto	Adds the last update timestamp value and user
Obj	id to the passed in persistable business object.
	The application developer invokes this method
	from the setUserIdTimeStamptoObj method of
	a business object.
getColumnNames	Return the database table column names.
getPersistedAttributes	Return all the attributes to persist. The
	application developer invokes the
	addPersistedAttribute method of the super
	class to add user id and last update timestamp
	attributes.
getKeyNames	Return the primary key field name.
getKeyValues	Return all the primary key values.
getKeyAttributeVector	Return vector of all key attributes.
getKeyAttributes	Return the array of all key attributes.
getTableName	Return the name of the database table
	associated with this business object.
columnList	Returns a comma-separated list of all columns
	corresponding with this class.
attributesForInsert	Returns a comma separated list of attribute
	values for SQL insert command.
attributesForUpdate	Returns a comma separated list of attribute
	name = attribute value pairs for SQL update
	command.
conditionForUpdate	Returns the ‘where’ clause for SQL update or
Remove	remove command (both are equal).

AFPLExtent

[0330] The AFPLExtent class provides the mapping between the business object and its associated database table. In addition, the AFPLExtent class represents the domain defined by the visible part of the database table for the specified user. This class holds the passed in database URL, username and password used during the access to the database. Lastly, the AFPLExtent class manages the database connection.

Methods

[0331] The AFPLExtent class implements the following methods used by the application developer from business factory objects:

[0332]

	Method	Description
	Select	Return all business objects matching the search
		criteria.
	Update	Update all business objects matching the
		search criteria
	Delete	Remove all business objects matching the
		specified criteria
	Insert	Insert new business object(s)

VBPersistObj

[0333] The VBPersistObj interface class contains methods that need to be implemented on every VB Business Object.

[0334] The application developer implements the following methods from their business object:

[0335]

Method	Description
newFrom	Create a new instance of that class using the
	resultset passed as parameter
GetValue	Returns the value for the attribute passed as
	parameter.
SetValue	Sets the value for the attribute passed as
	parameter.
GetColumns	Return the database table column names.
GetTableName	Return the Table Name where this class is
	stored in the database.
attributesForInsert	Returns a comma separated list of attribute
	values for SQL insert command.
attributesForUpdate	Returns a comma separated list of attribute
	name = attribute value pairs for SQL update
	command.
conditionForUpdate	Returns the ‘where’ clause for SQL update or
Remove	remove command (both are equal).

VBExtent

[0336] The VBExtent class provides the mapping between the business object and its associated database table. In addition, the VBExtent class represents the domain defined by the visible part of the database table for the specified user. This class holds the passed in database URL, username and password used during the access to the database. Lastly, the VBExtent class manages the database connection.

Methods

[0337] The VBExtent class implements the following methods used by the application developer from business factory objects:

[0338]

	Method	Description
	Select	Return all business objects matching the search
		criteria.
	Update	Update all business objects matching the
		search criteria
	Delete	Remove all business objects matching the
		specified criteria
	Insert	Insert new business object(s)

[0339] FIG. 18 illustrates a method 1800 for persisting information during a user session. First, in operation 1802, a session is initiated upon a user accessing a predetermined starting page. A current page accessed by the user is then tracked in operation 1804 while browsing a plurality of pages during the session. In operation 1806, a record is maintained of a page previously accessed by the user during the session. Information is persisted in operation 1808. This information is selected from a group of items such as user identifier, a time of a most recent user action during the session, activity components accessed during the session, and business components accessed during the session. During the session, the current page, previous page record, and information are provided to at least one activity component in operation 1810. Also in operation 1810, the activity component generates output based on input provided by the user via the plurality of pages.

[0340] In one embodiment of the present invention, the activity components to which the current page, previous page record, and information are provided may be selectively determined. In addition, the activity component may be provided an indication as to whether the user is permitted to access each of the pages. In such a case, the activity component may also be provided the indication as to whether the user is permitted to access each of the pages based on the previous page record.

[0341] In another embodiment of the present invention, the information may also include the user identifier. In such an embodiment, user preferences may be looked up based on the user identifier with the information including the user preferences. Also, in order to identify the persisted information, references to activity components, business components, a user component, a tracking manager component, a system preference component, and an event handler component may be employed. The following material provides a more detailed description of the above-described method.

[0342] This portion of the present description details the ReTA Session framework design from the perspective of the application developer. The primary role of this framework is to provide services to handle the stateless nature of Internet. By default, the Internet does not provide services for maintaining information between pages. Without these services, it would not be possible to implement most eCommerce functionality. For example, session level state is necessary to implement eCommerce functionality where a customer can select products on multiple product description pages and then submit a complete product order request from a confirm order page. The ReTA Session framework leverages the Internet Information Server/Active Server Page (IIS/ASP) session object, which is automatically created when a user who has no open IIS sessions requests a Web page.

Session Framework

Description

[0343] FIG. 18.1 illustrates a Session Flow Diagram—On Session Start. As shown, a Session framework 1830 operates in the MTS Runtime Environment 1832. FIG. 19 illustrates a Session Flow Diagram—On Start ASP Page. Again, the Session framework 1900 operates in the MTS Runtime Environment 1902. The ReTA Session framework provides services required throughout a user session. The user creates the Session framework at log on and removes the Session framework at log off. During the lifetime of the user session, application and architecture components require certain data to persist. This framework provides services to store and retrieve all information needed for a particular user session. This information may persist throughout the user session. The Session framework also provides services to uniquely identify the user and enforce access rights.

[0344] The user information that the Session framework persists, in memory, between Active Server Page requests includes:

• • [0345] User id
    • [0346] Identifies session user
  • [0347] Last page
    • [0348] Last page accessed by the session user.
  • [0349] Current page
    • [0350] Current page accessed by the session user.
  • [0351] Last connection time:
    • [0352] Session user's last connection time.
  • [0353] Current activity:
    • [0354] Activity currently being executed by the session user (refer to activity framework design
  • [0355] Activity Components
    • [0356] All activity components accessed during user session
  • [0357] Business Components
    • [0358] All business components accessed during user session required by multiple activity components.
      Note:

[0359] This framework uses the Active Server Page's Session Object. Thus, the framework only works with browsers that accept cookies. For other browsers (or if cookies are disabled), a new ASP Session Object may start for each web page.

Services

[0360] The Session Framework provides the following services:

[0361]

Service	Detail
Security	User identification
	Page access authorization - Session scope
	Automatic abort - timeout
Customized	Customized user interface
information	Customized application access
delivery
Manage user	Inform user on session status
session	Abort session
Flow control	Page to open on action
	Pages of activity
Maintain context	Activity Component context
	Business Component context - shared among activities
Message	Register listener
Broadcast	Broadcast Message to registered listeners
Encryption	Encode Database User Name and Password
	Note: Encoding implemented only once (as part of
	system set up).
	Decode Database User Name and Password
	Note: Used by session framework during all database
	accesses.

Components

[0362] The Session Framework implements these services through the following COM objects

[0363]

Component	Service
AFSession	Manages current user session
AFSystem	Contains System Preferences from database table
Preferences	T_AF_SYSTEMPREFERENCES
AFTracking	Contains security and flow control info from database
Manager	tables T_AF_PAGESOFACTIVITY,
	T_AF_AUTHDESTINATIONPAGE
	T_AF_AUTHSOURCEPAGE
	T_AF_DESTINATIONFORACTION
AFBrowserInfo	Contains current user's web browser information

[0364] These components are described in detail in the following sub portions of the description.

AFSession

[0365] The AFSession component maintains the users session state information To maintain the state information, this component holds references to activity components (logical units of work—application flow logic), business components (business logic required across activity components), user component (user information), tracking manager component (web page access security and web page flow control information), system preference component (system preference information) and event handler component (event handler) created during the user's session.

[0366] From the application developer's perspective, the state maintenance work performed by the AFSession component is transparent. The application developer leverages the session services through populating the database tables with the client specific information.

Methods

[0367] The IAFSession, IAFEventBroadcaster and IAFContext interfaces define the access to the AFSession component. These interfaces support the following methods:

[0368]

Method	Description
AFSession
Start	Start session - Called by ASP (global.asa
	Session_OnStart).
Stop	Stop session - Called by ASP (global.asa
	Session_OnStop).
StartPage	This method is called by ASP script logic at the start of
	each page. It is used to broadcast a pageStart event to all
	the listeners (activity components) that have registered as
	interested in pageStart events. It also stores this page as
	the current page and moves the existing current page into
	the last page (information held by the session's
	“tracking” object).
StopPage	This method is called by ASP script logic at the end of
	each page. It is used to broadcast a pageEnd event to all
	the listeners (activity components) that have registered as
	interested in pageEnd events.
Abort	This method is called when the session is to be aborted.
	This method calls the abort method on all activity
	components known to session (held by the session's
	“activity context” object).
SetCurrentPage	Sets the current Active Server Page (held by the session's
	“tracking” object).
GetCurrent	Returns the current Active Server Page (held in the
Page	session's “tracking” object).
GetLastPage	Returns the last Active Server Page accessed in the
	session (held in the session's “tracking” object).
SetSessionId	Update the sessionId attribute.
GetSessionId	Returns the current session Id.
SetCurrent	Sets the current activity Page (held in the session's
Activity	“tracking” object).
GetCurrent	Returns the instance of the current activity (held in the
Activity	session's “tracking” object).
GetActivity	Returns the instance of the requested activity (held by the
	session's “activity context” object).
IsActivityIn	Ask session if it has a reference to the requested activity
Context	(held by the session's “activity context” object). If
	found, returns true, else returns false.
AddActivity	Add the requested activity (references held by the
	session's “activity context” object). Set the requested
	activity to the current activity (held in the session's
	“tracking” object).
Remove	Remove the current activity (held by the session's
Activity	“activity context” object).
GetNextPage	Returns the next web page to access for the current
	activity (information held by the “tracking manager”
	component).
GetAFUser	Returns the “user” component (information associated
	with the current logged in user).
SetAFUser	Sets the user for the current session. Returns an integer
	indicating success or failure.
GetTracking	Returns the “tracking manager” component.
Manager
GetEvent	Returns the “event handler” component.
Handler
GetSystem	Returns the “system preference” component.
Preferences
AddObject	Add a business object (held by the session's “business
	object context” object).
GetObject	Returns the instance of the requested business object
	(held by the session's “business object context” object).
RemoveObject	Remove the instance of the requested business object
	(held by the session's “business object context” object).
ContainsKey	Returns true if the “label” of the requested business
	object exists (held by the session's “business object
	context” object).
GetKeys	Returns all business object “labels” (held by the
	session's “business object context” object).
AFEventBroadcaster
AddListener	Add the requested listener (activity component) to list of
	interested listeners. If an activity is interested in a
	StartPage event (i.e., needs to capture user modified data
	from the previous web page), this method is called by
	ASP script logic at the start of the page.
Remove	Remove the requested listener (activity component) from
Listener	list of interested listeners.
BroadcastEvent	Invoke the receiveEvent method on all registered
	listeners (activity components). Refer to activity
	framework design for the automated user data capture
	functionality.

AFSystemPreferences

[0369] The AFSystemPreferences component contains system preferences (held during the session). This component uses the ReTA persistence framework to read the system preferences from the database (“system preferences” table).

Methods

[0370] The IAFSystempreferences interface defines the access to the AFSystemPreferences component. This interface supports the following methods:

[0371]

Method	Description
Start	Reads and stores “system preference” data from “system
	preferences” table.
GetRootAsp	Returns the application's ASP root location (as defined in
	from “system preferences” table).

AFTrackingManager

[0372] The AFTrackingManager component provides page sequence security, dialogue flow and activity flow functionality for the session framework.

Page sequence security

[0373] The page sequence security is defined in the following tables:

• • [0374] Table “Authorized Destination Page” 1834:
  • [0375] Define for each page, the pages that are allowed to be accessed. If no authorized destination pages are defined, the page is authorized to access any page.

[0376]

	Column name	Description
	Id	Unique id
	CurrentPage	Name of the current page
	DestinationPage	Page which is authorized to be access

• • [0377] Table “Authorized Source Page” 1836:
  • [0378] Define for each page, the pages that are allowed to access it. If no authorized source pages are defined, the page is authorized to be accessed by any page.

[0379]

	Column name	Description
	Id	Unique id
	CurrentPage	Name of the current page
	SourcePage	Page authorized to access the current page

Dialogue flow

[0380] The dialogue flow is defined in the following table:

• • [0381] Table “Destination For Action” 1838:
  • [0382] Define the action flow between the web pages (i.e., which ASP is open when a specified push button is clicked during a specified activity).

[0383]

	Column name	Description
	Id	Unique id
	CurrentPage	Name of the current page
	Action	Name of the UI widget, which triggers the
		action
	Activity	Name of the activity where the event is
		triggered
	DestinationPage	Name of the page to open

Activity Flow

[0384] The activity flow is defined in the following table: Table “Page Of Activity” 1840:

[0385] Define the automated activity switching when the user jumps from one web page to another.

[0386]

	Column name	Description
	Id	Unique id
	Activity	Name of the activity
	Page	Name of the page belonging to the activity

Methods

[0387] The IAFTrackingManager interface 1904 defines the access to the AFTrackingManager component. This interface supports the following methods:

[0388]

Method	Description
CheckAuthorized	Determines if the previous page is in the list of
SourcePage	allowable sources for this page (as defined in
	“Authorized Source Page” table). If access is
	allowed, returns true. Else, returns false.
CheckAuthorized	Determines if this page is in the list of
DestinationPage	allowable destinations for the previous page (as
	defined in “Authorized Destination Page”
	table). If access is allowed, returns true. Else,
	returns false.
GetDestination	Returns destination page for requested action,
	activity, and source page (as defined
	Destination For Action” table).
IsPartOfActivity	Determines if this page is part of requested
	activity (as defined in “Page Of Activity” table).
	If page is part of activity, returns true. Else,
	returns false.
Start	Reads and stores the Authorized Destination
	Page, Authorized Source Page, Destination For
	Action and Page Of Activity tables.

AFBrowserInfo

[0389] The AFBrowserInfo component contains the user's browser information.

Methods

[0390] The IAFBrowserInfo and IAFEditable interfaces define the access to the AFBrowserInfo component. These interfaces support the following methods:

[0391]

Method	Description
GetBrowserName	Returns the name of the browser that the user
	is currently running.
GetBrowserVersion	Returns the version of the browser that the
	user is currently running.
IsPluginSupported	Note: not implemented
IsCustomPluginSupported	Note: not implemented
IsMimeSupported	Note: not implemented
SetValues	Sets the requested attribute's value.
GetValue	Returns the requested attribute's value.

[0392] FIG. 20 illustrates a method 2000 for generating a graphical user interface. A form is initially created in operation 2002. The form includes a plurality of attribute rules dictating a manner in which user interface objects are situated thereon. In operation 2004, a plurality of user interface objects are selected. A page is generated in operation 2006 with the selected user interface objects situated on the page in accordance with the attribute rules of the form. JavaScript actions are attached to the selected user interface objects in operation 2008. The JavaScript actions are capable of being executed upon detection of a user action involving one of the user interface objects.

[0393] The user interface objets may include one or more of the following: a push button, a text box, a text area, a radio button, a check box, a drop down, a blank item, a user interface list, and a static table. The user action may include at least one of clicking on one of the user interface objects, changing text in one of the interface objects, exiting a text box of one of the interface objects. Further, the user action involving one of the user interface objects may cause a predetermined event. Optionally, the page may be an HTML page. The following material provides a more detailed description of the above-described method.

[0394] This portion of the present description details the ReTA User Interface (UI) framework design from the perspective of the application developer. The role of this framework is to provide services that generate the HTML code for UI widgets and attach Javascript actions to UI widgets. The UI framework exposes these services through a set of Component. Object Model (COM) objects. The application developer uses these U d COM objects and their services through scripting logic added to the application's Active Server P ages (ASP).

User Interface Framework

[0395] The User Interface framework provides components for generating HTML. An HTML page is generated from a combination of the various UI Components. FIG. 20.1 shows the steps for generating a HTML page consisting of a form 2030 with a TextBox 2032, a DropDown list 2034 and a PushButton 2036.

[0396] The User Interface Framework provides the following services

[0397]

	Service	Detail
	Generate UI Items	Form
		Push Button
		Text Box (single-line entry field)
		Text Area (multi-line entry field)
		Radio Button group
		Check Box
		Drop Down List Box
		Blank Item
		Static Table
		Single-Select List Box
	Generate UI actions	JavaScript - action shell
		JavaScript - data type validation
		JavaScript - data range validation
		JavaScript - automatic navigation action
	Generate Page Format	Cascading Style Sheet
		Form (grid layout for form elements)

[0398] The User Interface Framework implements these services through the following COM objects:

[0399]

Component	Generates
AFForm	Form containing the widgets
AFPushButton	Push button widget
AFTextBox	Single-line entry text box widget
AFTextArea	Multi-line entry text box widget
AFRadioButton	Radio button widget
AFCheckBox	Check box widget
AFDropDown	Combo box widget
AFBlankItem	Blank item widget (used for spacing.)
AFUIList	Single-Select List Box widget - IE4 Only
AFStaticTable	Static Table widget
AFHardCodedASPAction	Javascript function - Move to next page
AFScriptAction	HTML - attach Javascript function to a form
	element
AFScriptGenerator	Javascript tag and functions
AFStyleSheet	Cascading style sheet (CSS)

[0400] These components are described in detail in the following sub-portions of the description.

AFForm

[0401] The AFForm component is used in conjunction with form element widgets to build complex user interfaces. Initially, the application creates an instance of the form component and sets its attributes. Following this activity, the application creates instances of the associated form element widgets and adds them to the form using the form's add method. As another service, the form component provides methods to help align all associated form element widgets properly on the page.

Methods

[0402] The IAFForm interface defines the access to the AFForm component. This interface supports the following methods, which the developer uses to create a form.

[0403]

Method	Description
Int left()	Align the form left
Int right()	Align the form right
Int center()	Align the form centrally
Int caption(String)	Sets the caption that may appear at the top of
	the form.
Int name(String)	Set the HTML name of the form. This option is
	required by some of the items which can be
	added to the form and should always be set
Int value(String)	Set the HTML value of the form.
Int border(int)	Sets the width of the border around the form
Int size()	Returns the number of form element widgets
	added to form.
String sendLocation(int	Value of the Location object attached to the
eventcollection)	members of this form.
Int form_width(int)	Sets the width of the form in UI elements. For
	example if set to 2 a form 2 elements wide
	would be created. A third element added to the
	form would be placed on a new line.
Int cell_width(int)	Sets the HTML Cell padding value for the
	form. A larger number may increase the
	spacing between the form elements.
Int lockTableWidth(int)	Locks the width of the form to the input value
	in percentage valid ranges (0-100%). Use this
	option to set the amount of screen width the
	form may occupy.
Int Add(Widget Object,	Add a widget object to this form. Widgets are
eventcollection)	created separately.
String generate(event	Generates the HTML code for the Form. The
collection)	return value is the output HTML and should be
	printed to the screen.

AFPushButton

[0404] The AFPushbutton component can only be used in conjunction with a AFForm component (the form's generate method iterates through the generate method for all form element widgets to build the necessary HTML code). An action object can be attached to a AFPushButton component. (Refer to AFHardCodedASPAction and AFJScripaAction for details).

Methods

[0405] The IAFPushbutton and IAFUCIActionItem interfaces define the access to the AFPushbutton component. These interfaces support the following methods, which the developer uses to create a push button form element.

[0406]

Method	Description
Int left()	Align the button left
Int right()	Align the button right
Int center()	Align the button centrally
Int caption	Set the text that may appear on the button. The button
(String)	may stretch its size to fit this text
Int name(String)	Set the name of the button.
Int setIsReset	Set the button to be the default HTML reset button.
Button()	When this method is called, clicking on the button
	causes the values of all HTML form elements in the
	form to which this button belongs to be reset to their
	values when the page was initially loaded.
Int	Resets the above method. The button returns to being a
setIsNotReset	normal Widget item.
Button()
Int addAction	Adds an action to the button.
(Action)

AFTextBox

[0407] The AFTextBox component can only be used in conjunction with a AFForm component (the form's generate method iterates through the generate method for all form element widgets to build the necessary HTML code). An action object can be attached to a AFTextBox component. (Refer to AFHardCodedASPAction and AFJScriptAction for details).

Methods

[0408] The IAFTextBox and IAFUIActionItem interfaces define the access to the AFTextBox component. These interfaces support the following methods, which the developer uses to create a Text Box form element.

[0409]

Method	Description
Int left()	Align the textbox to the left
Int right()	Align the textbox to the right
Int center()	Align the textbox to the center
Int caption	Set the caption to appear next to the text box
(String)
Int name(String)	Set the HTML name of the text box
Int max_length	Set the maximum length of text in the box
(int)
Int size(int)	Set the visible size of the text box
Int default_text	Set the default text in the text box
(String)
Int dataValidation	Adds data validation to the onBlur event of the text
(type, range,	box.
lower bound,	Data Type validation includes:
upper bound)	Numeric-DV_TYPE_ISNUMERIC,
	Alpha-DV_TYPE_ISAPLHA, or
	Date-DV_TYPE_ISDATE.
	None-DV_NONE
	Range validation* includes all 8 permutations-<less
	than>through <(less than equal) and (greater than
	equal)>.
	DV_RANGE_LESSTHAN,
	DV_RANGE_LESSTHANEQUAL,
	DV_RANGE_GREATERTHAN,
	DV_RANGE_GREATERTHANEQUAL,
	DV_RANGE_LESSTHAN_GREATERTHAN,
	DV_RANGE_LESSTHANEQUAL_GREATERTH
	AN,
	DV_RANGE_LESSTHAN_GREATERTHANEQU
	AL,
	DV_RANGE_LESSTHANEQUAL_GREATERTH
	ANEQUAL
	*Note: Range validation only occurs for “Numeric”
	data type.
Int setTextBox	This method sets a private member variable to an
Indicator(int)	integer value, this value indicates if the textbox may
	be the only textbox on the form that is to be
	generated.
Int addAction	Adds an action to the onChange event of the text
(Action)	box.

AFTextArea

[0410] The AFTextArea component can only be used in conjunction with a AFForm component (the forms generate method iterates through the generate method for all form element widgets to build the necessary HTML code). An action object can be attached to a AFTextArea component. (Refer to AFHardCodedASPAction and AFJScriptAction for details).

Methods

[0411] The IAFTextArea and IAFUIActionItem interfaces define the access to the AFTextArea component. These interfaces support the following methods, which the developer uses to create a Text Area form element.

[0412]

Method	Description
Int left()	Align the text area left
Int right()	Align the text area right
Int center()	Align the text area to the center
Int caption	Set the caption to appear next to the text area
(String)
Int name	Set the HTML name of the textArea
(String)
Int formName	The name of the HTML form on which the textarea is to
(String)	be placed. This is a required method and the textarea
	may not function correctly without this value being set.
Int setRows	Set the number of rows which the text Area may display
(int)	to the user
Int setColumns	Set the number of columns, which the text Area may
(int)	display, to the user.
Int data	Adds data validation to the onBlur event of the text box.
Validation	Data Type validation includes:
(type, range,	Numeric-DV_TYPE_ISNUMERIC,
lower bound,	Alpha-DV_TYPE_ISAPLHA, or
upper bound)	Date-DV_TYPE_ISDATE.
	None-DV_NONE
	Range validation* includes all 8 permutations-<less
	than>through <(less than equal) and (greater than
	equal)>.
	DV_RANGE_LESSTHAN,
	DV_RANGE_LESSTHANEQUAL,
	DV_RANGE_GREATERTHAN,
	DV_RANGE_GREATERTHANEQUAL,
	DV_RANGE_LESSTHAN_GREATERTHAN,
	DV_RANGE_LESSTHANEQUAL_GREATERTHAN,
	DV_RANGE_LESSTHAN_GREATERTHANEQUAL,
	DV_RANGE_LESSTHANEQUAL_GREATERTHAN
	EQUAL
	*Note: Range validation only occurs for “Numeric”
	data type.
Int setForm	Set the name of the form onto which the textArea object
Name(String)	is being added. This method is mandatory for the
	correct functioning of the method.
Int set	Set the maximum size of text, which can be entered into
MaximumSize	the text area. When this value is exceeded, a pop up
(int)	window may warn the user that they have exceeded the
	maximum size and that their entry may be truncated to
	the maximum value (which is set here). The default
	value is 500.
Int addAction	Add an action to the textarea.
(action)

AFRadioButton

[0413] The AFRadioButton component can only be used in conjunction with a AFForm component (the form's generate method iterates through the generate method for all form element widgets to build the necessary HTML code). An action object can be attached to a AFRadioButton component. (Refer to AFHardCodedASPAction and AFJScriptAcfion for details).

[0414] Radio buttons are used in groups. Because of the complexity of the client side script required in conjunction with the radio button component, the application developer must call the generateRadioButtonScript( ) method on the AFScriptgenerator object on the page wherever radio buttons are used. This method takes as inputs:

• • [0415] The name of the form object to which the radio button has been added.
  • [0416] The name of the radio button group within the form
  • [0417] The default value the radio button group may pass to the page view if nothing is selected by the user.
  • [0418] The return value from this method is the generated HTML and Javascript which is written to the client browser within the <HEAD></HEAD>tag of the page.
    Methods

[0419] The IAFRadioButton and LAFUIActionItem interfaces define the access to the AFRadioButton component. These interfaces support the following methods, which the developer uses to create a Radio Button form element.

[0420]

Method	Description
Int left()	Align the radio button left
Int right()	Align the radio button right
Int center()	Align the radio button to the center
Int caption	Set the caption to appear next to the radio button
(String)
Int name	Set the HTML name of the radio button
(String)
Int deselect()	Deselect the radio button.
Int select()	Select the radio button. (highlights button)
Int	Sets the name of the form onto which the radio button is
setFormName	being added. This is a mandatory method in order for the
(String)	component to function correctly.
Int	Set the number within the group which this radio button
setGroup	is assigned
Number(int)
Int getGroup	Returns the group number of the Radio Button
Number()
Int addAction	Add an action to the radio button.
(action)

AFCheckBox

[0421] The AFCheckBox component can only be used in conjunction with a AFForm component (the form's generate method iterates through the generate method for all form element widgets to build the necessary HTML code). An action object can be attached to a AFCheckBox component. (Refer to AFHardCodedASPAction and AFJScriptAction for details).

Methods

[0422] The IAFCheckBox and IAFUIActionItem interfaces define the access to the AFCheckBox component. These interfaces support the following methods, which the developer uses to create a Check Box form element.

[0423]

Method	Description
Int left()	Align the checkbox to the left
Int right()	Align the checkbox to the right
Int center()	Align the checkbox to the center
Int caption(String)	Sets the HTML caption value of the object. The
	text may be displayed next to the checkbox
	object.
Int name(String)	Sets the HTML name of the checkbox
Int select()	Mark as checked the checkbox when generating it
Int deselect()	Mark as not checked the checkbox when
	generating it.
Int value(String)	Sets the HTML value of the checkbox
Int addAction(action)	Add an action to the checkbox.

AFDropDown

[0424] The AFDropDown component can only be used in conjunction with a AFForm component (the form's generate method iterates through the generate method for all form element widgets to build the necessary HTML code). An action object can be attached to a AFDropDown component. (Refer to AFHardCodedASPAction and AFJScriptAction for details).

Methods

[0425] The IAFDropDown and IAFUIActionltem interfaces define the access to the AFDropDown component. These interfaces support the following methods, which the developer uses to create a Combo Box form element.

[0426]

Method	Description
Int left()	Align the Combo Box to the left
Int right()	Align the Combo Box to the right
Int center()	Align the Combo Box to the center
Int caption(String)	Set the HTML caption of the object.
Int name(String)	Set the HTML attribute of the object.
Int addData(String)	Add a row of data to the Combo Box.
Int	Set the name of the form onto which the Combo
formName(String)	Box component has been added.
Int selected(int)	Set the index of the data item on the Combo Box,
	which may be selected.
Int	Add an action to the Combo Box.
addAction(action)
Int	Populate dropdown box with a Codes Table value
setCodesTable(String)

AFBlankItem

[0427] The AFBlankItem component can only be used in conjunction with a AFForm component (the form's generate method iterates through the generate method for all form element widgets to build the necessary HTML code).

Methods

[0428] The IAFBlankItem interface defines the access to the AFBlankItem component. This interface supports the following methods, which the developer uses to create a blank item form element.

[0429]

Method	Description
int left()	Align the blank item to the left
int right()	Align the blank item to the right
int center()	Align the blank item to the center
int setWidth	Set the widths of the blank item in percentage (%)
(int, int)
int setValues	Set the values of the blank item. The first String sets the
(String, String)	text to appear in the first cell and the second String sets
	the text to appear in the second.
int setColors	Sets the color of the elements of the blank item. The
(int, int)	two integer values represent the color of the first and
	second cells. Valid Values are 0 and 1. The default
	color is white. Passing a value of 1 into either parameter
	causes the blank item cell to be displayed in the default
	highlighted color.

AFUIList

[0430] The AFUIList component creates a sophisticated DHTML based single-select list box form widget. The list box widget consists of a fixed headings row and a scrollable set of data rows. The list box widget supports data entry through data row level associated check boxes and text boxes. In addition, action objects can be attached to the list box and are generated in the same way as described for other form components. (Refer to AFHardCodedASPAction and AFJScriptAction for details).

[0431] The list box widget refreshes itself by passing (as parameters) the selected item and the state of all check boxes and all text boxes. The AFUIList view captures the values and updates the state of the list box to reflect the user choice.

Note:

[0432] The sophisticated functionality provided by this widget requires DHTML support. As of this portion of the present descriptions release date (Phase 2), only Internet Explorer 4.0 provides the necessary DHTML services. Therefore, this component is not cross-browser compatible.

Methods

[0433] The IAFUIList interface defines the access to the AFUIList component. This interface supports the following methods, which the developer uses to create a single select list box.

[0434]

Method	Description
Int left()	Align the list box to the left
Int right()	Align the list box to the right
Int center()	Align the list box to the center
Int setChecked()	Set indicated Selected List row as “checked”
Int setUnChecked()	Set indicated Selected List row as “unchecked”
Int setSelected()	Set indicated Selected List row as “highlighted”
Int getSelectedRow()	Return the currently selected list box row
	number.
Int getSelectedRowObj	Return the object id of the currently selected list
ID()	box row.
String getObjIdFor	Capture the Object id for a given list box row
Row()	(used by the view mechanism).
int	Retrieve the list box row number, which
getRowForImage	corresponds to an image reference.
Reference()
Int getCheckbox	Get Check Box status of requested list box row.
Status()
Int setTextBoxValue()	Set text box value for requested list box row
	with passed in String value.
String getTextBox	Get text box value for requested list box row.
Value()
Int setName()	Set list box name.
Int getName()	Get list box name.
Int getNumberOf	Get the total number of list box rows.
Rows()
Int addDataRow	Add a row to the list box.
Tokenized()
Int addDataRow()	Add a row to the list box.
Int setBorderWidth()	Set border width.
Int setValues	Set the default values of the list box:
Tokenized()	BorderWidth, cellPadding, Click Trigger Flag
	and Double Click Trigger Flag.
Int setValues()	Set the default values of the list box:
	BorderWidth, cellPadding, Click Trigger Flag
	and Double Click Trigger Flag.
Int reset()	Clear all list box data rows.
String generate()	Generate the DHTML for the list box data rows
	(bottom frame).
String	Return the results of the single click action,
generateSingleClick	which was attached to the list box. If no action is
Action()	attached, return a blank string.
String	Return the results of the double click action,
generateDoubleClick	which was attached to the list box. If no action is
Action()	attached, return a blank string.
String generate	Generate the scripts required to handle the
Scripts()	selected list. This method is executed on the
	parent frame that the list box is embedded.
Int addClickAction()	Add a click action to the list box.
Int addDoubleClick	Add a double click action to the list box.
Action()

AFThumbNailContainer

[0435] The AFThumbNailContainer component generates a set of thumbnail images. The thumbnails are used as iconic pushbuttons. The application developer defines the single click and double click action destinations in the ASP page by coding the JavaScript functions referenced by the AFThumbNailContainer “generate” method.

Methods

[0436] The IAFThumbNailContainer interface defines the access to the AFIThumbNailContainer component. This interface supports the following methods, which the developer uses to create a Thumbnail container.

[0437]

Method	Description
Int setSelected( )	Set indicated Thumbnail item
	as “highlighted”
String getSelectedThumbNailObjectId( )	Return the selected item
	object id. If no item is selected,
	return an empty string.
String generate( )	Generate the HTML code for
	the thumbnails.
Int addItem ( )	Add thumbnail image to
	container.
Int setAttributes ( )	Define the border width, the
	input path to the thumbnail
	images and identify the selected
	item.

AFStaticTable

[0438] The static table component creates a standard HTML table with the parameters set by the developer through scripting logic added to application's ASP.

Methods

[0439] The IAFStaticTable interface defines the access to the AFStaticTable component. This interface supports the following methods, which the developer uses to create a static HTML table.

[0440]

Method	Description
int addDataElement (String, int)	Adds a data element to the static table.
	The integer value passed as the
	second parameter specifies the
	color to be applied to this cell
	of the table.
	0 indicates that it should be white,
	1 indicates the default highlighted color,
	2 indicates the default AF Blue color,
	3 indicates a gray color.
Int SetRowLength(int)	Set the number of data elements before
	an end of row is generated.
Int GetRowLength( )	Returns the number of data elements in
	the table.
int setBorderWidth(int)	Set the width of the border, which may
	appear around the table. Valid values
	are 0 through 10. Default is 0.
Int getBorderWidth()	Returns the current border setting for
	the static table.
Int SetCellPadding (int)	Sets the HTML cell padding value that
	may be applied to the form. This creates
	space around the data in the table. Valid
	values are 0 through 100. Default is 0.
Int getCellPadding()	Get the current cell padding value for
	the static table.
Int SetTableName(String)	Sets the HTML name attribute on the
	table object.
String GetTableName()	Returns the HTML name attribute on
	the table object.
String Generate ()	Returns the generated HTML for the
	static table.
SetFontOffSet (int)	Sets the size of the font to be used on
	the static table. Valid values are −5
	through +5. Default is 0.

AFHardCodedASPAction

[0441] The AFHardCodedASPAction component adds a user defined automatic navigation action to a UI component. The UI components that support this service include AFPushButton, AFTextBox, AFTextArea, AFRadioButton, AFCheckBox, AFDropDown and AFSelectedList. Attaching the navigation action to a UI item may automatically direct the user to the next page. The next page is identified by the flow control service of the session framework. This means that the developer does not have to specify the page to open. This service also ensures that all changes made to the open pages are capture before opening a new one. The navigation action is triggered when the user causes a defined event on the object. Defined events include clicking on a link or button and changing the text or exiting a text box. The Javascript events are on Click and OnChange.

[0442] The page that represents the target of the action must be entered into the database. The action logic may look to see which activity it belongs to and then look in the database to determine what page to show to the user. An example database entry in the T_AF_FWDestinationforaction table is:

[0443]

T_AF_FWDestinationforaction
ID	CurrentPage	Action	Activity	Destination Page
100	//ASP/SampApp/Samp.asp	Next	Order	//ASP/SampApp/SampNext.asp

• • [0444] The id field must be a unique number,
  • [0445] The current page is the page on which the action is being triggered.
  • [0446] The Action is the name of the UI item which is triggering the action,
  • [0447] The Activity is the activity in which the action is taking place.
  • [0448] The Destination Page is the page to which the user should be redirected as the outcome of the action.
    Methods

[0449] The IAFAction and IAFHardCodedASPAction interface defines the access to the AFHardCodedASPAction component. These interfaces support the following methods, which the developer uses to create a navigational action.

[0450]

Method	Description
Int CreateSameFrame( )	The target of the action may be on
	the same frame as that from which
	the action is triggered.
Int CreateOnNewWindow(String)	The target of the action may be on a
	new instance of the web browser.
Int CreateParentFrame(String)	The target of the action may be on
	the parent frame of the frame,
	which triggered the action.
Int generate(String)	Create HTML to call Javascript
	function (“String value”)
	when the action is triggered.
InitializeLocation( )	Used to track frame location
	during action.

AFJScriptAction

[0451] The AFJscriptAction component adds a user defined action to a UI Component. The UI components that support this service include AFPushButton, AFTextBox, AFTextArea, AFRadioButton, AFCheckcBox, AFDropDown and AFSelectedList. Attaching a Javascript action to a UI item may call a Javascript function when the action is triggered. Note: The application developer creates the called Javascript function on the correct application's ASP. The Javascript action is triggered when the user causes a defined event on the object. Defined events include clicking on a link or button and changing the text or exiting a text box. The Javascript events are onClick and onChange.

Methods

[0452] The IAFAction interface defines the access to the AFJscriptAction component. This interface supports the following methods, which the developer uses to create an action.

[0453]

Method	Description
Int generate(String)	Create HTML to call Javascript function
	(“String value”) when the action is triggered.
Int JScript(String)	Create HTML to call Javascript function
	(“String value”) when the action is triggered.

AFScriptGenerator

[0454] The AFScriptGenerator component creates the Javascript functions needed by the actions.

Methods

[0455] The IAFScriptGenerator interface defines the access to the AFScriptGenerator component. This interface supports the following methods, which the developer uses to generate the appropriate Javascript functions.

[0456]

Method	Description
Int generate(eventcollection)	Generate the Javascript function block.
Int generateSelectedListScript	Generate the Javascript function block
(listener, eventcollection)	for a selected list box.
Int generateAutoSave	Generate the Javascript function block
(eventcollection)	for autosave.
Int generateRadioButtonScript	Generate the Javascript function block
(listener, listener, listener)	for radio button group.
Int generateAutoCapture	Generate the Javascript function block
(eventcollection)	for auto capture.

[0457] AFStyleSheet

[0458] The AFStyleSheet Component creates the Cascading Style Sheet text for the application.

Methods

[0459] The IAFStyleSheet interface defines the access to the AFStyleSheet component. This interface supports the following method, which the developer uses to generate the appropriate Cascading Style Sheet text.

[0460]

Method	Description
String getStyleSheet( )	Generate the Cascading Style Sheet text.

[0461] FIG. 21 illustrates a method 2100 for software configuration management. First, in operation 2102, software configuration management units are identified. In operation 2104, software configuration management repositories and practices are established for storing work product related to the software configuration management units. A change control process is determined in operation 2106 for implementing change requests relating to the work product. Access to the work product is monitored in operation 2108 by a plurality of users and audits are performed to indicate whether the access to the work product by the users is authorized. Further, training requirements are calculated in operation 2110 by identifying a skill set required for the implementation of the change requests and determining a current skill set.

[0462] As an option, the software configuration management units may be identified based on configuration types, project baselines, and/or naming standards. The software configuration management units may also have characteristics including a name, a modification log, and a release affiliation. Further, the software configuration management practices may include backing up the repositories.

[0463] The change control process may include identifying users authorized to implement the change requests, defining criteria for implementing the change requests, allowing evaluation of the change requests by the users based on the criteria, and monitoring the implementation of the change request. The present invention may also optionally include the creation of a training schedule to fulfill the training requirements. The following material provides a more detailed description of the above-described method.

[0464] The ReTA Development Architecture Design includes a set of sub-components that represent all design aspects of the development architecture. The Development Architecture Design Deliverable is used to validate design of the development architecture against the requirements. After it is validated, it may be used as a basis for build and test of the architecture.

[0465] Development Architecture Component Design

Purpose

[0466] The ReTA Development Architecture Component Design is based on the IDEA framework 2130. See FIG. 21.1. IDEA provides a development environment framework and associated guidelines that reduce the effort and costs involved with designing, implementing, and maintaining an integrated development environment.

[0467] IDEA takes a holistic approach to the development environment by addressing all three Business Integration components: organization, processes, and tools. In order to accomplish this, several subcomponents 2132 are provided around a central system building 2134.

[0468] The purpose of the development environment is to support the tasks involved in the analysis, design, construction, and maintenance of business systems, as well as the associated management processes. It is important to note that the environment should adequately support all the development tasks, not just the code/compile/test/debug cycle.

Configuration Management

[0469] The purpose of Software Configuration Management (SCM) 2106 is to establish and maintain the integrity of the components of an application throughout the project's life cycle.

[0470] This includes:

• • [0471] Comprehensively assessing and evaluating changes to a system after requirements have been agreed upon and commitments established.
  • [0472] Ensuring that approved changes are communicated, updated, verified and implemented properly.
  • [0473] Coordinate the project's day-to-day activities and avoid conflicting actions by controlling access to code and repositories.

[0474] The project manager is responsible for the completion of the Project Configuration Management Plan during Design—with the help of the project team. This may:

• • [0475] Clarify roles/responsibilities for migrations so that they are understood early in the project lifecycle. See FIG. 22, which illustrates the Configuration Management Life Cycle. First, a project study 2200 is created. Development and testing stages 2202,2204 follow the study. Finally, the implementation stage is reached 2206.
  • [0476] Increase visibility of non-application components (e.g. database, architecture) in Configuration Management to improve quality of delivered products. Many times these are the components that are missed during implementations.

[0477] The ReTA SCM Policy portion of the description can assist engagement executives in creating a project configuration management plan.

[0478] The following table provides a list of the active participants within the change control process. A person may have more than one role or responsibility depending on the size of the technical effort. Also note that the responsibilities are described here at a high level and are not intended to be all-inclusive. Most of the roles are would already exist on an engagement. However, there is one new role that is critical to the CM process, the Source Code Librarian.

[0479]

Title	Description & Responsibilities
Technical Manager	Typically an IS department head with responsibility for the purchase
	and/or support of hardware and software. In configuration
	management, this role is more software oriented. Other
	responsibilities include:
	Assign development and support staff to projects.
	Review (accept/reject) technical approach proposed for projects.
	Monitor development and support budgets and personnel - status of projects.
Network System Administrator	This individual is responsible for the installation, maintenance and
	support of the Unix and Windows NT servers including operating
	system, file systems, and applications. Other responsibilities include:
	Operating system installation, patch updates, migrations and
	compatibility with other applications.
	Installation and support of proper backup/restore systems.
	Installation and support of other peripherals required for installed
	(or to be installed) applications.
	Proper portion of the present description of hardware configuration and setup.
	Maintenance of Windows Domain users and Groups as well as other security issues.
Database Administrator	The DBA is responsible for proper creation and maintenance of
	production and system test databases. The integrity of the database,
	as well as recovery using backup/restore and logging, are priorities
	for the DBA. Other responsibilities include:
	Assist developers in maintaining development databases by
	automating backup/recovery, applying changes to database schema, etc.
	Provide support for tuning, sizing and locating database objects
	within allocated database space.
	Applying change requests to databases.
	Ideally maintain entity relationship diagrams for databases.
	Maintenance of database users and other database-related security issues
Source Code Librarian	Individual responsible for development and maintenance of source code control
	tools, training materials, and storage areas. The Source Code Librarian
	is also responsible for the integrity of the source code environment.
	Additionally:
	Establishes source code directories for new projects.
	Provides reports on source code environment status and usage per project.
	Provides assistance/information as needed regarding objects to check
	out for system test.
	Assists production operations in building/moving all applications into production.
Business Analyst	Individual or individuals responsible for managing the detailed
	design, programming, and unit testing of application software.
	Other responsibilities include:
	Developing/reviewing detailed designs.
	Developing/reviewing unit test plans, data, scripts, and output.
	Managing application developers.
Application Developer	Individual or individuals responsible for making changes to source
	code defined by management. This person typically:
	Checks source code out of the source code environment.
	Modifies code per user requirements or other development portion of
	the present description.
	Unit tests modifications in the development environment.
	Checks modified code back into source code environment in
	preparation for system test.
System Tester Integration Tester	This person or team is directly responsible for system testing or
	integration testing of an application prior to implementing in production.
	This may also take the form of performance testing.
	Typically, a system or integration test person or team may be responsible for:
	Following production operation procedures for installing a new
	application in the appropriate test environment.
	Develop and execute a test plan to properly exercise new application
	including new, modified, and unmodified functionality.
	Reporting results of test.
Vendor	For the purposes of this portion of the present description, a vendor is
	defined as an organization from which software has been purchased
	for use by the clients systems. Alternatively, a vendor may distribute
	final installable media in the form of tape or CD with upgrades or
	new release of application. A vendor may:
	Make modifications to application code at vendor offices or within
	the engagement development environment.
	Provide necessary information to Source Code Librarian to store new code.
	Assist Source Code Librarian in transferring modifications to the
	engagement system test environment.
	Participate in system test (or performance test).

Change Control
Description

[0480] Change requests as a consequence of changing requirements and changes requested due to nonconformity (or defects), either in the application software, or in the system software must be analyzed, authorized, scheduled, staffed, and tracked in a defined way. What, why, when, and who made a change must be tracked from the point of analysis to the reintroduction of the defective or changed component at the appropriate stage. Change control therefore governs what software component is changed, version controlled, and when it is re-migrated to a given development stage.

[0481] Configuration Management becomes more complex in a component-based development environment as the system is broken down to a greater level of granularity. For this reason, change control processes need to be clearly defined and communicated across the entire engagement team.

Tool Recommendation

ReTA Change Tracking Database

[0482] The Change Tracking Database is a Microsoft Access tool. It provides basic functionality of entering, modifying and reporting of system change requests encountered throughout the entire project life cycle.

Issues Tracking Database

[0483] The Issues Tracking Database is a Microsoft Access tool that is ideal for small to medium sized projects. It provides basic functionality of entering, modifying and reporting of project issues encountered throughout the entire project life cycle.

Procedures/Standards

[0484] FIG. 23 illustrates the change control ‘pipeline’ 2300 and each phase within the pipeline. The Change Control process can be divided into many different phases. They include:

Log Change Request

[0485] The first phase 2302 of the change control process is to log a change request. Regardless of who initiates a change request and how the change request enters into the engagement work-in-progress pipeline each change request should be logged Change Tracking tool. IT personnel who log change requests should record as much information as possible.

Change Control Committee Review

[0486] During the second phase 2304, the Change Control Committee (CCC) meets regularly to review the change requests that have been logged to the Change Tracking tool in the past week. The committee also discusses the status of the changes scheduled for migration during the weekly migration windows, reviews the changes already moved to production, and sets the Staging Date for change requests.

[0487] Before each weekly meeting, the Change Control Committee facilitator may generate the following reports:

• • [0488] Report of the change requests that have been logged to the Change Tracking tool in the past week
  • [0489] Implementation Report that list all changes scheduled to be implemented

[0490] During the meeting the CCC may:

• • [0491] Review the new change requests
  • [0492] Discuss the cross-functional impacts
  • [0493] Verify that the target implementation date is realistic
  • [0494] Set the Staging Date
  • [0495] Update the status of the change requests scheduled to be implemented that week during one of the change windows
  • [0496] Evaluate the quality metrics of the changes that have been migrated to production and discuss any lessons learned
    Statement of Work/Scope Definition Portion of the Present Description

[0497] During the third phase 2306, depending on the Change Category (Project, Enhancement, or Emergency), a Statement of Work or simple Scope Definition portion of the present description may or may not be required. These portions of the present descriptions both serve to define what the change request entails, and record what is agreed to by the change requester and IT.

[0498] The Statement of Work, which is currently in use sometimes in FIP, is a detailed portion of the present description that describes the work that may be done for the change request. The Scope Definition portion of the present description is a simple portion of the present description of the scope of the change. It can be an email message, a faxed letter, or a brief Microsoft Word portion of the present description. The following table shows what is required:

[0499]

		Scope Definition
		Portion of the
Change Category	Statement of Work	present description
Project	Required	Not Required
Enhancement	Not Required	Required
Emergency	Not Required	Not Required

[0500] Once the developer starts working on the Statement of Work or Scope Definition portion of the present description, the developer should set the status of the change request in the Change Tracking tool to “Assigned”.

[0501] The Statement of Work/Scope Definition portion of the present description is sent to the change requester for sign-off. The sign-off needs to be checked-off on the

[0502] Migration Checklist in the Change Tracking Tool in order to migrate the change to production. This sign-off serves as a quality checkpoint that the work on the change request may meet the business needs of the change requester.

Analysis & Design

[0503] This phase 2308 is required only for project change requests. For example, the developer may create technical analysis and design specifications portion of the present descriptions. Other impacted groups may create a technical impact statement.

Code & Unit Test

[0504] In this phase 2310, the developer codes the change request and unit tests the code changes to ensure that it works as designed and that it meets the business needs. The developer should set the status of the change request in the Change Tracking tool to “Development”.

[0505] After the change has been coded and unit tested, the developer should fill in the Resolution field for the change request within the Change Tracking Database. The developer should also fill in the approximate number of hours it took to complete the change request in the Actual Hours field.

System Test

[0506] This phase 2312 is required for all project change requests and some enhancements. In this phase, the developer tests the change to ensure that the system's functionality works as designed. Furthermore, this test also ensures that the code change did not adversely affect other areas of the current system. This may entail running some pre-defined System Test scripts. For certain change requests, it is important to test the code change against a large volume of data. This may check if the change may handle all the data in the production environment. For any change requests which may impact interfaces both in and out of the target application, it is necessary to test that all the interfaces still work correctly. This may prevent a change request from adversely impacting other systems.

[0507] The developer should set the status of the change request in the Change Tracking tool to “Testing”.

User Acceptance Test

[0508] In this phase 2314, the most appropriate person, whether it is the requester or a user who may be directly affected by the change, may assume the role of the test administrator. The administrator tests the change request to ensure that it meets the original business need. In some cases, the developer may actually run the test plans that the test administrator creates, and the test administrator may validate the test results. Once the test administrator agrees that the change satisfies all the test criteria, the developer needs to check the user acceptance test sign-off box in the Change Tracking Tool.

[0509] The sign-off is needed to migrate the change to production. This sign-off serves as a final quality checkpoint that the work on the change request meets the business needs of the change requester.

Fill out Migration Form

[0510] In this phase, the developer goes through a final process before submitting the change request to be moved to production. The developer should move all objects associated with the change request from the testing environment to the staging area.

[0511] In order to move the change to production, the developer needs to complete the Migration Checklist form on the Change Tracking Tool and inform Production Control 2316 by the Staging Date. This form contains all the information about the objects that need to be moved from the staging area into the production environment. This form is a streamlined checklist of all the things that the developers must do in order for Production Services personnel to move the objects to production. Whenever a sign-off checkbox is checked or unchecked, the current user's ID and the current date may be captured by the Change Tracking tool.

[0512] The following Migration Checklist items are required for the different change categories:

[0513]

Checklist Item	Project	Enhancement	Emergency
Statement of Work	Required	Not Required	Not Required
Scope Definition	Not Required	Required	Not Required
User Acceptance Test	Required	Required	Not Required
Tech/Code Review	Required	Required	Not Required
Complete Portion of	Required	Required	Not Required
the present description
Complete Components	Required	Required	Required
Submit Production	Required	Required	Required
Move
Distribution Lists	Required	Required	Not Required
Requirements
(TCPIP, Special
Forms, Microfiche,
Electronic Files)
Identify Impacted	Required	Required	Not Required
Systems
Capacity Planning	Required	Required	Not Required
Ready to Migrate	Required	Required	Required

[0514] The Ready to Migrate checkbox is used to summarize that all the required sign-offs have been obtained and that the code is ready to be migrated to production. Finally, the developer should set the status of the change request in the Change Tracking tool to “Migrate”.

Move to Production

[0515] Once Production Services personnel examines a completed Migration Checklist form, they may verify that all objects to be moved into production are in order, and that the change can be moved on the migration night in phase 2318. They may also ensure that all relevant items on the Migration Checklist have been completed. This check serves as the final quality checkpoint before the change goes into production.

[0516] Production Services personnel may move all project and enhancement change requests to the Production environment during prescheduled outages or immediately in the case of an emergency fix. Production Services may then informing all system users what changes have been moved into production.

[0517] Production Services personnel should set the status of each migrated change request in the Change Tracking tool to “Production”. They should also set the Actual Implementation Date to the date the change was moved to production.

Measure/Monitor Change in Production

[0518] Business users and developers should continue to actively monitor the change requests after it is migrated to production during phase 2320. If no problems develop in production due to the change request, the Change Control Committee may confirm that the team leader of the change request should set the status of the change request in the Change Tracking tool to “Closed”. If problems do develop in production, the status should be set to “Re-Open”. The developer is then re-assigned to fix the change request.

[0519] If the change request in production caused other problems to jobs in production, and a new fix is needed, the change request is reopened once again. If the change request caused problems in other jobs that requires modification to the other jobs, then a new change request is created, and the source of the new request is tracked back to the old request.

[0520] The Change Tracking tool contains metrics to track the quality of the change request. The Change Control Committee may assign the Migration Metric and Production Metric values for each change request approximately 35 days after it was migrated into production. If problems occur during the migration of the change request, the Change Control Committee may assign a “Fail” for the Migration Metric. The

[0521] Problem Description should then be completed to explain why this problem occurred. The Lessons Learned should be filled with what lessons can be learned from the experience. If no problems occur, the Migration Metric may be assigned a “Pass”.

[0522] If problems occur in production due to the change request, the Change Control Committee may assign a “Fail” for the Production Metric. The Problem Description and Lessons Learned fields should also be filled with the relevant information.

[0523] Below are the criteria for the Change Control Committee to use in deciding if a change request passed or failed the migration metric or the production metric. A change request may pass if it meets the following criteria.

Migration Metric Criteria

[0524] Flawless movement of all resources (Active Server Pages, MTS Components, Java Classes, Graphics, Data Model, etc.), from the staging environment to the production environment) is required. (I.e., resource movement must have no negative effects.) During implementation activities there must be no unplanned, adverse effect on regularly scheduled batch or online processing, online availability feeds to other systems and reports.

Production Metric Criteria

[0525] Production online processing and production batch processing must not experience any release-related abends.

[0526] The production implementation may not cause problems, interruptions in service or failures in other areas within 35 days of the initial implementation date. Any release with is backed out due to quality or problems may fail this criterion.

[0527] The change must be delivered when planned. A postponement due to external reasons may not cause the change to fail this criterion. Postponements due to quality or readiness of code must be communicated to the Change Control Committee, project team, and customers at least 3 days prior to the scheduled implementation date.

Migration Control

Description

[0528] Migration Control tools control multiple versions of source code, data, and other items as they are changed, tested, and moved from one development environment into another, for example, from development to test and from test to production. The list below provides a list of the various environments and their specific purpose within the project lifecycle.

[0529]

Environment	Description
Build/Component Test	This ‘virtual’ environment is configured to reside nearly entirely on
	an individual developer workstation. Web and application services
	are running locally for presentation and business logic.
	Architecture components are accessed via a mapped network drive.
	A shared RDBMS Server or a local, more lightweight version of the
	database can be used for database services.
	Different workstation configurations may exist for component or
	user interface developers. Both types of developers use a source
	code repository for check in/out of code during development.
	In the event that the required modifications affect both a user
	interface and server-side components, then both developers may
	share components and interfaces using drive mappings.
	As code changes are made a ‘Unit’ or Component test is performed
	to ensure that changes made in one area of the code do not have
	adverse affects on the rest of the component.
	When the build code is deemed fit for promotion, the source code is
	checked into the source code repository and the source code
	administrator is notified of the status.
Staging Test	This environment is used to verify and test packaged systems and
	components. This allows developers to verify the functionality and
	use of third party vendor applications during the Build/Unit Testing phase.
Assembly Test	This environment is a smaller testing environment used to ensure
	that end-to-end functionality of the system and to verify that
	changes made during any build efforts do not impact other areas of
	the system. A single developer lead (typically the Source Code Administrator)
	gets the latest version of the source code from the source code repository,
	performs a complete build, and executes a complete regression test of the system.
	When a point when the code is deemed stable and the system test environment is ready,
	the code residing on the integration server is checked back into the
	source code repository using a version label.
	Additionally, the binaries from the integration server are copied to
	the system test server for continued testing.
System Test	This environment, sometimes referred to as Product Test, is used
	for complete system technical and functional testing. Typically
	there are assigned project team members tasked with writing and
	executing system test scripts, logging errors as they are encountered
	and ensuring that the delivered application satisfies the functional
	requirements set by the client.
	From this point, system application and architecture binaries are
	promoted to the production environment.
Performance Test	This environment is used for conducting performance evaluations
	of the application and supporting architecture components. This
	environment should be configured to simulate the production
	system as closely as possible. Additionally, data and transactional
	volume should be configured to simulate the system under worst-case scenarios.
	Performance testing tools should be utilized to simulate multiple
	users as well as monitor and report performance results.
Production	This environment consists of key hardware and software
	components to support the business operational systems.
	Typically, only applications and components that have been thoroughly tested
	for functional and technical accuracy are moved into this environment.

[0530] With a ReTA/Microsoft-centric environment, a few key issues arise with respect to environment migration. These issues relate to the fact that the application is based on the use of Active Server Pages, Microsoft Transaction Server components and Java Classes.

Sequence of Events

[0531] To perform the code migration, certain steps should be followed to ensure that users that are currently in the application are not adversely affected. This can be accomplished by performing the migration in the following order:

[0532] Using the Internet Information Server administration utility, monitor the site's number of active users. A count of zero indicates that no clients are currently hitting the site. Shut down the web listener to prevent additional users from connecting to the site.

[0533] Within the MTS Administration tool, shut down all server processes. This cleans up an components that may still be awaiting garbage collection from the Java Virtual Machine.

[0534] If the component interfaces have not been modified, it is possible to copy the new version of the Java Classes directly to the new environment. If the interfaces have been changed, the MTS administrator may need to delete and recreate the individual components within MTS.

[0535] Copy any new web server files (ASP, HTML, graphics, etc.) to the target directories on the web server.

[0536] Restart the web listener to allow users access to the application.

Module Location

[0537] There are basically three types of modules that get migrated during a ReTA engagement. Web Server files, Application files and database objects.

[0538] Web Server modules include Active Server Pages (ASP), static HTML portion of the present descriptions, graphics or images and JavaScript files. The ASP and HTML portion of the present descriptions may have security restrictions placed on them from within Microsoft Internet Information Server (IIS) and from the Windows NT Server. Security can be set to include individual user accounts, groups/roles, or no security.

[0539] Application Server—Two file types are migrated within application servers, COM Dynamic Link Library's and Java Classes. Both files are created during the application and architecture build processes. The COM DLL's require registration within MTS by inserting them into a MTS Package. In the event that the Web and Application servers are two physically different machines, an export process is required between them to instruct the Web server where the business components physically reside. For more information on the registration and exporting processes refer to the MTS online help.

[0540] In the case of the Java Classes, they need to reside in a directory that is defined within the server's ‘CLASSPATH’ environment variable. For ReTA Phase 1 & 2 development and testing all runtime files were located with C:\ ReTA. Therefore the following classpath environment variable was defined on each developer's workstation:

CLASSPATH=C:WinNTJavaClasses;C:\ WinNTlavaTrustLib;C:\ ReTAArchitecture;C:ReTA\ Application

[0541] Database Server—These items include tables, views, sequences, triggers, stored procedures and functions, and user/schema information. These items are not necessarily particular to multi-tiered development. However, care should be taken to ensure that architecture tables and other objects are located separately from the application objects.

Security

[0542] Within the ReTA application model, security is enforced at the Web and Application Servers. In the case of Web server security, access to ASP and HTML files can be restricted using the Access Control List security provided by Windows NT. Security on these objects can be set at the group (role) or individual user levels.

[0543] A component within MTS utilizes role-based security to determine who may or may not have access to a specific COM component. A role is a symbolic name that defines a group of users for a package of components. Roles extend Windows NT security to allow a developer to build secured components in a distributed application.

[0544] For example, FIG. 24 depicts the application of Roles 2400 within the Microsoft Transaction Server Management console 2402. The package labeled ‘ReTA Applications’ 2404 has a single role defined as being able to access it, ‘ReTA User’ 2406. Users that are members of the local ‘ReTA Administrators’ and ‘ReTA User’ Windows NT groups 2408,2410 are allowed to function in the ReTA User capacity defined for this package.

[0545] Due to the security options available at both the Web and Application server levels, care should be taken during code migration to ensure that security settings are consistent and applied correctly to ensure accurate execution.

MTS Transactions

[0546] Within MTS, every component has a transaction attribute that can be set by the MTS administrator to indicate what level of participation a component has within a transaction. Care must be taken during MTS component migrations to ensure that the correct transactional attributes are set within MTS.

[0547] The transaction attribute can have one of the following values:

• • [0548] Requires a transaction. This value indicates that the component's objects must execute within the scope of a transaction. When a new object is created, its object context inherits the transaction from the context of the client. If the client does not have a transaction, MTS automatically creates a new transaction for the object.

[0549] Requires a new transaction. This value indicates that the component's objects must execute within their own transactions. When a new object is created, MTS automatically creates a new transaction for the object, regardless of whether its client has a transaction.

[0550] Supports transactions. This value indicates that the component's objects can execute within the scope of their client's transactions. When a new object is created, its object context inherits the transaction from the context of the client. If the client does not have a transaction, the new context is also created without one.

• • [0551] Does not support transactions. This value indicates that the component's objects do not run within the scope of transactions. When a new object is created, its object context is created without a transaction, regardless of whether the client has a transaction.
    Tool Recommendation

[0552] Many configuration management tools are available on the market today, some of which provide many features useful for code promotion and management.

[0553] During the ReTA Phase 1 engagement, Microsoft Visual SourceSafe was utilized for it's labeling and source code management capabilities. Additionally, the ReTA Change Tracker database could be utilized for source code migrations that required change management knowledge and approval. In the event that client requires the use of paper or email based migration control, the ReTA Migration Request template can be used.

Procedures/Standards

Processes

[0554] The processes that guide development within ReTA engagement environments are represented in FIG. 25, which illustrates an environment migration process 2500. These processes include creating a new application 2502, modifying an existing application, and applying emergency bug fixes 2504. The solid lines represent stages required for new/modified application process. Dashed lines show the path for emergency bug fixes. Note: The term application used here is broadly applied to any managed module or component.

[0555] Processes are defined by stages shown as individual boxes. Through these stages, applications are eventually (or quickly in the case of emergency bug fixes) promoted to production. Stages provide for initiating, managing, securing and coordinating changes to applications.

[0556] The stages for the projects were developed in conjunction with representatives from each development team. It is important to note that the development stages represent the lifecycle of an application, not data. Within each development stage, there can be multiple data sets. For example, within the system test stage, an application team might wish to run several test cycles in parallel. In order to do that and keep the data consistent, a database for each cycle is required.

[0557] The CM process may ensure application modules are promoted through the development stages in a consistent manner. It is up to each application team to decide how to use each stage. For example, the application testing team may want four databases within the system test stage for different types of tests, whereas the assembly testing team may only want two.

• • [0558] Stage is used to consolidate and verify vendor changes. Depending on the change, it may be migrated to Development or System Test 2506,2508 directly. The order may be dictated by project requirements.

[0559] A very important tenet of the CM process is that an application modification can only be in one stage at any point in time. Consider the example of modulel. Modulel starts out in development. When the development team indicates, the Source Code Librarian moves modulel into system test. As soon as that happens, no changes can be made to modulel. Only after modulel is promoted to production 2510 can modifications be made to the module (further enhancements, bug fixes, etc.). The purpose for this rule is to prevent the situation where one developer is modifying a module when that module needs to have a bug fix to continue testing. There is one exception to this rule, emergency fixes.

[0560] When the situation dictates an emergency fix, the module affected needs to be modified immediately. When this happens, the module in question should be fixed within the development stage. When the fix is made, the module may immediately be put back into production. However, the same change also needs to be applied/promoted to the module in system test stage. This may allow modules in system test to always be current with what is in production.

[0561] The CM process depends on change control records (CCR) for tracking changes to the system. A change control record is created for every new module or modification. The CCR is used to coordinate migrations and communicate status for each module in the system. One may see the use of the CCR throughout every process description. The CCR processing system may be automated through Notes.

[0562] Major tasks and responsibilities define each stage of a process and are covered in the pages that follow. These tasks and responsibilities are not intended to be a development methodology. Any references to deliverables and/or portion of the present descriptions is informational only and provided to help anchor an already existing development methodology. However, specific deliverables and portion of the present descriptions required for the change management process are required and may be highlighted.

Development/Unit Test

[0563] Development team checks required application source code out of source code control. See FIG. 26, which illustrates a Development/Unit test 2600 for existing applications. Note: In the event that this is a new application, the developer may use the appropriate template from source code control.

[0564] As needed, DBA 2602 checks required database source code out of source code control. Also as needed, DBA works with development team to approve and prepare modifications to development database. All work occurs on developer's workstation using local web and application server processes. Note: A shared web/application may be used for vendor staging.

[0565] Unit testing is ongoing during development. The development team checks modified application source code into source code control. The development team also fills in a change control record indicating which modules have changed. As needed, the DBA checks modified database source code into source code control. A source Code Librarian 2604 verifies/prepares necessary objects for building new applications. Unit test and development is completed. In some cases, a string test may be required. The system test team is notified, such as by e-mail.

[0566] Deliverables from this stage might include:

• • [0567] Modified or new application
  • [0568] Modified or new database objects
  • [0569] Unit test data and output

[0570] CM Deliverables from this stage include:

• • [0571] A change control record with developer information filled in.
    Assembly Test

[0572] With reference to FIG. 27, an assembly test team 2700 reviews user requirements and prepares validation or test plan. Database modifications are fetched from source code control and applied to an assembly test environment 2702. The Source Code Librarian fetches new application, builds it and copies it into assembly test environment 2704. Validation or test plan is executed pass/fail/deviation. The assembly test team signs change control portion of the present description.

[0573] Deliverables from this stage might include:

• • [0574] Completed validation or test plan with pass/fail/deviation information.

[0575] CM Deliverables from this stage include:

• • [0576] A change control record with assembly test information.
    System Test

[0577] System test team reviews user requirements and prepares validation or test plan. See FIG. 28, which illustrates a system test 2800 for existing systems. Database modifications are fetched from source code control 2802 and applied to the system test environment 2804. The Source Code Librarian fetches the new application, builds it and copies it into the system test environment. A validation or test plan is executed pass/fail/deviation. The system test team 2806 signs the change control portion of the present description.

[0578] Deliverables from this stage might include:

• • [0579] Completed validation or test plan with pass/fail/deviation information.

[0580] CM Deliverables from this stage include:

• • [0581] A change control record with system test information.
    Production

[0582] FIG. 29 is a flowchart for production of existing applications. The change control record is forwarded to the production operations team 2900 responsible for scheduling changes to production. A promotion to production is scheduled on the production plan 2902. Database modifications are fetched from source code control 2904 and applied to the production environment 2906.

[0583] The Source Code Librarian fetches the new application, builds it and copies it into the production environment. The controlled change-tracking portion of the present description is signed and filed. Electronic copies of all portion of the present descriptions and portion of the present description can optionally be stored in source code control or other portion of the present description storage system.

[0584] Deliverables from this stage might include:

• • [0585] Application promoted to production.

[0586] CM Deliverables from this stage include:

• • [0587] A complete change control record with production information.
    Version Control
    Description

[0588] Version Control tools control access to source code as it is developed and tested and allow multiple versions to be created, maintained, or retrieved. For maintenance management purposes, it is desirable to designate one individual team member to function as the source control administrator. Duties for the source control manager would include the administration of source control users and projects, scheduling and performing periodic backups and applying labels to specific versions of the code (for migration purposes).

[0589] Examples of architecture and application source code maintained within the version control process include:

[0590]

Location	Types
Web Server	Static HTML, Images, JavaScript
	Active Server Pages (ASP)
	Cascading Style Sheets (DHTML)
	Architecture ASP Header Files
Application Server	Activities
	Sub-Activities
	Business Components
	(factories, supporting Business Objects)
	Architecture Frameworks
Database Server	Database specifics
	(table, rollback segment and temporary space
	information)
	Users, Roles
	Tables, Indexes, Triggers
	Procedures, Packages, Sequences

Tool Recommendation

[0591] Many configuration management tools are available on the market today, some of which provide test data management functionality.

[0592] During the ReTA Phase 1 engagement, two different tools where utilized and evaluated: MicroSoft's Visual SourceSafe™ and Intersolve's PVCS Version Manager™. Both applications are relatively simple use and administer. Visual SourceSafe is preferred for small to medium sized engagements and PVCS Version Manager is preferred for large, enterprise-scale development efforts. For a complete description of the configuration and usage of the Microsoft Visual SourceSafe application as it was utilized on the ReTA Phase 1 engagement, refer to Source Control.

Visual SourceSafe

[0593] Visual SourceSafe from Microsoft ships with the Visual Studio suite and as such is tightly integrated with the Visual Integrated Development Environments. See FIG. 30, which illustrates a frame 3000 of Visual Source Safe. Check in and check out functions 3002,3004 can be performed from with Visual Basic or Visual J++. Additionally, Rational Rose is also tightly integrated with SourceSafe.

[0594] Additionally, this product provides:

• • [0595] Easy to use drag-and-drop for file check in and check out
  • [0596] Historical reporting and impact analysis
  • [0597] User and project level security
  • [0598] Archive and restore functionality
  • [0599] Version ‘Labeling’ for source code migration
  • [0600] Support for web based applications
    PVCS Version Manager

[0601] PVCS Version Manager from INTERSOLV is the industry standard for organizing, managing and protecting your enterprise software assets. Version Manager enables teams of any size, in any location, to coordinate concurrent development, with secure access and a complete audit trail. See FIG. 31, which illustrates a frame 3100 of FU PVCS Version Manager I-Net Client.

[0602] PVCS VM Server extends the power of Version Manager to teams enterprise-wide via the Internet and Intranets. An intuitive Web client lets users connect to a secure archive and work interactively, anywhere in the world, while sharing protected, centrally managed software.

[0603] Additional features include:

• • [0604] I-NET client is simple and easy to use. It supports developers in many locations, working on many platforms
  • [0605] Organizes and references all project components graphically with a flexible, project-oriented approach
  • [0606] Use easy drag-and-drop to check files in and out of the system with the check in and check out buttons 3102,3104
  • [0607] Graphically view project history and see file differences in side-by-side comparisons
  • [0608] Branch and merge as needed, with automatic alerts of any conflicts
  • [0609] Automate development processes with event triggers
  • [0610] Set up projects quickly with online assistants for project configuration, security and customization
    Procedures/Standards
    Build & Integration

[0611] FIG. 32 is an illustration of a Build Source Control Model. During the Build phase of a ReTA engagement, the workstation 3200 of each individual developer should be configured to function independently of other workstations and servers 3202 (except for the development database 3204). This process may require developers to first get an updated version of the application source files in addition to those files be checked out for modifications.

[0612] The benefits of this configuration are:

• • [0613] Individual development changes do not effect other developers
  • [0614] Easier debugging and testing
  • [0615] Different project team members may check out different versions and/or components of the application concurrently. Changes can then be merged later.
    Assembly Test

[0616] FIG. 33 illustrates an Assembly Test phase control model. During the Assembly Test phase of a ReTA engagement, the Source Control Administrator may be responsible for the mass checkout and build of the entire application or architecture. Test workstations 3300 may access a web the app server 3302, which is connected to the source code repository 3304 and the database server 3306.

[0617] To aid in this process, the use of ‘Labels’ within the source code repository is employed to identify specific versions of files and projects. (See FIG. 34, which illustrates Microsoft Visual SourceSafe ‘Labels’ 3400). Labels allow for marking a specific set of files within the repository with a logical name and version. At a later point, it is possible to display the different labels and retrieve the desired version.

Environment Management

[0618] This portion of the description identifies the miscellaneous application and system-level services that do not deal with the human-computer interface, communication with other programs, or access to information. Environment Management Services identify each component used to perform the operating system services, system level services, application services, and run-time services.

Systems Management

[0619] In order to maintain an effective and secure infrastructure, System Management procedures are essential in the success of obtaining a stable environment. These systems require tools, utilities and processes that allow administrators to monitor running components and change their configuration. Systems Management involves all functions required for the day to day operation of the ReTA environment (e.g. event monitoring, failure control, monitoring, tape loading, etc.). Regardless of the changes taking place within the Net-Centric environment, Systems Management activities must take place in an on-going manner.

System Startup & Shutdown

[0620] A comprehensive development environment rapidly becomes sufficiently complex that the startup and shutdown of the environment must be managed carefully, and preferably automated. This is key to ensuring the integrity of the environment.

[0621] Startup may involve the carefully sequenced initialization of networking software, databases, web servers and more. Similarly, shutdown involves saving configuration changes as needed and gracefully taking down running software in the correct sequence.

[0622] An Uninterrupted Power Supply (UPS) provides a server with power when the AC power fails or is marginal. The UPS may also shut the server down, in an orderly fashion, in the event of a power failure. The UPS may not shut down the server if the power failure is brief.

[0623] The Smart UPS 1400 should be configured with an interface to the server. The recommended interface is the serial port B (COM2) on most servers. PowerChute Plus 5.0 software from American Power Conversion is the recommended choice.

[0624] The basic purpose of PowerChute Plus is to safely shut down an operating system and server in the event of a power failure. To do this properly, PowerChute Plus needs the UPS to provide battery power to the system while PowerChute shuts down the system. This is where the correct sequencing of Events becomes important.

[0625] Clear and accessible portion of the present description of startup/shutdown procedures

[0626] Automated startup/shutdown process that rarely requires manual intervention

[0627] A product that has remote power on reset capabilities

Backup and Restore

[0628] The incremental value of the daily work performed on the development project is high. This investment must be protected from problems arising from hardware and software failure, and from erroneous user actions and catastrophes such as fires or floods. The repositories and other development information must therefore be backed up regularly. Backup and restore procedures and tools must be tested to ensure that system components can be recovered as anticipated. The large volumes of complex data generally require automation of backups and restores.

[0629] The advent of Netcentric technologies has introduced an increase in media content that requires storage. The environment may support a high volume of media files, which must be considered in the backup/restore plans. Storage capacity planning should allow for the typically increased size of these file types.

[0630] As the amount of storage may grow significantly over time on a large project, the hardware requirements may increase. Sufficient room for growth should be planned when selecting the tools and hardware. Switching tools and hardware can be problematic due to lack of upward compatibility (DDS-DLT, various tools etc.).

[0631] The time required for backups must also be considered. Usually the number of hours without development per day decreases over time and if backups can only be performed when no user is logged in, this might become a problem. It is generally the case that the project may benefit from buying the fastest and largest backup hardware/software it can afford.

Storage Management

[0632] ReTA may implement an automated tape management system that provides location/retention special handling, file integrity and data protection.

Archiving

[0633] Archiving can be particularly useful to safeguard information from previous versions or releases. More generally, it is used to create a copy of information that is less time-critical than the current environment at a given time. Archiving may be performed to a medium, which is different from the backup medium, and may involve other tools, which, for example, provide a higher compression ratio.

Performance Monitoring

[0634] Performance Management ensures that the required resources are available at all times throughout the distributed system to meet the agreed upon SLAs. This includes monitoring and management of end-to-end performance based on utilization, capacity, and overall performance statistics. If necessary, Performance Management can adjust the production environment to either enhance performance or rectify degraded performance.

Operating System

[0635] Windows NT may function as the ReTA Phase 1 Development Environment operating system, handling Environment System Services such as multi-tasking, paging, memory allocation, etc.

System Level Services

[0636] The Windows NT Domain Controller allows users and applications to perform system-level environment services such as a login/logoff process for authentication to the operating system; enforced access control to system resources and executables; and access to the local or remote system's user or application profiles.

Application Services

[0637] The ReTA Phase 1 Frameworks may perform application Security Services, Error Handling/Logging Services, State Management Services and Help Services within the application.

State Management

[0638] State Management Services enable information to be passed or shared among windows and/or Web pages and/or across programs. In Netcentric environments, the HTTP protocol creates a potential need for implementing some form of Context Management Services (storing state information on the server). The HTTP protocol is a stateless protocol. Every connection is negotiated from scratch, not just at the page level but for every element on the page. The server does not maintain a session connection with the client nor save any information between client exchanges (i.e., web page submits or requests). Each HTTP exchange is a completely independent event. Therefore, information entered into one HTML form must be saved by the associated server application somewhere where it can be accessed by subsequent programs in a conversation Security Services ReTA implements Application Security through the ReTA Session and Activity frameworks. The Session framework provides “Session level Page access authorization”, “User identification” and “session timeout” services. The Activity framework provides “Activity level Page access authorization”.

Error Handling/Logging Services

[0639] Error Handling Services support the handling of fatal and non-fatal hardware and software errors for an application. An error handling architecture takes care of presenting the user with an understandable explanation of what has happened and coordinating with other services to ensure that transactions and data are restored to a i) consistent state.

[0640] Logging Services support the logging of informational, error, and warning messages.

[0641] Logging Services record application and user activities in enough detail to satisfy any audit trail requirements or to assist the systems support team in recreating the sequence of events that led to an error.

Runtime Services

[0642] The ReTA Phase 1 Development Environment may use the Microsoft Transaction Server and the Microsoft Java Virtual Machine as a Run-Time Environment System Service. This affords a layer of abstraction between the applications and the underlying operating system.

Problem Management

[0643] Problem Management tools help track each system investigation request—from detection and portion of the present description to resolution (for example, Problem Tracking, Impact Analysis, Statistical Analysis). Several problem management software packages are available from a variety of vendors.

Tool Recommendation

SIR Workbench

[0644] The SIR Workbench is another Microsoft Access tool that was developed for small to medium sized projects. It provides basic functionality of entering, modifying and reporting of architecture and application problems encountered during the testing and release phases of the project life cycle.

[0645] Visual SourceSafe Visual SourceSafe (VSS) from Microsoft ships with the Visual Studio suite and as such is tightly integrated with the Visual Integrated Development Environments.

[0646] One of the features provided by VSS is the ability to search through the source code for given text strings. This is useful for performing impact analysis.

Security Management

[0647] Security Management tools provide the components that make up the security layer of the final system, and may provide required security controls to the development environment. While some of these tools may be considered as nothing more than security-specific Packaged Components, many are an integral part of the development environment toolset.

Database

[0648] Development Database security may be minimal. Database User IDs may be setup to grant user-level security. The engagement Database Administrator (DBA) may have a logon to allow for full permissions. Otherwise, a Developer ID may allow read/write access and a Core User ID may allow for read access only.

Network

[0649] A Windows NT Group created specifically for the engagement may protect the Development shared file folder and subsequent sub-folders (ex ‘ReTAArch’). Project members individual network accounts may be added to the Domain Group ensuring access. Local network administrators may be responsible for the creation and maintenance of individual and group account information.

Application Server

[0650] The application server has two forms of security: Static security and dynamic (context dependent) security.

[0651] A Windows NT group may be created for each Role in the completed application (e.g. Customer, Manager). Microsoft Transaction Server's integrated Windows NT security allows the developer to determine the security rights for each component.

[0652] The dynamic, context dependent security is implemented by the developer using the Event Handler framework for the logging and display of errors to the user.

Web Server

[0653] The web server has static security for each page and security to maintain control of the flow between pages. The static security uses the Windows NT group for each user role to restrict access to each page. For the flow control, the developer uses the Session framework to restrict the ordering of page requests. The allowed ordering of pages are entered into the Session database tables.

Systems Building

[0654] System Building tools comprise the core of the development architecture and are used to design, build, and test the system.

Analysis & Design

[0655] The BI Methodology has several application development routes that apply to different development scenarios. Routes currently exist in the methodology for custom and packaged application development. Component development is among several routes to be developed. Until the component development route is completed, component-based projects should be planned using a combination of BI Methodology and ODM task packages.

[0656] In general, BI Methodology should be used for all tasks that are independent of a specific technology. For example, tasks related to business modeling, user interface design, training development, package selection, and product testing should all be taken from BI Methodology rather than ODM. These technology-independent tasks typically occur early (business modeling, solution strategy, and requirements gathering) and late (product testing through deployment) in the project.

[0657] ODM content should be used for all tasks that are related to component and object development. In addition, ODM is the primary source for those tasks related to obtaining characteristics associated with component- and object-based development (such as flexibility and reuse). When using ODM task packages, take care to ensure that one consider how they link with the other elements of business integration (such as human performance).

Data Modeling

Description

[0658] Data Modeling tools provide a graphical depiction of the logical data requirements for the system. These tools usually support diagramming entities, relationships, and attributes of the business being modeled on an Entity-Relationship Diagram (ERD). Several techniques have evolved to support different methodologies (e.g., Chen, Gane & Sarson, and IDEF).

[0659] As systems are often built on top of legacy databases, some data modeling tools allow generation of an object model from the legacy database data model (DDL). By understanding the E-R diagram represented by the database, it is easier to create an efficient persistence framework, which isolates business components from a direct access to relational databases. Caution is required, however, as the resulting model is at best only partial, as an object model has dynamic aspects to it as well as static relationships, and may not correctly reflect the analysis performed in the problem domain.

[0660] When a component or object-based approach is used, data modeling is not performed. Rather, the object model represents both the data and the behavior associated with an object. In most systems, relational databases are used and the object model must be mapped to the data model. Standard mechanisms for mapping objects exist.

Tool recommendation

Visual Studio

[0661] Microsoft's Visual Studio 6.0 includes a database diagram tool that helps developers visualize structures of tables and relationships within a relational database. See FIG. 35, which illustrates a Database Diagram 3500 within Visual Studio 3502.

[0662] Using this project within Visual Studio it is possible to, for example:

• • [0663] Connect to existing Oracle 7.33+ or SQL Server 6.5+databases.
  • [0664] View, print and modify existing database objects including table attributes and properties, views 3504, columns, indexes, relationships, procedures 3506 and functions 3508.
  • [0665] Create new database objects.
  • [0666] Generate SQL scripts for schema creation and update.
  • [0667] Version control schema information using Visual SourceSafe.
    Visual Studio

[0668] Additionally, Rational Software's Rational Rose 98 provides Oracle8 data modeling functionality including schema analysis, SQL/DDL generation, reporting and editing. For a complete description of the product and its features visit the Rational Rose Website at www.rational.com.

Performance Modeling/Management

Description

[0669] The performance of a system must be analyzed as early as possible in the development process. Performance modeling tools support the analysis of performance over the network. A simple spreadsheet may be suitable in some well-known and understood environments, but dedicated performance modeling tools should be considered on any project with high transaction volumes or complex distributed architectures involving several platforms.

[0670] In the case of Internet-based applications, as the Internet is not a controlled environment, performance modeling is limited to those components within the domain of the controlled environment (i.e. up to the Internet Service Provider). However, in the case of intranet-based systems, where the environment is controlled from end-to-end, performance modeling may be performed across the entire system.

[0671] Performance modeling for components involves the analysis of the projected level of interaction between components and the level of network traffic generated by this interaction. It is important for performance reasons that communication between components is minimized, especially if these components are distributed.

Tool recommendation

• [0672] Visual Quantify
• [0673] Tivoli
• [0674] Sniffer Basic
• [0675] Application Expert
  Object Modeling
  Description

[0676] An object model usually contains the following deliverables:

• [0677] Class Diagram (1 per functional area or 1 per component)
  Class Definition (1 per class)
• [0678] Class Interaction or Sequence Diagram (1 or more per scenario/workflow)
• [0679] Class State Transition Diagram (1 per Class with complex state)

[0680] Tools such as MS Word, MS PowerPoint, ABC Flowchart (MicroGrafix), may be used to produce these deliverables. See FIG. 36 illustrating Object Modeling 3600 within Rational Rose 3602. Specific modeling tools do exist, however, and provide advantages such as cross referencing (for example, are all the methods used in the Interaction diagrams described in the class definitions?), automatic propagation of changes to other diagrams, generation of reports, and generation of skeleton code. However, some tools have problems with:

• • [0681] Usability and stability
  • [0682] Single users or small numbers of concurrent users
  • [0683] Proprietary repositories (usually file-based, rather than DB-based)
  • [0684] Support of extensions/customizations

[0685] As well as providing the usual editing and graphical functionality, a good modeling tool should:

• • [0686] Interface with a repository (to support versioning)
  • [0687] Support multiple users
  • [0688] Generate code from the design

[0689] The industry standard to represent the object model is UML notation (adopted by OMG).

Tool recommendation

• [0690] Rational Rose 98
• [0691] Visio 5.0
• [0692] Visual Modeler 2.0 (Only valid for VB and VC++)
  Component Modeling
  Description

[0693] Component modeling can mean either designing components from scratch, or customizing and integrating packaged software. No specific component modeling tools exist, and current object modeling tools only provide limited support for components (e.g. for packaging related classes together). Class packages can be used to separate the object models for different components, with a separate class package(s) for the component model. This approach, however, is not enforced by current modeling tools, and requires project naming and structuring standards.

[0694] When component modeling is being performed using existing packaged software, some form of reverse engineering or importing is required from the modeling tool to capture the existing design.

[0695] During component design, the partitioned component model is designed, which defines physical interfaces and locations for components. It is important for performance reasons that communication between components is minimized, especially if they are distributed.

Tool Recommendation

• [0696] Rational Rose 98
• [0697] Visio 5.0
• [0698] Visual Modeler 2.0 (Only valid for VB and VC++)
  Application Logic Design
  Description

[0699] Application Logic Design tools graphically depicts an application. These tools include application structure, module descriptions, and distribution of functions across client/server-nodes.

[0700] A variety of tools and techniques can be used for Application Logic Design. Examples are structure charts, procedure diagrams (module action diagrams), and graphics packages to illustrate distribution of functions across client and server.

[0701] Application Logic Design functionality is also provided by a number of Integrated Development Environments (IDE).

[0702] With component-based development, Application Logic Design is performed through object and component modeling. The functionality is captured in use cases, scenarios, work flows and/or operations diagrams along with interaction diagrams/sequence diagrams. These are usually produced using MS Word, MS PowerPoint, ABC Flowcharter (Micrografix), or an object modeling tool.

Tool recommendation

• [0703] Rational Rose 98
• [0704] Visio 5.0
  Database Design
  Description

[0705] Database design tools provide a graphical depiction of the database design for the system. They enable the developer to illustrate the tables, file structures, etc. that may be physically implemented from the logical data requirements. The tools also represent data elements, indexing, and foreign keys.

[0706] Many data design tools integrate data modeling, database design, and database construction. An integrated tool may typically generate the first-cut database design from the data model, and may generate the database definition from the database design.

[0707] With an object-based or component-based solution, the data-modeling task changes.

[0708] In most cases, relational databases are still used, even where there are no dependencies on legacy systems. As there is an ‘impedance mis-match’ between an object model and a data model, a mapping activity must be undertaken. There are standard mechanisms for doing this. There are also tools on the market which allow the mapping of classes to relational tables, and which generate any necessary code to perform the database operations.

[0709] There is a tendency (especially when dealing with legacy systems) to treat data models and object models the same. It is important to recognize that at best, the data model represents only the static part of the object model and does not contain any of the transient or dynamic aspects. The physical data model may also change significantly (for DB optimization), further confusing the issue.

[0710] There can be performance problems with objects mapped to a relational database. In a worst case scenario, an object can be spread across many tables, with a single select/insert for each table, and as each object is loaded one by one, the performance becomes very poor. Some tools provide lazy initialization (only loading the parts as they are needed) and caching (minimizing DB hits).

[0711] The current trend seems to be for object-relational databases, with vendors such as Oracle adding object features to their core products. Although the support provided at the moment is limited, it is likely that in future versions Java or C++ classes may be able to interface directly.

Tool recommendation

• [0712] Rational Rose 98 (Only valid for Oracle 8)
• [0713] ERwin
  Presentation Design
  Description

[0714] Presentation design tools provide a graphical depiction of the presentation layer of the application. Tools in this category include window editors, report editors, and dialog flow (navigation) editors. Window editors enable the developer to design the windows for the application using standard GUI components. Report editors enable the developer to design the report layout interactively. Placing literals and application data on the layout without specifying implementation details such as page breaks. The majority of these tools generate the associated application code required to display these components in the target system.

[0715] Using the dialog flow (navigation) editors, the developer graphically depicts the flow of the windows or screens. The Control-Action-Response (CAR) diagram is a commonly used technique for specifying the design of GUI windows.

[0716] The majority of Netcentric systems use Web browsers to provide a common cross-platform user interface. Presentation design for this ty pe of environment therefore entails the generation of HTML pages, often with additional components (JavaScript, 3rd party ActiveX controls, Plug-ins) providing enhanced functionality or media content. Many tools are currently available for designing and creating web content, although HTML remains the common denominator, at the very least as a placeholder for the content.

[0717] In the case of systems published on the Internet, defining the target audience is less straightforward than in traditional systems, but equally important. Having a good understanding of the intended audience may be a big advantage when thinking about user interaction with the system, and therefore, the presentation layer of the system.

[0718] Within a ReTA based application, three types of web pages that are available include:

[0719]

Page Type	Description
Static HTML	This page consists of a single HTML file containing static
	text, formatting, scripts, anchor tags, and imbedded images.
	This type of portion of the present description is the most
	common as it can be created using an ASCII text editor
	such as Windows Notepad.
	For designing web pages in a WYSIWYG format,
	Many popular editing tools are available including
	Microsoft FrontPage, Microsoft Visual InterDev,
	and HomeSite.
	Design elements include:
	Static HTML v3.2/v4.0 portion of the present descriptions
	Graphics/Images
	JavaScript (client and server) v1.2
Active	This type of web page is created dynamically at the web
Server Page	server and written to the requesting client.
(Non UI	These pages are useful when dynamic data is required
Framework)	within the web page itself.
	Microsoft FrontPage and Visual InterDev are
	popular ASP editors with Visual InterDev
	providing ASP debugging functionality as well.
Active	This type of web page is also created dynamically at the
Server Page	web server and written to the requesting client, however,
(Using UI	they make use of the ReTA User Interface Framework.
Framework)

Tool recommendation

• [0720] Microsoft Visual Studio 6.0
• [0721] Rational Rose 98
• [0722] Visio 5.0
• [0723] Visual Modeler 2.0 (Only valid for VB and VC++)
  Packaged Component Integration
  Description

[0724] Packaged components are generally thought of as third party applications or services that provide ready-made business logic that is customizable and reusable. Additionally, legacy applications can be included in these discussions when there is a desire to reuse portions of or an entire pre-existing application.

[0725] One of the benefits of component-based systems is the ability to separate the component interfaces from their implementation. This simple feature can help enormously with access to both third party components and legacy applications. The concept of putting an object or component interface on a non-object piece of software is called ‘wrapping.’

[0726] There are several arguments for putting a wrapper around an third party application or legacy system instead of custom building or replacing the functionality that they provide:

• • [0727] The wrapped component may provide functionality that requires deep technical expertise or knowledge to develop. (e.g. hardware drivers, EDI applications)
  • [0728] The provided functionality may only be temporary. With a wrapper in place, the underlying implementation may change without affecting the consuming application.
  • [0729] The wrapped component can now be reused within additional applications without additional effort.
  • [0730] Wrapping can take considerably less time and effort than building the third party component or legacy application over again. The more complex the application being wrapped, the greater the cost savings in time and effort.
  • [0731] Within wrapped components, it is possible to consolidate several existing applications into a single new service. (e.g. customer details from a ERP package as well as from the new system)
    Procedures/Standards
    Pure Component Integration

[0732] Component standards are maturing, particularly in eCommerce Applications. Although plug and play is not yet a reality, more application and ISV vendors are developing component based solutions for the eCommerce market place. Generally, this is the simplest form of integration if leading-edge eCommerce architectures are being deployed.

[0733] Care should be taken to allow for the migration from one vendor to another. To allow for this, the application developer should investigate encapsulating the component within an application wrapper.

Wrapped Component Integration

[0734] Many of today's vendors provide ActiveX or Java classes that provide a direct component interface into their application or services. Some vendors such as SAP expose component interfaces which can be accessed by ORBs e.g. Microsoft's DCOM connector. The underlying architecture however is not component-based. This is not a problem providing the package provides scalable and robust application execution.

[0735] Another example is the use of Microsoft's COM Transaction Integrator 3700 and the Microsoft SNA Server for NT 3702. These products allow for the wrapping of CICS transactions in COM component stubs 3704 that can be invoked from MTS components. See FIG. 37, which illustrates directly calling a wrapped CICS component 3706.

Batch and Indirect Integration

[0736] This process of integration relies on the use of Message Oriented Middleware (MOM) to provide asynchronous messaging to and from the packaged application. This can be accomplished using Microsoft's Message Queue (MSMQ) 3800, IBM's MQ/Series 3802 and Level 8's Falcon Bridge 3804 (to provide MSMQ to MQ/Series communication). See FIG. 38, which illustrates indirectly calling a wrapped CICS component 3806.

Data Integration

[0737] This is the most common form of integration but restrictive because it involves development of duplicated business logic, risks breaking application integrity and causes maintenance overheads.

Construction

[0738] Construction tools and processes are used to program or build the application: client and server source code, windows, reports, and database. ReTA based development should use a base set of naming and coding standards.

Tool Recommendation

• [0739] Visual Studio 6.0
• [0740] Rational Rose 98
  Test

[0741] Testing applications (client/server or NetCentric) remains a complex task because of the large number of integrated components involved (i.e., multi-platform clients, multi-platform servers, multi-tiered applications, communications, distributed processing, and data). The large number of components result in a large number and variety of testing tools.

Test Data Management

Description

[0742] Members of the technology infrastructure and data architecture teams are often the ones who create and maintain the common test data. This requires full-time personnel, especially when a large number of test databases must be kept in synchronization. Many of the automated testing tools available on the market today provide test data management functionality.

[0743] At a minimum, vendor or custom applications and processes should be in place to perform the following:

• • [0744] Database Schema Export & Import
  • [0745] Individual or Bulk Table Deletion and Population
  • [0746] Data Refresh/Restore

[0747] Additional functionality may include data generation or conversion, versioning and validation.

Tool Recommendation

[0748] Many testing tools are available on the market today, some of which provide test data management functionality.

Procedures/Standards

[0749] The ReTA Component Test Workbook Plan-Prep provides the mechanism for maintaining component test data required during test execution. When creating the test data, all attempts should be made to make the test data reusable.

Test Data Manipulation

Description

[0750] There are a few avenues for the manipulation of test data. When considering this function during the component and assembly testing phases consider the following:

• • [0751] Create test data if the physical data model is stable.
  • [0752] Use the existing application if it can create valid data.
  • [0753] Convert production data if the Data Conversion Application and the production data are reliable.
    Tool Recommendation

[0754] If possible, leverage any existing data manipulations that were included with the database suite. Many database vendors provide data management and manipulation applications with their database systems. Additionally, many development packages, including Microsoft Visual Studio, provide database access and manipulation functionality.

[0755] For data generation, PLATINUM TESTBytes™ is a test data generation tool that connects to your database to create test data for your relational databases. With point-and-click action, one can specify the type of data needed. TESTBytes automatically generates up to millions of rows of meaningful test data, eliminating days or weeks of time-consuming effort and reducing costs.

Procedures/Standards

[0756] For data conversion, the best approach is to:

• • [0757] If data is going to be shared with an existing application, attempts should be made to reuse test data from the legacy system.

[0758] Use the existing data store capabilities to extract or massage the data into a format that is easily integrated into the new application.

[0759] Create one-time extract and formatting applications to extract the legacy data, perform formatting and business operations, and import the newly modified data into the new data store.

[0760] The ReTA Component Test Workbook Plan-Prep provides the mechanism for maintaining component test data required during test execution. When creating the test data, all attempts should be made to make the test data reusable.

Test Planning

Description

[0761] The test planning function during a ReTA engagement provides an opportunity to define the approaches, tools, environments and process to test the application and its individual components for functional and technical validation. This process is typically assigned to someone with experience in application development using similar technologies as those to be used on the new system.

Tool Recommendation

[0762] The ReTA Component Test Workbook Plan-Prep provides the mechanism for maintaining and communicating component test information. Component test planning information such as component test cycles and component test conditions are included. Both worksheets are to be completed during the design phase by the designer.

Test Execution

Description

[0763] If testing environments have been created, application testing scenarios and scripts should be created to evaluate the application functions as designed. Actual results are compared against expected results portion of the present description with the test conditions. The use of automated testing tools is essential for fast, accurate regression and performance testing. Ensure the tool used for automated testing is easily configured. Also, ensure the scripts can be quickly updated to allow for user interface changes.

Tool Recommendation

Component Test Workbook

[0764] The ReTA Component Test Workbook Plan-Prep provides the mechanism for maintaining and communicating component test information. Component test planning information such as component test cycles and component test conditions are included. Both worksheets are to be completed during the design phase by the designer.

Automated Testing Tool

[0765] There are many automated, web-based testing tools on the market today. Many tools provide record and playback scripting functionality. See FIG. 39 which illustrates RSW eTest Automated Testing Tool 3900. Recommended features include:

• • [0766] Auto record and playback of test scripts
  • [0767] Data driven testing
  • [0768] Easy test modification (many tools have proprietary scripting languages)
  • [0769] Cross-browser support
  • [0770] Multi-user simulation for load & performance testing
  • [0771] Test summaries and reporting
    Procedures/Standards

[0772] In addition to the test planning elements of the CT workbook, component test execution worksheets are also included: component test script, test data, and expected & actual results worksheets. These worksheets are to be completed by the developer during the build phase. These scripts may be used by the developer/tester to execute the individual component tests. In theory, since the steps of the component test are portion of the present description, any developer or tester should be able to execute the test by simply following the steps outlined in the test script.

Performance Management

Description

[0773] Performance Management tools support application performance testing. These tools monitor the real-time execution and performance of software. They help to maximize transactions and response time to the end user. They are also useful in identifying potential bottlenecks or processing anomalies.

Procedures/Standards

[0774] During the automated test execution process, the testing tool may automatically verify the current state of the system (i.e. actual results) against the expected state of the system (i.e. expected results) for each test case defined in the test script. Execution status may be reported through the reporting function of the toolset. In the case of performance or lead testing, the testing tool may provide a summary report including graphic illustrations describing the overall performance of the system.

Test Results Comparison

Description

[0775] Whether using automated or manual testing processes, after the completion of each testing cycle it should be clear as to what defects still exist within the system. By comparing actual results with expected results, the application tester and developer can quickly detect design and development errors within the system.

Tool Recommendation

[0776] The ReTA Component Test Plan-Prep Workbook provides the mechanism for maintaining expected and actual results. The Expected and Actual Results worksheet outlines the expected result for each condition and lists the actual result encountered during the test execution.

Procedures/Standards

[0777] During the automated test execution process, the testing tool may automatically verify the current state of the system (i.e. actual results) against the expected state of the system (i.e. expected results) for each test case defined in the test script. Execution status may be reported through the reporting function of the toolset.

Test Coverage Measurement

Description

[0778] Test Coverage Measurement tools are used to analyze which parts of each module are used during the test. Coverage analyzing tools are active during program operation and provide comprehensive information about how many times each logic path within the program is run. This Test Management and Quality Management tool ensures that all components of an application are tested, and its use is a vital and often overlooked component of the test process.

Tool Recommendation

[0779] Rational's Visual PureCoverage™ is an easy-to-use code-coverage analysis tool that automatically pinpoints areas of code that code that have and have not been exercised during testing. This greatly reduces the amount of time and effort required to test an entire application and its components, increases the effectiveness of testing efforts by providing insight into overall program execution, and helps ensure greater reliability for the entire program, not just part of it.

Procedures/Standards

[0780] Test coverage measurement ensures is used to ensure that the entire application or system is completely tested. A manual approach can be applied to ensure that every path of logic within the application is completely tested. To reduce the test preparation time, an automated testing tool that provides this functionality should be leveraged.

SIR Management

Description

[0781] SIR Management Tools help track each system investigation request from problem detection through portion of the present description resolution.

Tool Recommendation

[0782] SIR Management Tools help track each system investigation request from problem detection through portion of the present description resolution. During the testing phases of the engagement, it may be desirable to reuse the SIR tools and processes developed for and used for overall problem tracking

SIR Workbench

[0783] The SIR Workbench is a Microsoft Access based tool that has been used on various component and client/server engagements. It provides basic functionality of entering, modifying and reporting of architecture and application problems encountered during the testing phases of the project life cycle.

Procedures/Standards

[0784] For a full description of the tool and its use, refer to the SIR Workbench.

Development Architecture Physical Model

Purpose

[0785] The ReTA Development Architecture Physical Model portion of the description shows the actual components comprising the Development Architecture and their relative location and interfaces. Additionally, the model—depicts the platforms on which the components may reside as well as the distribution across the environment. The components in the Physical Model may support a portion of a function or more than one function from the functional model.

Physical Configuration

[0786] FIG. 40 is an illustration that describes the physical configuration necessary for ReTA development. The development environment was composed of the following hardware and software configurations:

[0787]

Name	CPU	RAM	Operating System	Software
RETASRV1 (4000)	P-300	128 MB	Windows NT Server 4.0 (SP4)	Microsoft Internet Information Server 4.0
				Microsoft Transaction Server 2.0
				Microsoft Visual SourceSafe Client 6.0
				HP OmniBack II Client
RETASRV2 (4002)	P-166	60 MB	Windows NT Workstation 4.0 (SP4)	Microsoft Visual SourceSafe Server 6.0
				HP OmniBack II Client
RETADB1 (4004)	P-300	128 MB	Windows NT Server 4.0 (SP4)	Oracle Enterprise Edition 8.04
				HP OmniBack II Client
RETADEV1 (4006)	P-300	96 MB	Windows NT Workstation 4.0 (SP4)	Microsoft Transaction Server 2.0
				Microsoft Personal Web Server 4.0
				Microsoft Visual SourceSafe Client 6.0
				Microsoft Visual J++ 6.0
				Microsoft Visual C++ 6.0 - Tools Only
				Microsoft Internet Explorer 4.01
				Oracle 8 Client

Build Model

[0788] FIG. 41 illustrates the application & architecture configuration for a typical ReTA Build environment 4100. Each development workstation 4102 should be configured to provide systems management, configuration management and systems building support. In this model, all architecture and application components & services reside on the developer workstation. This allows the developer to design, build, debug and test independently of other developers.

Assembly Test Model

[0789] FIG. 42 illustrates the application & architecture configuration for a typical ReTA Build environment 4200. In this model, the testing workstation 4202 is configured to provide presentation services by way of an HTML 3.2 & JavaScript 1.2 compatible web browser. The web/application server 4204 is configured with the current assembly test versions of ReTA application and architecture components.

Security Management Architecture

[0790] Overview

[0791] The ReTA Security Management Architecture includes security issues, concerns and recommendations associated with Net-Centric Computing. The Security Management Architecture deliverable is used to illustrate the potential security implications. The ReTA Security Management Architecture portion of the present description is divided into three main portions in order to encompass security requirements for Development, Execution and Operation Architecture.

Development Architecture Security Management

[0792] Preserving security of information as it travels across the Internet, or even your own intranet, has become increasingly complex. The Internet is a public resource accessible worldwide, and is built on a foundation of inherently insecure technologies. Information which is available across the Internet is becoming more and more sensitive as business continue to deploy to the Internet. Implementing effective security in our new Net Centric computing environments presents some challenges without a doubt, but not insurmountable ones. By designing security into your Net Centric solution, and implementing the appropriate application, infrastructure, and procedural controls, security can be appropriately aligned with business risk. See FIG. 43, which illustrates an IDEA Framework 4300 with components in scope ReTA Phase 1.

[0793] Everyone today is talking about Net Centric security. Keeping up with all of the security issues surrounding Net Centric technologies is more than a full time job, it has become a full time obsession. When designing a Net Centric solution, security is always at the forefront of everyone's mind, but what are the important things to consider? How do I know that I've addressed all the appropriate questions? How may my solution affect the security of my computing environment? How may that security impact my business? This paper may answer these questions, providing an overview of “things to consider” when designing a Net Centric solution. It may not attempt to provide detailed technical solutions, but it may navigate one to the right path to find that information.

Impacts

Security Impacts

[0794] There is no question that the trend toward Net Centric computing may impact the traditional computing environment. Systems are much more distributed, and applications are being used by a larger number of people to reach new objectives every day. Along with all of these changes come significant security impacts. So what is it about Net Centric computing that can lead to security problems?

[0795] First of all, the Internet is a public resource. Traditionally our computer systems were only used or accessible by a small audience which we knew and could control. Now our computer environment is linked to the Internet, which is accessible to virtually anyone who has the time and the money to invest. While most of these people have good intentions when it comes to using your resources, some have an evil purpose. Threats can come from many sources: teenage hackers, spies from other companies, even curious people who inadvertently cause damage. The public nature of the Internet also increases the ability of these malicious individuals to collaborate and recruit others, thus strengthening their cause. The Internet contains a wide variety of information that people are interested in, from public information resources to sensitive customer databases.

[0796] In addition to the very lure of interesting information on the Internet, there are vulnerabilities inherent to Internet technologies which can make that information is, more easily compromised. In fact, the original intent of the Internet was to share information, not to be used as a business tool. Security weaknesses are widespread and present in nearly all Internet related technologies. The very communication protocol used, TCP/IP, was designed with few provisions to protect the security of the data packet.

[0797] Of course, security problems weren't created with the Internet; many of our standalone computer systems have the same types of security exposures. However, the global nature of the Internet now transfers these insecure services rapidly around the world. Weaknesses that before could only have been exploited by a small number of users with access to the system, can now be exploited by virtually anyone. These breaches are also now publicized to the entire Internet community. For example, many high profile web pages have recently been attacked, including NASA, the Department of Justice, and the CIA. Although these attacks were limited to vandalizing their web pages, (as far as we know), the publicity generated from the attacks has raised questions about the security of their systems in general. Internet access not only made these attacks possible, it also publicized the attack around the world.

[0798] This rapid transfer of information raises an issue regarding the dynamic nature of today's environment. The Net Centric environment includes traditional long term users of systems, as well as one time users who require instant logons and immediate connections. Security may stand in the way of business objectives if it is not flexible and dynamic enough to adapt to ever-changing business and technology requirements. In addition, new threats and risks evolve quickly in the Net Centric environment, and security programs may become ineffective and obsolete if not reviewed and updated regularly.

[0799] The Internet also brings with it a whole new set of legal issues, and topping the list are potential privacy implications. Businesses can now track your every movement on the Internet, from your email and IP addresses, to each site you surfed to and which ad one clicked. Does this constitute an invasion of your privacy? One may have freely given other businesses sensitive information aboutonerself, such as one's credit card number or one's social security number. To what lengths must that business go to in order to protect that information? If and when that information is compromised, who is liable? What is the penalty for breaking into a computer to which one is not granted access? What if one just looks around and does not cause any damage? These questions are just beginning to be addressed as cases are introduced in court and legislation is passed in Congress. But we are a long way from finding all the answers.

[0800] All of these security concerns have been widely publicized in the media, to the extent that the public now perceives security as a major issue on the Internet. These concerns may have the effect of impeding the success of an Internet solution, or even delaying a business decision to deploy to the Internet. Even as new technology emerges to solve many Internet related security problems, public opinion, legitimate or not, may still impact the success of any Internet solution.

Application Impacts

[0801] There are obviously a myriad of security implications from the move towards Net Centric computing. The Internet, and the growth of local intranets, has made our computing environment look much different today than it did five years ago. So what does this mean? When designing a business solution in this new environment, security implications have to be considered at every step of the process. Application design presents a specific set of security related challenges.

Application Design

[0802] The underlying theme in application design, from a security perspective, is to design in security from the beginning. Talk to Information Security representatives, and even internal auditors early on, and get their approval for your design. This can save retrofitting costs in order to achieve an adequate level of security, and may also end up giving one a more secure solution by integrating security right into the design of the application.

[0803] Once one is considering security, what is the best way to design it into your application? Even the most pompous security expert should recognize that your primary goal is not to build an application with really good security, it is to build an application that achieves a specific business goal. The challenge is to integrate security into that business goal so that it may not impede efficiency. Often security is tacked on a the last minute and impedes performance in the application, such that users may bypass security if possible, and curse it if not possible.

[0804] The next step is to consider the basic parameters of your application and how security applies to each of them.

[0805] Who needs access to the application, i.e. what is your user group? Is it all Internet users or some authorized subset? Does one only have one type of user or are multiple levels of authorization required?

[0806] Where may your application may be accessed from, the Internet or your intranet? How much control do one has over the security of that location and PC?

[0807] What is the confidentiality of the information your application may be transmitting or accessing? What implications would there be if that information fell into the wrong hands?

[0808] Once these questions have been answered one can begin to choose the appropriate tools or mechanisms to provide an adequate level of protection.

[0809] When designing your application, consider implementing the minimum level of functionality and authority required to meet your business goal. This is often contradictory to basic instinct when designing a new solution, but consider the potential implications. If your application does not need to allow users to execute arbitrary operating system commands, don't let it. If your application does not need to run as root or supervisor, don't let it. Designing for minimum functionality may obviously be a tradeoff between business and security benefits, but in general, it is better meet the level of authority required, not exceed it.

Security Integration

[0810] When designing security into your application, remember that one may not have to re-invent the proverbial wheel. Most information security groups may have corporate security strategies with which one can integrate. For example, an enterprise wide authentication scheme may be in use, with which one can integrate for remote access. Or there may be a single sign-on product with which your application may need to be compatible. Even if there is not a corporate security strategy in place today, consider the direction that the company is moving toward, and provide for future integration if possible.

Auditing and Logging

[0811] Application auditing and logging is often overlooked because it is less than glamorous, but it does provide security administrators with a crucial tool for monitoring use of an application. Good logs should be searchable for known or suspected patterns of abuse, and should be protected from alteration. Logs can monitor a virtual myriad of data, including access times, user IDs, locations from where the application was accessed, actions the user performed, and whether or not those actions were successfully completed.

Web Browser Security

[0812] While web browsers may not be exactly part of your application design, they are intimately related to many of the design decisions one may make, such as the programming tools one uses and the format your user interfaces take. The application programming tools portion of the description, above, discussed some possible ways a Web browser can exploit application security flaws. There are also design anomalies within the Web browsers themselves which can be exploited. Microsoft has fixed many of these flaws in their newest release of Internet Explorer, but their older versions are still vulnerable. This type of problem demonstrates that when considering integration with the major commercial web browsers, it is important to monitor news releases for recent security flaws. One may want to consider requiring your users to use the latest, most secure version of their Web browser if possible.

Infrastructure Impacts

[0813] Today's Net Centric computing infrastructure requires a complex mix of operating systems, web servers, database servers, firewalls, management tools, routers, and underlying network components. Each different component of this infrastructure has specific security considerations which need to be addressed. These requirements are always growing and changing, as are the solutions which can be implemented. When designing this complex infrastructure, similar to designing an application, security should be considered early on in the process.

Operating System Security

[0814] It is crucial to choose an operating system (OS) which can provide adequate security; and once chosen it is just as important to configure that OS in a secure manner. Any must address the same basic security questions, such as restricting permissions for what each user can access, limiting what actions each user can perform, providing monitoring and logging of user access, and restricting what services are available. Windows NT is without exception.

[0815] NT has been publicly available for over three years now, and while security issues may have appeared, fresh out of the box NT is a very secure OS. But there are still steps to take to improve this security. Configure your OS securely from the start, implement tools where appropriate, and continue to monitor the bulletin boards and vendor announcements for problems as they come up.

Web Server Security

[0816] Many of the OS security guidelines apply to web servers as well. Regardless of your choice of web server, it is important to configure that server securely. The server should be set to run under an ID which is used only by that web server; and never as root. Directory permissions should be assigned according to a need to know philosophy, and your portion of the present description root (where published information is stored) should be different from your server root (where server binaries and configuration files are stored.)

[0817] In addition to these somewhat generic operating system security tips, there are several features which are specific to a web server which could create security exposures. In general, if one doesn't need a feature, don't turn it on; and if one does need a feature, make sure the potential security risks are understood. Server side includes allow HTML authors to place commands inside their portion of the present descriptions that cause output to be modified whenever that portion of the present description is accessed by a user. Hackers can take advantage of server side includes if they are able to place arbitrary HTML statements on your server and then execute them.

Legacy System Integration

[0818] In order to truly take advantage of the power of Net Centric computing, new technologies need to be mixed and integrated with existing systems. More sophisticated intranets and extranets often require on line transactions or database inquiries of legacy environments which may not have the level of granular control required for secure access. In some cases, it may be possible to mirror the information from an existing platform to a more securable web server or database. This may protect the integrity of your sensitive systems while still providing the access for your on-line transactions. If a mirror system is not possible, a thorough audit should be performed of the security of your legacy system, to ensure that one is providing access to only those resources which are allowed.

Network Security

[0819] Now one has chosen your access control mechanisms, configured your OS, and it's time to connect to your network. This action may strike fear into the heart of many network and system administrators, because this may create one more way network security can be compromised. Contrary to popular belief, it is possible to establish and maintain effective network security. The first step is to understand what all of your network components are, and how they are connected. By examining your network topology, one can determine where all of your access points are, and (hopefully) the way that access to them is controlled. If remote access directly into your network is required, the use of your modems must be appropriately restricted. Don't rely on knowledge of the phone number or a single static password as effective security controls.

[0820] In addition to identifying one's access points, one should examine the path that one's traffic follows, and determine if that path is vulnerable to snooping and attack. One of the more infamous hacker gangs, the Masters of Deception, once infiltrated a major telecommunication provider's data network, and had access to the corporate secrets of hundreds of companies as information was sent across the lines. Even if your data is just traveling over internal links, a network management station could still be monitoring traffic, or a sniffer could illicitly be installed anywhere along the line. There are two major security controls that mitigate these risks: firewalls to restrict who can access your secure network, and encryption to protect your data as it's sent over an insecure network.

Firewalls

[0821] Firewalls are often thought of as THE answer to network security. There is a common misconception that purchasing and installing the “best” firewall available may automatically protect your network from the Internet. This is not necessarily true. In fact there are many factors to consider when choosing a firewall, and when placing and configuring that firewall in your environment. First of all, consider the type of network connection your are trying to protect. Firewalls are not only used to separate your intranet from the Internet, they can also be used to segregate a particularly sensitive or particularly insecure area of your intranet from the rest of your network. Depending on the services one wants to provide your users and what risk one is willing to accept, your choice of the “best” firewall implementation may change.

[0822] There are many different components of the firewall architecture to consider. Packet Filtering Systems selectively route packets between internal and external hosts by either the type of packet, the originating host address, or the target host address. Packet filtering is typically implemented on a specific type of router called a screening router.

[0823] Proxy Services are specialized applications or server programs that run on a firewall host, which take users' requests for Internet services (such as ftp and telnet) and forward them, as appropriate according to the site's security policy, to the actual services. The proxies provide replacement connections and act as gateways to the services. For this reason, proxies are sometimes known as Application Level Gateways.

[0824] A Bastion Host is typically a dual-homed gateway with one interface on the internal network and one on the external network. It can be used to run proxy services or perform stateful packet inspection. The bastion host typically acts as the main point of contact for incoming connections from the outside world, including email, ftp and telnet requests, and DNS queries about the site.

[0825] A Perimeter Network or DMZ refers to a small network between your internal network and the Internet which provides an extra layer of security. Any publicly available resources one provides, such as a Web server or an ftp server, may typically be located in the DMZ, and restricted from one's internal network by a firewall machine or bastion host.

[0826] There are many commercially available firewall products that provide some or all of these features. Which product or firewall configuration is right for one may depend on what one's network looks like, what one is trying to protect, and what your users require.

Event Monitoring

[0827] Before an incident can be responded to, it must first be detected. In the Net Centric environment, your firewall, routers, web servers, database servers, applications, and network management tools must be monitored to ensure they are working correctly and no violations have occurred. Monitoring packages can be configured to take different actions on a series of specified events, such as sending an email message if a log fills up, flashing an icon on a system administrator's screen if someone's user ID is disabled, or paging a network administrator if a link to the ISP goes down. Once this initial notification takes place, there should be escalation procedures to decide whom to notify next. For example, if the link to the ISP goes down, how long does one wait before notifying one's manager? one's users? In addition, not all monitoring needs to be reactive. There are proactive monitoring tools available which can detect patterns of abuse or failure which may lead to larger problems, and can help one detect those problems before they affect your users.

Backup and Recovery

[0828] People kick over servers, accidentally delete files, and spill coffee on machines. For these reasons and a host of others, Net Centric resources must be backed up in a manner so that they can be recovered. This does not mean dumping a bunch of files onto data tapes and stacking them in a corner of the server room. An effective backup and recovery strategy should address how backups may be taken, the media—on which they may be stored, the location where they may be stored, and the frequency with which they may be taken. Backups should also be periodically tested to make sure that they are recoverable, for example to make sure the backup tape drive is still working. When designing your backup strategy one should also consider the specific types of applications, databases, and hardware which are in use in your environment. For example an Oracle database may probably not be recoverable from a.tar file. In addition to software resources, consider what would happen if your router or your ISP link were to go down. It may be necessary to maintain a backup link to a secondary service provider in the event that your ISP goes down for an extended period of time.

Execution Architecture Security Management

[0829] The Execution Architecture Security focuses on Authorization, Encryption and Authentication in order to securely support applications and ensure data integrity throughout the life cycle of a single transaction. The ReTA Effort chose the Netcentric Architecture Framework (NCAF) to identify the appropriate components to focus on within the Execution Architecture. See FIG. 44 which illustrates a NCAF Framework 4400 with the shaded components 4402 in scope for Phase 1.

Authentication

[0830] Regardless of the operating system that one is using, access control is a major security concern. NT authenticate users by their knowledge of an ID and password that can be used multiple times however, all passwords are vulnerable in some manner. The advent of sniffing technologies allows passwords to be monitored and read over the network. Even if passwords are encrypted as they are sent, a keystroke capturing program could be installed at the client PC and used to capture passwords before they are encrypted. Perhaps advanced client side security can mitigate this threat as well, but even with the highest technology solution, a user could write his password down and stick it to the side of his PC, thereby defeating all of the technology just implemented.

[0831] The solution to this problem is some type of two factor authentication, meaning that users are authenticated with something they have, and something they know. The “something they know” can still be a password, and the “something they have” can range from the high end being a one time password generator, to the low end being an ID file stored on the user's PC or on a disk. In choosing an appropriate solution, one should consider ease of management and ease of distribution, the required strength of the solution, and integration into your environment. There are several examples of technologies which can meet your requirements, including the use of one-time passwords, time based passwords, or challenge response schemes. Once chosen and implemented, a secure authentication mechanism can be incorporated with both your operating system and your application to remove the risks associated with static passwords. Some authorization options are depicted in this Authentication Matrix:

[0832]

Product	Description	Pros	Cons	Implementation	Vendors
Smartcards	The smart card is a plastic	Strong Authentication	Additional Hardware	4-6 people weeks	WetStone
	card having the size and shape of a	Login from	No Standard		Schumberger
	credit card, and containing a	various locations	Slow Acceptance		SmartCard Technologies
	microprocessor chip with	Scalability
	both secure storage of
	public/private key data
	and cryptographic
	processing capabilities
PKI	The system required to provide	Strong Authentication	Requires infrastructure	4-24 people weeks	GTE Cybertrust
	public-key encryption and digital	Enables the use of	to operate		VeriSign Entrust
	signature services. The purpose of a	encryption and digital	Certificate Management
	public-key infrastructure is to	signature services	Services
	manage keys and certificates. A	across a wide variety
	PKI enables the use of encryption	of applications
	and digital signature services
	across a wide variety of applications.
Hard Token	A hard token is a physical device	Strong Authentication	Increased Cost	4-8 weeks	Enigma Logic
	that acts as “something a user has”.	Versatility		depending on	Security Dynamics
	The end-user then supplies	Login from various		API config.	Vasco
	“something the user knows”, namely	locations
	a personal identification number
	or PIN.
	The combination of the token and the
	PIN, along with the user's public
	username, provides strong two
	factor authentication of the user.
Soft Token	A soft token is a software device that	Provides a	Users limited to	3-6 weeks	Axent Defender
	creates a unique one-time password	significantly higher	log on from one	depending on	Security Dynamics
	that cannot be guessed, shared,	level of security	computing	API config.
	or cracked. The end-user then	than the reusable	location
	supplies a personal identification	password	More easily
	number or PIN. The combination		compromised
	of the one-time password and the		than hard token
	PIN, along with the user's
	public username, provides two factor
	authentication of the user.
ID/Password	A method of authenticating a user	Easy implementation	Password Intensive	Native to Applet
	by which a user provides a
	unique identifier and a
	shared secret.

Encryption

[0833] In Net Centric computing it is likely that eventually your data may pass through a network that is not secure, where your data can be snooped or even changed. In order to guarantee confidentiality over any insecure network, including the Internet, some type of encryption must be used. Encryption may ensure that data cannot be read by anyone other than the secure target server, and that the data being transferred has not been altered. Today there are so many different strategies for implementing encryption, it is often difficult to choose which scheme is most appropriate. The specific encryption strategy chosen may rely on a number of factors.

[0834] What information exactly needs to be encrypted? If one is running a smart store over the Internet, maybe one only needs to encrypt the single piece of data that has the customer's credit card information. If one is allowing their system administrators to dial into their network via the Internet, one may probably want to encrypt the whole session.

[0835] How many users are there? If one want to just encrypt data between a few users and one's system, a private or secret key encryption scheme may be appropriate. If one is in a multi-user environment one may probably want to consider public key encryption, and the key management strategies that go along with it.

[0836] What does one's computing environment look like? If your applications or operating systems provide native encryption, these may be the easiest and most secure to implement.

[0837] Based on your answers to these questions, there are a number on encryption solutions available for implementation. If one is running a Netscape web server, one may want to consider Secure Sockets Layer, or SSL, which provides data encryption, server authentication, message integrity, and optional client authentication for a TCP/IP connection. Another WWW security solution is Secure Hypertext Transfer Protocol (S-HTTP), which is a security-enhanced version of HTTP, developed by Enterprise Integration Technologies (EIT). S-HTTP supports end-to-end secure transactions by incorporating cryptographic enhancements to messaging at the application level. Pretty Good Privacy, or PGP, is a common encryption solution for electronic mail. PGP may both authenticate the sender of the message, and encrypt the contents of the message through the use of a public key/private key pair. In electronic commerce solutions, the Secure Electronic Transactions (SET) specification which is being jointly developed by Visa and MasterCard may be considered. SET may require authentication of all parties involved with a credit card transaction through the use of digital signatures and certificates, and may use a separate encryption handshake in order to guarantee both confidentiality and integrity. Other encryption solutions include Point to Point Tunneling Protocol (PPTP), Private Communication Protocol (PCT), or the use of CryptoAPI. Some available encryption options are depicted in the following Encryption Matrix:

[0838]

Product	Description	Pros	Cons	Implementation	Vendors
Virtual	A secure, end-to-end connection	Application-	High implementation	1-4 people weeks.	Axent Raptor
Private	is established through	independent channel	cost		Firewall VPN and
Network	encryption in an application-	Best suited for	Requires software		Power VPN
	independent channel.	static business	for remote users		Checkpoint VPN
	Encryption services can be	relationships			V-one SmartGate,
	computationally expensive	Does not require any
	and degrade performance.	additional software
	Hardware based encryption	for enterprise users
	services usually provide increased
	performance over software based
	encryption.
Protocol	A secure, end-to-end connection	Reduced cost over	Application dependent	2-8 people weeks	WorldTalk's
Specific	is established through	traditional VPN	channel		WorldSecure
VPN	encryption for a specific	Reduced implementa-
	protocol.	tion time compared to
		traditional VPN
Hardware	Performs cryptographic processing	Increased security and	Increased cost over	1-3 people weeks	Atalla SignMaster
Encryption	features on a dedicated	performance over	software encryption		Cylink CryptoServer
	hardware device.	software encryption			Timestep PERMIT/Gate
Secure	SSL is a security protocol that	Open standard	Early implementations	Native to web
Sockets	prevents eavesdropping, tampering,	Low implementation	have security	components)
Layer	or message forgery over the Internet.	cost	vulnerabilities
		Strong take-up in the
		U.S. vs. SET
PKI	The system required to provide	Provides security	Expensive to implement	4-24 people week	GTE Cybertrust
	public-key encryption and digital	infrastructure for	Requires ongoing key		VeriSign Entrust
	signature services. The purpose of a	multiple applications	management activities
	public-key infrastructure is to	Provides
	manage keys and certificates. A	authentication in
	PKI enables the use of encryption,	addition to
	digital signatures, and	encryption
	authentication services across a
	wide variety of applications.
Symmetric	The system required to provide	Increased performance	Authentication is not	(solution not	TriStrata Portion of
Key	symmetric key encryption and	over public key	tied uniquely to one	implemented)	the present description
Encryption	authentication services. Similar	encryption	individual		Security System
Infra-	to kerberos, this system may provide	Toolkits can be	Private information is
structure	a central repository for encryption	used to integrate	stored in a central
	and authentication services	security technology	database
	across multiple applications and	into applications	native in applications
	computing platforms.		limited to WIN95/NT

Authorization

[0839] When a user requests access to network resources, the Authorization service determines if the user has the appropriate permissions and either allows or disallows the access. (This occurs after the user has been properly authenticated.)

[0840] The following are examples of ways to implement Authorization services:

[0841] Network Operating Systems—Authorization services are bundled with all network operating systems in order to control user access to network resources.

[0842] Servers, Applications, and Databases—Authorization can occur locally on a server to limit access to specific system resources or files. Applications and databases can also authorize users for specific levels of access within their control. (This functionality is within the Environment Services grouping in the execution architecture.)

[0843] Firewall Services protect sensitive resources and information attached to an Intxxnet network from unauthorized access by enforcing an access control policy.

Recommendation

[0844] ReTA may utilize all Windows NT-based resources, including those accessed using a Web browser, are represented as objects that can be accessed only by authorized Windows NT-based users. Access may be controlled through an Access Control List (ACL).

Operations Architecture Security Management

[0845] The Operations Architecture is a combination of tools, support services, procedures, and controls required to keep a production system up and running efficiently. Unlike the Execution and Development Architectures, its primary users are the system administrators and the production support personnel.

[0846] All components of the Operations Architecture are integral to the successful management of a distributed environment. Any processes, procedures, or tools developed or chosen as an operational management solution for a specific operational area must be able to integrate with any existing or planned process, procedure, tool solutions for other Operations Architecture areas. See FIG. 45 which illustrates a MODEnc Framework 4500 with an event processing component 4502 and an event and data generation component 4504.

Execution Architecture Design

Overview

[0847] The Netcentric Architecture Framework (NCAF) identifies the run-time services required by Netcentric applications. The ReTA design effort used this framework to define the ReTA Execution Architecture requirements. Taken in the NCAF context, this portion of the present description describes the ReTA Execution Architecture implementation (through custom and/or vendor components) of the required run-time services.

[0848] The NCAF categorizes the runtime services into the following logical areas (see FIG. 46 which illustrates the NCAF Framework 4600):

• • [0849] Presentation Services 4602
  • [0850] Information Services 4604
  • [0851] Communication Services 4606
  • [0852] Communication Fabric Services 4608
  • [0853] Transaction Services 4610
  • [0854] Environment Services 4612
  • [0855] Base Services 4614
  • [0856] Business Logic 4616
    Execution Architecture Component Design
    Purpose

[0857] The Execution Architecture Component Design portion of the description describes the ReTA implementation of the NCAF defined run-time services. This portion of the description also maps the ReTA application architecture frameworks into the appropriate NCAF service component descriptions.

[0858] The ReTA Application Architecture comprises the following frameworks:

[0859]

Framework	Services
Session	Security
	User identification
	Page access authorization - Session scope
	Automatic abort - timeout
	Customized information delivery
	Customized user interface
	Customized application access
	Manage user session
	Inform user on session status
	Abort session
	Flow control
	Page to open on action
	Pages of activity
	Maintain context
	Activity context
	Business Object context - shared among activities
	Message Broadcast
	Register listener
	Broadcast Message to registered listeners
	Encryption
	Encode Database User Name and Password
	Decode Database User Name and Password
Activity	Provide a logical unit of work
	Microsoft Transaction Server transaction principles
	Maintain context
	Business Object context
	UI context - List boxes
	Sub-activity context
	Security
	Page access authorization - Activity scope
	Validation
	Pre-conditions
	Post-conditions
	Sub-Activity - Smallest grained business logic
	Execute business logic
	View - mapping between a user interface and a
	business object
	Capture user entry
	Display value entered
Persistence	Database Connection
	Uncouple database connection from application
	Database mapping
	Map an object to a database table
	Object query
	Trigger queries on objects
	Easily iterate through the results
	Record locking
	Optimistic locking
	Pessimistic locking
Event Handler	Register event
	Create event
	Maintain event reference
	Process event
	Information
	Warning
	Logical Unit of Work
	Fatal
	Display events
	Translate event
	Inform user
	Persist event
	Log event to database
User Interface	Generate UI Items
	Form
	Push Button
	Text Box (single-line entry field)
	Text Area (multi-line entry field)
	Radio Button group
	Check Box
	Drop Down List Box
	Blank Item
	Static Table
	Single-Select List Box
	Generate UI actions
	JavaScript - action shell
	JavaScript - data type validation
	JavaScript - data range validation
	JavaScript - automatic navigation action
	Generate Page Format
	Cascading Style Sheet
	Form (grid layout for form elements)
Codes Table	Retrieve from Codes Table
	Retrieve single decode value
	Retrieve all decode values
	Maintain Codes Table
	Update single Code/Decode
	Update all Codes/Decodes
	Set Table Name
	Add new Code/Decode
	Remove Code/Decode
	Add Table
	Remove Table

Base Services

[0860] Base Services provide server-based support for delivering applications to a wide variety of users over the Internet, intranet, and extranet.

Web Server Services

Description

[0861] Enables organizations to manage and publish information and deploy Netcentric applications over the Internet and Intranet environments. These services support the following: managing portion of the present descriptions in multiple formats, handling of client requests for HTML pages, processing server-side scripts, and caching web pages to improve performance.

ReTA implementation

[0862] ReTA implements web server services through Microsoft's Internet Information Server 4.0 (IIS). IIS provides the following services:

• • [0863] Process requests for static and dynamic web pages and graphics.
  • [0864] Implement appropriate security and authentication to public and private areas of a web site.
  • [0865] Execute application specific Active Server Pages.
  • [0866] Implement web activity tracking and reporting.
  • [0867] Implement application state and management capability.

[0868] ReTA uses the US Session object to hold references to architecture and application components during the user session.

Communication Services

[0869] Network services provided by the Communications Services layer are grouped into four major categories of functionality: Virtual Resource, Directory, Messaging, and Security services. The Virtual Resources Component is not implemented by ReTA Phase 1.

Directory Services

[0870] A full-featured Directory Service organizes, categorizes and names networked resources in order to provide a comprehensive picture of clients, servers, users, applications and other resources. The service typically includes a database of objects, representing all nodes and resources on a network. The database manages relationships between users and networks, network devices, network applications, and information on the network. The Directory service performs the following functions:

• • [0871] Stores information about network resources and users and tracks relationships
  • [0872] Organizes resource access information in order to aid resources in locating and accessing other resources throughout the network
  • [0873] Provides location transparency, since resources are accessed through a directory rather than based on their physical location
  • [0874] Converts between logical resource names and physical resource addresses
  • [0875] Interacts with Security services such as authentication and authorization track identities and permissions
  • [0876] Provides single network logon to file and print resources; can provide single network logon for network applications that are integrated with the Directory service
  • [0877] Distributes directory information throughout the enterprise (for reliability and location-independent access)
  • [0878] Synchronizes multiple directory databases
  • [0879] Enables access to heterogeneous systems (integration of various network operating systems, platforms, etc.)
    Domain Services
    Description

[0880] A network domain is a set of network nodes under common control (i.e., common security and logins, unified addressing, coordinated management, etc.). Domain services manage these types of activities for the network nodes in a domain. Domain services may be limited in their ability to support heterogeneous systems and in the ability to scale to support the enterprise.

ReTA implementation

[0881] ReTA implements domain services through Microsoft's NT 4.0 Server.

Name Services

Description

[0882] The Name service creates a logical “pronounceable” name in place of a binary machine number. These services could be used by other communications services such as File Transfer, Message Services, and Terminal Services. A Name service can be implemented on its own, or as part of a full-featured Directory service.

ReTA implementation

[0883] ReTA implements name services through Microsoft's NT 4.0 Server.

Messaging Services (Core)

[0884] Broadly defined, Messaging services enable information or commands to be sent between two or more recipients. Recipients may be computers, people, or processes within a computer. Core Messaging services are categorized by the characteristics of the information being transferred:

• [0885] File Transfer
• [0886] RPC
• [0887] Message-Oriented Middleware—Not in scope for ReTA Phase 1
• [0888] Streaming—Not in scope for ReTA Phase 1
  File Transfer
  Description

[0889] File Transfer services enable the sending and receiving of files or other large blocks of data between two resources. In addition to basic file transport, features for security, guaranteed delivery, sending and tracking sets of files, and error logging may be needed if a more robust file transfer architecture is required.

ReTA implementation

[0890] ReTA implements file transfer services through Microsoft's Internet Information Server 4.0 (IIS) using the HyperText Transfer Protocol (HTTP). Within a Web-based environment, Web servers transfer HTML pages to clients using HTTP. HTTP can be thought of as a lightweight file transfer protocol optimized for transferring small files. HTTP reduces the inefficiencies of the FTP protocol. HTTP runs on top of TCP/IP and was developed specifically for the transmission of hypertext between client and server.

RPC (Remote Procedure Calls)

Description

[0891] RPCs (Remote Procedure Calls) are a type of protocol by which an application sends a request to a remote system to execute a designated procedure using the supplied arguments and return the result. RPCs emulate the function call mechanisms found in procedural languages. This means that control is passed from the main logic of a program to the called function, with control returning to the main program once the called function completes its task.

ReTA implementation

[0892] ReTA implements RPC services through Microsoft's COM/DCOM mechanism and the Internet Information Server 4.0 (IIS) using HTTP.

Messaging Services (Specialized)

[0893] Specialized Messaging services extend the Core Messaging services to provide additional functionality, including:

• [0894] Provides messaging among specialized systems by drawing upon basic messaging capabilities
• [0895] Defines specialized message layouts
• [0896] Defines specialized inter-system protocols
• [0897] Suggests ways in which messaging draws upon directory and security services in order to deliver a complete messaging environment
  Database Access
  Description

[0898] Database Messaging services (also known as Database Access Middleware) provide connectivity for clients to access databases throughout the enterprise. Database messaging software draws upon basic inter-process messaging capabilities (e.g., RPCs) in order to support database connectivity.

ReTA implementation

[0899] ReTA implements Database Messaging services through Microsoft's Open Database Connectivity (ODBC) mechanism. ReTA abstracts database connection from the application developer through the Microsoft Transaction Server (MTS) 2.0 connection pooling mechanism.

Object Messaging

Description

[0900] Object Messaging enables objects to transparently make requests of and receive responses from other objects located locally or remotely. Objects communicate through an Object Request Broker (ORB). An ORB enables client objects to access server objects either locally or remotely over a network and invoke operations (i.e. functions and methods) on them. ORBs typically provide interoperability between heterogeneous client and server environments: across languages and/or operating systems and/or network protocols.

ReTA Implementation

[0901] ReTA implements Object Messaging services through Microsoft's COM/DCOM mechanism.

Security Services

[0902] Communications Security services control access to network-attached resources. Combining network Security services with security services in other parts of the system architecture (e.g., application and database layers) results in robust security.

Authentication

Description

[0903] Authentication services verify network access requests by validating that users are who they claim to be. For secure systems, one or more authentication mechanisms can be used to validate authorized users and to verify to which functions and data they have access.

ReTA implementation

[0904] ReTA implements Authentication services through Microsoft's NT 4.0 Server (and IIS).

Authorization

Description

[0905] Authorization services determine if users have appropriate permissions and either allows or disallows the access.

ReTA implementation

[0906] ReTA implements Authorization services through Microsoft's NT 4.0 Server (and IIS). ReTA also supports application defined “required workflow sequence” web page access authorization through the ReTA Session framework.

Encryption

Description

[0907] Encryption services encrypt data prior to network transfer to prevent unauthorized interception. Encryption has two main components: the encryption algorithm, which is the series of steps that is performed to transform the original data; and the key, which is used by the algorithm in some way to encrypt the message. Typically, the algorithm is widely known, while the key is kept secret. There are several types of encryption in use today, including:

• [0908] Secret key cryptography—uses one key (the secret key) both to encrypt the message on one side and to decrypt the message on the other side.
• [0909] Public key cryptography—uses two keys, the public key and the private key. The public key and private key are mathematically related so that a message encrypted with the recipient's public key may be decrypted with the recipient's private key. Therefore, the public key can be widely published, while the private key is kept secret.
  ReTA implementation

[0910] ReTA implements Encryption services through the Secure Sockets Layer (SSL) mechanism. ReTA also implements encryption for the User ID and User Password used by the ODBC mechanism through the ReTA Session framework.

Environment Services

[0911] Environment Services provide miscellaneous application and system level services that do not deal directly with managing the user-interface, communicating to other programs, or accessing data. Subcomponents covered during the Phase 1 of ReTA include: Application Services, Component Framework, Operating System, Runtime Services, and System Services.

Application Services

[0912] Application Services are miscellaneous services which applications can use for common functions. These common functions can apply to one application or can be used across applications. They include: Application Security Services, Error Handling/Logging Services, State Management Services, Help Services, and Other Common Services.

Application Security

Description

[0913] Besides system level security such as logging into the network, there are additional security services associated with specific applications. These include:

• [0914] User Access Services—set of common functions that limit application access to specific users within a company or external customers.
• [0915] Data Access Services—set of common functions that limit access to specific data within an application to specific users or user types (e.g., secretary, manager).
• [0916] Function Access Services—set of common functions that limit access to specific functions within an application to specific users or user types (e.g., secretary, manager).
  ReTA implementation