Skip to main content
Kinetic Community

User Manual

 

 

 

 

 

 

KINETIC CALENDAR


File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image001.png

User and Management Guide

Version 1.5.1

 

October 25, 2011

 

 

 

 

File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image002.jpg

 

Descrption

Kinetic Calendar is a comprehensive tool to be used for scheduling and organizing all types of information from any BMC Remedy-based application.

 

Calendar allows a simple approach to creating calendars and schedules whether used for personal time management or for an entire organization.  Our goal in creating this software is to make scheduling, planning, coordinating and collaboration easy for everyone.   With this software, you can set up project phases as independent objects, quickly and simply modify dates, coordinate events, manage change requests and create back-up calendars. 
 

Calendar Uses

Use your calendar for these and other purposes:

  • business scheduling
  • coordinate and organize events
  • back-up calendars
  • change requests
  • IT Infrastructure Library (ITIL) process reviews

 

 

Kinetic Data and BMC Partnership

As a BMC/Remedy user, you know that Remedy delivers service management software solutions that enable your organization to automate and manage internal and external service and support processes. As a BMC Solutions Partner, Kinetic Data delivers Remedy system enhancements expanding Remedy capabilities and processes that save you time while providing faster results more efficiently.

 

Kinetic Calendar User and Management Guide

The Calendar user interface was designed from the start, with a single principle in mind, ease-of-use.  Since even the best features and productivity gains can be overshadowed unless users can easily take advantage of them, Kinetic Calendar was built to be easy-to-use, allowing multiple users to edit calendar information and providing methods for “view only” access. 

This manual provides the ability to see time and day-based data in a calendar form by retrieving Remedy data and inputting it onto a calendar to see and manage.  

 

Who Should Read this Manual?

This manual is intended for Kinetic Calendar managers and users.  To use Kinetic Calendar, you must have user privileges.  See Users and Groups Administration.

 

Users and Groups Administration

The purpose of this chapter is to provide the Kinetic Calendar system administrators with definitions of user groups to apply within the Remedy user setup and security, which allows you to understand how to manage security.

Within Kinetic Calendar there are two groups using two distinct sections of the calendar system.  There are Administrative and Managerial users that go into Remedy and actually create calendars.  Then there are users that interact with the Web Calendar.  Kinetic Calendar offers the ability to create and view both private and public calendars. 

Kinetic Calendar Users and Groups

Kinetic Calendar delivers four user groups for security setup. Please see your Remedy Action Request System documentation for more information on assigning User Groups to users.

The four types of users are Calendar Creator, Calendar Manager, Calendar Event Changer, and Calendar Event Viewer.

Calendar Creator

The main purpose of this role is to create calendars. Once created, they can assign another user the role of calendar manager.  A calendar is setup as private or public.  All customers can view events on a public calendar. Only specific groups, assigned by the calendar creator, can view events on private calendars.  It is important for the calendar creator to have an understanding of Remedy security groups, and which users belong to each group.  Because of this requirement, calendar creators are typically Remedy administrators or department managers.

A calendar creator must belong to either the Administrator group or the KS_CAL and KS_CAL_Creator groups.  Calendar creators also require a Remedy write license.

Calendar creators have all the security privileges as calendar managers, calendar event changers, and calendar event viewers.

Calendar Manager

The calendar manager creates and modifies the definition of a calendar.  This includes giving other Remedy users calendar roles, such as Manager, Event Changer, or Event Viewer. 

The calendar manager also creates the event types for the calendar.  Event types define the structure, or template of events.  This is where the calendar manager can organize events based on some type of criteria, or even display records from a different Remedy form.

A calendar manager must belong to either the Administrator group or the KS_CAL and KS_CAL_Manager groups.  Calendar managers also require Remedy write license.

Calendar Managers also have all the security privileges as calendar event changers and calendar event viewers.

Calendar Event Changer

Calendar users with this role have permission to create and modify events on the calendar they are assigned to.  These users generally will not belong to the KS_CAL_Manager or KS_CAL_Creator groups, so they will not have access to the Kinetic Calendar Manager console.  These users will be creating and modifying events from the calendar web interface.

Depending on your Remedy server settings, calendar event changers may or may not need a write license.  If your server is configured with submitter mode locked, event changers will be able to create and modify their own events with only a read license.  Please see the Remedy user manuals for information regarding this setting.

Calendar Event Viewer

Depending on the security access setup in the calendar, viewers may or may not need this role to view events on a specific calendar.  If the calendar is setup as public, anybody can view this calendar, so no users will need to be assigned the Event Viewer role.  If the calendar is private, users will need to belong to one of the calendar roles to view events.

No Remedy licenses are required for users of public calendars.  Viewers of private calendars are required to authenticate with Remedy before viewing the calendar, therefore, must at least have a read license.

 

