Administrator Guide
About HOPEX Administration
Connecting to HOPEX Administration
Accessing HOPEX Administration
Connecting to an Environment
Managing Users
Actions to be Performed to Define a User
Before defining a user: profile concepts
Compulsory Actions to be Performed to Define a User
Optional Actions to be Performed to Define a User
Other Actions to Set or Manage a User
Introduction to Profile Management
Description of a Profile
Definition of the profile
Profile assignment
Connection Diagrams
Connection diagram (with WET)
Connection diagram (without WET)
Restricting access to the desktops of an application
The Administration profiles provided
HOPEX Administrator profile
HOPEX Administrator - Production profile
User Management Web Administrator profile
Functional Administrator profile of a Solution
Profile Properties
Name
Products accessible on the license (Command Line)
Assignable
Administrator profile
Set of UI access rights
Profile display
Profile status
_GUIName
MetaPicture
Working Environment Template (WET)
Persons
Available applications
Available desktops
Reporting presentation
Assignable profiles
Terminology
Available types
Introduction to User Management
Users Provided
User: Definition
Person Properties
Name
Image
E-mail
Phone number and initials
Data language
Default library
Person's reading access area and reading access area at creation
Person writing access area and writing access area at creation
Login
Belongs to a Person Group
Login Properties
User code
Login Holder
Inactive user (Status)
Products accessible on the license (Command Line)
Authentication mode
LDAP server
Managing Profiles
Viewing Profile Characteristics
Creating a Profile
Customizing the UI Access (Permissions) of an Existing Profile
Customizing the Characteristics of an Existing Profile / Creating a Profile from an Existing Profile
Configuring a Profile
Configuring profile characteristics
Assigning a WET to a profile
Defining the applications accessible to the users of a profile (non WET-based configuration)
Defining the application desktops accessible to the users of a profile (non WET-based configuration)
Associating a terminology with a profile
Defining the object types available for a profile
Assigning a Profile to a Person
Performing a Mass Profile Assignment to Persons
Deleting a Profile
Access to User Management
Accessing User Management and UI Access Management Folders
Accessing User Management and UI Access Management Folders
Opening the User Management window
Opening the profile management window
Opening the profile assignment window
Viewing Person Characteristics
Viewing the Login Characteristics
Managing Users
Creating Users
Defining a Person
Creating the Login of a Person
Defining the Login of a Person
Modifying the Properties of a User
Preventing User Connection
Deleting Users
Creating or Modifying the Password of a User (Windows Front-End)
Exporting the Repository Users
Managing user options
Configuring the Metamodel Access
Authorizing Deletion of a Dispatched Object
Making a Comment Mandatory on Dispatch
Managing User Inactivity
Activating/Deactivating user inactivity management
Managing user inactivity
Authentication in HOPEX (Windows Front-End)
Defining Default Authentication Mode
Viewing default authentication mode
Defining default authentication mode to LDAP
Modifying the user authentication mode
Configuring Windows Authentication
Synchronization with a company directory
Associating a Windows user with a HOPEX user manually
Connection in case of unique authentication
Single sign-on precautions
Configuring LDAP authentication
Configuring LDAP authentication
Accessing LDAP server management
Creating an LDAP server
Configuring the LDAP server
Configuring an LDAP parameter
Modifying LDAP directory import content
Importing persons from an LDAP server
Authentication and a user created on the fly (Web Front-End)
Managing 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 RDBMS Repository Performance
Generating a Repository Health Report
Performance test description
Health test description
Health report description
Configuring HOPEX health report emailing
Managing Repositories
Managing logfiles
Backup logfile
Backup logfile process
If you have a problem
Repository log
Configuring the logging for an inter repository consolidation
Logging
Modifying the log behavior
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
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
Managing workspaces
Private Workspace Principle
Private workspace
Collaborative Workspace
Using Your Private Workspace
Connecting to HOPEX
Saving Sessions
Workspace Properties
HOPEX Repository State Changes
Dispatching Your Work
Dispatch Conflicts
Creation of duplicated objects
Deletion of already deleted objects or links
Modifying or linking a renamed object
Rejects When Dispatching
Change in writing access values between opening and dispatching a private workspace
Rename/create collisions
Verifying link uniqueness
Attribute uniqueness (other than name)
Updating a deleted object
Dispatch Report
Refreshing Data
Conflicts When Refreshing
Discarding Work
Discarding work from a private workspace
Discarding work from a collaborative workspace
Exiting a Session
Exiting a session from a private workspace
Exiting a session from a collaborative workspace
Workspace Administration
Accessing Workspace Management
Deleting a Workspace
Private Workspace Life: Example
Private workspace 1
Private workspace 2
Private workspace 3
Private workspace 4
Private workspace 5
Private workspace 6
Viewing Updates
Viewing Updates
The Updates window
Displaying your current updates on the HOPEX repository
Displaying your current updates on the system repository
Viewing updates dispatched on the repository over a period of time
Viewing the Dispatches and their Content
Exporting Updates
Exporting Your Private Workspace Log
Private Workspaces and Repository Size
Private workspace life
Private workspace monitoring
Modifying the maximum duration of a private workspace
Managing locks
Principle of Locks
Preventing conflicts
Deleting a lock or unlocking an object
Clock synchronization
Details on the operating method of the locks
Managing Locks on Objects
Managing locks in HOPEX Administration
Managing locks in HOPEX
Managing Environments
Using Environments
Environment Structure
Creating an Environment
Moving and Referencing an Environment
Moving an environment
Referencing an environment
Deleting a reference to an environment
Deactivating an Environment (RDBMS)
Customizing Environments
Backing Up Environment Customizations
Restoring Environment Customizations
Compiling an Environment
Managing the Scheduling (Scheduler)
Introduction to the Scheduler
Concepts
Job
Scheduler
Trigger
Option: Time Zone
Managing Triggers
Accessing Triggers
Accessing the Trigger management
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
Managing the Scheduler
Accessing the Scheduler Control Panel
Stopping the Sheduler
Managing Events
Introduction to supervision
Prerequisites to Supervision
Supervising Events
Event types
Supervision files
Supervision configuration file: MegaSite.ini
Executable code
Supervision tool: HOPEX Server Supervisor
Starting HOPEX Server Supervisor
Extend HOPEX Server Supervisor functionalities
Modifying processes to be supervised (MegaSite.ini filter)
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
Events to be Monitored (Production Server)
Events: Login and Authentication
Events: Configuration Management
Events: Workspace Activity
Events: Repository Connections
Events: Service Execution
Events: Infrastructure Performance and Repository Health
Events: Data Import/Export Tracking
Events: Report DataSet/GraphSet/TreeSet Generation
Events: Scheduled Jobs
Events: Reporting Datamart
Events: Questionnaire Generation
Managing 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
Importing a Solution Pack in HOPEX
Managing UI Access (Permissions)
Introduction to UI Access Management (Permissions)
Prerequisites and definitions
Performance
Accessing the UI access management (HOPEX Administration)
Accessing the permission management (HOPEX)
Object UI Access Values
MetaClass occurrence access permissions
MetaAssociationEnd access permissions
MetaAttribute access permissions
Permissions on a tool
Managing UI Access
Modifying access permissions on occurrences of a MetaClass
Modifying access permissions on MetaAttributes of a MetaClass
Modifying access permissions on tools of a MetaClass
Modifying access permissions of a link around a MetaClass
Modifying access permissions on links around a MetaClass
Rules on permissions while aggregating Sets of UI access rights
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
Generating a Report on Permissions by Profile
Generating the report
Report content
Managing General UI Access
Managing Shapes
Accessing Shapes
Managing 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
Managing 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 (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
Managing Options
Options Overview
Option Window Presentation
Accessing Options
Options Level
Modifying options at site level
Modifying options at environment level
Modifying options at profile level
Modifying options at user level
Modifying options at workstation level
Option Inheritance
Controlling the Modification of the 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 options Report
Available Option Groups
User options
Workstation Options
Managing Languages
Changing User Interface (Windows Front-End) Language
Defining the Data Languages Available for a User
Changing User Data Language (Windows Front-End)
Installing Additional Languages
Defining the Language of e-mails in Workflows
Managing Languages in Web Applications
Managing Date Format
Managing HOPEX Data Customization
Frequently Asked Questions - Administration
Common Operations
Recurrent Messages
Product Codes
Access your list of available products
Glossary
Technical Articles (EN)
HOPEX Administration Consoles
HOPEX Administration Consoles
Introduction to HOPEX Administration Consoles
Accessing the HOPEX Administration Consoles
Directly Accessing One of the HOPEX Administration Consoles
Switching between HOPEX Administration Consoles
HOPEX Supervision console
Accessing HOPEX Supervision Console
HOPEX Supervision Console Description
HOPEX Supervision navigation panes
HOPEX Supervision Console tool bar
Accessing all the Server Events
Accessing the Process Events
Accesssing the User Events
Accessing the Session Events
Accessing the Event Information
Accessing the Macro Information
Finding the Supervision File Location
Supervising the domain
Defining the Supervision Data Files to be displayed
Refreshing the Information
Accessing all of the Events (not filtered)
Accessing a Consolidated Snapshot Event
Displaying consolidated snapshot graph
Using the history
Using HOPEX Supervision data
Customizing the view display
Accessing prefiltered lists
Adding filters to the event list
Deleting all the filters added to the event list
Graphing an event count by time interval
Graphing an event
Graphing the server CPU
Handling a graph
HOPEX Monitoring console
Introduction to HOPEX Monitoring Console
Accessing HOPEX Monitoring Console
HOPEX Monitoring Console Description
Environments
Connected Users
Disconnecting users
Disconnecting users with TimeOut sessions
Processes
Logs
Downloading all the logs
Downloading a specific log
Checkings
Performances
Launching a performance diagnostic test on a repository
Defining a Test Case on a profile
Launching a performance diagnostic test on a profile
HOPEX Licensing Console
Accessing HOPEX Licensing Console
Accessing a License Characteristics
Using the HOPEX Licensing Console
Downloading the report regarding the licenses used
Defining a default license
Viewing which HOPEX license a user is assigned
Managing the user products
Accessing the list of products available to a user
Managing the users of a license
Managing the license products available to a user
Securing the platform
Introduction
Securing the access to the application
Activating SSL on the website
Disabling SSL v2, v3, TLS 1.0 and TLS 1.1, Triple DES 128, RC4 128/128
Block the TRACE HTTP request
Remove the default install page in IIS
Securing the RDP access (Terminal Services)
Configuring the firewall
Configuring the default error page of the application to hide application errors
Protection against ClickJacking
Securing the ASP.NET session cookies
Hide ASP.Net version header
Remove IIS Server version HTTP Response Header
Strict-Transport-Security HTTP header
Manage content type options
Restrict Cross Origin Ressource Sharing to Trusted Domains
Search engine protection
Securing the application
Hiding the error details
Activating the automatic logoff
Hiding the information when entering the wrong credentials
Manage password activities
Account initialization
HOPEX Password Management
Documents Upload
Modules
GraphQL/GraphiQL
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
Hopex Visual Studio Templates
Prerequisites
Web Service Factory (WSF) Template
Installing the HOPEX WSF template
Creating an HOPEX Web Service
Controllers project
Implementing a controller
Security
Creating and using an EventSource
Log events
Using CacheComponent
Hosting.IIS project
Macro project
TestingConsole project
App.config
Program.cs
Deploying the HOPEX WSF Service
Solve possible Cross Origin Resource Sharing (CORS) issue
Macro Template
Installing the HOPEX macro template
Creating a macro
Deploying a macro
Calling a macro
Identity Provider Template
Installing the HOPEX IdentityProvider template
Creating a new identity provider
Deploying an identity provider
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
Mega_Usr folder
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
Table of abbreviations associated with languages