@uipath/delegate-sdk 1.203.1 → 1.203.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +41 -3
- package/dist/index.mjs +2 -2
- package/dist/skills/business-analysis/SKILL.md +722 -0
- package/dist/skills/business-analysis/as-is-capture.md +440 -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 +215 -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 +81 -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,194 @@
|
|
|
1
|
+
# Environment Setup
|
|
2
|
+
|
|
3
|
+
**Goal:** Resolve the project root before any other operations.
|
|
4
|
+
|
|
5
|
+
## Studio Desktop vs headless Studio
|
|
6
|
+
|
|
7
|
+
`uip rpa` runs against a **headless Studio** by default (codename Helm — ships as the `UiPath.Studio.Helm.{Platform}` NuGet package, auto-launched the first time a command needs it). **Studio Desktop is not required** for the standard authoring loop — `init`, `run`, `debug start`, `validate`, `build`, `activities find`, `packages install`, the `uia` group (indication, capture, interaction), etc. all work headless.
|
|
8
|
+
|
|
9
|
+
Studio Desktop is only required for two interactive UI tools:
|
|
10
|
+
- `uip rpa files diff` — opens an interactive diff window in Studio's UI.
|
|
11
|
+
- `uip rpa focus-activity` — selects an activity in Studio's active workflow designer.
|
|
12
|
+
|
|
13
|
+
For these two, see [§ Edge case: requiring Studio Desktop](#edge-case-requiring-studio-desktop) below.
|
|
14
|
+
|
|
15
|
+
> **First call is slow.** On a cold NuGet cache, the very first `uip rpa` invocation triggers a silent `dotnet restore` of the headless Studio package and may sit near-silent for 30–90 seconds (longer behind a slow feed). A heartbeat line every 15s confirms it's still working. The default shell timeout covers this; bump `timeoutSeconds` only behind a slow feed.
|
|
16
|
+
|
|
17
|
+
## Step 0.1: Establish Project Root
|
|
18
|
+
|
|
19
|
+
The `uip rpa` commands use `--project-dir` to target a specific project (defaults to current working directory). **If the current working directory is NOT the UiPath project root, all commands will fail or target the wrong project.**
|
|
20
|
+
|
|
21
|
+
**Resolution order** (use the first rule that matches):
|
|
22
|
+
1. **Explicit path** — The user provided a directory path → use it as-is.
|
|
23
|
+
2. **Project name reference** — The user mentioned a project by name → search for a folder with that name containing `project.json`.
|
|
24
|
+
3. **Fall back to current working directory** — If neither is given.
|
|
25
|
+
|
|
26
|
+
If the CWD is not the project root:
|
|
27
|
+
- Locate the project root by finding `project.json`: `Glob: pattern="**/project.json"`
|
|
28
|
+
- **Pass `--project-dir` explicitly** to every `uip rpa` command
|
|
29
|
+
- Store the project root path and use it consistently as `{projectRoot}`
|
|
30
|
+
|
|
31
|
+
## Step 0.2: Authentication (If Needed)
|
|
32
|
+
|
|
33
|
+
Some commands (IS connections, workflow examples, cloud features) require authentication:
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
uip login
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
If you encounter auth errors (401, 403, "not authenticated") during any phase, run `uip login` as the entire shell command (Delegate adds `--authority` for the signed-in deployment), then retry. Don't ask the user to run it in their own terminal: without `--authority` it signs in to UiPath Cloud.
|
|
40
|
+
|
|
41
|
+
## Step 0.3: Creating a New Project
|
|
42
|
+
|
|
43
|
+
**ALWAYS use `uip rpa init`** — never write `project.json`, `project.uiproj`, or other scaffolding files manually.
|
|
44
|
+
|
|
45
|
+
**`init` always scaffolds XAML.** Regardless of flags, the templates produce XAML files: `BlankTemplate` → `Main.xaml`, `TestAutomationProjectTemplate` → `TestCase.xaml`, `LibraryProcessTemplate` → XAML library workflows. There is no flag that flips the scaffolding to coded.
|
|
46
|
+
|
|
47
|
+
**`--expression-language` is independent of coded vs XAML.** It controls VB vs C# syntax inside XAML activity expressions — not whether the project has `.cs` workflow files. Coded workflows (`.cs` with `[Workflow]` / `[TestCase]`) work fine in both `VisualBasic` and `CSharp` projects.
|
|
48
|
+
|
|
49
|
+
**To work in coded mode**, scaffold the project (always XAML), then add `.cs` workflow files following [coded/operations-guide.md § Add a Workflow File](coded/operations-guide.md#add-a-workflow-file-to-existing-project) and update `entryPoints` in `project.json`. The scaffolded `Main.xaml` / `TestCase.xaml` can stay alongside your `.cs` files — `.xaml` and `.cs` workflows coexist freely.
|
|
50
|
+
|
|
51
|
+
**First, decide which template to use** — see [§ Template selection](#template-selection) below **before** running any `init` command. Defaulting to `--template-id BlankTemplate` is correct only when the user did not name a template or domain pattern.
|
|
52
|
+
|
|
53
|
+
### For XAML Projects (default for new projects)
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
uip rpa init \
|
|
57
|
+
--name "MyAutomation" \
|
|
58
|
+
--location "/path/to/parent/directory" \
|
|
59
|
+
--template-id "BlankTemplate" \
|
|
60
|
+
--expression-language <VisualBasic|CSharp> \
|
|
61
|
+
--target-framework <Portable|Windows> \
|
|
62
|
+
--description "Automates invoice processing" \
|
|
63
|
+
--output json
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
**Decide `--target-framework` and `--expression-language` before running — never omit them.** Both are immutable after creation; omitting `--target-framework` silently produces a **Windows** project. **Default to `Portable` (Cross-platform)** — it runs on every OS a Delegate host runs on, so a captured task ports with the user. Choose `Windows` only when the automation demonstrably needs a Windows-only capability (a dependency package with no cross-platform build, or an activity the cross-platform runtime does not ship). Windows - Legacy is a last resort (explicit ask or hard .NET 4.6.1 need) and is created/authored in **Legacy mode**, not via this command.
|
|
67
|
+
|
|
68
|
+
**Expression language:** Default `VisualBasic`.
|
|
69
|
+
|
|
70
|
+
**`--studio-dir`:** Optional. Headless Studio does not need it. Pass it only when you have explicitly forced Studio Desktop (`UIPATH_RPA_TOOL_USE_STUDIO=1`, or invoking `diff`/`focus-activity`) and Studio's auto-detection from the registry fails.
|
|
71
|
+
|
|
72
|
+
### For Coded Projects (only when the user explicitly requested coded)
|
|
73
|
+
|
|
74
|
+
Run the **same** `init` command as for an XAML project (above) — there is no separate coded form. After it scaffolds, add `.cs` workflow files per [coded/operations-guide.md § Add a Workflow File](coded/operations-guide.md#add-a-workflow-file-to-existing-project) and update `entryPoints` in `project.json`. The scaffolded `Main.xaml` / `TestCase.xaml` can stay — remove it only if the user explicitly asks for a coded-only project.
|
|
75
|
+
|
|
76
|
+
#### Parameters
|
|
77
|
+
|
|
78
|
+
| Parameter | Options | Default | Notes |
|
|
79
|
+
|-----------|---------|---------|-------|
|
|
80
|
+
| `--name` | Any string | (required) | Project folder name |
|
|
81
|
+
| `--location` | Directory path | (current dir) | Parent directory where project folder is created |
|
|
82
|
+
| `--template-id` | `BlankTemplate`, `LibraryProcessTemplate`, `TestAutomationProjectTemplate` | `BlankTemplate` | Project template |
|
|
83
|
+
| `--expression-language` | `VisualBasic`, `CSharp` | none — set explicitly | Expression syntax for XAML workflows. Immutable after creation |
|
|
84
|
+
| `--target-framework` | `Portable` (Cross-platform), `Windows`, `Legacy` (Windows - Legacy) | none — set explicitly (omitting → Windows) | .NET target framework. Immutable after creation. Default to `Portable`; `Windows` only for a demonstrated Windows-only need. `Legacy` is a last resort for new projects (explicit ask or hard .NET 4.6.1 need only) |
|
|
85
|
+
| `--description` | Any string | (none) | Project description in project.json |
|
|
86
|
+
|
|
87
|
+
**Note:** `uip rpa init` may return `success: false` but still create the project files (partial success). If it fails, check whether the project directory and `project.json` were created before retrying.
|
|
88
|
+
|
|
89
|
+
### Template selection
|
|
90
|
+
|
|
91
|
+
Before running `init`, decide which template to use.
|
|
92
|
+
|
|
93
|
+
**1. Trigger keywords**
|
|
94
|
+
|
|
95
|
+
| User says... | Action |
|
|
96
|
+
|---|---|
|
|
97
|
+
| "REFramework", "ERP template", "SAP template", "based on X template", or any specific template name | Run `uip rpa templates search --query "<term>" --output json` (see § "Search and select" below) |
|
|
98
|
+
| "library", "library project" | Use `--template-id LibraryProcessTemplate` (built-in, no search) |
|
|
99
|
+
| "test project", "test automation" | Use `--template-id TestAutomationProjectTemplate` (built-in, no search) |
|
|
100
|
+
| Nothing template-related | Use `--template-id BlankTemplate` (default) |
|
|
101
|
+
|
|
102
|
+
**2. Search and select**
|
|
103
|
+
|
|
104
|
+
Run `uip rpa templates search --query "<term>" --output json`. Apply this rule against `Data[*]`, top-down:
|
|
105
|
+
|
|
106
|
+
- **User named a specific non-Official template** (e.g. "Enhanced REFramework", "Lite ReFrameWork", a specific package name) AND a `Marketplace` item's `title` or `packageId` substring-matches the user's specific qualifier ("Enhanced", "Lite", etc.) → ask the user (treat Official + that Marketplace item as candidates). Do NOT auto-pick.
|
|
107
|
+
- **Exactly one item with `source == "Official"`** AND user did not name a non-Official template → pick it. No user prompt.
|
|
108
|
+
- **Multiple `Official` items** → present candidates (`packageId`, `version`, `title`, `description`) and ask the user.
|
|
109
|
+
- **Zero `Official` items, ≥1 `Marketplace` item** → present and ask. Never silently pick a Marketplace template.
|
|
110
|
+
- **No results** → tell the user, then create with `--template-id BlankTemplate`.
|
|
111
|
+
|
|
112
|
+
**3. Create from package**
|
|
113
|
+
|
|
114
|
+
For Official/Marketplace templates, pass `--template-package-id` (and optionally `--template-package-version` — omit for latest) to `init`. When `--template-package-id` is set, `--template-id` is ignored.
|
|
115
|
+
|
|
116
|
+
### From a NuGet Template Package
|
|
117
|
+
|
|
118
|
+
Use when the user asks for a domain-specific template, references a specific template package by name, or wants to browse available templates.
|
|
119
|
+
|
|
120
|
+
**1. Search for available templates:**
|
|
121
|
+
|
|
122
|
+
```bash
|
|
123
|
+
uip rpa templates search --query "<SEARCH_TERM>" --output json
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
Does not require a project to be open. Returns a JSON array of `TemplateSearchResult` objects:
|
|
127
|
+
|
|
128
|
+
```json
|
|
129
|
+
[
|
|
130
|
+
{
|
|
131
|
+
"packageId": "UiPath.Template.SAPExample",
|
|
132
|
+
"version": "2.0.0",
|
|
133
|
+
"title": "SAP Automation Template",
|
|
134
|
+
"description": "Pre-configured project for SAP GUI automation",
|
|
135
|
+
"authors": "UiPath",
|
|
136
|
+
"source": "https://feed.example.com/v3/index.json",
|
|
137
|
+
"tags": ["SAP", "ERP"]
|
|
138
|
+
}
|
|
139
|
+
]
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
| Parameter | Type | Default | Notes |
|
|
143
|
+
|-----------|------|---------|-------|
|
|
144
|
+
| `--query` | string | (none) | Filter by name or description. Omit to list all |
|
|
145
|
+
| `--limit` | integer | 20 | Maximum results |
|
|
146
|
+
| `--include-prerelease` | flag | false | Include prerelease versions |
|
|
147
|
+
|
|
148
|
+
**2. Create from the chosen template:**
|
|
149
|
+
|
|
150
|
+
```bash
|
|
151
|
+
uip rpa init \
|
|
152
|
+
--name "MySAPAutomation" \
|
|
153
|
+
--location "/path/to/parent/directory" \
|
|
154
|
+
--template-package-id "<PACKAGE_ID>" \
|
|
155
|
+
--template-package-version "<VERSION>" \
|
|
156
|
+
--target-framework <Portable|Windows> \
|
|
157
|
+
--expression-language <VisualBasic|CSharp> \
|
|
158
|
+
--output json
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
Pass `--target-framework` and `--expression-language` here too (default `Portable`, same rule as above) — a template package does not exempt you from the explicit-framework decision.
|
|
162
|
+
|
|
163
|
+
| Parameter | Type | Default | Notes |
|
|
164
|
+
|-----------|------|---------|-------|
|
|
165
|
+
| `--template-package-id` | string | (none) | NuGet package ID from `templates search` results. **Overrides `--template-id` when set** |
|
|
166
|
+
| `--template-package-version` | string | (latest) | Omit to use the latest available version |
|
|
167
|
+
|
|
168
|
+
### After Creation
|
|
169
|
+
|
|
170
|
+
1. Open the project in Studio: `uip rpa project open --project-dir "/path/to/MyAutomation"`
|
|
171
|
+
2. **Read the scaffolded files** — the command generates starter files. Read them before making changes so you build on valid defaults
|
|
172
|
+
3. Proceed with the skill workflow using the new project root
|
|
173
|
+
|
|
174
|
+
> **Batch the post-`init` prerequisites.** Step 2 here, `packages install` for known-needed packages, and the first `activities find` all depend only on the project existing — emit them as parallel tool calls in one message, not one per turn. They share the warmed Studio host. See SKILL.md § Call Batching.
|
|
175
|
+
|
|
176
|
+
## Edge case: requiring Studio Desktop
|
|
177
|
+
|
|
178
|
+
Two `uip rpa` commands need a running Studio Desktop instance — they have UI side effects that Helm cannot render:
|
|
179
|
+
|
|
180
|
+
| Command | Why it needs Studio |
|
|
181
|
+
|---------|---------------------|
|
|
182
|
+
| `uip rpa files diff` | Opens an interactive diff window in Studio's UI; finishes when the user closes the window. |
|
|
183
|
+
| `uip rpa focus-activity` | Selects/highlights an activity in Studio's active workflow designer. ⚠️ Against headless it **silently succeeds without doing anything** (there is no designer) — a `success: true` from a headless session does NOT mean anything was focused. |
|
|
184
|
+
|
|
185
|
+
When (and only when) you need to run one of these, ensure Studio Desktop is up:
|
|
186
|
+
|
|
187
|
+
```bash
|
|
188
|
+
uip rpa instances list --output json # hidden diagnostic — confirms a Studio Desktop instance is running
|
|
189
|
+
uip rpa studio start --project-dir "{projectRoot}" --output json # launches Studio Desktop if none is running
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
If `studio start` cannot resolve Studio's install directory from the registry, pass `--studio-dir` pointing to the Studio installation root.
|
|
193
|
+
|
|
194
|
+
You can also force Studio Desktop for any other command by setting `UIPATH_RPA_TOOL_USE_STUDIO=1`, but this is not needed for the standard authoring loop and gives up the headless benefits.
|
|
@@ -0,0 +1,195 @@
|
|
|
1
|
+
# Error Handling Guide
|
|
2
|
+
|
|
3
|
+
Production-grade error handling and resilience for modern UiPath coded projects (Windows / Cross-platform). Covers exception taxonomy, Try/Catch discipline, Throw/Rethrow, screenshot-on-error, fail-fast validation, state recovery, transaction boundaries, idempotent/compensating writes, sensitive-data handling, and retry ownership across layers.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 1. Exception Taxonomy
|
|
8
|
+
|
|
9
|
+
Two families. Classify correctly — misclassification either wastes retries on bad data or skips recoverable failures.
|
|
10
|
+
|
|
11
|
+
| | Business exception | System / Application exception |
|
|
12
|
+
|---|---|---|
|
|
13
|
+
| **Type** | `UiPath.Core.BusinessRuleException` | `System.Exception` (and any other subclass) |
|
|
14
|
+
| **Cause** | Invalid / missing INPUT DATA (bad format, missing field, rule violated) | Transient TECHNICAL failure (app crash, timeout, selector not found, network, file lock) |
|
|
15
|
+
| **Retry fixes it?** | **No** — data won't change on retry; needs a human | **Maybe** — transient, may clear on retry |
|
|
16
|
+
| **Action** | Log, skip item, mark failed | Retry (limited), reset app state, then escalate |
|
|
17
|
+
| **Orchestrator queue Auto-Retry** | Not retried | Retried (when enabled) |
|
|
18
|
+
|
|
19
|
+
**Rules:**
|
|
20
|
+
|
|
21
|
+
1. `BusinessRuleException` and `System.ApplicationException` are **siblings** — both inherit directly from `System.Exception`, neither from the other. A `System.Exception` catch matches everything; a `BusinessRuleException` catch matches only business exceptions.
|
|
22
|
+
2. Business classification is **never automatic** — you must throw a `BusinessRuleException` explicitly. Any unhandled error that isn't an explicit business throw surfaces as a system exception.
|
|
23
|
+
3. Qualify as `UiPath.Core.BusinessRuleException` when ambiguous — the name also exists in other namespaces. `UiPath.Core` is imported by default in new projects, so the short name resolves; use the full name in coded files or on a compiler-ambiguity error.
|
|
24
|
+
4. **Isolated invoke loses the type:** a `BusinessRuleException` from a workflow invoked with **Isolated** checked arrives at the caller as `System.Exception` (separate process), breaking type-based catch routing. If the caller routes on type, don't use Isolated. If you must, catch inside the isolated workflow and return a structured status / error-code **output argument**, or throw with a stable code prefix the caller matches — never route on the human-readable `Message` (it changes, localizes, and carries variable data).
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
## 2. Choose the Mechanism
|
|
29
|
+
|
|
30
|
+
| Need | Use | Notes |
|
|
31
|
+
|------|-----|-------|
|
|
32
|
+
| Handle / classify a failure, run compensating logic | **Try/Catch** | Wrap external interactions (UI, file, network, DB) — not assignments or control flow |
|
|
33
|
+
| Reject bad input before any work | **Fail-fast** + throw a `BusinessRuleException` | Validate all inputs up front (§7) |
|
|
34
|
+
|
|
35
|
+
Default posture: **fail-fast on bad data, Try/Catch around every external interaction.** Don't blanket-wrap pure logic.
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## 3. Try/Catch Discipline
|
|
40
|
+
|
|
41
|
+
Rules that matter for correctness:
|
|
42
|
+
|
|
43
|
+
1. **Order catches specific → general; `System.Exception` last.** A `System.Exception` clause above specific ones makes them unreachable. (Place `BusinessRuleException`, `TimeoutException`, `SelectorNotFoundException` first.)
|
|
44
|
+
2. **Never leave a Catch empty** — violates Workflow Analyzer `ST-DBP-003`. At minimum log the exception.
|
|
45
|
+
3. **Catch only what you'll act on.** Wrap external interactions; don't wrap a whole `Process` in a catch-all that hides where the failure was.
|
|
46
|
+
4. **`Finally` is cleanup only** — close/kill apps, dispose connections, delete temp files. No business logic.
|
|
47
|
+
5. **`Finally` DOES run when the Catch rethrows** (modern, verified) — cleanup is safe to place there even on a rethrow path. (Older legacy-era guidance claiming Finally is skipped on Rethrow does **not** apply to modern Windows / Cross-platform projects.)
|
|
48
|
+
6. **Don't design business recovery around runtime/process termination.** Out-of-memory, a killed host process, and UiPath fatal faults can tear the job down without your Catch/Finally running — treat them as unrecoverable, not as something to handle.
|
|
49
|
+
|
|
50
|
+
---
|
|
51
|
+
|
|
52
|
+
## 4. Throw & Rethrow
|
|
53
|
+
|
|
54
|
+
```csharp
|
|
55
|
+
new BusinessRuleException($"Invoice {invoiceId} amount {amount:F2} is negative")
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
---
|
|
59
|
+
|
|
60
|
+
## 7. Fail-Fast Input Validation
|
|
61
|
+
|
|
62
|
+
Validate **all** required inputs in one place at the start, before any business logic. Throw `BusinessRuleException` immediately with the offending value in the message.
|
|
63
|
+
|
|
64
|
+
Catch every problem up front, not one run at a time. Don't validate inside loops — validate once before the loop. Guiding principle: **fail fast, fail loud** — surface bad data immediately with context; never let an invalid value flow into business logic and fail obscurely later.
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
## 9. Screenshot-on-Error
|
|
69
|
+
|
|
70
|
+
For unattended post-mortem, capture a screenshot in the Catch before propagating. Modern activity: **Take Screenshot** (`UiPath.UIAutomationNext.Activities.NTakeScreenshot`, package `UiPath.UIAutomation.Activities`).
|
|
71
|
+
|
|
72
|
+
1. **Use an absolute path** including folder + `.png` — relative paths resolve into the NuGet cache. Create the directory first.
|
|
73
|
+
2. **Set `ContinueOnError=True` on the capture** so a failed screenshot doesn't abort the handler.
|
|
74
|
+
3. **Take Screenshot needs an interactive session** — under unattended Robots with no display it fails (`Win32Exception 0x80004005`) or silently writes nothing. For reliable unattended post-mortem prefer **Orchestrator session recording** (Robot 2023.2+) over the activity.
|
|
75
|
+
4. **Treat screenshots as sensitive data** — they routinely capture PII, credentials, invoices, and open sessions. Write to an access-controlled folder / storage bucket (not a world-readable temp), name files by job/transaction id + timestamp, set a retention + cleanup policy, and don't attach raw screenshots to logs that ship to a broad audience.
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
## 10. Logging Exceptions
|
|
80
|
+
|
|
81
|
+
1. **Log `exception.ToString()`** (type + message + full stack), not just `.Message` — `.Message` alone loses the root cause.
|
|
82
|
+
2. **Level:** `Error` for caught system exceptions; `Warn` for recoverable business exceptions; `Fatal` for unrecoverable. Only `Trace`/`Verbose` capture argument values (PII risk) — don't log secrets.
|
|
83
|
+
3. **Log before you handle** — emit the exception detail before the Catch swallows or rethrows it.
|
|
84
|
+
4. **Limits:** `Log Message` truncates at 10,000 chars; Automation Cloud drops robot logs > 50 KB. The Orchestrator robot log level overrides local config (default `Information`).
|
|
85
|
+
|
|
86
|
+
---
|
|
87
|
+
|
|
88
|
+
## 11. Recover to a Known State Before Retrying
|
|
89
|
+
|
|
90
|
+
Retrying a UI or system action without resetting state usually repeats the failure or corrupts data. After a system exception, **before the next attempt**:
|
|
91
|
+
|
|
92
|
+
1. Dismiss blocking popups / modal dialogs.
|
|
93
|
+
2. Return the app or browser to a known anchor (home / search page); reattach, or close and reopen if the window is gone.
|
|
94
|
+
3. Clear partially-entered form data; discard half-built records.
|
|
95
|
+
4. Re-login if the session expired or timed out.
|
|
96
|
+
5. Clean up partial artifacts (temp files, interrupted downloads).
|
|
97
|
+
6. **Verify the expected screen is present** (`Check App State` / `Element Exists`) before re-running the action.
|
|
98
|
+
|
|
99
|
+
Wire this reset into the Catch before a manual retry. Rule: **a retry that skips state recovery is usually a bug.**
|
|
100
|
+
|
|
101
|
+
## 12. Transaction Boundary (outside REFramework)
|
|
102
|
+
|
|
103
|
+
Scope error handling to **one item**, not the whole loop, so a single bad item can't abort the batch. Two recipes by source:
|
|
104
|
+
|
|
105
|
+
**Queue-backed — let Orchestrator own retry.** Get a queue item, process, then set its status with `Set Transaction Status`:
|
|
106
|
+
- **Success** on completion.
|
|
107
|
+
- **BusinessException** on bad data → Orchestrator does **not** retry; flagged for human review.
|
|
108
|
+
- **ApplicationException** on a transient/system failure → Orchestrator retries per the queue's `Max # of retries`.
|
|
109
|
+
|
|
110
|
+
Don't wrap your own per-item retry loop on top — the queue owns transaction retry (§15). Carry the item `Reference` / id in every log line.
|
|
111
|
+
|
|
112
|
+
**DataTable / list — own a status column + bounded in-workflow retry.** No queue, so you own status and retry:
|
|
113
|
+
|
|
114
|
+
```
|
|
115
|
+
For each row/item:
|
|
116
|
+
Try
|
|
117
|
+
Validate ' Throw BusinessRuleException on bad data
|
|
118
|
+
Process ' external interactions
|
|
119
|
+
Status column = "Success"
|
|
120
|
+
Catch BusinessRuleException ' bad data — do NOT retry
|
|
121
|
+
Status = "Failed: business"; log; continue to next item
|
|
122
|
+
Catch Exception ' transient — bounded retry of the SAME item, then escalate
|
|
123
|
+
Status = "Failed: system"; log
|
|
124
|
+
Finally
|
|
125
|
+
Persist the status column; release per-item resources
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
1. **One Try/Catch per item** — a single bad item must not abort the batch.
|
|
129
|
+
2. `BusinessRuleException` → mark failed/skipped, continue. System exception → bounded retry of the **same** item, then escalate.
|
|
130
|
+
3. Persist per-item status and release resources in `Finally`; include an **item id / correlation id** in every log line.
|
|
131
|
+
|
|
132
|
+
## 13. Compensation & Resume-Safe Writes
|
|
133
|
+
|
|
134
|
+
A failure partway through external writes leaves partial side effects. Make writes safe to re-run:
|
|
135
|
+
|
|
136
|
+
1. **Idempotency key** on API creates (client-generated id or `Idempotency-Key` header) so a retried create doesn't duplicate.
|
|
137
|
+
2. **Check-before-create** when no key is available — query by natural key first. **Not concurrency-safe on its own:** two robots can both check, see nothing, and both create. Back it with a server-side unique constraint / upsert, a lock or reservation record, or a downstream reconciliation pass — don't rely on the check alone.
|
|
138
|
+
3. **Record the external id immediately** after creation (persist before the next step) so a resumed run continues from it instead of re-creating.
|
|
139
|
+
4. **Never blindly retry a non-idempotent write** (payment, append, keyless POST).
|
|
140
|
+
5. **Define compensation** for partial work: delete the created draft, void the transaction, or mark the record for manual reconciliation.
|
|
141
|
+
|
|
142
|
+
## 14. Sensitive Data in Logs & Screenshots
|
|
143
|
+
|
|
144
|
+
Error paths are where secrets leak — exceptions and screenshots capture live data.
|
|
145
|
+
|
|
146
|
+
1. **Never log** credentials, auth headers/tokens, full request/response bodies, bank/card numbers, full customer identifiers, or document images unless explicitly approved. Redact or hash first.
|
|
147
|
+
2. `exception.ToString()` is right for the stack trace (§10), but the **message may still contain secrets or input values** — sanitize messages you build; don't echo raw input.
|
|
148
|
+
3. Treat screenshots as sensitive data — restricted storage, id+timestamp naming, retention/cleanup, access control (§9).
|
|
149
|
+
4. `Trace` / `Verbose` capture argument values (PII) — keep them out of production, and don't defeat the project's excluded-logged-data settings (`Private:*`, `*password*`).
|
|
150
|
+
|
|
151
|
+
## 15. Who Owns the Retry — Pick One Layer
|
|
152
|
+
|
|
153
|
+
Retries **stack multiplicatively**: 3 local × 3 queue × 3 job = up to 27 executions of the same work, with duplicate side effects. Assign one owner per concern.
|
|
154
|
+
|
|
155
|
+
| Layer | Owns | Don't use it for |
|
|
156
|
+
|---|---|---|
|
|
157
|
+
| **Orchestrator queue retry** (`Max # of retries`) | Business-transaction retry, when queues are used | short transient UI blips |
|
|
158
|
+
| **Orchestrator job/process retry** | Whole-job restart (use sparingly) | per-item or per-action retry |
|
|
159
|
+
|
|
160
|
+
1. Queues present → queue retry owns transaction retry.
|
|
161
|
+
2. **Don't enable retry at every layer** — pick the lowest layer that fully resets state (§11) and disable the rest.
|
|
162
|
+
|
|
163
|
+
---
|
|
164
|
+
|
|
165
|
+
## Coded (C#)
|
|
166
|
+
|
|
167
|
+
Coded workflows use the same types and rules:
|
|
168
|
+
|
|
169
|
+
```csharp
|
|
170
|
+
if (string.IsNullOrWhiteSpace(invoiceNumber))
|
|
171
|
+
throw new BusinessRuleException($"Invoice number is empty"); // using UiPath.Core;
|
|
172
|
+
try { /* external interaction */ }
|
|
173
|
+
catch (BusinessRuleException) { Log("business error", LogLevel.Warn); throw; } // bare throw = preserve stack
|
|
174
|
+
catch (Exception ex) { Log(ex.ToString(), LogLevel.Error); throw; }
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
- `throw;` (bare) preserves the stack trace; `throw ex;` resets it — same `CA2200` rule as Rethrow vs Throw-new.
|
|
178
|
+
- Workflow Analyzer rules (`ST-DBP-003`, etc.) apply to `.cs` workflows too.
|
|
179
|
+
- Retry: a plain `for` loop with `try/catch` and a delay. Coded `using` directives: [coded/coding-guidelines.md](coded/coding-guidelines.md).
|
|
180
|
+
|
|
181
|
+
---
|
|
182
|
+
|
|
183
|
+
## Anti-patterns
|
|
184
|
+
|
|
185
|
+
| Symptom | Cause | Fix |
|
|
186
|
+
|---|---|---|
|
|
187
|
+
| "BusinessRuleException caught as system error" | not thrown explicitly, Isolated invoke, or namespace ambiguity | Explicit throw of `BusinessRuleException`, qualify `UiPath.Core`, avoid Isolated (§1) |
|
|
188
|
+
| Empty `Catch` | silent failure, `ST-DBP-003` | Log at minimum (§3) |
|
|
189
|
+
| `throw ex;` to re-surface | resets stack, drops type | bare `throw;` (§Coded) |
|
|
190
|
+
| Screenshot works attended, nothing unattended | no interactive session | Orchestrator recording + absolute path (§9) |
|
|
191
|
+
| Same work runs many times / duplicate side effects | retries stacked at multiple layers (local × queue × job) | one retry owner per concern (§15); idempotency on writes (§13) |
|
|
192
|
+
| Retry repeats the failure or corrupts data | action retried without resetting app/data state | recover to a known state first (§11) |
|
|
193
|
+
| Secrets/PII in logs or screenshots | logging raw messages/bodies; unprotected screenshot store | redact; restricted storage (§14) |
|
|
194
|
+
</content>
|
|
195
|
+
</invoke>
|
package/dist/skills/uipath-taskautomation/references/coded-reference/powershell-interop-guide.md
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# Invoking PowerShell from RPA Workflows
|
|
2
|
+
|
|
3
|
+
## Default: Use a Coded Workflow Instead
|
|
4
|
+
|
|
5
|
+
When the impulse is "drop into PowerShell," reach for a coded workflow (`[Workflow]` in a `.cs` file) first. A coded workflow runs in-process, surfaces real exceptions, and lives in one file with the rest of the project.
|
|
6
|
+
|
|
7
|
+
Reach for PowerShell only when:
|
|
8
|
+
|
|
9
|
+
1. The script needs Windows-admin cmdlets (`Get-ADUser`, `Mount-*`, etc.) awkward to call from .NET.
|
|
10
|
+
2. The project already has `.ps1` scripts you must edit (don't rewrite for its own sake).
|
|
11
|
+
3. Logic is genuinely PS-shaped (modules, pipeline-style data flow).
|
|
12
|
+
|
|
13
|
+
For SharePoint REST, HTTP uploads, JSON parsing, file mangling — write a coded workflow.
|
|
14
|
+
|
|
15
|
+
## When You Need PowerShell — Use the `InvokePowerShell` Activity
|
|
16
|
+
|
|
17
|
+
`UiPath.Core.Activities.InvokePowerShell<T>` (`UiPath.System.Activities`) is the supported path. **Do not shell out via `Invoke Process` + `powershell.exe`** — that path requires manual quote escaping, exit-code parsing, and a status-file dance. `InvokePowerShell` handles parameter binding and output collection directly, and exceptions propagate as activity faults.
|
|
18
|
+
|
|
19
|
+
### Properties
|
|
20
|
+
|
|
21
|
+
| Property | Type | Notes |
|
|
22
|
+
|----------|------|-------|
|
|
23
|
+
| `CommandText` | `InArgument<string>` | Required. Script body or single command. |
|
|
24
|
+
| `IsScript` | `InArgument<bool>` | `true` → multi-line script. `false` → single cmdlet invocation. |
|
|
25
|
+
| `Parameters` | typed collection | Named bindings passed in. |
|
|
26
|
+
| `Input` | `InArgument<IEnumerable>` | Pipeline input (`$input` inside the script). |
|
|
27
|
+
| `Output` | `OutArgument<IEnumerable<T>>` | Collected results. `T` is the activity's generic type argument (e.g. `PSObject`, `string`). |
|
|
28
|
+
| `PowerShellProcess` | enum | `WindowsPowerShell32` / `WindowsPowerShell64` / `PowerShellCore`. Pin the runtime explicitly. |
|
|
29
|
+
| `ContinueOnError` | `InArgument<bool>` | Default `false`. PS exceptions propagate as activity faults. |
|
|
30
|
+
|
|
31
|
+
For typed parameter bindings, use the `Parameters` collection instead of building a command line — no string concatenation, no quote escaping.
|
|
32
|
+
|
|
33
|
+
### Choosing `PowerShellProcess`
|
|
34
|
+
|
|
35
|
+
| Value | Runtime | When to use |
|
|
36
|
+
|-------|---------|-------------|
|
|
37
|
+
| `WindowsPowerShell64` | Windows PowerShell 5.1, 64-bit | Default for Windows robots; broadest cmdlet compatibility. |
|
|
38
|
+
| `WindowsPowerShell32` | Windows PowerShell 5.1, 32-bit | Legacy 32-bit modules only. |
|
|
39
|
+
| `PowerShellCore` | PowerShell 7+ | Cross-platform. Requires `pwsh` installed on the robot. Needed for 7+-only features (`Invoke-WebRequest -InFile`, `ConvertFrom-Json -AsHashtable`, ternary, null-conditional, `&&`/`\|\|`). |
|
|
40
|
+
|
|
41
|
+
Always set `PowerShellProcess` explicitly so a robot upgrade does not silently change the runtime.
|
|
42
|
+
|
|
43
|
+
## Last-Resort `Invoke Process`
|
|
44
|
+
|
|
45
|
+
Some scenarios force a direct shellout — a vendor script with exact-CLI requirements, or an interactive session. In that case:
|
|
46
|
+
|
|
47
|
+
1. **Pin the executable.** `FileName="powershell.exe"` for 5.1, `FileName="pwsh.exe"` for 7+. Do not rely on PATH.
|
|
48
|
+
2. **Escape quotes in every value** embedded in `Arguments`. A single `"` or `'` in a path silently shifts every later positional arg.
|
|
49
|
+
- C#: `value.Replace("\"", "\"\"")`
|
|
50
|
+
3. **Status by file, not stdout.** `Invoke Process` returns the exit code only. Wrap the script body in `try { … } catch { Out-File -FilePath $statusFile -InputObject ("ERROR: " + $_.Exception.Message); exit 1 }` so failures are never silent. Read the file after, then delete it.
|
|
51
|
+
|
|
52
|
+
## Anti-Patterns
|
|
53
|
+
|
|
54
|
+
1. **Defaulting to PowerShell when a coded workflow would do.** See § Default.
|
|
55
|
+
2. **Using `Invoke Process` when `InvokePowerShell` works.** Skipping the typed activity for no reason triples the gotcha surface.
|
|
56
|
+
3. **Driving UI from PowerShell.** Use UiPath UIAutomation activities — targeting rules in [coded-workflow-authoring.md](../coded-workflow-authoring.md) § Targeting.
|
|
57
|
+
4. **Omitting `PowerShellProcess`.** A robot upgrade can silently land your script on a different runtime.
|
package/dist/skills/uipath-taskautomation/references/coded-reference/project-structure-guide.md
ADDED
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
# Designing Project Structure
|
|
2
|
+
|
|
3
|
+
When creating a project, **proactively design the right file structure** based on the task complexity. Do not put everything into a single root workflow file. Use your best judgment to split the project into multiple files following good software engineering practices.
|
|
4
|
+
|
|
5
|
+
## Guidelines
|
|
6
|
+
|
|
7
|
+
- **Single simple task** (e.g. "read a CSV and log it") — one workflow file (`Main.cs`) is fine
|
|
8
|
+
- **Multi-step process** (e.g. "read invoices, validate, post to system") — split into multiple workflow files, each handling one step. The root workflow invokes each step
|
|
9
|
+
- **Shared data structures** — extract into a Coded Source File (e.g. `Models.cs`, `InvoiceData.cs`)
|
|
10
|
+
- **Repeated logic** — extract into a helper Coded Source File (e.g. `ValidationHelpers.cs`)
|
|
11
|
+
- **Test project** — one test case per scenario. Coded test projects optionally use `partial class CodedWorkflow : IBeforeAfterRun` in `CodedWorkflowHooks.cs` for shared setup
|
|
12
|
+
- **Complex domain logic** — isolate business rules so they can be unit-tested and reused (Coded Source File for typed logic, or a separate workflow for activity-driven logic)
|
|
13
|
+
|
|
14
|
+
## Designing for Reuse
|
|
15
|
+
|
|
16
|
+
Structure decisions that keep components extractable later.
|
|
17
|
+
|
|
18
|
+
### Single responsibility
|
|
19
|
+
|
|
20
|
+
One workflow file = one meaningful action, named for it. Split a workflow when it exceeds ~20-30 activities.
|
|
21
|
+
|
|
22
|
+
### Standard folder shape
|
|
23
|
+
|
|
24
|
+
For multi-step processes, organize by layer:
|
|
25
|
+
|
|
26
|
+
```
|
|
27
|
+
Project/
|
|
28
|
+
├── Framework/ # Init, cleanup, error handling, app open/close
|
|
29
|
+
├── BusinessLogic/ # Process-specific rules and transactions
|
|
30
|
+
├── Utilities/ # Process-agnostic helpers (formatters, screenshots)
|
|
31
|
+
└── Data/ # Config files, templates
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### Separate business logic from UI components
|
|
35
|
+
|
|
36
|
+
UI workflows interact with applications and carry zero business rules; business-logic workflows decide and never touch the UI. Make read and write distinct invocable components. When the target application's UI changes, only the UI workflows need fixing; when a business rule changes, the UI workflows are untouched. Process-agnostic UI components are also the ones worth promoting to a shared library later.
|
|
37
|
+
|
|
38
|
+
### Composition and argument naming
|
|
39
|
+
|
|
40
|
+
Compose via `workflows.StepName()`. Process workflow arguments use directional prefixes — `in_InvoiceId`, `out_Result`, `io_Browser` — so data flow is visible at every invocation site. Exception: library public workflows drop the prefixes.
|
|
41
|
+
|
|
42
|
+
### Layout and scale-out
|
|
43
|
+
|
|
44
|
+
- High-volume transactional work: dispatcher/performer split via queues (REFramework territory, out of scope for this extract)
|
|
45
|
+
|
|
46
|
+
### Promotion ladder
|
|
47
|
+
|
|
48
|
+
Promote logic only as reuse materializes:
|
|
49
|
+
|
|
50
|
+
1. **Inline** — used once in one workflow
|
|
51
|
+
2. **Separate workflow file** — reused within the project
|
|
52
|
+
3. **Shared library** — reused across projects
|
|
53
|
+
|
|
54
|
+
## Example — Invoice Processing Project
|
|
55
|
+
|
|
56
|
+
```
|
|
57
|
+
InvoiceProcessor/
|
|
58
|
+
├── project.json
|
|
59
|
+
├── Main.cs # Root workflow: calls each step via workflows.StepName()
|
|
60
|
+
├── ReadInvoices.cs # Step 1
|
|
61
|
+
├── ValidateInvoices.cs # Step 2
|
|
62
|
+
├── PostToERP.cs # Step 3
|
|
63
|
+
├── InvoiceData.cs # Coded source file: data model
|
|
64
|
+
└── ValidationHelpers.cs # Coded source file: validation utilities
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
`Main.cs` uses strongly-typed workflow invocation:
|
|
68
|
+
|
|
69
|
+
```csharp
|
|
70
|
+
[Workflow]
|
|
71
|
+
public void Execute(string inputFolder)
|
|
72
|
+
{
|
|
73
|
+
var readResult = workflows.ReadInvoices(folderPath: inputFolder);
|
|
74
|
+
Log($"Read {readResult.count} invoices");
|
|
75
|
+
|
|
76
|
+
var validateResult = workflows.ValidateInvoices(invoices: readResult.invoiceList);
|
|
77
|
+
Log($"Valid: {validateResult.validCount}, Invalid: {validateResult.invalidCount}");
|
|
78
|
+
|
|
79
|
+
var postResult = workflows.PostToERP(validInvoices: validateResult.validInvoices);
|
|
80
|
+
Log($"Posted {postResult.successCount} invoices to ERP");
|
|
81
|
+
}
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
## Example — Test Project
|
|
85
|
+
|
|
86
|
+
```
|
|
87
|
+
InvoiceTests/
|
|
88
|
+
├── project.json
|
|
89
|
+
├── CodedWorkflowHooks.cs # Coded test projects only: partial class CodedWorkflow with Before/After hooks
|
|
90
|
+
├── TestLoginFlow.cs # Test case: login scenario (hooks apply automatically via partial class merge)
|
|
91
|
+
├── TestInvoiceCreation.cs # Test case: create invoice scenario
|
|
92
|
+
├── TestInvoiceValidation.cs # Test case: validation rules
|
|
93
|
+
└── TestData.cs # Source file: shared test constants/fixtures
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
## Project Structure Decision Tree
|
|
97
|
+
|
|
98
|
+
**Is it a single, simple task?**
|
|
99
|
+
- ✅ Yes → Single root workflow
|
|
100
|
+
|
|
101
|
+
**Is it a multi-step process?**
|
|
102
|
+
- ✅ Yes → A root workflow that invokes each step + separate workflow files for each step
|
|
103
|
+
|
|
104
|
+
**Does it involve repeated data structures?**
|
|
105
|
+
- ✅ Yes → Extract to Coded Source File (e.g. `Models.cs`, `InvoiceData.cs`)
|
|
106
|
+
|
|
107
|
+
**Is there shared logic across workflows?**
|
|
108
|
+
- ✅ Yes → Extract to a helper Coded Source File
|
|
109
|
+
|
|
110
|
+
**Is it a test project?**
|
|
111
|
+
- ✅ Yes → One test case file per scenario. Coded test projects optionally use `CodedWorkflowHooks.cs` (partial class CodedWorkflow) for shared setup/teardown
|
|
112
|
+
|
|
113
|
+
**Does it have complex business rules?**
|
|
114
|
+
- ✅ Yes → Isolate in Coded Source Files for reusability and testability
|