Setting-up and Managing Calendar

Calendars and event types are created in the Remedy user tool, but can be accessed with the web interface to create and manage events. 

This chapter provides procedures to create a new calendar. 

Accessing the Calendar Manager Console

To Access the Calendar Manager

  1. Open the AR System User Tool.
    1. From the toolbar, select the Open icon.   File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image006.jpg  -OR-
    2. ​From the toolbar, select the File menu and Open.
  2. ​The All tab of the Object List dialog displays, listing all Remedy forms on the AR Server.
  3. File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image007.jpg
  1. From the All tab list of the Object List dialog, highlight the Kinetic Calendar Console entry point and double-click to open it.
  2. File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image008.jpg

 

Calendar Manager Console

The Calendar Manager Console offers a selection of calendars and events created by calendar creators, managers and users.  From the console set-up, access, and monitoring of functions for all types of calendar events is accomplished. 

The top tier of the console lists calendars within the application that a user has permission to access.  Selecting or highlighting a calendar in this area enables a user to update information in the bottom, or second tier, of the console calendar. 

Second tier functions offer tools to assist in better managing details within each calendar, such as:

  • Cloning Calendars
  • Event Types
  • Calendar Manager Console Audit

Because this is a permissions-based system, it must be set-up by a user who belongs to either the Administrator or Calendar Creator group.

From the Permissions Tab, users are assigned to a calendar by a calendar creator or manager, and given a calendar role.  Additional functions in this section are Event Types, and Audit

Calendar Properties

The Calendar Properties Dialog appears after clicking Add or Modify in the top tier of the console.

File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image009.jpg

 

Within the Calendar Properties Dialog area Names, Groups, and Statuses can be created offering permissions and informative internal sources. 

A unique Web Name can be created that will appear in the Uniform Resource Locator (URL), the address that defines the route to a file on a Web server.    

Creating or Modifying a Calendar

  1. From the Calendar Manager Console, click Add or Modify.
  2. Enter a Calendar Name.
  3. Enter a Web Name using alpha/numeric key strokes with no spaces.
  4. Select the Visibility as either Public or Private.
    1. Private requires the user to “log-in” before they can see the calendar.  The user must belong to one of the groups specified in the Viewer Group list.
    2. Public will allow any users who have access to the specific web application to view the calendar. 
  5. ​If you choose Private, select a Viewer Group from the drop-down menu.
  6. Select an Active or Inactive Status.  Only active calendars will be accessible to users through the web client.  Inactive calendars allow managers to configure and setup the calendar, without letting users access the calendar.
  7. The Display Page selection determines which JSP file to render the calendar in.  By default, all calendars will use the ‘calendarView.jsp’ file.  If this value is blank, the default JSP will be used.  Changing the value of this field requires a corresponding file to exist on your web server.
  8. The Default View selection determines what web view the calendar will initially be displayed in.  If this value is blank, the month view will be used by default.  Other valid choices are week, day, and list.
  9. The Encoding selection determines the character set used to send the data to and from the web client.  If this value is blank, UTF-8 will be used by default.
  10. Under Calendar Rules, on the right side of the screen is the option to make the calendar Visible in Web Listing.  By default, a calendar will be displayed in the listing.  Also is the option to enable Manager Notifications, or not.  This setting is global for the calendar, and will override any event type manager notifications if set to ‘Disabled’.
  11. Click Save when finished.
  12. Click Close to exit the dialog without saving your choices.

Searching For Calendars

The Calendar Manager Console provides a few fields to help filter the result list and narrow down your search for a calendar.  The Status field shows calendars that have either Active or Inactive status.  To view both active and inactive calendars, choose Clear

Note:  The Status for calendars can be viewed and changed from the Calendar Manager Console, as well as from within the Calendar Properties Dialog.   

The Visibility field shows only calendars that have either Public or Private status.  To view all calendars, choose Clear.  

A Calendar Name field also exists to filter the calendar list by name.  This will perform a search on the calendar name field, to display all calendars that meet the search criteria.  Since this is a full text search, the search criteria can match any part of the calendar name.

Clicking the Refresh button will reapply all table qualifications and refresh their results.

Deleting Calendars

Clicking Delete from the Calendar Manager Console will generate the box below as a notice that if “Yes” is clicked, the calendar resources, events and event types will also be deleted for that calendar. 

File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image010.jpg

 

Calendars are not deleted immediately; the calendar status field is just set to ‘Delete’.  There is an escalation that runs every 24 hours and checks for calendars that have been marked for deletion for at least 24 hours.  If any are found, they will be automatically deleted at this time.  This gives Remedy administrators at least one day to undo a deleted calendar if it was deleted by mistake.

Cloning Calendars

