SUPPORT AND DOCUMENTATION

Getting Started with ITAutomated

Complete the first-run configuration in a controlled order, verify your product entitlement, connect the administration services you use and complete a safe read-only task before enabling live administration.

Applies to 0.25.x Estimated time 10–20 minutes Starting mode Read-only recommended Updated
Step 1

Confirm Identity

Verify the current Windows account, build number and product status.

Step 2

Connect Services

Test Citrix, Active Directory and the optional licensing services.

Step 3

Validate Safely

Run read-only diagnostics and preview workflows before live changes.

Step 4

Begin Administration

Use only the modules approved for your role and delegated access.

Begin in read-only mode

First confirm connectivity, visibility and permissions. Use diagnostics, searches and previews before performing any action that can disconnect a session, modify Active Directory, publish resources or change a machine.

PREPARATION

Before the First Launch

Confirm the application was installed correctly and that you are using the intended administration account.

01

Complete installation

Extract the full Windows x64 package into its approved local application folder. Do not start a new installation from an incremental update package.

View Installation Guide
02

Use the correct account

Sign in with the named Windows account that will normally run ITAutomated. Product licensing and protected settings are tied to the current Windows context and computer.

03

Confirm prerequisites

Install only the Citrix SDKs and Microsoft RSAT components needed by the modules you intend to use.

View System Requirements
04

Start conservatively

Obtain approval for live administration. Complete the first-run checks using read-only queries, diagnostics and previews.

Local administrator rights are not the same as environment permissions

Windows elevation may be needed for local installation or certain tools, while Citrix, Active Directory, DNS and RDS actions still require separately delegated environment permissions.

FIRST RUN

Launch and Verify the Dashboard

Confirm the identity, version and initial product state before configuring services.

1

Start ITAutomated

Open ITAutomated.AdminDashboard.exe from the approved application folder. Keep all files from the complete package together.

2

Confirm the current user

Review the Current user area at the bottom of the left navigation. It must display the account whose environment permissions you intend to use.

3

Confirm the build

Verify that the navigation footer displays the expected product version. The guide currently applies to 0.25.x.

4

Review the licence card

The Overview page shows the current edition, licence state, computer ID and any remaining trial period.

EXPECTED

Dashboard opens normally

The navigation, Overview page and product licence card are visible.

CHECK

Windows security prompt

Confirm the file came from the approved ITAutomated release source before proceeding.

STOP

Missing or blocked files

Do not continue with a partial package. Re-extract the complete verified release.

ORIENTATION

Understand the Dashboard Navigation

Use the role selector to focus on the modules most relevant to your first session.

OverviewLicence state, Citrix connection and environment summary.
Application AccessReview published application visibility and assignments.
LicensesView Citrix and configured RDS licensing information.
Desktop ManagementInspect and manage supported desktop resources.
Desktop PublisherPreview and publish approved desktops or applications.
Session ManagementReview Citrix and RDP sessions; actions require confirmation.
User SessionSearch a user and inspect session, machine, AD and HDX details.
Citrix ManagementRun guided Citrix administration workflows.
AD ManagementUse controlled Active Directory administration and reporting tools.
Engineer ToolsLaunch approved utilities and scripted tools.
DiagnosticsRun read-only health checks and generate documentation.
SettingsConfigure connections, licensing sources and application options.
PRODUCT ACCESS

Confirm the Licence or Pro Trial

Review the entitlement before configuring administration modules.

NEW INSTALLATION

Seven-day Pro trial

A new installation begins with access to Pro features for seven days. The Overview licence card shows the remaining trial period.

STARTER

Perpetual feature access

Activate the signed key issued for the displayed computer ID. Updates and support are not included with Starter.

PRO

Subscription entitlement

Pro includes active product access, eligible updates, new releases and basic support while the subscription remains valid.

1

Copy the displayed computer ID

Use the exact computer ID shown in the product licence card when requesting a Starter or Pro key.

2

