Skip to content

Installation

Ethan Dunzer edited this page May 26, 2024 · 6 revisions

To install the ScheduledMaintenanceComponent into a developer org, follow these steps:

1. Clone the Repository:

git clone https://github.com/your-repo/scheduled-maintenance-component.git
cd scheduled-maintenance-component

2. Authorize Your Salesforce Org in vscode:

sfdx force:auth:web:login -a DevOrg

3. Modify LWC Components:

  • Before deploying you will want to change the developerName value in the scheduledMainteanceComponent.js file to the developer name of the app you want to default users to. Located on line 136.
  • Then you will also want to change the button label in the scheduledMaintenanecComponent.html file to that apps name. Located on line 61.

5. Deploy Project to ORG:

sf project deploy start -d force-app

6. Assign Permission Sets:

  • Navigate to Setup > Permission Sets
  • Find Object - Scheduled Maintenance - Level 1 and assign that permission to every user you want to see the alert.
  • Find Object - Scheduled Maintenance - Level 6 and assign to any admin or user you want to have control over this components record based functionality.

7. Add the Component to a Lightning Page:

  • Navigate to an existing lighting page or create a new one.
  • Drag and drop the ScheduledMaintenanceComponent onto the page.
  • Add an App context value if applicable to the lighting page.
  • Save the page.

8. Change Applicable Apps values:

  • Navigate to Setup > Objects > Scheduled Maintenance
  • Go to Fields and select Applicable Apps
  • Add/Remove the values that are applicable to your ORG. Do Not Remove 'System' unless you dont want to use that functionality

You have now successfully installed and configured the ScheduledMaintenanceComponent in your Salesforce developer org. Now all you have to do is add the object tab to a app of your choice and start creating records.