Home    Forums    Feature Requests    Beta Issues    SysAid Resources    Documentation    Support
Hello Guest,  Login   
        
DOWNLOAD FREE EDITION
    
     Recent Topics    Hottest Topics    Online Members    Member Listing    Advanced Search
Custom Notifications  XML
Forum Index » Online Aid
 
Author Message
sivanm
SysAid Product Manager


Joined: 14/03/2010
Messages: 293
Offline

Customize

Customized Notifications

 

There are a number of events in SysAid that can trigger automatic notifications, such as creating a new administrator, assigning a task to an administrator, or when an end user submits a new service record. This page allows you to edit the contents of these notifications.

 

From the Notification list, choose the notification you would like to edit. The page will refresh to show you the current contents of that notification, which you may then edit. Make sure to click Save after making any changes.

 

 

Using tags in your notifications

SysAid allows you to insert dynamic data into your notifications based upon the event that triggers the notification. An example would be including the status and category of a service record, or the title and progress towards completion for a task. Many of the notifications include tags in their default contents, but these are only a fraction of the tags that you have available to use. Please see the table below for a complete list of available tags.

 

"If" statements in your notifications

There may be times that you would like certain text to be added to a notification only if certain conditions are true. For instance, if a service record is sent when the helpdesk is closed, you can use the tag $isAfterHours in the following way:

#if( ${AfterHours} && ${AfterHours}==true && ${IsNewSr}==true)

The Helpdesk is not active at the moment. Your service record will be addressed during working hours.

#end

 

Please see the table below for a list of available variables for use in "If" statements.

 

Custom notifications in multiple languages

SysAid allows you to add language specific text to your notifications. That is to say, a user using SysAid in Spanish will receive Spanish text and a user using SysAid in English will receive English text. To add language specific text:

  1. Go to Preferences --> Account Defaults and uncheck the option Use the default language for automatic notifications.
  2. Download to your computer the SysAid translation file for the desired language. The translation file is located under Customize --> Translate.
  3. Open the translation file and scroll to the very bottom.
  4. Add a new key for each text that you want in your notifications. Each key should look like this:
  5. _custom.notif_keyname=Text that will appear in the notification

  6. Replace keyname with a unique name of your choosing.
  7. Replace Text that will appear in the notification with your desired text in the language of your choice.
  8. Example: _custom.notif_bday=Happy birthday!

  9. Repeat steps 1 - 4 for each language your users will be using.
  10. Example: You have English, Spanish, and Italian speaking end users. You must add each key and its appropriate translation to the English, Spanish, and Italian translation files. In the English translation file, you would put _custom.notif_bday=Happy birthday!, in the Spanish translation file you would put _custom.notif_bday=¡Feliz cumpleaños!, etc.

  11. In SysAid, go to Customize --> Notifications.
  12. Select from the dropdown list the notification to which you would like to add your new text.
  13. In the exact place you would like your text to appear, enter:
  14. $resource.getString("_custom.notif_keyname")

    Example: $resource.getString("_custom.notif_bday")

This will insert the text from the translation file for the language your user is using when the notification is sent.

 

Return to defaults

Click Return to Default to return the currently selected notification to the SysAid default.

Click Return All to Default to return all notifications to the SysAid defaults. Please use caution when selecting this option, as it will erase all changes you've made to all of the notifications.

 

 

List of all tags in custom notifications

In the table below is the full list of tags and their meaning in SysAid.

 

