Admin Guide - Gantt Lightning Web Component (LWC)

The Gantt Lightning Web Component (LWC) is an upgrade of our existing Project Gantt from a Visualforce component to a Lightning Web Component (LWC), aligning it with the current Salesforce platform architecture and programming language. This upgrade brings a more intuitive user interface, aligned with the Lightning aesthetic. It also enhances performance and scalability.

This help article outlines the required configurations for the Gantt Lightning Web Component (LWC).

Please Note:

You must be a Salesforce System Administrator to complete the steps below.

• Complete Inspire Planner Post-Install Instructions
• Grant Access to "Gantt Version" Field
• Grant Access to "Deactivated Dependencies" Field
• Grant Access to "LWC Settings" Field
• Add "Gantt Version" to Project Page Layout
• Add "Gantt Version" to Project Lightning Page
• Add the Gantt LWC to the Project Lightning Page
• Add "Deactivated Dependencies" Field to Project Task Page Layout
• Implement the New Project Schedule Action
• Install the Inspire Planner Gantt LWC Conversion Toolkit
• Assign the "Inspire Planner - Gantt LWC Conversion Toolkit" Permission Set
• Add "Violation Detected" to Project Task Field Set
• Add "Assign Constraints Script" Action to Project Page Layout

Complete the Inspire Planner Post-Install Instructions

If you have not done so yet, it is highly recommended that you first go through and complete the post-install instructions for Inspire Planner.

Please see Inspire Planner Post-install Instructions.

Grant Access to "Gantt Version" Field

A new field called “Gantt Version” has been added to the Project object. The value in this field determines which version of the Gantt to display when you open a project. You will need to make sure that your users have read and write access to this field.

Please Note:

Gantt Version field defaults to a blank value. When this field is blank or has a value of "Visualforce", then it will display Gantt Visualforce.

The following permission sets that come out-of-the-box with Inspire Planner already include access to this field:

• Inspire Planner Standard User - v1.12 Permission Set
• Inspire Planner - Agile Project Management

If you are using custom permission sets, then you will need to edit them to enable access to this new field.

1. In Setup, enter "Permission Sets" in the Quick Find box and click on Permission Sets.
   
   
    
2. Click on your custom permission set. The image below is just an example.
   
   
    
3. Click on Object Settings.
   
   
    
4. Click on Projects.
   
   
    
5. Click on Edit.
   
   
    
6. Look for "Gantt Version" and enable Read and Edit Access. Click on Save when finished.
   
   
    
7. Repeat the steps above for all your custom permission sets.

Grant Access to "Deactivated Dependencies" Field

A new field called “Deactivated Dependencies” has been added to the Project Task object. When you make an adjustment to project task dates that violate a constraint, the constraint violation dialogue displays the option to deactivate the dependency. When the user chooses to deactivate the dependency, the Predecessor field keeps the value, and the same value is populated in “Deactivated dependencies” field. This means that any adjustments made to the predecessor task(s) no longer impact the successor task(s).

The following permission sets that come out-of-the-box with Inspire Planner already include access to this field: 

• Inspire Planner Standard User - v1.12 Permission Set
• Inspire Planner - Agile Project Management
   

If you are using custom permission sets, you will need to edit them to enable access to this new field.

1. In Setup, enter "Permission Sets" in the Quick Find box and click on Permission Sets.
   
   
    
2. Click on your custom permission set. The image below is just an example.
   
   
    
3. Click on Object Settings.
   
   
    
4. Click on Project Tasks.
   
   
    
5. Click on Edit.
   
   
    
6. Look for "Deactivated dependencies" and enable Read and Edit Access. Click on Save when finished.
   
   
    
7. Repeat the steps above for all your custom permission sets.

Grant Access to "LWC Settings" Field

A new field called “LWC Settings” has been added to the User Project Settings object. This is where Inspire Planner stores the user’s viewing preferences (columns, column widths, column order, etc.) for a project for the Gantt LWC.

The following permission sets that come out-of-the-box with Inspire Planner already include access to this field:

• Inspire Planner Standard User – v1.12 Permission Set
• Inspire Planner – Agile Project Management

If you are using custom permission sets, you will need to edit them to enable access to this new field.

1. In Setup, enter "Permission Sets" in the Quick Find box and click on Permission Sets.
   
   
    
2. Click on your custom permission set. The image below is just an example.
   
   
    
3. Click on Object Settings.
   
   
    
4. Click on User Project Settings.
   
   
    
5. Click on Edit.
   
   
    
6. Look for "LWC Settings" and enable Read and Edit Access. Click on Save when finished.
   
   
    
7. Repeat the steps above for all your custom permission sets.

Add "Gantt Version" to Project Page Layout

