Use the VeloPhex Assistant

Sign in to the VeloPhex Assistant, find and run attended automations, stop or kill jobs, and manage favourites, preferences and support bundles.

The VeloPhex Assistant is the desktop app for attended automation: see what you may run, run it on your own desktop, and see that it ran. It talks to the Robot service on the same machine and, when you sign in, to the Orchestrator as you. The Assistant is installed with the Attended and Developer profiles, and with Unattended unless it was unticked. See Install the Robot. Open the Assistant# Open VeloPhex Assistant from the Start menu. It runs without administrator rights. Wait for Starting VeloPhex Assistant… to finish. If the Robot service is stopped, the Assistant starts it. Read the three conditions in the title bar: Condition Healthy Needs attention Account Signed in as your name and tenant Not signed in, Session expired Robot Robot running, Robot running an automation Robot stopped, Robot faulted Orchestrator Orchestrator reachable Connecting, Orchestrator unreachable, Not connected, Enrolment refused When something needs attention, one line at the bottom of the sidebar says what to do next. If the Assistant shows The VeloPhex Robot service isn't reachable, select Retry, or Continue to open the Assistant while it keeps checking. If it offers Repair the installation, select it and approve the Windows prompt. Sign in# Signing in makes the list yours: the automations you may see, marked with the ones you may start, and every run is recorded as started by you. Studio and the Assistant share one sign-in for your Windows account on this machine, so signing in or out of one does the same in the other. Select Preferences. Under Sign in, check the Orchestrator address, such as https://orchestrator.example.com. On an enrolled machine it is fixed to the machine's Orchestrator. Select Sign in. Your browser opens the Orchestrator's approval page, and the Assistant shows a code with Waiting for approval in your browser…. Approve the sign-in in the browser. If the browser did not open, select Open browser again. Wait for Signed in as your name and tenant, then select the back arrow (Back to automations). To switch tenants, choose one in Tenant at the top of the sidebar. When an administrator connected the machine, the tenant is the machine's and cannot be changed here. To sign out, open Preferences and select Sign out. If jobs are running under your personal robot, the Assistant asks first, because signing out stops them. Personal robotIf no administrator has connected this machine, signing in connects it as your personal robot: it runs only the jobs you start here, in your session, and ends when you sign out. Your organization can turn this off, in which case the Assistant shows Your organization requires an administrator to connect this machine. If another person's personal robot holds the machine, you see Machine in use. Do I have to sign in?# That depends on the tenant's Attended sign-in setting in the Orchestrator: Setting What you see Machine or signed-in (default) Signed out, the list is the machine's and starts use the machine's identity. Signed in, you start as yourself. Signed-in only Nothing is listed or started until you sign in. Machine only Starts always use the machine's identity, and signing in changes nothing for attended runs. Find an automation# In the sidebar under Automations, type in Search to filter the list. Select Refresh (the circular arrow) to read the list again. The Assistant also refreshes it when the Robot reconnects. Select an automation to open it. The list shows at most 500 automations per machine (Showing the first 500); search covers only those. An automation you cannot start here stays in the list with a lock icon. Hover over the icon, or open the automation, to see why under Can't start here: you lack Start Jobs in its workspace, the machine is not connected, or the machine lacks a runtime the automation needs. Add favourites# Select the star at the end of an automation's row (Add to favourites). To remove it, select the star again (Remove from favourites). Favourites are listed first. They are kept for each Orchestrator and tenant. Run an automation# Select the automation. The Details tab shows its Entry point, Version, Runtime and Package. Check the line under Run: Runs as you on this machine. Select Run. If the automation takes inputs, fill in the Run dialog and select Run. Hints under each field say what it expects, such as A whole number or One item per line. Watch the sidebar footer: it shows Started and the automation's name, and An automation is running while it runs. The automation runs as you, on your desktop, in your Windows session. Keep the session signed in and unlocked while it runs. The Assistant remembers the inputs you typed for the next run, except protected values such as passwords (Not remembered after the run.). If the Orchestrator refuses the inputs, the Assistant shows These inputs were not accepted with the reason; select Change inputs to correct them. Check jobs and history# Open the automation. Select Jobs to see its running jobs, or History to see its past runs on this machine. Read each row: the outcome, the local time, the failure summary if it failed, and the status, duration and entry point. To share a row, select Copy details. It copies the full row with the job id. If the Robot finished a job while the Orchestrator was unreachable, a bar says 1 result is waiting to be delivered (or more). The Robot delivers them when the Orchestrator is reachable again. For the full job log, open the job in the Orchestrator. See Jobs. Stop or kill a job# Open the automation and select Jobs. On the running job, select Stop. The job is asked to end cleanly, and its row shows Stopping…. If it does not end, select Kill. Kill ends it at once, without letting it clean up, and the row shows Terminating… until it ends. Stop Kill What it does Asks the automation to end, and gives it time to run its clean-up Ends the process tree at once Use it First, always Only when Stop does not end the job You can stop your own job that runs on another machine too, while you are signed in. If the stop is refused, the reason shows above the Jobs list. Keep the Assistant in the notification area# By default, closing the window keeps the Assistant running in the notification area, and the first time you see VeloPhex Assistant is still running. Select the VeloPhex icon in the notification area to open the Assistant. Hover over it to see the Robot's status. Right-click it for Open Assistant, Preferences and Exit. To close the Assistant fully when you close the window, turn off Keep running in the notification area in Preferences > General. Change preferences# Open Preferences from the bottom of the sidebar or the notification area icon. Section Setting What it does Sign in Account, Orchestrator, Sign in, Sign out Your own sign-in. See Sign in. Machine connection Status, Connection, Orchestrator, Tenant, Machine, Proxy What the machine is connected to, why it is not taking work if it is not, and when it last heard from the Orchestrator. Proxy is read-only; an administrator sets it on the command line. Test connection Has the Robot service call the Orchestrator through its proxy and reports the time or the problem. Connect / Change connection, Disconnect The administrator's enrollment. Both need administrator consent. See Enroll a Robot. General Keep running in the notification area On by default. Start when I sign in Starts the Assistant when you sign in to Windows. Off by default. The Robot service starts with Windows either way. Theme System, Light or Dark. Robot State, Runtimes, Version, Installation ID, Host fingerprint What the Robot can run. Hover over a runtime for its detail. Copy host fingerprint copies the value an administrator may ask for. About Versions, Copy support bundle The Assistant and Robot versions, and a newer Robot version when one is available: Robot … available or Installing Robot …. Collect a support bundle# Open Preferences and go to About. Select Copy support bundle. Wait for Support bundle copied. The zip is saved to your Downloads folder as velophex-robot-support-<machine>-<date-time>.zip, put on the clipboard, and shown in File Explorer. Attach the zip to your support request. You do not need administrator rights. The bundle holds the Robot's logs, recent attempt journals, undelivered log lines and failure screenshots, the configuration with secrets removed, and an environment summary. It never contains a password, token or key. If the Robot service is not running, you see No support bundle; collect one with the command line instead (see Logs and troubleshooting). When something goes wrong# Message What to do You can't start this automation You lack Start Jobs in the automation's workspace. Ask an administrator for it. This machine cannot run that automation The machine lacks a runtime the automation needs. Add it with VeloPhex Setup. Start it from your own desktop The Robot could not tell who asked. Start the Assistant in your own signed-in Windows session, not over a shared or elevated session. Session expired — sign in again Your sign-in ran out and the start was not sent. Sign in again in Preferences, then run it. The Orchestrator could not be reached Nothing was sent. Check the network, then try again. This machine is not connected An administrator connects it in Preferences > Machine connection, or sign in to use a personal robot if the tenant allows it. Robot unavailable The Robot service is not running. Select Retry, or ask an administrator to check the service. More fixes: Logs and troubleshooting. Next steps# Attended and unattended Robots Jobs Logs and troubleshooting

Open the Assistant

Sign in

Do I have to sign in?

Find an automation

Add favourites

Run an automation

Check jobs and history

Stop or kill a job

Keep the Assistant in the notification area

Change preferences

Collect a support bundle

When something goes wrong

Next steps