Skip to content

Commit e89244c

Browse files
committed
update di plugin reference
1 parent 7bd7a29 commit e89244c

19 files changed

Lines changed: 547 additions & 294 deletions

data/plugins.json

Lines changed: 132 additions & 136 deletions
Large diffs are not rendered by default.

docs/build/reference/customtask/.pages

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ nav:
4747
- "Send email": SendEMail.md
4848
- "Send Mattermost messages": cmem_plugin_mattermost.md
4949
- "Set or Overwrite parameters": cmem_plugin_parameters-ParametersPlugin.md
50+
- "Set parameters": setParameters.md
5051
- "SHACL validation with pySHACL": shacl-pyshacl.md
5152
- "SOQL query (Salesforce)": cmem_plugin_salesforce-SoqlQuery.md
5253
- "Spark SQL query": CustomSQLExecution.md
@@ -58,7 +59,7 @@ nav:
5859
- "Start Workflow per Entity": cmem_plugin_loopwf-task-StartWorkflow.md
5960
- "Store Vector Embeddings": cmem_plugin_pgvector-Store.md
6061
- "Unpivot": Unpivot.md
61-
- "Update SemSpect": cmem_plugin_semspect-task-Update.md
62+
- "Update Graph Insights Snapshots": cmem_plugin_graph_insights-Update.md
6263
- "Upload File to Knowledge Graph": eccencaDataPlatformGraphStoreFileUploadOperator.md
6364
- "Upload files to Nextcloud": cmem_plugin_nextcloud-Upload.md
6465
- "Upload local files": cmem_plugin_project_resources-UploadLocalFiles.md
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
title: "Update Graph Insights Snapshots"
3+
description: "Update one or more snapshots, optionally selected by affected graph."
4+
icon: octicons/cross-reference-24
5+
tags:
6+
- WorkflowTask
7+
- PythonPlugin
8+
---
9+
# Update Graph Insights Snapshots
10+
<!-- This file was generated - DO NOT CHANGE IT MANUALLY -->
11+
12+
!!! note inline end "Python Plugin"
13+
14+
This operator is part of a Python Plugin Package.
15+
In order to use it, you need to install it,
16+
e.g. with cmemc.
17+
18+
This workflow task updates [Graph Insights](https://go.eccenca.com/feature/explore-graph-exploration-graph-insights?lang=en&origin=cmem-plugin-graph-insights)
19+
snapshots for a specified graph in your system.
20+
21+
## Behavior
22+
23+
- **No graph selected**: All snapshots in the system are updated
24+
- **Graph selected**: Only snapshots associated with the selected graph are updated
25+
26+
## Usage
27+
28+
1. Add this task to your workflow.
29+
2. Optionally select a specific graph to limit which snapshots are updated.
30+
3. Use the "Preview Snapshots" action to see which snapshots will be affected before execution.
31+
4. Run the workflow to update the snapshots.
32+
33+
## Prerequisites
34+
35+
- Graph Insights must be active in your system
36+
- User must have permissions to access Graph Insights
37+
- The plugin will skip execution with a warning if these conditions are not met
38+
39+
40+
## Parameter
41+
42+
### Selected Graph
43+
44+
Selected graph to update snapshots for. Leave empty for updating all snapshots.
45+
46+
- ID: `selected_graph`
47+
- Datatype: `string`
48+
- Default Value: `None`
49+
50+
51+
52+
53+
54+
## Advanced Parameter
55+
56+
### Timeout
57+
58+
Timeout in seconds for Graph Insights API.
59+
60+
- ID: `timeout`
61+
- Datatype: `double`
62+
- Default Value: `100`
63+
64+
65+

docs/build/reference/customtask/cmem_plugin_llm-ExecuteInstructions.md

Lines changed: 13 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -35,32 +35,30 @@ AI-powered text generation, analysis, and transformation tasks within Corporate
3535
## Input/Output Behavior
3636

3737
After processing, each entity receives an additional path (default: `_instruction_output`)
38-
containing the LLM response. Input/output ports are automatically configured based on
39-
template variables:
38+
containing the LLM response. For TEXT and JSON_MODE output formats, the response is stored
39+
in this path. For STRUCTURED_OUTPUT, the Pydantic model fields are directly added to the
40+
entity (the `_instruction_output` path is not used).
41+
42+
Input/output ports are automatically configured based on template variables:
4043

4144
- **No placeholders**: No input ports required
42-
- **With placeholders**: Dynamic input ports created for each template variable
43-
- **Port ordering**: Variables sorted alphabetically determine port order
45+
- **With placeholders**: Single input port created for entity data
4446
- **Schema handling**: Fixed schemas when using specific entity paths, flexible schemas otherwise
4547

4648
## Template System
4749

4850
Uses Jinja2 templating for dynamic prompts:
4951

5052
```jinja2
51-
{{ variable }} # Entire entity as JSON
52-
{{ variable.name }} # Specific entity property
53-
{{ variable_a.title }} # Property from first additional input port
54-
{{ variable_b.content }} # Property from second additional input port
53+
{{ entity }} # Entire entity as JSON
54+
{{ entity.name }} # Specific entity property
5555
```
5656

57-
The followin template processing rule are implemented:
57+
The following template processing rules are implemented:
5858

5959
1. **Variable Extraction**: Automatically detects template variables to configure input ports
60-
2. **Entity Iteration**: Main processing iterates over first input port entities
61-
3. **Additional Inputs**: Secondary ports provide context data for template rendering
62-
4. **Consumption Modes**: Choose between first-entity or all-entities consumption from
63-
additional ports
60+
2. **Entity Iteration**: Processes entities from the single input port individually
61+
3. **Single Entity Context**: Each entity is processed independently with its own template context
6462

6563
## Output Formats
6664

@@ -167,7 +165,7 @@ An optional API key for authentication.
167165

168166
### Instruct Model
169167

170-
The identifier of the instruct model to use. Note that some provider do not support a model list endpoint. Just create a custom entry then. Available model IDs for some public providers can be found here: [Claude](https://docs.claude.com/en/docs/about-claude/models/overview), [OpenRouter](https://openrouter.ai/models), [Azure](https://learn.microsoft.com/en-us/azure/ai-foundry/foundry-models/concepts/models-sold-directly-by-azure).
168+
The identifier of the instruct model to use. Note that some provider do not support a model list endpoint. Just create a custom entry then. Available model IDs for some public providers can be found here: [OpenAI](https://platform.openai.com/docs/models), [Claude](https://docs.claude.com/en/docs/about-claude/models/overview), [OpenRouter](https://openrouter.ai/models), [Azure](https://learn.microsoft.com/en-us/azure/ai-foundry/foundry-models/concepts/models-sold-directly-by-azure). **Note:** For STRUCTURED_OUTPUT format, only certain models support structured outputs. See [OpenAI Structured Outputs Guide](https://platform.openai.com/docs/guides/structured-outputs) for supported models.
171169

172170
- ID: `model`
173171
- Datatype: `string`
@@ -221,7 +219,7 @@ The timeout for a single API request in seconds.
221219

222220
### Instruction Output Path
223221

224-
The entity path where the instruction result will be provided.
222+
The entity path where the instruction result will be provided. Note: This parameter is not used when Output Format is set to STRUCTURED_OUTPUT. For structured outputs, only the Pydantic model fields are included in the output schema.
225223

226224
- ID: `instruction_output_path`
227225
- Datatype: `string`
@@ -251,16 +249,6 @@ A list of messages comprising the conversation compatible with OpenAI chat compl
251249

252250

253251

254-
### Consume all entities from additional input ports
255-
256-
If enabled, all entities from additional input ports will be consumed. Otherwise, only the first entity of the additional ports will be used.
257-
258-
- ID: `consume_all_entities`
259-
- Datatype: `boolean`
260-
- Default Value: `false`
261-
262-
263-
264252
### Output Format
265253

266254
Specifying the format that the model must output. Possible values are `TEXT` - Standard text output, `STRUCTURED_OUTPUT` - output follows a given schema. Add your schema as Pydantic model in the parameter below, `JSON_MODE` - a more basic version of the structured outputs feature where you have to add your structure to the prompt template.

docs/build/reference/customtask/cmem_plugin_salesforce-SoqlQuery.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "SOQL query (Salesforce)"
3-
description: "Executes a custom Salesforce Object Query (SOQL) to return sets of data your organizations Salesforce account."
3+
description: "Executes a custom Salesforce Object Query (SOQL) to return sets of data your organization's Salesforce account."
44
icon: octicons/cross-reference-24
55
tags:
66
- WorkflowTask
@@ -17,9 +17,9 @@ tags:
1717

1818

1919
This task executes a custom Salesforce Object Query (SOQL)
20-
and returns sets of tabular data from your organizations Salesforce account.
20+
and returns sets of tabular data from your organization's Salesforce account.
2121

22-
> Use the Salesforce Object Query Language (SOQL) to search your organizations
22+
> Use the Salesforce Object Query Language (SOQL) to search your organization's
2323
> Salesforce data for specific information. SOQL is similar to the SELECT statement in
2424
> the widely used Structured Query Language (SQL) but is designed specifically for
2525
> Salesforce data.

docs/build/reference/customtask/cmem_plugin_salesforce-workflow-operations-SobjectCreate.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Create/Update Salesforce Objects"
3-
description: "Manipulate data in your organizations Salesforce account."
3+
description: "Manipulate data in your organization's Salesforce account."
44
icon: octicons/cross-reference-24
55
tags:
66
- WorkflowTask
@@ -18,7 +18,7 @@ tags:
1818

1919
This task retrieves data from an incoming workflow task (such as a SPARQL query),
2020
and sends bulk API requests to the Salesforce Object API, in order to
21-
manipulate data in your organizations Salesforce account.
21+
manipulate data in your organization's Salesforce account.
2222

2323
The working model is:
2424
- Each entity from the input data is interpreted as a single Salesforce object of the

docs/build/reference/customtask/cmem_plugin_semspect-task-Update.md

Lines changed: 0 additions & 105 deletions
This file was deleted.

docs/build/reference/customtask/cmem_plugin_validation-validate-ValidateEntities.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,28 +25,35 @@ JSON Schema specification.
2525
The used JSON Schema needs to be provided as a JSON Dataset in the project.
2626

2727
### Input Modes
28+
2829
The plugin supports two input modes for validation:
30+
2931
1. **Validate Entities**: Validates entities received from the input port in the workflow.
30-
2. **Validate JSON Dataset**: Validates a JSON dataset stored in the project.
32+
2. **Validate JSON Dataset**: Validates a JSON dataset stored in the project.
3133
- If the JSON dataset is a JSON array, the schema will validate each object inside the array.
3234
- If the JSON dataset is a JSON object, it will be validated against the schema directly.
3335

3436
Validated data objects can be sent to an output port for further processing in the workflow
3537
or saved in a JSON dataset in the project.
3638

3739
### Output Modes
38-
1. **Valid JSON objects sent to Output Port**: Valid JSON objects can be sent as entities to the output port.
39-
2. **Saved in JSON Dataset**: Valid JSON objects can be stored in a specified JSON dataset in the project.
40+
41+
1. **Valid JSON objects sent to Output Port**: Valid JSON objects can be sent as entities
42+
to the output port.
43+
2. **Saved in JSON Dataset**: Valid JSON objects can be stored in a specified JSON dataset
44+
in the project.
4045

4146
### Error Handling
47+
4248
The task can either:
49+
4350
- Fail instantly if there is a data violation, halting the workflow.
44-
- Provide warnings in the workflow report, allowing follow-up tasks to run based on the validated data.
51+
- Provide warnings in the workflow report, allowing follow-up tasks to run based on the
52+
validated data.
4553

4654
The error handling behavior is configurable through the `Fail on violations` parameter.
4755

4856

49-
5057
## Parameter
5158

5259
### Source / Input Mode

docs/build/reference/customtask/cmem_plugin_yaml-parse.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,24 @@ tags:
1515
In order to use it, you need to install it,
1616
e.g. with cmemc.
1717

18-
This workflow task is basically a yaml2json command.
18+
19+
This workflow task parses YAML content from multiple sources and converts it to various output
20+
formats.
21+
22+
**Input Sources:**
23+
- **entities**: Parse YAML from input port entities in a workflow
24+
- **code**: Parse YAML from directly entered source code
25+
- **file**: Parse YAML from uploaded project file resources
26+
27+
**Output Formats:**
28+
- **entities**: Convert parsed structure to entities for workflow processing
29+
- **json_entities**: Output as single JSON entity to the output port
30+
- **json_dataset**: Save parsed structure directly to a JSON dataset
31+
32+
The plugin provides flexible YAML-to-JSON conversion with configurable input schema
33+
types and paths for entity-based processing. It includes comprehensive validation and
34+
error handling for all supported modes.
35+
1936

2037
## Parameter
2138

0 commit comments

Comments
 (0)