Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Page Properties
hiddentrue

magnet_version

6.0

Scroll ignore

This documentation does not detail managing conditions from the admin panel. For that documentation go here

Feature Overview

...

The box below is used as an on the Admin Documentation(linked above). If you change the text in the box below, make sure it makes sense on the linked documentation as well
Excerpt
Excerpt

Case Conditions allow for creating conditions that can be used throughout the MAGNET system, by assigning the conditions to cases as needed.

Conditions can allow for easier generation of needed “Standard Conditions” documents, as well as prevent users from taking actions on cases(Issuing, Scheduling Final Inspections, Issuing COO Documents) until required conditions have been completed.

This document will outline, what conditions are, what they can do and how to utilize them in the MAGNET system.

Condition Anatomy

Each condition can either affect the case it is attached to or can simply be used for informational use, such as when generating a Conditions Notice for a contractor. The behavior of the condition is controlled by the conditions Severity.

Additional details about the available configuration fields for conditions can be found in the Conditions Administration documentation.

Condition Group and Type

The conditions Group and Type are used to categorize conditions into different groups and further into types within that group. This allows for easier organization and finding of conditions when adding them to a case. Both Group and Type are always required. The default options of “General” can be used if further grouping is not desired.

Examples of Groups

Groups are commonly similar to Application Types, such as Accessory Dwelling Unit, CUP, etc. However, they can be anything that makes grouping conditions together more useful for you.

Examples of Types

Types can be any additional grouping that is helpful in classifying conditions. Some common examples are Aesthetics, Air Quality, etc. As with Groups, the name of the types can be anything that makes further categorization of the conditions easier.

Severity

The Severity of the condition, determines if a condition must be completed(or marked N/A) before a particular action can be completed on the case the condition is on.

General conditions do not affect the ability to perform actions on the case and are typically used when generating the Conditions Notice for the case.

Required conditions must be completed(or marked N/A) or they will prevent a specific action from being allowed on the case.

Info

Conditions can be configured to apply to cases either on initial add or when inherited onto a case after linking to another case(or both).

Rules

For conditions set to a severity of “Required”, one of the rules must be selected. These rules will prevent the defined action from occurring, unless the condition is resolved or marked N/A.

When one of the actions that can be controlled by conditions occurs or is attempted, the system will check for any incomplete conditions that apply to the case, that would prevent the action. If incomplete conditions are found, the users actions will be blocked and they can choose to view a list of the conditions preventing the action from being completed.

Actions

The following actions can be prevented/controlled with Required conditions.

  • Case Issuance

  • Certificate of Occupancy Document Generation

  • Scheduling of inspections labeled as “Final” (e.g. Final Inspection)

Inheritance

Inheritance allows for conditions that are inheritable to be automatically added to a case when another case is linked to the case that has conditions. This allows for adding conditions to a case, such as a planning case, that will also affect a later building or public works case when the other cases are linked to the original planning case.

Info

Conditions inherit in only one direction. When a case is linked to case with inheritable conditions, the case initiating the link will inherit the conditions from the case linked to.

For example, a Planning case is created that contains several conditions that implicitly prevent issuance of the Planning application(Apply on add), another condition we want to provide the contractor on the main conditions document, but it doesn’t prevent the issuance of the planning case(it’s applies on inherit). That condition will show on the planning case but not prevent the issuance of the planning case; later when a building case is linked to this planning case, the condition will be inherited and since it’s applies on inherit, it will be enforced on the building case and prevent issuance of that case until the condition is resolved.

Tip

This same situation could also be done with a condition that is set to “applies on both”, with the only difference being that it would prevent issuance of both the planning and building case.

What data is inherited

When a condition is added to a case, it becomes it’s own condition, meaning changes to that condition on the case have no effect on the main condition. The only way to change a main condition is to update it in the admin panel. Updating conditions in the admin panel does not affect conditions already applied to a case.

When a condition is inherited, it will inherit all the data on the condition from the case, in it’s current form, including any changes to the condition data on the case. However some data from the condition is not inherited, as noted below