Tag ID Description
Tags For Use in Notifications Regarding Service Records
${ActionNotification} This is the action that caused the notification to be sent
${StatusNotification} This notifies the end user to which status the SR has been changed. Will appear blank in notification if status hasn't changed
${user} This is the administrator who the SR is assigned to. Displays the contents of the First Name and Last Name fields
${Title} This is the title of the service record
${ModifyUser} This is the last user to modify the service record
${Computer} This is the name of the asset attached to the service record
${assetUpdateTime} This is the last time the asset attached to the SR sent an inventory update to SysAid
${assetCompany} This is the company of the asset attached to the service record
${ParentID} This is SR# of the parent service record. Will only display if the service record generating the notification is a child SR
${Category} This is the top level category of the service record
${SubCategory} This is the sub category of the service record
${ThirdLevelCategory} This is the third level category of the service record
${CloseTime} This is the time the service record was closed
${CustDate1} Displays the contents of custom date field 1
${CustDate2} Displays the contents of custom date field 2
${Description} This is the service record's description
${DueDate} This is the full due date of the service record, including hour
${DueDateOnly} This is the date the service record is due
${ID} This is the service record number
${LinkToSurvey} Displays a link to fill out your survey for the service record. Recommended for use in conjunction with an "if" statement (see below) and the ${isClosedSR} tag
${SubmitTime} Time the service record was submitted
${Notes} Displays the contents of the notes field
${Priority} Shows the priority of the service record
${Urgency} Shows the urgency of the service record
${Status} Shows the status of the service record
${SrSubType} This is the sub type of the service record
${Resolution} Displays the contents of the resolution field
${Solution} Displays the contents of the solution field
${SubmitUser} This is the user who submitted the service record
${AssignedGroup} This is the group the service record has been assigned to
${ModifyTime} This is the time the service record was last modified
${Location} Shows the contents of the location field
${LinkToSR} Includes a direct link to the service record. For administrators only
${Escalation} Shows whether or not a service record is escalated
${RequestUser} Shows the request user's username
${ReqUser} Shows the request user's first name and last name
${Company} Shows the request user's company
${OrganizationName} The name of your organization as it's entered under Preferences --> Account Defaults
${Phone} Shows the request user's phone number
${Cellphone} Shows the request user's cellular phone number
${SMS} Show the request user's text message number
${SelfServicePortalURL} Inserts a link to the SysAid Server which can be used by end users to log in to the End User Portal
${CompanyPhone} Shows the phone number of the request user's company
${CompanyAddress} Shows the first line of the address for the request user's company
${CompanyAddress2} Shows the second line of the address for the request user's company
${AssignedTo} This is the administrator the service record is assigned to
${AssignedToFirstName} This is the first name of the administrator the service record is assigned to
${AssignedToLastName} This is the last name of the administrator the service record is assigned to
${user.getEmail()} Shows the e-mail address of the administrator the service record is assigned to
${ResponsibleAdmin} This is the service record's responsible admin
${ResponsibleAdminFirstName} This is the first name of the service record's responsible admin
${ResponsibleAdminLastName} This is the last name of the service record's responsible admin
${AccountTimeZone} Shows the default SysAid Server time zone
${ActivitiesNum} Displays the number of activities that have been logged on the SR
${ActivitiesTable} Displays the full contents of the activities table for the service record
${ActivitiesTotalMinutes} Displays the total time of all activities that have been logged on the SR
${custList1} Shows the contents of custom list 1 for this service record
${custList2} Shows the contents of custom list 2 for this service record
${OperatingTimesTable} Displays the list of operating times that apply to the current service record. Operating times are determined by SLA or by Company. If neither of these exists for the request user, then the default operating times are used.
${LinkToAttachments} Adds links to download any attachments attached to the service record
${Total_Active_Requests} Shows the total number of active SRs on the Service Desk
${Active_requests_for_assigned_admin} Shows the total number of active SRs on the Service Desk that are assigned to the same admin as this service record
${Department} Shows the request user's department
Boolean tags for use in "if" statements
${IsNewSr} Returns "true" if this is the new SR notification or "false" if this is an SR modified notification.
${AfterHours} Returns "true" if the notification is sent while the Service Desk is closed, or "false"if the notification is sent while the Service Desk is open. Based upon operating times.
${isClosedSR} Returns "true" if SR is closed or "false" if SR is open.
Special tags that grant access to SysAid Entities
${ReqUser} This allows you to poll any field related to the SR's request user, except for list fields. Note that you must use a special syntax with this tag: ${ReqUser.getXXXX()}. Replace getXXXX() with any any get method found in the User Table. Example to retrieve Car license: ${ReqUser.getCarNumber()}. Note that this will not work for list fields
${sr} This allows you to poll any field on the service record, except for list fields. Note that you must use a special syntax with this tag: ${sr.getXXXX()}. Replace getXXXX() with any any get method found in the service record table. Example to retrieve Followup Text: ${sr.getFollowupText()}. Note that this will not work for list fields
${asset} This allows you to poll any field on the asset attached to the service record, except for list fields. Note that you must use a special syntax with this tag: ${asset.getXXXX()}. Replace getXXXX() with any any get method found in the computer table. Example to retrieve asset model: ${asset.getSystemModel()}. Note that this will not work for list fields, and that there must be an asset attached to the SR
${ci} This allows you to poll any field on the CI attached to the service record, except for list fields. Note that you must use a special syntax with this tag: ${ci.getXXXX()}. Replace getXXXX() with any any get method found in the CI table. Example to retrieve CI name: ${ci.getCiName()}. Note that this will not work for list fields, and that there must be a CI attached to the SR
${resource} This allows you to insert a key from the translation file into your notification. This allows for notifications in multiple languages. Please see Custom notifications in multiple languages above for more information about using this tag
Tags For Use in Device Enrollment Notifications (MDM)
$UserName Displays the username of the user receiving the enrollment notification
$UserDisplayName Displays the name of the user receiving the enrollment notification as specified by the setting User name display method under Customize --> Appearance
$LoginUrl Displays the login URL for your SysAid Server
Tags For Use in Notifications Regarding Users Who Forgot Their Passwords
${NewPassword} This is the new password e-mailed to the end user
${LoginURL} This inserts a link to the login URL for your SysAid Server
${SelfServicePortalURL} This inserts a link to the login URL for your SysAid Server
${OrganizationName} The name of your organization as it's entered under Preferences --> Account Defaults
${firstName} First name of the end user who initiated the password reset
${lastName} Last name of the end user who initiated the password reset
${fullName} Full name of the end user who initiated the password reset
${resource} This allows you to insert a key from the translation file into your notification. This allows for notifications in multiple languages. Please see Custom notifications in multiple languages above for more information about using this tag
Tags For Use in Notifications to New Administrators and End Users
${Password} Password of the newly created user
${LoginUrl} This inserts a link to the login URL for your SysAid Server
${SelfServicePortalURL} This inserts a link to the login URL for your SysAid Server
${AccountID} This is the Account ID of your SysAid Server
${UserName} Username of the newly created user
${OrganizationName} The name of your organization as it's entered under Preferences --> Account Defaults
${firstName} First name of the newly created user
${lastName} Last name of the newly created user
${fullName} Full name of the newly created user
${user} This allows you to poll any field related to the new user, except for list fields. Note that you must use a special syntax with this tag: ${user.getXXXX()}. Replace getXXXX() with any any get method found in the User Table. Example to retrieve Car license: ${user.getCarNumber()}. Note that this will not work for list fields
${resource} This allows you to insert a key from the translation file into your notification. This allows for notifications in multiple languages. Please see Custom notifications in multiple languages above for more information about using this tag
Tags For Use in Notifications Sent to Project Managers
${ActionNotification} This is the action that caused the notification to be sent
${OrganizationName} The name of your organization as it's entered under Preferences --> Account Defaults
${Title} This is the title of the project
${Account} This is the Account ID of your SysAid Server
${Category} This is the category of the project
${Status} This is the status of the project
${StartTime} This is the start date of the project
${EndTime} This is the end date of the project
${Description} This is the project's description
${ID} Shows the project's ID number
${Notes} Displays the contents of the notes field
${RawEstimation} Displays the raw estimation (in hours) that it will take to complete the project
${Company} The company that's listed on the project
${Manager} Shows the manager in charge of the project
${RequestedGroup} The group that requested the project
${AssignedGroup} The group that the project is assigned to
${Progress} The percentage towards completion of the project
${resource} This allows you to insert a key from the translation file into your notification. This allows for notifications in multiple languages. Please see Custom notifications in multiple languages above for more information about using this tag
Tags For Use in Notifications Sent to Task Users
${ActionNotification} This is the action that caused the notification to be sent
${OrganizationName} The name of your organization as it's entered under Preferences --> Account Defaults
${Project} This is the name of the task's parent project
${Activity} Shows any activity that is added or deleted to the task. If no activity is added or deleted, does not display anything
${Title} This is the title of the task
${Account} This is the Account ID of your SysAid Server
${Category} This is the category of the task
${Status} This is the status of the task
${StartTime} This is the start date of the task
${EndTime} This is the end date of the task
${Description} This is the task's description
${ID} Shows the task's ID number
${Notes} Displays the contents of the notes field
${Estimation} Displays the estimation (in hours) that it will take to complete the task
${Progress} The percentage towards completion of the task
${Manager} This is the manager of the task's parent project
${Users} Shows a list of the users assigned to work on this task
${resource} This allows you to insert a key from the translation file into your notification. This allows for notifications in multiple languages. Please see Custom notifications in multiple languages above for more information about using this tag

