Don't run late! Get Calendar and Schedule up and running 'on-time' in 'no-time'. Let’s get it done fast
Agenda Installing and Configuring Creating Calendars Calendar and Schedule Creating Calendars Configuring Parameters Branding Click handlers
Resources Download package for “CalendarSchedule Training support files.zip” from: Training Support File Expand zip file These files are already configured for the training We will install Kinetic Calendar v2.0.4 Kinetic Schedule v1.2
Our environment Calendar and Schedule are already installed on the matrix VM. Directory structure on matrix
Preparing for Calendar/Schedule Installation We will uninstall first. Log into matrix with kin/kinetic Stop kineticTomcat with command sudo service tomcatKinetic stop Password is kinetic Delete kineticCalendar and kineticSchedule directories Delete work directories of previous installation.
Preparing for Calendar/Schedule Installation Refer to http://community.kineticdata.com/40_Kinetic_Calendar/Documentation/Ve rsion_2.0/08_Installation http://community.kineticdata.com/42_Kinetic_Schedule/Documentation/Ki netic_Schedule_1.2/Installation Copy war files into tomcat/webapps directory Copy from downloadedKEGfiles/Calendar Copy from downloadedKEGfiles/Schedule
Preparing for Calendar Installation Copy files for training Copy downloadedKEGFiles\Calendar\WEB-INF\lib\* into kineticCalendar\WEB-INF\lib Start tomcatKinetic service Sudo service tomcatKinetic start Password is kinetic
Preparing for Calendar Installation Activity 1 Complete actions on slides 6,7,8
Configuring Kinetic Calendar Run URL http://matrix.kineticdata.com/kineticCalendar/AdminConsole Login with admin/admin By default the installation will come with some configurations These will show errors in the console, which we will ignore because we are going to provide a new configuration directory Click on the Properties tab and configure the values based on the package file provide: downloadedKEGFiles\Calendar\property.txt
Configuring Kinetic Calendar Calendar has now been installed and configured with predefined Calendars
Configuring Kinetic Calendar Activity 2 Complete actions on slides 10, 11
Configuring Kinetic Schedule Kinetic Schedule does not have an AdminConsole Schedule will now already be installed, but will need configuration. Copy files downloadKEGfiles\Schedule\properties.xml and license.txt The properties files will reference the predefined configurations directory for the session. Restart tomcatKinetic sudo service tomcatKinetic restart
Configuring Kinetic Schedule Run URL http://matrix.kineticdata.com/kineticSchedule
Configuring Kinetic Schedule Activity 3 Complete actions on slides 13, 14
Creating Calendars - Kinetic Calendar All information can be found on: http://community.kineticdata.com/40_Kinetic_Calendar/Documentation/Ve rsion_2.0 Let’s focus on example calendars that have already been configured. Asset Information Oracle Adapter Firstly Adapters An adapter is code that is able to communicate to the targeted system. Each adapter must be installed and configured for the environment. We are using two examples, Kinetic Matrix a BMC connection to the Matrix, and the Oracle Adapter connecting to the underlying Oracle Database.
Creating Calendars - Kinetic Calendar Adapters are installed as java code either as classes or within jar files. Each adapater type will have it own code. The adapter class will be registered in the adapters.json. Eg. /home/kin/apps/configuration/KineticCalendar BMC Adapter & Oracle Adapter
Creating Calendars - Kinetic Calendar Connections use an adapter Each Calendar event will refer to a connection Credentials used in the connection must have valid permission to the targeted data source.
Creating Calendars - Kinetic Calendar The definition of the Calendar itself must be configured as set of json files These must be located in the configuration directory Each Calendar will have its own directory A calendar.json file defines the Calendar One or more et_XXX.json files define the event types that can be viewed within a Calendar
Creating Calendars - Kinetic Calendar calendar.json
Creating Calendars – Kinetic Calendar et_events.json connectionName Indicates configured connection configuration Identifies remedy form and qualification coreMappings Identifies fields that are used to for specific event detailMappings Any fields that you wish to display when a user clicks an event filterMappings Fields and values that a user can filter in/out events
Creating Calendars - Kinetic Calendar Let’s have a look at the calendar in action. Load URL http://matrix.kineticdata.com/kineticCalendar Click Asset Information
Creating Calendars - Kinetic Calendar Oracle Adapter sample
Creating Calendars - Kinetic Calendar Oracle Adapter et_events.json All configuration is similar to previous example, except the configuration values are specific for this type of adapter. Configuration “Events Query” SQL for events “Event Query” SQL for specific event details
Creating Calendars - Kinetic Calendar Let’s have a look at the Oracle Adapter example. Load URL http://matrix.kineticdata.com/kineticCalendar Click Oracle Adapter
Creating Calendars - Kinetic Calendar Activity 4 Complete actions on slides 22, 25 Nothing to do except run the URLs
Creating Calendars – Kinetic Schedule All information can be found on: http://community.kineticdata.com/42_Kinetic_Schedule/Documentation/Ki netic_Schedule_1.2/Installation Let’s focus on an example calendar that has already been configured. Tech Schedule Adapters Like Kinetic Calendar, Kinetic Schedule follows the same design architecture So an adapter is the same concept
Creating Calendars – Kinetic Schedule Adapters are configured in the adapters file
Creating Calendars – Kinetic Schedule Connections are stored in the files but do not have an Admin Console like Calendar yet. Instead the details must be maintained in the files directly.
Creating Calendars - Kinetic Schedule The definition of the Calendar itself must be configured as a set of json files These must be located in the configuration directory Each Calendar will have its own directory A cal_XXX.json file defines the Calendar A res_XXX.json file defines the Resource A ds_XXX.json file defines the Events XXX must be the same name as the directory these files are in
Creating Calendars - Kinetic Schedule cal_techschedule.json
Creating Calendars - Kinetic Schedule res_techschedule.json Identifies the resources such as people Source Name of the form sourceMapKey Field id for key SourceMapCriteria Qualification for query
Creating Calendars - Kinetic Schedule ds_techschedule.json Defines the events related to defined resources Source Name of the form sourceMapKey Field id for key SourceMapCriteria Qualification for query
Creating Calendars - Kinetic Schedule Let’s have a look at the calendar in action. Load URL http://matrix.kineticdata.com/kineticSchedule Click Tech Schedule
Creating Calendars - Kinetic Schedule Click in an empty slot to schedule a resource to a time. This will launch a Kinetic Request page, to enter details. When completed, refresh the calendar to view the scheduled event.
Creating Calendars - Kinetic Schedule There may be a slight delay in processing the Schedule event request
Creating Calendars - Kinetic Schedule Activity 5 Complete actions on slides 35, 36, 37 Nothing to do except play with the calendar
Calendar - Passing Parameters A calendar can be displayed by applying various parameters, in this example we are focusing on a parameter that controls the events query. Refer to http://community.kineticdata.com/40_Kinetic_Calendar/Documentation /Version_2.0/12_Adapters/BMC_Remedy_ARS_Adapter I have pre-configured a copy of the asset_information calendar called asset_information_byowner
Calendar - Passing Parameters A qualification can then be defined to expect a value as a parameter and entered as part of the qualification definition.
Calendar - Passing Parameters Let’s run the calendar using the following URL http://matrix.kineticdata.com/kineticCalendar/calendar?id=asset_informati on_byowner¶meter[group]=Admin Try changing the group value to other values Admin Network Desktop
Calendar - Passing Parameters Activity 6 Complete actions on slides 40 Nothing to do except run the calendar and inspect the files
Schedule - Passing Parameters Like Kinetic Calendar, Schedule also allows a calendar to be loaded based on parameters being passed in the URL I have pre-configured a copy of the techschedule calendar called techschedule_bycity
Schedule - Passing Parameters Parameters can be applied to the Resource data and the Event data The parameter is encased in the {{}} chars and applied to the qualification File res_techschedule_bycity.json
Schedule - Passing Parameters Let’s run the URL http://matrix.kineticdata.com/kineticSchedule/calendar?CalendarName=te ch_schedule_bycity&city=St.%20Paul
Schedule - Passing Parameters Activity 7 Complete actions on slides 44 Nothing to do except run calendar and expect files
Calendar Branding Kinetic Calendar can be branded to adopt your color themes and include your logo. A calendar may also be displayed in another language. This is accomplished by applying a custom theme, which can be easily based on the supplied default theme. A pre-defined example has been created called asset_information_fr This will show some customizations and also show the calendar in French
Calendar Branding Copy the directory downloadKEGfiles\Calendar\themes\french To /home/kin/apps/tomcatKinetic/webapps/kineticCalendar/themes
Calendar Branding Most visual aspects of Calendar can be configured Too many parts to go through now I have focused on changing the logo and banner area, to emulate your company branding being applied. Load URL http://matrix.kineticdata.com/kineticCalendar/calendar?id=asset_information_fr
Calendar Branding Within the new theme directory Applying the language pack Refer to the language pack required in file calendar.jsp Change logo Set the preferred logo file in file interface/fragments/contentHeader.jspf
Calendar Branding Change the header banner color and size Alter styles in file resources/css/themes.css
Calendar Branding Activity 8 Complete actions on slides 48, 49 Inspect files and change values to experiment
Schedule Branding Kinetic Schedule can also be branded to adopt your color themes and include your logo. A calendar may also be displayed in another language. This is accomplished by applying a custom theme, which can be easily based on the supplied default theme. A pre-defined example has been created called tech_schedule_de This will show some customizations and also show the calendar in Danish
Schedule Branding Copy the directory downloadKEGfiles\Schedule\themes\danish To /home/kin/apps/tomcatKinetic/webapps/kineticSchedule/themes
Schedule Branding Most visual aspects of Schedule can be configured Too many parts to go through now I have focused on changing the logo and banner area, to emulate your company branding being applied. Load URL http://matrix.kineticdata.com/kineticSchedule/calendar?CalendarName=tech_s chedule_de
Schedule Branding Within the calendar file cal_techschedule_de.json Refer to the new theme This tells the calendar to load the correct themed version
Schedule Branding Within the new theme directory Applying the language pack In file jsp/main_de.jsp Change logo Set the preferred logo file in file jsp/viewfragments/_headerBanner.jspf
Schedule Branding Activity 9 Complete actions on slides 53, 54 Inspect files and change values to experiment
Calendar Click Handlers Click Handler definition allow you to extend functionality for users of the calendars. Refer to documentation http://community.kineticdata.com/40_Kinetic_Calendar/Documentation/Version _2.0/10_Configuration/20_Configuration_Files/Click_Handlers There 2 types of handlers, URL and Javascript We will focus on a javascript example
Calendar Click Handlers Using a clickHandler, the default behavior can be overridden to whatever solution makes sense. Copy the contents of the file downloadKEGfiles\Calendar\javascript\event_dump.txt to /home/kin/apps/configuration/KineticCalendar/calendars/asset_information/et_ events.json This calls a predefined function within the themes theme.js
Calendar Click Handlers Load URL for the AdminConsole http://matrix.kineticdata.com/kineticCalendar/AdminConsole Click the Reload Configuration button Now run the URL http://matrix.kineticdata.com/kineticCalendar/calendar?id=asset_informati on
Calendar Click Handlers Click on any event, and a dialog identifying the content of an event will display.
Calendar Click Handlers Activity 10 Complete actions on slides 59, 60
Schedule Click Handlers Refer to documentation http://community.kineticdata.com/42_Kinetic_Schedule/Documentation/Kinetic _Schedule_1.2/Configuration/Click_Handlers The techSchedule calendar already has a URL clickHandler defined
Schedule Click Handlers Let’s configure a click handler against the resources for the techSchedule calendar. Copy the js directory downloadKEGfiles/Schedule/clickHandler/js To /home/kin/apps/tomcatKinetic/webapps/kineticSchedule/themes/default This file contains a javascript file with a function called test
Schedule Click Handlers Copy file downloadKEGfiles/Schedule/clickHandler/_main.jspf To /home/kin/apps/tomcatKinetic/webapps/kineticSchedule/themes/default/jsp/Fragme nts This changes includes the custom.js file in the calendar
Schedule Click Handlers Copy file downloadKEGfiles/Schedule/clickHandler/res_techschedule.json To /home/kin/apps/configuration/KineticSchedule/calendars/techschedule This change includes the definition of the clickHandler
Schedule Click Handlers Load the URL http://matrix.kineticdata.com/kineticSchedule/calendar?CalendarName=tech_s chedule Click on a resource
Schedule Click Handlers Activity 11 Complete actions on slides 64, 65, 66, 67
Q & A