@uipath/delegate-sdk 1.203.0 → 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
package/dist/skills/uipath-taskautomation/references/coded-reference/assets/testcase-template.md
ADDED
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
# UiPath Coded Test Cases Templates
|
|
2
|
+
|
|
3
|
+
Ready-to-use templates for UiPath coded test cases files. Replace placeholders in `{{PLACEHOLDER}}` format.
|
|
4
|
+
|
|
5
|
+
> **Using statements:** These templates include only the minimal required usings. Add service-specific usings based on actual usage — see [coding-guidelines.md](../references/coded/coding-guidelines.md) for the full mapping.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Coded Test Case (.cs) — Basic
|
|
10
|
+
|
|
11
|
+
```csharp
|
|
12
|
+
using System;
|
|
13
|
+
using System.Collections.Generic;
|
|
14
|
+
using UiPath.CodedWorkflows;
|
|
15
|
+
// Add service-specific usings as needed — see references/coding-guidelines.md
|
|
16
|
+
|
|
17
|
+
namespace {{PROJECT_NAME}}
|
|
18
|
+
{
|
|
19
|
+
public class {{CLASS_NAME}} : CodedWorkflow
|
|
20
|
+
{
|
|
21
|
+
[TestCase]
|
|
22
|
+
public void Execute()
|
|
23
|
+
{
|
|
24
|
+
// Arrange
|
|
25
|
+
{{ARRANGE}}
|
|
26
|
+
|
|
27
|
+
// Act
|
|
28
|
+
{{ACT}}
|
|
29
|
+
|
|
30
|
+
// Assert
|
|
31
|
+
testing.VerifyExpression({{ASSERTION}});
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Coded Test Case (.cs) — Data-Driven with Default Parameters
|
|
38
|
+
|
|
39
|
+
```csharp
|
|
40
|
+
using System;
|
|
41
|
+
using System.Collections.Generic;
|
|
42
|
+
using UiPath.CodedWorkflows;
|
|
43
|
+
// Add service-specific usings as needed — see references/coding-guidelines.md
|
|
44
|
+
|
|
45
|
+
namespace {{PROJECT_NAME}}
|
|
46
|
+
{
|
|
47
|
+
public class {{CLASS_NAME}} : CodedWorkflow
|
|
48
|
+
{
|
|
49
|
+
[TestCase]
|
|
50
|
+
public void Execute(System.String {{paramName}} = "{{defaultValue}}")
|
|
51
|
+
{
|
|
52
|
+
// Arrange
|
|
53
|
+
{{ARRANGE}}
|
|
54
|
+
|
|
55
|
+
// Act
|
|
56
|
+
{{ACT}}
|
|
57
|
+
|
|
58
|
+
// Assert
|
|
59
|
+
testing.VerifyExpression({{ASSERTION}});
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## Coded Test Case (.cs) — Data-Driven with Test Data Queue
|
|
66
|
+
|
|
67
|
+
```csharp
|
|
68
|
+
using System;
|
|
69
|
+
using System.Collections.Generic;
|
|
70
|
+
using UiPath.CodedWorkflows;
|
|
71
|
+
// Add service-specific usings as needed — see references/coding-guidelines.md
|
|
72
|
+
|
|
73
|
+
namespace {{PROJECT_NAME}}
|
|
74
|
+
{
|
|
75
|
+
public class {{CLASS_NAME}} : CodedWorkflow
|
|
76
|
+
{
|
|
77
|
+
[TestCase]
|
|
78
|
+
public void Execute()
|
|
79
|
+
{
|
|
80
|
+
// Arrange — get test data from queue
|
|
81
|
+
var item = testing.GetTestDataQueueItem("{{QUEUE_NAME}}");
|
|
82
|
+
{{EXTRACT_FIELDS}}
|
|
83
|
+
|
|
84
|
+
// Act
|
|
85
|
+
{{ACT}}
|
|
86
|
+
|
|
87
|
+
// Assert
|
|
88
|
+
testing.VerifyExpression({{ASSERTION}});
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
```
|
|
@@ -0,0 +1,249 @@
|
|
|
1
|
+
# UiPath CLI (`uip`) Reference
|
|
2
|
+
|
|
3
|
+
`uip rpa` and sibling tools (`uip is`, `uip tm`, …) talk to UiPath Studio over named pipes (IPC). This file teaches **how to discover** commands, arguments, and flags — plus the non-obvious behaviors that `--help` won't tell you (auth, headless vs Desktop Studio, how to read run results, error recovery).
|
|
4
|
+
|
|
5
|
+
> **Do not treat any command/flag list here as exhaustive or current.** The CLI is the source of truth and it drifts. Discover the live surface with `--help` (below); this file carries only the HOW that `--help` omits.
|
|
6
|
+
|
|
7
|
+
> **Installation is automatic.** Do NOT install `uip` manually or instruct the user to install it.
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## Discover the live CLI with `--help`
|
|
12
|
+
|
|
13
|
+
The CLI is self-documenting. Append `--help` at **any** level to drill from tools → groups → verbs → parameters. Each level lists the next.
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
uip --help # top-level commands + installed tools (rpa, is, tm, ...)
|
|
17
|
+
uip tools list # installed tools, machine-readable
|
|
18
|
+
uip rpa --help # all rpa command groups and verbs
|
|
19
|
+
uip rpa packages --help # verbs inside a group
|
|
20
|
+
uip rpa validate --help # parameters, accepted values, defaults for one verb
|
|
21
|
+
uip is --help # Integration Service surface
|
|
22
|
+
uip skills --help # skill install/search/update
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
The same pattern works for every tool and depth (`uip rpa uia <verb> --help`, `uip login --help`, etc.). When unsure whether a verb, flag, or accepted value exists, **run `--help` rather than guessing** — guessed flags fail with `unknown command`/`unknown option`.
|
|
26
|
+
|
|
27
|
+
> **Run `--help` standalone — never combine it with other flags.** `uip rpa <verb> --help --project-dir "<path>"` parses `--project-dir`'s value as a positional command and exits with `unknown command '<value>'`. Drop every other flag when probing help.
|
|
28
|
+
|
|
29
|
+
> A verb may be **hidden from `--help`** yet still callable by exact name (e.g. diagnostic or UI-cue verbs). Absence from `--help` means "not part of the standard loop," not "does not exist."
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
## Output format
|
|
34
|
+
|
|
35
|
+
`--output` defaults to **`json`**. Accepted: `json`, `table`, `yaml`, `plain`. Keep `json` for anything parsed programmatically — `table` pads columns and can balloon to 100 KB+.
|
|
36
|
+
|
|
37
|
+
`--output-filter "<JMESPath>"` applies a JMESPath expression to the response envelope's `Data` field — use it to slice large responses instead of post-processing in the shell.
|
|
38
|
+
|
|
39
|
+
`--log-level <debug|info|warn|error>` and `--log-file <path>` are global. Raise log level or add `--verbose` when diagnosing a failure.
|
|
40
|
+
|
|
41
|
+
Most response envelopes share the shape `{Result: "Success"|"Failure", Code, Data, Message?, Instructions?}`. Branch on `Result`, not on stdout text.
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
## Authentication
|
|
46
|
+
|
|
47
|
+
Cloud features (templates/packages from feeds, Integration Service, Data Service entities, publishing) need a logged-in session.
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
uip login # interactive browser login
|
|
51
|
+
uip login status # current session: org, tenant, expiry
|
|
52
|
+
uip login which # which auth source uip resolves for this cwd
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
If a command fails with `not authenticated` / `401` / `403`, run `uip login` and retry. Discover non-interactive/CI login options (credentials folder, client id/secret, authority) via `uip login --help`.
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
## Project context: `--project-dir`
|
|
60
|
+
|
|
61
|
+
Most `uip rpa` verbs identify the project via `--project-dir`, defaulting to the current working directory. When the project is elsewhere, pass the absolute path to the folder containing `project.json`. A few verbs deviate (e.g. `init` takes `--name` + `--location`; `build`/`pack` take the project dir as a positional) — confirm with that verb's `--help`.
|
|
62
|
+
|
|
63
|
+
To create a project, see [environment-setup.md](environment-setup.md); `--target-framework` and `--expression-language` are immutable after creation, so decide them per SKILL.md before running `init`.
|
|
64
|
+
|
|
65
|
+
---
|
|
66
|
+
|
|
67
|
+
## Headless Studio (Helm) vs Studio Desktop
|
|
68
|
+
|
|
69
|
+
`uip rpa` connects to one of two Studio flavors behind the same IPC contract:
|
|
70
|
+
|
|
71
|
+
- **Headless Studio (Helm) — default.** Ships as a NuGet package and auto-launches on first use. **No Studio Desktop install needed.** First call on a cold NuGet cache may sit near-silent for 30–90 s while `dotnet restore` runs — the default shell timeout covers this; raise `timeoutSeconds` only behind a slow feed.
|
|
72
|
+
- **Studio Desktop.** The interactive UI. Used automatically only by verbs with **UI side effects** — those that open a window or highlight something in the designer (discover them via `--help`; they don't work headless). For such a verb, ensure Desktop is up first (`uip rpa studio start --project-dir "<PROJECT_DIR>"`), then run it. Force Desktop for any command with `UIPATH_RPA_TOOL_USE_STUDIO=1` (not recommended for the standard authoring loop).
|
|
73
|
+
|
|
74
|
+
`--studio-dir` is consulted **only when Studio Desktop is in use**; headless ignores it. When Desktop auto-detection fails, resolution falls back to `UIPATH_STUDIO_DIR`, then the default install path, then a dev build output. Errors like `"does not have interop support"` / `"Requires Studio 26.2+"` mean the detected Desktop is too old — tell the user to update it; this affects only the Desktop-only verbs.
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
|
|
78
|
+
## Installed package activity documentation
|
|
79
|
+
|
|
80
|
+
When a package is installed, its activity docs land under `{PROJECT_DIR}/.local/docs/packages/{PackageId}/`. Read these directly — they carry the per-activity property surface and coded API signatures that no `--help` exposes.
|
|
81
|
+
|
|
82
|
+
| Action | How |
|
|
83
|
+
|--------|-----|
|
|
84
|
+
| **Read an activity doc** | `Read` `…/{PackageId}/activities/{ActivityName}.md` — preferred when you know package + class |
|
|
85
|
+
| **Read coded API doc** | `Read` `…/{PackageId}/coded/coded-api.md` — service API signatures for coded workflows |
|
|
86
|
+
| **Read package overview** | `Read` `…/{PackageId}/overview.md` |
|
|
87
|
+
| **List documented packages / activities** | `Bash`: `ls …/.local/docs/packages/` then `ls …/{PackageId}/activities/` |
|
|
88
|
+
| **Search activity docs** | `Glob` `**/*.md` under `…/.local/docs/packages/`, then `Read` matches. **Not `Grep`** — `.local/` is gitignored and `Grep` skips it. |
|
|
89
|
+
|
|
90
|
+
---
|
|
91
|
+
|
|
92
|
+
## Reading run / debug results
|
|
93
|
+
|
|
94
|
+
`uip rpa run` runs a workflow with no debugging; the `debug` group drives breakpoints, stepping, and exception handling (`uip rpa debug --help` — the source skill's `debugging.md` is not part of this extract). **Use `run` for any non-interactive execution, UI automation included.** `debug start` earns its place only when a human is driving the sub-verbs: on an unhandled exception it suspends rather than exits (see `debugState` below), which a caller reading output to end-of-stream can never observe, so an automated `debug start` presents a failed run as a hang. Cancel an active run or session with `uip rpa execution cancel`. Pass workflow inputs as repeatable `--input-arguments key=value` pairs (see [Passing structured inputs](#passing-structured-inputs)); discover the remaining flags (log level, skip-build, profiling) via `--help`.
|
|
95
|
+
|
|
96
|
+
Both `run` and `debug start` return the same payload, but the envelope placement differs by outcome. On success it sits in `Data` as an object with camelCase keys: `{Result: "Success", Code, Data: {output, hasErrors, errorMessage, profiling, debugState, debugDetails}}`. On failure the same object arrives as a **JSON string** in `Message` (`{Result: "Failure", ErrorCode, Message: "<json-string>"}`) — parse it separately. Fields:
|
|
97
|
+
|
|
98
|
+
- `output` — the workflow's own serialized output arguments JSON, populated when the run completes. **Carries the workflow's data, not a verdict.**
|
|
99
|
+
- `hasErrors` — `true` iff execution finished unsuccessfully (compile/validation failure, unhandled exception that ended the run, cancellation, or timeout); `false` otherwise — including while a debug session is `Suspended` on an exception, since the outcome is not decided yet.
|
|
100
|
+
- `errorMessage` — formatted error chain when `hasErrors: true`; on debug responses it may instead carry guidance with `hasErrors: false`; `null` otherwise.
|
|
101
|
+
- `debugState` / `debugDetails` — debug sessions only (`null` on plain `run`). Every debug command returns at the next stable state — `Paused` (activity + locals in `debugDetails`), `Suspended` (exception + locals), `Running` (wait timed out), or `Completed`. Drive the loop off these states; the source skill's `debugging.md` walkthrough is not part of this extract. **A stable state that is not `Completed` leaves the session — and its process — alive**, so a caller that collects output by reading to end-of-stream gets nothing at all rather than a `Suspended` payload. That is why non-interactive execution uses `run`.
|
|
102
|
+
- `profiling.outputDirectory` — the only field `profiling` carries; absolute path to the per-run `.uistat` and `Screenshots/`. No inline per-activity data, and present on failed runs too. It cannot enumerate per-step selector resolution — see `../profiling-output.md`.
|
|
103
|
+
|
|
104
|
+
Workflow log output (`Log Message`, system traces) does **not** appear in the envelope, nor in `--log-file`, nor on stderr. It lands in `%LOCALAPPDATA%\UiPath\Logs\<YYYY-MM-DD>_Execution.log`, one JSON object per line; workflow `Log()` calls carry `logType: "User"` and a `jobId` that correlates them to one run.
|
|
105
|
+
|
|
106
|
+
> **Single source of truth for success/failure of a completed run: outer `Result` (equivalently `hasErrors` in the payload).** `Result: "Success"` already accounts for compile failures, validation failures, and unhandled exceptions — the CLI propagates them. **DO NOT infer failure from a streamed log entry's `Level`.** A successful workflow may emit `Log Message` at `Error`/`Warning` level as observability — that is workflow data, not a CLI failure. Treating log levels as a verdict flips green runs to "failed" and burns retries. In a debug session, check `debugState` before `hasErrors` — `Suspended` means an exception awaits your decision while `hasErrors` is still `false`.
|
|
107
|
+
|
|
108
|
+
---
|
|
109
|
+
|
|
110
|
+
## Passing structured inputs
|
|
111
|
+
|
|
112
|
+
`--input-arguments` and `--input-variables` may be supplied as repeatable `key=value` pairs (`key:=value` for raw JSON, `key=@file` to read a value from a file), as an inline JSON string, or from a JSON file using `'@file'` or `--<flag>-file`. `--packages` takes one item per occurrence as comma-joined fields.
|
|
113
|
+
|
|
114
|
+
```bash
|
|
115
|
+
uip rpa run --file-path Main.cs --input-arguments name=John --input-arguments retries:=3
|
|
116
|
+
uip rpa run --file-path Main.cs --input-arguments 'message=Hello, world!'
|
|
117
|
+
uip rpa debug test-activity --input-variables greeting=@expression.txt
|
|
118
|
+
uip rpa run --file-path Main.cs --input-arguments '@args.json' # or: --input-arguments-file args.json
|
|
119
|
+
uip rpa packages install --packages 'id=UiPath.System.Activities,version=23.10.1' --packages id=UiPath.Excel.Activities
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
Rules:
|
|
123
|
+
|
|
124
|
+
- **`=` vs `:=`**: `count=42` sends the string `"42"`; `count:=42` sends the number `42`. For `debug test-activity` / `debug start-from-here`, values are VB/C# expression **strings** — always `=`.
|
|
125
|
+
- **Quoting**: single-quote any token containing spaces, commas, or a leading `@`; bare identifiers and numbers need no quotes. Values containing double quotes cannot be passed inline on Windows PowerShell 5.1 (it strips them) — write them to a UTF-8 file (`Set-Content -Encoding UTF8`) and use `key=@file`, `'@file'`, or `--<flag>-file`.
|
|
126
|
+
- **Inline JSON**: a single JSON blob (`--input-arguments '{"k":"v"}'`) remains accepted for backward compatibility, but is unreliable on PowerShell 5.1 — prefer pairs or files.
|
|
127
|
+
|
|
128
|
+
---
|
|
129
|
+
|
|
130
|
+
## validate
|
|
131
|
+
|
|
132
|
+
`uip rpa validate` returns diagnostics for a file or the whole project, re-validating first by default (`--skip-validation` reads cached, possibly stale, results; `--min-severity` filters). Confirm flags via `uip rpa validate --help`.
|
|
133
|
+
|
|
134
|
+
> **Known issue: an absolute `--file-path` with an absolute `--project-dir` falsely fails** with `The targeted project file <X> is not in the project folder <Y>`. The CLI normalizes `--file-path` to forward slashes but leaves `--project-dir` with backslashes, then string-compares — same path, different separators. Pass `--file-path` **relative** to the project directory (e.g. `--file-path "Main.cs"`) to sidestep it. For a project-level compile gate without this quirk, use `build`.
|
|
135
|
+
|
|
136
|
+
---
|
|
137
|
+
|
|
138
|
+
## build
|
|
139
|
+
|
|
140
|
+
`uip rpa build` compiles the project — catching runtime-compile failures `validate` misses. Required before returning a project to the user (see [validation-guide.md § Project Build Verification](validation-guide.md#project-build-verification-required-before-returning-a-project)). Takes the project directory as a **positional** argument and runs independently of Studio IPC. Discover flags (log level, skip-analyze, governance, NuGet sources) via `uip rpa build --help`.
|
|
141
|
+
|
|
142
|
+
`run` and `debug start` compile internally, so a successful smoke test implies `build` would pass. When no smoke test runs (side effects, interactive workflow, no test input), `build` is the required compilability check.
|
|
143
|
+
|
|
144
|
+
---
|
|
145
|
+
|
|
146
|
+
## analyzer-rules list
|
|
147
|
+
|
|
148
|
+
`uip rpa analyzer-rules list` reports the Workflow Analyzer rules **enabled** for the project — the best-practice rules `validate` and `build` enforce. Reports rules, not violations. Each rule returns `severity` (`error`/`warning`/`info`), rule ID, scope, title, and (when available) `recommendation` and `docs` URL. Prefix convention: `ST-*` = built-in Studio rule, `MA-*` = package-shipped rule.
|
|
149
|
+
|
|
150
|
+
Rules with scope `Coded Workflow` run as Roslyn analyzers over the project's `.cs` files during `analyze`, `build`, and `pack`. The four built-in ones are all Error severity; triggers and fixes: [coded/coding-guidelines.md § Coded Workflow Analyzer Rules](coded/coding-guidelines.md#coded-workflow-analyzer-rules).
|
|
151
|
+
|
|
152
|
+
> **Performance:** the unscoped call enumerates every rule across every package and can take a minute or more. Narrow with `--scope` (`Activity`, `Workflow`, `Project`, or `Coded Workflow`) — scoped calls return in seconds. See `--help` for accepted scope values.
|
|
153
|
+
|
|
154
|
+
---
|
|
155
|
+
|
|
156
|
+
## packages install
|
|
157
|
+
|
|
158
|
+
`uip rpa packages install` installs or updates NuGet packages (canonical way to add dependencies — **do not hand-edit `project.json`**; there is no `add-dependency` verb). Repeat `--packages` once per package with comma-joined `key=value` fields — `--packages 'id=<PackageId>,version=<Version>'` or just `--packages id=<PackageId>` (see [Passing structured inputs](#passing-structured-inputs)); discover the remaining flags via `uip rpa packages install --help`.
|
|
159
|
+
|
|
160
|
+
- **Omit the version** to resolve the latest compatible automatically (preferred). Pin only for a known compatibility constraint.
|
|
161
|
+
- **Discover available versions** with `uip rpa packages versions --package-id <Id> --include-prerelease`. **Default to `--include-prerelease`** — activity packages frequently ship `-preview` between stable releases, carrying the freshest activity surface and `.local/docs`. When a newer stable or preview exists over the installed version, inform the user and offer the upgrade — never force.
|
|
162
|
+
- **Package not found** → verify the exact ID (use `activities find` or the package's `.local/docs`). **Feed/network error** → check NuGet feed config in Studio settings.
|
|
163
|
+
|
|
164
|
+
---
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
## Commands -- Data Fabric Entities
|
|
168
|
+
|
|
169
|
+
UiPath Data Fabric entities live in the Orchestrator tenant's Data Service. To use them in an RPA project — as typed arguments (`UiPath.DataService.Activities`, test-data bindings) or any generated entity type — they must first be **installed** into the project, which writes a manifest under `.entities/` and compiles a strongly-typed assembly.
|
|
170
|
+
|
|
171
|
+
Typical flow, all under `uip rpa data-fabric-entities` (discover exact flags via `--help`):
|
|
172
|
+
|
|
173
|
+
1. **List** — returns a unified view of entities installed in the project **and** available in the connected tenant, each with an `installed` flag. Run before installing to pick names or verify bindings.
|
|
174
|
+
2. **Install** — applies an add/remove delta to the installed set. Dependency expansion is automatic (adding an entity pulls in everything it references); server-deleted entities are silently dropped. Final selection = `(installed ∪ add) − remove`; an empty result uninstalls everything for that manifest.
|
|
175
|
+
|
|
176
|
+
**Install entities before** invoking any workflow or test case that references their generated types, and before any test-data command that binds to an entity.
|
|
177
|
+
|
|
178
|
+
---
|
|
179
|
+
|
|
180
|
+
## Integration Service (`uip is`)
|
|
181
|
+
|
|
182
|
+
`uip is` manages connectors, connections, resources, triggers, and webhooks. Discover the full surface via `uip is --help`, then drill in (`uip is connections --help`, `uip is resources describe --help`, …). All verbs support `--output json`.
|
|
183
|
+
|
|
184
|
+
The verbs you'll reach for: list/describe **connectors** and their **activities**/**resources**, list/create/ping/edit **connections** (OAuth opens a browser; `--no-browser` prints the URL), and run CRUD **resource** operations. RPA-specific connector workflow patterns (activity/resource discovery, connection management, schema inspection) live in the source skill's `connector-capabilities.md`, not in this extract — use `--help` on the verb instead.
|
|
185
|
+
|
|
186
|
+
---
|
|
187
|
+
|
|
188
|
+
## Test Manager
|
|
189
|
+
|
|
190
|
+
Two distinct surfaces — pick by intent:
|
|
191
|
+
|
|
192
|
+
- **`uip tm` (dedicated tool)** — *runtime* Test Manager operations: browsing manual test cases, runs, results. `uip tm --help`. Do **not** invoke these runtime verbs from `uip rpa`.
|
|
193
|
+
- **`uip rpa tm` (project configuration)** — *authoring/setup*: wire an RPA project to Test Manager by editing its `.tmh/config.json`. Pure file I/O — no Studio or Helm process is needed, so it works with everything closed.
|
|
194
|
+
|
|
195
|
+
### `uip rpa tm` verbs
|
|
196
|
+
|
|
197
|
+
| Verb | Purpose |
|
|
198
|
+
|---|---|
|
|
199
|
+
| `uip rpa tm connect --url <url>` | Set the Test Manager **server URL** (`testManagerBasePath`). Switching to a **different** server (different host/org/tenant) also **clears the default project**, since it belonged to the old server. |
|
|
200
|
+
| `uip rpa tm set-default-project --id <guid> [--name <name>] [--key <key>]` | Link the **default Test Manager project** (`defaultProject`). **Requires a connected server** — run `connect` first or it is rejected. |
|
|
201
|
+
| `uip rpa tm clear-default-project` | Unlink the default project; the server URL is kept. |
|
|
202
|
+
| `uip rpa tm status` | Show the current configuration — server URL and linked default project. |
|
|
203
|
+
|
|
204
|
+
Typical setup flow (all verbs take the standard `--project-dir` and `--output json`):
|
|
205
|
+
|
|
206
|
+
```
|
|
207
|
+
uip rpa tm connect --url "https://cloud.uipath.com/<org>/<tenant>/testmanager_" --project-dir "<PROJECT_DIR>" --output json
|
|
208
|
+
uip rpa tm set-default-project --id <project-guid> --name "<project-name>" --key "<KEY>" --project-dir "<PROJECT_DIR>" --output json
|
|
209
|
+
uip rpa tm status --project-dir "<PROJECT_DIR>" --output json
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
`set-default-project` does **not** call the server to validate the id (there is no server round-trip) — pass a real Test Manager project id (and optional name/key). Listing projects from the server is not available here; obtain the id from Test Manager itself. Confirm exact flags via `uip rpa tm --help`.
|
|
213
|
+
|
|
214
|
+
#### Acting on `reloadHint` in the output
|
|
215
|
+
|
|
216
|
+
A `connect` / `set-default-project` / `clear-default-project` response may include a **`reloadHint`** field. It appears only when the project is currently **open in a Studio older than 26.0.197**, which reads `.tmh/config.json` *only on project open*. When you see it, tell the user to **close and reopen the project in Studio** for the change to take effect — the CLI cannot do this for them. No `reloadHint` means nothing to do: either the project isn't open in Studio, or it's open in Studio 26.0.197+, which applies the change live.
|
|
217
|
+
|
|
218
|
+
---
|
|
219
|
+
|
|
220
|
+
## CLI Error Recovery
|
|
221
|
+
|
|
222
|
+
Diagnose by error category, apply the recovery, retry **once** — do not loop the same failing command.
|
|
223
|
+
|
|
224
|
+
| Error pattern | Cause | Recovery |
|
|
225
|
+
|---------------|-------|----------|
|
|
226
|
+
| `connection refused`, `EPIPE`, `pipe not found` | Studio IPC unavailable. Headless: NuGet restore failed or process exited. Desktop: not running. | Re-run — headless relaunches automatically. If persistent, raise `--timeout` and check Helm restore output for NuGet errors. Run `uip rpa studio start` only for Desktop-only verbs or when `UIPATH_RPA_TOOL_USE_STUDIO=1`. |
|
|
227
|
+
| `timeout`, `ETIMEDOUT` | Cold Helm NuGet restore (30–90 s) or long operation. | Raise both limits together: shell `timeoutSeconds` toward its documented max, and `uip rpa --timeout <timeoutSeconds − 30> <command>` — the shell timeout must exceed `--timeout` by ≥ 30 s or the shell kills the CLI before it can cancel cleanly. For `validate`, also try `--skip-validation`. |
|
|
228
|
+
| `not authenticated`, `401`, `403` | Auth required for cloud features. | `uip login`, then retry. |
|
|
229
|
+
| `package not found`, `version not available` | Wrong package ID or version. | Verify via `uip rpa activities find`; omit `version` to auto-resolve latest. |
|
|
230
|
+
| `project not found`, `no project open` | Wrong `--project-dir` or project not open. | Verify the path points at the `project.json` folder. |
|
|
231
|
+
| `not in the project folder` (in `validate`) | Absolute `--file-path` + separator mismatch. | Pass `--file-path` relative to the project root (see [validate](#validate)). |
|
|
232
|
+
| `Studio is busy`, `operation in progress` | Studio processing a prior request. | Wait a few seconds, retry. |
|
|
233
|
+
| Unrecognized error | Unknown | Re-run with `--verbose` for debug detail, then inform the user. |
|
|
234
|
+
|
|
235
|
+
---
|
|
236
|
+
|
|
237
|
+
## RPA discovery tools (non-CLI)
|
|
238
|
+
|
|
239
|
+
| Action | How |
|
|
240
|
+
|--------|-----|
|
|
241
|
+
| **Get JIT type definitions** | `Read` `{PROJECT_DIR}/.project/JitCustomTypesSchema.json` |
|
|
242
|
+
| **Activity docs** | See [Installed package activity documentation](#installed-package-activity-documentation) above |
|
|
243
|
+
| **Inspect a NuGet package's API** | `uip rpa packages inspect` — see [coded/inspect-package-guide.md](coded/inspect-package-guide.md) |
|
|
244
|
+
|
|
245
|
+
---
|
|
246
|
+
|
|
247
|
+
## UI Automation (`uip rpa uia ...`)
|
|
248
|
+
|
|
249
|
+
`uip rpa uia --help` deliberately exposes no standard subcommands — the UIA CLI surface is owned and co-versioned by the `UiPath.UIAutomation.Activities` package. Subcommands, flags, accepted values, and artifact filenames live in `{PROJECT_DIR}/.local/docs/packages/UiPath.UIAutomation.Activities/references/cli-reference.md`. Read that file rather than improvising from `--help`.
|
|
@@ -0,0 +1,275 @@
|
|
|
1
|
+
# CodedWorkflow Base Class Reference
|
|
2
|
+
|
|
3
|
+
All workflow and test case files inherit from `CodedWorkflow`, which provides built-in methods and service access. The `CodedWorkflow` class is a **partial class** — you can extend it in a Coded Source File (see "Extending CodedWorkflow with Before/After Hooks" below).
|
|
4
|
+
|
|
5
|
+
## Built-in Methods (available in any workflow/test case via `this`)
|
|
6
|
+
|
|
7
|
+
| Method | Description |
|
|
8
|
+
|--------|-------------|
|
|
9
|
+
| `Log(string message, LogLevel level = LogLevel.Info, IDictionary<string, object> additionalLogFields = null)` | Output log messages with optional level and custom fields. Valid `LogLevel` values: `Trace`, `Verbose`, `Info`, `Warn`, `Error`, `Fatal`. Note: `LogLevel.Warning` does not exist — use `LogLevel.Warn` |
|
|
10
|
+
| `Delay(TimeSpan time)` / `Delay(int delayMs)` | Pause execution synchronously |
|
|
11
|
+
| `DelayAsync(TimeSpan time)` / `DelayAsync(int delayMs)` | Pause execution asynchronously |
|
|
12
|
+
| `BuildClient(string scope = "Orchestrator", bool force = true)` | Build an authenticated `HttpClient` for Orchestrator or custom scopes |
|
|
13
|
+
| `GetRunningJobInformation()` | Returns `IRunningJobInformation` with current job context: job ID, process name/version, tenant, folder, organization, robot name, and more (see [IRunningJobInformation](#irunningjobinformation-properties) below) |
|
|
14
|
+
| `RunWorkflow(string workflowFilePath, IDictionary<string, object> inputArguments = null, TimeSpan? timeout = null, bool isolated = false, InvokeTargetSession targetSession = InvokeTargetSession.Current)` | **Fallback method:** Invoke workflow by string path. Use `workflows.MyWorkflow()` instead when possible |
|
|
15
|
+
| `RunWorkflowAsync(...)` | Async version of `RunWorkflow` (same limitations apply) |
|
|
16
|
+
|
|
17
|
+
## Invoking Other Workflows
|
|
18
|
+
|
|
19
|
+
**Recommended:** Use the strongly-typed `workflows` property to invoke other workflows in your project:
|
|
20
|
+
|
|
21
|
+
```csharp
|
|
22
|
+
// Invoke workflow with strongly-typed parameters
|
|
23
|
+
var result = workflows.ProcessInvoice(invoiceId: "INV-001", amount: 1500.00m);
|
|
24
|
+
Log($"Processing completed: {result.success}");
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
**Benefits of `workflows.MyWorkflow()`:**
|
|
28
|
+
- **Type-safe:** Compile-time checking of workflow names and parameters
|
|
29
|
+
- **IntelliSense:** Auto-completion for workflow names and parameters
|
|
30
|
+
- **Refactor-friendly:** Renaming workflows/parameters updates all references
|
|
31
|
+
- **Dynamic updates:** Automatically adapts when workflows change
|
|
32
|
+
|
|
33
|
+
**Default parameters:** Workflows with default parameter values can be invoked with or without those arguments — omitted parameters use their defaults:
|
|
34
|
+
```csharp
|
|
35
|
+
// If ProcessData has: Execute(string source, int maxRows = 100, bool verbose = false)
|
|
36
|
+
workflows.ProcessData(source: "invoices.csv"); // maxRows=100, verbose=false
|
|
37
|
+
workflows.ProcessData(source: "invoices.csv", maxRows: 500); // verbose=false
|
|
38
|
+
workflows.ProcessData(source: "invoices.csv", maxRows: 500, verbose: true); // all explicit
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
**Fallback (string-based):** For dynamic scenarios where workflow name isn't known at compile time:
|
|
42
|
+
|
|
43
|
+
```csharp
|
|
44
|
+
// Only use when workflow name is determined at runtime
|
|
45
|
+
string workflowPath = GetWorkflowPathFromConfig();
|
|
46
|
+
var result = RunWorkflow(workflowPath, new Dictionary<string, object>
|
|
47
|
+
{
|
|
48
|
+
{ "invoiceId", "INV-001" },
|
|
49
|
+
{ "amount", 1500.00m }
|
|
50
|
+
});
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
> **Return value:** `RunWorkflow` returns `IDictionary<string, object>`. Argument direction is determined by the `Execute` method signature:
|
|
54
|
+
>
|
|
55
|
+
> - **Single return value** (`public string Execute(int a, int b)`) — the result is stored under the key `"Output"`. Access it as `result["Output"]`.
|
|
56
|
+
> - **Multiple outputs via tuple** (`public (string a, string b) Execute()`) — each tuple member becomes a separate key: `result["a"]`, `result["b"]`. These are Out arguments.
|
|
57
|
+
> - **InOut arguments** — when a parameter name appears in both the input parameters and the return tuple, it is an InOut argument. Example: `public (string a, string b) Execute(string b, int c)` — `a` is Out, `b` is InOut (same name in input and output), `c` is In. The input and output types of an InOut argument must be identical — a mismatch fails analyzer rule ST-REL-001 (Error) at `analyze`/`build`/`pack`.
|
|
58
|
+
>
|
|
59
|
+
> For same-project workflows, prefer the type-safe `workflows.MyWorkflow()` property — it returns the declared return type directly and avoids this dictionary lookup.
|
|
60
|
+
|
|
61
|
+
## Service Properties (injected based on installed packages)
|
|
62
|
+
|
|
63
|
+
Services are accessed as properties on `this`: `system.GetAsset(...)`, `excel.ReadRange(...)`, `testing.VerifyExpression(...)`, etc. See the Service-to-Package mapping in SKILL.md.
|
|
64
|
+
|
|
65
|
+
## Integration Service Connections
|
|
66
|
+
|
|
67
|
+
> **Two IS connection patterns exist in coded workflows.** This section covers first-party package connections (Office365, GSuite) where Studio auto-generates `ConnectionsManager.cs` / `ConnectionsFactory.cs`. For raw IS connectors (Jira, Salesforce, custom) that use `CodedConnectorConfiguration` + agent-generated `ISConnections.cs`, see [integration-service-guide.md](integration-service-guide.md).
|
|
68
|
+
|
|
69
|
+
When packages that use Integration Service connections are installed (e.g. `UiPath.MicrosoftOffice365.Activities`, `UiPath.GSuite.Activities`), Studio auto-generates two files in `.codedworkflows/`:
|
|
70
|
+
|
|
71
|
+
- **`ConnectionsManager.cs`** — Exposes a typed property for each connection category (e.g. `O365Mail`, `Excel`, `OneDrive`, `Gmail`, etc.)
|
|
72
|
+
- **`ConnectionsFactory.cs`** — Contains factory classes with typed properties for each configured connection instance
|
|
73
|
+
|
|
74
|
+
These are injected via the `connections` property on `CodedWorkflow`.
|
|
75
|
+
|
|
76
|
+
### How It Works
|
|
77
|
+
|
|
78
|
+
1. **Configure connections** in UiPath Automation Cloud → Integration Service
|
|
79
|
+
2. **Studio detects them** and generates typed accessors in `.codedworkflows/`
|
|
80
|
+
3. **Access in code** via `connections.<FactoryName>.<ConnectionName>`
|
|
81
|
+
|
|
82
|
+
### Example: ConnectionsManager.cs (auto-generated)
|
|
83
|
+
|
|
84
|
+
```csharp
|
|
85
|
+
public class ConnectionsManager
|
|
86
|
+
{
|
|
87
|
+
public ExcelFactory Excel { get; set; }
|
|
88
|
+
public O365MailFactory O365Mail { get; set; }
|
|
89
|
+
public OneDriveFactory OneDrive { get; set; }
|
|
90
|
+
|
|
91
|
+
public ConnectionsManager(ICodedWorkflowsServiceContainer resolver)
|
|
92
|
+
{
|
|
93
|
+
Excel = new ExcelFactory(resolver);
|
|
94
|
+
O365Mail = new O365MailFactory(resolver);
|
|
95
|
+
OneDrive = new OneDriveFactory(resolver);
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### Example: ConnectionsFactory.cs (auto-generated)
|
|
101
|
+
|
|
102
|
+
```csharp
|
|
103
|
+
public class O365MailFactory
|
|
104
|
+
{
|
|
105
|
+
// Connection name derived from Integration Service display name
|
|
106
|
+
public MailConnection My_Workspace_user_company_com { get; set; }
|
|
107
|
+
|
|
108
|
+
public O365MailFactory(ICodedWorkflowsServiceContainer resolver)
|
|
109
|
+
{
|
|
110
|
+
My_Workspace_user_company_com = new MailConnection("9e26a554-...", resolver);
|
|
111
|
+
}
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
public class OneDriveFactory
|
|
115
|
+
{
|
|
116
|
+
public OneDriveConnection Shared_tenant_onmicrosoft_com { get; set; }
|
|
117
|
+
|
|
118
|
+
public OneDriveFactory(ICodedWorkflowsServiceContainer resolver)
|
|
119
|
+
{
|
|
120
|
+
Shared_tenant_onmicrosoft_com = new OneDriveConnection("22530bcf-...", resolver);
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
### Usage Pattern
|
|
126
|
+
|
|
127
|
+
```csharp
|
|
128
|
+
// Step 1: Get the connection from the auto-generated factory
|
|
129
|
+
var mailConnection = connections.O365Mail.My_Workspace_user_company_com;
|
|
130
|
+
|
|
131
|
+
// Step 2: Get a sub-service from the connection-based service
|
|
132
|
+
var mailService = office365.Mail(mailConnection);
|
|
133
|
+
|
|
134
|
+
// Step 3: Call methods on the sub-service
|
|
135
|
+
mailService.SendEmail("recipient@example.com", "Subject", "Body");
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
### Connection Types by Package
|
|
139
|
+
|
|
140
|
+
| Package | Connection Class | Factory Name | Used By |
|
|
141
|
+
|---------|-----------------|--------------|---------|
|
|
142
|
+
| `UiPath.MicrosoftOffice365.Activities` | `MailConnection` | `O365Mail` | `office365.Mail()`, `office365.Calendar()` |
|
|
143
|
+
| `UiPath.MicrosoftOffice365.Activities` | `ExcelConnection` | `Excel` | `office365.Excel()` |
|
|
144
|
+
| `UiPath.MicrosoftOffice365.Activities` | `OneDriveConnection` | `OneDrive` | `office365.OneDrive()`, `office365.Sharepoint()` |
|
|
145
|
+
| `UiPath.GSuite.Activities` | `GmailConnection` | `Gmail` | `google.Gmail()`, `google.Calendar()` |
|
|
146
|
+
| `UiPath.GSuite.Activities` | `DriveConnection` | `GoogleDrive` | `google.Drive()` |
|
|
147
|
+
| `UiPath.GSuite.Activities` | `SheetsConnection` | `GoogleSheets` | `google.Sheets()` |
|
|
148
|
+
| `UiPath.GSuite.Activities` | `DocsConnection` | `GoogleDocs` | `google.Docs()` |
|
|
149
|
+
|
|
150
|
+
### Important Notes
|
|
151
|
+
|
|
152
|
+
- Connection names in the factory are sanitized versions of the Integration Service display name (spaces/special chars replaced with `_`)
|
|
153
|
+
- The connection ID (GUID) is embedded in the factory — it references the specific Integration Service connection
|
|
154
|
+
- If a connection is **not authorized** or the token is expired, you get `ConnectionHttpException: Connection [...] failed to authorize` at runtime — re-authorize in Automation Cloud → Integration Service
|
|
155
|
+
- The `connections` property is always available on `CodedWorkflow` regardless of installed packages, but the factory properties (`.O365Mail`, `.OneDrive`, etc.) only exist when the corresponding package is installed and connections are configured
|
|
156
|
+
|
|
157
|
+
## The `workflows` Property (Strongly-Typed Workflow Invocation)
|
|
158
|
+
|
|
159
|
+
The `workflows` property provides strongly-typed access to all workflows in your project:
|
|
160
|
+
|
|
161
|
+
```csharp
|
|
162
|
+
// Invoke workflows with IntelliSense and compile-time checking
|
|
163
|
+
var result1 = workflows.ReadInvoices(folderPath: "/data/invoices");
|
|
164
|
+
var result2 = workflows.ValidateInvoices(invoices: result1.invoiceList);
|
|
165
|
+
var result3 = workflows.PostToERP(validInvoices: result2.validInvoices);
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
Each workflow in your project becomes a method on the `workflows` object with parameters matching the workflow's input arguments and return values matching output arguments. This is the **recommended approach** for invoking workflows.
|
|
169
|
+
|
|
170
|
+
## The `services` Property
|
|
171
|
+
|
|
172
|
+
The `services` property provides access to:
|
|
173
|
+
- `services.Container` — dependency injection container for resolving custom services
|
|
174
|
+
- `OrchestratorClientService` (via `BuildClient`) — Orchestrator API interaction
|
|
175
|
+
- `WorkflowInvocationService` (via `RunWorkflow`) — fallback for dynamic workflow invocation
|
|
176
|
+
- `OutputLoggerService` (via `Log`) — logging
|
|
177
|
+
|
|
178
|
+
## IRunningJobInformation Properties
|
|
179
|
+
|
|
180
|
+
`GetRunningJobInformation()` returns an `IRunningJobInformation` instance (from `UiPath.Robot.Activities.Api`). Key properties:
|
|
181
|
+
|
|
182
|
+
| Property | Type | Description |
|
|
183
|
+
|----------|------|-------------|
|
|
184
|
+
| `JobId` | `Guid` | Current job identifier |
|
|
185
|
+
| `ProcessName` | `string` | Running process name |
|
|
186
|
+
| `ProcessVersion` | `string` | Running process version |
|
|
187
|
+
| `OrganizationId` | `string` | Organization identifier |
|
|
188
|
+
| `TenantId` | `string` | Tenant identifier |
|
|
189
|
+
| `TenantName` | `string` | Tenant display name |
|
|
190
|
+
| `FolderId` | `long?` | Orchestrator folder numeric ID |
|
|
191
|
+
| `FolderName` | `string` | Orchestrator folder display name |
|
|
192
|
+
| `FolderKey` | `Guid` | Orchestrator folder GUID key |
|
|
193
|
+
| `RobotName` | `string` | Executing robot name |
|
|
194
|
+
| `UserEmail` | `string` | Logged-in user's email |
|
|
195
|
+
| `InitiatedBy` | `string` | What started the job (`"Orchestrator"`, `"Studio"`, `"Assistant"`, etc.) |
|
|
196
|
+
|
|
197
|
+
### Usage Example
|
|
198
|
+
|
|
199
|
+
```csharp
|
|
200
|
+
var jobInfo = GetRunningJobInformation();
|
|
201
|
+
Log($"Org: {jobInfo.OrganizationId}, Tenant: {jobInfo.TenantName}, Folder: {jobInfo.FolderName}");
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
## Before/After Hooks (IBeforeAfterRun)
|
|
205
|
+
|
|
206
|
+
Any class inheriting from `CodedWorkflow` can implement `IBeforeAfterRun` to add setup/teardown logic. Two approaches:
|
|
207
|
+
|
|
208
|
+
**Per-file:** Implement directly on a workflow or test case — hooks run only for that file:
|
|
209
|
+
```csharp
|
|
210
|
+
public class TestLoginFlow : CodedWorkflow, IBeforeAfterRun
|
|
211
|
+
{
|
|
212
|
+
public void Before(BeforeRunContext context) { Log("Starting " + context.RelativeFilePath); }
|
|
213
|
+
public void After(AfterRunContext context) { Log("Finished " + context.RelativeFilePath); }
|
|
214
|
+
|
|
215
|
+
[TestCase]
|
|
216
|
+
public void Execute() { /* Before() already ran, After() runs after */ }
|
|
217
|
+
}
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
**Project-wide:** Use a `partial class CodedWorkflow` — hooks apply to every workflow and test case:
|
|
221
|
+
```csharp
|
|
222
|
+
// CodedWorkflowHooks.cs — Coded Source File (no entry point)
|
|
223
|
+
using UiPath.CodedWorkflows;
|
|
224
|
+
|
|
225
|
+
namespace MyProject
|
|
226
|
+
{
|
|
227
|
+
public partial class CodedWorkflow : IBeforeAfterRun
|
|
228
|
+
{
|
|
229
|
+
public void Before(BeforeRunContext context) { Log("Starting " + context.RelativeFilePath); }
|
|
230
|
+
public void After(AfterRunContext context) { Log("Finished " + context.RelativeFilePath); }
|
|
231
|
+
}
|
|
232
|
+
}
|
|
233
|
+
```
|
|
234
|
+
|
|
235
|
+
## Extending CodedWorkflow with Partial Classes
|
|
236
|
+
|
|
237
|
+
The auto-generated `CodedWorkflow` is a `partial class`. You can extend it to add shared methods, properties, or constants available to all workflows and test cases — with or without hooks:
|
|
238
|
+
|
|
239
|
+
```csharp
|
|
240
|
+
// CodedWorkflowExtensions.cs — Coded Source File (no entry point)
|
|
241
|
+
using UiPath.CodedWorkflows;
|
|
242
|
+
|
|
243
|
+
namespace MyProject
|
|
244
|
+
{
|
|
245
|
+
public partial class CodedWorkflow
|
|
246
|
+
{
|
|
247
|
+
protected string GetEnvironmentUrl()
|
|
248
|
+
{
|
|
249
|
+
var env = system.GetAsset("Environment").ToString();
|
|
250
|
+
return env == "prod" ? "https://app.example.com" : "https://staging.example.com";
|
|
251
|
+
}
|
|
252
|
+
}
|
|
253
|
+
}
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
### Key Points
|
|
257
|
+
|
|
258
|
+
- **`IBeforeAfterRun`** is an interface — any `CodedWorkflow`-derived class can implement it
|
|
259
|
+
- **`partial class CodedWorkflow`** is a C# feature — extends the auto-generated class for all files in the project
|
|
260
|
+
- **They combine:** use `partial class CodedWorkflow : IBeforeAfterRun` when you want hooks on every file
|
|
261
|
+
- **Use `IBeforeAfterRun` on individual files** when only specific workflows/test cases need setup/teardown
|
|
262
|
+
- **Use `partial class CodedWorkflow`** (without hooks) to add shared methods, properties, or constants
|
|
263
|
+
- **Context objects** (`BeforeRunContext`, `AfterRunContext`) provide `RelativeFilePath`, `WorkflowFilePath`, etc.
|
|
264
|
+
- **After() runs even on failure** — guaranteed cleanup
|
|
265
|
+
|
|
266
|
+
### When to Use Which
|
|
267
|
+
|
|
268
|
+
| Scenario | Pattern |
|
|
269
|
+
|----------|---------|
|
|
270
|
+
| One test case needs its own setup/teardown | `IBeforeAfterRun` on the class |
|
|
271
|
+
| All test cases share the same setup/teardown | `partial class CodedWorkflow : IBeforeAfterRun` |
|
|
272
|
+
| Shared helper methods for all workflows | `partial class CodedWorkflow` (no hooks) |
|
|
273
|
+
| All of the above | Combine patterns in one or more partial files |
|
|
274
|
+
|
|
275
|
+
Code templates: [assets/before-after-hooks-template.md](../../assets/before-after-hooks-template.md)
|