Skip to main content

Update to Social Knowledge Graph

Migration Guide for Adapting Your Modules to the new Social Knowledge Graph

Estimated time: 30 to 60 minutes

warning

Before starting the update, please have a lock at update filter links to ensure that your filter links are compatible with the new Social Knowledge Graph.


1. Introduction

To use your modules in combination with the new Social Knowledge Graph, a technical migration is required. This guide outlines all necessary steps to migrate your environment smoothly and minimize downtime.


2. Prerequisites

  • PHP version: from 7.4 to 8.4
  • Composer: Must be installed on the server
  • SSH or API access to your system
  • Coordination with your project manager/contact person for the final configuration switch
warning

After the module update is complete, configuration must be switched to the Social Knowledge Graph. Without this change, no data can be retrieved! Please coordinate the go-live with your project manager or contact to minimize downtime.


4. Step-by-Step Instructions

4.1. Switch Branch

  1. First, set the module's upstream branch to skg.
info

All PHP scripts can be executed in the browser. Alternatively, you can use curl to run the scripts.

curl "{base_url}/we2p/api/setBranch.php?branch=skg"

4.2. Update Modules

Now the modules need to be updated. This is done via the update script, which brings the module up to date.

curl "{base_url}/we2p/api/update.php"

4.3. Verify Update

Check if the update was successful:

curl "{base_url}/we2p/api/status.php"

Expected result (excerpt):

{
"components": {
"webmodules-core": {
"version": {
"current_branch": "skg"

}
}
}
}
  • Success indicator: "current_branch": "skg"
  • Error case: If you see "master", "develop" or "legacy", resolve open Git diffs in the we2p directory and repeat step 4.1.

4.4. Update Composer Packages

  1. Navigate to the directory containing your composer.json.
  2. Update dependencies:
composer update
  1. Verify that the modules are still functioning (no data will be shown yet, as the configuration is not yet switched).

4.5. Switch Configuration to Social Knowledge Graph

Inform your project manager or contact that the modules have been updated and the configuration can now be switched. After the switch, verify that all data is being retrieved correctly.


5. Summary

StepActionEndpoint/Script
1. Switch branchSet module branch to Social Knowledge Graph/we2p/api/setBranch.php?branch=skg
2. Update modulesRun update script/we2p/api/update.php
3. Check statusVerify the switch/we2p/api/status.php
4. Composer updateUpdate Composer packagescomposer update
5. Switch configurationFinal switch to Social Knowledge GraphCoordinate with Venus GmbH