wwparcel.html

Importing a Module into Hopex

Module

Importing a Module into Hopex

Hopex MCP Technical Documentation

Introduction

Hopex MCP Architecture

Hopex Integration Model

Authentication and Security

Deployment and Configuration

MCP Tools and Capabilities

Context and Data Access

MCP Request Lifecycle

Supervision and Observability

Performance and Scalability

Tests and Validation

Troubleshooting

Operational Governance

Annexes

Hopex MCP Server

Objective

Scope

Key Features

Functional Architecture

Interfaces

Security

Limitations

Use Cases

Broader Business Value

Prerequisites

Administration, Installation, Configuration, and Deployment

Glossary

HOPEX diagrams in MS Teams

Teams Module Description

HOPEX in Microsoft Teams

HOPEX Configuration

REST API and GraphQL

REST API Documentation

GraphQL endpoints

GraphQL and Data Confidentiality (CRUD)

Selecting the data language with the REST API

Basic Auth vs API Key

Querying/Creating/Updating/Deleting with GraphQL

Creating custom schema (SDL/JSON) / custom endpoint

Pagination in REST API with GraphQL

Filtering data (where condition) in REST API with GraphQL

Mutation: Absolute/External/Temporary - Identifier

Asynchronous versus Synchronous Web service call

Diagram API: dowloading a diagram by REST API

Attachment API: Uploading or Downloading Business Document

Getting GraphQL Schema as a file (SDL schema file)

ID Converter From HexaIdAbs to Absolute identifier

Using Postman to call the REST API

MODULES : Importing a Module into Hopex

MODULES : Importing a Module into Hopex : Module

MODULES : Importing a Module into Hopex : Module : Module description

MODULES : Importing a Module into Hopex : Module : Required dependent modules

MODULES : Importing a Module into Hopex : Importing a Module into Hopex

MODULES : Importing a Module into Hopex : Importing a Module into Hopex : Updating an environment manually

MODULES : Importing a Module into Hopex : Importing a Module into Hopex : Authentication via an API key

MODULES : Hopex MCP Technical Documentation

MODULES : Hopex MCP Technical Documentation : Introduction

MODULES : Hopex MCP Technical Documentation : Hopex MCP Architecture

MODULES : Hopex MCP Technical Documentation : Hopex MCP Architecture : Role in the Hopex ecosystem

MODULES : Hopex MCP Technical Documentation : Hopex MCP Architecture : Components

MODULES : Hopex MCP Technical Documentation : Hopex MCP Architecture : Communication flow

MODULES : Hopex MCP Technical Documentation : Hopex MCP Architecture : Responsibilities

MODULES : Hopex MCP Technical Documentation : Hopex MCP Architecture : Architecture diagram

MODULES : Hopex MCP Technical Documentation : Hopex Integration Model

MODULES : Hopex MCP Technical Documentation : Hopex Integration Model : MCP endpoint

MODULES : Hopex MCP Technical Documentation : Hopex Integration Model : Exposed Hopex capabilities

MODULES : Hopex MCP Technical Documentation : Hopex Integration Model : User context

MODULES : Hopex MCP Technical Documentation : Hopex Integration Model : MCP session

MODULES : Hopex MCP Technical Documentation : Hopex Integration Model : SaaS and on-premises considerations

MODULES : Hopex MCP Technical Documentation : Authentication and Security

MODULES : Hopex MCP Technical Documentation : Authentication and Security : OAuth 2.0 and Dynamic Client Registration

MODULES : Hopex MCP Technical Documentation : Authentication and Security : API key authentication

MODULES : Hopex MCP Technical Documentation : Authentication and Security : Authorization and Hopex rights

MODULES : Hopex MCP Technical Documentation : Authentication and Security : Transport security

MODULES : Hopex MCP Technical Documentation : Authentication and Security : Traceability

MODULES : Hopex MCP Technical Documentation : Authentication and Security : Licensing requirements

MODULES : Hopex MCP Technical Documentation : Deployment and Configuration

MODULES : Hopex MCP Technical Documentation : Deployment and Configuration : MCP module management in the HAS console

MODULES : Hopex MCP Technical Documentation : Deployment and Configuration : MCP module management in the HAS console : Default GraphQL schema

MODULES : Hopex MCP Technical Documentation : Deployment and Configuration : MCP module management in the HAS console : Mutation authorization

MODULES : Hopex MCP Technical Documentation : Deployment and Configuration : MCP module management in the HAS console : Deferred authentication

MODULES : Hopex MCP Technical Documentation : Deployment and Configuration : MCP module management in the HAS console : API key mode

