orchestrator

2020.10

false

Getting started
- Introduction
- Logging in to Orchestrator
- Resetting Your Password
- Robots
  - Robot Statuses
  - Robot Settings
- Activities Feeds
Best practices
- Organization Modeling in Orchestrator
- Managing Large Deployments
- Automation Best Practices
Tenant
- About the Tenant Context
- Robots
- Folders
- About Users
- Roles
  - Default Roles
  - Managing Roles
- Machines
  - Managing Machines
- Packages
- Audit
- Credential Stores
- Webhooks
  - Types of Events
  - Managing Webhooks
- About Licensing
  - Activating Your License
  - Managing Your Licenses
- Alerts
  - Alert Emails
  - Setting Up Alert Emails
- Settings
Actions
- About Actions
- Managing Actions
Folders Context
- About the Folders Context
- Home
  - Overview
Automations
- About Automations
Processes
- About Processes
- Managing Processes
- About Recording
Jobs
- About Jobs
- Managing Jobs
- Job States
Triggers
- About Triggers
- Managing Triggers
- Using Cron Expressions
Logs
- About Logs
- Managing Logs in Orchestrator
- Logging Levels
- Orchestrator Logs
- Protecting Sensitive Information in Studio
Monitoring
- About Monitoring
- Machines
- Processes
- Queues
- Queues SLA
Queues
- About Queues and Transactions
- 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
Storage Buckets
- About Storage Buckets
  - CORS/CSP Configuration
- Managing Storage Buckets
- Moving Bucket Data Between Storage Providers
Test Suite - Orchestrator
- 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
Action Catalogs
- About Action Catalogs
- Managing Action Catalogs
Profile
- About the Profile Page
- Managing Profile Settings
System Administrator
- About System Administrators
- Managing Tenants
- Field Descriptions for the Host Settings Page
- Maintenance Mode
Identity Server
- About Identity Server
- Identity Management Portal
- External Identity Providers
  - Field Descriptions for External Providers Page
- Installation Access Token
Authentication
- Configuring the Active Directory Integration
- Configuring SSO: SAML 2.0
- Configuring SSO: Google
- Configuring SSO: Azure Active Directory
- SmartCard Authentication
- Setting Up Auto Login for Users Under an Active Directory Group
- Configuring the SMTP Server
- Changing the Windows Authentication Protocol
Other Configurations
- Increasing the Size Limit of Package Files
- Opting Out of Telemetry
- Setting up Encryption Key Per Tenant
- GZIP Compression
Integrations
- About Input and Output Arguments
  - Example of Using Input and Output Arguments
Classic Robots
- Robots
- Environments
  - Managing Environments
- Jobs
- Triggers
- Monitoring
  - Robots
- Resources
Troubleshooting
- IE 11.0.9600.17031 Issues
- Frequently Encountered Orchestrator Errors
- Cron Expressions
- Upgrade Issues

OUT OF SUPPORT

Orchestrator User Guide

DELIVERY:

DELIVERY:

Automation Cloud Automation Cloud Public Sector Automation Suite Standalone

Last updated Dec 12, 2023

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 so for large deployments with numerous active schedules and many jobs processing at all times.

Note: Maintenance Mode is only available to the Host tenant, 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?

PREVIOUSField Descriptions for the Host Settings Page

NEXTAbout Identity Server

Support and Services

Get The Help You Need

Learning RPA - Automation Courses

UiPath Community Forum

Trust and Security

© 2005-2024 UiPath. All rights reserved.