Work Trail Admin Guide

Installation

Setup Instructions:

1. Add the “Work Trail Notes and Tasks” LWC to a record detail page via the lightning app builder interface. This can be done for any standard or custom object.

1. 1. Optional Lightning web component properties
      
       
      1. Pinned Note Columns Per Row: The number of notes that will display in a single row in the pinned notes section. If the component is positioned in an area that is narrow it is suggested to set this to 1.
      2. Regular Note Columns Per Row: The number of notes that will display in a single row in the regular notes section. If the component is positioned in an area that is narrow it is suggested to set this to 1.
      3. Maximum Note Body Height (In Pixels): The maximum height in pixels that the body section of the note component should expand to. When the text expands beyond the maximum height a scroll bar will appear. If this is set to a blank value there will be no maximum height.

   2. Additional optional configuration may be done on the ‘Work Trail Configuration’ tab.

   1. To create a set of tasks that display on the “Work Trail Notes and Tasks” LWC click the “Task Set Configuration” panel.
      

1. 1. 1. Click the “New” button.
      2. Fill out a task set name, and select the object that you’ve added the “Work Trail Notes and Tasks” LWC to.
      3. Fill out the tasks that you’d like to display on the record. You may click the “Add Task” button to add additional tasks.
      4. (Optional) Click the “Add Task Display Criteria” to define the criteria that a record should meet to display the set of tasks. If you would like the set of tasks to display for all records of the selected object you may skip this step.
      5. Click the “Save” button.
      6. View a record and click the “Tasks” tab at the top of the “Work Trail Notes and Tasks” LWC to confirm the set of defined tasks are displayed.
   2. To display notes from child objects at a parent object level, click the “Note Object Configuration” panel.

1. 1. 1. Click the “New” button.
      2. Select the parent object that you’d like notes from child objects to display on.
      3. Then select the child objects whose notes should also display at the parent object level.
      4. Once all the child objects have been selected click the “Save” button.
      C. If you’d like to set default note background colors or add note statuses to notes of a particular type click the “Note Defaults Configuration” panel.
      
      
      
      1. Select a note type.
      2. Set the default note color, or add note statuses (separated by a comma ex: open, closed, WIP).
      3. Add additional configurations by clicking the “Add Note Config” button.
      4. Once all default configs are added click the “Save” button. 

3. Customize the note types that are available when users create notes.

1. 1. Go to setup and search for ‘Picklist Value Sets’
   2. Find the ‘Note Types’ global value set and click on it.
   3. In the ‘Values’ section you may add or remove any note type you’d like.
      
      

End User Instructions:

1. Note Component:
   1. When viewing the “Work Trail Notes and Tasks” component the default tab selected should be the Notes tab.

1. 1. 1. Click the “Create Note” button to create a note.
         1. Select the Note Type
         2. Select the Read/Write mode
         3. (Optional) select the Note Background Color
         4. Populate the note body with the desired information
         5. Click the “Log Note” button. 

                 II.  After a note is created you will see the following buttons in the top right corner of the note.

1. 1. 1. 1. From left to right the buttons are Pin, Tag, Edit, Comment, and Delete.
            1. Pin: allows you to pin notes so that they will display at the top of the note component in the pinned section. 
            2. Tag: allows you to tag notes with topics or users to easily distinguish what the note relates to.
            3. Edit: Allows you to modify a note after it has been created.
            4. Comment: allows you to comment on a note.
            5. Delete: allows you to delete a note.
2. Task Component:
   1. To the right of the “Notes” tab you can see the “Tasks” tab.
      
   
    
   1. 1. Simply click on the tasks tab to see a set of tasks that should be completed for a given record (If configured in the Task Set Configuration).
         1. When viewing the tasks you can see a slider that you may use to mark a task complete.
         2. To the right of the task you can see a “Log Note” button that will allow you to log a note for a specific task.