This message was edited 1 time. Last update was at 12/09/2012 10:39:47

Joseph Zargari
VP Customer Relations


Meet me in Vegas - SysAid technology Conference - 28-30/4/2010
Joined: 26/03/2006
Messages: 516
Offline

I have some more variables that should be added to the documentation:

${DueDateOnly} – Shows the service request due date (date only)
${ReqUser.userName} - Shows the request user's user name.
${ReqUser.firstName} - Shows the request user's first name.
${ReqUser.lastName} - Shows the request user's last name.
${ReqUser.email} - Shows the request user's email address.
${ReqUser.phone} - Shows the request user's phone number.
${ReqUser.cellphone} - Shows the request user's cell phone number.
${ReqUser.notes} - Shows the request user's notes.
${ReqUser.sms} - Shows the request user's SMS number.
${ReqUser.location} - Shows the request user's location.
${ReqUser.building} - Shows the request user's building.
${ReqUser.floor} - Shows the request user's floor.
${ReqUser.cubic} - Shows the request user's cubic.
${ReqUser.carNumber} - Shows the request user's car number.
${ReqUser.custList1} - Shows the request user's cust list 1.
${ReqUser.custList2} - Shows the request user's cust list 2.
${ReqUser.custText1} - Shows the request user's cust text 1.
${ReqUser.custText2} - Shows the request user's cust text 2.
${ReqUser.custNotes} - Shows the request user's cust notes.
${ReqUser.custInt1} - Shows the request user's cust int 1.
${ReqUser.custInt2} - Shows the request user's cust int 2.
${ReqUser.department} - Shows the request user's department.
${ReqUser.custDate1} - Shows the request user's cust date 1.
${ReqUser.custDate2} - Shows the request user's cust date 2.
${ReqUser.userManagerName} - Shows the request user's manager name.
${OrganizationName} – Shows the organization name entered in Preferences > Account Defaults
${LinkToSurvey} - Creates links to fill in the satisfaction survey
${SelfServicePortalURL} – Creates a link to the SysAid server


