27
Copyright©2017 enigtrax Technical & User Documentation Author: Enigtrax

Technical & User Documentation - appexchange.salesforce.com

  • Upload
    others

  • View
    8

  • Download
    0

Embed Size (px)

Citation preview

Page 1: Technical & User Documentation - appexchange.salesforce.com

Copyright©2017 enigtrax

Technical & User Documentation Author: Enigtrax

Page 2: Technical & User Documentation - appexchange.salesforce.com

Copyright©2017 enigtrax

Contents Overview .......................................................................................................................................... 1

Installing the Trainodize Application ............................................................................................. 2

Technical Aspects of the Trainodize Application ......................................................................... 5

Trainodize Application Schema ................................................................................................. 5

Editions Supported ..................................................................................................................... 5

Package Type ............................................................................................................................. 5

Salesforce Version ...................................................................................................................... 5

Application Components ............................................................................................................ 6

Training Object ........................................................................................................................ 6

Attendance Object ................................................................................................................ 10

Customisation & Configuration .................................................................................................... 12

Fields.......................................................................................................................................... 12

Profile Settings .......................................................................................................................... 12

Page Layouts ............................................................................................................................ 12

Tabs ........................................................................................................................................... 12

Reports ...................................................................................................................................... 13

User Guide to the Trainodize Application ................................................................................... 14

Setting up a new Training Session .......................................................................................... 14

Notes & Attachments Related List ........................................................................................... 16

Adding Attendees to a Training Session ................................................................................. 16

Adding Attendees to the Waiting list ....................................................................................... 18

To add a person to a training session if they are on the waiting list ..................................... 18

Mass Import Attendees to a Web Training Session ............................................................... 19

Mass Updating Attendees Training Session. ......................................................................... 19

Training Session Statistics ....................................................................................................... 20

Cancelling a Training Session ................................................................................................. 20

Completing a Training Session ................................................................................................ 21

Reports ...................................................................................................................................... 22

Tips for Running Reports ......................................................................................................... 23

Adding Additional Functionality to the Application ..................................................................... 24

Contact Details .............................................................................................................................. 25

Page 3: Technical & User Documentation - appexchange.salesforce.com

1

Copyright©2017 enigtrax

Overview

The Trainodize application is designed to be a tool that System Administrators can use to

organise and manage Salesforce training within their organisation.

The application will enable System Administrators:

Add functionality to promote training opportunities within the organisation via Chatter

and send emails to users regarding their status on training sessions.

Allows the tracking of responses from users regarding training sessions.

The application allows the customisation of field values, to tailor the application to

meet the organisation needs.

Provides reports on the users of Salesforce within their organisation in relation to

what training they have undertaken.

Enable the System Administrator to easily compile attendance reports for training

sessions to facilitate the organisation of the training session.

Page 4: Technical & User Documentation - appexchange.salesforce.com

2

Copyright©2017 enigtrax

Installing the Trainodize Application

1) Go to the Salesforce App Exchange - https://appexchange.salesforce.com/

2) Click on the ‘Login In’ button to the Salesforce app exchange button and enter you

Salesforce credentials.

3) Locate the Trainodize App and Click on the ‘Get It Now’ button.

4) Select where to install the application in production or a sandbox.

5) Check the agreement box and click the ‘Confirm & Install button’.

Page 5: Technical & User Documentation - appexchange.salesforce.com

3

Copyright©2017 enigtrax

6) Enter your Salesforce Credentials

7) When prompted:

a) Select Rename conflicting components in package

b) Select the ‘Install for Admins’ Only checkbox

Page 6: Technical & User Documentation - appexchange.salesforce.com

4

Copyright©2017 enigtrax

8) Click on the Install button

9) An email will be sent to your inbox when the installation is completed.

10) Click on the ‘Setup’ Link in the top right hand corner of the Salesforce org & select

the ‘Installed packages’ link in the setup Administration area on the left hand side of

the screen. The Trainodize package will be installed in the org.

Page 7: Technical & User Documentation - appexchange.salesforce.com

5

Copyright©2017 enigtrax

Technical Aspects of the Trainodize Application

Trainodize Application Schema

The following diagram highlights the relationships between the different objects used in this

application.

Key:

M/L – master detail relationship

L/U – lookup relationship

Editions Supported

All editions of Salesforce can use the Trainodize application.

Package Type

Managed

Salesforce Version

Trainodize is both Salesforce Classic and Lightning compliant

Training Users

Attendance

M/D

L/U

Page 8: Technical & User Documentation - appexchange.salesforce.com

6

Copyright©2017 enigtrax

Application Components

The application has the following components:

2 Objects

20 Custom Fields

1 Tab

2 Page Layouts

1 Report Types

14 Validation Rules

Training Object

Custom Tab

Training

Standard Fields

Field Label Field Name Data Type