Kinetic Calendar provides an easy way to copy existing calendars.  We call this process ‘cloning’.  Cloning a calendar will create a copy of the calendar along with all user permissions and event types.  Any events that are specific to the source calendar are not copied.

Clicking Clone from the Calendar Manager Console will display a dialog that includes the name, and web name of the calendar you are trying to clone.  You are expected to change the both values, taking care to ensure the web name has not yet been used. 

File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image011.jpg

 

Permissions

The Permissions tab is where an Administrator or Manager can manage who has access to create/modify view Default events on private calendars. Use Remedy permissions for Custom or Filtered events.

 

Important Note: See the Managing Calanders section for information on adding resources to Kinetic Calendar.

 

  1. From the Permissions Tab, click Add.  The Resource Permissions dialog opens.
  2. File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image012.jpg
  3. Type a Name and click the “Lookup Name” button, or alternately, type a Remedy User ID and click the “Lookup ID” button to query from the Selection List.
  4. File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image013.jpg
  5. From the drop-down menu, select a Role.  Choices are Manager, Change All Events or View.  A calendar may have an unlimited number of resources, of any role.
    1. Manager can Create/Delete/Edit events
    2. Change All Events can Create/Delete/Edit events
    3. View can only view events
  6. Click Save when finished. or click Close to exit the dialog and not save your choices.  

Event Types

An Event Type is a way of grouping like events together, similar to a category. The type of event determines where the data comes from, and the options you have for display.

Where your event data comes from is determined by a setting in the event type, called “source”.  The values for this setting are: Default, Custom, Other Calendar, and Filtered.

  • Choosing Default means that your event data is stored in an internal Kinetic Calendar event form and not pulled from one of your own forms.  Default event types allow event changers the ability to create and modify calendar events interactively.
  • Choosing Custom allows you to access data in your own Remedy forms outside of Kinetic Calendar (i.e., Change Management, SLA, or Incident Applications).  Custom offers a user the ability to define what fields from the source form are mapped to specific events.  Custom event types do not allow any user to create or modify events from the calendar web interface.  These events are view only.
  • Choosing Other Calendar lets you show other Event Types within Kinetic Calendar that are configured for other calendars.  This function offers the ability to “layer” calendars on top of each other.  Events linked from other calendars may not be created or edited on the web interface from this calendar.  These events can only be created and edited from their root calendar.
  • Choosing Filtered offers functionality similar to Custom event types, with the added ability to filter the events that are displayed on the web client, and drill down into specific values of fields on the source form.

Important Note:  If you are showing custom events, events from other calendars, or filtered events, those events are READ ONLY. Events of this type cannot be created or modified from the web calendar interface.

 

By selecting the different sources, Default, Custom, Other Calendar, or Filtered, different tabs or options will be available to further define that event type.

 

Creating or Modifying an Event Type

  1. From the Event Types Tab, click Add to create, or Modify to view the event type.  A new event type is created with a “Default” source selected.
  2. File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image014.jpg
  3. Give the event type a descriptive Name for how it best defines or categorizes the events created under it.  For example, an event type name might be "Primary Contact" for your SQL Server On-Call calendar.
  4. Choose Active or Inactive from the Status field.  Only active event types will be displayed on the web client.
  5. Next to the Source field, if you choose Custom, Other Calendar, or Filtered a screen will appear asking if you want to proceed.
  6. File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image015.png

 

Custom (Source)

Choosing Custom enables a user to access any table within Remedy and show information on the screen.  See Publishing Data to Your Calendar for information on completing the fields and how to proceed.  

Other Calendars (Source)

Choosing Other Calendars is an efficient way to aggregate a number of calendars.  It enables a user to access fields from other calendars into an event on a “master calendar.”  For example, use this feature if you would want to list the SQL On-Call people, the Oracle On-Call people, and the DB2 On-Call people all on one calendar.  Other Calendar event types can only link to other Default event types.

Important Note:  If you are showing events from other calendars, those events are READ ONLY.  You cannot change existing events or create new events for this event type. 

File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image016.jpg

 

  1. Using the drop-down menu choose a Source Calendar.
  2. Using the drop-down menu choose a Source Event Type.  If the event type is not selected, all event types for the linked calendar will be shown.
  3. Click Save when finished or click Close to exit the dialog and not save your choices.

Filtered (Source)

Choosing Filtered enables a user to access any form within Remedy and show information on the screen. See Publishing Data to Your Calendar (later in this chapter) for information on completing the fields and how to proceed. A filtered event type is very similar to a custom event type, but it also has the ability to define fields that the end user can use to filter the events that appear on the web client.

Menu Options Tab

The first tab for a default source is menu options.  Default event types allow attaching information from another form to the events that belong to these event types.  This can be especially useful to display extra information about a resource, change request, or an incident, or to add a menu of people available for user desk coverage.  These fields are optional, and may be left blank.

