s

Preface Table of Contents Introduction Client Application Builder Architecture

1 2 3

SIMATIC IT 6.3 SP1

CAB Portal

Client Application Builder Concept Guide

Concept Guide

Edition 10/2007
A5E01504167-01

Guidelines
This manual contains notices intended to protect the products and connected equipment against damage. These notices are graded according to severity by the following texts: Caution Indicates that if the proper precautions are not taken, this can result into property damage. Notice Draws your attention to particularly important information on handling the product, the product itself or to a particular part of the documentation.

Trademarks
All names identified by are registered trademarks of the Siemens AG. The remaining trademarks in this publication may be trademarks whose use by third parties for their own purposes could violate the rights of the owner.

Disclaimer of Liability
We have reviewed the contents of this publication to ensure consistency with the hardware and software described. Since variance cannot be precluded entirely, we cannot guarantee full consistency. However, the information in this publication is reviewed regularly and any necessary corrections are included in subsequent editions.

Siemens AG Automation and Drives Postfach 4848 90437 NRNBERG GERMANY

A5E01504167-01 10/2007

Copyright Siemens AG 2007 Technical data subject to change

Preface
Purpose
This Concept Guide covers the basic concepts underlying SIMATIC IT Client Application Builder (CAB) and CAB Portal. Important This guide does not intend to act as a technical manual or reference for SIMATIC IT Client Application Builder

Basic knowledge required

This guide is intended for SIMATIC IT users responsible for system configuration, such as application managers and system integrators or consultants. To understand the concepts and examples discussed in this guide, the reader ought to have attended the SIMATIC IT Training course. A general background in the concepts of SIMATIC IT environment is required.

Where is this manual valid?

This manual is valid for release 6.3 SP1 of SIMATIC IT .

Readme
The installation includes a readme file, which contains information on upgrade procedures and compatibility with previous releases. This file is supplied both in standard text (Readme.wri) and in Acrobat PDF (Readme.pdf) format. This file is available in folder \ReleaseNotes of the setup DVD and is available from the shortcut Start > SIMATIC > SIMATIC IT Documentation.

Online help
The SIMATIC IT online help integrated in the software complements this Concept Guide and provides detailed support for using the software. The help system consists of: The Contents and Index command on the Help menu to open the online help window, from which you can choose the topic of interest. You can search for the desired information, using the table of contents or the index A context-sensitive help that offers information on the current context, for example, an open dialog box or an active window. You can open the contextsensitive help by clicking the Help button in any dialog box. A status bar that offers another type of context-sensitive help. It displays a short explanation for each menu command when the mouse pointer is positioned on the menu command.

SIMATIC IT V6.3 SP1 A5E01504167-01

iii

Preface A brief explanation (ToolTip) for each icon in the toolbar when the mouse pointer is positioned on the icon for a short time.

Related documentation
The following documents contain information related to the content of this Concept Guide. SIMATIC IT CAB online help SIMATIC IT CAB Good Programming Practice manual SIMATIC IT ASP.NET Best Practice manual CAB Portal Startup guide CAB Portal Advanced development manual CAB Portal Developer manual CAB Portal Reference guide All these documents are available online from the shortcut Start > SIMATIC > SIMATIC IT Documentation.

Finding your way

This document consists of three parts. The table below outlines the structure.
Part 1 2 3 Content Introduction Architecture of Client Application Builder CAB Portal

Conventions
The table below describes the specific typographic conventions that are used throughout this manual:
Symbol/Convention Indicates...

E.g. Text in bold

Where examples are given. The names of menus, commands, dialog boxes and toolbar buttons and, in general, all strings (e.g. File menu; Save command). Shortcut keys, which permit rapid access to commands (e.g. CTRL+C). The names of keyboard keys (e.g. RETURN key). The names of parameters that must be replaced with a specific name or value. E.g. filename indicates that the name of the file must be specified; input indicates that the corresponding value must be specified.

KEY1+KEY2 UPPERCASE Italics

>

A succession of commands in which the command preceding the symbol must be selected before the command following it.

iv

SIMATIC IT V6.3 SP1 A5E01504167-01

SIMATIC IT Training Center