MODULES : Hopex MCP Technical Documentation : Deployment and Configuration : Customized metamodel exposure

MODULES : Hopex MCP Technical Documentation : Deployment and Configuration : AI client configuration

MODULES : Hopex MCP Technical Documentation : Deployment and Configuration : Secret management

MODULES : Hopex MCP Technical Documentation : Deployment and Configuration : SaaS and on-premises deployment

MODULES : Hopex MCP Technical Documentation : Deployment and Configuration : Network prerequisites

MODULES : Hopex MCP Technical Documentation : MCP Tools and Capabilities

MODULES : Hopex MCP Technical Documentation : MCP Tools and Capabilities : Tool design principles

MODULES : Hopex MCP Technical Documentation : MCP Tools and Capabilities : Tool naming and structure

MODULES : Hopex MCP Technical Documentation : MCP Tools and Capabilities : Tool inputs and outputs

MODULES : Hopex MCP Technical Documentation : MCP Tools and Capabilities : Tool error handling

MODULES : Hopex MCP Technical Documentation : MCP Tools and Capabilities : Data exposure control

MODULES : Hopex MCP Technical Documentation : MCP Tools and Capabilities : Available MCP capabilities

MODULES : Hopex MCP Technical Documentation : Context and Data Access

MODULES : Hopex MCP Technical Documentation : Context and Data Access : Accessible data

MODULES : Hopex MCP Technical Documentation : Context and Data Access : Scope control

MODULES : Hopex MCP Technical Documentation : Context and Data Access : Call context

MODULES : Hopex MCP Technical Documentation : Context and Data Access : Filtering, pagination, and limits

MODULES : Hopex MCP Technical Documentation : Context and Data Access : Exposure protection

MODULES : Hopex MCP Technical Documentation : Context and Data Access : Logging and retention

MODULES : Hopex MCP Technical Documentation : MCP Request Lifecycle

MODULES : Hopex MCP Technical Documentation : MCP Request Lifecycle : Connection initialization

MODULES : Hopex MCP Technical Documentation : MCP Request Lifecycle : Tool discovery

MODULES : Hopex MCP Technical Documentation : MCP Request Lifecycle : Tool invocation

MODULES : Hopex MCP Technical Documentation : MCP Request Lifecycle : Validation

MODULES : Hopex MCP Technical Documentation : MCP Request Lifecycle : Hopex execution

MODULES : Hopex MCP Technical Documentation : MCP Request Lifecycle : Response handling

MODULES : Hopex MCP Technical Documentation : MCP Request Lifecycle : Timeouts and errors

MODULES : Hopex MCP Technical Documentation : Supervision and Observability

MODULES : Hopex MCP Technical Documentation : Supervision and Observability : Supervision events

MODULES : Hopex MCP Technical Documentation : Supervision and Observability : Event correlation

MODULES : Hopex MCP Technical Documentation : Supervision and Observability : Usage monitoring

MODULES : Hopex MCP Technical Documentation : Supervision and Observability : Supervised data limits

MODULES : Hopex MCP Technical Documentation : Performance and Scalability

MODULES : Hopex MCP Technical Documentation : Performance and Scalability : Web API-equivalent behavior

MODULES : Hopex MCP Technical Documentation : Performance and Scalability : Performance factors

MODULES : Hopex MCP Technical Documentation : Performance and Scalability : Data volume management

MODULES : Hopex MCP Technical Documentation : Performance and Scalability : Load, concurrency, and supervision

MODULES : Hopex MCP Technical Documentation : Performance and Scalability : Write-operation impact

MODULES : Hopex MCP Technical Documentation : Tests and Validation

MODULES : Hopex MCP Technical Documentation : Tests and Validation : Integration preparation

MODULES : Hopex MCP Technical Documentation : Tests and Validation : MCP Server registration

MODULES : Hopex MCP Technical Documentation : Tests and Validation : Connection and authentication

MODULES : Hopex MCP Technical Documentation : Tests and Validation : Configuration header checks

MODULES : Hopex MCP Technical Documentation : Tests and Validation : Simple read prompts

MODULES : Hopex MCP Technical Documentation : Tests and Validation : Mutation tests

MODULES : Hopex MCP Technical Documentation : Tests and Validation : Error handling tests

MODULES : Hopex MCP Technical Documentation : Tests and Validation : Supervision checks

MODULES : Hopex MCP Technical Documentation : Troubleshooting

MODULES : Hopex MCP Technical Documentation : Troubleshooting : Connection and authentication issues

MODULES : Hopex MCP Technical Documentation : Troubleshooting : Configuration and rights issues