File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image017.jpg

 

The figure above shows this event type will allow one menu item per event.  The menu will have a name of “Contact”, and the menu options will be built from the KS_CAL_Res_ResCal_Join form.  This is a join form containing the resources associated with a calendar.

 

The data returned from this form is determined by the specified qualification, and will produce a list of menu options displaying the value in the ‘Name’ field, but using the ‘Request ID’ field as the lookup index.

 

This particular example will allow one menu.  It is possible to attach multiple menus to an event as well.  This could be useful for displaying information for both a primary contact, and a backup contact.

 

  1. From the Menu Name field, type an applicable name such as Resource or Contact.
  2. From the Menu Form field choose the applicable form from the drop-down menu. 
  3. From the Label Field choose an applicable label from the drop-down menu (i.e., first name/last name, e-mail, request ID, etc.)  This is the value that users will see in the event.
  4. From the Value Field choose the true value for that field.  This represents the linkage back to this record in the database where it is stored.  Take care to apply a unique identifier to the Value Field.  Typically, it is a request ID (field 1) or it could be an instance ID (field 179).  This value is used to look up the record in the menu form, so use a field with an index for best performance.
  5. Write a Qualification that describes the data that corresponds to the menu. The calendar workflow uses this qualification to display the proper data in the menu list.
  6. From the Allow field determine if you want one record to be selected or multiple records using the drop-down menu.  In some situations, a user may want multiple people such as a series of approvers for some type of calendar event.  In this case you would select “multiple” to offer several contact choices on the Web Calendar.

Display Fields Tab

This area offers the opportunity to select additional fields that correspond to the menu item.  You can add fields from the menu form chosen on the “Menu Options” tab to display more information about the selected menu item.

For our event type example, ask yourself what fields do I want to appear beside a primary contact on this event?  You would probably want the contact’s email address and telephone number. For a change request, or an incident, you might want to include the summary, category, type, item, and possibly the requester’s name.

 

File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image018.jpg

 

Additional Display Fields
  1. From Output Format, choose the format template used to display this information.
  2. From Select Field, choose a field from the drop-down menu.  A Field Identifier and Field Label appear.  You may modify the field label to suit your needs.  In Figure 13, the “Phone1” field was renamed to read “Work Phone”.
  3. Click the Add button to add the field to the selected fields list.
  4. Continue to add as many fields as desired.
  5. Fields may be removed from the list in the same fashion.  Just click the field you wish to remove from the table, and click the Remove button.
Notifications Tab

Use this screen to setup manager notifications for this event type.  Managers are only sent an email notification if there is a day without a scheduled event for X number of days into the future.  For instance, this provides an automated way for a manager to ensure there is at least one on-call person scheduled every day for X number of days.  If manager notifications are not needed for this event type, simply disable by selecting the appropriate option. 

Please note, this selection only enables, or disables manager notifications for this event type.  The calendar notifications setting, configured by the calendar creator, takes precedence over this setting.  If the calendar notifications are disabled, then this setting will have no effect.

 File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image019.jpg

 

Calendar Manager Console Audit

Additions and modifications for Kinetic Calendar will be performed by managers or administrators.  The Audit tab allows a manager to see changes that have taken place for events and event types for each calendar. 

Audit changes can include:

  • Changes to Events, and Event Types
  • Deletions of calendars, events, or event types
  • Various “field” and “value” changes

 

File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image020.jpg

 

In addition to the Application, Audit Type, and Audit Message, the information on the tracked change include:

  • User making the change
  • Date/time of the change
  • Previous value
  • Field Name
  • New Value
  • Time Zone

Note:  A calendar event(s) time zone will be reflected by the “Remedy” time zone (i.e., your user preference is set to a time zone depending on where you are normally logged-in).  The software will retrieve that time zone, first, and then whatever time zone your browser is using.  Finally, if that can’t be retrieved, the software will use the server time zone. 

 

To view auditing details:

  1. From the Audit Tab highlight an audit and click View.
  2. When finished, click Close

Publishing Other Data to Your Calendar

Kinetic Calendar provides the ability to display and share data from time-based Remedy solutions, allowing Kinetic Calendar to integrate with your existing data management solution.  The information that comes from another source can then be published into Kinetic Calendar as READ ONLY information. 

 

Source Fields Tab

  1. From the Event Types tab click Add or Modify
  2. Type in an event type Name.  Enter field information for Name in a short and concise manner so it will fit in the “Web Calendar” window. 
  3. Check either Custom or Filtered as the source.
  4. File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image021.jpg

 

The first tab contains the “Source Fields” to use for the external event.  This is a field mapping from another Remedy form, into the Calendar Events form.  Calendar will substitute the fields specified in these fields for the normal event fields of the same name.

 