CreatedBy CreatedBy Lookup(User)

Last Modified By LastModifiedBy Lookup(User)

Owner Owner Lookup(User,Queue)

Training Session Name Name Text(80)

Custom Fields & Relationships

Field Label API Name Data Type

Attended Attended__c Roll-Up Summary (COUNT Attendance)

Audience Audience__c Picklist

Confirmed Confirmed__c Roll-Up Summary (COUNT Attendance)

Declined Declined__c Roll-Up Summary (COUNT Attendance)

End Time End_Time__c Date/Time

Level Level__c Picklist

Location Location__c Picklist

Not

Attended

Not_Attended__c Roll-Up Summary (COUNT Attendance)

Notes Notes__c Text Area(255)

Page 9: Technical & User Documentation - appexchange.salesforce.com

7

Copyright©2017 enigtrax

Training

Places

Remaining

Training_Places_

Remaining__c

Formula (Text)

Start Time Start_Time__c Date/Time

Status Status__c Picklist

Topic Topic__c Picklist

Training

Places

Training_Places__

c

Number(8, 0)

Training

Type

Training_Type__c Picklist

Waiting List Waiting_List__c Roll-Up Summary (COUNT Attendance)

Validation Rules

Rule Name Error

Location

Code Error Message

add_attendance_when_session_co

mplete

Top of

Page

and(

or(

ispickval( Status__c

,"Active"),

ispickval( Status__c

,"Cancelled")),

or(

Not_Attended__c >0,

Attended__c >0))

You can only

add an

attendance to

the user record

after the

training session

has been

delivered and

the training

session has a

status of

"Completed"

class_location_not_null_or_web_tra

ining

Location And(

ispickval(Training_Type

__c,"Classroom"),

or(

ISBLANK(

text(Location__c )),

ispickval( Location__c

,"N/A - Web Training")))

You need to

enter a location

for a classroom

based Training

Session

Page 10: Technical & User Documentation - appexchange.salesforce.com

8

Copyright©2017 enigtrax

End_date_greater_than_start_date End Time End_Time__c <=

Start_Time__c

The end date /

time needs to

be greater than

the start time /

date of this

training session

location_web_training_validation_ru

le

Location and(

ispickval(

Training_Type__c

,"Web"),

not(ispickval(

Location__c ,"N/A -

Web Training"))

)

Please select

N/A - Web

Training for the

location when

entering a new

Web training

session

need_a_audience_for_a_classroom

_training

Audience and(

or(

ispickval(

Training_Type__c

,"Classroom"),ispickval(

Training_Type__c

,"Web")),

ISBLANK( text(

Audience__c )) )

You need to

enter an

audience for a

classroom

based training

session

need_a_level_for_a_training_se Level and(

or(

ispickval(

Training_Type__c

,"Classroom"),ispickval(

Training_Type__c

,"Web")),

ISBLANK( text(

Level__c )) )

You need to

enter a level for

this training

session

need_to_select_a_topic Topic ISPICKVAL( Topic__c ,"")

Please select a topic area for this training session

Page 11: Technical & User Documentation - appexchange.salesforce.com

9

Copyright©2017 enigtrax

need_to_select_a_type_of_training

_course

Training

Type

isblank(

text(Training_Type__c

))

Please select a

type of training

course

number_of_places_blank_web_cou

rse

Training

Places

and(

ispickval(

Training_Type__c

,"Web"),

not(isblank(

Training_Places__c )))

You do not

need to enter a

value in this

field when a

web training

course has

been selected

number_of_places_not_exceeded Top of

Page

And(

ispickval(IM666__Traini

ng_Type__c,"Classroo

m") ,

value(IM666__Training

_Places_Remaining__c

) < 0

)

The number of

places on this

course has

already been

filled. Please

add this user to

the waiting list

for this training

course.

valid_number_of_places Training

Places

and(

ispickval(

Training_Type__c

,"Classroom"),

or(

ISBLANK(

Training_Places__c ),

Training_Places__c <=

0))

You need to

enter the

number of

places

available on a

classroom

training session

waiting_list_val_not_for_web_sessi

on

Top of

Page

and(

ISPICKVAL(

Training_Type__c

,"Web") ,

Waiting_list__c > 0)

You do not

need to add

someone to a

Waiting List for

a Web Training

session. Please

select another

course status.

Page 12: Technical & User Documentation - appexchange.salesforce.com

10

Copyright©2017 enigtrax

Page Layouts

Training_Session Layout

Attendance Object

Standard Fields

Field Label Field Name Data Type Indexed

Attendance Name Name Auto Number

Created By CreatedBy Lookup(User)

Last Modified By LastModifiedBy Lookup(User)

Custom Fields & Relationships

Field Label API Name Data Type Indexed

Attendance_Status Attendance_Status__c Picklist

Course_Status Course_Status__c Picklist

Training_Session Training_Session__c Master-Detail(Training)

User User__c Lookup(User)

Note: There is a filter on the user look up field to only show active users in the Salesforce

platform.

Validation Rules

Rule Name Error

Location

Code Error Message

need_to_selct_a_course_status Course_Status isblank(Text(

Course_Status__c ))

Please select a

course status for

this attendee on

this training

session

need_to_select_a_user User isblank( User__c ) You need to

select a user to

attend a course

Page 14: Technical & User Documentation - appexchange.salesforce.com

12

Copyright©2017 enigtrax

Customisation & Configuration

Fields

The values in some fields can be modified and customised to meet the needs of the

organisation.

The fields that can be edited in regard to the details of the training session are:

Location: Location the training is to take place. Note: N/A – Web Training value should not

be deleted from this list as it is a required value for when a web based training session is to

be organised. Add values to this field accordingly to meet organisational requirments.

Level: The level the training session is aimed at. Current values available are Basic,

Intermediate and Advanced.

Audience: Target Audience for the training session. Current values available are All Staff

and Super Users.

Topic: The subject area relating to the name of the training session.

Profile Settings

These are the profile settings suggested for System Administrators only organising and

managing training events within an organisation.

The System administrator profile needs to have full read / write access on the training and

attendance objects.

All other profiles should have no access to these objects.

Page Layouts

The page layout Training_Session Layout should only be assigned to the system

administrator profile only.

Tabs

The Tab called Training should be added to your System Administrator App or main tab

menu.

Page 15: Technical & User Documentation - appexchange.salesforce.com

13

Copyright©2017 enigtrax

Reports

The application comes with a custom report types:

Training Report

Training Report: This report can be used as a method of compiling an attendance list for a

particular training session and analysis of training sessions that are run by the Salesforce

Team within an organisation.

Page 16: Technical & User Documentation - appexchange.salesforce.com

14

Copyright©2017 enigtrax

User Guide to the Trainodize Application

Setting up a new Training Session

Click on the Training Tab

Click on the new button

Enter the following information:

1) Enter a name for the training session

1

3

5

7

9

2

4

6

8

10

12

11

Page 17: Technical & User Documentation - appexchange.salesforce.com

15

Copyright©2017 enigtrax

2) Enter a topic area that the training session relates to.

3) Select a level for the Training course. Current options are Basic, Intermediate,