Next, you will need to add the "Gantt Version" field to the project page layout you use for waterfall projects.

Please Note:

Gantt Version field defaults to a blank value. When this field is blank or has a value of "Visualforce", then it will display Gantt Visualforce.

1. In Setup, go to Object Manager.
   
   
    
2. Enter "Project" in the Quick Find box and click on Project.
   
   
    
3. Go to Page Layouts. Click on the page layout you are using for waterfall projects. The image below is just an example.
   
   
    
4. From the list of available fields, drag “Gantt Version” to your desired area on the page. Click on Save when finished.
   
   
    
5. If you use record types for Projects, repeat the steps above for all the page layouts you use for waterfall projects.

Add "Gantt Version" to Project Lightning Page

You will also need to add the “Gantt Version” field to your Project Lightning record page if you are using Dynamic Forms.

Please Note:

If you are using record types for Projects, you can skip this step. Click here to move to the next step.

1. In Project object, go to Lightning Record Pages.
   
   
    
2. Click on the Lightning Record Page you are using. If you would like to use the out-of-the-box Project Lightning record pages that came with Inspire Planner, you will need to clone them first so that you can edit the clone to add the field.
   
   The image below is just an example.
   
   
    
3. Click on Edit.
   
   
    
4. Next, click on the Details tab.
   
   
    
5. Click on Fields in the panel on the left and drag "Gantt Version" to your desired area on the details page.
   
   
    
6. Then, click on Save. If you haven't activated the page, you will also need to activate it.

Add the Gantt LWC to the Project Lightning Page

The Project Lightning record pages that come out-of-the-box with Inspire Planner already contain the Gantt LWC. However, if you are using a custom Project Lightning Record page, you will need to add the Gantt LWC to the page and also set the component visibility.

1. Click on the Project Lightning record page you are using. The image below is just an example.
   
   
    
2. Click on Edit.
   
   
    
3. Under Components on the left, scroll down to Custom - Managed and look for "Inspire - Project Gantt LWC". This is the Gantt Lightning Web Component (LWC).
   
   
    
4. Drag "Inspire - Project Gantt LWC" in the "Schedule" Tab. You can drag it above or below the existing Gantt VisualForce page.
   
   
    
5. Next, you will need to set the component visibility so that it displays the version of the Gantt (LWC or VisualForce) based on the value in "Gantt Version". 
   
   Click on the legacy Gantt VisualForce page to select it. 
    

   Please Note the following:

   Gantt Version field defaults to a blank value. When this field is blank or has a value of "Visualforce", then it will display Gantt Visualforce.
   
   It is important to apply component visibility so that only 1 version of Gantt is displayed - either Visualforce or LWC. Due to the auto save function, having both components displayed at the same time will cause conflicts. 

   
   
   
    
6. After you click on it, in the panel on the right, it should say "Page > Visualforce". Click on Add Filter under Set Component Visibility. 
   
   
    
7. Set the following values:
   
   Field = Gantt Version
   Operator = Not Equal
   Value = LWC
   
   This means that it will check the value in Gantt Version field in the project detail. If it is not "LWC", then it will display the legacy Gantt VisualForce page.
   
   Click on Done.
   
   
    
8. Next, click on the Gantt LWC to select it.
   
   
    
9. After you click on it, in the panel on the right, it should say "Page > Inspire - Project Gantt LWC". Click on Add Filter under Set Component Visibility. 
   
   
    
10. Set the following values:
    
    Field = Gantt Version
    Operator = Equal
    Value = LWC
    
    This means that it will check the value in the Gantt Version field in the project detail. If it is "LWC", it will display the Gantt Lightning Web Component (LWC).
    
    Click on Done.
    
    
     
11. Click on Save when finished. If you haven't activated the Project Lightning record page, you will also need to activate it.

Add "Deactivated Dependencies" Field to Project Task Page Layout

A new field called “Deactivated Dependencies” has been added to the Project Task object. When you make an adjustment to project task dates that violate a constraint, the constraint violation dialogue displays the option to deactivate the dependency. When the user chooses to deactivate the dependency, the Predecessor field keeps the value, and the same value is populated in “Deactivated dependencies” field. This means that any adjustments made to the predecessor task(s) no longer impact the successor task(s).

1. In Setup, go to Object Manager.
   
   
    
2. Enter "Task" in the Quick Find box and go to Project Task.
   
   
    
3. Click on Page Layouts. Then, click on the page layout you are using (the image below is just an example).
   
   
    
4. From the list of fields on top, drag "Deactivated Dependencies" to your desired area on the page and click on Save.
   
   

Implement the New Project Schedule Action