MODULES : Hopex MCP Technical Documentation : Troubleshooting : Execution and performance issues

MODULES : Hopex MCP Technical Documentation : Troubleshooting : Support information

MODULES : Hopex MCP Technical Documentation : Operational Governance

MODULES : Hopex MCP Technical Documentation : Operational Governance : MCP tool evolution

MODULES : Hopex MCP Technical Documentation : Operational Governance : Exposed scope control

MODULES : Hopex MCP Technical Documentation : Operational Governance : HAS configuration governance

MODULES : Hopex MCP Technical Documentation : Operational Governance : Write-operation governance

MODULES : Hopex MCP Technical Documentation : Operational Governance : AI client compatibility

MODULES : Hopex MCP Technical Documentation : Operational Governance : Supervision and support

MODULES : Hopex MCP Technical Documentation : Operational Governance : Operational practices

MODULES : Hopex MCP Technical Documentation : Annexes

MODULES : Hopex MCP Technical Documentation : Annexes : Glossary

MODULES : Hopex MCP Technical Documentation : Annexes : Error response examples

MODULES : Hopex MCP Technical Documentation : Annexes : Hopex rights and profiles matrix

MODULES : Hopex MCP Technical Documentation : Annexes : Security and network exposure checklist

MODULES : Hopex MCP Technical Documentation : Annexes : AI client configuration examples

MODULES : Hopex MCP Technical Documentation : Annexes : AI client configuration examples : OAuth/DCR examples

MODULES : Hopex MCP Technical Documentation : Annexes : AI client configuration examples : Header-based examples

MODULES : Hopex MCP Technical Documentation : Annexes : SaaS and on-premises deployment checklist

MODULES : Hopex MCP Server

MODULES : Hopex MCP Server : Objective

MODULES : Hopex MCP Server : Scope

MODULES : Hopex MCP Server : Key Features

MODULES : Hopex MCP Server : Functional Architecture

MODULES : Hopex MCP Server : Interfaces

MODULES : Hopex MCP Server : Security

MODULES : Hopex MCP Server : Limitations

MODULES : Hopex MCP Server : Use Cases

MODULES : Hopex MCP Server : Use Cases : Analysis and Investigation

MODULES : Hopex MCP Server : Use Cases : Reporting, Governance, and Risk

MODULES : Hopex MCP Server : Use Cases : Transformation Support

MODULES : Hopex MCP Server : Use Cases : Visual Insight

MODULES : Hopex MCP Server : Broader Business Value

MODULES : Hopex MCP Server : Broader Business Value : Developers

MODULES : Hopex MCP Server : Broader Business Value : Strategists

MODULES : Hopex MCP Server : Broader Business Value : Product Managers

MODULES : Hopex MCP Server : Broader Business Value : Governance Teams

MODULES : Hopex MCP Server : Broader Business Value : Application Owners

MODULES : Hopex MCP Server : Broader Business Value : Transformation Leaders

MODULES : Hopex MCP Server : Prerequisites

MODULES : Hopex MCP Server : Administration, Installation, Configuration, and Deployment

MODULES : Hopex MCP Server : Glossary

MODULES : HOPEX diagrams in MS Teams

MODULES : HOPEX diagrams in MS Teams : Teams Module Description

MODULES : HOPEX diagrams in MS Teams : HOPEX in Microsoft Teams

MODULES : HOPEX diagrams in MS Teams : HOPEX in Microsoft Teams : Adding the App to your Teams (optional)

MODULES : HOPEX diagrams in MS Teams : HOPEX in Microsoft Teams : Adding a diagram tab in your Team

MODULES : HOPEX diagrams in MS Teams : HOPEX in Microsoft Teams : Viewing a HOPEX diagram

MODULES : HOPEX diagrams in MS Teams : HOPEX in Microsoft Teams : Editing the HOPEX diagram

MODULES : HOPEX diagrams in MS Teams : HOPEX Configuration

MODULES : HOPEX diagrams in MS Teams : HOPEX Configuration : Installing Teams Module

MODULES : HOPEX diagrams in MS Teams : HOPEX Configuration : Configuring Http Security

MODULES : HOPEX diagrams in MS Teams : HOPEX Configuration : Setting SameSite cookie

MODULES : HOPEX diagrams in MS Teams : HOPEX Configuration : Configuring the authentication

MODULES : HOPEX diagrams in MS Teams : HOPEX Configuration : Configuring the authentication : User accounts

MODULES : HOPEX diagrams in MS Teams : HOPEX Configuration : Configuring the authentication : API Key

MODULES : HOPEX diagrams in MS Teams : HOPEX Configuration : Configuring the authentication : Authorizing HOPEX connection from Teams