Enjoy,
Joseph.
Joseph Zargari
VP Customer Relations


Meet me in Vegas - SysAid technology Conference - 28-30/4/2010
Joined: 26/03/2006
Messages: 516
Offline

Just found a new one:
SR Custom Notes: ${sr.custNotes}
Joseph Zargari
VP Customer Relations


Meet me in Vegas - SysAid technology Conference - 28-30/4/2010
Joined: 26/03/2006
Messages: 516
Offline

You can also use the following tags to get the custom list 1/2:
${custList1}
${custList2}

As opposed to ${sr.custList1} and ${sr.custList2}, which return the item key value, these will return the caption.
Ori
SysAid Customer Relations


Joined: 17/04/2008
Messages: 298
Offline

The Asset variables that are shown in the above post doesn't work in version 7.5x and below. Here's you'll find a list of the correct variables:

Building: ${sr.getAsset().building}
Floor : ${sr.getAsset().floor}
Name: ${sr.getAsset().computerName}
UpdateTime: ${sr.getAsset().updateTime}
Ip-Address: ${sr.getAsset().ipAddress}
Asset : ${Computer}

Keep in mind, that this will work only if you have an asset associated with actual service request. You can add the following IF statement and show the below variables when the assets is indeed associated :
#if( ${sr.getAsset()} )
--enter your required variables here--
#end

Best Regards.

This message was edited 1 time. Last update was at 03/03/2011 09:16:45

calinutz
SysAider

SysAider from release 7.5 Romania
Joined: 19/01/2011
Messages: 5
Offline

hello,

