orchestrator

2024.10

true

Getting started
- Introduction
- User options
- Logging in to Orchestrator
- Resetting your password
- Robots
  - Robot Statuses
  - Robot Settings
- Auto Updating Client Components
- Orchestrator Configuration Checklist
Best practices
- Organization Modeling in Orchestrator
- Managing Large Deployments
- Automation Best Practices
- Optimizing Unattended Infrastructure Using Machine Templates
- Unattended automation
- Organizing Resources With Tags
- Orchestrator Read-only Replica
- Exporting grids in the background
Tenant
- About the Tenant Context
- Searching for Resources in a Tenant
- Robots
- Folders
- Monitoring
- Access control
- Configuring automation capabilities
- Machines
- Packages
- Audit
- Credential Stores
  - Managing credential stores
  - Integrating credential stores
- Webhooks
  - Types of Events
  - Managing Webhooks
- Licensing
  - Managing Your Licenses
- Alerts
- Settings - Tenant Level
Resource Catalog Service
- About Resource Catalog Service
Folders Context
- About the Folders Context
- Home
Automations
- About Automations
Processes
- About Processes
- Managing Processes
- Managing Package Requirements
- Recording
Jobs
- About Jobs
- Managing Jobs
- Job States
- Working with long-running workflows
- Running Personal Remote Automations
- Process Data Retention Policy
Triggers
- About triggers
  - Time triggers
  - Queue triggers
- Managing triggers
  - Creating a time trigger
  - Creating a queue trigger
- Managing Non-Working Days
- Using Cron Expressions
  - Triggering jobs on the last day of the month
Logs
- About Logs
- Managing Logs in Orchestrator
- Logging Levels
- Orchestrator Logs
Monitoring
- About Monitoring
- Machines
- Processes
- Queues
- Queues SLA
Queues
- About Queues and Transactions
- Bulk uploading Queue Items using a CSV file
- Managing Queues in Orchestrator
- Managing Queues in Studio
- Managing Transactions
  - Editing Transactions
  - Field Descriptions for the Transactions .csv File
- Review Requests
Assets
- About Assets
- Managing Assets in Orchestrator
- Managing Assets in Studio
- Storing Assets in Azure Key Vault (read only)
- Storing Assets in HashiCorp Vault (read only)
- Storing Assets in AWS Secrets Manager (read only)
Storage Buckets
- About Storage Buckets
  - CORS/CSP Configuration
- Managing Storage Buckets
- Moving Bucket Data Between Storage Providers
Test Suite - Orchestrator
- Test Automation
- Test Cases
  - Field Descriptions for the Test Cases Page
- Test Sets
  - Field Descriptions for the Test Sets Page
- Test Executions
  - Field Descriptions for the Test Executions Page
- Test Schedules
  - Field Descriptions for the Test Schedules Page
- Test Data Queues
- Testing Data Retention Policy
Other Configurations
- Increasing the Size Limit of Package Files
- Setting up Encryption Key Per Tenant
- GZIP Compression
Integrations
- About Input and Output Arguments
  - Example of Using Input and Output Arguments
Host administration
- About the host level
- Managing system administrators
- Managing tenants
- Configuring host authentication settings
- Managing your host license
  - Allocating Licenses to Tenants
- Configuring system email notifications
- Configuring other host settings
- Audit logs for the host portal
- Maintenance Mode
Organization administration
- About organizations
- Managing organization administrators
- Managing organization settings
- Configuring organization authentication
- Configuring organization security
  - Session policy
  - Restricting access to a set of users
- About licensing
  - Activating your license
- Accounts and groups
  - Managing access
  - Managing accounts and groups
- Authorizing external applications
  - Managing external OAuth applications
  - Configuring fine-grained access for confidential apps
- Managing tags
- Overriding system email settings
  - Email setup
    - System emails are not sent - SslHandshakeException
- Audit logs
Troubleshooting
- About Troubleshooting
- Frequently Encountered Orchestrator Errors
- Browser group policies
- Cron Expressions

Orchestrator User Guide

DELIVERY:

DELIVERY:

Automation Cloud Automation Cloud Public Sector Automation Suite Standalone

Last updated Nov 13, 2024

Maintenance Mode

Maintenance Mode provides a simplified and pain-free solution for stopping all Orchestrator activity and shutting down IIS when needed, such as undertaking maintenance or upgrading your Orchestrator instance. This is useful for all installations, but especially for large deployments with numerous active schedules and many jobs processing at all times.

Note: Maintenance Mode is only available to the host organization, and is accessible only via Orchestrator's API. For details, see the Orchestrator API Reference.

To use Maintenance Mode:

Enable Pending Maintenance mode using the /api/Maintenance/Start call and selecting Draining as the phase parameter. During this time:
- Robot communication with Orchestrator is still active (i.e. logs are uploaded, queue items are added);
- No new jobs can be created;
- A Stop command is sent to all running jobs;
- All schedules are paused;
- The Orchestrator interface is unavailable to everyone during maintenance.
  
  Note: If any jobs do not complete, or are too lengthy to wait, you have the ability to send a Kill command for all remaining jobs using the killJobs parameter.
When all running jobs have stopped, enable Maintenance Mode using the /api/Maintenance/Start call and selecting Suspended as the phase parameter. During this time all Robot to Orchestrator communication is stopped.
You can now shut down IIS and proceed with any maintenance or update actions needed. Maintenance Mode will persist through any stop, restart, or upgrade operation until manually switched off.
Restart IIS and Orchestrator when all maintenance actions have been completed. Turn off Maintenance Mode using the /api/Maintenance/End endpoint. As outcomes:
- All job executions scheduled to run during the maintenance mode are skipped;
- A maintenance log is created for each tenant. The log summarizes all stopped/killed jobs and skipped trigger executions.
  
  Note: This log is only accessible at the tenant level using the api/Maintenance/Get call and contains only those job and schedule details specific to that tenant.

Was this page helpful?

PREVIOUSAudit logs for the host portal

NEXTAbout organizations

Support and Services

Get The Help You Need

Learning RPA - Automation Courses

UiPath Community Forum

Trust and Security

© 2005-2024 UiPath. All rights reserved.