Important Note:  User permissions are applicable for a form whether a public or private calendar is being accessed.  If a public calendar is being accessed the “default” web user must have permission for the chosen form.  In accessing private calendars, the logged-in user needs permission for the form and all fields, as well. 

 

  1. From Source Form click the drop-down menu and choose another Remedy form.  This is the form where the data will come from.
  2. File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image022.jpg
  3. Select a field from the drop-down menu for Description Field that corresponds to a description for the event on the source form.  This field can be any length.
  4. File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image023.pngFile:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image024.jpg
  5. Select a field from the drop-down menu for Event Name Field.   Choose a field that corresponds to the event name on the source form. 
  6. Select a field from the drop-down menu for Time Begin Field.  This must be either a time field, or a date/time field in Remedy (i.e., Create Date).
  7. Select a field from the drop-down menu for Date Begin Field.  This must be either a date field, or a date/time field in Remedy   (i.e., Create Date, Modified Date, Assigned Date). 
  8. If applicable, select a Duration Field from the drop-down menu.  Currently, this value must be an integer field, representing the duration in number of minutes.  If you do not have a value in the Duration field, the application will calculate the difference between the Start Date/Time and End Date/Time. If your End Date/Time and Start Date/Time are the same, the event will be marked as an all day event. If the time of the event goes over midnight, it will be shown as a full day.
  9. Select a field from the drop-down menu for Date End Field.  Again, this must be either a date field, or a date/time field in Remedy. 
  10. Type in or select a field from the drop-down menu for Qualification.  Part of the qualification criteria is that it only corresponds to a particular month.  Therefore, if the month of March is indicated, the system retrieves only those events for March.
    1. Example:  Assume your organization creates “Change Notices” for changes made to an event, but only those events deemed “critical” need to be viewed.  In that case, the qualification would be typed as ‘type’ = “critical”.
  11. ​If you want to dynamically change the data that is displayed on the calendar, you can put a placeholder value in the qualification, and then use a URL parameter when the calendar is called on the web. To identify the placeholder, enclose the value in double curly brackets { { } }. Once you have the placeholder, you can add this to the URL as a parameter.
    1. Example:  You want to dynamically set the server by a value passed in the URL. Your qualification for the event would be ‘Server Name’ LIKE “{ {sname} }%”. Then, your parameter would include a string like this; &sname=myServerName. The & adds a new parameter and the sname links the value after the equals sign to the qualification string for the calendar. You can have multiple parameters passed into the URL.
  12. ​Click Save when finished or click Close to exit the dialog and not save your choices.  

Filter Fields Tab

For Filtered event types, another tab exists called ‘Filter Fields’.  This area offers the opportunity to select additional fields that end users may filter data on, and drill down into the data based on fields defined in this list.   You can add these fields from the source form chosen on the “Source Fields” tab.

For a change request, or an incident, you might want to include the category, type, item, status, priority, urgency, and possibly the requester’s name or the assignee’s name.

If you prefer to filter the data immediately when the calendar is displayed, the Default Filter Field selection allows you to indicate what field should be used for the initial filter.

 

File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image026.jpg

 

Managing Calendar

On the left side of the Calendar Manager Console are helpful links to assist in administering the calendars.  While other areas in which you have been working are applicable to specific calendars and events, these links are global to the Calendar application. 

Not all links will be available to all calendar users. They are dependent on permissions.

Resources

 

File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image027.jpg

 

The Resources screen displays the users that have been added to the KS_CAL_Resources form.  At the least, make sure you have filled in the User ID (Remedy ID) and the Name fields. These users may be assigned calendar roles, as described in the Permissions section.  Typically workflow is added to automatically populate this form from another data source, like  the User form, the SHR:People form, or some other source.

 

In Kinetic Calendar versions prior to v1.4.0, users had to be listed as a Resource to have access to Private calendars. Kinetic Calendar now uses Remedy authentication and permissions to allow users access to private calendars and the data displayed from Remedy. The only reason to add users as resources is to control the access to the Add Events link directly on a calendar using the Default event type.

 

Configuration

Configuration allows Administrators to build, arrange, organize and shape various aspects of the application. They can manage configuration items including:

  • Configuration Items
  • Add or Modify Menus
  • Delete a Menu
  • View More Details on Audits

 

NOTE - You must be a Remedy Administrator to access the Configuration Manager dialog form.

 

Configuration Items

These items set much of the default settings for the Kinetic Calendar application, including default views and license keys.

File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image034.jpg

 

  1. From the Configurations Item Tab, click Add or Modify.  The Configuration Item Dialog appears.
  2. File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image035.jpg
  3. From the drop-down menu under Configuration Type, choose from the selections offered.
  4. From the drop-down menu under Config Property, choose either Web Property, Remedy Property or Clear.
  5. Type a Configuration Value in the window provided.
    1. Example:  A potential scheduling problem exists for the on-call resource calendar: $Calendar_Name$.  Please click the following link to view this calendar: $Web_Name$
  6. ​Click Save when finished.
  7. Click Close to exit the dialog and not save your input.

