The Assignment Manager module enables virtual airline management staff to create, edit, debug and manage assignments.
Whilst the Assignment Manager is happy to generate flights to and from established airports that exist within the simulator (and we have a ton of options for randomly generating these kinds of assignments) this system, based on what it was actually primarily designed for, really shines when generating assignments to non-airport specific locations such as GPS locations - this opens up a whole load of fantastic possibilities for STOL, float planes, Military and Helicopter flights.
Here are just a few example use cases and ideas that I had in mind when developing this feature which I hope might serve as a creativity booster when you and your airline staff create assignments (obviously these will depend on the type of airline you are running):
Whilst the above are just examples, you can combine the power and available options that our assignment system provides to literally cater for ANY kind of assignment.
In addition to the above, this system can be combined with our existing Routes and Duty Schedules features (for conventional, commercial airlines), you could, for example, choose to set the value of the rewards on your Company Routes to zero (0) and then use the assignment generator to generate flights to and from "Any company route" and by setting the value of a reward on the assignment template specifically would entice pilots to fly the company routes using the generated assignments only (as the rewards would only be available and "paid out" when flying them as an assignment) or, equally, pay a "bonus" for flying the assignment (such as an "overrime" achievement).
Conventional airlines, whilst they primarily fly route-based flights (and probably have their routes and hubs set up in FsHub already) could use this feature to generate other assignments such as maintenance, lost baggage, repatriation flights and/or "fictional" pilot cover (for example, if a pilot calls in sick).
Before your airline will start to generate assignment jobs, your virtual airline owner (or another member of the virtual airline management team with the correct RBAC role) must first enable the feature in the Airline's Airline Settings module:-
From the Airline Settings module, scroll down until you find the section named Assignments & missions and then check (ensure it's ticked) the box labelled Enable airline auto-generated assignments?, as demonstrated below. Once ticked, be sure to click the Save button for the changes to take effect!
Now that you have enabled the feature, your airline, once you have created one or more assignment templates will start to generate jobs at the intervals you specify.
By default, the airline owner will have access to create, edit and debug assignment templates.
All airline pilots will have access to view the list of generated assignments and to complete them by default, only the "administration" features require additional roles and permissions if you wish to grant access to other virtual airline members to manage the assignment templates!
The airline owner can also, optionally enable access to over virtual airline members by adding a new security role using the Roles & Permissions module from the airlines' Crew Portal as shown here:
Three permissions can be added to a role that enables users in your virtual airline to manage specific aspects of the assignment's system, these are as follows:-
The permissions can be seen here:
In addition to being able to create, edit and delete assignment templates, if a user (with this role) has both Create template and Delete template permissions, they will automatically be granted access to the Debug Tools section of the Assignments Manager module - the Debug Tools feature enable you to bulk generate and bulk delete all assignments for testing purposes!
Once you have created a role (or added the required permissions to an existing role) with the required permissions, you can assign this role to any users to whom you want to grant access too via. the Human Resources module.
The settings under Assignments & missions in the Airline's Airline Settings module enable you to "tune" the global assignment generation settings.
An overview and explanation of each of these settings are as follows:-
HH: MM
eg. 00:00
for midnight, 06:25
for 25 minutes past six in the morning or 21:30
for half-past nine in the evening) format that you want FsHub to generate your assignments at. Please be aware that this time uses the UTC timezone, so ensure that you take this into account when setting this value.Mission
, Job
, Charter
, and Ad-hoc Job
will substitute the word "Assignment(s)" in the airline's crew portal. Tip: Ensure you use singular words (omit the tailing "s" at the end of the word) as FsHub will automatically inject this when required.Remember to Save Changes when adjusting these settings for them to take effect!
An "assignment template" is the term that we at FsHub refer to the assignment generation configuration.
One or more assignment templates can be created by the virtual airline admin staff and, based on the settings in the assignment template (more on this below) will be used by FsHub to generate randomised assignments based on your airline's generation interval settings.
When you first access the Assignment Manager module you will be shown the current list of Assignment Templates that you and your airline managers have created.
An overview of the columns and what they mean are as follows:-
{TAGS}
do not work in this name/title). Clicking on the title will open up the assignment template in "Edit" mode.The next four columns are for informational purposes only and can be used by virtual airlines to determine what types of assignments are popular and which ones are flown less (and might be a candidate to be removed and replaced with a different type). These columns can also be used by virtual airlines to determine if the spawn rate (Chance %) should be tweaked!
And finally, if you decide that you want to delete an assignment template (maybe you no longer want to generate assignments of this type, are using assignments as "Daily Challenges" or some other reason, you can click the delete button in column (10) to delete the assignment template. Please note that any existing assignments generated from this template will remain in your airline's assignment list until they have either expired or been flown and completed by a pilot.
Hovering your mouse over any of these columns that have an underline will display the full-length version of the column name.
If you have assignment templates that have a low generation chance (%) you can expect the value in the GT column to be lower than in the NT column (as these are going to be generated less than not at all.
You are not restricted to one assignment template per "type" of assignment and the system is designed to enable airlines to create the same assignment template which, can for example, simply be used to cover such scenarios where you may want to generate completely random GPS locations but ensuring they will almost certainly all be land-based departure or arrivals - To do this you may want to generate three templates that are almost exact in their configuration except the departure and arrival GPS coordinates - these may each vary in location and radius.
You can set up a new assignment template using the Create New button on the assignment listing page as shown here:
Once you load into the assignment creation page, the assignment configuration editor will appear as follows:
The sections and their purposes are described below:
A320, A20N, B737, B738, B739
) or leave blank to allow any aircraft type to be used to fly and complete this assignment.When adding a title to the assignment or description/storyline, FsHub enables you to use some "dynamic" placeholders to improve and further enhance the content by giving it more context.
There are two types of placeholders you can use, firstly is the assignment generation placeholders such as the departure airport ICAO code, GPS landing zone name as well as the ability for you, an airline admin to add your own placeholder words/phrases that will be chosen at random.
Assignment tags are injected based on the departure and arrival GPS coordinates and/or airports. An overview of the tags is as follows:-
{DEP-ICAO}
- The departure ICAO code (if the departure is an airport), for example, KJFK
.{DEP-NAME}
- The departure name (if the departure is an airport), for example Kennedy Intl
.{DEP-GPS-NAME}
- If the departure location is a GPS location and you have used the GPS named coordinates format when adding specific GPS locations, this will inject the location name you set for the GPS location, for example, Oil Rig 26
or Major Road Accident
.{ARR-ICAO}
- Same as the {DEP-ICAO}
tag but for the arrival instead!{ARR-NAME}
- Same as the {DEP-NAME}
tag but for the arrival instead!{ARR-GPS-NAME}
- Same as the {DEP-GPS-NAME}
tag but for the arrival instead!Additionally, if you choose the Any Airline Hub open when selecting the departure and arrival configuration items, an additional tag ({ROUTE-NAME}
) will then be available and this will inject the airline's route name for the random route.
Custom tags are made available (and can be used) when tags are added to the Placeholder words/phrases (optional) text box.
Whilst this feature is fully optional (you don't have to add any at all), if you do, FsHub will automatically choose one (a line) and inject it into the assignment upon creation.
If your assignment only requires basic context, you can just use a single word or phrase per line, as demonstrated here:-
FsHub will, when it generates an assignment from this template, choose one (a line) and replace all instances of the {RANDOM}
tag in the assignment title and description/story content with the content you have added.
As an example, using the above settings, FsHub would choose one at random and the assignment content would be generated as follows:-
We can do more though... In the below (a more advanced) example, I'm demonstrating the use of multiple placeholder words (or phrases), we can separate related content with a pipe character (|
) - whilst this is optional, this can add greater context and flexibility to your assignments' storyline.
The way it works is that FsHub will still choose a line at random but, if the line has multiple words or phrases (separated by a pipe (|
) character), you can access the word or phrase from the line using the word/phase position number, these tags will be in this format:
{RANDOM-1}
, {RANDOM-2}
, {RANDOM-3}
, {RANDOM-4}
, {RANDOM-5}
, and {RANDOM-6}
At this time, the maximum number of words/phrases supported by this feature is six (6)! TIP: If you need greater flexibility, duplicate the assignment template and change the contexts!
Placeholder words/phrases must be added on new lines - at the point that an assignment is generated from this template, it will choose one line at random and use that "context". TIP: Whilst each line has an equal chance to be "chosen" at random if you need to increase the probability that a certain one will get chosen over another, simply duplicate the line (add it multiple times).
From the above example a generated assignment would look as follows:-
Assignment templates require a departure (generation) method and an arrival (generation) method, these settings are then used when FsHub generates the assignments from the template.
The assignment manager supports several methods for generating assignments, each of these methods then have specific options, we will cover these below.
The departure and arrival method dropdown menu (options) appears as follows:
The menu is split into two sections, the Generic options group does not require the virtual airline to have previously configured Hubs or specific routes using the airline's Crew Portal's Hub Manager and Routes Manager modules and is likely to be suitable for most virtual airlines that don't use Routes or Hub.
Optionally, if your airline is a "conventional commercial airline" you may find the options under the Airline route-based options group to utilise preconfigured options for ease of configuration.
Both menus (departure and arrival methods) contain the same options and can be set independently.
If the Any Airline Route option is selected in either dropdown menu, this will lock the arrival type to this too this is since this option uses your airlines' routes to choose one at random. It is also good to note that when the Any Airline Route option is used, the "Generate a SimBrief plan?" option will also populate the correct airline flight number/callsign when generating a SimBrief plan!
Upon selecting a departure and arrival type, depending on the type of generation method used, additional configuration options will then appear below the menu, in the next section we will cover each of the different types of generation methods and any specific configuration options (if there are any).
The Specific Airports (ICAOs) option enables virtual airlines to add a space-separated list of ICAO codes (a comma-separated list will work fine too in this specific instance).
Upon choosing the Specific Airports (ICAOs) method type from the dropdown menu, the Specific Airports (ICAOs) text box will appear as follows:
In the above example, we are configuring this assignment template to choose one of these airports at random when the assignment is generated, in this instance, the assignment template will use either EGLL
(Heathrow Intl), EGSS
(Stansted Airport) or EGKK
(Gatwick Airport).
You should use a space-separated list (optionally you can use a comma too if you wish) of ICAO codes here, but it is not recommended to add a new line. TIP: If you make a typo in the ICAO code or the ICAO code entered does not exist, FsHub will substitute it for EGLL (as a safe fallback).
The Random Airports option enables virtual airlines to instruct FsHub to randomly choose an airport (optionally by size) within a certain range (distance) from an existing ICAO (airport).
In the screenshot above, you can see that there are four additional options for this method, which are as follows:-
The Airport size field (1) enables you to fine-tune the types of airports that your assignments will use. The available options are summarised as:
Whilst FsHub can automatically generate GPS coordinates (so you don't have to enter a specific list of them), this particular setting does have the added advantage of enabling you to set specific departure or landing locations such as for custom scenery (eg. oil rigs, static aircraft carriers or other non-airport related sceneries)
Each GPS location (coordinates) must be entered on a new line!
There are two formats that you can use when entering these coordinates, they are as follows:-
lat,lng
such as 52.033442,1.098380
.lat,lng[location name here]
such as 52.033442,1.098380[Road Traffic Collision]
.There are a couple of advantages to using the "named GPS coordinates" format over the "standard coordinates" format, these are as follows:-
{DEP-GPS-NAME}
and/or {ARR-GPS-NAME}
placeholder in the assignment's title and description boxes adding more context to the storyline.Check out our section below titled Tips and tricks for GPS-based arrival and departure zones for some useful tips on how to easily find specific GPS coordinates for your assignment templates using Google Maps.
In the above example, I have specifically used the "named GPS locations" format to highlight another "trick", I'm setting up a heli-med assignment template, I've specifically set some named locations (such as near major roads, swimming pools, football stadiums etc), the screenshot highlights in (3) that I have duplicated some coordinates but have given them different "names" - this will add another degree of randomness (eg. we may have to "scamble" our air ambulance helicopter to the same location but, each time we could get a different "situation" eg. a bus crash, motorcycle accident etc).
The other setting, Tolerance (2) enables us to specify how large the area is (zone) around the GPS coordinates that the pilot can land/depart within.
For GPS-specific landing/departure zones, the assignment manifest highlights the "acceptable" landing/departure zone (2) as follows:-
Other useful things to note from the above screenshot are:
{ARR-GPS-NAME}
tag in addition to custom tags using the {RANDOM}
placeholder (to add more depth to the manifest story)For reference purposes, the template I created to generate this particular assignment was as follows:
...more information on the manifest overview page and some tips on how to fly GPS/VRF flights can be found on the pilot-specific documentationairline-assignment-system for the Assignments system.
If you plan to add assignments to custom scenery locations you may find that the developer of the scenery has published these coordinates on their website. If they haven't you could consider contacting them directly or simply locating them within the simulator and then copying the coordinates.
To be completed!
This method will generate random coordinates within a range.
If you are trying to cover an entire country but want to avoid waterways and sea etc. it is recommended that you choose one of more "centre" points that, when added to multiple assignment templates can be used to cover an entire island such as the UK (where the shape is oblong), you could, for example, create three separate assignment templates, each one using a different centre-point ICAO code which, when combined will cover the entire island. The other, probably less desirable option but would be more "precise" would be to use the "Specific GPS Coordinates" option and add a long list of desired locations.
This method has four customisable options, these are as follows:
The Any Airline Hub Airport option will choose a random airline hub that your virtual airline has created in the Hub Manager module (accessed from the Crew Portal).
As shown in the screenshot above, there are no additional configuration options for this specific method.
The Any Airline Spoke Airport option will choose a random destination or arrival airport that your virtual airline has configured as a route (created in the Route Manager module or which is accessible from the Crew Portal) and is not configured as a hub.
As shown in the screenshot above, there are no additional configuration options for this specific method.
This particular option differs from the other options, when selecting this option (Any Airline Route) from either the departure or arrival "Method" drop-down menus, you'll notice that the second (arrival) drop-down menu becomes disabled (2)!
Using this option, FsHub will automatically use the departure and arrival airports from one of your company routes (company routes can be configured through the Route Manager module in the Crew Portal).
You will also notice that when this option is selected, you are now able to use an additional placeholder tag (3), the placeholder tag will output the company route name (such as the flight number or call sign) that was set up when you created the route.
The assignment templates enable you to specify Specific GPS coordinates as an option for the assignment's departure or arrival configuration and whilst we understand that knowing the exact GPS coordinate for a specific location off the top of your head is highly unlikely, you can use Google Maps to browse to a location and then right-click on the map to display the exact coordinates, clicking on the coordinates as shown in the screenshot (2) below will then copy these to your clipboard (so you can then paste them into the assignment template creation screen).
Whilst you can use the Random GPS coordinates setting when creating assignment templates in FsHub (FsHub will then randomly generate coordinates for you, without you needing to specify a long list), in this example, I am planning to create a large list of Specific GPS coordinates (locations) at major roads/intersections and plan to use these for heli-med style missions; by using the Specific GPS coordinates departure or arrival setting when creating the assignment template, I can ensure that my pilots get a more accurate experience for road traffic collision style heli-med missions (as opposed to using the Random GPS coordinates setting.
In the below screenshot, you can see that I have located a busy, major road intersection which is likely to have single or multiple-vehicle pile-ups, remember that whilst I have specifically chosen a suitable landing spot, this exact landing coordinate is actually just the "centre-point" of the "landing zone" and as such, the pilot flying this mission could land anywhere within the landing zone (tolerance) as per your assignment's template configuration.
When you use a large list of "specific GPS coordinates" in an Assignment Template you can be sure that when the assignments are generated since the specific GPS coordinates are chosen at random (from the list you have added), a longer list or GPS coordinates will ensure that the GPS coordinates that are chosen are more infrequent (as there are more to choose from) than a shorter list.
Another such example (to fuel your creativity - pun most certainly intended) might be that you want to set up assignments to custom scenery locations (maybe your virtual airline specialises in helicopter transfer flights to off-shore oil rigs) and therefore, assuming these locations are static (unlike aircraft carriers for example) and exist in the real world (such as oil rigs), the same process to obtain the GPS coordinates for the departure or arrival location using Google Maps - simply find the oil rig using Google Maps and copy the GPS coordinates!
There are a whole bunch of fantastic scenery developers out there that are developing bespoke scenery and add-ons not always for specific airports but instead scenery at nearby glaciers, beautiful outback locations and
Ever wanted to visit obscure locations in the sim (and get a sense of achievement from them), maybe your virtual airline might like to set up an assignment template for a helicopter trip to Sealand (a sovereign Principality built on a WWII military fortress in the north sea!)
From the Assignments Manager module, you can test how FsHub will generate assignments based on your airline's global settings and the assignment template configurations (this can be great for checking and fine-tuning the Chance % in addition to ensuring that the user of placeholder tags are working correctly (as you intend them to).
The debug tools panel, when clicking the Debug Tools link will appear as follows:
It is important to note that the Debug Tools feature is for debugging purposes only and it is recommended that it is used infrequently as it is, by design destructive in nature!
The screenshot above has four main buttons (or features) these are described as follows:-
The Debug Tools link will only display if you are the airline admin or if you have granted specific permissions (roles) to your virtual airline users to whom you want to be able to administer these features (more details on this can be found in this page above)
This documentation has covered how to set up and manage assignment templates, for more information on how to fly these achievements and how these work, we recommend you read the pilot-specific documentation.