@uipath/delegate-sdk 1.203.1 → 1.203.3
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/README.md +41 -3
- package/dist/index.mjs +2 -2
- package/dist/skills/business-analysis/SKILL.md +729 -0
- package/dist/skills/business-analysis/as-is-capture.md +444 -0
- package/dist/skills/business-analysis/assets/progress.yaml +19 -0
- package/dist/skills/business-analysis/assets/task-list.md +34 -0
- package/dist/skills/business-analysis/automation-hub-publishing.md +47 -0
- package/dist/skills/business-analysis/bpmn-to-be-design.md +274 -0
- package/dist/skills/business-analysis/case-to-be-design.md +223 -0
- package/dist/skills/business-analysis/diagram-authoring.md +224 -0
- package/dist/skills/business-analysis/industry-gaps.md +134 -0
- package/dist/skills/business-analysis/interview-spine.md +297 -0
- package/dist/skills/business-analysis/locales/de.json +54 -0
- package/dist/skills/business-analysis/locales/en.json +54 -0
- package/dist/skills/business-analysis/locales/es-MX.json +54 -0
- package/dist/skills/business-analysis/locales/es.json +54 -0
- package/dist/skills/business-analysis/locales/fr.json +54 -0
- package/dist/skills/business-analysis/locales/ja.json +54 -0
- package/dist/skills/business-analysis/locales/ko.json +54 -0
- package/dist/skills/business-analysis/locales/pt-BR.json +54 -0
- package/dist/skills/business-analysis/locales/pt.json +54 -0
- package/dist/skills/business-analysis/locales/ro.json +54 -0
- package/dist/skills/business-analysis/locales/tr.json +54 -0
- package/dist/skills/business-analysis/locales/zh-CN.json +54 -0
- package/dist/skills/business-analysis/locales/zh-TW.json +54 -0
- package/dist/skills/business-analysis/pdd-generation.md +204 -0
- package/dist/skills/business-analysis/pdd-template.md +562 -0
- package/dist/skills/business-analysis/progress-presentation.json +13 -0
- package/dist/skills/business-analysis/recording-first.md +19 -0
- package/dist/skills/business-analysis/recording-processing.md +152 -0
- package/dist/skills/business-analysis/references/automation-hub-open-api.md +57 -0
- package/dist/skills/business-analysis/references/case-definition-spec.md +90 -0
- package/dist/skills/business-analysis/references/case-design-patterns/loan-origination-spec.md +86 -0
- package/dist/skills/business-analysis/references/component-type-mapping.md +52 -0
- package/dist/skills/business-analysis/references/uipath-products/case-management-schema.md +62 -0
- package/dist/skills/business-analysis/references/uipath-products/maestro-case-framework.md +65 -0
- package/dist/skills/business-analysis/references/uipath-products/maestro-case-management.md +49 -0
- package/dist/skills/business-analysis/research-offer.md +104 -0
- package/dist/skills/business-analysis/research-pass.md +149 -0
- package/dist/skills/business-analysis/scripts/assemble-pdd.ps1 +294 -0
- package/dist/skills/business-analysis/scripts/assemble-pdd.sh +453 -0
- package/dist/skills/business-analysis/scripts/check-phase-ready.ps1 +72 -0
- package/dist/skills/business-analysis/scripts/check-phase-ready.sh +98 -0
- package/dist/skills/business-analysis/scripts/lint-diagram.ps1 +524 -0
- package/dist/skills/business-analysis/scripts/lint-diagram.sh +519 -0
- package/dist/skills/business-analysis/scripts/stamp-pages.ps1 +363 -0
- package/dist/skills/business-analysis/scripts/stamp-pages.sh +360 -0
- package/dist/skills/business-analysis/to-be-design.md +199 -0
- package/dist/skills/confluence/SKILL.md +386 -0
- package/dist/skills/doc-coauthoring/SKILL.md +295 -0
- package/dist/skills/excel-architect/SKILL.macos.md +161 -0
- package/dist/skills/excel-architect/SKILL.md +180 -0
- package/dist/skills/excel-architect/SKILL.windows.md +61 -0
- package/dist/skills/excel-architect/archetypes/01-financial-model-advanced.md +332 -0
- package/dist/skills/excel-architect/archetypes/01-financial-model.md +248 -0
- package/dist/skills/excel-architect/archetypes/02-data-analysis.md +171 -0
- package/dist/skills/excel-architect/archetypes/03-tracking-dashboard.md +160 -0
- package/dist/skills/excel-architect/archetypes/04-project-planning.md +193 -0
- package/dist/skills/excel-architect/archetypes/05-simple-table.md +111 -0
- package/dist/skills/excel-architect/building.md +279 -0
- package/dist/skills/excel-architect/create.md +64 -0
- package/dist/skills/excel-architect/data-and-formulas.md +186 -0
- package/dist/skills/excel-architect/generator.md +272 -0
- package/dist/skills/excel-architect/macos/scripts/add-data-validation.applescript +242 -0
- package/dist/skills/excel-architect/macos/scripts/append-rows.applescript +310 -0
- package/dist/skills/excel-architect/macos/scripts/apply-conditional-format.applescript +565 -0
- package/dist/skills/excel-architect/macos/scripts/autofit-columns.applescript +79 -0
- package/dist/skills/excel-architect/macos/scripts/benchmark.sh +135 -0
- package/dist/skills/excel-architect/macos/scripts/check-compile.sh +30 -0
- package/dist/skills/excel-architect/macos/scripts/clear-range.applescript +152 -0
- package/dist/skills/excel-architect/macos/scripts/copy-paste.applescript +179 -0
- package/dist/skills/excel-architect/macos/scripts/create-chart.applescript +531 -0
- package/dist/skills/excel-architect/macos/scripts/create-pivot.applescript +443 -0
- package/dist/skills/excel-architect/macos/scripts/create-sheets.applescript +264 -0
- package/dist/skills/excel-architect/macos/scripts/create-workbook.applescript +92 -0
- package/dist/skills/excel-architect/macos/scripts/delete-chart.applescript +105 -0
- package/dist/skills/excel-architect/macos/scripts/delete-sheet.applescript +127 -0
- package/dist/skills/excel-architect/macos/scripts/filter-data.applescript +213 -0
- package/dist/skills/excel-architect/macos/scripts/find-replace.applescript +238 -0
- package/dist/skills/excel-architect/macos/scripts/format-range.applescript +531 -0
- package/dist/skills/excel-architect/macos/scripts/freeze-panes.applescript +133 -0
- package/dist/skills/excel-architect/macos/scripts/get-current-file.applescript +24 -0
- package/dist/skills/excel-architect/macos/scripts/get-sheet-dimensions.applescript +115 -0
- package/dist/skills/excel-architect/macos/scripts/health-check.applescript +704 -0
- package/dist/skills/excel-architect/macos/scripts/list-open-workbooks.applescript +80 -0
- package/dist/skills/excel-architect/macos/scripts/maximize-window.applescript +47 -0
- package/dist/skills/excel-architect/macos/scripts/merge-cells.applescript +227 -0
- package/dist/skills/excel-architect/macos/scripts/open-workbook.applescript +139 -0
- package/dist/skills/excel-architect/macos/scripts/read-range.applescript +267 -0
- package/dist/skills/excel-architect/macos/scripts/rename-sheet.applescript +231 -0
- package/dist/skills/excel-architect/macos/scripts/select-sheet.applescript +133 -0
- package/dist/skills/excel-architect/macos/scripts/set-tab-color.applescript +109 -0
- package/dist/skills/excel-architect/macos/scripts/sort-data.applescript +136 -0
- package/dist/skills/excel-architect/macos/scripts/undo.applescript +59 -0
- package/dist/skills/excel-architect/macos/scripts/workbook-lifecycle.applescript +149 -0
- package/dist/skills/excel-architect/macos/scripts/write-formula.applescript +225 -0
- package/dist/skills/excel-architect/macos/scripts/write-range.applescript +351 -0
- package/dist/skills/excel-architect/reference/api/advanced.md +381 -0
- package/dist/skills/excel-architect/reference/api/basic.md +747 -0
- package/dist/skills/excel-architect/reference/guides.md +348 -0
- package/dist/skills/excel-architect/reference/repair.md +174 -0
- package/dist/skills/excel-architect/reference/troubleshooting.md +46 -0
- package/dist/skills/excel-architect/scripting.md +266 -0
- package/dist/skills/excel-architect/styling-and-features.md +433 -0
- package/dist/skills/excel-architect/windows/api/composites.md +337 -0
- package/dist/skills/excel-architect/windows/api/scripting.md +139 -0
- package/dist/skills/excel-architect/windows/examples/level-1-workflows.md +485 -0
- package/dist/skills/excel-architect/windows/examples/level-2-advanced.md +690 -0
- package/dist/skills/excel-architect/windows/examples/level-3-scripting.md +337 -0
- package/dist/skills/github/SKILL.md +446 -0
- package/dist/skills/github/recipes/add-comment.md +85 -0
- package/dist/skills/github/recipes/check-pr-status.md +122 -0
- package/dist/skills/github/recipes/compare-branches.md +79 -0
- package/dist/skills/github/recipes/create-issue.md +103 -0
- package/dist/skills/github/recipes/create-pr.md +97 -0
- package/dist/skills/github/recipes/get-file-contents.md +76 -0
- package/dist/skills/github/recipes/get-last-commit.md +128 -0
- package/dist/skills/github/recipes/list-my-open-prs.md +105 -0
- package/dist/skills/github/recipes/list-recent-commits.md +84 -0
- package/dist/skills/github/recipes/search-issues.md +115 -0
- package/dist/skills/google-workspace/SKILL.md +217 -0
- package/dist/skills/google-workspace/services/calendar.md +311 -0
- package/dist/skills/google-workspace/services/docs.md +426 -0
- package/dist/skills/google-workspace/services/drive.md +504 -0
- package/dist/skills/google-workspace/services/gmail.md +466 -0
- package/dist/skills/google-workspace/services/sheets.md +370 -0
- package/dist/skills/internal-comms/SKILL.md +35 -0
- package/dist/skills/internal-comms/examples/3p-updates.md +47 -0
- package/dist/skills/internal-comms/examples/company-newsletter.md +65 -0
- package/dist/skills/internal-comms/examples/faq-answers.md +30 -0
- package/dist/skills/internal-comms/examples/general-comms.md +15 -0
- package/dist/skills/jira/SKILL.md +397 -0
- package/dist/skills/jira/recipes/add-comment.md +123 -0
- package/dist/skills/jira/recipes/assign-issue.md +157 -0
- package/dist/skills/jira/recipes/create-issue.md +274 -0
- package/dist/skills/jira/recipes/get-issue-details.md +154 -0
- package/dist/skills/jira/recipes/list-projects.md +151 -0
- package/dist/skills/jira/recipes/my-issues.md +180 -0
- package/dist/skills/jira/recipes/search-issues.md +215 -0
- package/dist/skills/jira/recipes/transition-issue.md +154 -0
- package/dist/skills/jira/recipes/troubleshooting.md +387 -0
- package/dist/skills/knowledge-base/SKILL.md +289 -0
- package/dist/skills/media-tools/SKILL.md +204 -0
- package/dist/skills/media-tools/references/encode-runbook.md +24 -0
- package/dist/skills/media-tools/references/resolve-binaries.md +88 -0
- package/dist/skills/media-tools/scripts/macos/ff-launch.sh +22 -0
- package/dist/skills/media-tools/scripts/macos/ff-poll.sh +10 -0
- package/dist/skills/media-tools/scripts/windows/ff-launch.ps1 +34 -0
- package/dist/skills/media-tools/scripts/windows/ff-poll.ps1 +20 -0
- package/dist/skills/office-download/SKILL.md +161 -0
- package/dist/skills/outlook-365/SKILL.macos.md +331 -0
- package/dist/skills/outlook-365/SKILL.md +171 -0
- package/dist/skills/outlook-365/SKILL.windows.md +124 -0
- package/dist/skills/outlook-365/api/bulk-email-operations.md +178 -0
- package/dist/skills/outlook-365/api/check-availability.md +87 -0
- package/dist/skills/outlook-365/api/create-inbox-rule.md +182 -0
- package/dist/skills/outlook-365/api/download-attachments.md +149 -0
- package/dist/skills/outlook-365/api/find-and-email-contact.md +185 -0
- package/dist/skills/outlook-365/api/manage-calendar-events.md +189 -0
- package/dist/skills/outlook-365/api/organize-with-folders.md +178 -0
- package/dist/skills/outlook-365/api/reply-to-conversation.md +68 -0
- package/dist/skills/outlook-365/api/schedule-meeting.md +73 -0
- package/dist/skills/outlook-365/api/search-and-read-email.md +93 -0
- package/dist/skills/outlook-365/api/send-email-with-attachments.md +94 -0
- package/dist/skills/outlook-365/api/send-email.md +396 -0
- package/dist/skills/outlook-365/api/set-out-of-office.md +196 -0
- package/dist/skills/outlook-365/macos/scripts/bulk-operations.applescript +429 -0
- package/dist/skills/outlook-365/macos/scripts/calendar.applescript +642 -0
- package/dist/skills/outlook-365/macos/scripts/contacts.applescript +635 -0
- package/dist/skills/outlook-365/macos/scripts/helpers.applescript +227 -0
- package/dist/skills/outlook-365/macos/scripts/read-emails.applescript +299 -0
- package/dist/skills/outlook-365/macos/scripts/search-emails.applescript +339 -0
- package/dist/skills/outlook-365/macos/scripts/send-email.applescript +245 -0
- package/dist/skills/outlook-365/uia/BASIC_OPERATIONS.md +278 -0
- package/dist/skills/outlook-365/uia/CALENDAR_OPERATIONS.md +386 -0
- package/dist/skills/outlook-365/uia/COMPOSE_EMAIL.md +426 -0
- package/dist/skills/outlook-365/uia/README.md +75 -0
- package/dist/skills/outlook-365/windows/com/bulk-operations.ps1 +241 -0
- package/dist/skills/outlook-365/windows/com/calendar.ps1 +227 -0
- package/dist/skills/outlook-365/windows/com/contacts.ps1 +270 -0
- package/dist/skills/outlook-365/windows/com/helpers.ps1 +158 -0
- package/dist/skills/outlook-365/windows/com/read-emails.ps1 +115 -0
- package/dist/skills/outlook-365/windows/com/search-emails.ps1 +141 -0
- package/dist/skills/outlook-365/windows/com/send-email.ps1 +121 -0
- package/dist/skills/pdf-architect/SKILL.md +640 -0
- package/dist/skills/powerpoint-architect/SKILL.macos.md +271 -0
- package/dist/skills/powerpoint-architect/SKILL.md +853 -0
- package/dist/skills/powerpoint-architect/SKILL.windows.md +458 -0
- package/dist/skills/powerpoint-architect/custom_themes.md +141 -0
- package/dist/skills/powerpoint-architect/editing-guide.md +424 -0
- package/dist/skills/powerpoint-architect/generator-reference.md +668 -0
- package/dist/skills/powerpoint-architect/images-guide.md +207 -0
- package/dist/skills/powerpoint-architect/issue-fix-mapping.md +768 -0
- package/dist/skills/powerpoint-architect/macos/scripts/add-html-to-slide.applescript +389 -0
- package/dist/skills/powerpoint-architect/macos/scripts/add-slide.applescript +255 -0
- package/dist/skills/powerpoint-architect/macos/scripts/add-speaker-notes.applescript +132 -0
- package/dist/skills/powerpoint-architect/macos/scripts/add-text.applescript +245 -0
- package/dist/skills/powerpoint-architect/macos/scripts/apply-slide-layout.applescript +80 -0
- package/dist/skills/powerpoint-architect/macos/scripts/apply-theme.applescript +122 -0
- package/dist/skills/powerpoint-architect/macos/scripts/autofit-placeholders.applescript +62 -0
- package/dist/skills/powerpoint-architect/macos/scripts/close-presentation.applescript +24 -0
- package/dist/skills/powerpoint-architect/macos/scripts/copy-slides.applescript +303 -0
- package/dist/skills/powerpoint-architect/macos/scripts/create-chart-with-data.applescript +305 -0
- package/dist/skills/powerpoint-architect/macos/scripts/create-with-theme.applescript +56 -0
- package/dist/skills/powerpoint-architect/macos/scripts/delete-slides.applescript +137 -0
- package/dist/skills/powerpoint-architect/macos/scripts/export-presentation.applescript +100 -0
- package/dist/skills/powerpoint-architect/macos/scripts/extract-slide-data.applescript +138 -0
- package/dist/skills/powerpoint-architect/macos/scripts/format-shape.applescript +192 -0
- package/dist/skills/powerpoint-architect/macos/scripts/format-slide-content.applescript +336 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-current-slide-number.applescript +38 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-file-path.applescript +94 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-layout-elements.applescript +141 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-layouts.applescript +58 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-opened-files.applescript +50 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-presentation-info.applescript +150 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-recent-files.applescript +68 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-slide-count.applescript +37 -0
- package/dist/skills/powerpoint-architect/macos/scripts/get-slide-info.applescript +105 -0
- package/dist/skills/powerpoint-architect/macos/scripts/health-check.applescript +690 -0
- package/dist/skills/powerpoint-architect/macos/scripts/insert-shape.applescript +188 -0
- package/dist/skills/powerpoint-architect/macos/scripts/insert-table.applescript +112 -0
- package/dist/skills/powerpoint-architect/macos/scripts/insert-text-box.applescript +225 -0
- package/dist/skills/powerpoint-architect/macos/scripts/manage-image.applescript +486 -0
- package/dist/skills/powerpoint-architect/macos/scripts/maximize-window.applescript +48 -0
- package/dist/skills/powerpoint-architect/macos/scripts/navigate-to-slide.applescript +84 -0
- package/dist/skills/powerpoint-architect/macos/scripts/open-presentation.applescript +38 -0
- package/dist/skills/powerpoint-architect/macos/scripts/reorder-slides.applescript +106 -0
- package/dist/skills/powerpoint-architect/macos/scripts/replace-text.applescript +193 -0
- package/dist/skills/powerpoint-architect/macos/scripts/save-presentation.applescript +54 -0
- package/dist/skills/powerpoint-architect/macos/scripts/set-animation.applescript +203 -0
- package/dist/skills/powerpoint-architect/macos/scripts/set-transition.applescript +130 -0
- package/dist/skills/powerpoint-architect/visual-styling-guide.md +206 -0
- package/dist/skills/powerpoint-architect/windows/api/advanced.md +317 -0
- package/dist/skills/powerpoint-architect/windows/api/basic.md +392 -0
- package/dist/skills/powerpoint-architect/windows/examples/10-slide-presentation.md +140 -0
- package/dist/skills/powerpoint-architect/windows/examples/custom-theme-workflow.md +219 -0
- package/dist/skills/powerpoint-architect/windows/examples/level-1-workflows.md +531 -0
- package/dist/skills/powerpoint-architect/windows/examples/level-2-scripting.md +239 -0
- package/dist/skills/powerpoint-architect/windows/scripts/create-with-theme.ps1 +81 -0
- package/dist/skills/project-task-list/SKILL.md +174 -0
- package/dist/skills/slack-operation/SKILL.md +97 -0
- package/dist/skills/slack-operation/api/advanced-api/GUIDE.md +277 -0
- package/dist/skills/slack-operation/api/search-and-read/EXAMPLE.md +75 -0
- package/dist/skills/slack-operation/api/search-and-read/GUIDE.md +108 -0
- package/dist/skills/slack-operation/api/send-message/EXAMPLE.md +112 -0
- package/dist/skills/slack-operation/api/send-message/GUIDE.md +63 -0
- package/dist/skills/slack-operation/api/share-files/EXAMPLE.md +94 -0
- package/dist/skills/slack-operation/api/share-files/GUIDE.md +63 -0
- package/dist/skills/slack-operation/ui/desktop-automation/GUIDE.md +55 -0
- package/dist/skills/system-diagnostics/SKILL.md +263 -0
- package/dist/skills/teams-operation/SKILL.md +79 -0
- package/dist/skills/teams-operation/api/advanced-api/GUIDE.md +234 -0
- package/dist/skills/teams-operation/api/meetings/EXAMPLE.md +63 -0
- package/dist/skills/teams-operation/api/meetings/GUIDE.md +52 -0
- package/dist/skills/teams-operation/api/search-and-read/EXAMPLE.md +72 -0
- package/dist/skills/teams-operation/api/search-and-read/GUIDE.md +54 -0
- package/dist/skills/teams-operation/api/send-message/EXAMPLE.md +92 -0
- package/dist/skills/teams-operation/api/send-message/GUIDE.md +60 -0
- package/dist/skills/teams-operation/ui/desktop-automation/GUIDE.md +66 -0
- package/dist/skills/transcribe-media/SKILL.md +142 -0
- package/dist/skills/uipath-integrations/SKILL.md +370 -0
- package/dist/skills/uipath-integrations/reference/connectors.md +331 -0
- package/dist/skills/uipath-integrations/reference/endpoints.md +220 -0
- package/dist/skills/uipath-integrations/reference/errors.md +211 -0
- package/dist/skills/uipath-integrations/reference/metadata.md +317 -0
- package/dist/skills/uipath-integrations/reference/operations.md +297 -0
- package/dist/skills/uipath-orchestrator/SKILL.md +312 -0
- package/dist/skills/uipath-orchestrator/recipes/assets.md +282 -0
- package/dist/skills/uipath-orchestrator/recipes/audit-logs.md +215 -0
- package/dist/skills/uipath-orchestrator/recipes/buckets.md +205 -0
- package/dist/skills/uipath-orchestrator/recipes/jobs.md +286 -0
- package/dist/skills/uipath-orchestrator/recipes/list-folders.md +207 -0
- package/dist/skills/uipath-orchestrator/recipes/queue-items.md +292 -0
- package/dist/skills/uipath-orchestrator/recipes/queues.md +232 -0
- package/dist/skills/uipath-orchestrator/recipes/releases.md +212 -0
- package/dist/skills/uipath-orchestrator/recipes/robots-sessions.md +274 -0
- package/dist/skills/uipath-orchestrator/recipes/schedules.md +280 -0
- package/dist/skills/uipath-orchestrator/reference/endpoints.md +85 -0
- package/dist/skills/uipath-orchestrator/reference/schemas.md +153 -0
- package/dist/skills/uipath-taskautomation/SKILL.md +310 -0
- package/dist/skills/uipath-taskautomation/assets/CodedWorkflow.template.cs +98 -0
- package/dist/skills/uipath-taskautomation/assets/ExampleWorkflow.cs +146 -0
- package/dist/skills/uipath-taskautomation/references/action-activity-map.json +32 -0
- package/dist/skills/uipath-taskautomation/references/action-activity-map.md +44 -0
- package/dist/skills/uipath-taskautomation/references/app-profiles.md +63 -0
- package/dist/skills/uipath-taskautomation/references/automation-spec.md +88 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/assets/before-after-hooks-template.md +115 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/assets/codedworkflow-template.md +186 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/assets/helper-utility-template.md +22 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/assets/json-template.md +91 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/assets/testcase-template.md +92 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/cli-reference.md +249 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/coded/codedworkflow-reference.md +275 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/coded/coding-guidelines.md +229 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/coded/inspect-package-guide.md +81 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/coded/integration-service-guide.md +507 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/coded/operations-guide.md +410 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/coded/third-party-packages-guide.md +67 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/data-manipulation-guide.md +110 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/environment-setup.md +194 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/error-handling-guide.md +195 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/powershell-interop-guide.md +57 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/project-structure-guide.md +114 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/project-structure.md +126 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/uia-elements-interaction-guide.md +109 -0
- package/dist/skills/uipath-taskautomation/references/coded-reference/validation-guide.md +147 -0
- package/dist/skills/uipath-taskautomation/references/coded-workflow-authoring.md +219 -0
- package/dist/skills/uipath-taskautomation/references/profiling-output.md +80 -0
- package/dist/skills/uipath-taskautomation/references/reliability-guide.md +83 -0
- package/dist/skills/uipath-taskautomation/references/task-automation-cheatsheet.md +272 -0
- package/dist/skills/uipath-taskautomation/references/template-preflight.md +17 -0
- package/dist/skills/uipath-workflow-documenter/SKILL.md +430 -0
- package/dist/skills/uipath-workflow-documenter/layouts/pdd-template.md +265 -0
- package/dist/skills/uipath-workflow-documenter/routines/from-orchestrator.md +11 -0
- package/dist/skills/uipath-workflow-documenter/routines/from-workflow.md +11 -0
- package/dist/skills/word-architect/SKILL.macos.md +147 -0
- package/dist/skills/word-architect/SKILL.md +502 -0
- package/dist/skills/word-architect/SKILL.windows.md +55 -0
- package/dist/skills/word-architect/api/advanced.md +522 -0
- package/dist/skills/word-architect/api/basic.md +378 -0
- package/dist/skills/word-architect/api/expert.md +302 -0
- package/dist/skills/word-architect/generation.md +308 -0
- package/dist/skills/word-architect/layouts/01-professional.md +168 -0
- package/dist/skills/word-architect/layouts/02-educational-kids.md +354 -0
- package/dist/skills/word-architect/layouts/03-academic.md +83 -0
- package/dist/skills/word-architect/layouts/04-creative.md +242 -0
- package/dist/skills/word-architect/layouts/05-operational.md +94 -0
- package/dist/skills/word-architect/macos/scripts/apply-heading-style.applescript +215 -0
- package/dist/skills/word-architect/macos/scripts/apply-style.applescript +272 -0
- package/dist/skills/word-architect/macos/scripts/autofit-tables.applescript +53 -0
- package/dist/skills/word-architect/macos/scripts/close-document.applescript +287 -0
- package/dist/skills/word-architect/macos/scripts/create-chart-with-data.applescript +379 -0
- package/dist/skills/word-architect/macos/scripts/create-chart.applescript +191 -0
- package/dist/skills/word-architect/macos/scripts/delete-selection.applescript +223 -0
- package/dist/skills/word-architect/macos/scripts/export-document.applescript +167 -0
- package/dist/skills/word-architect/macos/scripts/extract-table.applescript +168 -0
- package/dist/skills/word-architect/macos/scripts/find-by-style.applescript +173 -0
- package/dist/skills/word-architect/macos/scripts/find-text.applescript +199 -0
- package/dist/skills/word-architect/macos/scripts/format-table.applescript +234 -0
- package/dist/skills/word-architect/macos/scripts/format-text.applescript +431 -0
- package/dist/skills/word-architect/macos/scripts/get-document-properties.applescript +95 -0
- package/dist/skills/word-architect/macos/scripts/get-document-structure.applescript +371 -0
- package/dist/skills/word-architect/macos/scripts/get-header-footer-text.applescript +106 -0
- package/dist/skills/word-architect/macos/scripts/get-images.applescript +166 -0
- package/dist/skills/word-architect/macos/scripts/get-opened-files.applescript +103 -0
- package/dist/skills/word-architect/macos/scripts/get-paragraph-bounds.applescript +133 -0
- package/dist/skills/word-architect/macos/scripts/get-paragraph-format.applescript +134 -0
- package/dist/skills/word-architect/macos/scripts/get-recent-files.applescript +82 -0
- package/dist/skills/word-architect/macos/scripts/get-styled-text.applescript +256 -0
- package/dist/skills/word-architect/macos/scripts/get-tables.applescript +126 -0
- package/dist/skills/word-architect/macos/scripts/get-text-formatting.applescript +224 -0
- package/dist/skills/word-architect/macos/scripts/get-text.applescript +383 -0
- package/dist/skills/word-architect/macos/scripts/get-theme-colors.applescript +123 -0
- package/dist/skills/word-architect/macos/scripts/health-check.applescript +606 -0
- package/dist/skills/word-architect/macos/scripts/insert-cover-page.applescript +77 -0
- package/dist/skills/word-architect/macos/scripts/insert-header-footer.applescript +87 -0
- package/dist/skills/word-architect/macos/scripts/insert-horizontal-line.applescript +112 -0
- package/dist/skills/word-architect/macos/scripts/insert-html.applescript +440 -0
- package/dist/skills/word-architect/macos/scripts/insert-hyperlink.applescript +191 -0
- package/dist/skills/word-architect/macos/scripts/insert-image.applescript +320 -0
- package/dist/skills/word-architect/macos/scripts/insert-list.applescript +317 -0
- package/dist/skills/word-architect/macos/scripts/insert-pagebreak.applescript +181 -0
- package/dist/skills/word-architect/macos/scripts/insert-smartart.applescript +104 -0
- package/dist/skills/word-architect/macos/scripts/insert-table.applescript +238 -0
- package/dist/skills/word-architect/macos/scripts/insert-text.applescript +677 -0
- package/dist/skills/word-architect/macos/scripts/insert-textbox.applescript +261 -0
- package/dist/skills/word-architect/macos/scripts/maximize-window.applescript +67 -0
- package/dist/skills/word-architect/macos/scripts/normalize-formatting.applescript +56 -0
- package/dist/skills/word-architect/macos/scripts/open-document.applescript +222 -0
- package/dist/skills/word-architect/macos/scripts/replace-text.applescript +390 -0
- package/dist/skills/word-architect/macos/scripts/save-document.applescript +230 -0
- package/dist/skills/word-architect/macos/scripts/select-range.applescript +142 -0
- package/dist/skills/word-architect/macos/scripts/set-document-properties.applescript +195 -0
- package/dist/skills/word-architect/macos/scripts/set-page-layout.applescript +273 -0
- package/dist/skills/word-architect/macos/scripts/set-theme-colors.applescript +264 -0
- package/dist/skills/word-architect/macos/scripts/undo-redo.applescript +61 -0
- package/dist/skills/word-architect/macos/scripts/update-toc.applescript +112 -0
- package/dist/skills/word-architect/reference/formatting.md +119 -0
- package/dist/skills/word-architect/reference/html-layouts/01-executive-summary-box.md +36 -0
- package/dist/skills/word-architect/reference/html-layouts/02-kpi-summary-table.md +68 -0
- package/dist/skills/word-architect/reference/html-layouts/03-comparison-table.md +63 -0
- package/dist/skills/word-architect/reference/html-layouts/04-pros-cons-table.md +86 -0
- package/dist/skills/word-architect/reference/html-layouts/05-timeline-table.md +114 -0
- package/dist/skills/word-architect/reference/html-layouts/06-raci-matrix.md +95 -0
- package/dist/skills/word-architect/reference/html-layouts/07-data-table-alternating.md +84 -0
- package/dist/skills/word-architect/reference/html-layouts/08-callout-box.md +102 -0
- package/dist/skills/word-architect/reference/html-layouts/09-vertical-milestone.md +100 -0
- package/dist/skills/word-architect/reference/quality-assurance.md +102 -0
- package/dist/skills/word-architect/reference/tables.md +62 -0
- package/dist/skills/word-architect/reference/tracked-changes.md +34 -0
- package/dist/skills/word-architect/reference/uia-fallback.md +231 -0
- package/dist/skills/word-architect/reference/visual-elements.md +82 -0
- package/dist/skills/word-architect/windows/scripts/apply-heading-style.ps1 +190 -0
- package/dist/skills/word-architect/windows/scripts/autofit-tables.ps1 +64 -0
- package/dist/skills/word-architect/windows/scripts/create-chart-with-data.ps1 +133 -0
- package/dist/skills/word-architect/windows/scripts/create-chart.ps1 +73 -0
- package/dist/skills/word-architect/windows/scripts/export-document.ps1 +86 -0
- package/dist/skills/word-architect/windows/scripts/get-current-file.ps1 +27 -0
- package/dist/skills/word-architect/windows/scripts/insert-cover-page.ps1 +79 -0
- package/dist/skills/word-architect/windows/scripts/insert-horizontal-line.ps1 +74 -0
- package/dist/skills/word-architect/windows/scripts/insert-image.ps1 +98 -0
- package/dist/skills/word-architect/windows/scripts/insert-smartart.ps1 +118 -0
- package/dist/skills/word-architect/windows/scripts/insert-text-box.ps1 +90 -0
- package/dist/skills/word-architect/windows/scripts/normalize-formatting.ps1 +63 -0
- package/package.json +5 -4
|
@@ -0,0 +1,219 @@
|
|
|
1
|
+
# Coded workflow authoring and the uip CLI
|
|
2
|
+
|
|
3
|
+
How to scaffold, write, and build a UiPath coded workflow headlessly from Delegate. This file is the POC recipe; the full coded-workflow knowledge is bundled under `coded-reference/` (see below). Command forms below are the documented shapes; the `uip` CLI is the source of truth, so confirm with `uip rpa --help` and `uip rpa <verb> --help` at author time. Version drift is expected. For making the emitted code actually reliable (not just compiling) — interaction mode, built-in verify/retry, `dryRun` — see `../reliability-guide.md`.
|
|
4
|
+
|
|
5
|
+
## Do not load the `uipath-rpa` skill
|
|
6
|
+
|
|
7
|
+
Every `uip rpa` command prints "Before using this tool, make sure you have loaded the uipath-rpa skill". Ignore it here — `coded-reference/` below is a coded-workflow-only extract of that skill, bundled in this skill's own directory and read on demand (not preloaded into context just because this skill was invoked — read it the same way you'd read any other `references/*.md`). Loading the full `uipath-rpa` skill on top adds its XAML-authoring rules (irrelevant to coded workflows) and duplicate tokens for no gain.
|
|
8
|
+
|
|
9
|
+
## Bundled coded reference
|
|
10
|
+
|
|
11
|
+
**UI-automation POC core:**
|
|
12
|
+
|
|
13
|
+
| Topic | File |
|
|
14
|
+
|---|---|
|
|
15
|
+
| Coded C# rules, `using` discipline, naming, `out`/`ref` ban | `coded/coding-guidelines.md` |
|
|
16
|
+
| Coded operations, `uiAutomation` usage, service accessors | `coded/operations-guide.md` |
|
|
17
|
+
| Control-specific handling (date inputs, dropdowns, async-disabled buttons) | `uia-elements-interaction-guide.md` |
|
|
18
|
+
| `uip rpa` CLI surface | `cli-reference.md` |
|
|
19
|
+
| Errors `build` catches that `validate` misses | `validation-guide.md` |
|
|
20
|
+
| Error handling in coded | `error-handling-guide.md` |
|
|
21
|
+
| Environment / prerequisites | `environment-setup.md` |
|
|
22
|
+
|
|
23
|
+
**Rarely needed (read only if the task explicitly hits it):**
|
|
24
|
+
|
|
25
|
+
| Topic | File |
|
|
26
|
+
|---|---|
|
|
27
|
+
| `CodedWorkflow` API reference | `coded/codedworkflow-reference.md` |
|
|
28
|
+
| Reading a package's co-versioned coded API doc | `coded/inspect-package-guide.md` |
|
|
29
|
+
| Integration Service calls from coded | `coded/integration-service-guide.md` |
|
|
30
|
+
| Third-party packages in coded | `coded/third-party-packages-guide.md` |
|
|
31
|
+
| Project layout | `project-structure-guide.md`, `project-structure.md` |
|
|
32
|
+
| Data manipulation in coded | `data-manipulation-guide.md` |
|
|
33
|
+
| PowerShell interop from coded | `powershell-interop-guide.md` |
|
|
34
|
+
| Templates (class, project.json, test case, before/after hooks, helper) | `assets/*.md` |
|
|
35
|
+
|
|
36
|
+
The bundle carries coded authoring rules, guides, and examples, but **not** per-activity package API docs (dropped for this UI-automation-centered POC). Any package's exact co-versioned coded API — including `uiAutomation.*` — comes from the installed package doc at build time (`{PROJECT_DIR}/.local/docs/packages/<PackageId>/coded/`) via the flow in `coded/inspect-package-guide.md`.
|
|
37
|
+
|
|
38
|
+
## CodedWorkflow shape
|
|
39
|
+
|
|
40
|
+
`UiPath.Template.TaskAutomations` scaffolds `Main.cs` — class `Main : CodedWorkflow` with an empty `[Workflow] Execute()` — as `main` and the one registered entry point. Overwrite it with `../assets/CodedWorkflow.template.cs` (skill Phase 4): method `Execute(string inputJson, bool dryRun)`, the input readers, `Retry`/`Retry<T>`, a `result` returned as the JSON envelope, and a `// LLM BUSINESS LOGIC START/END` placeholder. Then set the entry's `input`/`output` (§ project.json) and fill the placeholder (skill Phase 5); do not scaffold a second class/file. On the BlankTemplate fallback the same skeleton goes into a new `.cs` you register yourself. Targeting-technique reference either way: `../assets/ExampleWorkflow.cs`. Rules the example does not make obvious:
|
|
41
|
+
|
|
42
|
+
- Base class `CodedWorkflow` (from `UiPath.CodedWorkflows`) is mandatory — no custom base; Studio wrapper generation depends on the exact type.
|
|
43
|
+
- `[Workflow]` marks the entry method, never `async` — every `uiAutomation.*` call (`Open`/`Attach`/`Click`/`TypeInto`/`GetText`) is synchronous, so there's no `await` anywhere in this skill's generated code. `void` is fine (the template's shape); a return value becomes the workflow's `Output` argument, which is how the fallback skeleton hands back its envelope.
|
|
44
|
+
- Class name must match the file name — `Main` in `Main.cs`; namespace = sanitized project name. `init` does not rename the template's namespace for you (Studio's New Project dialog does; the CLI copies files verbatim), so the skeleton you write over `Main.cs` is where the project's namespace gets set.
|
|
45
|
+
- Never prefix the class name with the project name (stricter than ST-NMG-017's class ≠ namespace). A class starting with the namespace name silently breaks codegen: `WorkflowRunnerService` is omitted from the generated partial and the build fails with `Type or namespace 'WorkflowRunnerService' does not exist in namespace '<Project>'` (×4). Seen with project `NotepadTaylorLyric` + class `NotepadTaylorLyricWorkflow`; renaming the class to `NotepadLyric` fixed it. `Main` cannot hit it unless the project itself is named `Main…` — on a fallback `.cs`, pick a class name that does not start with the project name.
|
|
46
|
+
- Add a `using` only for an installed package — an unused `using` for a missing package fails the build.
|
|
47
|
+
- Regex escaping: verbatim `@"\d+"` OR non-verbatim `"\\d+"` — never mixed. `@"\\d+"` compiles and matches a literal backslash instead of digits, so the pattern silently never matches at run time and any guard built on it fails the whole run (seen: an extraction loop yielding zero matches on every cell). Before building, scan the authored code for `\\d`, `\\s`, `\\w`, `\\b` inside `@"…"` strings — any hit is this bug.
|
|
48
|
+
|
|
49
|
+
## Targeting: inline selectors, semantic fallback
|
|
50
|
+
|
|
51
|
+
Targets live in the code, so the workflow builds and runs headlessly with no Studio Desktop step. Every technique below is shown working in `../assets/ExampleWorkflow.cs` — read it, then apply this checklist.
|
|
52
|
+
|
|
53
|
+
**Targeting ladder — try in this order per action:**
|
|
54
|
+
|
|
55
|
+
1. **Keyboard shortcut**, if the app exposes one for this action (`Ctrl+B` for bold, `Ctrl+A` for select-all, …) — no selector to drift. Toolbar/ribbon buttons are usually the least stable target on a desktop app; prefer the shortcut over clicking the button. Write it as `app.KeyboardShortcut(target, "<sequence>", 0.5)` when the step names an element, or `app.KeyboardShortcut("<sequence>", 0.5)` to send it to the focused element of the window — both verified against a live run on `UiPath.UIAutomation.Activities` 26.10.1. Prefer these over the `KeyboardShortcutOptions` overload, which rejected the same sequence at run time.
|
|
56
|
+
|
|
57
|
+
**⚠ Two hotkey dialects exist and they are NOT interchangeable. You must convert.** Task logs and `interact type` write Ctrl+A as `[d(ctrl)]a[u(ctrl)]`; the Keyboard Shortcuts activity requires every sequence wrapped in shortcut-start/end delimiters — `[d(hk)][d(ctrl)]a[u(ctrl)][u(hk)]` (`{PROJECT_DIR}/.local/docs/packages/UiPath.UIAutomation.Activities/activities/KeyboardShortcuts.md` § Hotkey Encoding Format). Copying a task-log or spec string through **verbatim compiles clean and then throws `Invalid or empty shortcut sequence` on the first key press**, because the tokens belong to no sequence. Nothing adds the wrapper for you — add it to every sequence as you write the call, and re-check it if a run dies on the first shortcut. Also: multiple modifiers share one block and release in reverse (`[d(ctrl)d(shift)]t[u(shift)u(ctrl)]`), Space is a literal space and never `[k(space)]`, and the token names are `[k(back)]`/`[k(del)]`/`[k(esc)]`/`[k(ins)]`, not the spelled-out forms.
|
|
58
|
+
2. **Strict selector** — captured live from `AppAct` this session, or a known-stable one from `../references/app-profiles.md` if this app was seen in a prior session (check there before deriving a fresh capture).
|
|
59
|
+
3. **Alternate selector candidate**, if Phase 2 captured more than one path to the same element (e.g. a UWP window's direct-process shape vs. its `ApplicationFrameHost.exe` fallback shape).
|
|
60
|
+
4. **AI semantic selector** (`Target.WithSemanticSelector`/`Target.FromSemanticSelector`, below) — last resort. If this also throws at run time, the activity fails and the run fails — no runtime callback into Delegate; flag the step for a human fix.
|
|
61
|
+
|
|
62
|
+
**Never pass a selector to `uiAutomation.*` as a bare string.** The `string`-typed overloads (`Open(string)`, `Attach(string)`, `Click(string)`, …) treat the arg as an **Object Repository name**, NOT a selector, and fail at runtime with `NodeNotFoundException: Cannot find screen [***.***].[<selector>]` (`***.***` = the appName/appVersion sentinel — proof it hit the Object Repository). Wrap every captured `uipathSelector` in a model factory (all in `UiPath.UIAutomationNext.API.Models`):
|
|
63
|
+
|
|
64
|
+
- **App/browser** → `AppTarget.FromUrl(url, selector, browserType)` (or `AppTarget.FromPath(path)`) → `uiAutomation.Open`/`Attach`. Prefer `Open(appTarget, new TargetAppOptions { OpenMode = NAppOpenMode.IfNotOpen })` — one call attaches-or-launches. Scope the browser selector by **URL not title** (`<html app='chrome.exe' url='https://your.host/*' />`); Chrome churns the title.
|
|
65
|
+
- **Elements** → `Target.FromSelector(uipathSelector)` → `Click`/`TypeInto`/`GetText`/`SelectItem`. Keep captured selectors reusable: parameterize with `$"...{arg}..."`; `*`/`?`-wildcard dynamic `aaname` text (`aaname='* Days - Request Absence'`); anchor ambiguous tags with `parentid=` (or another stable ancestor id/class).
|
|
66
|
+
- **Range drag** → `AppAct` drag coords do not port; replace with modifier-click: `Click(target, new ClickOptions { KeyModifiers = NKeyModifiers.Shift })` (or `Ctrl`/`Alt`).
|
|
67
|
+
- **Semantic fallback** → `Target.WithSemanticSelector(Target.FromSelector(strict), "description")` (strict first, AI only on drift), or `Target.FromSemanticSelector("description")` when no strict selector can be captured. If that also throws at run time, the activity fails — no runtime callback into Delegate to catch it.
|
|
68
|
+
- **Extension-free run** → `TargetAppOptions.WebDriverMode = NWebDriverMode.DevTools` (CDP; no browser extension, no WebDriver download at run time).
|
|
69
|
+
- **UWP apps on Windows 11** (Calculator, Notepad, Photos, Settings, Store apps) → `AppTarget.FromPath(...)` FAILS at run time with `ApplicationOpenException: Could not find <wnd pid='NNNN'/>`. The System32 stub exits after handing off to the UWP host, so UIA's pid tracker looks at a dead pid. Bypass inline (no Studio, no Object Repository) by launching via the shell URI and attaching by window shape:
|
|
70
|
+
```csharp
|
|
71
|
+
System.Diagnostics.Process.Start(new System.Diagnostics.ProcessStartInfo {
|
|
72
|
+
FileName = "explorer.exe",
|
|
73
|
+
Arguments = @"shell:AppsFolder\Microsoft.WindowsCalculator_8wekyb3d8bbwe!App",
|
|
74
|
+
UseShellExecute = true
|
|
75
|
+
});
|
|
76
|
+
System.Threading.Thread.Sleep(2000); // let the UWP window materialise (Execute is void, no await)
|
|
77
|
+
var targetApp = new TargetAppModel {
|
|
78
|
+
Selector = "<wnd app='ApplicationFrameHost.exe' cls='ApplicationFrameWindow' title='Calculator' />"
|
|
79
|
+
};
|
|
80
|
+
using var app = uiAutomation.Attach(targetApp, new TargetAppOptions());
|
|
81
|
+
```
|
|
82
|
+
All UWP windows are hosted by `ApplicationFrameHost.exe` with class `ApplicationFrameWindow`; disambiguate by `title`. Get the AppUserModelID with PowerShell `Get-StartApps | ? Name -like '*Calculator*'`. `TargetAppModel` is documented as Object-Repository-only, but its `Selector` property is public and assignable inline — confirmed by compiler probe (guessing bogus members yields `CS0117` errors that enumerate the wrong names; anything that compiles is real).
|
|
83
|
+
|
|
84
|
+
Known-app shapes (Notepad, Calculator) are captured once in `../references/app-profiles.md` — check there before rediscovering a UWP launch/selector for an app already seen in a prior session; add a new entry there after this session captures one live.
|
|
85
|
+
- **macOS apps** → three rules:
|
|
86
|
+
1. **Strict selectors use the `<ax>` dialect, never `<ctrl>`.** A macOS element selector is `<ax role='AXButton' identifier='Five' />` scoped by a window selector `<wnd app='Calculator' role='AXWindow' title='Calculator' />`. The Windows attribute names do not exist in this dialect: `<ctrl role='AXButton' automationid='Five' />` compiles fine and throws `NodeNotFoundException` on every run — `automationid` is `identifier` here, and the tag is `ax`. Never hand-compose one from an AX extraction; generate it with the capture flow below and copy it verbatim.
|
|
87
|
+
2. **`AppTarget.FromPath` cannot open a macOS app.** The `.app` bundle path fails path validation (not a file), and the inner executable (`Contents/MacOS/<name>`) passes validation but the launch hands off to the real app process, so the pid tracker reports `<wnd pid='0'/>` / `ApplicationNotFoundException`. Launch with the OS (`open -a <AppName>` via `ExecuteBashCommand`, or `Process.Start`) and **attach by window shape** — the macOS sibling of the UWP shell-URI workaround above:
|
|
88
|
+
```csharp
|
|
89
|
+
System.Diagnostics.Process.Start(new System.Diagnostics.ProcessStartInfo {
|
|
90
|
+
FileName = "/usr/bin/open", Arguments = "-a Calculator", UseShellExecute = false
|
|
91
|
+
});
|
|
92
|
+
System.Threading.Thread.Sleep(2000); // let the window materialise (Execute is void, no await)
|
|
93
|
+
var targetApp = new TargetAppModel { Selector = "<wnd app='Calculator' role='AXWindow' title='Calculator' />" };
|
|
94
|
+
using var app = uiAutomation.Attach(targetApp, new TargetAppOptions { InteractionMode = NInteractionMode.Simulate });
|
|
95
|
+
```
|
|
96
|
+
3. **Capture strict selectors with the `uia` capture flow — on `UiPath.UIAutomation.Activities` >= 26.10.4.** The window ref is positional: `snapshot capture` (top-level, note the window's `wN` ref) → `snapshot capture <wN> --folder-path <work>` captures that window's elements directly, one command. On a project still pinned to 26.10.3, upgrade the package rather than working around it — that version's per-window capture path is defective (fixed in 26.10.4). Finish with `target-anchorable resolve-defaults` per element — the generated `FullSelector` is the strict selector to paste into `Target.FromSelector(...)`.
|
|
97
|
+
|
|
98
|
+
**Reading text on macOS:** prefer `GetText` with the **Fulltext** scraping method for AX-backed values. `Native`/`TextAttribute` can return an empty string on an `AXScrollArea` whose `AXStaticText` value is demonstrably present (known scraping gap), and the OCR method calls a cloud CV service — offline or without a CV key it fails (surfaces as `401`), so never leave a target on the OCR default.
|
|
99
|
+
|
|
100
|
+
## The installed package's own docs and skills
|
|
101
|
+
|
|
102
|
+
Everything below `{PROJECT_DIR}/.local/docs/packages/UiPath.UIAutomation.Activities/` is written to disk by the scaffold and is **co-versioned with the package** — it beats this file, the bundle, and anything remembered, every time. Three parts matter:
|
|
103
|
+
|
|
104
|
+
| Path | What it is |
|
|
105
|
+
|---|---|
|
|
106
|
+
| `coded/coded-api.md` | Every `uiAutomation.*` and `UiTargetApp` signature, overload, and options class. The authority for any call neither this file nor `task-automation-cheatsheet.md` pins — reach for it via that cheat sheet's § Escalate, not by grepping. |
|
|
107
|
+
| `activities/<Activity>.md` | Per-activity properties and formats — e.g. `KeyboardShortcuts.md` § Hotkey Encoding Format, which is where the `[d(hk)]…[u(hk)]` requirement is documented. |
|
|
108
|
+
| `skills/` | Three ready UIA skills, below. |
|
|
109
|
+
| `ui-automation-guide.md` | Added in `26.10.3`. Its § For Coded Workflows routes targets through Object Repository `Descriptors.*`, which needs Studio Desktop to regenerate `ObjectRepository.cs` — unavailable on this skill's headless `uip rpa init` path, so its "MANDATORY" ladder does not apply here (`task-automation-cheatsheet.md` § Escalate). Its § Screen Handle Affinity and § Coded-Specific Pitfalls do. |
|
|
110
|
+
|
|
111
|
+
**The skills are the fast path for the work that is otherwise slow and error-prone:**
|
|
112
|
+
|
|
113
|
+
| Skill | Use it when |
|
|
114
|
+
|---|---|
|
|
115
|
+
| `uia-interact` | Inspect or drive the **live** app through `uip rpa uia` — click, type, read a value, screenshot, inspect state, extract a table. Use it to check a target or confirm a step's real behaviour *before* committing it to code, and to verify afterwards. |
|
|
116
|
+
| `uia-configure-target` | A step needs a reliable target and the capture is weak or missing. Creates/reuses Object Repository entries, batches several elements in one call (pipe-separated), and falls back to Computer Vision by default when selector resolution fails (`--cv false` to disable). |
|
|
117
|
+
| `uia-improve-selector` | A selector broke or a run failed on one. Repairs it from runtime data — `--mode recover` (it stopped working) or `improve` (make it more robust) — instead of re-deriving by hand. |
|
|
118
|
+
|
|
119
|
+
`skills/references/selector-intelligence/tag-names-instructions/` carries per-tag selector-authoring rules (`wnd`, `webctrl`, `html`, `ctrl`, `uia`, `java`) — the authority for tightening a captured selector.
|
|
120
|
+
|
|
121
|
+
Two traps:
|
|
122
|
+
|
|
123
|
+
- **`uia-interact`'s `references/special-keys.md` is a different hotkey dialect.** It documents the unwrapped form (`[d(ctrl)]a[u(ctrl)]`), correct for `uip rpa uia interact type` and **wrong** for the `KeyboardShortcut` activity, which needs the `[d(hk)]…[u(hk)]` wrapper (§ Targeting rung 1). The two files sit a few directories apart in the same package and nothing in either warns about the other.
|
|
124
|
+
- **These CLIs are native executables.** Every path passed to them must be absolute in the host OS's own format (`C:/Work/...`, forward slashes fine). A git-bash/MSYS path (`/c/Work/...`), a WSL `/mnt/c/...` path, or a relative path fails or silently writes to the wrong place. In git-bash use `pwd -W` (or `cygpath -m`), never a bare `pwd`.
|
|
125
|
+
|
|
126
|
+
Exact target-model construction is co-versioned with the package, so never hardcode an overload from memory. The distilled form is `task-automation-cheatsheet.md` — the factories above, the action overloads, the options classes, and the enum members, in one read. Note that `AppTarget`/`Target` are **not** in `coded-api.md`; the cheat sheet is the only place they are written down, and grepping the package docs for them returns nothing. Escalate to `{PROJECT_DIR}/.local/docs/packages/UiPath.UIAutomation.Activities/coded/coded-api.md` (plus `uip rpa uia --help`, per `coded-reference/coded/inspect-package-guide.md`) only per that cheat sheet's § Escalate.
|
|
127
|
+
|
|
128
|
+
**Screen handle.** Element interactions go through the handle returned by `uiAutomation.Open`/`Attach` (`using var app = uiAutomation.Open(...)`; then `app.Click(...)`, `app.TypeInto(...)`) — not `uiAutomation.Click(...)` on the service. Each handle is bound to one window, but handles for different apps **coexist**: a multi-app spec opens one per `applications[]` entry up front and interleaves calls across them (`../references/automation-spec.md` § More than one app). Interleaving is safe under `Simulate`/`WindowMessages`, which act without the target focused, and `ClickOptions`/`TypeIntoOptions.ActivateBefore` defaults to `true` so each action foregrounds its own window (`../references/reliability-guide.md` §§ 1, 5). Under `HardwareEvents` — which needs the target visible and focused — group each app's actions together instead of alternating. Method surface (Open/Attach/Click/TypeInto/GetText): `coded-reference/coded/operations-guide.md` — it covers only those five. `KeyboardShortcut` (ladder rung 1, needed by every `key_press` action) is not in that bundle but is pinned here: `KeyboardShortcut(string shortcuts, double delayBetweenShortcuts = 0.5)` and `KeyboardShortcut(TargetAnchorableModel target, string shortcuts, double delayBetweenShortcuts = 0.5)`, both verified against a live run on `UiPath.UIAutomation.Activities` 26.10.1. Prefer these over the `KeyboardShortcutOptions` overload, which rejected the same sequence at run time. Control-specific technique (date inputs typed in displayed format, dropdowns decided by the `items` attribute, async-disabled buttons needing `DelayBefore`): `coded-reference/uia-elements-interaction-guide.md`.
|
|
129
|
+
|
|
130
|
+
## uip rpa recipes
|
|
131
|
+
|
|
132
|
+
There is no coded-init, and no `project.json` field flips a project to "coded" — a project is coded because its entry point is a `.cs` `[Workflow]`. `UiPath.Template.TaskAutomations` ships exactly that: `Main.cs` as `main` with its `entryPoints` entry (§ CodedWorkflow shape), so you overwrite the file and set the entry's arguments rather than adding anything. `BlankTemplate` scaffolds an XAML project instead; on that fallback, coded is a post-scaffold step you perform by hand: add the `.cs`, then register it.
|
|
133
|
+
|
|
134
|
+
```bash
|
|
135
|
+
# 1. Scaffold from the packageId/version Phase 0 resolved and verified (references/template-preflight.md).
|
|
136
|
+
# <ParentDir> = the Delegate workflows folder (<userData>/workflows); project lands at <ParentDir>/<SanitizedName> (immutable flags, set explicitly)
|
|
137
|
+
uip rpa init --name "<SanitizedName>" --location "<ParentDir>" \
|
|
138
|
+
--template-package-id "<Phase 0 packageId>" --template-package-version "<Phase 0 version>" \
|
|
139
|
+
--expression-language CSharp --target-framework Portable --output json
|
|
140
|
+
|
|
141
|
+
# 2. Overwrite <ProjectDir>/Main.cs with assets/CodedWorkflow.template.cs and set its entry-point
|
|
142
|
+
# input/output (§ project.json) — before any validate or build
|
|
143
|
+
|
|
144
|
+
# 3. Validate one file (pass --file-path RELATIVE to the project dir)
|
|
145
|
+
uip rpa validate --file-path "<File>.cs" --project-dir "<ProjectDir>" --output json
|
|
146
|
+
|
|
147
|
+
# 4. Build (project dir is positional)
|
|
148
|
+
uip rpa build "<ProjectDir>" --output json
|
|
149
|
+
|
|
150
|
+
# 5. Run (never `debug start` — see below) — only after a successful build,
|
|
151
|
+
# always with --skip-build, and always --profiling so you can prove which selectors actually resolved.
|
|
152
|
+
# inputJson carries automation.spec.md's `## Inputs` values. Pass it with = (string), never := — the
|
|
153
|
+
# parameter is a System.String, so := would hand it a JSON object and fail to bind. dryRun is the
|
|
154
|
+
# reverse: := (raw JSON true), or it binds as the string "true".
|
|
155
|
+
uip rpa run --file-path "<File>.cs" --project-dir "<ProjectDir>" --skip-build --profiling \
|
|
156
|
+
--input-arguments 'inputJson={"text":"im the problem its me"}' --input-arguments dryRun:=true \
|
|
157
|
+
--output json
|
|
158
|
+
|
|
159
|
+
# 5b. Payload with quotes/apostrophes: put it in a file and read it in, instead of fighting quoting
|
|
160
|
+
uip rpa run --file-path "<File>.cs" --project-dir "<ProjectDir>" --skip-build --profiling \
|
|
161
|
+
--input-arguments 'inputJson=@payload.json' --input-arguments dryRun:=true --output json
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
- **Smoke-test with `run`, never `debug start`.** A debug session suspends on an unhandled exception instead of exiting, so no verdict reaches a caller reading output to end-of-stream: the failed run presents as a hang, and killing it strands the execution (next bullet) and leaves `--profiling` unflushed at 0 bytes. `debug start` is for interactive stepping only; mechanism in `coded-reference/cli-reference.md` § Reading run / debug results.
|
|
165
|
+
- **`--profiling` does not enumerate per-step selector resolution.** The field carries only `Profiling.outputDirectory`; the `.uistat` inside it records a coded workflow as one activity however many steps ran. Per-step evidence is the Phase 5 `STEP <n>` markers in `%LOCALAPPDATA%\UiPath\Logs\<YYYY-MM-DD>_Execution.log` (`logType == "User"`, correlated by `jobId`). Profiling corroborates: `CustomData.Target.SearchSteps` says whether the strict selector resolved alone (`Selector`) or the AI fallback participated (`Selector, SemanticSelector`), and the screenshots show what the run saw. Applies to the start commands (`run`, `debug start`) only; ignored by stepping/breakpoint sub-verbs. Needs a Studio Develop profile with `EnableProfiling`; without it the field is omitted — "no data", never "verified". Full shape in `profiling-output.md`.
|
|
166
|
+
- **Workflow `Log()` output does not reach `--log-file` or stderr** at any `--log-level`; it lands in the execution log above. `--log-file` captures CLI logs only and is commonly empty.
|
|
167
|
+
- **`Could not load file or assembly '<Project>'` on a `--skip-build` run** means `.local/install/` has no `<Project>.dll` — `uip rpa build` alone does not always produce it. Re-run once without `--skip-build`, then `--skip-build` works.
|
|
168
|
+
- Verdict = the JSON `Result` / `hasErrors`, never a log line's level. A failed postcondition throws, so it lands as `hasErrors: true` + `errorMessage`; the envelope the workflow built reaches you through `Data.output` on success (the same object arrives as a JSON string in `Message` on failure) or the execution log (`cli-reference.md` § Reading run / debug results). Both feed the Phase 7 per-postcondition report.
|
|
169
|
+
- Build before run — and before `validate`. Both the `run`/`debug start` pre-run validator and `uip rpa validate --file-path` compile the `.cs` **without** the `.local/.codedworkflows/CodedWorkflow.cs` partial that `build` generates, so a workflow that builds cleanly still fails them with cascading errors (`CodedWorkflow` not found, `Log` not found, `Cannot infer var (…) = await`). On a project that has never been built, that makes the first `validate` report the base class and every member it supplies (`Log`, `Delay`, `uiAutomation`) as missing — false positives on correct code; do not "fix" them. Always `build` first, then run with `--skip-build`.
|
|
170
|
+
- **Stuck "An execution is already in progress":** Helm keeps its execution alive after your shell command stopped waiting — a timed-out or cancelled command kills the `uip` process tree, not the run behind it. Prevention first: **never chain `build` and `run` in one bounded shell call** (`build && run` inside a single 180s command is how runs get stranded — the build eats the budget and the run's timeout kills a live execution). Issue `build` and `run` as separate invocations, each with a timeout sized to that step alone. When it has already happened — and holds a lock on `.local/install/*.dll` (so re-build fails with `permission_denied`). Cancel with `uip rpa execution cancel --project-dir "<ProjectDir>" --output json` (returns `{"message":"Execution stop requested."}`), wait ~3s, then rebuild/re-run. Issue it as its own command: a lone `uip …` invocation runs as a trusted CLI, and chaining it (`;`, `|`, `&`) onto anything forfeits that. Do NOT kill random `node.exe` or `UiPath.Studio.Helm` processes — that risks breaking Studio. Any smoke run that returns nothing has probably left an execution behind, so cancel before assuming the next `build` will work. (A suspended `debug start` session is the other way in here, and only `execution cancel` ends one — the `uip rpa debug` sub-verbs `continue`/`step-*`/`resume`/`restart-from-top` drive an attached session rather than ending it. Smoke-testing with `run` is what keeps you out of that state; see the `run` bullet above.)
|
|
171
|
+
- Discovery: the template is `UiPath.Template.TaskAutomations` on the official UiPath template feed (source: `UiPath-Services/StudioTemplates`). `uip rpa templates search` and `uip rpa init --template-package-id` resolve against the same template feed set, so the search's exact `packageId` match is what `init` will scaffold (`references/template-preflight.md` § 1). Confirm the scaffold's `Main.cs` is a `CodedWorkflow` with a `[Workflow]` `Execute()` before overwriting it. `--template-package-id` overrides `--template-id`; with `--target-framework Portable --expression-language CSharp` it scaffolds the cross-platform C# variant, which pins `UiPath.UIAutomation.Activities` 26.10.5, `UiPath.System.Activities` 26.6.0 and `UiPath.Testing.Activities` 25.10.2.
|
|
172
|
+
- Fallback — only if no package resolves under any exact name (§ template-preflight.md § 4), not merely because the first inspection looked wrong: scaffold with `--template-id BlankTemplate` instead, then `uip rpa packages install --packages 'id=UiPath.UIAutomation.Activities,version=26.10.4' --project-dir "<ProjectDir>" --output json`.
|
|
173
|
+
- Add any extra package via `packages install` (repeat `--packages`); `install` writes the `dependencies` map — never hand-edit that. There is no `add-dependency` verb. (`entryPoints` is the one array the agent maintains by hand — the `Main.cs` entry's arguments on the template path, a whole new entry on the BlankTemplate fallback; see § project.json.)
|
|
174
|
+
- `run --input-arguments name=John` sends a string; `count:=42` sends raw JSON. In a PowerShell single-quoted value, double each apostrophe: `--input-arguments 'text=It''s me!'`.
|
|
175
|
+
- Orchestrator publish (`uip rpa pack` → `uip or packages upload`) is out of scope for this POC.
|
|
176
|
+
|
|
177
|
+
## Build gotchas
|
|
178
|
+
|
|
179
|
+
`validate` is weaker than `build`; always run `build`. Documented traps:
|
|
180
|
+
|
|
181
|
+
- A clean `build` does not carry over to `run`/`debug start`: their pre-run validator recompiles without the build-generated `.local/.codedworkflows/CodedWorkflow.cs` partial and fails spuriously. After `build`, always run with `--skip-build` (§ uip rpa recipes).
|
|
182
|
+
|
|
183
|
+
- No `out` / `ref` params on a `[Workflow]` method (`CS1620`). Return values or tuples instead.
|
|
184
|
+
- `LogLevel.Warn`, not `LogLevel.Warning` (valid: `Trace`, `Verbose`, `Info`, `Warn`, `Error`, `Fatal`).
|
|
185
|
+
- `using` for a package not installed → compile error.
|
|
186
|
+
- `UiPath.UIAutomation.Activities` must be >= `26.10.3` (the `AppTarget`/`Target` factories and the
|
|
187
|
+
`uip rpa uia` capture CLI both require it). `UiPath.Template.TaskAutomations` pins a
|
|
188
|
+
compliant version (26.10.5) — Phase 0's probe confirms this per session (template contents drift); pin
|
|
189
|
+
explicitly only on the BlankTemplate fallback. If `UiPath.Testing.Activities` is
|
|
190
|
+
used, pin `25.10.2` (`25.10.0/.1` break the build with `CS0234`).
|
|
191
|
+
|
|
192
|
+
## project.json
|
|
193
|
+
|
|
194
|
+
Init-generated; never hand-edit the CLI-managed fields (`schemaVersion`, `studioVersion`, `expressionLanguage`, `targetFramework`, `runtimeOptions`, `dependencies`). From `UiPath.Template.TaskAutomations`, `"main"` is already `Main.cs` — leave it. From `BlankTemplate`, `init` scaffolds `Main.xaml` and points `"main"` at it — leave both alone there too. The XAML never runs in a coded workflow; Studio discovers the `.cs` workflows via `entryPoints` regardless of `"main"`.
|
|
195
|
+
|
|
196
|
+
**Set the entry for `Main.cs`.** The template scaffold already registers `Main.cs` in both root `entry-points.json` and `project.json` — keep that entry and its `uniqueId`, and replace only its `input`/`output` with the ones below; adding a second entry duplicates the registration. On the BlankTemplate fallback, where you author the `.cs` yourself, add one entry per `.cs` workflow:
|
|
197
|
+
|
|
198
|
+
```json
|
|
199
|
+
{ "filePath": "<File>.cs", "uniqueId": "<uuid-v4>", "input": [...], "output": [...] }
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
`build` compiles the `.cs` even with no entry, so a missing entry still passes local build — but the workflow is then unregistered for publish and run-by-name. Always add it.
|
|
203
|
+
|
|
204
|
+
`input`/`output` mirror the `Execute` **signature**, not the spec: argument direction is derived from the method (parameters = In, return value/tuple = Out — `coded-reference/coded/codedworkflow-reference.md`), and the runtime binds run arguments to parameters by name. Under the fixed `Execute(string inputJson, bool dryRun)` contract that means exactly two entries:
|
|
205
|
+
|
|
206
|
+
```json
|
|
207
|
+
"input": [
|
|
208
|
+
{ "name": "inputJson", "type": "System.String", "required": true },
|
|
209
|
+
{ "name": "dryRun", "type": "System.Boolean", "required": false }
|
|
210
|
+
]
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
The spec's `inputs` keys are **not** entry-point arguments — they ride inside the `inputJson` payload, which is the trade the JSON envelope makes for a stable signature. Registering them as `input` items declares arguments `Execute` cannot accept: the run then fails to bind, or drops the values silently. `output` mirrors the return value (`[]` for a `void` `Execute`; a single return value is keyed `Output`). The skeleton's `Execute` returns the serialized `result`, so its `output` is that one entry:
|
|
214
|
+
|
|
215
|
+
```json
|
|
216
|
+
"output": [
|
|
217
|
+
{ "name": "Output", "type": "System.String" }
|
|
218
|
+
]
|
|
219
|
+
```
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
# Profiling output
|
|
2
|
+
|
|
3
|
+
What `--profiling` produces on a start command, and what it can and cannot prove. The skill's smoke test passes it to `uip rpa run` (`coded-workflow-authoring.md` § uip rpa recipes); the shape below was captured from a `uip rpa debug start --profiling` run on uip CLI 1.201 / Executor 26.0.199 on Windows, and has not been re-verified under `run`. Expect the same directory and `.uistat` — `--profiling` is documented for both start commands — but treat a discrepancy as the doc being stale, not the run being broken, and fix it here. `IsDebugging` is the one field that certainly differs.
|
|
4
|
+
|
|
5
|
+
## The envelope returns a path, not data
|
|
6
|
+
|
|
7
|
+
`Profiling` carries one field:
|
|
8
|
+
|
|
9
|
+
```json
|
|
10
|
+
"profiling": { "outputDirectory": "C:\Users\<user>\AppData\Local\UiPath\ProfiledRuns\<HHMMSS>_<YYYY-MM-DD>_<EntryFile>_<Project>" }
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
No inline per-activity data. Read the directory to get anything. Emitted on failed runs too — its presence says nothing about the verdict.
|
|
14
|
+
|
|
15
|
+
## Directory contents
|
|
16
|
+
|
|
17
|
+
- `<guid>.uistat` — JSON, one per run.
|
|
18
|
+
- `Screenshots/*.png` — some runs only; filenames are tick counts, referenced from the `.uistat`.
|
|
19
|
+
|
|
20
|
+
Three states, not two: field omitted (profiling unavailable), directory present with no target data, directory with target data. A `.uistat` carrying no target data is normal.
|
|
21
|
+
|
|
22
|
+
## `.uistat` shape
|
|
23
|
+
|
|
24
|
+
Top level: `ExecutorJobId`, `ProfilingInstanceId`, `IsDebugging`, `Project`, `ProjectDirectory`, `EntryPointPath`, `Environment`, `Robot`, `RestoredPackages`, `ExecutionStartTimeUtc`, `ExecutedActivities`, `Workflows`.
|
|
25
|
+
|
|
26
|
+
Target data lives at `ExecutedActivities[].Activities[].CustomData`:
|
|
27
|
+
|
|
28
|
+
| Field | Carries |
|
|
29
|
+
|---|---|
|
|
30
|
+
| `ActivityType` | `Click`, `GoToUrl`, … |
|
|
31
|
+
| `Target.ScopeSelector` | window/app scope |
|
|
32
|
+
| `Target.StrictSelector` | selector authored on the activity |
|
|
33
|
+
| `Target.SearchSteps` | which strategies resolved it |
|
|
34
|
+
| `Target.SemanticSelectorModel` | AI fallback model |
|
|
35
|
+
| `TargetSearch[]` | per-attempt `Duration`, `StartScreenshot`, `EndScreenshot`; `EndScreenshot.TargetArea` = resolved bounds |
|
|
36
|
+
| `AfterExecuteScreenshot` | post-action frame |
|
|
37
|
+
|
|
38
|
+
`SearchSteps` separates a strict-selector hit from an AI rescue:
|
|
39
|
+
|
|
40
|
+
- `Selector` — the strict selector resolved it alone.
|
|
41
|
+
- `Selector, SemanticSelector` — the semantic fallback participated; the strict selector is not proven.
|
|
42
|
+
|
|
43
|
+
## Hard limit: one activity per coded workflow
|
|
44
|
+
|
|
45
|
+
The profiler sees a coded workflow as a single activity. `Workflows["Main.cs"].Activities` lists only the workflow class's activity wrapper (measured on a class `MicroAutomationWorkflow` as `MicroAutomationWorkflowActivity`), and `ExecutedActivities[].Activities[]` carries one entry — however many `app.Click`/`app.TypeInto` calls ran inside it.
|
|
46
|
+
|
|
47
|
+
Measured: a run that captured 100 screenshots referenced 2 of them in its `.uistat` and listed 1 activity.
|
|
48
|
+
|
|
49
|
+
Profiling therefore cannot enumerate per-step selector resolution. Do not build per-step accounting on it. It corroborates: `SearchSteps` for the one recorded target, screenshots for repair.
|
|
50
|
+
|
|
51
|
+
## Per-step evidence: the execution log
|
|
52
|
+
|
|
53
|
+
Workflow `Log()` output does not reach `--log-file` (writes an empty file) or stderr, at any `--log-level`. It lands in:
|
|
54
|
+
|
|
55
|
+
```
|
|
56
|
+
%LOCALAPPDATA%\UiPath\Logs\<YYYY-MM-DD>_Execution.log
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
One JSON object per line:
|
|
60
|
+
|
|
61
|
+
```json
|
|
62
|
+
{"message":"...","level":"Information","logType":"User","timeStamp":"...","fileName":"Main","jobId":"69b29242-...","processName":"<SanitizedName>"}
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
- `logType: "User"` — workflow `Log()` calls; system traces carry other values.
|
|
66
|
+
- `jobId` — correlates lines to one run.
|
|
67
|
+
|
|
68
|
+
Filter to `logType == "User"` plus the run's `jobId` (or the RunId the scaffold logs) for that run's step markers in order.
|
|
69
|
+
|
|
70
|
+
`<YYYY-MM-DD>_UIAutomation.log` sits alongside — low-level UIA traces, not step-correlated. Not a verification source.
|
|
71
|
+
|
|
72
|
+
## `--skip-build` and the assembly-load failure
|
|
73
|
+
|
|
74
|
+
`uip rpa build` alone can leave `.local/install/` without `<Project>.dll`. A later `--skip-build` run then fails:
|
|
75
|
+
|
|
76
|
+
```
|
|
77
|
+
Could not load file or assembly '<Project>, Culture=neutral, PublicKeyToken=null'
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
Recovery: run once without `--skip-build` (populates `.local/install/`), then `--skip-build` works.
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
# Writing reliable task automations
|
|
2
|
+
|
|
3
|
+
Task automations skip the heavy validation/testing pass a full RPA project gets — quick authoring is the point. That trade only works if the emitted code leans on the platform's own reliability mechanisms instead of hand-rolled waits/retries. This is the checklist; every property below is verified against a real generated `{PROJECT_DIR}/.local/docs/packages/UiPath.UIAutomation.Activities/coded/coded-api.md` (26.10.x) — confirm against yours if the pinned version differs, don't assume these hold across major versions.
|
|
4
|
+
|
|
5
|
+
## 1. Set `InteractionMode` explicitly — the default is the least reliable option
|
|
6
|
+
|
|
7
|
+
`uiAutomation.Open`/`Attach` default `TargetAppOptions.InteractionMode` to `NInteractionMode.HardwareEvents` when unset. Per the enum's own doc: "emulates human behavior 100%. However some events might be lost" — and it requires the target to stay visible/focused on screen. Omission is the common mistake, not a rare one: nothing in the API surfaces the choice, so an emitted `TargetAppOptions` block that sets only `OpenMode` looks complete. `assets/ExampleWorkflow.cs` sets it explicitly (`Simulate`, for a browser) — copy that shape.
|
|
8
|
+
|
|
9
|
+
Set it once, at `Open`/`Attach` time:
|
|
10
|
+
|
|
11
|
+
```csharp
|
|
12
|
+
var appOptions = new TargetAppOptions
|
|
13
|
+
{
|
|
14
|
+
InteractionMode = NInteractionMode.Simulate, // or WindowMessages for Windows desktop apps
|
|
15
|
+
OpenMode = NAppOpenMode.IfNotOpen,
|
|
16
|
+
};
|
|
17
|
+
using var app = uiAutomation.Open(appTarget, appOptions);
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
| Pick | When | Why |
|
|
21
|
+
|---|---|---|
|
|
22
|
+
| `NInteractionMode.Simulate` | Browsers, Java-based apps, SAP | "Usually more reliable than Hardware Events." Works even if the app isn't in focus — required for anything that might run backgrounded. |
|
|
23
|
+
| `NInteractionMode.WindowMessages` | Windows desktop apps | Same reliability edge as Simulate, via Win32 messages. Windows-only. |
|
|
24
|
+
| `NInteractionMode.HardwareEvents` | Only when Simulate/WindowMessages don't work — custom-drawn/canvas/game-engine UIs, some legacy controls | Explicit choice, not the fallback-by-omission. |
|
|
25
|
+
| `NInteractionMode.DebuggerApi` | Chrome/Edge elements specifically | Debugger-API based; works without focus. |
|
|
26
|
+
|
|
27
|
+
Per-element override (rare — only when one control needs a different mode than the rest of the app): `ClickOptions.InteractionMode` / `TypeIntoOptions.InteractionMode` (type `NChildInteractionMode`, adds `SameAsCard` — the default, inherits the app-level setting). Leave every other element on the default so the app-level choice controls the whole automation from one place.
|
|
28
|
+
|
|
29
|
+
## 2. Use `VerifyOptions` instead of hand-rolled waits, where it fits
|
|
30
|
+
|
|
31
|
+
`ClickOptions`, `TypeIntoOptions`, `HoverOptions`, and `KeyboardShortcutOptions` all carry a `VerifyOptions` property — the platform's own execute-and-confirm-and-retry loop, not something you write yourself:
|
|
32
|
+
|
|
33
|
+
```csharp
|
|
34
|
+
app.Click(target, new ClickOptions
|
|
35
|
+
{
|
|
36
|
+
VerifyOptions = new VerifyOptions
|
|
37
|
+
{
|
|
38
|
+
Target = nextScreenAnchor, // TargetAnchorableModel — the element that should appear/disappear after this click
|
|
39
|
+
Mode = NVerifyMode.Appears, // Appears | Disappears | TextChanges | AspectChanges
|
|
40
|
+
Retry = true, // retries the click itself if verification fails
|
|
41
|
+
Timeout = 10,
|
|
42
|
+
}
|
|
43
|
+
});
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Reach for this on any step where the UI's response is the real signal of success (a dialog closing, a next screen appearing, a status text changing) — it replaces a fixed `Thread.Sleep` plus a manual retry loop with one option block, and the retry happens inside the activity, not as extra code you have to write and debug. `TypeIntoOptions.VerifyOptions` additionally supports `ExpectedText` to confirm what was actually typed landed.
|
|
47
|
+
|
|
48
|
+
**Don't reach for `ClickOptions.DelayBefore`/`DelayAfter` — it doesn't exist.** Only `TargetOptions` (the base for read-only ops like `IsEnabled`/`GetClipboard`/`GetUrl`) and `VerifyOptions` itself carry `DelayBefore`/`DelayAfter`; `ClickOptions`/`TypeIntoOptions` do not, in this package version. (`references/coded-reference/uia-elements-interaction-guide.md`'s "async-disabled button" C# snippet predates this and is wrong for the coded API — its XAML form may still be accurate, the coded property just isn't there.) For a button disabled during validation/load: use `VerifyOptions` with `Retry = true` against a signal that the button became clickable (a loading spinner's `Mode: Disappears`, or the button's own `Mode: AspectChanges` if that's confirmed to cover enabled state — verify the exact semantics against your installed `coded-api.md` before relying on `AspectChanges` for this), or a short explicit `Thread.Sleep` as a last resort, never an invented `DelayBefore` field.
|
|
49
|
+
|
|
50
|
+
## 3. Use the `Retry<T>` helper in `Main.cs` for steps prone to one-off flakiness
|
|
51
|
+
|
|
52
|
+
`Main.cs` already carries `Retry`/`Retry<T>` helpers (exponential backoff, defined below `Execute`, written there from `assets/CodedWorkflow.template.cs`) — this skill removed the Delegate-agent self-healing fallback, so this is now the primary resilience mechanism for a step that occasionally fails for reasons unrelated to selector correctness (a transient network call, a slow-to-load page before the element search even starts):
|
|
53
|
+
|
|
54
|
+
```csharp
|
|
55
|
+
Retry(() => app.Click(target), attempts: 3);
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
Don't wrap every step in `Retry` by default — that hides a genuinely wrong selector behind three slow failures instead of failing fast. Reserve it for steps with a known transient-failure reason.
|
|
59
|
+
|
|
60
|
+
## 4. Honor `dryRun` for real, don't just log it
|
|
61
|
+
|
|
62
|
+
`Execute(string inputJson, bool dryRun)` receives `dryRun`, but nothing in the skeleton acts on it — filling the placeholder without checking `dryRun` means a caller who explicitly asked for a no-op gets the real, irreversible action anyway. Wrap the last irreversible step(s) — the ones the Security section's "no secrets" and credential rules already flag as sensitive, e.g. Submit/Send/Purchase/Delete:
|
|
63
|
+
|
|
64
|
+
```csharp
|
|
65
|
+
if (dryRun)
|
|
66
|
+
{
|
|
67
|
+
Log("Dry run: would click Submit here.");
|
|
68
|
+
}
|
|
69
|
+
else
|
|
70
|
+
{
|
|
71
|
+
app.Click(submitTarget);
|
|
72
|
+
}
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
Everything before the irreversible tail (navigation, form-filling, reads) can run normally in a dry run — it's cheap and lets the caller verify the workflow reaches the right screen. Only gate the step(s) that can't be undone.
|
|
76
|
+
|
|
77
|
+
## 5. Bring the target to the foreground before acting — usually already on
|
|
78
|
+
|
|
79
|
+
`ClickOptions.ActivateBefore` / `TypeIntoOptions.ActivateBefore` / `KeyboardShortcutOptions.ActivateBefore` default to `true` (bring the element's window to the foreground first). Leave it — don't set `false` unless you've confirmed the automation must not steal focus (e.g. a background batch run sharing the desktop with the user). A `false` here is a common, hard-to-diagnose cause of "the click did nothing" when another window covered the target.
|
|
80
|
+
|
|
81
|
+
## 6. `UnblockInput` only works with `Simulate`
|
|
82
|
+
|
|
83
|
+
`ClickOptions.UnblockInput` (used when a click triggers a modal dialog box) is documented as Simulate-only. If a step needs it and the app is on `WindowMessages`/`HardwareEvents`, either switch that one interaction's `InteractionMode` to `Simulate` or handle the resulting modal a different way — don't set `UnblockInput` expecting it to work under a different mode.
|