when i use either Department: ${ReqUser.department} or Location: ${ReqUser.location} instead of the text i get the coresponding Key of the value (i.e. 1, 2 ...)

how can i make it show the text instead of the Key Value ?!?

Thanks !
calinutz
SysAider

SysAider from release 7.5 Romania
Joined: 19/01/2011
Messages: 5
Offline

Anyone ... an idea !??!?!
JaneFrasier
Super SysAider


SysAider from release 6.5 United States Pathfinder
Joined: 25/03/2010
Messages: 93
Offline

I have the same question. This is very important to us.
Lisa
SysAider


SysAider from release 7.5 United States
Joined: 16/03/2011
Messages: 15
Offline

I want to populate the data captured in custom fields that had been created through Customize> Entities> Service Requests. How would that be done? Thanks for any insight.
Karush
SysAider

SysAider from release 6.5 Ireland
Joined: 13/09/2010
Messages: 6
Offline

I have successfully edited both the subject and body text of end user notifications to meet my needs.

However, body text comes up blank on the user's end. It is the same for all end users. The subject line is perfect; and the timing of e-mails is perfect.

Does anyone know how to resolve this issue of blank body text appearing?
Inna
SysAid Customer Relations

Joined: 24/06/2010
Messages: 745
Offline

Karush,

Probably you have done some error in the customization please contact us Helpdesk@sysaid.com and we will be glad to assirt you with.
Inna
SysAid Customer Relations

Joined: 24/06/2010
Messages: 745
Offline

Dear Lisa

Please see atachmnet.
[Thumb - Capture.JPG]
 Filename Capture.JPG Download
 Description
 Filesize 126 Kbytes
 Downloaded:  60 time(s)

Timmothy Green
SysAider

SysAider from release 6.5 United States
Joined: 21/10/2009
Messages: 38
Offline

Is there anyway to test if the Request User is also an Administrator?

Our Director is an Administrator. He will sometimes e-mail in requests as will some others that are Administrators. We do not allow End Users to add Notes and we do not include the Notes in End User notifications. I would like to add a check in the the body of the End User notification so that if the Request User is also an Administrator the Notes will be included.

So far the only luck I've had is something like this:

#if (${RequestUser}=="Joe Yooser")
** BEGIN NOTES **
${Notes}
** END NOTES **
#end

This works for a single Administrator, however, I would have to add in a similar entry for each Administrator. Looking for something like ${IsAdmin}==true, but I haven't found anything that allows me to do that yet.

I see a column "administrator" in dbo.sysaid_usr which is set to "Y" if the user is an administrator. Unfortunately, #if(${ReqUser.administrator}=="Y") doesn't seem to work.
aim icon
5.7FSN
SysAid Wiz

SysAider from release 7 United States Pathfinder
Joined: 15/04/2010
Messages: 375
Offline

Any reason the ${Project} and ${Manager} tag don't work in emails regarding tasks? Or has sysaid changed them ?
David Cohen
Technical Writer

Joined: 10/07/2008
Messages: 581
Offline

The list of tags has been updated as of 23 June 2011, and is now fully up-to-date. Please let me know if there are any questions about the new list of tags.
Forum Index » Online Aid
Go to:   
Help Desk Software
Free Help Desk Software
Free Asset Management Software
SysAid Helpdesk Software
Web Based Help Desk Software
SysAid Help Desk Forum
General IT Discussion Forum
SysAid CSS Customer Service Software
Customer Support Software
   SysAid Technologies Ltd.
   Toll-Free phone center (U.S.): 1-800-686-7047
   Offices - U.S.617-231-0124
   Israel:+972-3-533-3675
   Email:helpdesk@sysaid.com
   Optimized by SEO Israel
   SysAid logos and other SysAid Technologies marks
   are trademarks or registered trademarks of
   SysAid Technologies Ltd.
   All Rights Reserved by SysAid Technologies Ltd.
   2002-2011
   Live Support Hours
   07:00 AM - 09:30 PM (UK)
   03:00 AM - 05:30 PM (EDT)

   We provide worldwide services, and we do our best
   to match the working times of customers from
   different time zones.

   SysAid Help Desk Software and Asset Management Software
Privacy Policy © Terms Of Use