Data not inherited

The following data from a condition is not inherited when a case links to it

  • The condition status

    • An inherited condition will always have an initial status of “Applied”, regardless of the status of the condition that is being inherited.

  • The inheritable flag

    • When a condition is inherited, the inheritable flag will always be set to “No”. This is to prevent conditions from being inherited again if another case was to link to the current case. The flag can be edited and set back to “Yes”, but by default, inherited conditions are not intended to be inherited again to another case.

Note

While inherited conditions start out with the data from the case it inherited it from, updates to the original case condition or the inherited condition do not affect each other. The conditions will behave independently once inherited.

Managing conditions on a case

To add conditions to a case, select the “Conditions” tab to go to the case conditions page. From this page you can add, edit, delete conditions that apply to this case.

Warning

Adding, editing and deleting conditions are controlled by permissions. If you are not able to complete an action detailed below, you may need to request that permission to do so be added to your account.

Adding conditions

Using the filters on the add conditions page, identify and select the conditions that should apply to the current case.

Info

You can change the filters after selecting conditions without losing you previously selected conditions.

After the needed conditions are selected, click save to add the conditions to the case.

Editing Conditions

To edit conditions, simply click on the edit icon on a condition that you would like to make changes. When editing a condition on a case, most data is available and able to be changed, with the exception of the Group and Type.

After making the needed changes, click the Update button to save the changes

Note

Keep in mind, changes made to a condition on a case, will only affect the current condition. The main condition as well as any inherited conditions will be unaffected.

Condition Variables

...

Deleting Conditions

To delete a condition on a case, click on the delete icon(The trash can located on the top right of the condition). After confirming that you would like to delete the condition, it will be removed from the case.

Setting a condition status

To update the conditions status, select the applicable status from the available option on the top left of the condition.

Note

Only conditions that have a Severity of “Required” will have status options available.

Conditions Document

To generate the conditions document, from the main View page on a case, click the “Issue Document” button. After clicking this button a list of available documents should be displayed. Click on the “Conditions Notice” option to generate a Word document containing all available conditions on the case.

Info

Only conditions set to “Show in Notice” will be exported to the Word document.

Warning

Any changes needed for conditions should be made in the system on the Conditions tab. While changes made to the Word document can be uploaded to the case for future reference, it will not affect any conditions on the case.

Condition Ordering

...

Include Page
CD:Case Conditions: Feature Overview
CD:Case Conditions: Feature Overview

Condition Anatomy

Include Page
CD:Case Conditions: Condition Anatomy
CD:Case Conditions: Condition Anatomy

Condition Group and Type

Include Page
Condition Group and Type
Condition Group and Type

Examples of Groups

Include Page
Examples of Groups
Examples of Groups

Examples of Types

Include Page
Examples of Types
Examples of Types

Severity

Include Page
CD:Case Conditions: Severity
CD:Case Conditions: Severity

Rules

Include Page
CD:Case Conditions: Rules
CD:Case Conditions: Rules

Actions

Include Page
CD:Case Conditions: Actions
CD:Case Conditions: Actions

Inheritance

Include Page
CD:Case Conditions: Inheritance
CD:Case Conditions: Inheritance

What data is inherited?

Include Page
What data is inherited?
What data is inherited?

Data not inherited

Include Page
Data not inherited
Data not inherited

Managing Conditions on a Case

Include Page
Managing Conditions on a Case
Managing Conditions on a Case
Include Page
Conditions Document
Conditions Document

Adding Conditions

Include Page
Adding Conditions
Adding Conditions

Editing Conditions

Include Page
Editing Conditions
Editing Conditions

Condition Variables

Include Page
CD:Case Conditions: Condition Variables
CD:Case Conditions: Condition Variables

Deleting a Condition

Include Page
Deleting Conditions
Deleting Conditions

Setting a Condition Status

Include Page
Setting a condition status
Setting a condition status

Conditions Document

Include Page
Conditions Document
Conditions Document

Conditions Ordering

Include Page
Condition Ordering
Condition Ordering