Menus

Menus are used throughout the Kinetic Calendar Console.  This form allows Calendar Managers the ability to manage menus used in the application.

Add or Modify a Menu

File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image036.jpg

 

  1. From the Menus Tab, click Add or Modify.  The Menus Dialog appears. 
  2. File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image037.jpg

 

Delete a Menu

  1. From the Menus Tab, highlight a menu and click Delete.  The following box appears asking if you wish to delete the selected menu item?
  2. File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image038.jpg
  3. Click Yes or No

 

Deleted Calendars

The Deleted Calendars tab allows a manager to see all calendars that have been marked for deletion, but haven’t actually been deleted yet.  The manager can manually restore the calendar to the system by clicking the ‘Restore’ button, or manually delete the calendar by clicking the ‘Delete’ calendar.

File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image039.jpg

 

View More Detail on Audit Changes

The Audit tab allows a manager to see changes that have taken place for an item.  Changes that are audited include:

  • Event changes, once the status is “Active”.  Changes in “Inactive” status are considered in development and are not audited.
  • Deletions of calendar events
  • Integration changes

The information tracked on the change includes:

  • User that made the change
  • Audit Date/Time
  • Previous Value
  • Field Name
  • New Value

File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image040.jpg

 

  1. From the Audit Tab, use the scroll bar or click Next or Previous to locate and highlight an audit item. 
  2. Click View.  The Audit Information table appears. 
  3. File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image041.jpg
  4. Click Close to exit the screen. 

 

Administration

On the left side of the Calendar Console are links to help manage or administer Kinetic Calendar.  Clicking each link will open either open a web page with information regarding the Kinetic Calendar application, or another Remedy form with relevant information.  

File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image028.png

 

Properties Viewer

The Properties Viewer displays web server properties including the logging level and Remedy server and the environment properties, such as JDK and the class path used by your web server. 

 

File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image029.jpg

 

 

Log Viewer

The Log Viewer displays the web server logs.  Information in this log is dependent on what log level is set in the properties.  The entire log is available on your web server in the temp directory on the same level as the KinCal directory.

 

File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image030.jpg

 

Readiness Check

The Readiness Check link is useful for checking that the appropriate jars are in place or that the license is active, etc.  This would most often be used after a new web server is installed. 

 

File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image031.jpg

 

Error Messages

The Error Messages screen allows an Administrator to create and manage error messages that display to a Kinetic Calendar user. 

 

As an example, an appropriate error message may appear when a user is incorrectly trying to access a certain field or drop-down menu. 

 

File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image032.jpg

 

Password Encrypter

The Password Encrypter link opens a web page that will encrypt a plain text string, such as a password.  It uses the EncryptionSeed value found in the application's configuration file (KinCal.xml) as a unique seed.

KinCal_EncryptionSeed.png

Please ensure this value is set in the application configuration file.  If it is not, please set it to a value - it can be a word, sentence, or a random string of characters - then restart the web server so the application uses the new value.

After encryting the password, the encrypted value can be copied from the resuls page, and pasted into the application's configuration file (KinCal.xml) instead of the plain text value.

 

To encrypt the password for the default web user, follow these steps:

  1. Open the password encryption page  EncryptionPage.png
  2. Type in the plain-text password in the form field.
  3. Click the Encrypt button to have the web server encrypt the value.  The web server encrypts the value entered along with the encryption seed defined in the EncryptionSeed property of the application's configuration file.
  4. Copy the encrypted string value from the results page.EncryptionResult.png
  5. Using a text editor such as Notepad or VI, open the KinCal/WEB-INF/classes/KinCal.xml file.
  6. Paste the encrypted string into the value for the RemedyPassword entry: KinCal_RemedyPassword.png
  7. Set the UseEncryption property to true  KinCal_UseEncryption.png
  8. Save the KinCal.xml properties file.
  9. Restart the web server.

Using The Web Calendar

Viewing your Remedy data on the web is the overall goal of Kinetic Calendar. Multiple styles and types are available with the web view.  

 

Calendar works much the same as other standard calendars with easy-to-access Day, Week, Month and List views.  Each view shows the selected month with today’s date highlighted in yellow on the upper left side of the screen.  Using the arrows at the top of the screen, a user has the ability to toggle forward or backward through the different available views or use the Day, Week, Month, or List tabs located at the top right area of the calendar. 

 

 

File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image046.jpg

 

The small calendar (in the upper left corner) shows today’s date highlighted in green.  (If viewing a different day or week from today it will highlight in yellow.) 

