Revizto scheduler Follow
The updated Revizto Scheduler released with version 5.15 allows you to create and run automated tasks for your Revizto projects. Once set up, tasks will run without you needing to be actively in Revizto, allowing you the flexibility to set tasks for off hours and from central devices. Tasks can include importing models from files, running clash automation, and publishing models and sheets from authoring tools.
For full access to the scheduler features discussed in this article, make sure you have updated to the most recent version of Revizto.
In this article:
You can also check out Revizto Academy for our essentials course on the scheduler: Scheduler essentials. Making an account and taking courses is free!
Scheduler overview
The scheduler is accessed through the standalone Revizto 5 Scheduler application or the Scheduler tab in Revizto Workspace. You must be signed in to Revizto to use the scheduler. If you are not signed in to Revizto when you try to open the scheduler application, you will be asked to sign in to Revizto and try again.
Revizto 5.15 includes both the Revizto 5 Scheduler and Revizto 5 Old Scheduler applications. Refer to Revizto 5 Old Scheduler for more information on how to switch between the old and new scheduler and migrate and back up tasks.
In the upper right corner of the scheduler application is the account and region the scheduler is operating under. To change the region or Revizto account, close the scheduler application and sign in to Revizto using another region or account. When you reopen the scheduler, the region and account will be updated.
In the upper left corner of the scheduler application is the device name (This device) and settings menu . Changing the device name and other settings is described in Scheduler settings. The scheduler application is linked to the current device, so the tasks displayed are from that device, regardless of project. Meanwhile, all tasks displayed in the Scheduler tab in Revizto Workspace are from the project you are in, regardless of the user who set up the task or the device where the task will be executed.
To access the Scheduler tab in Revizto Workspace:
- Sign in to ws.revizto.com.
- If you are a member of several licenses, ensure that the correct license is selected.
- Go to Tools, then select My Projects
- Open the project and then, in the top toolbar, select Scheduler
.
Refer to the sections below to learn more about the scheduler layout, settings, and some best practices.
Scheduler layout
In both the application and Scheduler tab in Revizto Workspace, the scheduler is divided into three sections:
Across the top of each section you can filter and search for tasks within that section. Filters vary based on the scheduler section and location (standalone application or Revizto Workspace).
Scheduler settings
The scheduler settings can only be accessed through the scheduler application. In the settings, you can change the device name, revert to the old scheduler, migrate tasks from the old scheduler, and set timeouts to cancel a task if it spends too long in the queue or takes too long to execute.
To access and change scheduler settings:
- Click Settings
next to the device's name in the upper left corner. This will open the Settings menu.
- Change the device name or timeout limits.
- To change the device name, edit directly in the Device name field.
- To set a timeout limit, select the checkbox next to the type of timeout you want (Task execution, Time in queue, or both), then enter the number of hours.
- Click Save.
The scheduler application's settings are based on the device and not the account and will, therefore, be different on a different device.
Scheduler best practices
The scheduler allows for automatic task management such as setting tasks to run after hours or from a central device. However, for the scheduler to run tasks successfully, the device with the scheduler must meet the following guidelines:
- The device must be on and awake. This might mean changing the device's power settings to prevent it from going to sleep.
- The computer screen can be locked as long as it is not asleep.
- The user who set up the scheduler must be logged in to the device.
- If the scheduler is running publishing tasks, the device must have that authoring tool installed.
- Tasks must be set in the scheduler on the device running the task. A user cannot set up a task from their own device and expect it to run on a central device.
Tasks
The Tasks tab shows all tasks that have been created from the device (in the scheduler application) or for the project (in Revizto Workspace). In the scheduler application, you can also manage and create tasks from this section.
You cannot create or edit tasks in the Scheduler tab in Revizto Workspace, you can only view and delete them depending on your access rights in the project.
Each task row includes task information columns, which can be added or removed by clicking Show/hide columns to the right of the task columns. The alert column (second from the left) will indicate if the task has any issues by showing a warning
or error
. Warnings are not critical, and mean the task can still run, but might have a problem such as a syncing issue. Errors are critical and indicate a problem that prevents the task from running, such as source files that can't be found. Tasks can be filtered by alert type.
Task actions
From the tasks toolbar in the scheduler application, you can perform the following actions:
-
Run now
-
Duplicate tasks
-
Export tasks
-
Import tasks
-
Delete tasks
Tasks can be deleted in both the application and the Scheduler tab in Revizto Workspace. In the scheduler application, any task can be deleted by the device's user, regardless of rights. In Revizto Workspace, only project administrators can delete tasks.
You can perform any of the above actions by selecting the checkbox next to the relevant tasks, then clicking the action in the menu bar.
From Tasks in the scheduler application you can create and edit tasks as described in the following sections:
Creating tasks
You can create the following types of tasks in the scheduler application:
- Import 3D models from files
- Clash automation
- Publishing from authoring tools
To create a new task, click Create task and select the type of task you want to create. You will then be prompted to enter the task settings. The specific settings vary depending on the type of task you are creating, as described in the sections below.
Tasks can only be created in the scheduler application.
You can create tasks to import 3D models from the following file types: IFC, FBX, OBJ, RVM, 12DXML, GLTF, and point clouds (FARO, ReCAP, and LAS). While multiple file types are available for import, only one file type can be selected for an individual task. If you need to import multiple file types, you will need to create a separate task for each one. One task can include multiple files of the same file type, however.
To create a task to import 3D models from files:
- Click Create task.
- From the Task type dropdown menu, select Import 3D models from files.
- Click Create. This will open the new task pane.
- Complete the fields under New task.
- In the Task name field, add a name.
- Next to the Revizto project field, click Select projects. This will open the Publish to Revizto window. Select your project, then click OK.
If you select a local project, you will not have the options to sync the project or send email notifications under Additional actions.
- Select the model files under Model import settings.
- In the Source models box, click Add models. Select the file format of your models from the dropdown menu and click OK, then select the files from your device.
- If prompted, select if you would like to link the model to an existing model in your Revizto project and set the model positioning.
- Change the settings under Publishing settings if needed. The fields will vary depending on the file type.
- Set a schedule to run the task automatically under Schedule.
- If you do not want to run the task on a schedule, turn off the Run task automatically on schedule toggle. This means the task will only run manually or through a command line.
The specified end date is the last date the task will run on.
- Select any desired options under Additional actions.
- If you would like to run command-line actions related to this task, select the Perform command-line actions before or after task checkbox. More information on command-line actions can be found under Using the command-line functions.
- Review all task settings then, at the top of the pane, click Save.
Your task will now be ready to run. It will be visible under Tasks as well as Upcoming schedule if you set the task to run on an automatic schedule.
Tasks can be set to run clash automation in your cloud and shared location Revizto projects (a Revizto+ license is required). Once a task is set up, Revizto will not need to be open to run the clash automation; this means you can set multiple tasks to run after hours or from a central machine and eliminates the need to manually run the clash automation. Clash automation tasks can run clash automation for either specific clash tests or for tests with specific labels, however the tests or labels must already be set up in your Revizto project. You cannot set up a clash test from the scheduler.
To create a clash automation task:
- Click Create task.
- From the Task type dropdown menu, select Clash automation.
- Click Create. This will open the new task pane.
- Complete the fields under New task.
- In the Task name field, add a name.
- Next to the Revizto project field, click Select project. This will open the Publish to Revizto window. Select your project from the options listed, then click OK.
Local projects are not available for clash automation tasks as the ability to sync is required.
- Select your Clash automation settings.
- Under Clash tests, select which clash tests you want to include from All, Selected labels, or Selected clash tests. Choosing Selected labels or Selected clash tests will prompt you to add the labels or clash tests in the Labels or Clash tests field.
Revizto must be open to select labels or clash tests. If Revizto is not already open, it will be opened by the scheduler.
- Under Actions, select the clash test actions you want to run. The options, Run clash detection and Sync with the issue tracker, are the same actions that must be chosen for clash tests in Revizto. You must select at least one option.
- If you select the Sync with the issue tracker checkbox, choose what type of clashes you want synced ("reviewed" and "not reviewed" or only "reviewed").
- Set a schedule to run the task automatically under Schedule.
- If you do not want to run the task on a schedule, turn off the Run task automatically on schedule toggle. This means the task will only run manually or through a command line.
The specified end date is the last date the task will run on.
- Select any desired options under Additional actions.
- If you would like to run command-line actions related to this task, select the Perform command-line actions before or after task checkbox. More information on command-line actions can be found under Using the command-line functions.
- Review all task settings then, at the top of the pane, click Save.
Your task will now be ready to run. It will be visible under Tasks as well as Upcoming schedule if you set up the task to run on an automatic schedule.
Creating a task to publish from an authoring tool must be done in the authoring tool. Once a task has been created, however, the authoring tool must be closed for the task to publish from the tool to Revizto. If the tool is open when the task tries to run, it will fail. The scheduler currently supports publishing from: Revit, Navisworks, AutoCAD, Plant 3D, Civil 3D, Advance Steel, and Bentley MicroStation.
To create a task to publish from an authoring tool:
- Open your project in the authoring tool.
- In the Revizto 5 plug-in in the authoring tool, click Revizto Scheduler. This will open a scheduler window.
- Select the task's settings and save the task to create it.
The button Publish to Revizto will publish the model immediately and is not used for creating tasks in the scheduler.
Once a task to publish from an authoring tool has been created, it will show up in the scheduler where you can perform all scheduler functions (such as run, delete, and export) and edit most settings in the task.
Editing tasks
All tasks—importing models from 3D, clash automation, and publishing from an authoring tool—can be edited in the scheduler.
To edit a task:
- Click on the task to open the task pane.
- Click Edit in the task's toolbar. This will open task fields for editing.
- Edit the relevant fields and settings.
- Click Save.
When editing a clash automation or publishing task, Revizto or the authoring tool may open, however, most of the editing can still be done in the task in the scheduler.
In publishing tasks specifically, you can link or unlink a source model from the task. This will change the model associated with the task without having to create an entirely new task. This is useful when a new version of a model is created to replace an old version or the authoring tool is updated to a new version and upgrades the models.
To unlink and link a model from a task:
- Click on the task to open the task pane.
- Click Edit in the task's toolbar. This will open task fields for editing.
- Next to Source model, click Unlink.
- Click Save. The task will now show a Warning alert, however this will go away when a new model has been linked.
- Open the new model in your authoring tool.
- In the Revizto 5 plug-in in the authoring tool, click Revizto Scheduler. This will open a scheduler window
- Under Tasks not linked to models, click Link to current model for the task you want to link.
- Click OK to confirm your selection.
If you need to upgrade a model linked to a task because the authoring tool has been updated to a new version:
- Open the model in the updated authoring tool.
- In the Revizto 5 plug-in in the authoring tool, click Revizto Scheduler. This will open a scheduler window.
- Under Tasks created in other <authoring tool> versions, click Use <updated authoring tool>. This will automatically update the model linked to the task to the new version of the tool.
- Click OK to confirm your selection.
Using the command-line functions
All tasks include options to use command-line functions in the Action and Command-line settings task sections.
To use the command-line function task sections:
Creating command-line actions
A command-line action runs automatically before or after a task based on the selections under Action in that task's settings.
To create a command-line action:
- Under the Additional actions section of the task, select the Perform command-line actions checkbox. This will open the Action section.
- Select when you would like the action to be performed. Options include Before task, After task on success, and After task on failure or partial failure.
Task statuses are described under History.
- Add the command to the box.
- When all editing on the task is completed, click Save at the top of the task pane.
You can add as many actions as you want to a task by clicking Add another action. This will add another Action section to the task pane. Additional actions are independent from each other and are only applied to the task itself; they do not stack on top of previous actions.
To delete an action from a task, open the task for editing, then, under the relevant Action section, click Delete action.
Using command-line settings
The Command-line settings section provides the command to run the task you are viewing. This command can be used to run this task through Revizto Console or as an action on another task. The command is auto-generated and read-only, however, you can edit the command's name in the Task alias for the command line field and copy the command using the Copy button above the command's field.
Task queue
You can open the task queue by clicking the Task queue button in the upper right corner of the scheduler application. The task queue shows the current status of all running and queued tasks. Only one task can run at a time and will feature a progress bar to show the status of the task's run. You can use the task queue to monitor the progress of your tasks.
To cancel queued tasks, click X next to the individual tasks or click Cancel all to cancel all tasks in the queue. If a task is running, it will take longer to cancel as the progress on the task must be rolled back, however, it will be canceled. Task cancellations will be recorded under the History tab.
Upcoming schedule
You can view all upcoming runs of scheduled tasks in the Upcoming schedule tab. Tasks will be grouped by date with each line representing a scheduled run time for a task, not the entire task. For example, if a task is set to run every week on Mondays and Tuesdays, you will see a line for a specific run of that task listed under each upcoming Monday and Tuesday for the duration of the task.
From the upcoming schedule, you can skip a scheduled task run. Skipping a task means it will not run that task at that scheduled run time, but it does not delete the task. Any scheduled runs beyond the run that was skipped will still run automatically unless individually skipped or the task is deleted.
To skip a task:
- Select the checkbox next to the scheduled run. Multiple task runs can be selected.
- Click Skip at the top of the page. The skipped run will be labeled "[Skipped]" in front of the task's name.
To undo a skip:
- Select the checkbox next to a skipped run. Multiple skipped task runs can be selected.
- Click Undo skip at the top of the page.
History
The History tab shows you a history of all the tasks that have been run. You can use this section to view the details of your previous tasks, such as start time, duration, and status. Clicking a task will open an info pane with more details on the task and its status, such as who canceled the task or why it failed.
Tasks can have the following statuses:
Running | The task is actively running. |
Queued | The task is in the task queue and waiting to run. |
Success | The task succeeded. |
Failed | The task failed. |
Partially failed | Parts of the task failed, but not the entire task. |
Skipped | The task was canceled before it ran or was queued. |
Canceled | The task was canceled after it started running or was queued. |
Unreachable |
The device that was supposed to run the task could not be reached. This status will only show in Revizto Workspace. |
Depending on which scheduler location you are using, the task history will be slightly different. In the scheduler application, the history will show tasks related to that specific device and account. In the Scheduler tab in Revizto Workspace, the history will show all tasks related to the project you are in.
Revizto 5 Old Scheduler
The release of Revizto 5.15 introduced the new Revizto scheduler described in this article. The new scheduler is a more powerful and flexible tool with options such as creating clash automation tasks, viewing and managing the upcoming task schedule, and reviewing task history. However, as this represents significant changes from the old Revizto scheduler, the new scheduler includes easy options to migrate tasks from the old scheduler to the new one and revert to the old scheduler if needed.
Updating to 5.15 will automatically install both the new scheduler and old scheduler applications on your device. Use the following workflows to migrate tasks or switch scheduler versions.
Migrating tasks to the new scheduler
When switching to the new scheduler, you might want to migrate tasks that exist in the old scheduler to the new one.
To switch to the new scheduler and migrate your tasks:
- Open the Revizto 5 Scheduler application. You may need to search for it in the Windows start menu.
- Click Start using new scheduler.
- You will be asked if you want to back up your tasks. Click Select folder then choose a destination folder to create a backup file, otherwise click Skip.
If you select Skip, a backup file will be saved in the .old-scheduler-backups folder in your Revizto working folder.
- In the next window, click Migrate tasks.
- Confirm the migration by clicking OK.
All tasks in the old scheduler will be migrated to the new scheduler and will run automatically on their existing schedules. Migrated tasks can be edited and will include the expanded settings that come with the new scheduler.
Reverting to the old scheduler
If you are currently using the new scheduler, you can switch back to the old scheduler at any time. The new scheduler offers a number of advantages over the old scheduler, however, the old scheduler will remain available if it better meets your needs.
To revert to the old scheduler:
- Open the new Revizto 5 Scheduler application. You may need to search for it in the Windows start menu.
- Go to Settings
.
- Click Revert to old scheduler.
- You will be asked if you want to back up your tasks. Click Select folder,then choose a destination folder to create a backup file, otherwise click Skip.
It is recommended to create a backup file as all tasks will be deleted from the new scheduler when reverting to the old scheduler.
- Select if you would like to restore tasks in the old scheduler from a backup file.
- If you want to restore tasks, click Select file, then choose the relevant file from your device.
- If you do not want to restore tasks, click Skip restoring.
- Confirm that you are switching back to the old scheduler by clicking OK.
You will now be able to use the old scheduler. You will still be able to open the new scheduler application and the Scheduler tab in Revizto Workspace, but will not be able to create a task or perform any actions without switching to the new scheduler. Additionally, any tasks created in the new scheduler before switching back to the old scheduler will be deleted, so it is recommended to always create a backup file when switching between scheduler versions.
Comments
0 comments
Article is closed for comments.