Paste the complete signed licence key

Do not edit the key or add spaces. Select Activate licence.

3

Confirm the edition and status

Verify the Overview card reports Starter, Pro or Pro trial as expected.

Licence keys are computer-specific

A key issued for another computer will not activate. Deactivate or request a replacement entitlement before moving the application to a different administration workstation.

CITRIX CONNECTION

Connect and Test Citrix

Load a read-only environment summary before using any Citrix administration workflow.

1

Open Overview

Locate the Citrix connection status card.

2

Sign in

Select Sign in to Citrix when authentication is required.

3

Test connection

Select Test Citrix connection and allow the read-only query to finish.

4

Review results

Confirm SDK mode, site or environment and live resource counts.

SUCCESSFUL CONNECTION

What you should see

  • A green Citrix connection status.
  • The detected SDK mode and site or environment name.
  • Delivery group, machine, application and active-session counts.
  • Registered, unregistered, maintenance and powered-off machine metrics where available.

Install the supported Citrix DaaS Remote PowerShell SDK on the administration workstation. Use the authorised Citrix sign-in flow and confirm that the account has the required delegated roles for the information and actions being requested.

MICROSOFT SERVICES

Prepare Active Directory and DNS

Validate discovery and read access before attempting any directory change.

Required foundation

  • The workstation can resolve the target AD DNS namespace.
  • The computer is domain joined or has approved connectivity to the domain.
  • Windows PowerShell 5.1 is available.
  • The required Active Directory and DNS RSAT modules are installed.
  • The signed-in account has delegated permissions appropriate to the task.

Recommended first validation

  1. Open Diagnostics.
  2. Run the Active Directory and DNS readiness checks.
  3. Open AD Management.
  4. Use a user lookup, directory report or another read-only operation.
  5. Confirm the correct domain objects are returned.
Never test first-run access with a destructive workflow

Do not use computer deletion, DNS cleanup, group deletion or another live change merely to confirm connectivity. Use discovery, lookup, reporting or dry-run functions first.

LICENSING DATA

Add RDS Licence Servers

Configure only the licence servers that the administration workstation is authorised to query.

1

Open Settings

Use the Settings page at the bottom of the left navigation.

2

Add each RDS licence server

Enter the server name or FQDN exactly as it resolves from the administration workstation.

3

Save and refresh

Open Licenses and refresh the RDS licensing data.

4

Validate each server row

Confirm each configured server reports the expected supported RDS licence versions and usage.

Citrix licence consumption is a separate data source

Citrix environment counts from the Broker SDK do not automatically provide Citrix Cloud licence-consumption data. Configure the separate licensing access only when your organisation has approved it.

SAFE VALIDATION

Complete Your First Successful Task

Choose one read-only path and confirm that ITAutomated returns useful, correctly scoped information.

Recommended

Run the Diagnostics dashboard

  1. Open Diagnostics.
  2. Refresh the read-only health checks.
  3. Review SDK, RSAT, AD, DNS and local-host readiness.
  4. Investigate warnings without making changes.

Success means: the report completes and each unavailable component is reported clearly rather than blanking the entire result.

SUPPORTABILITY

Use Logs and Status Messages

Capture the exact version, module, operation and error before changing configuration.

Open logs from Overview

Use the Open logs button when a Citrix connection or dashboard operation fails.

Record the exact context

Note the build number, current user, affected module, selected object and time of the failure.

Protect sensitive data

Review logs and screenshots before sharing them outside the authorised support path.

Do not repeat live failures

Stop repeating a destructive operation. Return to preview, diagnostics and permission validation.

ONBOARDING PROGRESS

Getting Started Checklist

Your progress is stored only in this browser and can be reset at any time.

COMPLETION 0 of 10 complete
0%
CONTINUE LEARNING

Proceed One Module at a Time

Start with read-only visibility and diagnostics. Introduce live administration only after permissions, approval, preview and rollback expectations are understood.

Open Support Centre
Scroll to Top