Administrator Guide
About HOPEX Administration
Connecting to HOPEX Administration
Accessing HOPEX Administration
Connecting to an Environment
Repositories
Introduction to Repositories
System Repository (SystemDb)
HOPEX Repository
Repository Structure
Accessing Repositories
Creating a Repository
Consulting and Modifying Repository Properties
Accessing the Log of Repository Changes (.EMV file)
Repository Performance and Health
Consulting Repository Performance
Generating a Repository Health Report
Performance test description
Health test description
Health report description
Configuring HOPEX health report emailing
Managing Repositories
Repository log
Configuring the logging
Viewing the Repository Update Log
Viewing the repository update log
Displaying dispatches
Exporting Updates
Enabling and Customizing Repository Indexing
Enabling/Disabling repository indexing for full-text search
Indexing a repository manually
Customizing the indexing scheduler
Deleting indexing folders
Converting a Repository
Mass converting technical data
Importing Libraries into a Repository
Repository Physical Backup
Backup frequencies
Elements to be backed up
Other elements to be backed up
Elements that could be useful to back up
Reorganizing an RDBMS Repository
Reorganizing a repository
Repository Logical Backup
Deleting a Repository
Updating a Repository
Importing command files
Viewing rejects
Viewing the import execution report file
Viewing the Environment Report File
Viewing the environment report file
Copying the environment report file
Opening the environment report file
Viewing User Process Error Trace Files
Opening the trace file from HOPEX Administration
Opening the trace file from the HOPEX Server Supervisor tool
Opening the trace file from HOPEX
Saving the Error Zip file for Diagnostics
Viewing Object History
Viewing Dispatch Report
Optimizing Repository Access Performance
Managing Log Size
Log size management frequency
Deleting a log or reducing the log size
Backing up the repository log
Deleting log elements to reduce the log size
Modifying MetaClass loggability
Managing the Cache in RDBMS Environments
Increasing RDBMS cache size (memory)
Managing Status Indicators
Deleting RDBMS Repository Temporary and Historical Data
Performing Repository Regular Maintenance Tasks
Cleaning up a Repository
Configuring the Anti-Virus According to HOPEX Data
Referencing and Unreferencing a Repository
Referencing a Repository
Unreferencing a Repository
Protecting the Referencing of a Repository
Adding a referencing password to a repository
Modifying/Canceling a repository password
Environments
Using Environments
Environment Structure
Creating an Environment
Creating an environment using a module
Moving and Referencing an Environment
Moving an environment
Referencing an environment
Deleting a reference to an environment
Updating an Environment
Warnings
Deactivating an Environment
Customizing Environments
Backing Up Environment Customizations
Restoring Environment Customizations
Compiling an Environment
Scheduling (Scheduler)
Introduction to the Scheduler
Concepts
Job
Scheduler
Trigger
Defining your Local Time (Time Zone)
Managing Triggers
Accessing Triggers
Creating a Trigger
Managing a Trigger
Defining the Trigger Execution Context
Configuring the Trigger Scheduling
Defining the Execution Time Zone
Defining the First Execution Date of the Trigger
Defining the first execution date (or unique execution)
Defining a relative date for the first execution
Defining the Trigger Frequency
Defining the Last Execution Date
Defining the Execution Time
Defining the Trigger execution time
Defining a time-based recurrence on the Trigger execution
Supervision and Events
Introduction to Supervision
Supervision Event
Event types
Supervision Files
Supervision Configuration
Executable code
Supervision Tool: HOPEX Server Supervisor
Starting HOPEX Server Supervisor
Extending HOPEX Server Supervisor Functionalities
Modifying the Processes to Supervise
Finding the Supervision File Location
Modifying the Supervision File Location
Supervising Events
Supervision Tool
Supervision tool toolbar
Supervision tool tabs
Consulting a Supervision Event File
Actions from an Event Supervision Window
Objects
Exporting HOPEX Objects
Export
Exporting Objects
Exporting HOPEX objects
Exporting a HOPEX object from the object
Viewing an export file
Activating the export perimeter selection option
Viewing Objects Before Export
Enabling the view option
Viewing objects
Protecting Objects
Accessing the Object Protection Management Window
Assigning a Writing Access Area to an Object
Propagating Authorizations Between Linked Objects
Comparing and Aligning Objects Between Repositories
Compare and Align Principle
Compare and Align Warnings
Repository log
Users
Reading (confidentiality) and writing access levels
Comparing and Aligning Two Repositories
Merging Two Objects
Choice of the objects to be merged
Merging Two Objects
Managing Data Access Dynamically
Implementing a dynamic data access rule
Creating a permission rule (data access rule)
Associating a permission rule with a profile
Associating a permission rule with an object
Use case: data access rule set up
Managing UI Access (Permissions)
Managing Shapes
Shapes provided by HOPEX
Customizing the shapes
Data Writing Access
Introduction to writing access management
Users
Writing Access Areas
Writing Access Diagram
Rules
Use
Link Orientation: Major and Minor Objects
Opening the Writing Access Diagram
Opening the Writing Access Diagram (Windows Front-End)
Compiling the Writing Access Diagram
Defining Writing Access Areas
Creating a Writing Access Area
Defining Writing Access Area Persons or Person Groups
Defining a Writing Access Area at Creation
Modifying Writing Access Areas of Objects
Modifying Writing Access Areas of an Object Group
Deleting Writing Access Areas
Propagating Object Writing Access Areas to Child Objects
Associating Objects with Writing Access Areas
Tips on Using Writing Access Areas
Common data
Tips
Typical example
Customizing Writing Access Area Management
Calculated Writing Access Area
Calculated MetaAttribute
Installing a Writing Access Diagram
Locking Validated Objects
Merging Two Projects
Splitting a Project
Managing Users from the Writing Access Diagram
Creating Persons with Writing Access Areas
Creating Person Group with Writing Access Areas
Managing Users from the Writing Access Diagram
Compiling the Writing Access Diagram
Transferring the Writing Access Diagram
Customizing Writing Access Diagram Display
Customizing Diagram Structure Representation
Customizing Writing Access Area Display
Data Reading Access
Introduction
The Need to Manage Sensitive Data
General Concepts
Activating Data Reading Access Management
Consulting Environment Reading Access Information
Managing Reading Access in HOPEX
Compiling the Reading Access Diagram
Reading Access Area Matrix
Accessing the Reading Access Area Matrix
Adding an Object Reading Access Area
Adding a User Reading Access Area
Associating User Reading Access Areas with Object Reading Access Areas
Associating Users with User Reading Access Areas
Reading Access Diagram
Reading Access Diagram Operating
Activating the reading access diagram
Prohibiting Reading Access Diagram Modification
Opening the reading access diagram (Windows Front-End)
Organizing Reading Access Areas
Creating reading access areas
Connecting two reading access areas
Displaying reading access areas associated with a reading access area
Adding a User in the Reading Access Diagram
Adding a person in the reading access diagram
Adding a person group in the reading access diagram
Connecting Users to Reading Access Areas
Reading access area of the user
Reading access area at creation
Consulting Reading Access Diagram Information:
Customizing Reading Access Area Display
Configuring Data Reading Access
Associating Objects with Reading Access Areas
Connecting objects to object reading access areas
Disconnecting objects from reading access areas
Displaying the list of objects associated with a reading access area
Associating user reading access areas with objects
Propagating Reading Access Areas
Propagating a reading access area from HOPEX Administration
Propagating a reading access area from HOPEX
Managing MetaClass Sensitivity and Reading Access Areas
Opening the HOPEX MetaClasses reading access configuration dialog box
Modifying MetaClass sensitivity
Hiding confidential or sensitive objects in a diagram
Confidential or Sensitive Object Behavior
Displaying a confidential or sensitive object in a diagram
Export and Duplication
Generation of reports and Report DataSets
Generation of reports (MS Word) and Web sites
Macros
Confidential or sensitive objects and namespaces
Modifying Reading Access Areas
Modifying object reading access areas
Modifying user reading access areas
MetaClass Confidentiality Exceptions
Command File Syntax
Command file extensions
Object Naming Rules
Commands
Basic Syntax
Creating an Object
Deleting Objects
Modifying an Object
Modifying Texts
Modifying a Name
Creating and Modifying an Object with a Single Command
Creating a Link Between Two Objects
Modifying a Link
Deleting a Link
Managing Translations
Validating Import
Displaying a Comment in the Import Dialog Box
Transforming an MGL File to MGR
Transforming an MGR File to MGL
Options
Introduction to Options
Option Overview
Option Window Presentation
Accessing Options
Options Level
Modifying options at site level
Modifying options at environment level
Option Inheritance
Controlling Modification of Options
Prohibiting modification of a lower level option
Unlocking the modification of a lower level option
Reinitializing Option Values
Reinitializing the values of an option
Reinitializing the values of an option group (Windows Front-End)
Generating the list of options
Option Groups
Installation
Repository
Workspace
Tools
HOPEX Solutions
Compatibility
Technical Support
Debugging
Managing HOPEX Data Customization
Languages and Dates
Managing Languages
Supported Data Languages
Installing Additional Languages
Defining Available Data Languages
Defining the Language of e-mails in Workflows
Managing Languages in Web Applications
Managing Date and Time Formats
Frequently Asked Questions - Administration
Common Operations
Recurrent Messages
Product Codes
Access your list of available products
Glossary
Supervision Event Description
Login and Authentication
Authentication
LoginAuthenticationSuccess
LoginAuthenticationFailure
MaxAuthenticationRetryFailure
License
LicenseLoginSuccess
LicenseLoginWarning
LicenseLoginFailure
Login
ProfileAssignment
ProfileAssignmentError
LoginInitialize
Password Update
LoginPasswordChange
LoginPasswordChangeFailure
Connection
Connecting to an environment
HopexVersionMismatch
RepositorySessionConnect
RepositorySessionClose
RepositorySessionConnectFailure
RepositorySessionReconnect
Connecting to a repository
RepositoryExclusiveRWAccess
RepositoryOpen
RepositoryOpenFailure
RepositoryClose
RepositoryCloseFailure
MetaData
MetaDataCompile
CompiledDataReset
CompiledDataMissing
CompiledDataResetAttempt
ComputedMetaAttributeCheckErrors
GraphCompile
GraphUpdate
Workspaces
TransactionFlushFailure
TransactionDispatchFailure
AutoDispatch{#AutoDispatch}
TransactionDispatch
TransactionFlush
TransactionRefresh
TransactionRollback
TransactionUnFlush
Performance
HOPEX Server
RepositoryHealthCacheConfigurationlAlert
ProcessSnapshot
SQL Server
SqlServerCPUAlert
RepositoryHealthSQLCompatibiltyLevelAlert
RepositoryHealthSQLPrivateWorkspaceAlert
RepositoryHealthSQLHistoricalDataAlert
RepositoryHealthSQLTableAlert
RepositoryHealthSQLIndexAlert
Daily measures of data access performances
RepositoryPerformanceROGraphCommentReadAlert
RepositoryPerformanceROGraphReadAlert
RepositoryPerformanceROGraphQueryAlert
RepositoryPerformanceRWGraphCommentWriteAlert
RepositoryPerformanceRWGraphCreateAlert
RepositoryPerformanceRWGraphDestroyAlert
RepositoryPerformanceRWGraphQueryAlert
Repository Health
MetaAttributesUsageAlert
RepositoryHealthCustomisationAlert
RepositoryHealthLocksAlert
RepositoryHealthMetaAssociationChildrenVolumeAlert
RepositoryHealthMetaAssociationVolumeAlert
RepositoryHealthMetaClassVolumeAlert
RepositoryHealthWorkspaceAlert
Data Import/Export and Conversion
RepositoryLogConsolidate
RepositoryLogDestroy
RepositoryDataExport
RepositoryDataImport
RepositoryDataImportFailure
RepositoryDataLogicalSave
RepositoryNameConvert
ReporDataSet, TreeSet, and GraphSet
ReportDataSet
ReportDataSetGenerate
ReportDataSetGenerateWarning
ReportDataSetUpdate
ReportDataSetLoad
GraphSet
GraphSetGenerate
GraphSetGenerateWarning
GraphSetGenerateFailure
TreeSet
TreeSetGenerate
TreeSetGenerateFailure
TreeSetGenerateWarning
Scheduled Jobs
ScheduledJobExecution
ScheduledJobExecutionFailure
SchedulerError
Reporting
Generating Outputs
DocumentGenerate
MSWordDocumentGenerate
v# ReportGenerate
WebsiteGenerate
Datamart
DatamartStructureInit
DatamartDataInit
DatamartCalculatedAttSynchro
DatamartDiagramsSynchro
Questionnaire
Assessment Survey Generation
Deployment Generation
Aggregation Generation
Diagram
DiagramOpen
DiagramSave
DiagramClose
Connect Wizard
ConnectionWizardCandidateComputation
action = FindButtonBeginWith
action = FindButtonBeginWithOnUT
action = FindButtonEndWith
action = FindButtonEndWithOnUT
action = FindButtonContains
action = FindButtonContainsOnUT
action = CandidateQueryExecutionOnChange
action = CandidateQueryExecutionOnWinIntialize
action = SearchOnWinIntialize
action = PasteSelectionOnTerminate
Workflow
WorkflowActionComputation
WorkflowConditionComputation
WorkflowParticipantComputation
RunTimeAlerts
MacroExcessiveInvocationTime
ProcessException
ERQLWarning
JavaMacroBindAlert
InformalCollectionSerializationAlert
Process ThreadPool Alert
DesktopHeapAlert
CPUBenchAlert
HopexPerformanceWarning
RepositorySQLIndexLack
GbmMonitoring
Unclassified
AutoDiagnostic
ChatServiceError
DesktopClose
DesktopLock
ExternalMacro
Perf_UX_Server_GenerateDesktopJson
RepositoryPerformanceAlert
DNETMacro
ScriptMacro
JavaMacro
Undo/Redo
UnknownTextFormat
Indexes
Technical Articles (EN)
Description of MEGA Data Exchange XML Format
Introduction to MEGA XML Data Exchange Format
Format XML Schema Model
Tags in Brief
<MegaExchange>
<Header>
<Attribute>
<Value>
<Commands>
<Content>
<Object>
<Link>
<Add>
<Delete>
<Replace>
<Extension>
Format in Detail
MEGA data exchange XML document structure
Physical structure
Logical structure
Exchanged data description modes
Command exchange: <Commands> tag
Content exchange: <Content> tag
Commands description: <Add>, <Delete>, <Replace> tags
Object Descriptions
Command Mode
Content Mode
Object identification mechanisms
Link description
Hierarchical link in content mode
Other links
Description of attribute values
Attribute value format
Translatable attributes and attribute value expression language
MEGA XML format extensions
Example of use of the <Extension> tag by MEGA
Attributes of MEGA XML documents used by MEGA
Document attributes list
Glossary
Reporting Datamart
Reporting Datamart Overview
Reporting Datamart Description
Structure
Data
Content
Excluding MetaAttribute values from the Reporting Datamart
Creating and initializing a reporting datamart
Creating a Reporting Datamart
Initializing the Reporting Datamart structure
Initializing the Reporting Datamart data
Synchronizing the Reporting Datamart with the HOPEX Repository content
Synchronization frequency
Launching an incremental synchronization
Launching a calculated MetaAttribute synchronization
Launching a diagram synchronization
Deleting a reporting datamart
Using the Reporting Datamart
Usage
Advantages
Reporting Datamart Detailed description
Reporting Datamart table classification
Reporting Datamart table name format
Technical tables
MetaClass occurrence tables
MetaAssociation tables
Reporting Datamart columns
MetaClass occurrence table columns
Link table columns
Use case: reading the Reporting Datamart through a link
Accessing your Reporting Datamart tables
Understanding a link table
Finding the MetaClass corresponding to an IdAbs
Finding attributes or tagged values belonging to a MetaClass occurrence
Finding information on an attribute
Use case: saving the diagram drawings
RDBMS Environment Duplication
Introduction
Prerequisites
The SQL Server account
Backup/Restore of SQL Server databases
Backup and file transfer
Restore
When duplicating a repository in an environment – Expert mode
Post Installation Tasks
Create/Attach an environment in HOPEX
Creating an environment
Attaching the working database(s) to the environment
Copy the documents from source to target
The Word/RTF documents
The internal documents (.DAT files)
Get the parameters of the environment
MegaEnv.ini file
Automatic Translation Administration
Prerequisites for the use of automatic translation
Configuring the incremental automatic translation batch
Initiating automatic batch translation
Configuring the incremental automatic batch translation
Table of abbreviations associated with languages
Administrator Guide
About HOPEX Administration
Connecting to HOPEX Administration
Accessing HOPEX Administration
Connecting to an Environment
Repositories
Introduction to Repositories
Creating a Repository
Consulting and Modifying Repository Properties
Repository Performance and Health
Managing Repositories
Repository log
Configuring the logging
Viewing the Repository Update Log
Exporting Updates
Enabling and Customizing Repository Indexing
Converting a Repository
Importing Libraries into a Repository
Repository Physical Backup
Reorganizing an RDBMS Repository
Repository Logical Backup
Updating a Repository
Viewing the Environment Report File
Viewing User Process Error Trace Files
Saving the Error Zip file for Diagnostics
Viewing Object History
Viewing Dispatch Report
Optimizing Repository Access Performance
Managing Log Size
Managing the Cache in RDBMS Environments
Managing Status Indicators
Deleting RDBMS Repository Temporary and Historical Data
Performing Repository Regular Maintenance Tasks
Cleaning up a Repository
Configuring the Anti-Virus According to HOPEX Data
Referencing and Unreferencing a Repository
Referencing a Repository
Unreferencing a Repository
Protecting the Referencing of a Repository
Environments
Using Environments
Creating an Environment
Moving and Referencing an Environment
Updating an Environment
Deactivating an Environment
Customizing Environments
Backing Up Environment Customizations
Restoring Environment Customizations
Compiling an Environment
Scheduling (Scheduler)
Introduction to the Scheduler
Managing Triggers
Configuring the Trigger Scheduling
Supervision and Events
Introduction to Supervision
Supervision Event
Supervision Files
Supervision Configuration
Supervision Tool: HOPEX Server Supervisor
Starting HOPEX Server Supervisor
Extending HOPEX Server Supervisor Functionalities
Modifying the Processes to Supervise
Finding the Supervision File Location
Modifying the Supervision File Location
Supervising Events
Supervision Tool
Consulting a Supervision Event File
Actions from an Event Supervision Window
Objects
Exporting HOPEX Objects
Export
Exporting Objects
Viewing Objects Before Export
Protecting Objects
Accessing the Object Protection Management Window
Assigning a Writing Access Area to an Object
Propagating Authorizations Between Linked Objects
Comparing and Aligning Objects Between Repositories
Compare and Align Principle
Compare and Align Warnings
Comparing and Aligning Two Repositories
Merging Two Objects
Managing Data Access Dynamically
Use case: data access rule set up
Managing UI Access (Permissions)
Managing Shapes
Shapes provided by HOPEX
Data Writing Access
Introduction to writing access management
Users
Writing Access Areas
Writing Access Diagram
Link Orientation: Major and Minor Objects
Opening the Writing Access Diagram
Compiling the Writing Access Diagram
Defining Writing Access Areas
Creating a Writing Access Area
Defining a Writing Access Area at Creation
Modifying Writing Access Areas of Objects
Deleting Writing Access Areas
Propagating Object Writing Access Areas to Child Objects
Tips on Using Writing Access Areas
Customizing Writing Access Area Management
Calculated Writing Access Area
Installing a Writing Access Diagram
Locking Validated Objects
Merging Two Projects
Splitting a Project
Managing Users from the Writing Access Diagram
Creating Persons with Writing Access Areas
Creating Person Group with Writing Access Areas
Managing Users from the Writing Access Diagram
Compiling the Writing Access Diagram
Transferring the Writing Access Diagram
Customizing Writing Access Diagram Display
Customizing Diagram Structure Representation
Customizing Writing Access Area Display
Data Reading Access
Introduction
The Need to Manage Sensitive Data
Consulting Environment Reading Access Information
Managing Reading Access in HOPEX
Reading Access Area Matrix
Accessing the Reading Access Area Matrix
Adding an Object Reading Access Area
Associating User Reading Access Areas with Object Reading Access Areas
Associating Users with User Reading Access Areas
Reading Access Diagram
Reading Access Diagram Operating
Activating the reading access diagram
Opening the reading access diagram (Windows Front-End)
Organizing Reading Access Areas
Adding a User in the Reading Access Diagram
Connecting Users to Reading Access Areas
Consulting Reading Access Diagram Information:
Customizing Reading Access Area Display
Configuring Data Reading Access
Associating Objects with Reading Access Areas
Associating user reading access areas with objects
Propagating Reading Access Areas
Managing MetaClass Sensitivity and Reading Access Areas
Confidential or Sensitive Object Behavior
Modifying Reading Access Areas
MetaClass Confidentiality Exceptions
Command File Syntax
Command file extensions
Object Naming Rules
Commands
Basic Syntax
Creating an Object
Deleting Objects
Modifying an Object
Modifying Texts
Modifying a Name
Creating and Modifying an Object with a Single Command
Creating a Link Between Two Objects
Modifying a Link
Deleting a Link
Managing Translations
Validating Import
Displaying a Comment in the Import Dialog Box
Transforming an MGL File to MGR
Options
Introduction to Options
Option Overview
Option Window Presentation
Accessing Options
Options Level
Option Inheritance
Controlling Modification of Options
Reinitializing Option Values
Generating the list of options
Option Groups
Managing HOPEX Data Customization
Languages and Dates
Managing Languages
Managing Date and Time Formats
Frequently Asked Questions - Administration
Common Operations
Recurrent Messages
Product Codes
Access your list of available products
Glossary
Supervision Event Description
Login and Authentication
Authentication
License
Login
Password Update
Connection
Connecting to an environment
Connecting to a repository
MetaData
MetaDataCompile
CompiledDataReset
CompiledDataMissing
CompiledDataResetAttempt
ComputedMetaAttributeCheckErrors
GraphCompile
GraphUpdate
Workspaces
TransactionFlushFailure
TransactionDispatchFailure
TransactionDispatch
TransactionFlush
TransactionRefresh
TransactionRollback
TransactionUnFlush
Performance
HOPEX Server
SQL Server
Repository Health
MetaAttributesUsageAlert
RepositoryHealthCustomisationAlert
RepositoryHealthLocksAlert
RepositoryHealthMetaAssociationChildrenVolumeAlert
RepositoryHealthMetaAssociationVolumeAlert
RepositoryHealthMetaClassVolumeAlert
RepositoryHealthWorkspaceAlert
Data Import/Export and Conversion
RepositoryLogConsolidate
RepositoryLogDestroy
RepositoryDataExport
RepositoryDataImport
RepositoryDataImportFailure
RepositoryDataLogicalSave
RepositoryNameConvert
ReporDataSet, TreeSet, and GraphSet
ReportDataSet
GraphSet
TreeSet
Scheduled Jobs
ScheduledJobExecution
ScheduledJobExecutionFailure
SchedulerError
Reporting
Generating Outputs
Datamart
Questionnaire
Assessment Survey Generation
Deployment Generation
Aggregation Generation
Diagram
DiagramOpen
DiagramSave
DiagramClose
Connect Wizard
ConnectionWizardCandidateComputation
Workflow
WorkflowActionComputation
WorkflowConditionComputation
WorkflowParticipantComputation
RunTimeAlerts
MacroExcessiveInvocationTime
ProcessException
ERQLWarning
JavaMacroBindAlert
InformalCollectionSerializationAlert
Process ThreadPool Alert
DesktopHeapAlert
CPUBenchAlert
HopexPerformanceWarning
RepositorySQLIndexLack
GbmMonitoring
Unclassified
AutoDiagnostic
ChatServiceError
ExternalMacro
Perf_UX_Server_GenerateDesktopJson
RepositoryPerformanceAlert
DNETMacro
ScriptMacro
JavaMacro
Undo/Redo
UnknownTextFormat
Indexes
Technical Articles (EN)
Description of MEGA Data Exchange XML Format
Introduction to MEGA XML Data Exchange Format
Format XML Schema Model
Tags in Brief
Format in Detail
Glossary
Reporting Datamart
Reporting Datamart Overview
Reporting Datamart Description
Creating and initializing a reporting datamart
Synchronizing the Reporting Datamart with the HOPEX Repository content
Deleting a reporting datamart
Using the Reporting Datamart
Reporting Datamart Detailed description
RDBMS Environment Duplication
Introduction
Prerequisites
Backup/Restore of SQL Server databases
Post Installation Tasks
Automatic Translation Administration
Prerequisites for the use of automatic translation
Configuring the incremental automatic translation batch
Table of abbreviations associated with languages