My Favorites
The My Favorites page lists all of your favorites and folders for personal and shared favorites. This is where you organize, copy, and distribute your report or utility favorites.
There are two ways to access the My Favorites page:
Report favorites can be accessed and managed from Application Function Bar > Reports > Reports Admin > Favorites > My Favorites.
Utility favorites can be accessed and managed from Application Function Bar > Utilities > Favorites > My Favorites.
Viewing My Favorites
When you open the My Favorites page there are three options for viewing your favorites. In the upper-left corner of the page, you can choose from the following View options:
All - select this option to view all personal and shared favorites. This is the default setting.
Personal - select this option to view only your personal favorites.
Shared - select this option to view only shared favorites.
Using the Tool Menu
The table below describes the buttons available for each saved favorite and folder.
Button | Description |
---|---|
Create Schedule: This option allows you to schedule the favorite to run in the background. Refer to the Scheduling Favorites to Run in the Background section in this topic for more information. | |
Edit Schedule: This option allows you to edit the settings on your scheduled favorite. You may also choose to delete the schedule. | |
Edit: This options will open a window identical to the Save as Favorite window and allows you to edit the settings of the folder or favorite. | |
Distribute: This option allows you to share this favorite with other users of Emplifi Agent. See Distributing Favorites for a full description. | |
Delete: This option allows you to delete the favorite. After clicking this button, you are prompted to confirm the deletion. |
Copying Favorites
If someone else has enabled their favorite to be sharable, you can copy another user's favorites. To do this:
From the banner, click Copy Favorites from User.
In the Copy Favorites window, select the user or users you want to copy favorites from. If you know the user name or ID, use the Search box to begin typing it. A list of matches will display for you to select the name you want to use.
From the list that displays on the right, choose which of their favorites you want to copy by selecting the check box. You may also use the Search box to search for a specific favorite.
Click Finish.
Sharing Personal Favorites
If you want to share a Personal Favorite, do the following:
Hover over the personal favorite you want to share and select the Edit button from the Tool menu.
On the Edit Favorite window, select the Copy button at the bottom of the window.
Change the Favorite Type field to "Shared" and make any other changes for the copied favorite.
Click Save.
Distributing Favorites
If you are distributing a favorite to multiple users, we recommend that you create a shared favorite rather than using the Distribute Favorites function. For details, see Creating Favorites.
Although anyone can use the Copy Favorite feature, distributing favorites requires a special permission. If you have this permission, you can distribute favorites to any other users of Emplifi Agent as well as edit the permissions they have with that favorite.
You can distribute one favorite or a whole folder of favorites at a time.
to administrators: The security function for distribution rights is "w_maint_favorite_copy". For more information, see Security Functions.
Best practice is to copy or distribute as a linked favorite which allows the favorite to be updated when the original is updated. See the Copy and Distribute Permissions section below for more information.
There are two ways to distribute favorites: Distribute Multiple Favorites or Distribute a Single Favorite.
Distribute Multiple Favorites
From the page banner, click the Distribute Favorites button and the Distribute Multiple Favorites window will display.
In the Distribute Favorite window, locate and select the check box next to the users to share the favorite with. If you know the user name or ID, use the Search box to begin typing it. A list of matches will display for you to select the name you want to use.
From the list of favorites, locate and select the check box next to the favorites you want to share. If you know the name of the favorite, use the Search box to find it.
Select the check boxes by the favorite permissions you want to assign these users.
This will be applied to all users. To set different permissions for different users, you need to distribute each permissions group separately. Refer to the Copy and Distribute Permissions section below for more information.Click Finish.
Distribute a Favorite
From the My Favorites list, hover over the folder or favorite you want to distribute. A menu button will display to the right of the favorite name. Hovering over this menu button will display a Tool menu.
Click the Distribute button.
In the Distribute Favorite window, locate and select the check box next to the users to share the favorite with. If you know the user name or ID, use the Search box to begin typing it. A list of matches will display for you to select the name you want to use.
Select the check boxes by the favorite permissions you want to assign these users.
This will be applied to all users. To set different permissions for different users, you need to distribute each permissions group separately. Refer to the Copy and Distribute Permissions section below for more information.Click Finish.
Distributing a favorite in a folder when the "to" user does not have that folder, then the favorite is saved in the ROOT! folder.
Selecting Copy and Distribute Permissions
When you copy and distribute favorites, you can choose any or all the following permission options:
Linked: Selecting this option will keep the new, linked favorite connected to the original so if the original favorite is changed or deleted, the linked version is also changed or deleted. When you copy a favorite without this option, you are creating a completely independent copy of the original.
When a linked favorite is updated, the users that have a copy of the linked favorite will not see any updates to the linked favorite until they log out and log back in to the system.Sharable: A sharable favorite is one that can be copied or distributed to other users.
Prevent Update on Distribute: When this option is selected, the copies (or links) that are created will be marked as protected so that they cannot be overwritten by another user. However, there is nothing that prevents a user from modifying his or her own favorite, regardless of how it was created originally.
Permit: When a favorite is distributed with this option selected, a user that does not have access rights to the report will be allowed to run the report.
Copy Schedule: This option copies the favorite along with any schedules it runs on so both users get the results of the favorite when it runs. If this option is left unselected, the user can leave it unscheduled and have to run it manually or create their own schedule for it.
Show in Work Items: This option allows the favorite to be accessible from the Work Items menu.
Show in Case Caller History: This option allows the favorite to be accessible from an open case. This option will not display for unsupported favorites and folders.
Creating Folders
You can create folders to organize favorites. To create a folder and begin organizing:
Click New Folder. A dialog window will display.
In the Folder Name field, enter a name for the folder. If you will be sharing the folder, we recommend that you add a prefix to the name to indicate that it is "shared".
In Favorite Type, select the type of favorite you want to save. Once the folder is saved, the Favorite Type setting cannot be changed.
Choose from:Personal- selecting this option keeps the favorite as your own personal folder. Other users will not be able to access this folder or the favorites stored in it.
Shared - other users may access this folder and the favorites stored in it. They may also make a copy for their own use.
A "shared" folder can only contain shared favorites. Likewise, a "personal" folder can only contain personal favorites. However, the ROOT! folder contains both shared and personal favorites.
If you selected the folder to be "shared", then in the Shared with Company field you can select the company ID where you want it to be shared.
If you selected the folder to be "shared, then in the Shared with Config field you can select the configuration to share it with.
Click OK. Your folder displays above the list of saved favorites.
Moving a Favorite to a Folder
Locate the favorite you want to move into the folder. Hover over the name and a menu button will display to the right of the favorite name. Hovering over this menu button will display a Tool menu.
Click the Edit Favorite button on the favorite you want to move to the folder.
From the In Folder drop-down field, choose the new folder name.
Scheduling Favorites to Run in the Background
You can schedule favorites to run in the background at a specified time. They can be scheduled to run a single time or on a recurring basis. The name of the process that runs scheduled tasks is the Emplifi Agent Automated Task Scheduler (PCATS). PCATS requires you to have the Event Requestor service configured and running in your environment. For more information, see Event Requestor Overview.
Create a New Schedule
To create a new schedule for a favorite:
From the My Favorites list, select the favorite or folder where the favorite is stored.
Hover over the favorite name and a menu button will display to the right of the favorite name. Hovering over this menu button will display a Tool menu.
Click the Create Schedule button. The Schedule Favorite window will display.
Enter information into the following fields.
Field | Description |
---|---|
Report Queue ID | Select a report queue. This field is required; all background processes (regardless of type) are submitted to a queue, where the background processor accesses them to run at the specified time. |
Run | Select whether you want to schedule this favorite to run One Time or to have it Repeat on a regular basis. |
Time Frame ID | If you are using a relative date to schedule this favorite, select a time frame to specify the interval between run times. For more information, see Time Frames and Dates on Reports and Utilities |
Schedule Start On | Select the first day on which the favorite is to run. While it is possible to also enter a time value in this field, we recommend that you enter the time in the Start Time field. Otherwise, if the favorite is using a repeating schedule, the time will be lost after the first run. |
Plus Days | Enter the number of days that you want the favorite to run past the start of a time frame. This field is used with custom time frames and built-in time frames to have a report run a certain number of days past the start of a time frame. You can verify the Start Day for the built-in "Week" time frame on the Time Frame screen. This will help you determine what value to enter in the Plus Days field. For more information, see Defining Time Frames. This field is only needed for schedules set to repeat on a weekly basis. |
Start Time | Enter the time of day at which the task should begin in the following format: h:mmPM or h:mmAM. |
Est. Run Time | Displays the estimated time (in minutes) required to run the favorite. The purpose of this value is to prevent a task from running when the database is expected to be down for maintenance. (The database maintenance schedule is part of the report queue definition.) If a job is scheduled to start, but PCATS calculates that the database will be down before the job completes, the system delays the start of the job until after the scheduled down time. |
Save As | Since the favorite runs in the background, you need to select an output file. Select the file type for the output. These are the same as the standard report and utility output types. For more information, see Report Output Types. |
File Name Type | Select a file name type for the output from one of the following options: Full File Name: Save using the full path and filename entered in the File Namefield. Partial + Day In Year: Save using the name entered in the File Name field, and the day of the year (1 to 366) appends to the file name. Generated: Emplifi Agent automatically generates a unique file name. |
File Name | Enter the full path and file name in which to save the task results. For further information, refer to the description of the File Name Type field. A favorite scheduled with a specific file name will replace that file name instead of appending. To avoid losing the previous file, use the generated file name type. |
Send Report Results To | Select the name of the user or group of users who are to receive an email notification each time the favorite has completed. You can also type a specific email address. This field can hold up to 2000 characters. If you select a message group as a recipient, the group name is stored as the recipient for the message in the database. This field is not used for utilities. Instead, use the Recipient List field in the utility favorite for listing who should receive the utility log file. |
Status Type | Displays the current status of the job being scheduled. This value is maintained by the system. Possible values include:
|
Report Processor ID | Displays the Processor ID of the Report Queue the job is to be submitted. For further details on setting up Report Queues, see Report Queue Maintenance. |
Started Date | Displays the last date and time the report was run. |
Next End Date | Displays the estimated time when the report will finish (based on the Est. Run Time field). |
Next Run | Displays the next date and time the report is scheduled to run. |
Planned Run | Displays the date and time the system plans to run the favorite. This field is calculated after the report queue schedule is taken into account. |
Click Ok to save the schedule.
Edit an Existing Schedule
If you need to edit the schedule of a favorite:
Find the report or utility favorite name, as described above.
Click the Edit Schedule button. The Schedule Favorite List window will display a list of all schedules for the favorite.
Select the schedule you want to change and update fields as needed.
Click Ok to save the new schedule.
Delete an Existing Schedule
If you need to delete an existing schedule for a favorite:
Find the report or utility favorite name, as described above.
Click the Edit Schedule button. The Schedule Favorite List window will display a list of all schedules for the favorite.
Next to the schedule you want to delete, click the Delete Schedule button. A confirmation message will display.
Click Delete. The schedule is removed from the list.
Searching for a Favorite
If you have several favorites, you can use the Search function to find the favorite you need.
To search for a favorite:
From the My Favorites screen for reports or utilities, type the favorite's name in the Search box. This is located in the upper-right side of the screen, below the banner. As you type the name, a list of matching favorites will display below the Search box.
Select the matching result from the list. The favorite will open on the page.