With the introduction of Gantt LWC, we're excited to announce a new Project Schedule action button designed specifically to support the transition from the Gantt Visualforce component to the Gantt Lightning Web Component (LWC). This button facilitates a seamless transition by supporting both Gantt Visualforce and Gantt LWC projects. It determines which component to display based on the Gantt Version field, enabling a smooth conversion for all projects.
 

1. Update Page Layouts: Transition your project page layouts by replacing the legacy Project Schedule Action button with the new Project Schedule LWC action. This update is crucial for moving forward with the LWC component.
    
2. Clear Communication: Inform your team about the introduction of the new Project Schedule LWC action and the importance of the Gantt Version field. Understanding these changes is vital for a smooth transition and maximizing the benefits of the LWC component.
    
3. Utilize the Admin Guide: For detailed guidance on updating the Gantt Version field and incorporating the new Project Schedule LWC action into your project layouts, refer to the Admin Guide - Add Project Schedule LWC Action.

Install the Gantt LWC Conversion Toolkit

The Gantt LWC Conversion Toolkit includes a permission set and apex classes that support your validation and conversion of Gantt Visualforce projects to Gantt LWC. It is available as a separate package you will need to install in your Salesforce org.

Please Note:

• If you are using a custom domain link to log in to Salesforce, you will need to log in via your custom domain first before clicking on the link below to install.
   
• When installing the Gantt LWC Conversion Toolkit, install it for Admins Only. 

Whether you are installing the Gantt LWC Coversion Toolkit for the first time, or already have it installed, you will need to click on the link below to either install the Gantt LWC Conversion Toolkit or update it to the latest version (version last updated with JUN 2024 - Maintenance 2, released on Sept 16, 2024).

Use this link to install or update the Gantt LWC Conversion Toolkit in your Salesforce Production Org:

https://login.salesforce.com/packaging/installPackage.apexp?p0=04tbn000000mtAH&isdtp=p1

Use this link to install or update the Gantt LWC Conversion Toolkit in your Salesforce Sandbox Environment:

https://test.salesforce.com/packaging/installPackage.apexp?p0=04tbn000000mtAH&isdtp=p1

Assign "Inspire Planner - Gantt LWC Conversion Toolkit" Permission Set

This permission set grants users access to fields and apex classes that support your validation and conversion of projects from Gantt Visualforce to Gantt LWC. 

1. In Setup, enter "Permission Set" in the Quick Find box and go to Permission Sets.
   
   
    
2. Click on "Inspire Planner - Gantt LWC Conversion Toolkit".
   
   
    
3. Click on Manage Assignments on top.
   
   
    
4. Click on Add Assignment icon in the top right corner.
   
   
    
5. Select the users you would like to assign the permission set to, and then click on Next.
    

   Please Note:

   Assign this permission set to all Inspire Planner users.

   
   
    
6. Review the list of users and click on Assign.
   
   

Add "Violation Detected" to Project Task Field Set

This field is used to identify tasks that have been manually rescheduled to start before its predecessor. You will need to add this field to the Gantt UI as a column so that users are able to see it when they open projects.

1. In Setup, go to Object Manager.
   
   
    
2. Enter "Task" in the Quick Find box and click on Project Task.
   
   
    
3. Go to Field Sets and click on Inspire Planner Custom Fields.
   
   
    
4. From the list of available fields, drag "Violation Detected" into the box labeled "In the Field Set". Then, click on Save.
   
   

Add "Assign Constraints Script" and "Predecessor Violation Script" Action to Project Page Layout

You will need to add the "Assign Constraints Script (Admin Only)" and "Predecessor Violation Script (Admin Only)" actions to your project page layout.

The "Assign Constraints Script" runs a job that automatically populates a Start-no-earlier-than constraint for all tasks without predecessors or where the task has been manually rescheduled to start later than its predecessor, and where the task does not have a constraint.  This prevents it from being rescheduled according to its dependency when the project is converted from Gantt Visualforce to Gantt LWC.

The "Predecessor Violation Script" identifies tasks that have been manually rescheduled to start before its predecessor and set the "Violation detected" field to TRUE. You can then review these tasks and manually correct them by either adding a Must-start-on Constraint or by adding a negative lag.

1. In Setup, go to Object Manager.
   
   
    
2. Enter "Project" in the Quick Find box and click on Project.
   
   
    
3. Go to Page Layouts and click on the project page layout you are using for waterfall projects. The image below is just an example.
   
   
    
4. Click on Mobile & Lightning Actions. Then drag "Assign Constraints Script (Admin Only)" and "Predecessor Violation Script (Admin Only)" to the section labeled "Salesforce Mobile and Lightning Experience Actions". Then, click on Save.
   
   
   
   **If you are using record types for projects, you will need to repeat the steps above and add the "Assign Constraints Script (Admin Only)" and "Predecessor Violation Script (Admin Only) actions to all your page layouts for waterfall projects.