Siemens A&D AS MES offers a number of training courses to familiarize you with the SIMATIC IT product suite. To successfully achieve this goal, training consists of lessons in both theory and practice. Courses are held year-round, according to a program that is published well in advance of the first scheduled session. The material on the basis of which our courses are conducted reflects the result of years of experience in process, LIMS, quality control and production management. All courses are held by expert personnel that are aware of the developments and innovations in the Siemens A&D AS MES product suite. Courses are held in English at the Siemens A&D AS MES Training Centers. Upon request, training courses can also be organized on the customers premises. For more information on the training course calendar, please visit our technical web site (http://www.siemens.com/simatic-it/training).

SIMATIC IT Service & Support

A comprehensive Software Maintenance program is available with SIMATIC IT products. Software Maintenance includes the following services: Software Update Service (SUS): automatic distribution of upgrades and service packs Technical Support Service (TSS): support on technical problems with SIMATIC IT software (standard support and other optional services) Online Support: a technical web site, providing information such as Frequently Asked Questions and technical documentation on SIMATIC IT products

Software Update Service (SUS)

This service provides automatic shipment of new versions and service packs when released. When a new version / service pack is available for shipping, it is typically shipped within one month. One copy of the installation DVD is shipped for each Server covered by Software Maintenance. Hot fixes (officially tested and released) are not shipped and must be downloaded from the Technical Support Service Web site.

Technical Support Service (TSS)

Siemens provides a dedicated technical support team for SIMATIC IT products.

The following options are available: Standard support: 9 hours/day, 5 days/week Premium support: 24 hours/day, 5 days/week Advanced support: 24 hours/day, 7 days/week

SIMATIC IT V6.3 SP1 A5E01504167-01

Preface

The principal language of the SIMATIC IT hotline is English. SIMATIC IT partners and customers covered by the Software Maintenance program are entitled to direct access to the TSS.

Access to the TSS

To be able to access the TSS, the customer needs to register as a user on the Technical Support Web site. Connect to http://www.siemens.com/mes-simaticit/ and follow the Technical Support Service link. The registration form must be completed with: Personal data The required company and plant information The Contract Number provided by Siemens Back Office when the contract is agreed.

Online Support
A customer who is a registered TSS user, can access the Technical Support Web site (http://www.siemens.com/mes-simaticit/tss), which contains technical information such as: Service conditions (Phone numbers, Working hours, Reaction times,) SIMATIC IT knowledge base: a technical support database that includes practical service solutions from the Technical Support or the SIMATIC IT community SIMATIC IT software (e.g. hot fixes, software examples) and release notes that can be downloaded SIMATIC IT cross-industry libraries that can be downloaded (limited access to SIMATIC IT certified partners) SIMATIC IT product documentation that can be downloaded Frequently Asked Questions and useful tips.

vi

SIMATIC IT V6.3 SP1 A5E01504167-01

Table of Contents
1 Introduction.......................................................................................................................... 1-1 1.1 What is SIMATIC IT Client Application Builder?............................................................ 1-1 1.2 Benefits of custom interfaces in the MES environment ................................................. 1-1 1.2.1 Data display and aggregation ...........................................................................1-1 1.2.2 An interface to support run-time operations......................................................1-1 1.2.3 Easy application distribution .............................................................................1-2 1.3 Sample scenario: Data aggregation and run-time interaction ....................................... 1-2 1.3.1 Description ........................................................................................................1-2 1.4 Overview of CAB features ............................................................................................. 1-3 1.4.1 Data retrieval.....................................................................................................1-3 1.4.2 GUI development ..............................................................................................1-3 1.4.3 Security Management .......................................................................................1-3 1.4.4 Production Modeler Integration.........................................................................1-3 1.4.5 Exchanging messages with other applications .................................................1-3 1.4.6 CAB Portal ........................................................................................................1-3 1.5 Additional documentation .............................................................................................. 1-4 2 Client Application Builder Architecture ............................................................................ 2-1 2.1 2.2 2.3 2.4 2.5 Overview ........................................................................................................................ 2-1 What is a Web Application?........................................................................................... 2-1 Multi-level architectures ................................................................................................. 2-1 Technology .................................................................................................................... 2-2 CAB Components .......................................................................................................... 2-3 2.5.1 CAB Engineering ..............................................................................................2-3 2.5.2 CAB Server .......................................................................................................2-3 2.5.3 CAB Web Server...............................................................................................2-3 2.5.4 CAB Client.........................................................................................................2-3 2.6 CAB data access strategies........................................................................................... 2-3 2.7 CAB security .................................................................................................................. 2-4 3 CAB Portal............................................................................................................................ 3-1 3.1 Overview ........................................................................................................................ 3-1 3.1.1 Faster and easier development ........................................................................3-1 3.1.2 Application reuse ..............................................................................................3-1 3.2 Features......................................................................................................................... 3-1 3.2.1 Modules for common functionalities .................................................................3-2 3.3 Architecture and workflow.............................................................................................. 3-2 3.3.1 Engineering CAB pages....................................................................................3-2 3.3.2 Adding pages to the CAB portal hierarchy........................................................3-2 3.3.3 User management ............................................................................................3-2 3.4 Additional documentation .............................................................................................. 3-3

SIMATIC IT V6.3 SP1 A5E01504167-01

vii

Introduction

1.1

What is SIMATIC IT Client Application Builder?

SIMATIC IT Client Application Builder (CAB) is a SIMATIC IT component which enables you to create MES-dedicated custom graphic user interfaces (GUI). Through these GUIs, users are able to: Aggregate and display production data (both real-time and historical) according to need Intervene while business logic is being executed in run-time Distribute applications simply and effectively

1.2
1.2.1

Benefits of custom interfaces in the MES environment

Data display and aggregation
The MES solution implemented by the SIMATIC IT software suite comprises several components. Each component handles the implementation of a specific subset of features defined by the S95 specification. Each component features its own user interface and manages its own set of data. An MES application must be able to display historical/statistic or run-time data from multiple components. Data may also need to be aggregated and manipulated according to specific scenario requirements. It is clear therefore that, due to the endless ways in which MES data can be aggregated and manipulated, no predefined user interface would be able to fulfill the requirements of all possible scenarios. SIMATIC IT CAB on the other hand allows users to aggregate and display data to best suit their needs, through tailor-made graphic user interfaces.

1.2.2

An interface to support run-time operations

In addition to customizing data display, plant operators are also provided with a run-time tool with which they can intervene in the logic of the production process to, for example: Carry out steps requiring user interaction before the process can continue Monitor potentially critical situations and react accordingly

SIMATIC IT V6.3 SP1 A5E01504167-01

1-1

Introduction Sample scenario: Data aggregation and run-time interaction

1.2.3

Easy application distribution

Because CAB applications are web applications, they can be applied to any machine on which Internet Explorer has been installed. All the other components required to execute the CAB application are downloaded from the web server the moment a user requests the application. This process is carried in accordance with the ZAC (Zero Administration Client) philosophy, i.e. no explicit installation is required on the client machine.

1.3

Sample scenario: Data aggregation and run-time interaction

So far we have discussed only theoretical benefits provided by CAB applications in support of SIMATIC IT-based MES solutions. This section covers how these concepts can be applied in a real-world scenario. We will be looking at both data aggregation and runtime interaction issues.

1.3.1

Description
Lets imagine a hypothetical company which has implemented a SIMATIC IT solution to manage production definition, production planning and order dispatching. In accordance with S-95 specifications these functionalities are implemented in SIMATIC IT by the following components: SIMATIC IT Product Definition Manager (PDefM) through which the steps in product manufacturing are defined. How these steps are defined is independent from the product itself, as dictated by S-95 specifications. SIMATIC IT Production Order Manager (POM) handles production planning and the dispatch of orders. Each of these components manages data independently and features its own graphic user interface despite the fact that their data are hosted on the same repository, the SIMATIC IT Components database. Our hypothetical customer needs a special tool which grants plant operators access to aggregated POM and PDefM data. Operators should also be able to trigger the dispatch of production orders. Specifically, our user needs access to: PPR (Product Production Rules, managed by PDefM) Orders (managed by POM) Entries (managed by POM)

A CAB application gives users a single interface with which they can perform all of the following operations: Display PPRs per finished products Select a PPR to display its relative orders Select an order to display its relative entries Dispatch selected orders

1-2

SIMATIC IT V6.3 SP1 A5E01504167-01

Introduction Overview of CAB features

1.4

Overview of CAB features

This section provides a brief overview of CABs main features.

1.4.1

Data retrieval
CAB facilitates the retrieval of data from various SIMATIC IT sources. There are two fundamental approaches to data retrieval: 'Connected' (COM) and 'Disconnected' (standard .NET approach to data management, implemented with ADO.NET). Which to use depends on a number of factors, the most important being the type of data source. For more information, see the section CAB data access strategy.

1.4.2

GUI development
CAB offers a set of graphic controls to enhance the capabilities of environment development; users can easily create powerful interfaces.

1.4.3

Security Management
Several objects are available for the management of CAB application security. These objects validate user credentials and set access levels for application pages and embedded controls. For more information see the section CAB security.

1.4.4

Production Modeler Integration

Several objects allow Production Modeler rules to be called easily from within CAB applications. Thanks to this Production Modeler integration, CAB application users can alter the execution of business logic during runtime.

1.4.5

Exchanging messages with other applications

The CAB Connector component interacts with SIMATIC IT Data Integration Service. DIS is service software for the exchange of messages between different types of applications, such as SAP, MQSeries, COM applications, WebServices, etc..

1.4.6

CAB Portal
SIMATIC IT 6.3 SP1 features the CAB Portal: a new and easier way to build CAB applications. Its main features: It provides centralized management of CAB users and applications. Allows you to customize the look of application pages by selecting a layout style.

SIMATIC IT V6.3 SP1 A5E01504167-01

1-3

Introduction Additional documentation The main benefit of CAB Portal is that it helps cut down application development time: several functionalities that once had to be developed explicitly (e.g. user authentication) are now managed directly by the portal. Moreover, CAB Portal allows existing applications to be reused more easily. For more information see the chapter CAB Portal.

1.5

Additional documentation
This document provides a functional and architectural overview of the SIMATIC IT Client Application Builder component. For more detailed architectural and development information, refer to the following materials: SIMATIC IT Client Application Builder online help contains detailed procedures to handle any implementation issue concerning CAB applications. It also features a reference guide for the public interfaces of CAB-specific classes. SIMATIC IT ASP.NET Best Practices manual has been developed under partnership with Microsoft. It provides useful suggestions to help ASP.NET programmers develop better applications. SIMATIC IT CAB Good Programming Practices manual comes with recommendations, code samples and CAB component descriptions so that you can get the most out of SIMATIC IT Client Application Builder. An architectural overview of CAB applications is also provided. It focuses on the differences between CAB and standard ASP.NET applications.

1-4

SIMATIC IT V6.3 SP1 A5E01504167-01

Client Application Builder Architecture

2.1

Overview
Applications created by means of SIMATIC IT Client Application Builder are webbased.

2.2

What is a Web Application?

A web application is a software application for which a web browser such as Internet Explorer is used to display a user interface on client machines. Web Applications use HTML (HyperText Markup Language) to interact with the user. This interaction implies sending the user HTML documents to which the user can then respond by filling out forms or following links, etc.. Each user action generates a new HTML document, which in turn prompts the user for other actions. Web Applications are intrinsically two-layer client-server applications for which both a web browser (client) and a web server are required. However, web applications differ from traditional two-layer client-server applications in that: Unlike client/server applications web applications generally require only web browser software to be installed on the client machine. Client are application-specific in client-server applications while a web browser can operate in any web application. A new installation is required whenever a client/server application is updated. With web applications updates are made only on the web server (centralization). Web applications are not limited to any specific operating system or version installed on clients. Once written they can be deployed almost anywhere, without having to create clients for each operating system. There is however one notable exception to this: if an Operating System's compiled code-specific objects (e.g. Microsoft ActiveX objects) are embedded in a web page, the web application will no longer be able to run on multiple Operating Systems.

2.3

Multi-level architectures
Typically web applications are built on a four-tiered architecture and rely on the HTTP protocol for communication between clients and servers. They can support technologies either lightweight (such as HTML) or non-lightweight (such as ActiveX) for returning data and user interaction. Software system logical architecture relies on multi-layer architectures distributed over a physical system spread out over multiple tiers (tiers are subsets of the physical system over which the application is distributed).

SIMATIC IT V6.3 SP1 A5E01504167-01

2-1

Client Application Builder Architecture Technology CAB extends the classic three-tiered SIMATIC IT model to a four-tiered architecture. In four-tiered architecture, a web server represents the additional tier, adding one computer to the tier count.

The application's user interface (UI) rests on the Client tier. In three-tiered architecture, the UI is furnished typically by the client components of the main application. In a four-tiered web-based architecture, the UI is delivered by standard Windows applications (generally a web browser) and/or ASP.NET technologies for browser-based interaction. The Web tier hosts the web server, i.e. the applications that deliver web pages. Scalability and fault-tolerance are handled via a Server Farm made up of a large number of parallel servers able to manage large numbers of clients. The Application tier implements the systems business functionality and contains business rules, data manipulation tools, etc.. The Data tier contains data access components which expose the data stored in databases to the Application tier.

2.4

Technology
The technology underlying SIMATIC IT CAB is ASP.NET. SIMATIC IT CAB employs Visual Studio .NET 2005 as its development environment. Visual Studio .NET 2005 features tools and plug-ins specifically designed for accessing and managing SIMATIC IT data. SIMATIC IT libraries can be used in conjunction with standard .NET classes.

Note The document does not aim at a full description of .NET technology nor does it provide technical details about the development of CAB applications For more information on these subjects see the following documents: - SIMATIC IT Client Application Builder online help - SIMATIC IT ASP.NET Best Practices manual

2-2

SIMATIC IT V6.3 SP1 A5E01504167-01

Client Application Builder Architecture CAB Components - SIMATIC IT Client Application Builder Good Programming Practices manual

2.5

CAB Components
SIMATIC IT Client Application Builder is a distributed solution implemented by means of the following modules: CAB Engineering CAB Server CAB Web Server CAB Client

2.5.1

CAB Engineering
In the CAB Engineering environment, CAB applications based on Visual Studio .NET are developed with both NET standard and SIMATIC IT specific objects.

2.5.2

CAB Server
CAB Server handles data exchange between the various SIMATIC IT data sources and the client. This module is invoked whenever SIMATIC IT data is retrieved in a connected scenario. Note For more information on how CAB applications retrieve SIMATIC IT data see the section CAB Data Access strategies.

2.5.3

CAB Web Server

This CAB Web Server module relies on Microsoft Internet Information Services and executes CAB applications when requested to do so by a client.

2.5.4

CAB Client
CAB Client is the end user environment. Via a web browser (typically Internet Explorer) it requests resources such as the display of a data set to the CAB Web Server.

2.6

CAB data access strategies

SIMATIC IT Client Application Builder adopts two approaches to data access and inter-component communication. Here we will be calling these two strategies 'Connected' and 'Disconnected'. The following table summarizes the features and architecture of both. It also indicates the preferred solution in various specific situations

SIMATIC IT V6.3 SP1 A5E01504167-01

2-3

Client Application Builder Architecture CAB security Strategy Connected Features Connection to the data source is always kept open. Data are updated withing graphic controls eliminating the need to refresh the web page. When to use it When automatic notification for a change of data source is required, i.e. when updates occur at great frequency (typically RTDS and PPA). The following sets of OCX controls rely on a CABconnected architecture: HDD, OEE/DTM, MM, POM, PRM, BPM, MSM, CS, SPC Dependent architecture CAB Item Data Source, a data source that is always connected. It reacts to data modifications and client events. CAB Item, a container for data retrieved by CAB Item Data Source. CABCC (CAB Communication Control), a control that keeps the connection between client and server open. CAB Graphic Components, a set of special graphics used to display data. Developed specifically for the connected strategy.

Disconnected

Connections to the data source or component are kept open only for the time required to retrieve data or call a component method. Retrieved data are then stored locally on the web server and the connection is closed. To check the data source for modifications a new connection must be opened.

When automatic notification of changes to the data source is not required. A web page refresh is required in order to display updated data. Applications built according to this strategy are not able to react to events unleashed beyond the client (i.e.new data added to the data source).

SQBDataSource, to query the data source ADO.NET objects (typically DataSets), to store data Graphic controls,such as a standard .NET datagrid to display data in the web page. PMConnector, opens a connection to Production Modeler thus allowing PM rules to be called from within a CAB application through components generated by PMRuleWizard.

2.7

CAB security
Security policies can be implemented in the CAB environment so that distinct access privileges can be granted to users of a given CAB application. User access security is managed through the application of two separate but inter-linked concepts: the Authentication mechanism verifies whether users are allowed to access CAB applications. The Authorization mechanism on the other hand verifies whether users are allowed to access certain individual pages of the application and/or specific controls and functionalities within these pages.

2-4

SIMATIC IT V6.3 SP1 A5E01504167-01

Client Application Builder Architecture CAB security CAB provides specific classes for security management and features the following: Web farm support Separate authentication/authorization management, which entails greater flexibility in application building. Authentication and authorization processes can be customized to suit particular application requirements.

SIMATIC IT V6.3 SP1 A5E01504167-01

2-5

CAB Portal

3.1

Overview
As of SIMATIC IT 6.3 SP1 a new environment called the CAB Portal has been made available for the development of a web-based graphical user interface to access SIMATIC IT data. The benefits of this CAB Portal are: CAB application can be developed quickly and easily. Application can be reused.

3.1.1

Faster and easier development

Thanks to CAB Portal, CAB applications can be developed more easily. The CAB Portal manages a set of common functionalities which were previously developed by the programmer. Therefore less coding is required from the developer who is now only responsible for application-specific issues such as specifying which data source is accessed and the graphic control to which it is bound. Less experienced users are now capable of developing CAB applications with ease, while expert developers can access all the features previously available in the CAB environment programmatically to suit specific application needs and advanced requirements.

3.1.2

Application reuse
The CAB Portal approach allows you to reuse applications thereby saving valuable development time. This approach involves the following: CAB application development no longer need begin from scratch as template applications which embed common functionalities are already provided. Users can customize these templates by developing and adding the features they need. Custom features can be moved across different applications easily thanks to the clean separation of logic and user interface that CAB Portal provides.

3.2

Features
In a single environment CAB Portal provides: an administration tool for users and applications security management. a client interface through which users access CAB applications in line with the permissions established by the CAB Portal administrator. Users can also customize the layout of the CAB Portal.

SIMATIC IT V6.3 SP1 A5E01504167-01

3-1

CAB Portal Architecture and workflow

3.2.1

Modules for common functionalities

As mentioned earlier, to save development time CAB Portal provides a set of common functionalities which are shared by all CAB applications. The following functionalities are covered by CAB Portal modules: User Authentication takes care of validating user credentials. User Authorization grants authenticated users proper permissions on CAB Portal resources, i.e. it defines access control for pages and page elements. Layout user profiling so that authenticated users can customize the CAB Portal: settings are saved and reinstated for successive user sessions. Multi-language support. CAB Portal provides a tool for configuring multiple language applications.

3.3

Architecture and workflow

SIMATIC IT CAB Portal is available as a Visual Studio 2005 solution. To ensure persistency, the following CAB portal information is stored on a proper database: Users definition Roles Applications User Personalizations

3.3.1

Engineering CAB pages

In the CAB Engineering environment CAB pages are created and engineered by means of Visual Studio 2005 SP1. Users can apply the functionalities offered through predefined modules provided with CAB Portal, or create custom code, or both.

3.3.2

Adding pages to the CAB portal hierarchy

Once a CAB page has been created in Visual Studio environment, it will have to be placed in the CAB Portal hierarchy. This action is carried from a CAB Client such as the Internet Explorer browser when the CAB Portal homepage is requested by the CAB Web Server host. Information is then stored on the CAB Portal database.

3.3.3

User management
Other essential administration functions include creating users and assigning them permissions on various CAB Portal resources. These actions can be carried out from CAB client when the CAB Portal homepage is requested by the CAB Web Server host. Information about users and their permissions are saved on the CAB Portal database. The architecture of CAB Portal solution and its workflow is outlined in the following image:
3-2 SIMATIC IT V6.3 SP1 A5E01504167-01

CAB Portal Additional documentation

3.4

Additional documentation
See the following for more information on CAB Portal installation, configuration and application development: CAB Portal Startup guide CAB Portal Advanced development manual CAB Portal Developer manual CAB Portal Reference guide

SIMATIC IT V6.3 SP1 A5E01504167-01

3-3