All Collections
Onboarding Materials
Onboarding 1.2 Best Practices
Onboarding 1.2 Best Practices
Lauren Scott avatar
Written by Lauren Scott
Updated over a week ago

Before working in Optioneer, it is important that you are aware of the following:

🚫 Deleting results, points, lines, configurations or polygons is permanent.

Deleting objects and project features deletes them for you and everyone in the project area.

  • Here are some recommended ways to minimise the risk of mistaken deletion.

    • Through the Data Window, you can export all points, lines and polygons for a local backup.

    • Through the Results Library, you can export all options for a local backup.

    • Make copies of points, lines or polygons if you wish to edit them (via the three-dot menu).

    • Do not delete anything until you are sure that you and the team do not require them.

πŸ—£ Use descriptions and comments.

  • When you add a point, line, or polygon or run an analysis in Optioneer, you will have the option to provide a description.

  • We advise you to provide details such as why it was actioned, who approved the action and reference any relevant document or correspondence. This helps track decisions.

🏷 Naming Conventions

Naming conventions can help you to keep your work organised in Optioneer. Here are some suggested naming structures for configurations, cases, options and project features.

🍽 Configurations

The suggested structure for naming configuration keeps them in a logical order in Optioneeer and allows your team to understand their purpose. Make sure to use the configuration description to add more detail where possible. The description can be accessed in the Basic Information of any configuration.

  • date_type_name


  • version_type_name

    • type = the config which can either be

      • baseline (env/tech)- exactly what is determined in the data register without any tweaks.

      • an iteration of the baseline

      • evaluation - includes the penalties specified plus design rules which allow you to obtain metrics from Optioneer

    • name = another distinctive characteristic

      • it may minimise length through a National Park, follows roads etc.

🧳 Cases and Options

Cases and options are ordered by the date and have the time stamp next to them in the results library. So dates aren’t required in case and option naming.

We suggest the following structure to keep your cases organised and searchable:

  • startpoint_endpoint_configname

  • startpoint_endpoint_configname_version

Alternatively, if evaluating a line then give the case name in the general format:

  • linename_configname

  • linename_configname_version

πŸ‘ƒ Project Features

Naming project features sensibly will help you search, filter and track them effectively. Use the project feature description for keywords that will help you filter certain results. Project feature names should be:

  • unique and,

  • unambiguous to the team

For example, naming a point Edinburgh Castle (start point) describes its location and its relevance to the project.

πŸ“‘ Assign categories to project features and comments

Assigning categories can help visualise different scenarios or types of comments within the Optioneer environment.

  • You can create a category by typing in the Select Category field.

  • Changing the colour or deleting a category will do the same for all lines with that category.

If you notice anything worth mentioning here, let us know! But for now, let's move on:

Did this answer your question?