MODULES : REST API and GraphQL

MODULES : REST API and GraphQL : REST API Documentation

MODULES : REST API and GraphQL : GraphQL endpoints

MODULES : REST API and GraphQL : GraphQL endpoints : Synchronous versus Asynchronous

MODULES : REST API and GraphQL : GraphQL endpoints : Version of the endpoint

MODULES : REST API and GraphQL : GraphQL and Data Confidentiality (CRUD)

MODULES : REST API and GraphQL : GraphQL and Data Confidentiality (CRUD) : Query

MODULES : REST API and GraphQL : GraphQL and Data Confidentiality (CRUD) : Mutation

MODULES : REST API and GraphQL : GraphQL and Data Confidentiality (CRUD) : Managing permission

MODULES : REST API and GraphQL : Selecting the data language with the REST API

MODULES : REST API and GraphQL : Selecting the data language with the REST API : Querying data in the current data language

MODULES : REST API and GraphQL : Selecting the data language with the REST API : Querying data in a selected data language

MODULES : REST API and GraphQL : Selecting the data language with the REST API : Changing the current data language

MODULES : REST API and GraphQL : Selecting the data language with the REST API : Changing the data language for a given user

MODULES : REST API and GraphQL : Selecting the data language with the REST API : Changing the data language for a given user : Query to know the language of a given user

MODULES : REST API and GraphQL : Selecting the data language with the REST API : Changing the data language for a given user : Mutation to update the language of a given user

MODULES : REST API and GraphQL : Selecting the data language with the REST API : Getting the list of available data languages

MODULES : REST API and GraphQL : Selecting the data language with the REST API : Adding data languages and seeing them in the API

MODULES : REST API and GraphQL : Basic Auth vs API Key

MODULES : REST API and GraphQL : Basic Auth vs API Key : Basic Auth

MODULES : REST API and GraphQL : Basic Auth vs API Key : Basic Auth : How to use it?

MODULES : REST API and GraphQL : Basic Auth vs API Key : Basic Auth : How to enable it?

MODULES : REST API and GraphQL : Basic Auth vs API Key : API Key

MODULES : REST API and GraphQL : Basic Auth vs API Key : API Key : Security

MODULES : REST API and GraphQL : Basic Auth vs API Key : API Key : Use case

MODULES : REST API and GraphQL : Basic Auth vs API Key : API Key : How to use it?

MODULES : REST API and GraphQL : Basic Auth vs API Key : API Key : How to enable it?

MODULES : REST API and GraphQL : Basic Auth vs API Key : Multi or Single Mode

MODULES : REST API and GraphQL : Querying/Creating/Updating/Deleting with GraphQL

MODULES : REST API and GraphQL : Querying/Creating/Updating/Deleting with GraphQL : Basic queries

MODULES : REST API and GraphQL : Querying/Creating/Updating/Deleting with GraphQL : Basic queries : Getting an object with its attributes

MODULES : REST API and GraphQL : Querying/Creating/Updating/Deleting with GraphQL : Basic queries : Getting an object with its relations

MODULES : REST API and GraphQL : Querying/Creating/Updating/Deleting with GraphQL : Basic mutations

MODULES : REST API and GraphQL : Querying/Creating/Updating/Deleting with GraphQL : Basic mutations : Creating an object

MODULES : REST API and GraphQL : Querying/Creating/Updating/Deleting with GraphQL : Basic mutations : Creating an object with a relationship

MODULES : REST API and GraphQL : Querying/Creating/Updating/Deleting with GraphQL : Basic mutations : Updating an object

MODULES : REST API and GraphQL : Querying/Creating/Updating/Deleting with GraphQL : Basic mutations : Deleting an object

MODULES : REST API and GraphQL : Creating custom schema (SDL/JSON) / custom endpoint

MODULES : REST API and GraphQL : Creating custom schema (SDL/JSON) / custom endpoint : How it works?

MODULES : REST API and GraphQL : Creating custom schema (SDL/JSON) / custom endpoint : How it works? : General principle

MODULES : REST API and GraphQL : Creating custom schema (SDL/JSON) / custom endpoint : How it works? : Creating/Updating a schema

MODULES : REST API and GraphQL : Creating custom schema (SDL/JSON) / custom endpoint : Creation of your metamodel to expose in the REST API

MODULES : REST API and GraphQL : Creating custom schema (SDL/JSON) / custom endpoint : Creation of your metamodel to expose in the REST API : Creating Custom Metamodel

MODULES : REST API and GraphQL : Creating custom schema (SDL/JSON) / custom endpoint : Creation of your metamodel to expose in the REST API : Completing default metamodel

