The GraphQL REST API exposes in standard a subset of the full HOPEX Metamodel. This subset is organized into several endpoint represented by a schema (SDL). The split is mainly done by solution scope or technical grouping: ITPM, BPA, Audit…
It is possible to extend the delivered schema or to create new schema. The result of this customization will end up with a new endpoint to call by HTTP request.
How it works ?
General principle
To create a schema we need to convert the HOPEX Metamodel into a GraphQL syntax compatible. This mapping is done through a JSON file that maps the HOPEX ID with a naming convention compatible with GraphQL. From this file the system generates a GraphQL syntax. The default JSON mapping schema are installed in the CONFIG folder of the HOPEX installation. For instance in HOPEX V4 :
C:\Program Files (x86)\MEGA\HOPEX V4\DotNet\hopex.graphql\1.0.0.0\CONFIG\V3\Standard
Moreover, in the web part a key in the web.config exposes the list of available schema.
<add key="GraphQLSchemas" value="ITPM, Assessment, Audit, BPA, Data, DataPrivacy, MetaModel, Reporting, Risk, Workflow"/>
<!-- GraphQLSchema-->
In this example we see that there are several schema about: ITPM, Assessment, Audit…
Within this JSON file the metamodel in terms of MetaClass, MetaAttribute, MetaAttributesValue, MetaAssociation.
Here is an extract of a JSON mapping schema for ITPM :
...
"metaclass": [{
"id": "MrUiM9B5iyM0",
"name": "Application",
"description": "An application is a software component that can be deployed and provides users with a set of functionalities.",
...
"properties": [{
"id": "Z20000000D60",
"name": "Name",
"description": "Short Name of the object ...",
"constraints": {
"type": "String",
"mandatory": true,
"maxLength": "1024",
"readOnly": false,
"translatable": true,
"formattedText": false
}}],
"relationships": [
{
"id": "7ChrtiDo4vb0_YChrYpDo4ri0_MrUiM9B5iyM0",
"name": "TimePeriod",
...
"pathToTarget": [
{
"id": "VChrYpDo4fi0",
"name": "TimeDependentObjectTimePeriod",
"maeName": "PeriodOfValidity",
"maeID": "YChrYpDo4ri0",
"metaClassName": "TimePeriod",
"metaClassID": "7ChrtiDo4vb0",
"multiplicity": "*"
}]}]
...
See attached ITPM file for full JSON.
Creating/updating a schema
To create your own schema you can:
- Create a totally new schema
In this situation you are free to define what is exposed and you will not be impacted by future updates of the API.
- Extend an existing schema.
This limits the customization to be performed but you will benefit from future updates of the default delivered schema..
In both cases the principle is the same. You need to create a custom JSON file that you will put in the custom folder
C:\Program Files (x86)\MEGA\HOPEX V4\DotNet\hopex.graphql\1.0.0.0\CONFIG\V3\Custom
In case of a new JSON the name of the schema must be added in the web.config
Step 1 : Create your metamodel to expose in the REST API
The JSON delivered out of the box have been generated by a java program that reads a diagram of metamodel. To generate a schema JSON you can use the same tool on existing metamodel diagram or with your new metamodel diagram.
Custom Metamodel
- Open HOPEX windows desktop client
- In MetaStudio tab create a new Metamodel
- Add a new diagram for this metamodel.
- Put the piece of the metamodel you want.
- Copy and keep for later the absolute identifier of the metamodel object
Complete default metamodel
Should you want to complete the default schema with additional MetaClass, MetaAttribute... follow the steps below :
- Import the MGL file located in "MGL" folder
- Duplicate the standard Metamodel and diagram you want to complete
- Put the piece of metamodel you want.
- Copy and keep for later the absolute identifier of the metamodel object
Important rules
This generator apply the following rules :
- Only concrete metamodel is generated
- MetaAssociation must be in the diagram to be generated, including the abstract version of the MetaAssociation.
Step 2 : Configure the generator
Download the generator from gitHub. In this example all the files will be moved to the destination folder
C:\temp\java
. You can adjust according to your case.
- From folder "EXE" copy paste the files to the destination folder :
- generatorJSONMapping.jar
- run.bat
- From folder "JSON" copy paste the files to the destination folder :
- 00_OverrideName_Global.JSON
- 00_SchemaToGenerate.json
- Open the "00_SchemaToGenerate.json" to add your schema. Past the absolute identifier you have saved from previous step.
- Edit the included section to false to avoid to generate the other schema.
Example of "00_SchemaToGenerate.json" :
{
"included": "true",
"schemaName": "ITPM",
"metaModelAbsoluteIdentifier": "TeEKeRMmSPYK",
"login": "Tibere",
"password": "Hopex",
"profile": "ITPM Functional Administrator"
},
- Login, password, and profile should reflect the restriction of metamodel you want to apply to the API. If you don't know which profile put 'HOPEX Customizer'. Access right will be read at runtime.
Step 3 : Run the generator
Before running the generator edit the file 'run.bat' to adjust :
- folders location : HOPEX, log, config file
- environment path
- repository name
- debug option (-d)
To run the program, execute the run.bat file. In case of success the message appears in the console.
Processing the request may take a while : between 30 to 45 min... Be patient! Depending on the complexity of the metamodel.
Example of console message in debug :
[2020-09-14 08:35:21] [CONFIG ] debug = true
[2020-09-14 08:35:21] [CONFIG ] verbose = false
[2020-09-14 08:35:21] [CONFIG ] Folder = c:\temp\java\
[2020-09-14 08:35:21] [CONFIG ] Log Folder = c:\temp\java\
[2020-09-14 08:35:21] [CONFIG ] File Name Override = 00_OverrideName_Global.JSON
[2020-09-14 08:35:21] [CONFIG ] File Name Schema = 00_SchemaToGenerate.JSON
[2020-09-14 08:35:21] [CONFIG ] Environment = C:\Users\Public\Documents\HOPEX V4\PRESALESV4
[2020-09-14 08:35:21] [CONFIG ] Repository = SOHO
[2020-09-14 08:35:21] [INFOS ] Read schema name
[2020-09-14 08:35:22] [INFOS ] ########### Starting ###########
[2020-09-14 08:35:22] [INFOS ] ########## Starting : Custom
[2020-09-14 08:35:22] [INFOS ] Open HOPEX
[2020-09-14 08:35:29] [INFOS ] Open Session
[2020-09-14 08:35:29] [INFOS ] sAdministrator: Mega - sPassword: *****
[2020-09-14 08:35:30] [INFOS ] Read overRideName JSON
[2020-09-14 08:35:30] [INFOS ] Creating JSON
[2020-09-14 08:35:30] [INFOS ] Start Metaclass
[2020-09-14 08:35:32] [INFOS ] Size = 1
[2020-09-14 08:35:33] [INFOS ] MetaClass = Application
[2020-09-14 08:36:01] [INFOS ] Starting Reverse Id
[2020-09-14 08:36:01] [INFOS ] Start Interfaces
[2020-09-14 08:36:01] [INFOS ] Wrting filec:\temp\java\SBB.JSON
[2020-09-14 08:36:01] [INFOS ] Write overRideName JSON
[2020-09-14 08:36:01] [INFOS ] HOPEX Closed
[2020-09-14 08:36:01] [INFOS ] ########### All done ###########
Hello,
Go to the HAS Console in Module Settings >> GraphQL IDE Settings add your new schema
Hello,
How do you run the script ?
- by opening Powershell ISE ? You need to be careful of the folder written in the blue section of the script
- right click on the file HOPEX-regserver.ps1 You need to make sure you have enough righ to execute powershell script.
