Merge pull request #1103 from catenax-ng/chore/xxx-docu

chore-xxx: added scheduler documentation
eclipse-tractusx · Mar 22, 2024 · f1e753d · f1e753d
2 parents a00c898 + b561112
commit f1e753d
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,7 @@ _**For better traceability add the corresponding GitHub issue number in each cha
 - #695 OAuth2.0 Client scope configuration
 - #606 Added error message into notifications on failure
 - #596 Added Policy management documentation
+- Added overview of the scheduler tasks in documentation
 
 ### Changed
 - #709 Bumped spring-core from 6.0.17 to 6.1.5

diff --git a/docs/src/docs/arc42/runtime-view/full.adoc b/docs/src/docs/arc42/runtime-view/full.adoc
@@ -8,3 +8,4 @@ include::data-consumption.adoc[leveloffset=+1]
 include::data-provisioning.adoc[leveloffset=+1]
 include::data-sovereignty.adoc[leveloffset=+1]
 include::policies.adoc[leveloffset=+1]
+include::scheduler.adoc[leveloffset=+1]
diff --git a/docs/src/docs/arc42/runtime-view/scheduler.adoc b/docs/src/docs/arc42/runtime-view/scheduler.adoc
@@ -0,0 +1,4 @@
+= Scheduler
+
+include::scheduler/scheduler.adoc[leveloffset=+1]
+
diff --git a/docs/src/docs/arc42/runtime-view/scheduler/scheduler.adoc b/docs/src/docs/arc42/runtime-view/scheduler/scheduler.adoc
@@ -0,0 +1,8 @@
+An overview of the scheduler tasks configured in the system.
+
+[options="header"]
+|===
+|Scheduler Name | Execution Interval | Description
+|PublishAssetsJob | Every hour at 30min | Publishes assets in IN_SYNCHRONIZATION state to core services. The process combines 'as-built' and 'as-planned' assets and initiates their publication for synchronization in the traceability system.
+|AssetsRefreshJob | Every 2 hours | Invokes the synchronization of asset shell descriptors with the decentralized registry. It ensures the latest asset information is fetched and updated in the system from external sources.
+|===
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,4 @@
		= Scheduler

		include::scheduler/scheduler.adoc[leveloffset=+1]