Importing a Module into HOPEX
Module
Module description
Required dependent modules
Importing a Module into HOPEX
Customization Lifecycle Management
Foreword
Vocabulary
Definitions
Synonym
From DEV to PROD process
The big picture
Customization Capabilities
Metamodel, desktops, profiles
Other resources
Getting Ready for Customization
Installing HAS Customization module
Online mode
Offline mode
Launching automatic update
Getting NuGet package
Online mode
Creating Customization (SystemDB)
Work Item concepts
Work Item States
Creating/Using a Work Item
Recommendation when working with WI
Dispatch customization
Publication process
Done with your customization?
Extracting Customization
Prerequisites
Generating the MGR/XMG files
Checking generated files
New/Replace/Override Resource Files
Folders and sub-folders structures
Examples of common files and folders customized
Diagram Shapes
Login page and Portal page
GraphQL custom schema
Packaging customization
Pushing Customization to STAGE/PROD
Pushing to STAGE or PROD principle
Uploading the custom module in HAS
Uploading the module from the Web
Uploading the module from the server (RDP)
Running Automatic update to apply your customization in repositories
Managing a Team to Move from DEV to PROD
Most common (recommended) working way
Principle
Dealing with iterative fix
Multiple team – Multiple Projects – Multiple DEV Instance
Architecture of multiple project
How to create your custom project module
Workflow to manage the project
Migrating to HOPEX V5?
Frequently Asked Questions
The Work Item dropdown is not available when dispatching
The Custom Packaging menu content is not available to extract my customization
I forgot to attach my dispatches to a Work Item, what can I do?
I have embedded demo data in my dispatch, how can I remove them?
How can I remove imported XMG/MGR in stage or prod?
How to force re-import of MGR/XMG files?
My custom files got imported with errors, What should I do?
I did customization but I don't have the initial custom module, what should I do?
Can I launch the automatic update without service interruption?
Is delta custom module package possible ?
HOPEX diagrams in MS Teams
Teams Module Description
HOPEX in Microsoft Teams
Adding the App to your Teams (optional)
Adding a diagram tab in your Team
Viewing a HOPEX diagram
Editing the HOPEX diagram
HOPEX Configuration
Installing Teams Module
Configuring Http Security
Setting SameSite cookie
Configuring the authentication
User accounts
API Key
Authorizing HOPEX connection from Teams
REST API and GraphQL
REST API Documentation
GraphQL endpoints
Synchronous versus Asynchronous
Version of the endpoint
GraphQL and Data Confidentiality (CRUD)
Query
Mutation
Managing permission
Selecting the data language with the REST API
Querying data in the current data language
Querying data in a selected data language
Changing the current data language
Changing the data language for a given user
Query to know the language of a given user
Mutation to update the language of a given user
Getting the list of available data languages
Adding data languages and seeing them in the API
Basic Auth vs API Key
Basic Auth
How to use it?
How to enable it?
API Key
Security
Use case
How to use it?
How to enable it?
Multi or Single Mode
Querying/Creating/Updating/Deleting with GraphQL
Basic queries
Getting an object with its attributes
Getting an object with its relations
Basic mutations
Creating an object
Creating an object with a relationship
Updating an object
Deleting an object
Creating custom schema (SDL/JSON) / custom endpoint
How it works ?
General principle
Creating/Updating a schema
Step 1: Create your metamodel to expose in the REST API
Creating Custom Metamodel
Completing default metamodel
Important rules
Step 2: Configure the generator
Step 3: Run the generator
Pagination in REST API with GraphQL
First elements with Skip or After
Last elements with Skip and Before
Pagination and Sort
Filtering data (where condition) in REST API with GraphQL
How to make a filter?
How to combine filters?
Type of filters by types of fields
String filters
Date or DateTime filters
Numbers filters
Enumeration filters
Boolean filters
Mutation: Absolute/External/Temporary - Identifier
Making a Query
Example: query with a result containing the identifiers
Example: query containing a filter on the external identifier
Making a Mutation
Creation without an Identifier
Creation with an External Identifier
Creation with a Temporary Identifier
Asynchronous versus Synchronous Web service call
What does the endpoint return?
Calling the API in asynchronous way
How the endpoint is called?
Which is the best option?
Diagram API: dowloading a diagram by REST API
Use case
Downloading a diagram (Metaclass Diagram or System Diagram)
Result of the API
Attachment API: Uploading or Downloading Business Document
Use case
Downloading an attachment (Business Document)
Uploading an attachment (Business Document)
Getting GraphQL Schema as a file (SDL schema file)
In GraphiQL
In Postman
ID Converter From HexaIdAbs to Absolute identifier
Using Postman to call the REST API
Importing a Module into HOPEX
Module
Importing a Module into HOPEX
Customization Lifecycle Management
Foreword
Customization Capabilities
Getting Ready for Customization
Creating Customization (SystemDB)
Extracting Customization
New/Replace/Override Resource Files
Packaging customization
Pushing Customization to STAGE/PROD
Managing a Team to Move from DEV to PROD
Migrating to HOPEX V5?
Frequently Asked Questions
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