File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image047.jpg

 

Accessing Web Calendars

Kinetic Calendar offers four ways to access web calendars.  First, highlight a calendar from the Calendar Manager Console and then click Launch.  This method will access the current day of the calendar “highlighted” on the console. 

A second method is through the “My Calendars” link in the upper right of the screen after you are authenticated and logged in. This method gives each user access to all web calendars they have been given permission to view.  From this view you can select the individual calendars you want to view, or by clicking the individual calendar name you can navigate to see just that calendar.

The third method is to display all public calendars in the system.  Users can simply navigate to the Default Web Server configuration setting (typically http://mywebservername.com/KinCal/)to get a list of all public calendars.  Clicking the name of the calendar will then forward the user to the monthly calendar view for that calendar.

The last method is direct URL access using the Default Web Server configuration with a specific identifier for the calendar you want. For example: http://mywebservername.com/KinCal/ca...alendarWebName

The text “/KinCal/calendar?CalendarName=” is required by the application and then you replace “”myCalendarWebName with the Web name you setup when the calendar was created.

Options when Viewing Calendars

The example below, shows opening a calendar from the Calendar Manager Console. Following that example are the optional parameters you can add to a Calendar URL. These parameters are useful for targeting the calendar to specific users needs.

The SQL On-Call calendar is highlighted. 

File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image049.jpg

 

To access the web calendar view of that calendar, click Launch

File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image052.jpg

 

Notice that the URL in the web address, http://kdtest01.kineticdata.com:8080/KinCal/calendar?CalendarName=sql&ForDate=200905&View=month  represents the resulting web calendar view.  From here, a user can add specific parameters and directly access different calendar views and specific dates. 

Specifying a Calendar Name from Web Calendar

  1. Using the mouse, place the cursor at the end of the URL in the web address window.
  2. Carefully backspace to clear data (if necessary) and place the cursor to the right of KinCal/calendar?CalendarName=, leaving the beginning of the URL intact.
  3. Type-in the “Web Name” (shown on the Calendar Manager Console) which represents the calendar you want to view.
    1. Examples: KinCal/calendar?CalendarName=sql or KinCal/calendar?CalendarName=oracle
  4. Press Enter.  The new calendar view appears. 
  5. File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image054.jpg

 

Requesting a Specific Date View From the URL

In addition to clicking or using the toggle elements to switch dates, a user can request a specific date directly from the URL window.

  1. Using the mouse, click the cursor in the URL and place the cursor at the end of the designated calendar name.
  2. Using the example below, type-in “&ForDate”, plus the date you want to view.
    1. ​Example: &ForDate=200702 will display the calendar for February, 2007.
  3. ​Press Enter.  Depending on whether you were previously logged in or not, a login screen may appear.
  4. File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image055.jpg
  5. Type in login information if the login screen appears. 
  6. Click Submit and the requested calendar data appears. 

 

Requesting a Specific Calendar View From the URL

In addition to clicking the Day, Week, Month, and List calendar view links to switch calendar views, a user can request a specific calendar view directly from the URL window. 

  1. Using the mouse, click the cursor in the URL and place the cursor at the end of the designated calendar name.
  2. Using the example below, type-in “&View”, plus the calendar view you want to see (day, week, month, or list).
    1. ​Example: &View=week  This will display the calendar in the week view.
  3. ​Press Enter.  Depending on whether you were previously logged in or not, a login screen may appear. 

 

Setting Custom Calendar Title from the URL

If you want to set a custom title for your calendar, it is easily accomplished by adding a parameter to the URL.

  1. Using the mouse, click the cursor in the URL and place the cursor at the end of the designated calendar name.
  2. Using the example below, type-in “&CalendarTitle=”, plus the calendar title you want to see.
    1. ​Example: &CalendarTitle=MyCalendarTitle  This will display MyCalendarTitle as the new title of the calendar.
  3. ​Press Enter.  Depending on whether you were previously logged in or not, a login screen may appear. 

 

Using Parameters from Your Qualification

If you are using parameters in your Event Type qualifications, they will need to be added into the URL. You can do this by hand in a URL, or with a custom webpage that constructs the URL using a scripting language like javascript.

 

Example:

 ‘serverName LIKE “%{ {server} }” in the qualification of the Event Type.

Then &server=RemedyProd1 added to the URL will substitute RemedyProd1 into the qualification when the Calendar is displayed.

 

Viewing “My Calendars” From Web Calendar

Accessed from Web Calendar, the “My Calendars” function offers users quick access to all (permission-based) calendars to view or change in the same manner described above.  In this way a user can efficiently check and recheck, hide or show, all of their calendars, simultaneously. 

To view My Calendars, click in the upper right portion of the screen. 

File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image058.jpg

 

In the example below, My Calendars (in this case, Demo) appears. 

Note:  In the lower, left side panel a color-coded indicator of all calendars in which the current user (logged in as “Demo”) has permission to access. 

 

File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image060.pngFile:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image062.jpg

 

Note that all day events show up in colored blocks, while events with “time” durations show up in a font color that matches the Calendar to which it is connected.

 

This option makes it easy for one user to see how their (permission-based) calendars overlap, viewed from one image.  Kinetic Calendar also offers the option to view just one or two calendars at a time, if you prefer.  This is accomplished by clicking and un-clicking on the checkbox next to the calendar you wish to show on the Web Calendar. 

 

File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image063.png

 

Calendar List – Public and Private Calendars

Once you are logged in to the web console, if you click on the words Kinetic Calendar on the top left, you will get a list of the Calendars you can access.

 

File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image064.jpg

 

 

Date Specific Calendar Requests

While no parameters are required, adding a “&ForDate” parameter in the URL can assist a user in specifying an exact date of My Calendar in the same manner as described above in: Requesting a Specific Date View From the URL. 

  1. Using the mouse, place the cursor at the end of the URL in the web address window.
  2. Carefully backspace to place cursor to the right of CalendarName=
  3. Type in the value “mycalendar”.
    1. ​Example: CalendarName=mycalendar
    2. Example: CalendarName=mycalendar&ForDate=200703
  4. Press Enter.  Your “My Calendars” view appears. 
  5. File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image067.jpg

 

Understanding/Using Web Calendar View

Located at the top center of the web calendar screen, a calendar name is shown.  It changes to reflect whatever calendar is currently being viewed. 

In addition to specifying a date in the URL field, a user can toggle or click back and forth within a calendar, using the three designated areas

  • The Today button
  • The next / previous arrows next to the Today button
  • The next / previous arrows on the small calendar

 

Modifying an Event

If a user is authenticated and has permission to create events (only Default event types support this), they see the “Add Event” hyperlink located at the top-left of the calendar.

 

File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image083.jpg

 

By clicking the Add Event link, a dialog screen appears giving users the ability to create events on calendars.

 

File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image088.jpg

 

Adding An Event from Web Calendar

Adding an event can be accomplished by clicking in the header of the day and the Add Event Dialog screen will appear, or by clicking on the Add Event link in the upper left corner. 

  1. Click the Add Event link.
  2. From the drop-down menu under Calendar, select a calendar. 
  3. From the drop-down menu under Event Type, select a type. 
  4. Type in a description of the event in the box under Description
  5. If applicable, add a URL address.  (tip: It is a good idea to click GO, to test if the URL works properly.)
  6. Type in a Beginning date to an Ending date.
  7. Check box to left of All Day Event, if applicable. 
  8. If it is not an all day event, type in a Start time and an End time. 
  9. When finished, click Save.  Click Cancel to exit and not save any entered data. 

Changing Event Descriptions and Times from Web Calendar

The Web Calendar monthly view designates All Day Events as a solid colored bar.  Translucent colored bars and a stated time, designate a time-based event (color-coded to match the affiliate calendar) shown below in light taupe and a matching burgundy colored font. 

 

File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image091.jpg

 

  1. From the Web Calendar place the cursor on the event bar you want to change and left mouse click.  The dialog screen appears.  (In the example below see the all-day event from July 3rd through 6th.) 
  2. File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image093.jpg
  3. To change the event description, place the cursor inside the window below Description
  4. Type-in a new description. 
  5. To change the date, place cursor inside the window below Date
  6. Type in a new begin and end date. 
  7. Or, if applicable, click in the box to the left of All Day Event
  8. To change the time, use the drop-down menus to select the correct start and end times. 
  9. When finished, click Save or click Cancel to exit and not save any entered data. 

Deleting an Event from Web Calendar

While it is a simple procedure to get rid of an event, it is important to note that deleting or changing an event from Web Calendar will be audited on the Remedy side of the software.  See View More Detail on Audit Changes. 

File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image095.jpg

 

  1. From the Web Calendar place the cursor on the event to be deleted and perform a left mouse click.  The event dialog screen appears.
  2. File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image096.png
  3. Click Delete Event
  4. File:User:jack.boespflug/KineticCalendar-DeleteMeUserManual/image097.jpg
  5. Click the OK button to delete the event, or the Cancel button. 

...And Finally

Congratulations. 

We at Kinetic Data hope you have found this application allows for a simple approach to creating calendars and schedules whether used for your personal time management or for your entire organization. 

Our goal in creating this software is to help you and your company schedule, plan, coordinate and collaborate easily. 

If the Enterprise or Demo (versus Lite) edition was purchased and you need assistance, please call 651-695-8566, or contact us at www.kineticdata.com, and thank you for purchasing Kinetic Calendar