Appendix A, Installing a Plug-in Viewer describes the SMARTEAM – Editor menu.
Appendix B, Database Connection Manager describes how to create and modify connections to SMARTEAM databases.
Appendix C, Full Text Search (FTS) provides the ability to perform complex textual searches on data without knowing where that data is stored. Full Text Search enables you to perform searches on files within the vaults and on textual Meta data stored inside the database.
Complex textual searches include Boolean expressions (AND, OR) and also with the use of phonetic operators such as "sounds like".
Appendix D, Compare Tool Utility describes how to compare between two different tree structures, documents or parts/assemblies.
Appendix E, Recommended Options for the System Administrator provides a guide for the System Administrator of recommended settings to use when setting up SMARTEAM.
Chapter 1: Administrator Functionality
This chapter describes administrative functions that can be performed by the system administrator in the SMARTEAM - Editor.
Customizing SMARTEAM – Editor
The SMARTEAM – Editor application is completely customizable and flexible. It provides numerous options for you, the system administrator, to modify SMARTEAM – Editor to suit your user's needs.
Using the Data Model Designer, you can build a data structure based on one of the SMARTEAM – Editor templates, or you can create a completely new template. You can also modify the
SMARTEAM – Editor interface by modifying the layout of a Profile card, modifying SMARTEAM – Editor operations and creating new operations. Furthermore, SMARTEAM – Editor enables you to set up proper security authorizations.
SMARTEAM Administrative Tools
The following lists SMARTEAM – Editor administrative tools. The first group of tools are accesssed from the Start MenuProgram Files SMARTEAM Admininstrative Tools.
The second group of tools are accessed from the SMARTEAM - Editor Tools menu.
Click on the relevant links for a detailed description of each tool.
Icon Description
The Authentication Manager is an administrative tool that enables administrators to configure the behavior of the Session Management Service. The Authentication Manager enables the administrator to select the authentication protocol used throughout the organization as well as the necessary parameters required to the authentication protocol selected.
The Database Connection Manager allows you to connect SMARTEAM to supported databases. It manages your list of SMARTEAM databases. You use it to create and modify connections to SMARTEAM databases.
The Default Values Utility enables you to define default values for specified attributes in a SMARTEAM Class located on a Profile Card.
Chapter 1: Administrator Functionality SMARTEAM Administrative Tools
The Export utility enables you to export values from a SMARTEAM database in order to transfer them to another database. SMARTEAM – Editor facilitates the transfer of data between various systems.
The Flowchart Designer is an intuitive interface for designing flowcharts. Using the Flowchart Designer, you can create a detailed flowchart, save it and assign it to a Process in a step-by-step manner. See SMARTEAM - Workflow Online Help for details.
The Form Designer utility allows you to modify an existing Profile Card or create a new one. You can also modify the Single Object View that displays the desktop with one document (object) instead of a tree browser.
The LDAP/Active Directory Import Wizard enables you to import users of LDAP /Active Directory protocols and to authenticate them against the LDAP/Active Directory server. See Importing LDAP/Active Directory Users for details.
The Import utility enables you to import values for specified attributes in order to create new objects in the SMARTEAM database.
The Integration Tools Setup Utility enables you to map properties from several integration sources and standard Windows sources directly to an object's Profile Card. This provides users with the highest level of integration, enabling a bi-directional link from an integration/Windows property to the object's Profile Card and from a Profile Card to an integration/Windows property.
The Lifecycle Rules Setup defines rules for the Lifecycle operations on linked objects throughout a Lifecycle Operation (as a result of an operation performed on a specific object).
The Menu Editor utility enables the System Administrator or any individual SMARTEAM – Editor user to customize SMARTEAM – Editor menu or toolbar profiles by adding and removing menus, sub-menus, commands or (image) buttons. Changed or new menu profiles are saved in the SMARTEAM database and made accessible to the SMARTEAM menu system.
The Sequence Designer utility enables you to create mask names. A mask name is a formula by which SMARTEAM – Editor automatically increments a field in a Profile card. The Sequence Designer utility can also be accessed from the Form Designer utility in order to assign a mask formula to a field in the Profile card, and from the Import utility in order to generate values to assign to an attribute during the import process.
Script Maintenance enables you to modify a SMARTEAM – Editor operation by adding a macro before, after or instead of a default SMARTEAM – Editor operation. You can also create a completely new operation. The Script
Maintenance utility can also be accessed from the Form Designer utility in order to add a macro in the Profile card, and from the Import utility in order to modify an
Chapter 1: Administrator Functionality SMARTEAM Administrative Tools
The SMARTEAM - Web Editor Data Model Wizard enables you to customize data templates and create new data structures for SMARTEAM - Web Editor. See SMARTEAM - Web Editor Online Help for details.
The SMARTEAM Data Model Designer enables you to customize data templates and create new data structures and modify existing data structures for the
SMARTEAM products.
SMARTEAM - Web Editor Data Model Documentation Wizard.
The SMARTEAM System Configuration Services enables you to view the system configuration keys and modify their values. See the SMARTEAM System Configuration Services documentation for details.
SMARTEAM’s Translation Utility provides translations of different text entities into languages other than English, such as visual controls, profile cards, error messages, specific/unique database-related items, metadata, user data, system data.
The User Maintenance utility enables you to set up passwords and restrictions on various options. This function enables you to define new users and groups of users, as well as define authorizations and passwords for individual users or a group of users. These access permissions provide optimal security measures.
The Web Form Designer is used to design and modify the layout and content of profile cards for SMARTEAM – Web Editor. This function is usually performed by the system administrator.
The Workflow Manager provides the system administrator or supervisor with online viewing and monitoring of Processes. Using the Workflow Manager search tools, the system administrator can locate problematic Processes, and modify them to prevent further bottlenecks. See SMARTEAM - Workflow Online Help for details.
Chapter 1: Administrator Functionality SMARTEAM Administrative Tools
In addition to these tools, the following administrative tools appear under the SMARTEAM - Editor Tools menu:
Applications Setup
The Applications Setup function enables you to specify which external application will be launched per specific file type and specific operation (such asView/Edit). This allows you to edit files in the external application in which they were created. This function only needs to be performed the first time when a new external application is added to SMARTEAM – Editor.
Lookup Tables Lookup Tables are dropdown lists that appear in the Profile Card for a specific field, such as File Type. In the Lookup Table Utility, you can manage the possible values to appear in each lookup table.
Vault Maintenance
The Vault Maintenance option enables you to:
Set the vault (that is defined in Vault Server Setup) to be used per project, file type and object state.
Modify a vault definition.
Delete a vault definition.
Operations Setup
Displays the Operations window, enabling the System Administrator to change the name of SMARTEAM – Editor operations.
SMARTEAM File Explorer.
The SMARTEAM File Explorer is a utility that allows you to manage files in the workspace. See Collaborative CAD Design for details.
Chapter 2: Data Model Designer
IMPORTANT! This utility is applicable for SMARTEAM – Editor only and not for any of the SMARTEAM integrations.
This chapter contains:
Launching the Data Model Designer provides instructions for starting the Data Model Designer and describes the main window.
Available Databases presents the complete list of mechanisms available for a SMARTEAM database along with their descriptions.
Creating and Defining Classes provides instructions for creating or modifying a template by naming and defining all the Classes and sub-Classes of the SMARTEAM data structure.
Defining Indexes and Class Attributes provides instructions for creating and modifying the Attributes (fields) of each Class in the template. These Attributes will be displayed in the Profile Card of a selected object when SMARTEAM is implemented. This step also provides instructions for creating an index for the highest level Classes in SMARTEAM.
Defining Links and Link Attributes provides instructions for defining Link Classes and Attributes to be assigned to the link between any two data objects and their properties. These Attributes appear in the Links page of SMARTEAM – Editor.
Defining Class Composition provides instructions for defining the composition of each Class, i.e., the sub-Classes that can be added to a selected Class in SMARTEAM – Editor.
Creating and Modifying a Form provides instructions for creating and modifying a form, the layout for the Profile Card in SMARTEAM – Editor.
Creating a SMARTEAM Database Structure provides instructions for creating the
SMARTEAM database structure based on the template defined in the Data Model Designer.
Multi-language Support describes how to use a different language interface in the Data Model Designer and how to select multi-language support in the destination database.
The Data Model Designer Menu Bar describes each option displayed in the menu bar.
Building a SMARTEAM Structure
The Data Model Designer enables you to build a SMARTEAM database structure precisely suited to your needs, and provides numerous Templates for your selection. Each SMARTEAM template is a complete definition of a SMARTEAM data structure. It provides different structures for various work environments, such as mechanical engineering, office automation or process organizations.
You can select one of these templates and use it as is or customize it to suit the needs of your organization. You can also create a new template of your own.
Chapter 2: Data Model Designer Sample Data Model Structure
The Data Model Designer offers you a ready-to-use, template together with complete flexibility to create new templates. A SMARTEAM data structure encompasses all the Classes and sub-Classes, including the definitions, attributes and composition assigned to each Class.
The Data Model Designer provides various options to enable you to create a data structure for your own specific business requirements. You can:
Use the database supplied with the installation (e.g., SmDemo) or modify it for your own requirements, by adding new Classes, changing/deleting existing Classes and attributes, etc. If you modify an existing database without deleting a Class, you can keep all objects stored in the database.
Load a template (WizSrc) to create a new database. (When you define a destination database, the new database will be empty.)
Load a template from another database. You can then change the template and create a new database. This new database will be empty.
Click the Create button to create the database. The new database can be displayed by selecting it from the Available Databases window. This window is displayed by selecting the Switch to Database option from the SMARTEAM – Editor File menu.
To further enhance the data structure, SMARTEAM provides the Sequence Designer utility. This utility enables you to add a mask name to the Profile Card; refer to Assigning a Mask Name. (A mask name is a formula that SMARTEAM uses to automatically increment a number for a specific field in the Profile Card.)
The Data Model Designer provides a completely flexible environment in which you define any hierarchy to suit your needs. The Classes are displayed in a ready-made template and can be used in your SMARTEAM database, as is and can be modified according to your needs.
With the Data Model Designer, you can define the characteristics, properties and behavior of each object and determine the exact attributes and size of the objects. For example, you can define a Class called Parts, and then define different kinds of parts (sub-Classes) for your exact
specifications. Furthermore, the Data Model Designer provides the freedom to design the user interface using various fonts, colors and layouts.
When you select the Create option, SMARTEAM automatically creates the data structure based on the template currently defined in the Data Model Designer. When you reopen the SMARTEAM – Editor application, it displays the newly created data structure. Refer to Creating a SMARTEAM Database Structure for further details.
Before starting the Data Model Designer, we recommend that you carefully organize the data structure you want to create. Sample Data Model Structure provides an explanation to help you organize your planned data structure.
Sample Data Model Structure
The Data Model Designer enables you to build a SMARTEAM database structure according to your exact specifications. The Data Model Designer provides numerous templates. Each SMARTEAM template is a complete definition of a SMARTEAM data structure.
Chapter 2: Data Model Designer Sample Data Model Structure
Getting Started: The Data Model
A data model is the abstract SMARTEAM data structure. It consists of object types (Classes) and the relationship between those types. Even though the data model is stored in a database, a distinction should be made between the two. Records are physical entities in a relational-database table, whereas objects are abstract entities in an object-oriented data model.
Basic Concepts Object
An object can be a physical object, a computer file, a person, etc. It is described by a set of properties called attributes. For example, an object of type person may have a Height attribute.
An object's attributes, behavior and identity are defined in its class.
Class
A class is a type of object. For example, you are an object of a Class defined as Person. An Object is an instance of a Class. You, in fact, are an instance of a Person.
A Class is set of objects that share common structure and common attributes. Every engineering entity is an object that can be classified.
Super Class
A Super Class is a special type of class. It is the topmost class in any class tree.
Inheritance
A Class can have Subclasses. A Subclass inherits the attributes of its parent Class, as well as other information called methods.
The following example illustrates the advantages of defining Classes in an inherited tree structure.
Throughout this example, the following symbols are used:
= Object = Class Creating objects
To explain these concepts we will assume a major automobile manufacturer is building a new line of cars called Swift.
Swift consists of various components, some of which are shown below. Each component is a SMARTEAM object.
Swift Front Wheel Rear Wheel Motor
Chapter 2: Data Model Designer Sample Data Model Structure
Creating an object tree
The Swift can now be assembled into an object tree, representing the physical car, as follows:
Defining a class for each object
Each object in the Swift object tree has a type, or is an instance of a Class. The following list shows the Class of each object, together with a few basic attributes that define that object.
Creating a new object
The same company may also be manufacturing motorcycles, named Rider. The Rider and corresponding Class definition can be defined as follows:
As a result, a new Class structure must be defined.
A Class consists of a Profile Card, an icon and attributes, each of which has a type and size.
Furthermore, a Class may have queries, authorization, and scripts defined for it.
Note: The car and the motorcycle Classes have the same attributes. This attribute infor-mation can be reused and inherited by sub-classes.
Convert the Class into a Class Tree
The Class details can be structured to form a Class Tree, as follows.
As a result, abstract classes called Item and Vehicle are created. Objects cannot be created from these Classes. They are created for the sole purpose of reusing their attributes in multiple Classes.
Note: This Class tree is not an Object tree. The Class tree cannot represent assembly relationships between objects; it does not even contain objects.
Summary
The advantage of structuring Classes as a tree is the ability to inherit information. This enables reuse of information, such as attributes, queries, user authorization, scripts, masks, and more.
Chapter 2: Data Model Designer Launching the Data Model Designer
Launching the Data Model Designer
This section describes:
Starting the Data Model Designer
The Data Model Designer window To start the Data Model Designer:
1 From the Start button on the taskbar select Programs, SMARTEAM, Administrative Tools, SMARTEAM Data Model Designer.
The SMARTEAM Data Model Designer window is displayed.
Creates the SmarTeam database from the selected template Loads the
selected template
Lo
Available templates
Data Model Designer Menu Bar
Selected template icon Description of the selected template
Chapter 2: Data Model Designer Launching the Data Model Designer
The SMARTEAM Data Model window contains:
The control buttons available depends on the Data Model Designer mode:
Working with templates (for creating new destination database)
Modifying an existing database Working with Templates
In this mode, the right pane, Supported Languages, includes a list of languages that will be supported in the destination database after it has been created.
When the selected template supports additional languages, the left pane will display a list of languages that can be selected and added to the destination database. To add a language to the destination database, select the language in the Multi Language Support pane and click Add. To remove a language from the destination database, select the language in the Supported Languages pane and click Remove.
Modifying the Existing Database
In this mode, the right pane includes languages that already exist in the destination database and languages that will be added by the current Data Model Designer session.
The Multi Language Support pane displays a list of available languages. Select a language and click on the Add button to add a new language to the Supported Languages pane (the destination database). To remove a language from the Supported Languages pane, select the language and click Undo Add.
In the Supported Languages pane, you can carry out specific options when you select a language and click on the dropdown arrow:
Button Description
Load Loads a selected template.
Close Closes the Data Model Designer and allows you to save or discard any changes.
Next/Prev Allows you to move forward/backward through the Data Model Designer utility.
Create Creates a SMARTEAM database structure based on the selected template.
Help Displays online Help for the current window.
Chapter 2: Data Model Designer Launching the Data Model Designer
2 Click Next to progress to the Classes window. In this window, the defined Classes and sub-Classes of the selected template are displayed.
Create Creates a language that does not exist in the destination database. (This is the only available action for languages added to the right pane in the current Data Model
Create Creates a language that does not exist in the destination database. (This is the only available action for languages added to the right pane in the current Data Model