Scrydon

Extensions d'exemple

Comment les Scrydon extensions d'exemple sont construits, importés, personnalisés et contribués. Parcourez le catalogue dans la section Exemples.

Ce sont des Process Flows pré-créés packagés sous forme de Scrydon extensions (.scrydon-extension.tar.gz). Chacun regroupe un process flow avec une ontologie — téléchargez, inspectez, puis téléversez via /api/extensions/import. Les exemples ne sont pas auto-installés ; vous les optez en important l'archive dans votre organisation.

Chaque archive est construite par packages/sdk-authoring/scripts/build-examples.ts à partir du manifeste situé à packages/sdk-authoring/src/process-flows/examples/<slug>/index.ts, encapsulé au moment du build dans une extension. L'archive est des données pures — aucun code exécutable n'est jamais distribué.

Parcourir les extensions d'exemple

Le catalogue d'exemples — chaque scénario, son guide pas à pas complet, ses données d'exemple et le téléchargement .scrydon-extension.tar.gz — se trouve dans la section Exemples. Cette page explique comment ces extensions sont construits, importés en ligne de commande, personnalisés et contribués.

Comment importer un exemple

Cliquez sur le lien de téléchargement d'une extension dans la section Exemples. L'archive est un flux gzip compact (environ 4 à 6 Kio).

Vérifiez le manifeste avant de téléverser.

bunx @scrydon/sdk-authoring extension inspect ~/Downloads/iso-quarterly-review-1.0.0.scrydon-extension.tar.gz

L'inspecteur applique les mêmes limites que le runtime — taille d'archive, nombre de fichiers, extensions autorisées, pas de liens symboliques, pas de traversée de chemin — et exécute la vérification de cycle DAG de tâches sur le sous-répertoire du process-flow.

Envoyez l'archive au point de terminaison d'import de extension de votre organisation.

curl -X POST "$AGENTIC_URL/api/extensions/import?organizationId=$ORG_ID" \
  -H "Cookie: $SESSION_COOKIE" \
  -F "file=@~/Downloads/iso-quarterly-review-1.0.0.scrydon-extension.tar.gz"

Une fois importé, le modèle apparaît sur la page Extensions de votre espace de travail. Activez-le, puis cliquez sur Nouveau depuis le modèle dans Process Flows pour démarrer une nouvelle instance.

Personnaliser avant le téléversement

La plupart des équipes voudront ajuster les personas, les jours de décalage d'échéance, ou remplacer les entrées actionType: workflow par leurs propres workflowId. Trois options :

  1. Modifier le manifeste, reconstruire. Clonez la source de l'exemple depuis packages/sdk-authoring/src/process-flows/examples/<slug>/index.ts, modifiez, puis bun run --cwd packages/sdk-authoring build:examples pour reconstruire chaque extension. Ou assemblez un répertoire de extension créé manuellement et bunx @scrydon/sdk-authoring extension build path/to/extension.json --outDir dist.
  2. Forker le manifeste en TypeScript. Créez votre propre defineProcessFlow(...) dans votre dépôt, en copiant-collant l'exemple comme point de départ. Recommandé quand les changements sont non triviaux.
  3. Modifier process-flow/manifest.json à l'intérieur de l'archive. Extraire → modifier → ré-emballer avec tar -czf. Rapide pour des ajustements ponctuels ; pas recommandé pour la maintenance continue.

Les manifestes d'exemple sont versionnés (package.version dans extension.json et dans le manifeste de process-flow) — incrémentez-le quand vous forkez pour que votre organisation suive la divergence.

Ajouter un nouvel exemple

Pour contribuer un nouvel exemple :

  1. Créez packages/sdk-authoring/src/process-flows/examples/<votre-slug>/index.ts exportant un résultat defineProcessFlow(...).
  2. Ajoutez-le à exampleTemplates dans examples/index.ts.
  3. (Optionnel) Si votre exemple a besoin d'une vraie ontologie, déposez le sous-répertoire d'ontologie sous packages/sdk-authoring/src/extensions/examples/<votre-slug>/ontology/ et enregistrez-le dans ONTOLOGY_OVERRIDES à l'intérieur de scripts/build-examples.ts. Les modèles sans remplacement reçoivent une ontologie vide auto-générée au moment du build.
  4. Exécutez bun run --cwd packages/sdk-authoring build:examples — le script découvre et package automatiquement chaque entrée.
  5. L'archive atterrit à apps/docs/public/static/process-extension-examples/<slug>-<version>.scrydon-extension.tar.gz et est servie par le site de documentation.
  6. Ajoutez l'extension au catalogue dans la section Exemples — une carte sur l'index des exemples et une page de guide sous content/docs/examples/.

Le script de build est vocal en cas d'échec : si un manifeste ne valide pas contre son schéma, l'exemple est rejeté et le build échoue avec le chemin Zod de la violation.

Ce qui N'EST PAS dans un exemple

Les Extensions sont des données pures — ils ne peuvent pas contenir de code exécutable. La logique personnalisée est référencée par workflowId contre des workflows système ou organisationnels. Les exemples ISO référencent compliance-quarterly-prefetch, compliance-monitoring-snapshot, compliance-evidence-sync et compliance-vanta-final-check — ce sont des workflows système prévus. Jusqu'à leur distribution, ces actions de type workflow se dégradent en listes de contrôle manuelles dans l'interface runtime.

Connexes

Sur cette page

Sur cette page