@cplace/mcp-server 2.2.0 → 2.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api.d.ts.map +1 -1
- package/dist/api.js +0 -1
- package/dist/api.js.map +1 -1
- package/dist/capability-gating.d.ts +8 -4
- package/dist/capability-gating.d.ts.map +1 -1
- package/dist/capability-gating.js +50 -29
- package/dist/capability-gating.js.map +1 -1
- package/dist/index.js +8 -2
- package/dist/index.js.map +1 -1
- package/dist/local-mode.d.ts +3 -0
- package/dist/local-mode.d.ts.map +1 -0
- package/dist/local-mode.js +8 -0
- package/dist/local-mode.js.map +1 -0
- package/dist/logger.d.ts +1 -0
- package/dist/logger.d.ts.map +1 -1
- package/dist/logger.js +5 -1
- package/dist/logger.js.map +1 -1
- package/dist/plugins/core/app-catalog/README.md +4 -1
- package/dist/plugins/core/app-catalog/cf.cplace.lowCodeWidgetBuilder/README.md +117 -0
- package/dist/plugins/core/app-catalog/cf.cplace.lowCodeWidgetRenderer/README.md +37 -0
- package/dist/plugins/core/app-catalog/cf.cplace.lowcode.ai/README.md +62 -9
- package/dist/plugins/core/widget-specifications/cf.cplace.workflow.widget/_meta.json +1 -1
- package/dist/plugins/resource-management/app-catalog/cf.cplace.resourceManagement/README.md +42 -30
- package/dist/plugins/resource-management/app-catalog/cf.cplace.resourceManagement.predefinedValueTypes/README.md +67 -0
- package/dist/searchSchema.d.ts +244 -3152
- package/dist/searchSchema.d.ts.map +1 -1
- package/dist/strict-schemas.d.ts +3 -2
- package/dist/strict-schemas.d.ts.map +1 -1
- package/dist/strict-schemas.js +72 -70
- package/dist/strict-schemas.js.map +1 -1
- package/dist/tools/board-widget.d.ts +45 -387
- package/dist/tools/board-widget.d.ts.map +1 -1
- package/dist/tools/board-widget.js +1 -1
- package/dist/tools/board-widget.js.map +1 -1
- package/dist/tools/change-listeners.d.ts +10 -3
- package/dist/tools/change-listeners.d.ts.map +1 -1
- package/dist/tools/change-listeners.js +1 -1
- package/dist/tools/change-listeners.js.map +1 -1
- package/dist/tools/common-schemas.d.ts +4 -4
- package/dist/tools/common-schemas.d.ts.map +1 -1
- package/dist/tools/csv-export.d.ts +247 -3623
- package/dist/tools/csv-export.d.ts.map +1 -1
- package/dist/tools/documents.d.ts.map +1 -1
- package/dist/tools/documents.js +77 -14
- package/dist/tools/documents.js.map +1 -1
- package/dist/tools/embedded-widget-layout.d.ts +9 -57
- package/dist/tools/embedded-widget-layout.d.ts.map +1 -1
- package/dist/tools/embedded-widget-layout.js +1 -1
- package/dist/tools/embedded-widget-layout.js.map +1 -1
- package/dist/tools/enum-providers.d.ts +4 -1
- package/dist/tools/enum-providers.d.ts.map +1 -1
- package/dist/tools/expert-settings.d.ts +6 -1
- package/dist/tools/expert-settings.d.ts.map +1 -1
- package/dist/tools/get-operations.d.ts +2 -2
- package/dist/tools/job-scripts.d.ts +5 -2
- package/dist/tools/job-scripts.d.ts.map +1 -1
- package/dist/tools/job-scripts.js +1 -1
- package/dist/tools/job-scripts.js.map +1 -1
- package/dist/tools/jobs.d.ts +10 -3
- package/dist/tools/jobs.d.ts.map +1 -1
- package/dist/tools/layout-richstring-widgets.d.ts +9 -81
- package/dist/tools/layout-richstring-widgets.d.ts.map +1 -1
- package/dist/tools/layout.d.ts +19 -163
- package/dist/tools/layout.d.ts.map +1 -1
- package/dist/tools/page-actions.d.ts +4 -1
- package/dist/tools/page-actions.d.ts.map +1 -1
- package/dist/tools/page-actions.js +2 -2
- package/dist/tools/page-actions.js.map +1 -1
- package/dist/tools/pages.d.ts +10 -4
- package/dist/tools/pages.d.ts.map +1 -1
- package/dist/tools/ppt-export-schemas.d.ts +343 -1647
- package/dist/tools/ppt-export-schemas.d.ts.map +1 -1
- package/dist/tools/ppt-export-schemas.js +1 -1
- package/dist/tools/ppt-export-schemas.js.map +1 -1
- package/dist/tools/ppt-export.d.ts +242 -1264
- package/dist/tools/ppt-export.d.ts.map +1 -1
- package/dist/tools/references.d.ts +3 -19
- package/dist/tools/references.d.ts.map +1 -1
- package/dist/tools/resource-planner-widget.d.ts +33 -192
- package/dist/tools/resource-planner-widget.d.ts.map +1 -1
- package/dist/tools/resource-planner-widget.js +1 -1
- package/dist/tools/resource-planner-widget.js.map +1 -1
- package/dist/tools/richstring-widgets.js +2 -2
- package/dist/tools/richstring-widgets.js.map +1 -1
- package/dist/tools/schedule.d.ts +5 -1
- package/dist/tools/schedule.d.ts.map +1 -1
- package/dist/tools/script-logs.d.ts +16 -3
- package/dist/tools/script-logs.d.ts.map +1 -1
- package/dist/tools/search.d.ts +259 -3629
- package/dist/tools/search.d.ts.map +1 -1
- package/dist/tools/solution-packages.d.ts +12 -20
- package/dist/tools/solution-packages.d.ts.map +1 -1
- package/dist/tools/system.js +2 -2
- package/dist/tools/system.js.map +1 -1
- package/dist/tools/type-layouts.js +1 -1
- package/dist/tools/type-layouts.js.map +1 -1
- package/dist/tools/type-management.d.ts +74 -96
- package/dist/tools/type-management.d.ts.map +1 -1
- package/dist/tools/type-management.js +9 -9
- package/dist/tools/type-management.js.map +1 -1
- package/dist/tools/type-messages.d.ts +4 -1
- package/dist/tools/type-messages.d.ts.map +1 -1
- package/dist/tools/type-messages.js +1 -1
- package/dist/tools/type-messages.js.map +1 -1
- package/dist/tools/validators.d.ts +4 -1
- package/dist/tools/validators.d.ts.map +1 -1
- package/dist/tools/version-history.d.ts +4 -4
- package/dist/tools/widget-simulation.d.ts +6 -1
- package/dist/tools/widget-simulation.d.ts.map +1 -1
- package/dist/tools/widgets.d.ts +9 -5
- package/dist/tools/widgets.d.ts.map +1 -1
- package/dist/tools/wizards.d.ts +26 -23
- package/dist/tools/wizards.d.ts.map +1 -1
- package/dist/tools/wizards.js +4 -4
- package/dist/tools/wizards.js.map +1 -1
- package/dist/tools/workflow-scripts.d.ts +27 -6
- package/dist/tools/workflow-scripts.d.ts.map +1 -1
- package/dist/tools/workflow.d.ts +8 -2
- package/dist/tools/workflow.d.ts.map +1 -1
- package/dist/tools/workflow.js +2 -2
- package/dist/tools/workflow.js.map +1 -1
- package/dist/tools/workspace-admin.d.ts +14 -7
- package/dist/tools/workspace-admin.d.ts.map +1 -1
- package/dist/tools/workspace-core.d.ts +8 -4
- package/dist/tools/workspace-core.d.ts.map +1 -1
- package/dist/utils/fileIO.d.ts +3 -0
- package/dist/utils/fileIO.d.ts.map +1 -1
- package/dist/utils/fileIO.js +14 -0
- package/dist/utils/fileIO.js.map +1 -1
- package/package.json +3 -3
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# AI Widget Studio Renderer (cf.cplace.lowCodeWidgetRenderer)
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
Displays widgets built with AI Widget Studio, without the full builder (editor, preview, custom types). It holds
|
|
6
|
+
only the Embedded Widget, which renders a published Widget Definition on any page.
|
|
7
|
+
|
|
8
|
+
**Plugin:** `cf.cplace.lowCodeWidgetBuilder`
|
|
9
|
+
|
|
10
|
+
**Repository:** `cplace-lowcode-widget-builder`
|
|
11
|
+
|
|
12
|
+
## Dependencies
|
|
13
|
+
|
|
14
|
+
- `cf.cplace.platform` (cplace Basis) — always pre-installed
|
|
15
|
+
|
|
16
|
+
No additional apps are auto-installed with this app. It does not install AI Widget Studio, and AI Widget
|
|
17
|
+
Studio does not install it.
|
|
18
|
+
|
|
19
|
+
## Types Provided
|
|
20
|
+
|
|
21
|
+
**None** — this app provides no types. The Widget Definition type comes from AI Widget Studio.
|
|
22
|
+
|
|
23
|
+
## Widgets Provided
|
|
24
|
+
|
|
25
|
+
| Widget | Widget Kind | Description | Use Case |
|
|
26
|
+
|--------|-------------|-------------|----------|
|
|
27
|
+
| Embedded Widget | `cf.cplace.lowCodeWidgetBuilder.embeddedWidget` | Renders a published Widget Definition on the page it is placed on | Every page that shows a custom widget |
|
|
28
|
+
|
|
29
|
+
## Usage Notes
|
|
30
|
+
|
|
31
|
+
- A workspace that also defines widgets needs AI Widget Studio installed as well.
|
|
32
|
+
|
|
33
|
+
## Investigation Details
|
|
34
|
+
|
|
35
|
+
- **Source:** the `cplace-lowcode-widget-builder` source — `LowCodeWidgetRendererApp.java` (qualified name, no
|
|
36
|
+
types, no required apps), `widgets/EmbeddedWidgetDefinition.java` (`getApp()`), `messages_en.properties` (title).
|
|
37
|
+
- **Live workspace investigation:** Not run.
|
|
@@ -14,22 +14,73 @@ widgets build on.
|
|
|
14
14
|
|
|
15
15
|
## Dependencies
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
When this app is installed, the following apps are automatically installed:
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
| App | Qualified Name | Description |
|
|
20
|
+
|-----|----------------|-------------|
|
|
21
|
+
| Attribute Dependencies | `cf.cplace.attributeDependencies` | Required in the same workspace; hides tool-parameter fields by parameter type (`AiApp.getRequiredAppsInSameSpace`) |
|
|
22
|
+
| cplace Basis | `cf.cplace.platform` | Base platform (always installed) |
|
|
20
23
|
|
|
21
24
|
## Types Provided
|
|
22
25
|
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
+
### cf.cplace.lowcode.ai.assistantConfiguration (Citizen AI Assistant Configuration)
|
|
27
|
+
|
|
28
|
+
Configures one AI assistant: its instructions, model, tools and knowledge sources. The type keeps the
|
|
29
|
+
pre-rename prefix `cf.cplace.lowcode.ai`; attributes added later use `cf.cplace.citizenAi`.
|
|
30
|
+
|
|
31
|
+
| Attribute | Internal Name | Type | Required | Description |
|
|
32
|
+
|-----------|---------------|------|----------|-------------|
|
|
33
|
+
| Instructions | `cf.cplace.lowcode.ai.systemMessage` | Script (Markdown) | Yes | System message given to the model |
|
|
34
|
+
| Model | `cf.cplace.lowcode.ai.modelId` | Text (dynamic enumeration) | Yes | One of the chat models configured for the tenant |
|
|
35
|
+
| Temperature | `cf.cplace.lowcode.ai.temperature` | Number | Yes | Sampling temperature, with a default value |
|
|
36
|
+
| Seed | `cf.cplace.lowcode.ai.seed` | Number | No | Seed for reproducible answers |
|
|
37
|
+
| Max. Tokens | `cf.cplace.lowcode.ai.maxTokens` | Number | No | Upper bound for the answer length |
|
|
38
|
+
| Custom Tools | `cf.cplace.citizenAi.tools` | Reference (multiple, to Tool) | No | No-code tools the assistant may call |
|
|
39
|
+
| Platform Tools | `cf.cplace.citizenAi.platformTools` | Text (dynamic enumeration, multiple) | No | Built-in platform tools the assistant may call |
|
|
40
|
+
| Available in AI Companion | `cf.cplace.citizenAi.availableInAiCompanion` | Boolean | No | Offer the assistant in the AI Companion (default false) |
|
|
41
|
+
| Default in AI Companion | `cf.cplace.citizenAi.defaultInAiCompanion` | Boolean | No | Preselect the assistant in the AI Companion (default false) |
|
|
42
|
+
| Icon | `cf.cplace.citizenAi.companionIcon` | Icon | No | Icon shown in the AI Companion |
|
|
43
|
+
| Contextual Knowledge Sources | `cf.cplace.citizenAi.ragDataSources` | Text (dynamic enumeration, multiple) | No | Knowledge sources searched for context |
|
|
44
|
+
|
|
45
|
+
**Icon:** `fa-robot`
|
|
46
|
+
|
|
47
|
+
---
|
|
48
|
+
|
|
49
|
+
### cf.cplace.citizenAi.noCodeTool (Tool)
|
|
50
|
+
|
|
51
|
+
A scripted tool an assistant can call. Only users with Low-Code permission may create one or edit its script.
|
|
52
|
+
|
|
53
|
+
| Attribute | Internal Name | Type | Required | Description |
|
|
54
|
+
|-----------|---------------|------|----------|-------------|
|
|
55
|
+
| Tool Name | `cf.cplace.citizenAi.name` | Text | Yes | Name the model calls the tool by (`[a-zA-Z0-9-_]+`) |
|
|
56
|
+
| Description | `cf.cplace.citizenAi.description` | Long text | No | What the tool does, read by the model |
|
|
57
|
+
| Parameters | `cf.cplace.citizenAi.parameters` | Reference (multiple, to Tool Parameter) | No | The tool's parameters |
|
|
58
|
+
| Script | `cf.cplace.citizenAi.script` | Script | Yes | cplaceJS executed when the tool is called |
|
|
59
|
+
|
|
60
|
+
**Icon:** `fa-tools`
|
|
61
|
+
|
|
62
|
+
---
|
|
63
|
+
|
|
64
|
+
### cf.cplace.citizenAi.toolParameter (Tool Parameter)
|
|
65
|
+
|
|
66
|
+
One parameter of a Tool.
|
|
67
|
+
|
|
68
|
+
| Attribute | Internal Name | Type | Required | Description |
|
|
69
|
+
|-----------|---------------|------|----------|-------------|
|
|
70
|
+
| Parameter Name | `cf.cplace.citizenAi.name` | Text | Yes | Name of the parameter (`[a-zA-Z0-9-_]+`) |
|
|
71
|
+
| Description | `cf.cplace.citizenAi.description` | Long text | No | What the parameter means, read by the model |
|
|
72
|
+
| Type | `cf.cplace.citizenAi.type` | Enumeration | Yes | Parameter type |
|
|
73
|
+
| Required | `cf.cplace.citizenAi.required` | Boolean | No | Whether the model must pass it (default true) |
|
|
74
|
+
| Allowed Values | `cf.cplace.citizenAi.allowedValues` | Text (multiple) | No | Allowed values; hidden for Boolean parameters |
|
|
75
|
+
|
|
76
|
+
**Icon:** `fa-hashtag`
|
|
26
77
|
|
|
27
78
|
## Widgets Provided
|
|
28
79
|
|
|
29
80
|
| Widget | Widget Kind | Description | Use Case |
|
|
30
81
|
|--------|-------------|-------------|----------|
|
|
31
82
|
| Ask Your Page | `cf.cplace.citizenAi.askYourPageWidget` | Zero-configuration, read-only AI assistant that understands the current page's attributes, relationships, and attached files and answers natural-language questions with links to related pages. Maintains per-user conversation history per page. | Exploring information-rich or highly-connected pages; documentation and knowledge Q&A; relationship navigation. |
|
|
32
|
-
| Citizen AI Streaming Chat |
|
|
83
|
+
| Citizen AI Streaming Chat | `cf.cplace.citizenAi.streamingChatWidget` | The recommended AI chat widget for new use cases; replacement for the deprecated Chat Widget. Answers with the assistant configuration it is set to. | New AI chat use cases — use in place of the deprecated Chat Widget. |
|
|
33
84
|
| Chat Widget (deprecated) | `cf.cplace.lowcode.ai.chatWidget` | **Deprecated** — use Citizen AI Streaming Chat instead. A script-based (CplaceJS `checkAccess()` / `call()`) chat interface supporting custom data sources, custom tools, configurable memory, and shared or per-user history. Will be removed in a future version. | Legacy custom AI assistants; new work should use Citizen AI Streaming Chat. |
|
|
34
85
|
|
|
35
86
|
## Use Cases
|
|
@@ -56,8 +107,10 @@ listed below. Run the standard investigation (see `INVESTIGATION-PROMPT.md`) to
|
|
|
56
107
|
|
|
57
108
|
## Investigation Details
|
|
58
109
|
|
|
59
|
-
- **Source:**
|
|
110
|
+
- **Source:** Widgets from the in-repo widget specifications
|
|
60
111
|
(`src/plugins/core/widget-specifications/cf.cplace.lowcode.ai.chatWidget/`,
|
|
61
112
|
`.../cf.cplace.citizenAi.askYourPageWidget/`) and `_catalog-data.json`.
|
|
62
|
-
- **
|
|
63
|
-
|
|
113
|
+
- **Types and dependencies:** from the `cplace-citizen-ai` source — `AiAppTypes.java` (types, attributes,
|
|
114
|
+
labels from `messages_en.properties`), `AiApp.java` (`getRequiredAppsInSameSpace`), and
|
|
115
|
+
`StreamingChatWidgetDefinition.java` (the Streaming Chat widget kind).
|
|
116
|
+
- **Live workspace investigation:** Not run.
|
|
@@ -21,51 +21,56 @@ The Resource Management app enables configuration and planning of resources acro
|
|
|
21
21
|
|
|
22
22
|
## Types Provided
|
|
23
23
|
|
|
24
|
-
|
|
24
|
+
The attribute internal names carry the prefix `cf.cplace.resourceManagement.`; labels are the English ones
|
|
25
|
+
from `messages_en.properties`.
|
|
26
|
+
|
|
27
|
+
### cf.cplace.resourceManagement.resourceTypeConfiguration (Resource Type Configuration)
|
|
25
28
|
|
|
26
29
|
Configures which types in the workspace should be treated as **resources** (e.g., Person, Team, Machine).
|
|
27
30
|
|
|
28
|
-
| Attribute | Type | Required | Description |
|
|
29
|
-
|
|
30
|
-
| `cf.cplace.resourceManagement.type` |
|
|
31
|
-
| `cf.cplace.resourceManagement.capacityAttribute` |
|
|
32
|
-
| `cf.cplace.resourceManagement.actualAttribute` |
|
|
33
|
-
| `cf.cplace.resourceManagement.responsibleAttribute` |
|
|
34
|
-
| `cf.cplace.resourceManagement.userReferenceAttribute` |
|
|
35
|
-
| `cf.cplace.resourceManagement.icon` |
|
|
31
|
+
| Attribute | Internal Name | Type | Required | Description |
|
|
32
|
+
|-----------|---------------|------|----------|-------------|
|
|
33
|
+
| Resource Type | `cf.cplace.resourceManagement.type` | Text (type name, dynamic enumeration) | Yes | The type to be used as a resource |
|
|
34
|
+
| Capacity Attribute | `cf.cplace.resourceManagement.capacityAttribute` | Text (attribute name, dynamic enumeration) | No | Attribute defining the capacity of the resource |
|
|
35
|
+
| Actual Attribute | `cf.cplace.resourceManagement.actualAttribute` | Text (attribute name, dynamic enumeration) | No | Attribute defining the actual/used value |
|
|
36
|
+
| Responsible Attribute | `cf.cplace.resourceManagement.responsibleAttribute` | Text (attribute name, dynamic enumeration) | No | Attribute defining responsible person(s) |
|
|
37
|
+
| User Reference Attribute | `cf.cplace.resourceManagement.userReferenceAttribute` | Text (attribute name, dynamic enumeration) | No | Attribute for displaying user profile picture |
|
|
38
|
+
| Icon | `cf.cplace.resourceManagement.icon` | Icon | No | Icon displayed in Resource Planner widget |
|
|
36
39
|
|
|
37
|
-
### cf.cplace.resourceManagement.planningItemTypeConfiguration
|
|
40
|
+
### cf.cplace.resourceManagement.planningItemTypeConfiguration (Planning Item Type Configuration)
|
|
38
41
|
|
|
39
42
|
Configures which types in the workspace should be treated as **planning items** (e.g., Task, Project, Work Package).
|
|
40
43
|
|
|
41
|
-
| Attribute | Type | Required | Description |
|
|
42
|
-
|
|
43
|
-
| `cf.cplace.resourceManagement.type` |
|
|
44
|
-
| `cf.cplace.resourceManagement.demandAttribute` |
|
|
45
|
-
| `cf.cplace.resourceManagement.actualAttribute` |
|
|
46
|
-
| `cf.cplace.resourceManagement.icon` |
|
|
44
|
+
| Attribute | Internal Name | Type | Required | Description |
|
|
45
|
+
|-----------|---------------|------|----------|-------------|
|
|
46
|
+
| Planning Item Type | `cf.cplace.resourceManagement.type` | Text (type name, dynamic enumeration) | Yes | The type to be used as a planning item |
|
|
47
|
+
| Demand Attribute | `cf.cplace.resourceManagement.demandAttribute` | Text (attribute name, dynamic enumeration) | No | Attribute defining the demand/need |
|
|
48
|
+
| Actual Attribute | `cf.cplace.resourceManagement.actualAttribute` | Text (attribute name, dynamic enumeration) | No | Attribute defining the actual value |
|
|
49
|
+
| Icon | `cf.cplace.resourceManagement.icon` | Icon | No | Icon displayed in Resource Planner widget |
|
|
47
50
|
|
|
48
|
-
### cf.cplace.resourceManagement.valueTypeConfiguration
|
|
51
|
+
### cf.cplace.resourceManagement.valueTypeConfiguration (Value Type Configuration)
|
|
49
52
|
|
|
50
53
|
Configures which types represent **allocation values** that connect resources to planning items.
|
|
51
54
|
|
|
52
|
-
| Attribute | Type | Required | Description |
|
|
53
|
-
|
|
54
|
-
| `cf.cplace.resourceManagement.type` |
|
|
55
|
-
| `cf.cplace.resourceManagement.resourceAttribute` |
|
|
56
|
-
| `cf.cplace.resourceManagement.planningItemAttribute` |
|
|
57
|
-
| `cf.cplace.resourceManagement.
|
|
55
|
+
| Attribute | Internal Name | Type | Required | Description |
|
|
56
|
+
|-----------|---------------|------|----------|-------------|
|
|
57
|
+
| Value Type | `cf.cplace.resourceManagement.type` | Text (type name, dynamic enumeration) | Yes | The type to be used as a value type |
|
|
58
|
+
| Attribute for Resource | `cf.cplace.resourceManagement.resourceAttribute` | Text (attribute name, dynamic enumeration) | No | Attribute linking to the resource |
|
|
59
|
+
| Attribute for Planning Item | `cf.cplace.resourceManagement.planningItemAttribute` | Text (attribute name, dynamic enumeration) | No | Attribute linking to the planning item |
|
|
60
|
+
| Requested Demand | `cf.cplace.resourceManagement.requestedDemandAttribute` | Time-bounded value mapping | No | Attribute holding the requested demand of the value type |
|
|
61
|
+
| Allocation | `cf.cplace.resourceManagement.allocationAttribute` | Time-bounded value mapping | No | Attribute holding the allocation of the value type |
|
|
62
|
+
| Icon | `cf.cplace.resourceManagement.icon` | Icon | No | Icon displayed in Resource Management widgets |
|
|
58
63
|
|
|
59
|
-
### cf.cplace.resourceManagement.tooltip
|
|
64
|
+
### cf.cplace.resourceManagement.tooltip (Tooltip)
|
|
60
65
|
|
|
61
66
|
Configures custom tooltips for the Resource Planner widget.
|
|
62
67
|
|
|
63
|
-
| Attribute | Type | Required | Description |
|
|
64
|
-
|
|
65
|
-
| `cf.cplace.resourceManagement.isActive` | Boolean |
|
|
66
|
-
| `cf.cplace.resourceManagement.isDefault` | Boolean |
|
|
67
|
-
| `cf.cplace.resourceManagement.referencedTypes` |
|
|
68
|
-
| `cf.cplace.resourceManagement.script` |
|
|
68
|
+
| Attribute | Internal Name | Type | Required | Description |
|
|
69
|
+
|-----------|---------------|------|----------|-------------|
|
|
70
|
+
| Activated | `cf.cplace.resourceManagement.isActive` | Boolean | No | Whether this tooltip is active (default false) |
|
|
71
|
+
| Default Tooltip | `cf.cplace.resourceManagement.isDefault` | Boolean | No | Whether this is the default tooltip for all types (default false) |
|
|
72
|
+
| Referenced Type | `cf.cplace.resourceManagement.referencedTypes` | Text (type names, dynamic enumeration, multiple) | No | Specific types this tooltip applies to |
|
|
73
|
+
| Script | `cf.cplace.resourceManagement.script` | Script | No | cplaceJS script to generate custom tooltip content |
|
|
69
74
|
|
|
70
75
|
## Widgets Provided
|
|
71
76
|
|
|
@@ -105,6 +110,13 @@ The Resource Planner widget provides:
|
|
|
105
110
|
|-----|---------|
|
|
106
111
|
| `cf.cplace.resourceManagement.resourceManagementChart` | Additional chart visualizations for resource data |
|
|
107
112
|
| `cf.cplace.projectPlanning.app.basic.basicScheduleManagement` | Schedule, Task, Milestone types that can be used as planning items |
|
|
113
|
+
| `cf.cplace.resourceManagement.predefinedValueTypes` | Optional companion: adds the value types "Resource Request" and "Resource Answer" and their Value Type Configurations |
|
|
114
|
+
|
|
115
|
+
### Optional Companion: Predefined Value Types
|
|
116
|
+
|
|
117
|
+
`cf.cplace.resourceManagement.predefinedValueTypes` (Value Types "Resource Request" and "Resource Answer") is a
|
|
118
|
+
separate app that requires this one. Install it when the solution plans with requests and answers instead of
|
|
119
|
+
defining its own value type; it brings the two types and configures them as value types.
|
|
108
120
|
|
|
109
121
|
### Prerequisites
|
|
110
122
|
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# Value Types "Resource Request" and "Resource Answer" (cf.cplace.resourceManagement.predefinedValueTypes)
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
Adds the value types "Resource Request" and "Resource Answer" to the workspace. On install it also creates a
|
|
6
|
+
Value Type Configuration for each: the request's allocation is mapped as the *Requested Demand*, the answer's as
|
|
7
|
+
the *Allocation*. It is the optional companion of Resource Management for solutions that plan with requests and
|
|
8
|
+
answers rather than with a value type of their own.
|
|
9
|
+
|
|
10
|
+
**Plugin:** `cf.cplace.resourceManagement`
|
|
11
|
+
|
|
12
|
+
**Repository:** `cplace-resource-management`
|
|
13
|
+
|
|
14
|
+
## Dependencies
|
|
15
|
+
|
|
16
|
+
When this app is installed, the following apps are automatically installed:
|
|
17
|
+
|
|
18
|
+
| App | Qualified Name | Description |
|
|
19
|
+
|-----|----------------|-------------|
|
|
20
|
+
| Resource Management | `cf.cplace.resourceManagement` | Required in the same workspace (`PredefinedValueTypesApp.getRequiredAppsInSameSpace`) |
|
|
21
|
+
| cplace Basis | `cf.cplace.platform` | Base platform (always installed) |
|
|
22
|
+
|
|
23
|
+
## Types Provided
|
|
24
|
+
|
|
25
|
+
Both types share the value-type attributes of Resource Management (prefix `cf.cplace.resourceManagement.`).
|
|
26
|
+
|
|
27
|
+
### cf.cplace.resourceManagement.request (Resource Request)
|
|
28
|
+
|
|
29
|
+
A demand for a resource on a planning item over time.
|
|
30
|
+
|
|
31
|
+
| Attribute | Internal Name | Type | Required | Description |
|
|
32
|
+
|-----------|---------------|------|----------|-------------|
|
|
33
|
+
| Resource | `cf.cplace.resourceManagement.resource` | Reference (any type) | No | The requested resource |
|
|
34
|
+
| Planning Item | `cf.cplace.resourceManagement.planningItem` | Reference (any type) | No | The planning item the demand is for |
|
|
35
|
+
| Requested Demand | `cf.cplace.resourceManagement.values` | Time-bounded values (multiple) | No | The demand per period |
|
|
36
|
+
| Resource Answer(s) | `cf.cplace.resourceManagement.answer` | Reference (multiple, to Resource Answer) | No | The answers to this request |
|
|
37
|
+
| Note | `cf.cplace.resourceManagement.note` | Long text | No | Free-text note |
|
|
38
|
+
| Time Range - Start | `cf.cplace.resourceManagement.startDate` | Date | No | Start of the values (read-only, derived) |
|
|
39
|
+
| Time Range - End | `cf.cplace.resourceManagement.endDate` | Date | No | End of the values (read-only, derived) |
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
### cf.cplace.resourceManagement.answer (Resource Answer)
|
|
44
|
+
|
|
45
|
+
The allocation granted in answer to a Resource Request.
|
|
46
|
+
|
|
47
|
+
| Attribute | Internal Name | Type | Required | Description |
|
|
48
|
+
|-----------|---------------|------|----------|-------------|
|
|
49
|
+
| Resource | `cf.cplace.resourceManagement.resource` | Reference (any type) | No | The allocated resource |
|
|
50
|
+
| Planning Item | `cf.cplace.resourceManagement.planningItem` | Reference (any type) | No | The planning item the allocation is for |
|
|
51
|
+
| Allocation | `cf.cplace.resourceManagement.values` | Time-bounded values (multiple) | No | The allocation per period |
|
|
52
|
+
| Resource Request | `cf.cplace.resourceManagement.originalRequest` | Reference (to Resource Request) | Yes | The request this answers |
|
|
53
|
+
| Note | `cf.cplace.resourceManagement.note` | Long text | No | Free-text note |
|
|
54
|
+
| Time Range - Start | `cf.cplace.resourceManagement.startDate` | Date | No | Start of the values (read-only, derived) |
|
|
55
|
+
| Time Range - End | `cf.cplace.resourceManagement.endDate` | Date | No | End of the values (read-only, derived) |
|
|
56
|
+
|
|
57
|
+
## Widgets Provided
|
|
58
|
+
|
|
59
|
+
None. The Resource Planner widget comes from Resource Management.
|
|
60
|
+
|
|
61
|
+
## Investigation Details
|
|
62
|
+
|
|
63
|
+
- **Source:** the `cplace-resource-management` source — `PredefinedValueTypesApp.java` (required app, types,
|
|
64
|
+
install hook), `types/RequestType.java`, `types/AnswerType.java`, `types/MixinTypes.java` (attributes),
|
|
65
|
+
`messages_en.properties` (labels). The qualified name follows the platform's `App.computeQualifiedName`
|
|
66
|
+
(package plus class name without `App`).
|
|
67
|
+
- **Live workspace investigation:** Not run.
|