Report Studio
HOPEX Report Studio Introduction
HOPEX Report Studio vs Java report
Connecting to HOPEX Report Studio Desktop
HOPEX Report Studio Desktop
HOPEX Report Studio Navigation Panes
Studio navigation pane
Report DataSet Definition
Introduction to Report DataSet Definition
Creating and Defining a Report DataSet Definition: the Big Picture
Report DataSet Definition Best Practices
Defining the Report DataSet Definition
Optimizing the Report DataSet Definition for better performance
Checking the Report DataSet row count
Report DataSet Definition creation
Accessing the Report DataSet Definitions
Accessing the Report DataSet Definitions from HOPEX (Web Front-End)
Accessing the Report DataSet Definitions from HOPEX (Windows Front-End)
Creating a Report DataSet Definition
Adding parameters to filter data extraction
Adding Property parameters
Adding Collection parameters
Defining how to populate the Report DataSet
Defining the data that feeds the Report DataSet
Defining the data that feeds the Report DataSet: drag and drop
Defining the data that feeds the Report DataSet: computed Property
Defining the data that feeds the Report DataSet: collection count Property
Previewing the Report DataSet
Customizing the Report DataSet
Modifying the display order of the Report DataSet columns
Hiding a column of the Report DataSet
Modifying the name of a Report DataSet column header
Speeding up the Report DataSet display
How To
How to add a column in a Report DataSet?
How to hide a column in a Report DataSet?
How to duplicate a Report DataSet Definition?
How to add a Report DataSet in an object Property pages?
Use cases
Common use case of Report DataSet Definition
Advanced use case of Report DataSet Definition: Applications of a Portfolio
Report DataSet creation
Creating a Report DataSet
Creating a Report DataSet (from Enterprise Architecture Desktops)
Creating a Report DataSet (from HOPEX Solutions)
Handling the Report DataSet
Report Template Definition
Report Template Introduction
Report Template and Report Chapters
Report Chapter and Macro or Report Data Views
Report Chapter and macro
Report Chapter and Report Data Views
Report Data View types
Report Style
Report Template Definition
Accessing the Report Templates and their Constituents
Accessing the Report Templates and their constituents in HOPEX (Web Front-End)
Accessing the Report Templates in HOPEX (Windows Front-End)
Report Template Properties
Characteristics
Parameters
Chapters
Report Template Edition
Permissions
Advanced
Extensions
Report Chapter Properties
Characteristics
Definitions (for Report Chapters based on Report Data Views)
Filters Binding (for Report Chapters based on Report Data Views)
Report Container Properties
Characteristics
Report Data View properties
Characteristics
Filter
Style
Chart
Matrix (Report Matrix View)
Table (Report Table View)
Report Table Column Properties
Characteristics
Conditional style
Report Style Condition Properties
Condition on value
Complex condition embedding a MetaTest
Condition on a report element regardless of its content
Report Style Properties
Characteristics
Definition
Report Template Creation
Creating a Report Template
Creating a Report Template using a Report Data View
Creating a Report Template using a macro
Creating a Report Template from an Instant Report
Creating a Report Data View
Adding a Report Chapter to a Report Template
How to
How to save an Instant Report as a Report Data View?
How to find information regarding JAVA macros?
How to define Parameters in a Report Template?
Defining parameters in a Report Template based on a macro
Defining parameters in a Report Template based on Data Views
How to Modify a Report Data View?
How to Group Report Data Views in a Report Chapter?
Grouping Report Data Views of a Report Chapter
Creating a Report Chapter with grouped Report Data Views
How to Add a Conditional Style on a Column?
How to Define the filters displayed in a Report?
How to Add Sub-totals in a Table Break?
How to Duplicate a Report Template?
How to Duplicate a Report Data View?
How to Add Reports in an Object Property Pages?
How to Make a Report Creation Available to an Object List?
How to customize availability of reports?
Customizing a Report Template
Managing a report snapshot
Organizing the Report Chapters
Customizing the Report Chapter export format
Customizing Parameter Display
Grouping parameters (order field)
Defining object display order in generated reports
Customizing the Report Container Group display
Customizing a Report Color Palette
Customizing a Report Template Style
Customizing a report icon
Report Template examples
Report Template example with a Report Chapter based on a Report DataSet
Report Template example with Report chapters based on macros
Writing Java report renderers
Introduction and prerequisites
Renderer modeling
Renderer implementation
Interface to implement
Implementation example
HTML Renderer Code
PDF Renderer Code
Example result
Using your implementation from the MEGA Renderer Macro
Compile
Configuring the macro
Writing Java report chapters
Introduction to Java report chapters
Generalities
Data and view separation
Prerequisites
Report modeling
Setup a Java development environment
Referencing jars and javadoc
Writing the macro implementation
Interfaces to implement
Report chapters
Callbacks
Implementing the macro
General steps
Example
Going further
Using your implementation from the MEGA Report Macro
Compile
Configure the Macro
Code Example
Demo 1: Charts using 2D datasets
Demo 2: Parameters in tables with vertical headers
Demo 3: Pie chart
Demo 4: Bubble chart
Demo 5: Simple Gantt chart
Demo 6: Tree of parameters
Demo 7: Clickable diagrams
Demo 8: Clickable illustrating diagrams
Customizing Documentation
Customizing Reports (MS Word)
Report (MS Word) Customization Functions
Report (MS Word) storage
Use of MS Word
Contents of Generated Reports (MS Word)
Report (MS Word) Generation Steps
Creating a Report Template (MS Word)
Modifying a Report Template (MS Word)
Entering text in your MS Word report template
Inserting Report Template (MS Word) Elements
Deleting a Report Template (MS Word) Element
Replacing a Report Template (MS Word) Element
Backing Up a Report Template (MS Word)
Private and Public Report Templates (MS Word)
Making report templates (MS Word) available
Making a private report remplate (MS Word) public
Making a report remplate (MS Word) private
Deleting Private Report Templates (MS Word)
Customizing Report (MS Word) Sending
Customizing RTF Descriptors
Creating RTF Descriptors
RTF descriptor categories
Creating a Descriptor
Descriptors and Inherited Objects
Defining descriptors
Accessing the descriptor structure
Adding Text to a Descriptor
Creating Groups
Adding Text to a Group
Specifying text execution conditions
Executing Descriptors
Executing a descriptor
Re-executing the descriptor from memorized objects
Advanced Features of RTF Descriptors
Modifying Descriptors
Duplicating Descriptors
Modifying the Order of Groups and Texts in Descriptors
Using Block Types
Using Macros
Adding a macro
Macro principle
Macro availability
Macros example
Taking inheritance into account in macros
Adding a Diagram
Adding existing descriptors
Creating descriptors directly in the descriptor editor tree
Using Groups
Reusing an existing group
Deleting a Group
Modifying a group properties
Defining the Object Order in Reports (MS Word)
Modifying Text
Adding the Image of an Object
Showing Metamodel Names
Showing a characteristic name
Showing the object type
Summary regarding metamodel names
Component Drag-and-Drop
Taking inheritance into account in texts with components
Defining Text Formats
Specifying Text Language (Multilingual Context)
Text editing conditions
Data derived exclusively from MEGA
Inserting Tables into Text
Adding External References in a Descriptor
Checking Descriptor Validity
Managing Formats and Styles
Reproducing RTF Text Formats
Standardizing Formatting
Reproducing character formatting
Reproducing paragraph formatting
Standardizing formatting in Web sites
Keeping Formatting Applied in the Text Editor
Character formatting reproduction
Reproducing paragraph formatting
How to keep RTF text formatting
Formatting and Objects Not Supported by HOPEX
Customizing Styles
Presentation
Styles
Style sheet
Structure of HOPEX Styles
Creating and Modifying Styles
Modifying a style
Creating a new style
Attaching a style sheet
Customizing the default style sheet
Applying styles in a descriptor
Synchronizing styles in a report template (MS Word)
Description of Default Styles (MegaStyl620.dot)
Titles
Texts
Tables
Drawing
Customizing Business Documents
Managing Business Documents
Prerequisites
Defining the Business Document Storage Directory
Classifying Business Documents
Creating a Business Document Category
Creating a Business Document Pattern
Defining Business Document Objects
Modifying Document Behavior
Customizing Web Sites
Creating a Web Site
About Web sites
Creating a Web Site
Defining Web Site Composition
Defining Objects
Adding an object
Adding an object list
Adding Pages
Text formatting
Modifying pages
Adding Index Pages
Generating a Web Site
Contents of a Generated Web Site
Home page
Site map
Index pages
Pages specific to each object
Web Site Folders and Files
Home page and site map
Using a Web Site Template
Creating a Web Site Template
Adding Pages
Selecting Objects
Creating a Web Site from a Web Site Template
Creating a Web Site Template from a Web Site
Duplicating a Web Site Template
Configuring Web Sites
About Web Site Configuration
Level 1: HTML descriptor configuration
Level 2: Script formatters configuration
Modifying Web Site/Web Site Template General Characteristics
Configuring Page Setup
Characteristics
Section titles
Menu presentation
Web site hosting
Modifying Logos, Bullets and Fonts
Details concerning background images, colors, fonts and links
Modifying Image Format
SVG format
Configuring Web Site Pages
Web Site Page, Characteristics tab
Web Site Page, Menu & Frame Tab
Managing Web Sites: Advanced Functions
HTML Concepts
Presentation
Use
Tags
Structure of HTML Documents
Hyperlinks
Other HTML Tags
Using Frames
Style Sheets
Style Sheet Presentation
Defining Styles
Styles Available in "Neutral.css"
Modifying Style Sheet .css
Modifying contents page parameters
Modifying menu parameters
Example of .css configuration
Managing Web Site Files
Generated File and Folder Structure
Configuring User Options
Checking File Names
Object identifier
File naming rules
Respecting specific naming rules
Index page naming rules
Image naming rules
Integrating External References
External reference integration standard mode
External reference management configuration
Macro content
Modifying Home Page and Site Map Files
Parameters used in generation files
Checking Web Site Generation
Generation Report
Checking Web Site Validity
Using HTML Descriptors
HTML Descriptors Overview
Accessing HTML descriptors
HTML descriptor editor
Icon specific to the HTML descriptor editor
Taking account of inheritance in HTML descriptors
HTML Descriptor Structure
Using several groups and texts
Using a single text
Displaying the HTML Descriptor Execution Result
Executing the descriptor independently
Integrating the HTML descriptor in a Web site
Editing HTML Descriptors from a Web Site
Editing HTML descriptor header and body
Defining a descriptor with complete page generation
Syntax of HTML Sources
Short form
Extended form
Remarks on syntax of HTML sources
Tags Specific to HTML Descriptors
Property Tag (P)
Layout (LY)
Bookmark (BMK)
Link (LNK)
Menu (MNU)
Target
PictureFormat
Component Tag (C)
Enter the query in the tag
Sorting a list by attribute
Displaying objects that produce pages
Using an abstract link
Component Properties (CP)
Number of Components (CL and CLP)
Drawing Tag (Draw)
Link
SvgBubble
Interlinked Components
WebObjectCollection (WOC) Tag
Workflow (WF) Tag
Context Tag
[Context=WebSiteHexaIdAbs/]
[Context=GlobalWebSiteDescriptor/]
ObjectPicture Tag
Using Settings
Menu Bar Configuration
Modifying title style
Inserting a bullet before a title
Inserting HTML code
Recovering the template of a _Code Template
Accessing Object, Home and Site Map Pages
Examples
Checking Object Availability
Conditioning HTML Tag Editing
Using the tag [If]
HTML Source Text Setup
Specific Uses of HTML Descriptors
HTML Descriptors and Multilanguage
Settings
Syntax
Inserting an e-mail Address in a Web Site
Creating a Buffer
Copying an image in the generation folder
Accessing _Code Template Properties
Defining the Same Header for All Web Sites
HTML Descriptors for Dynamic Web Sites
Displaying a MEGA Metatree As a Web Tree
Parameter
ContainerVisible
ContainerCollapsible
ContainerCollapsed
NavigateToObjectPage
ShowRoot
ShowTitle
Adding Favorites Page URL Access
Code to define URL in menus
Adding Search Page URL Access
Example code to define URL in menus
Adding RFC Page URL Access
Example code to define URL in menus
Adding Logout Page URL Access
Example code to define URL in our menus
Adding an Attribute to Property and ComponentProperty Tags
Customizing Diagrams
Creating and Editing Shapes
Shapes Editor and Shapes
Opening the Shapes Editor
Shapes Editor toolbars
Editing Shapes
Additional remarks on shapes
Exchanging files with other software
Exporting drawings
Importing drawings
Shapes Used in Diagrams
Tips on Using Shapes
Avoiding split shapes
Initial size
Optimal distortion
Aligning links
Optimizing performance
Reinitializing Shapes
Positioning Objects in a Shape
Identifying Elementary Objects
Modifying Code Generation Specifications
Shape height and width
Positioning of the object in its square
Object deformation
Code Generation
Tips on Deformation Code Generation
Name the fields
Draw accurately
MEGA Shapes Programming
Shape Storage
Shape Editing
Method Shapes
Shape Families
Calculated Fields
Default Deformation
Proportional Deformation
Text Fields Deformation
External Text Fields
Programmed Deformation
Deformation Code Editor
Object Identification
Basic Object Identification
Identifying Calculated Fields
Virtual Object Identification
Language Syntax
Programming
Calculated Field Programming
General Programming Recommendations
Default Code
Examples
Shape With Fixed Size Object
Shape With Calculated Field
Shape With Pictogram
Shape With Calculated Field and Pictogram Juxtaposed
Column Shape
Shape With Title Below
Docking Area
Position of Anchor Point at Creation
Configuring Diagrams
Diagram Types
Accessing Diagram Types
Creating a Diagram Type
Configuring a Diagram Type
Concepts
Concept names: equivalence table
Configuration Example: flowchart
Creating and Backing Up a Diagram Configuration
Using a New MetaClass in a Diagram
Creating a view in a diagram type
Adding a MetaClass to a view
Defining a shape for the new MetaClass
Defining a field in the new shape
Configuring MetaAssociations
Creating a MetaAssociation
Configuring link display
Adding a Zoom to a Diagram Type
Customizing the Metamodel
Introduction to Studio
Presentation of Studio
Managing the Metamodel
Introduction to Metamodel Management
Metamodel Extensions and Modifications
Warning Concerning Metamodel Modification
Metamodel extensions backup
Transferring metamodel extensions
Compiling the environment
Restrictions
Implementation conditions
Precautions Concerning Metamodel Extensions
Concepts
Concept names
Metamodel diagram
Vocabulary used
Creating Metamodel Extensions: Method
How to Create Metamodel Extensions
Extensions Backup
The Metamodel Diagram
Creating a Metamodel Diagram
Placing a MetaClass in a Metamodel Diagram
Placing a MetaAssociation
MetaClasses
Creating a MetaClass (Object Type)
Restricting the names of object types
Typing a MetaClass
MetaAssociations
Creating a MetaAssociation
Reversing Major/Minor Orientation
Modifying Object Protection
Imposing MetaAssociation Uniqueness
Specifying MetaAssociation Behavior
MetaAssociationTypes
MetaAssociation Types Kept to Maintain Compatibility
MetaAssociationTypes around a diagram
Other MetaAssociationTypes
Processing MetaAssociationTypes
MetaAttributes
MetaAttribute Characteristics
MetaAttribute Type
MetaAttribute Format
MetaText Format
MetaAttribute Definition Rules
Creating a MetaAttribute
Defining a tabulated characteristic
MetaAttribute with unique index
Editing MetaAttribute Tabulated Values
Using VB Scripts to Calculate Characteristics
Connecting Attributes to a MetaClass
Connecting Attributes to MetaAssociations
Customizing MetaAttributes
Excluding MetaAttribute values from a reporting Datamart
Making MetaAttributes not available for annotation
Abbreviations
Standard Attributes
Abstract Metamodel
Basic Concepts
Managing Abstract MetaClasses
Creating an abstract MetaClass
Inheritance relationships
Managing Generic MetaAssociations
Managing MetaAssociation inheritance
Accessing inherited MetaAssociations
Adapting Development Tools to the Abstract Metamodel
Properties pages
Abstract metamodel diagrams
Query Tool
Evolution of APIs
Accessing abstract MetaClasses
Notions of class and collection description
Abstract Metamodel Extension Recommendations
Perimeters
Introduction to Perimeters
MetaTool
Propagation
Scope
Propagation example
Viewing MetaAssociation Behavior Related to a Perimeter
Modifying the MetaAssociation Behavior Related to a Perimeter
Creating a Perimeter
Using a Perimeter in a MetaTool
Modifying the MetaTool Default Perimeter
Customizing a Standard Perimeter
Namespaces
Managing Namespaces
Defining Namespaces
Canceling Namespaces
Ownership and Use Links
Problems At Import
Problems Encountered At Import
Text format
Open transactions
Dash at the beginning of commands
End-of-file character within the commands
Translating the Metamodel
Translating and Compiling Environments
Renaming HOPEX Concepts
Defining a Terminology
Creating a Terminology
Inheriting a Terminology
Creating a language for a Terminology
Specifying all the profiles associated with a Terminology
Connecting MetaPictures of concepts
Managing profiles associated with several Terminologies
Adding a Terminology to a profile
Defining the priority Terminology
Renaming Concepts
Changing a concept name for a specific Terminology language
Changing translatable fields of a concept
Concepts that can be renamed
Metamodel Syntax in Command Files
Creating MetaClasses
Typing MetaClasses
Creating MetaAssociations
Reversing MetaAssociation Orientation
Modifying Link Type
Modifying Object Protection
Modifying Link Behavior for a Given Operator
Creating Characteristics
Creating a text type characteristic
Creating a tabulated MetaAttribute
Creating a unique index MetaAttribute
Connecting a MetaAttribute to a MetaClass
Connecting a MetaAttribute to a MetaAssociationEnd
Creating an abbreviation
Query Syntax
Query General Syntax: Select
Query notation
Query structure
Query comments
Query settings
Queries containing several selects
List of Query Operators
Checking Syntax and Getting Help
Result: Into
Condition: Where
Sub-query: In
Browsing the Metamodel
Reminder on MetaAssociationEnd names
Conditions on Object Characteristics
Wildcards
Conditions on Links
Link existence condition: Null, Unique and Having count
Link characteristic condition
Source object characteristic condition
Browsing reflexive links Deeply
Grouped conditions
Sets: From
Set Operations
Query Tips and Examples
Tips on Using Queries
Different queries and the same result
Tips with "and", "not" and "or" operators
Other query examples
Examples of Queries for MEGA Process
Creating Consistency Checks
Reminder: Rules Operation Principle
Displaying check results
Rules and check descriptors
Regulations
Displaying regulations
Activating a regulation
Defining rules of a regulation
Regulation application scope
Rule Properties
Rule Application Scope
Restricting application scope
Extending application scope
Conditioning application of a rule
Rule Implementation
Implementing a Rule by a Test or Tests
Implementing a Rule by a Macro
Implementing Test or Macro?
Using tests
Using macros
Defining an Implementation Test
Defining an Implementation Test By an Expression
Expression and logical operator
Comparison attribute and operator
Function ItemCount() and comparison operator
Functions TrueForEach() and TrueForOne()
Other available functions
Taking account of inheritance in tests
Defining an Implementation Test By a Macro
How to make a concept variable
Summary
Variability
Inheritance
Inheritance Setting
Substitution
Perimeters
Introduction to perimeters
Principle
Configuration
Defining a MetaTool
"Export" MetaTool
"Compare and align" MetaTool
Building a set by propagation
Root objects list
Set of objects
Set of links
Creating a perimeter
Customizing a Standard perimeter
Configuring a perimeter
Using a perimeter in a MetaTool
Default perimeter in a MetaTool
Configuring perimeter links
"Compare and align" MetaTool filter
Technical installation
Filtering MetaAttributes
Filtering MetaClasses and MetaAssociations
Standard configuration
Compare Tool API (to compare and align)
Implementation to VbScript
Attributes
Methods
Sample (VBScript)
Sample (Java)
Export Tool API (to Export)
Implementation to VbScript
Attributes
Methods
Remarks
Sample
Implementation to JAVA
Constructor Detail
Method Detail
Sample
Customizing the User Interface
Forms
Introduction
What is FORMS?
Accessing forms
FORMS and wizards
Specification of a form for a MEGA MetaClass
Metamodel
Standard form
General principles
Attribute groups and MetaAttributeGroups
MetaClass properties pages
Property page filtering according to product
Pages relating to MetaAttributes of MetaAssociations
Form defined by a ViewPort
Implementing page filtering
Implementing a Page Loader
Overloading standard tabs
Overloading form behavior
Generated form
Page general parameterization
Page name and order number
Page active by default
Filtering a page as a function of the object
FORMS properties page design
Basic principles and initialization
Properties page logic model
AttributeControl
Maps
Groups
Specifying templates
Syntax
Other options of standard pages
Synchronized pages - Immediate pages
Programmatic access to forms
Executing a form by API
Access interface
Dialog Handler
UpdateTools
AttributeControl types
Implicit AttributeControls
Explicit AttributeControls
Composite AttributeControls
Appendix: Compatibility
Forms - Property Pages - Tutorial
Objective
Initializing the courseware
Object standard Properties pages
Object Properties pages customization principles
Moving attributes using a MetaAttributeGoup
Grouping pages as subtabs
Reordering pages
Defining a new page displaying a non-standard element
Adding a non-standard element in the Characteristics page
Adding non-standard elements in a page
ListView: view as list
TreeView: view as tree
Viewer: HTML formatter display
HelpComment: help comment display
SubPage: page in page display
Displaying elements from another object
Direct display of an associated object
Displaying an object from a selection
Modifying customized page appearance
Modifying element title
Regrouping elements
Modifying element order
Modifying element size
Modifying element positioning and resizing
Modifying element appearance and behavior
Modifying page behavior
Hiding a page
Conditions on page elements
Redefining page template content
Forms – Wizard Implementation - Tutorial
Objective
Initializing the courseware
Customizing a creation wizard
Prerequisites
Adding properties in the standard creation page
Adding processing code to a creation wizard
Creating a wizard and its trigger
Trigger interface description
Wizard default page
Wizard context: MegaWizardContext interface
Dynamic addition of a property in the default page
Adding a processing in the wizard
Testing the wizard
Adding independent triggers
Defining new pages in a creation wizard
Calling a wizard by specifying a context
Calling a wizard - configuring properties of the object to be created
Specific context elements: cookies
External addition of pages and triggers
Creation wizard static configuration
Default page configuration
Wizard execution configuration
Wizard execution check
Filtering and conditioning of wizard page sequencing
Identifying wizard pages
Modifying page sequencing
Check before termination
Reuse mode: implementing an addition wizard
Dynamic customization of the wizard user interface
Wizard specific use and display data
Defining a collaboration between the wizard and its pages
Defining an informal query
Initializing collaboration cookies
Wizards on abstract MetaClasses
Interactive tool based on a MEGA wizard
Differences from a creation wizard
system process call
Configuring a wizard
Appendices
Wizard execution tracking
Wizard button dynamic activation
Versatile Desktop
Versatile Desktop Introduction
Aim
Public concerned
Versatile Desktop Overview
Diagram
Elements of a work environment
Metamodel
Desktop configuration
Desktop component elements
Container types
Container of Sub-Containers
Border Layout
Accordion
TabPanel
Portal
Vbox and Hbox
Container attributes
Container specific behaviors (Mode)
Tools
Creating a desktop
Creating a desktop from scratch
Creating a desktop from a model
Creating Desktop Containers
Creating a Desktop Container of Border Layout type
Creating the Center Container of a Border Layout Container
Creating the Bottom Container of a Border Layout Container
Creating a Desktop Container of Accordion type
Creating a Desktop Container of TabPanel type
Creating a Desktop Container of Tool type
Completing Desktop Container creation
Defining Container characteristics
Customizing Containers
Giving a title and/or icon dynamically to a Container
Defining Container dimensions
Defining Container behavior
Defining Container candidates
Defining Container affinities
Defining desktop characteristics
Defining the desktop characteristics
Modifying the desktop connection configurations
Configuring the desktop
Creating pop-up menus on an object
Restricting a command to a specific desktop
Examples of macros
Creating commands of a MetaClass
Implementing a group of dynamic commands
Configuring click (left)
Configuring behavior on an event
Creating a toolbar
Creating your toolbar structure
Creating toolbar tool groups
Configuring toolbar tool group display
Defining toolbar tool group commands
Configuring toolbar commands display
Command group configuration examples
Customizing the Desktop style sheet
Modifying the Desktop style sheet
Customizing icons for a specific style sheet
Defining a context-specific display for a Desktop Container
Modifying a desktop
Adding a Desktop Container to a desktop
Deleting a Desktop Container from a desktop
Modifying the position of a tool group in the toolbar
Action following event
Managing tool update as a function of current
Managing an action following an interaction
Using a Working Environment Template (WET)
Working Environment Template Overview
WET-based connection diagram
WET-based desktop principle
WET-based desktop example
WET-based desktop creation and customization main steps
Advanced configuration
Elements of a WET-based Desktop
Accessing the properties of the Metamodel elements related to a WET
WET metamodel
Creating a Working Environment Template
WET properties
Creating a WET
Defining the WET characteristics
Defining a Homepage for a WET
Adding Navigation panes to a WET
Working Environment Group Template characteristics
Creating a Working Environment Group Template
Adding a Navigation pane to a WET
Defining a Navigation Pane (Working Environment Group Template)
Working Environment Topic Template properties
Creating a Working Environment Topic Template
Adding topics to a Working Environment Group Template
Defining a Desktop to a Working Environment Group Template
Defining a Working Environment Topic Template (topic)
Adding actions to a Working Environment Topic Template
Profile and Working Environment Template
WET assignment metamodel
Assigning a WET to a Profile
Profiles sharing the same WET
Defining the profile homepage
Defining permissions on a topic with a Profile Perspective
WET advanced customization at property page level
Customizing a desktop for certain users
Creating a Working Environment
Connecting to a customized desktop
Switching from a Working Environment to another one
WET creation example
Configuring Navigation Trees
Concept and Definitions
Navigation Window Content
Navigation Tree Structure
Concepts Overview
Creating a Navigation Tree
Creating the object associated with the navigation tree
Creating the root node
Creating Navigation Tree Branches
Creating a Branch Corresponding to a Folder
Creating a branch of folder type
Creating a node from a branch
Creating a Branch Containing an Object List
Creating Classification Folder Branches
Creating a classification folder
Defining content of classification folder branches
Storing classification folders in a main folder
Filtering Branch Content
Configuring Navigation
Configuring Standard Navigation in a MetaClass
Configuring navigation for a MetaClass
Defining a branch from a MetaClass
Managing object titles in navigation trees
Modifying title of a MetaClass
Creating a composite title
Defining content of a title
Adding text within a MetaField
Navigating from Tree Objects
Using Advanced Functions
Associating Commands with the Tree Root Node
Sorting Content of a Branch
Conditioning Navigation in a Tree
Defining a navigation condition on a node
Defining a navigation condition on a branch
Defining a navigation condition on a classification folder
Using Options
Customizing Steering Calendars
Steering Calendar
Introduction
Steering calendar properties
Steering calendar type
Scheduler configuration
Reminder
Steering date
Scheduling
Customization
Steering Calendar Metamodel
Customizing a steering calendar
Use case: Action Plan workflow
Customizing Workflows
Configuring Workflows
Defining a Workflow
Overview of Workflow Definitions
Creating a Workflow Definition
Accessing workflow definitions
Creating a workflow definition diagram
Workflow Statuses
Workflow Participants
Creating a participant in a workflow definition diagram
Creating a participant from a workflow status
Associating persons with participants
Workflow Transitions
Creating a workflow transition
Person selection mode
Information associated with workflow transition
Multiple triggering transitions
Mass transitions
Implementing scheduled transitions
Conditioning a transition
Configuring the workflow transition triggering menu
Managing transitions at reassignment
Workflow Actions
Configuring a workflow action on a workflow status
Creating a workflow action
Workflow Advanced Configuration
Managing Workflow Object Statuses
Managing object status with the generic attribute
Managing object status with a specific attribute
Implementing Workflow Interactions
Workflow interactions principle
Workflow interaction macros
Workflow interaction examples
Managing E-mails and Notifications
Configuring Actions with Message or Notification
Defining text
Defining recipients
Help on tags
Managing Languages
Notification languages
E-mail language
Managing Objects and Attachments
Managing objects in notifications
Managing attachments in e-mails
Indicating a URL in an E-mail
Adding a URL
Opening the application on a specific tab
Managing Workflows
Workflow Administration Options
Accessing Workflow Options
Workflow Display RIghts
Workflow Administration Rights
Configuring Standard Workflows
Customizing Workflows
Adding a MetaClass
Duplicating a workflow definition
Customizing the Validation Workflow
Stopping a Workflow Instance
Viewing Workflows in Progress
Managing Workflow Users
Managing Permissions on Workflows
Configuring Permissions (CRUDs) on Objects
Specifying Persons Authorized to Start a Workflow
Generating a Report of Permissions by Workflow Definition
Generating the report from a profile
Generating the report from a workflow definition
Report content
Customizing Assessments
Assessment Templates
Definition of an Assessment Template
Creating an Assessment Template
Defining Assessment Template Properties
Assessment mode
Defining assessment scope
Specifying Assessed Object Type
Managing Assessed Characteristics
Creating an assessed characteristic
Specifying the object type and the corresponding MetaAttribute
Updating the MetaClass MetaAttribute
Specifying the display mode as a list
Assessment Template Scope
Creating Assessment Deployment Collections
Defining Deployment Collection Filling Mode
Filled by user
Deployment by tree
Deployment by object list
Deployment by macro
Deployment by macro with parameters
Deployment by query
Defining Deployment Query Parameters
Creating a deployment query parameter
Entering a deployment query parameter comment
Managing parameter values
Assessment Scope Definition Example
Creating a new query with parameter
Creating the object collection to be assessed
Creating an assessment query parameter
Creating a deployment query parameter value
Questionnaire templates
Creating Questionnaire Templates
Initializing questionnaire templates
Managing questionnaire template languages
Defining Questionnaire Presentation
Using presentations
Defining a Presentation
Presentation mode
Presentation possibilities
Previewing questionnaires
Completing the presentation
Questionnaire Contents
Presentation of Questionnaire Elements
Accessing Questionnaire Elements
Questions and Answer Types
Creating Questions
Answer types
About answer types
Selecting the answer type
Entering your own answer
select a value
Connecting HOPEX objects
Selecting a check box
Question Groups
Creating Question Groups
Creating a Specific Question Group on a MetaClass
Types of Questions to Specify Manually
Answer of Enumeration type (drop-down lists and radio buttons)
Creating Possible Answer Values
Defining an answer value by default in the event of a non-answer
Multiple answer
Value types
Example of "multiple answer type" question with unique value
All Answer Types
Initializing an answer value
Answer display conditions
Answers calculated according to answers to other questions
Presentation Tools
Positioning the presentation tool
Presentation Type
External diagram
Internal diagram
Image
External image
Macro
Sub-Page
Text
Conditions on question display
Quotation Rules
Creating Quotation Rules
Creating Plugins
Creating a macro
Implementing the macro
Macros example
Aggregation Schemas
Aggregation Schema Principle
Aggregation Schema Examples
Creating Aggregation Schemas
Aggregation schema
Aggregation steps
Simulating Aggregation
Executing Aggregation Schemas
Customization Examples
Triggering a Transition at Questionnaire Closing
Configuring Direct Assessment
Adding questions to a direct assessment template
Creating a direct assessment template
Creating a direct assessment properties page
Connecting the Objects of an Answer to an Assessed Object
Questionnaire-Related FAQs
How to Create the Questions for a Questionnaire?
Defining questions directly on the questionnaire template
Defining questions on the objects to assess
Defining questions on intermediate objects
What is "Data Call" ?
Data Call Usage Context
Designing Assessment Templates for Data Call
Difference between Data Call and Assessment
Is it possible to delegate parts of a questionnaire?
How to insert a hyperlink into the text of a questionnaire ?
How to prevent from submitting questionnaires with unanswered mandatory questions?
Assessment Workflows
Generic Assessment Workflows
Assessment Campaign Generic Workflow
Assessment Session Generic Workflow
Questionnaire Generic Workflow
Automatic Assessment Workflows
Assessment Campaign Automatic Workflow
Assessment Session Automatic Workflow
Questionnaire Automatic Workflow
Appendix: Assessment Plugins
Assessment Deployment Collection
Scoring Rule
Control Steps
Aggregation Rules
Check Regulation
Using the Scheduler
Scheduler
Introduction
Aim of this document
Presentation
Requirements
Limitation
Architecture
Web Front-End architecture
Windows Front-End architecture
Scheduler principles
Concepts
Job
Trigger
Scheduler
Scheduler execution details
Persistance
Scheduler API
Scheduler and Workspaces
Job execution: user/profile/repository
Scheduler configuration
HOPEX installations without Scheduler
Traceability
Scheduler Client API
Detailed description of the SchedulerClient API
Java
Documentation
VB Script
Documentation
Examples
Scheduling
Scheduling information: XML Scheduling format
<reference>
<start>
<relativedate>
"daysfromreference"
"dayofweek"
" weeksfromreference "
"weekofmonth"
"dayofmonth"
"monthsfromreference"
"month"
<endrepeat>
<timescheduling>
<dailyrepeat>
<weeklyrepeat>
<monthlyrepeat>
Scheduling MegaObject interface
Scheduling Property Page
Presentation of the Scheduling Property page
Provided property pages
Property page description help
Implementing a Job
Implemented Function description
Job Function Template
Triggers Administration
Using APIs
All about starting with APIs
Introduction
Create a VB Script component
VB Script component architecture
Creating and editing a VB Script component
Creating a VB Script component
Creating a VB Script macro with the wizard
Editing a VB Script code
Debugging a VB Script component
Activating macro debugging
Macro Debugging
Finding Text command bar
Create a Java component
MEGA and Java general considerations
Architecture of a MEGA plug-in written in Java
The JVM
The JDK
Development environment (Eclipse)
Installing Eclipse
General writing conventions
Calling a component written in Java from HOPEX
Creating a Java macro in HOPEX
Creating an Eclipse project
Implementing the macro
Executing the macro
Using the MEGA API in a component written in Java
Creating the Command
Configuring the Eclipse project for use of Java MEGA API
Implementing the MetaCommand Item
Debugging a Java component called from HOPEX
Configuration
Debugging
Create a Hopex C# macro
Creating a new class library project with the HOPEX Macro template
Prerequisites
Debugging configuration
Implementing the macro
Declaring the macro in Hopex Studio
Testing your macro
Advanced macros
How to debug
Macro parameterization
API Use Principles
Coding: the right way
MegaRoot
MegaFields
Basic Operations
Creating an object
Connecting operations to a project
Modifying a project name
Displaying the names of all repository projects in a window
Assigning an attribute value to several objects
Retrieving a query result
Using a MegaObject or MegaCollection
Filtering and refining the getCollection API to retrieve objects
Using Set in a VB Script code
Accessing MEGA API Public Objects
Accessing public objects from another MegaObject
MEGA API Methods and Functions
Functions on MegaCollections
Functions and methods on MegaObjects
Functions on MegaCurrentEnvironments
Methods on a Reporting Datamart
Summary of Functions
Functions on MegaItems
Functions on MegaCollections
Functions on MegaObjects
Functions on MegaAttributes
Functions on MegaRoot objects
Functions on MegaCurrentEnvironment
MEGA Operators
Operator types
Creating an operator
Macros used in HOPEX
Administration of HOPEX from APIs
Introduction
Starting administration
Connecting to an open session
Repository Administration Tasks
Getting the environment IdAbs
Connecting to an open repository
Repository logical backup
Compiling the environment
Reinitializing a repository backup logfile
Deleting a repository
Deleting a workspace
Disabling repository log
Flushing the ERQL cache
Initializing and synchronizing a Reporting Datamart
Executing tasks offline
Reorganizing repositories
Generating documents
Generating Web sites
Communication between HOPEX and the outside
API Scripts and .NET
Implementation principle
Language characteristics
VBA Application Example (Visual Basic for Applications)
Toolkit
Metamodel
Accessing an attribute translation using APIs
Accessing the metamodel description using APIs
Property Pages
Accessing the description of an object Property Pages
Accessing MegaObject menus using APIs
Managing scanners
Using or not using the scanner library
Theoretical operating principles (without language dependence)
Using scanners in Java
VB Script examples
Others
Getting the person or person group used for current session
Getting the current snapshot date
Getting the e-mail address
Triggering technical conversions
Managing a semaphore
MEGA TextStream an alternative string concatenation
How to
Supervising HOPEX
Undo
Import/Export
Using MEGA Import/Export command options
Exporting Excel data in batch mode
Importing Excel data in batch mode
Accessing the Desktop Context using APIs
Launching MEGA Tools from APIs
Interactive tools
Batch Tools
Comparing and aligning (CompareTool API)
Exporting (ExportTool API)
Launching an automatic macro while publishing
Invoking an object creation wizard using APIs
Checking a script execution
Setting up a progress bar in macro execution
Customizing an extraction using APIs
Options
Confidential object filtering
Advanced filtering using a component
Using Administration APIs with callback objects
Use case example: Customizing an extraction using APIs
Implementing an Update Tool in script
Managing HOPEX undo/redo actions from a Script
Converting VB Script APIs into Java
Duplicating an object
Calling a URL construction function using APIs in HOPEX
Code examples and results
Calling a macro from HTML, code and RTF descriptors
HTML and code descriptors
RTF Decriptors
Calling an operator
Calling a method (message box display)
Calling a function (RequestQuery)
Calling a function (RegulationApply)
Using MEGA identifiers in the code (Java, VBScript, others)
"Physical" type of MEGA identifiers via APIs
Handling identifiers in their « physical » form
MegaFields
MEGA identifier formats
Bad practice examples
Using macros to add calculated attributes
Launching a tool in HOPEX using APIs
API access
Opening an existing diagram
Creating a new diagram
Saving
Report DataSets and APIs
Getting a Report DataSet content using an API
Regenerating a report DataSet content using an API
Accessing graphical objects in a diagram
Accessing repository objects
Accessing repository links
Paths
Setting up interactive plug-ins in a diagram
Writing a diagram plug-in
Writing a drag'n drop plugin
Registering the macro on a DiagramType:
Writing a dynamic query
Accessing rules and regulations using APIs
Accessing regulations using APIs
Accessing rules using APIs
Business Documents and APIs
StaticDocumentFilePathGet
DesktopUrlBuild with DocumentLauncher tool
SaveAsStatic
Macro Script global properties (MegaPropertyBag)
Coding recommendations & Performances
Coding recommendations
Handling Identifiers
How to speed up queries in API code by using Absolute Identifiers
Browsing repository (collection use)
Writing code rules
Confidentiality
Performances
Navigating through the metamodel with APIs
Navigating through data with APIs
Optimizing the macro of a dynamic data access rule
Avoiding processes to go slower: tracking down non released instances
Processes going slower: releasing non released instances
Navigating through the technical data with APIs
Log error management
HOPEX Web Service API
Web service url
Requesting connection Information
Activating Connection Information service
Authentication
Authorization type: UAS
Environment list
Repository list
Calling the endpoints to access repository features
URL
Authentication
Authorization type: BASIC
Authorization type: UAS
Import file
Asynchronous method
URL
Header parameters
Format Post
Body Parameters
Result
Pooling your process
URL
Header parameters
Result
Get the Reject files
URL
Header parameters
Result
Call synchronous method
URL
Header parameters
Format Post
Body Parameters
Result
Call with SignalR
Export Objects
Asynchronous method
URL
Querystring filter
Result
Pooling your process
URL
Result
Get the export result
URL
Result
Synchronous method
URL
Querystring filter
Result
Dataset Export
Asynchronous method
URL
Querystring filter
Result
Pooling your process
URL
Result
Get the dataset export result
URL
Result
Synchronous method
URL
Querystring filter
Result
JavaDoc
Report Studio
JavaDoc