@uipath/skills 1.195.0 → 1.196.0

package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/GetEntityRecordById.md

@@ -0,0 +1,50 @@
+# Get Entity Record By Id
+
+`UiPath.DataService.Activities.GetEntityRecordById<TEntity>`
+
+**Package:** `UiPath.DataService.Activities`
+
+Retrieves a single record from a Data Fabric entity by its ID.
+
+**Category:** Data Service.Entity Record
+
+## Properties
+
+`x:TypeArguments` — concrete entity type, e.g. `local:EntityName`. Required at activity declaration.
+
+### Input
+
+| Property | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
+| `EntityId` | `InArgument<Guid>` | Yes | — | Entity GUID from `EntitiesStore.json` |
+| `RecordId` | `InArgument<Guid>` | Yes | — | GUID of the record to retrieve (validated — null produces error) |
+| `ExpansionDepth` | `InArgument<int>` | No | `2` | Depth of relationship expansion in response (range: 1–3, max `3`). Controls relationship-field shape on the returned record — see [overview § Relationship Fields & ExpansionDepth](../overview.md#relationship-fields--expansiondepth) |
+
+### Output
+
+| Property | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
+| `OutputEntity` | `OutArgument<TEntity>` | Yes | — | Variable to receive the retrieved record |
+
+### Common
+
+| Property | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
+| `ContinueOnError` | `InArgument<bool>` | No | `false` | Continue workflow on error |
+| `TimeoutInMs` | `InArgument<int>` | No | `30000` | Timeout in milliseconds |
+
+> **Solution scope properties** (`ScopeValue`, `SolutionEntityKey`, `SolutionEntityName`) only apply when the project has a SolutionId. For standalone projects, omit them. See [overview — Solution Scope Properties](../overview.md#solution-scope-properties-conditional) and [Solution Context](../overview.md#solution-context-folder-vs-tenant-scope).
+
+## XAML Example
+
+```xml
+<uda:GetEntityRecordById
+    x:TypeArguments="local:ENTITY_NAME"
+    ContinueOnError="False"
+    DisplayName="Get ENTITY_NAME by ID"
+    EntityId="ENTITY_GUID"
+    RecordId="[recordIdVariable]"
+    ExpansionDepth="2"
+    OutputEntity="[resultVariable]"
+    TimeoutInMs="30000" />
+```

package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/QueryEntityRecords.md

@@ -0,0 +1,69 @@
+# Query Entity Records
+
+`UiPath.DataService.Activities.QueryEntityRecords<TEntity>`
+
+**Package:** `UiPath.DataService.Activities`
+
+Queries records from a Data Fabric entity with optional filtering, sorting, and pagination.
+
+**Category:** Data Service.Entity Record
+
+## Properties
+
+`x:TypeArguments` — concrete entity type, e.g. `local:EntityName`. Required at activity declaration.
+
+### Input
+
+| Property | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
+| `EntityId` | `InArgument<Guid>` | Yes | — | Entity GUID from `EntitiesStore.json` |
+| `Top` | `InArgument<int>` | No | `100` | Maximum records to return (range: 1–1000; use `Skip` for pagination beyond 1000) |
+| `Skip` | `InArgument<long>` | No | `0` | Number of records to skip (pagination offset, `>= 0`). If `Skip` exceeds the total matching records, the result is empty. |
+| `SortByField` | `InArgument<string>` | No | — | Field name to sort by |
+| `ExpansionDepth` | `InArgument<int>` | No | `2` | Depth of relationship expansion (range: 1–3, max `3`). Controls relationship-field shape on returned records and gates dot-notation filterability — see [overview § Relationship Fields & ExpansionDepth](../overview.md#relationship-fields--expansiondepth) |
+| `FilterArguments` | `FilterArgument` | No | — | Filter definition (set via Studio designer; `[Browsable(false)]`) |
+| `FilterValues` | `IList<InArgument>` | No | — | Filter parameter values (set via Studio designer; `[Browsable(false)]`) |
+| `SortAscending` | `InArgument<bool>` | No | `true` | Sort direction |
+| `QueriedEntityId` | `Guid` | No | — | **Deprecated — do not use.** Legacy design-time entity tracking (`[Browsable(false)]`). Use `EntityId` instead. |
+
+### Output
+
+| Property | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
+| `OutputRecords` | `OutArgument<IList<TEntity>>` | Yes | — | Variable to receive the list of matching records |
+| `TotalRecords` | `OutArgument<long>` | No | — | Variable to receive total count (before pagination) |
+
+### Common
+
+| Property | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
+| `ContinueOnError` | `InArgument<bool>` | No | `false` | Continue workflow on error |
+| `TimeoutInMs` | `InArgument<int>` | No | `30000` | Timeout in milliseconds |
+
+> **Solution scope properties** (`ScopeValue`, `SolutionEntityKey`, `SolutionEntityName`) only apply when the project has a SolutionId. For standalone projects, omit them. See [overview — Solution Scope Properties](../overview.md#solution-scope-properties-conditional) and [Solution Context](../overview.md#solution-context-folder-vs-tenant-scope).
+
+## XAML Example (no filter)
+
+```xml
+<uda:QueryEntityRecords
+    x:TypeArguments="local:ENTITY_NAME"
+    ContinueOnError="False"
+    DisplayName="Query ENTITY_NAME Records"
+    EntityId="ENTITY_GUID"
+    ExpansionDepth="2"
+    Top="100"
+    Skip="0"
+    SortByField="[&quot;Name&quot;]"
+    SortAscending="True"
+    OutputRecords="[resultsVariable]"
+    TotalRecords="[totalCountVariable]"
+    TimeoutInMs="30000" />
+```
+
+## Filter XAML Generation
+
+`FilterArguments` and `FilterValues` are `[Browsable(false)]` — they do not appear in the Studio properties panel but can be generated in XAML. For structure, operator-string mappings, XML escaping, value-slot typing, nested-group templates, and worked examples, see [data-service-filter-builder-guide](../guides/data-service-filter-builder-guide.md).
+
+## Key Rules
+
+- `TotalRecords` returns the total count matching the filter, regardless of `Top`/`Skip` — useful for pagination logic

package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/UpdateEntityRecord.md

@@ -0,0 +1,120 @@
+# Update Entity Record
+
+`UiPath.DataService.Activities.UpdateEntityRecord<TEntity>`
+
+**Package:** `UiPath.DataService.Activities`
+
+Updates an existing record in a Data Fabric entity.
+
+**Category:** Data Service.Entity Record
+
+> **Single vs batch — use this only for ONE record.** For N records (each entity object pre-populated with its `Id`), use [UpdateMultipleEntityRecords](UpdateMultipleEntityRecords.md) — one HTTP request and partial-batch failure reporting via `FailedRecords`. Updating inside a `ForEach` loop is a performance anti-pattern. Full decision guide: [overview — When to Use Batch vs Single-Record Activities](../overview.md#when-to-use-batch-vs-single-record-activities).
+
+## Properties
+
+`x:TypeArguments` — concrete entity type, e.g. `local:EntityName`. Required at activity declaration.
+
+### Input
+
+| Property | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
+| `EntityId` | `InArgument<Guid>` | Yes | — | Entity GUID from `EntitiesStore.json` |
+| `RecordId` | `InArgument<Guid>` | Yes | — | GUID of the record to update |
+| `InputEntityInFieldView` | `InArgument<TEntity>` | Yes | — | Object-initializer expression with updated field values (runtime reads this) |
+| `InputEntity` | `InArgument<TEntity>` | No | — | Not recommended — Studio never syncs `SelectedFields` to this property, causing desync |
+| `State` | `RecordState` | Yes | — | Contains `SelectedFields` with field GUIDs and values (Studio card UI reads this) |
+| `ExpansionDepth` | `InArgument<int>` | No | `2` | Depth of relationship expansion in response (range: 1–3, max `3`). On write, relationship fields take **only** the target record's Id GUID — see [overview § Relationship Fields & ExpansionDepth](../overview.md#relationship-fields--expansiondepth) |
+
+### Output
+
+| Property | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
+| `OutputEntity` | `OutArgument<TEntity>` | No | — | Receives the updated record |
+
+### Configuration
+
+| Property | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
+| `IsInRecordView` | `InArgument<bool>` | Yes | — | Set to `[False]` — makes runtime read `InputEntityInFieldView` |
+| `VisibleDynamicPropertiesInfo` | `InArgument<string>` | No | `{x:Null}` | Always set to `{x:Null}` |
+
+### Common
+
+| Property | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
+| `ContinueOnError` | `InArgument<bool>` | No | `false` | Continue workflow on error |
+| `TimeoutInMs` | `InArgument<int>` | No | `30000` | Timeout in milliseconds |
+
+> **Solution scope properties** (`ScopeValue`, `SolutionEntityKey`, `SolutionEntityName`) only apply when the project has a SolutionId. For standalone projects, omit them. See [overview — Solution Scope Properties](../overview.md#solution-scope-properties-conditional) and [Solution Context](../overview.md#solution-context-folder-vs-tenant-scope).
+
+## Field Binding — Two Required Components
+
+For Create and Update activities, set `IsInRecordView="[False]"` and populate two things:
+
+1. **`InputEntityInFieldView`** — object-initializer expression with updated field values. The runtime evaluates this expression and sends it to the Data Service API.
+2. **`State` with `RecordState.SelectedFields`** — declares each field with its GUID from `EntitiesStore.json` and its value. Studio's card UI reads this to render per-field editors.
+
+Studio syncs `SelectedFields` → `InputEntityInFieldView` on file load, keeping them aligned. Do NOT use `InputEntity` — Studio never syncs `SelectedFields` to it, which causes the card UI to show one value while the runtime uses a stale one.
+
+## RecordState and DynamicEntityField
+
+`RecordState` properties:
+
+| Property | Type | Description |
+|----------|------|-------------|
+| `IsInRecordView` | `bool` | Set to `False` |
+| `RequiredFieldCount` | `int` | Count of `DynamicEntityField` entries where `IsRequired="True"` |
+| `SelectedFields` | `IList<DynamicEntityField>` | List of field declarations |
+
+`DynamicEntityField` properties:
+
+| Property | Type | Description |
+|----------|------|-------------|
+| `Id` | `Guid` | Field GUID from `EntitiesStore.json` → `Fields[].Id` |
+| `Name` | `string` | Field name from `EntitiesStore.json` → `Fields[].Name` |
+| `IsRequired` | `bool` | Whether the field is required |
+| `ArgumentValue` | `Argument` | The value as `InArgument` with appropriate `x:TypeArguments` |
+
+## XAML Example (VB.NET expression language)
+
+> This snippet uses the `udam:` prefix (`RecordState`, `DynamicEntityField`). Ensure `xmlns:udam` is declared on the root `<Activity>` element — see [overview — XAML Namespace Declarations](../overview.md#xaml-namespace-declarations).
+
+```xml
+<uda:UpdateEntityRecord
+    x:TypeArguments="local:ENTITY_NAME"
+    OutputEntity="{x:Null}"
+    VisibleDynamicPropertiesInfo="{x:Null}"
+    ContinueOnError="False"
+    DisplayName="Update ENTITY_NAME Record"
+    EntityId="ENTITY_GUID"
+    ExpansionDepth="2"
+    RecordId="[recordIdVariable]"
+    InputEntityInFieldView="[New ENTITY_NAME() With {.FIELD_A = &quot;newValue&quot;}]"
+    IsInRecordView="[False]"
+    TimeoutInMs="30000">
+  <uda:UpdateEntityRecord.State>
+    <udam:RecordState IsInRecordView="False" RequiredFieldCount="0">
+      <udam:RecordState.SelectedFields>
+        <scg:List x:TypeArguments="udam:DynamicEntityField">
+          <udam:DynamicEntityField Id="FIELD_A_GUID" IsRequired="False" Name="FIELD_A">
+            <udam:DynamicEntityField.ArgumentValue>
+              <InArgument x:TypeArguments="x:String">[&quot;newValue&quot;]</InArgument>
+            </udam:DynamicEntityField.ArgumentValue>
+          </udam:DynamicEntityField>
+        </scg:List>
+      </udam:RecordState.SelectedFields>
+    </udam:RecordState>
+  </uda:UpdateEntityRecord.State>
+</uda:UpdateEntityRecord>
+```
+
+Replace: `ENTITY_NAME` (entity class), `ENTITY_GUID` (from `EntitiesStore.json` → `Entities[].Id`), `FIELD_A` (field name), `FIELD_A_GUID` (from `Fields[].Id`).
+
+## Key Rules
+
+- Set `IsInRecordView="[False]"` and populate both `InputEntityInFieldView` and `RecordState.SelectedFields` — do NOT use `InputEntity`
+- At least one field in `SelectedFields` must have an `ArgumentValue` set — otherwise validation fails with "No update fields specified"
+- If the `InputEntityInFieldView` expression does not set `Id`, the activity copies `RecordId` into the entity automatically at runtime
+- Only include fields you want to update in `SelectedFields` and `InputEntityInFieldView` — unchanged fields can be omitted
+- `VisibleDynamicPropertiesInfo` must always be set to `{x:Null}` — the type `DynamicPropertiesInfo` is not public
+- Entity fields cannot be set as direct activity properties — `<uda:UpdateEntityRecord.FieldName>` produces `Cannot set unknown member`

package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/UpdateMultipleEntityRecords.md

@@ -0,0 +1,67 @@
+# Update Multiple Entity Records
+
+`UiPath.DataService.Activities.UpdateMultipleEntityRecords<TEntity>`
+
+**Package:** `UiPath.DataService.Activities`
+
+Updates multiple records in a Data Fabric entity in a single batch operation.
+
+**Category:** Data Service.Batch
+
+> **Batch vs single — use this for N records.** For exactly one record with design-time field bindings, use [UpdateEntityRecord](UpdateEntityRecord.md) — it accepts `RecordId` directly and exposes Studio's card UI via `RecordState.SelectedFields`. Batch requires each entity in `InputRecords` to have its `Id` property set. Full decision guide: [overview — When to Use Batch vs Single-Record Activities](../overview.md#when-to-use-batch-vs-single-record-activities).
+
+## Properties
+
+`x:TypeArguments` — concrete entity type, e.g. `local:EntityName`. Required at activity declaration.
+
+### Input
+
+| Property | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
+| `EntityId` | `InArgument<Guid>` | Yes | — | Entity GUID from `EntitiesStore.json` |
+| `InputRecords` | `InArgument<ICollection<TEntity>>` | Yes | — | Collection of entity objects to update (`[RequiredArgument]`) |
+| `ExpansionDepth` | `InArgument<int>` | No | `2` | Depth of relationship expansion in response (range: 1–3, max `3`). On write, relationship fields on each input entity take **only** the target record's Id GUID — see [overview § Relationship Fields & ExpansionDepth](../overview.md#relationship-fields--expansiondepth) |
+
+### Output
+
+| Property | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
+| `OutputRecords` | `OutArgument<IList<TEntity>>` | No | — | Successfully updated records |
+| `FailedRecords` | `OutArgument<IList<Tuple<string, TEntity>>>` | No | — | Failed records with error messages |
+
+### Configuration
+
+| Property | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
+| `ContinueBatchOnFailure` | `InArgument<bool>` | No | `true` | If `true`, continues processing remaining records when one fails |
+
+### Common
+
+| Property | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
+| `ContinueOnError` | `InArgument<bool>` | No | `false` | Continue workflow on error |
+| `TimeoutInMs` | `InArgument<int>` | No | `30000` | Timeout in milliseconds |
+
+> **Solution scope properties** (`ScopeValue`, `SolutionEntityKey`, `SolutionEntityName`) only apply when the project has a SolutionId. For standalone projects, omit them. See [overview — Solution Scope Properties](../overview.md#solution-scope-properties-conditional) and [Solution Context](../overview.md#solution-context-folder-vs-tenant-scope).
+
+## XAML Example
+
+```xml
+<uda:UpdateMultipleEntityRecords
+    x:TypeArguments="local:ENTITY_NAME"
+    ContinueOnError="False"
+    DisplayName="Update Multiple ENTITY_NAME Records"
+    EntityId="ENTITY_GUID"
+    ExpansionDepth="2"
+    ContinueBatchOnFailure="True"
+    InputRecords="[recordsCollection]"
+    OutputRecords="[successRecords]"
+    FailedRecords="[failedRecords]"
+    TimeoutInMs="30000" />
+```
+
+## Key Rules
+
+- Each entity object in `InputRecords` must have its `Id` property set to the record GUID being updated
+- `FailedRecords` contains `Tuple<string, TEntity>` — `Item1` is the error message, `Item2` is the failed record
+- Same batch failure behavior as `CreateMultipleEntityRecords`

package/skills/uipath-rpa/references/activity-docs/UiPath.DataService.Activities/activities/UploadFileToRecordField.md

@@ -0,0 +1,103 @@
+# Upload File To Record Field
+
+`UiPath.DataService.Activities.UploadFileToRecordField<TEntity>`
+
+**Package:** `UiPath.DataService.Activities`
+
+Uploads a file to a file-type field on an entity record.
+
+**Category:** Data Service.File
+
+## Properties
+
+`x:TypeArguments` — concrete entity type, e.g. `local:EntityName`. Required at activity declaration.
+
+### Input
+
+| Property | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
+| `EntityId` | `InArgument<Guid>` | Yes | — | Entity GUID from `EntitiesStore.json` |
+| `RecordId` | `InArgument<Guid>` | Yes | — | GUID of the target record (`[RequiredArgument]`) |
+| `Field` | `InArgument<string>` | Yes | — | Name of the file field (`[RequiredArgument]`, `[Browsable(false)]`) |
+| `FilePath` | `InArgument<string>` | Cond. | — | Local file path to upload (one of `FilePath` or `FileResource` required). **Max file size: 10 MB.** |
+| `FileResource` | `InArgument<IResource>` | Cond. | — | Resource object to upload (alternative to `FilePath`). **Max file size: 10 MB.** |
+| `ExpansionDepth` | `InArgument<int>` | No | `2` | Depth of relationship expansion on the returned entity (range: 1–3, max `3`) — see [overview § Relationship Fields & ExpansionDepth](../overview.md#relationship-fields--expansiondepth) |
+
+### Output
+
+| Property | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
+| `OutputEntity` | `OutArgument<TEntity>` | No | — | Receives the updated entity after upload |
+
+### Common
+
+| Property | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
+| `ContinueOnError` | `InArgument<bool>` | No | `false` | Continue workflow on error |
+| `TimeoutInMs` | `InArgument<int>` | No | `30000` | Timeout in milliseconds |
+
+> **Solution scope properties** (`ScopeValue`, `SolutionEntityKey`, `SolutionEntityName`) are inherited from `BaseEntityActivity` and exist on every activity, but only apply when the project has a SolutionId. For standalone projects, omit them — they're ignored outside solution context. See [overview — Solution Scope Properties](../overview.md#solution-scope-properties-conditional) and [Solution Context](../overview.md#solution-context-folder-vs-tenant-scope).
+
+## XAML Example — Upload from FilePath
+
+```xml
+<uda:UploadFileToRecordField
+    x:TypeArguments="local:ENTITY_NAME"
+    FileResource="{x:Null}"
+    InputEntity="{x:Null}"
+    OutputEntity="{x:Null}"
+    ContinueOnError="False"
+    DisplayName="Upload File to ENTITY_NAME"
+    EntityId="ENTITY_GUID"
+    ExpansionDepth="2"
+    Field="FILE_FIELD_NAME"
+    FilePath="C:\path\to\file.pdf"
+    RecordId="[recordIdVariable]"
+    TimeoutInMs="30000" />
+```
+
+- `Field` — bare string, not expression-wrapped. Use the field name exactly as it appears in `EntitiesStore.json`
+- `FilePath` — bare string for literal paths. Use expression syntax (`[variableName]`) only when the path comes from a variable
+- When using `FilePath`, set `FileResource="{x:Null}"`
+- Studio explicitly serializes unused nullable properties as `{x:Null}` — include them for properties that exist on the activity (do not include `ScopeValue`/`SolutionEntityKey`/`SolutionEntityName` in standalone projects)
+
+## XAML Example — Upload from FileResource (Round-Trip)
+
+```xml
+<uda:UploadFileToRecordField
+    x:TypeArguments="local:ENTITY_NAME"
+    FilePath="{x:Null}"
+    InputEntity="{x:Null}"
+    OutputEntity="{x:Null}"
+    ContinueOnError="False"
+    DisplayName="Upload File to ENTITY_NAME"
+    EntityId="ENTITY_GUID"
+    ExpansionDepth="2"
+    Field="FILE_FIELD_NAME"
+    FileResource="[downloadedFileResource]"
+    RecordId="[recordIdVariable]"
+    TimeoutInMs="30000" />
+```
+
+- When using `FileResource`, set `FilePath="{x:Null}"`
+- `downloadedFileResource` is typed as `upr:ILocalResource` (`UiPath.Platform.ResourceHandling.ILocalResource`) — the output of `DownloadFileFromRecordField.DownloadedFileResource`
+- `ILocalResource` is assignment-compatible with `IResource` (the `FileResource` input type) — no cast needed
+- **This is the preferred pattern for round-trip file copies** — it preserves the original filename. See [DownloadFileFromRecordField — Round-Trip Pattern](DownloadFileFromRecordField.md#round-trip-pattern-download--upload)
+
+## When to Use FilePath vs FileResource
+
+| Scenario | Use | Set the other to |
+|----------|-----|-----------------|
+| File comes from another activity in the same workflow (e.g., `DownloadFileFromRecordField`) | `FileResource="[downloadedFileResource]"` | `FilePath="{x:Null}"` |
+| File is at a known path on disk (user-specified or hardcoded) | `FilePath="C:\path\to\file.pdf"` | `FileResource="{x:Null}"` |
+
+**Never fabricate a temp file path** to bridge two activities. If the file originates from `DownloadFileFromRecordField`, chain via `FileResource` — it preserves the original filename. Fabricated paths (e.g., `"C:\temp\file_" & guid & ".pdf"`) lose the filename and create cleanup obligations.
+
+## Key Rules
+
+- **Maximum file size is 10 MB.** Uploads larger than 10 MB are rejected by the Data Service API at runtime — split or compress before calling this activity
+- Either `FilePath` or `FileResource` must be provided — if both are `{x:Null}`, validation fails
+- **Prefer `FileResource` for round-trip file copies** — pass the `ILocalResource` from download directly; this preserves the original filename
+- If `FileResource` is provided, it is resolved to a local path at runtime via `ToLocalResource().ResolveAsync()`
+- The `Field` property must match a field with `FieldDisplayType: "File"` in `EntitiesStore.json`
+- `Field` and `FilePath` accept bare strings for literal values — do not wrap in expression brackets (`[...]`) unless the value comes from a variable