Advanced.

4) Select a training Type. The 2 options are Web & Classroom.

5) Select the Audience for the Training session.

6) Default value for status is Active. Other options are Cancelled & Completed.

Note: Do not delete the ‘completed’ option otherwise validation rules will be affected.

7) Select a location for the training session. If the training type is Web select the “N/A –

Web Training” value otherwise for a classroom based training session select a

location for the training session.

8) Select a start time and date for the training session.

9) Select an end time and date for the training session. The end time / date needs to be

greater than the start time and date field.

10) If the training type selected is Web then you do not need to enter a value for this

field. If a classroom type training session is selected enter the number of places that

are available for the training session.

11) Add any notes that you need regarding this training session.

12) Click the save button to save the details of the training session.

Notes:

You need to resolve any errors before a record can be saved to Salesforce.

Depending on whether you choose a web or classroom based training session

depends on what fields and values need to populated. The table below outlines the

values required in each case:

Page 18: Technical & User Documentation - appexchange.salesforce.com

16

Copyright©2017 enigtrax

Field Name Training Type

Classroom Web

Training Session Name

Required Required

Topic Required Required

Level Required Required

Audience Required Required

Status Active Active

Location Required – Select Location

Required –“ N/A – Web Training”

Start Time Required Required

End Time Required Required

Training Places Required – Enter the number of places available on the course

Not Required – Leave blank

Notes Optional Optional

One – One Training: Sometimes an Administrator has to undertake training at a

user’s desk. To record this on the application regard this as a classroom training

session and add the user to the training session as before to document the training

session.

Notes & Attachments Related List

Use the Notes and Attachments related list to add any training material regarding the training

session.

Adding Attendees to a Training Session

1) Click on the New Attendance button

1

Page 19: Technical & User Documentation - appexchange.salesforce.com

17

Copyright©2017 enigtrax

2) Click on the look up button and select a Salesforce user to add to the training

session.

3) Select a course status. The values available are Declined, Confirmed and Waiting

list.

Note: Do not delete or edit the options supplied otherwise validation rules, roll up

summary fields and formula fields will be affected.

The ‘Waiting list’ option is not available for web training sessions.

4) The Attendance status can be added later after the training session has been

completed to record who attended and did not attend the event.

Note: The training session status needs to be changed to “Completed” before an

attendance status can be added to a user record.

Do not delete or edit the options supplied otherwise validation rules and roll up

summary fields will be affected.