MODULES : REST API and GraphQL : Creating custom schema (SDL/JSON) / custom endpoint : Creation of your metamodel to expose in the REST API : Important rules

MODULES : REST API and GraphQL : Pagination in REST API with GraphQL

MODULES : REST API and GraphQL : Pagination in REST API with GraphQL : First elements with Skip or After

MODULES : REST API and GraphQL : Pagination in REST API with GraphQL : Last elements with Skip and Before

MODULES : REST API and GraphQL : Pagination in REST API with GraphQL : Pagination and Sort

MODULES : REST API and GraphQL : Filtering data (where condition) in REST API with GraphQL

MODULES : REST API and GraphQL : Filtering data (where condition) in REST API with GraphQL : How to make a filter?

MODULES : REST API and GraphQL : Filtering data (where condition) in REST API with GraphQL : How to combine filters?

MODULES : REST API and GraphQL : Filtering data (where condition) in REST API with GraphQL : Type of filters by type of fields

MODULES : REST API and GraphQL : Filtering data (where condition) in REST API with GraphQL : Type of filters by type of fields : String filters

MODULES : REST API and GraphQL : Filtering data (where condition) in REST API with GraphQL : Type of filters by type of fields : Date or DateTime filters

MODULES : REST API and GraphQL : Filtering data (where condition) in REST API with GraphQL : Type of filters by type of fields : Numbers filters

MODULES : REST API and GraphQL : Filtering data (where condition) in REST API with GraphQL : Type of filters by type of fields : Enumeration filters

MODULES : REST API and GraphQL : Filtering data (where condition) in REST API with GraphQL : Type of filters by type of fields : Boolean filters

MODULES : REST API and GraphQL : Mutation: Absolute/External/Temporary - Identifier

MODULES : REST API and GraphQL : Mutation: Absolute/External/Temporary - Identifier : Making a Query

MODULES : REST API and GraphQL : Mutation: Absolute/External/Temporary - Identifier : Making a Query : Example: query with a result containing the identifiers

MODULES : REST API and GraphQL : Mutation: Absolute/External/Temporary - Identifier : Making a Query : Example: query containing a filter on the external identifier

MODULES : REST API and GraphQL : Mutation: Absolute/External/Temporary - Identifier : Making a Mutation

MODULES : REST API and GraphQL : Mutation: Absolute/External/Temporary - Identifier : Making a Mutation : Creation without an Identifier

MODULES : REST API and GraphQL : Mutation: Absolute/External/Temporary - Identifier : Making a Mutation : Creation with an External Identifier

MODULES : REST API and GraphQL : Mutation: Absolute/External/Temporary - Identifier : Making a Mutation : Creation with a Temporary Identifier

MODULES : REST API and GraphQL : Asynchronous versus Synchronous Web service call

MODULES : REST API and GraphQL : Asynchronous versus Synchronous Web service call : What does the endpoint return?

MODULES : REST API and GraphQL : Asynchronous versus Synchronous Web service call : Calling the API in asynchronous way

MODULES : REST API and GraphQL : Asynchronous versus Synchronous Web service call : How the endpoint is called?

MODULES : REST API and GraphQL : Asynchronous versus Synchronous Web service call : Which is the best option?

MODULES : REST API and GraphQL : Diagram API: dowloading a diagram by REST API

MODULES : REST API and GraphQL : Diagram API: dowloading a diagram by REST API : Use case

MODULES : REST API and GraphQL : Diagram API: dowloading a diagram by REST API : Use case : Downloading a diagram (Metaclass Diagram or System Diagram)

MODULES : REST API and GraphQL : Diagram API: dowloading a diagram by REST API : Use case : Result of the API

MODULES : REST API and GraphQL : Attachment API: Uploading or Downloading Business Document

MODULES : REST API and GraphQL : Attachment API: Uploading or Downloading Business Document : Use case

MODULES : REST API and GraphQL : Attachment API: Uploading or Downloading Business Document : Downloading an attachment (Business Document)

MODULES : REST API and GraphQL : Attachment API: Uploading or Downloading Business Document : Uploading an attachment (Business Document)

MODULES : REST API and GraphQL : Getting GraphQL Schema as a file (SDL schema file)

MODULES : REST API and GraphQL : Getting GraphQL Schema as a file (SDL schema file) : In GraphiQL

MODULES : REST API and GraphQL : Getting GraphQL Schema as a file (SDL schema file) : In Postman

MODULES : REST API and GraphQL : ID Converter From HexaIdAbs to Absolute identifier

MODULES : REST API and GraphQL : Using Postman to call the REST API