The LeanIX sync script is a python script that can be used to synchronize data from LeanIX into Port. It is based on the LeanIX GraphQL API to query factSheets and Port's Generic Webhook Integration to map the factSheets into the catalog.

!!! Make sure that you have python 3.6 or higher installed. !!! Make sure to set PORT_CLIENT_ID and PORT_CLIENT_SECRET environment variable with your port credentials. !!! Make sure to set LEANIX_SECRET environment variable with your LeanIX secret.

pip install -r requirements.txt

python sync.py

!!! Make sure to set PORT_CLIENT_ID and PORT_CLIENT_SECRET environment variable with your port credentials.

To clear the data ingested into port you can use the clean.py python script to remove all the ingested data from the sync.py script.

The clean script will delete all the blueprints and their entities according to the defined list of blueprints in the script file.

pip install -r requirements.txt

python clean.py

You can use the following environment variables to change the behavior of the script:

• DELETE_ENTITIES - By default the script is deleting the entities for the blueprints specified in it to disable the entities deletion set this environment variable to 0. (disabling this feature will also disable the blueprint deletion)
• DELETE_BLUEPRINTS - By default the script is deleting the blueprints specified in it to disable the blueprint deletion set this environment variable to 0
• DELETE_WEBHOOK - By default the script does not delete the webhook integration specified in it to enable the webhook deletion set this environment variable to 1

• Why are old entities not deleted in the sync process?

  The sync process does not delete entities, it only updates or creates new ones.

• What blueprints are created?

  The blueprints that are created are based on the ./assets/blueprints.json file.

• What is the generic webhook integration configuration?

  The webhook configuration is based on the ./assets/webhook.json file.

• How can I change the data queried from LeanIX?

  The data that is queried from LeanIX is based on the ./assets/queries.py file. The queries are written in GraphQL. Each query in the list will be executed and paginated accordingly

  !!! Make sure that you add the following fields to filter the query according to the pagination:

    after: "{{ end_cursor }}"
    first: {{ page_size }}