5) This is the training session the user will be added to.

Note: To return to the main training click on this link when you have completed adding the

user / users to the training session.

6) Click on save to save the details for the user attending the training session or ‘Save

& New’ to add additional attendees.

The user(s) will now be added to the attendance related list.

Note: The attendance list is ordered in ascending order by username.

2

4

3

5

6

Page 20: Technical & User Documentation - appexchange.salesforce.com

18

Copyright©2017 enigtrax

Adding Attendees to the Waiting list

If you try and add a user to a training session when there are no more places available the

following error message will occur.

In this case you can add this user to the waiting list by selecting the Waiting list value in the

course status field.

The user will then be added to the waiting list for this training session.

You can see when they were added to the waiting list by using the created or last modified

date. Users can then be in a queue for places for training session should a place become

available for the training session.

To add a person to a training session if they are on the waiting list

1) Change the course status of the person who cannot attend the training session to

Declined.

2) Select the user on the waiting list to be added to the training session and change

their course status to Confirmed.

3) Save the record. The user has now been added to the training session.

Page 21: Technical & User Documentation - appexchange.salesforce.com

19

Copyright©2017 enigtrax

Mass Import Attendees to a Web Training Session

For Web Training Sessions it may be easier to mass import attendees.

To undertake this process:

1) Create a Web Training Session.

2) Run a User Report in Salesforce and export all active users information making sure

the user id field is included in the document.

3) Document the course status of the users e.g. Confirmed or Declined.

4) Create an import file mapping the following database fields with the relevant

information:

User: User ID

Course status: Declined or Confirmed

Training: Training ID

5) You can now use the Data Import tool or a 3rd Party application like Dataloader to

import the attendees to that Training session.

Mass Updating Attendees Training Session.

To mass update the Attendance Status of users after a training session has been completed:

1) Run a Training Report for a training session (See Report section of this

documentation) and included the attendance id field in the export file.

2) Create a file, mapping the following database fields with the relevant information:

Attendance id: Attendance id

Attendance Status: Attended or Not Attended

3) Make sure the Training session status is set to ‘Completed’.

Page 22: Technical & User Documentation - appexchange.salesforce.com

20

Copyright©2017 enigtrax

4) Use the Data Import Wizard or Dataloader to update the status of the training

session.

Training Session Statistics

The training session statistics will automatically be updated depending on the statuses of the

attendees for that training session.

Cancelling a Training Session

1) Select the training Session you wish to Cancel

2) Click on the Edit Button

3) Select Cancelled from the Status field

4) Click on Save

2

3

1

Page 23: Technical & User Documentation - appexchange.salesforce.com

21

Copyright©2017 enigtrax

The training session has now been cancelled and will trigger a post to chatter to notify user

of the training session being cancelled.

Completing a Training Session

1) Select the training Session you wish to Complete

2) Click on the Edit Button

3) Select Completed from the Status field

4) Click on Save

3

4

2

1

4

Page 24: Technical & User Documentation - appexchange.salesforce.com

22

Copyright©2017 enigtrax

Reports

To select a report relating to training

1) Click on the New Report button

2) Open the Other Reports folder

3) Select the Training Report

4) Click on the Create button

You can modify the training reports based on your own requirements.

3

4

1

2

Page 25: Technical & User Documentation - appexchange.salesforce.com

23

Copyright©2017 enigtrax

Tips for Running Reports

Here are few starter tips when running the reports for training sessions:

Training Report

1) To create an attendance list for a particular training session:

Set the following fields as below:

Show: All training

Created Date : All time

Training Session Name equals {Insert Training Name}

You can add additional fields to the report where necessary e.g. attendance id

2) To create a report showing all the training sessions a user has attended:

Set the following fields as below:

Show: All training

Create a summary report by User: Full Name

Page 26: Technical & User Documentation - appexchange.salesforce.com

24

Copyright©2017 enigtrax

Adding Additional Functionality to the Application

Using process builder you can add additional functionality to the application.

Suggestions to develop the application are:

1) Post a tailored chatter post to a chatter group about training based on the status of

the training session e.g. Active, Completed, Cancelled or if there are changes to the

details of the training session based on the type of training session e.g. Web or

Classroom.

2) Sending an automated tailored email response to a user based on the user’s status

for a training session e.g. Confirmed, Declined, or on the Waiting list.

Note:

These were not introduced as;

1) The application is designed to be used for all editions of Salesforce.

2) In managed packages processes are not allowed to be edited.

If you require assistance implementing this functionality into your org then see the Trainodize

Processes documentation or please feel free to contact the administrator who developed the

application.

Page 27: Technical & User Documentation - appexchange.salesforce.com

25

Copyright©2017 enigtrax

Contact Details

If you wish to contact the Salesforce Administrator who created the application please use

the following contact details:

Email: [email protected]