Cognos 8
December 2009
Arkansas Public School Computer Network
101 East Capitol, Suite 101
Little Rock, AR 72201
This page intentionally left blank.
2
Table of Contents
Accessing Cognos Connection .........................................................................5
Default Cognos Connection Screen..................................................................8
Navigating In Cognos Connection...................................................................10
Setting Preferences for Cognos Connection...................................................13
Running Reports in Cognos Connection.........................................................14
Procedure for Running a Report (option 1............................................16
Procedure for Running a Report (option 2) ..........................................20
Cognos Viewer................................................................................................28
Cognos Viewer Menu Options and Icons .............................................29
Working in the Public Folder ...........................................................................32
Customizing My Folders .................................................................................34
Procedures for Creating New Folders ..................................................34
Folder Management .............................................................................36
Updating Folder Information......................................................36
Moving Folders..........................................................................37
Deleting Folders ........................................................................38
Adding Report Items to My Folders.................................................................39
Procedures for Creating A Copy of a Report Item................................39
Procedures for Creating A Shortcut of a Report Item...........................41
Procedures for Creating A Report View of a Report Item.....................45
Creating a Report View (option 1) .............................................45
Creating a Report View (option 2) .............................................48
Setting the Home Location..............................................................................51
Using Cognos Connection Search ..................................................................52
Procedures for Creating A New Page in Cognos Connection.........................54
Adding Content to Custom Page Components.....................................59
Managing Portal Pages........................................................................63
Creating Schedules and Jobs .........................................................................64
Procedures for Creating a Report Schedule.........................................64
Schedule Management……………………………………………..70
My Activities and Schedules……………………………….70
Current Activities…………………………………….71
Past Activities………………………………………..72
Upcoming Activities…………………………………73
Schedules……………………………………………74
Procedures for Creating a New Job .....................................................75
Cognos Connection Menu Items and Icons ....................................................82
Public Folders/My Folders Icons ..........................................................84
Additional Icons....................................................................................85
Report Item Icons and Actions........................................................................86
Item Icons.............................................................................................86
Report Action Icons..............................................................................88
Troubleshooting Tips ......................................................................................91
3
This page intentionally left blank
4
COGNOS CONNECTION
Cognos Connection is a web page that provides a single access point to run
public or personal reports on student data. Users can personalize Cognos
Connection by adding personal pages containing web pages, web links, or
reports.
Accessing Cognos Connection
1. Open a web browser such as Internet Explorer
2. In the Address box, type http://www.apscn.org
3. Hover over the Cognos link.
4. Click on the IBM Cognos 8 link.
5. The Log on screen appears.
WARNING: A shortcut to the Cognos login Screen should NEVER be
created. If a shortcut to Cognos is desired it should be to the
APSCN web page (www.apscn.org).
5
6. In the User ID box, type user login name; in the Password box, type user
password, and click OK. The Cognos welcome screen opens.
NOTE: The login and password used here are the same as the login and
password used for Plus.
The default screen that appears after logging into Cognos is the Welcome
Screen. If the “Show this page in the future” checkbox is unchecked, Cognos
will bypass the Welcome Screen and open on the user’s home screen. See
page 51 for more information on setting the home screen.
From the welcome screen, a link is provided (IBM Cognos content) to access
Cognos Connection. If the Home link is selected, the user’s defined home in
Cognos Connection will open. There is also a link for the user to Log Off of
Cognos from the Welcome Screen.
Query Studio will also be available from the Welcome Screen by selecting
Query my data.
NOTE: The Quick Tour button on the Welcome Screen will provide an
overview of Cognos Connection and Query Studio. There may be
other Cognos products discussed in the Quick Tour and Help areas
of Cognos Connection, such as Report Studio, which are not
available.
6
7. Click the IBM Cognos Content link or the My home link to enter Cognos
Connection.
Example of IBM Cognos Connection open to the Public Folders
7
DEFAULT COGNOS CONNECTION SCREEN
Once Cognos Connection opens, there are two tabs defined for each user on
the initial settings:
· Public Folders
· My Folders
Additional pages, or tabs, can be set based on the preference of the individual
user. More information on creating new pages in Cognos Connection can be
found on page 54.
8
Public Folders
Each user will only see folders to which he or she has access on the Public
Folders page. Reports for SMS will be accessed through the ADE APSCN –
Student Management System in the Public Folder. Within this folder there will
be a listing of different folders representing the modules in the Student
Management System. Each folder will house a set of report items that can be
generated for that particular SMS module. No changes can be made to the
items located in these folders. Report items located in the Public Folder can
be copied and saved in folders located in the My Folders section.
There are two types of folders located in the Public Folders section:
v The yellow folder contains report procedures or other folders that
contain report procedures.
v The blue folder represents a package. Package folders are only
used when authoring reports in Query Studio. NO REPORT ITEMS
WILL EXIST IN THESE FOLDERS.
My Folders
The My Folders section allows users to customize the contents to best fit the
needs of the user. Folders, report items, shortcuts to report items, report
views, and web links can be added to the My Folders section. More
information about customizing My Folders can be found on page 34.
9
Navigating In Cognos Connection
Cognos Connection makes use of links for users to maneuver throughout the
Cognos Connection website. Underlined items in Cognos Connection identify
links. When the cursor hovers over a link, the cursor will change to the link select
pointer ( ). A single click of the mouse will then activate the link. Portal tabs,
folders, report items, and some menu options are setup as links on the screen.
Example of links
Report items in the Public Folder will be located in the ADE APSCN – Student
Management System folder. Click the link for this folder to open the list of
subfolders seen on the following page.
10
Most folders in the ADE APSCN – Student Management System folder
correspond to the modules found in Student Plus. The two exceptions are the
District Repository folder and the District Shared folder. More information on
these two folders can be found on page 32.
The folders representing the modules in Student Plus may contain report items
or they may contain a group of subfolders. The following screen shows the
group of subfolders contained in the Demographic folder.
11
Below is an example of a screen that shows report items within a subfolder.
Note the icon in front of the report item name represents the format in which the
report will run when the report item link is selected. In this example, the icon
displayed ( ) indicates the report will run in an HTML format.
Crumb Trail
As folders are opened within Cognos Connection, a “crumb trail” or navigation
chain is created below the folder links indicating the menu path that was used to
get to the site that displayed on the screen. With the exception of the current
location, all other components of the “crumb trail” are links. Clicking on any one
of the folders displayed as a link in the “crumb trail” allows the user to return to
that folder.
Note: It is recommended that the links in the crumb trail be used to return
to a previous folder. Do not use the internet browser’s “Back arrow”
as it can cause unexpected results.
12
Setting Preferences for Cognos Connection
Menu Access: My Area Icon ( ) >> My Preferences
Through My Preferences users can define the overall look of Cognos
Connections. The list view format, style, default portal view and default report
format can all be set on this screen.
NOTE: The recommended format for printing reports is a PDF format. By
setting the report format to PDF in My Preferences, reports will
open in the PDF format.
Warning: Do NOT update settings in the Regional Options section, the
Personal Tab, and Portal Tabs.
13
Running Reports in Cognos Connection
Report items are stored in either Public Folders or My Folders. APSCN has
created standard reports for all districts that are located in the Public Folder titled
ADE APSCN – Student Management System. These reports can be run from
the Public Folder or copied over to a user’s private folders, and run from that
location.
Example of Public Folders window
To access the APSCN standard reports open the ADE APSCN – Student
Management System folder. The blue package folders ( ) do not contain any
reports and will not serve any function in Cognos Connection.
14
Most subfolders of the ADE APSCN – Student Management System folder
represent modules in Student Plus. Users will only see those subfolders to which
they have access. Access to these folders was granted based on information
from the Cognos Access Form signed by the superintendent of the district, NOT
by Student Plus securities.
Subfolders or report items are located under the different folders. With the
exception of the District Shared folders, report items in these folders are created
and maintained by APSCN personnel and cannot be updated or removed.
15
Procedure for Running a Report (option 1)
Note the “crumb trail” as a reminder of what folders are currently being accessed.
16
2. Click on the name of report to be run.
Warning: If the item icon is not followed with the run icon ( ), the default
action is to “View the most recent report”. When this occurs, and
a report has been saved under the report link, the saved report
will display rather than a generating a report showing the most
current data.
This situation should only exist in “My Folders” or the District
Shared folders. To change the default action to “Run the report”
on report items in either location, click on the property settings
icon ( ) in the Actions section of the report item. See page 94 for
more information on this issue.
17
3. When prompted select either the current year or NXT (Next Year’s
Scheduling) District Database.
4. If prompted, provide any required information. The asterisk next to a prompt
indicates that a selection is required before proceeding. Click Finish once the
prompts are completed.
Note: Some prompts allow for multiple selections. These prompts usually have
an option to “Select all” underneath the prompt. To select a partial group
of the available values, hold the control key down while clicking the
different values. Another option to select a group of values is to use shift
click. To use this option, click on a single value, hold the shift key down
and click on another value. All items between the two chosen values will
be selected.
18
5. When run, the report will appear in the format that was assigned when the
report procedure was created or as defined in the user’s My Preferences
menu.
Example of report in HTML format
19
Procedure for Running a Report (option 2)
1. Open the folder where the report item is located by clicking on the folder
name.
20
2. Click on the Run With Options icon ( ) on the report to be run.
3. Select Format and Delivery method. Leave Prompt for values checked.
Additional options, such as a delayed run time, and delivery method (email, or
view) of the report are available by selecting the “Advanced options” link.
21
When defining the advanced options the first selection to make is the mode in
which the report is run. By default “View the report now” is selected. In this
mode the only option available is the format in which the report will display.
The following options are available under Format.
Additional options are available for PDF and HTML formats.
Note: When running reports in an HTML format, removing the check on “Enable
selectionbased interactivity” will decrease the amount of time it takes to run the
report.
22
If “Run in the background” is selected the following screen opens allowing for
the report to be run at a later time with more delivery options.
When a report is run in the background multiple formats can be selected with
additional options for PDF reports available by clicking the Set… link. In addition
to defining paper size it is now possible to password protect a document by
providing a password when the report is run.
23
Access options can also be password protected as well as restricting reports
from being printed and are dependent on the property settings of the report item.
When setting the delivery method for reports run in the background, it is
recommended that the save option be unchecked so the report will not be
saved as a Cognos file. If the report is run PDF format it can be saved to a
file, such as My Documents on the user’s computer.
Note: The Select a printer option under the Delivery options currently has no
printers defined for delayed printing. Reports that need to be printed should be
opened in a PDF format and sent to a local printer.
24
When running a report in the background the recommended delivery option is to
send the report by email. To do this check the “Send the report by email” option
and click on the email option link ( ). On the email options window,
enter the address or addresses where the report will be sent. If multiple email
addresses are needed, they should be separated with semicolons. It is
suggested that the name of the sender of the report be added to the subject line
since that individual will not be identified otherwise. Type in any desired
message in the Body section and indicate if the report should be sent as a link or
an attachment. If the Body section is left blank and the report is sent in an HTML
format, the report will appear as the body of the email.
Email options window
Note: “Attach the report” should always be the selection when sending a
report via email. The option “Include a link to the report” requires
that the recipient have access to the folder in Cognos where the
report is stored.
Once the email options screen is completed, click OK to return to the options
screen.
4. Click Run on the Advanced options screen.
5. When prompted select either the current year or NXT (Next Year’s
Scheduling) District Database.
25
6. If prompted, provide any required information and click Finish.
7. If “Run in the background” is selected in the advanced options a summary
statement will appear displaying the settings used to run the report.
26
If “View the report now” is selected the report will appear in the format that
was assigned in the run options.
Example of report in PDF format
27
COGNOS VIEWER
Reports run in an HTML, PDF or XML format will open in Cognos Viewer.
Reports opened in Excel or CSV (Comma Separated Values) will open in the
browser in an Excel spreadsheet.
Example of report displayed in the Cognos Viewer in an HTML format.
An icon signifying the current format for the report is displayed at the top of the
screen with a dropdown menu arrow available to select a different format.
Once a report is open in the report viewer, the user has the option to save, save
as report view, email, or view the report in another format. A series of icons and
menu options appear at the top of the Cognos Viewer window that allows a user
to select the desired action.
28
COGNOS VIEWER MENU OPTIONS AND ICONS
v This dropdown menu provides
options for either saving or emailing the reports. The options available are:
· Email Report – allows a user to distribute a report via email.
· Save Report – saves a copy of the current report. The copy
can be accessed from the Actions menu of the report item used to
generate the report. Reports can only be saved in My Folders.
· Save the Report as Report View – creates a report view of
the report. Typically the report view is saved as another item in My
Folders, but can be saved in any personal folder.
v Run – this option will rerun the report in its current format and will
allow the user to change prompt values if desired.
v or Current report view – the dropdown menu next to the
icon allows for the selection of any of the following formats.
· View in HTML Format
· View in PDF Format
· View in XML Format
· View in Excel Options. Clicking this link opens a menu
allowing for several Excel formats.
29
§ Excel 2007 Format – This option is selected when
using Excel 2007.
§ Excel 2002 Format – This option is selected if using
Excel 2002 or later versions (up to Excel 2007). The report
appears the same as the Excel 2000 format.
§ Excel 2000 Single Sheet Format (default) – This option
shows all data on a single sheet and does not recognize
page breaks.
§ Excel 2000 Format – When viewing reports in this
format, separate tabs are created for each page in the
report. For each page break in the report a separate tab is
created.
§ CSV (Comma Separated Values) Format – Reports run
in this format will appear in an Excel spreadsheet. Headers
are ignored and treated as a separate field.
NOTE: See page 91 for troubleshooting tips on problems opening
a report in an Excel format.
v The dropdown menu allows for two
options.
· Allows for a shortcut to the
report to be created and stored in My Folders.
· Allows for a
bookmark for the report to be stored in the web browser
Favorites on the computer being used. A user must have
access to Cognos to use the link.
30
v Query Studio Access – This option allows access for a report item
to be opened in Query Studio for report editing purposes.
The icons are not currently used with SMS data.
To close Cognos Viewer and return to Cognos Connection, click the Home
icon ( ) or the Return icon ( ).
31
Working in the Public Folder
As noted previously, report procedures created by APSCN can be accessed
through the ADE APSCN – Student Management System folder in the Public
Folder. As seen below, this folder will contain a listing of several different folders
representing the modules in Student Plus. In addition to these “module” folders
there are two additional folders. The District Repository folder and the District
Shared folder allow report procedures to be shared between Cognos users. All
users have access to reports in the District Repository and District Shared
folders.
Note: No reports can be saved in the Public Folders with the exception of
the District Shared folder.
v District Repository – This folder contains subfolders for APSCN SMS Support
Personnel. This allows the support personnel to share report procedures with
district Cognos users. The folders are labeled with the name of the owner of
that folder. All Cognos users can access any District Repository folder to run
reports or copy report procedures for use within the district. Only the APSCN
SMS Support person who owns a folder can add, update or remove items
from that folder in the District Repository. Since these folders will be updated
32
at the discretion of the owner of the folder, it is recommended that users copy
report procedures to their personal folder (My Folders) for any procedure that
will be needed for future use.
v District Shared – Within the District Shared folder are two subfolders for
Cognos users to share report procedures with other Cognos users.
§ Districts (within your district only) – This folder is setup for district users
to share reports with other users within the district. Cognos users from
one district cannot access a folder from another district. To access the
district folder, users will first open either an Educational Coop folder or
an organization folder (Charter, Cooperatives, Vocational, etc.) with
which the school is a member. District personnel will maintain this
folder.
§ Transfer (temporarily share with another district) – The purpose of this
folder is to share report procedures with Cognos users in other
districts. When using this folder to share procedures it is
recommended that the transfer occur as quickly as possible. This
folder will be cleared on a routine basis by APSCN and items
copied into this folder could be removed at any time.
Note: Caution should be used when running reports from the “Transfer”
District Shared folder. A report that is custom built for one district
might not produce accurate results in another district.
33
Customizing My Folders
Initially My Folders will be empty. My Folders can be customized to allow users
quicker access to frequently used items. My Folders can be setup to contain
v Folders
v Report items
· Copies of report Items
· Shortcuts to report items
· Report views of report items
v Web Links
v Custom pages
Procedures for Creating New Folders
1. Open the location where the new folder will be stored. If creating a sub
folder, first open the folder where the new folder will be stored. Click on the
New Folder Icon ( ).
34
2. Define the folder name and information about the folder. Indicate the
location where the folder should be saved. Click the Finish button to save the
folder.
Note: Folders can be created in My Folders or within other folders in My Folders.
If the correct location is not selected prior to creating the folder, click the
link to select another location and indicate where the folder should be
saved.
The folder now appears in the location indicated when the folder was saved.
35
Folder Management
Once folders are created it is possible to update information on the folder, delete
a folder, or move a folder. These same options apply to report items as well.
Updating Folder Information
2. Update item Name, item Description, or Screen tip as needed.
3. Click OK to save the changes.
36
Moving Folders
1. Locate the folder to be moved and place a check in the folder next to the
item. Multiple items from the same location can be selected if necessary.
3. Open the location where the folder will should be moved. Note the
location displays in the crumb trail.
37
Deleting Folders
Warning: If a folder is deleted, the contents of that folder will also be
deleted.
1. Locate the folder to be deleted and place a check in the box next to the
item. Multiple items can be selected if necessary.
3. A warning message appears. Click OK to complete the process of
deleting the folder.
38
Adding Report Items to My Folders
Within Cognos Connection report items can be created in My Folders in one of
three ways:
1. Making a copy of an existing report item in the public folder and pasting it
in My Folders.
2. Creating a shortcut to a report item in the public folder.
3. Making a Report View of an existing report item.
Procedures for Creating A Copy of a Report Item
Report items can be copied from an original in any folder, renamed if desired,
and stored in a different location. A copy does not retain a link to the source from
which it was copied. If the source is deleted or changed, the copy is not affected.
1. Locate the item or items to be copied and place a check in the box at the front
of each report item. Checking the box located above the row of report item
checkboxes will check all items in the folder.
39
3. Open the location where the copies will be stored and click the Paste Icon
( ). Typically these items will be stored in My Folders or in a folder inside of
My Folders.
40
Procedures for Creating A Shortcut to a Report Item
A report item shortcut always uses the original report specifications when the
report is run. If the original report is changed, then the shortcut to the report item
will be generated on the new specifications.
The source of a shortcut is typically located in the Public Folders. Shortcuts
should never be created from a report item located in the District Shared folder or
the District Repository folder since these folders will be cleared periodically.
Warning: If the original report item is deleted, the link to the shortcut is
broken, and the shortcut will no longer work. A “broken” icon ( )
signifies a shortcut that is no longer linked to the source. The
report title is also no longer a link.
1. Locate the report item that will serve as the source of the shortcut and click
the link for additional action menu items ( ).
41
2. Click the Create a shortcut link ( ) on the Available Actions
menu.
3. Specify the identifying information (name, description and screen tip) of the
shortcut and indicate where in My Folders the shortcut is to be stored. It is
recommended that the Name contain the word “Shortcut” so that the report
item is easily identified as a shortcut.
To save the shortcut in a folder within My Folders or in a folder, first click the
Select My Folders link to change the Location to My Folders. Next click
Select another location….
42
When Select another location… is clicked a new screen opens with a “Crumb
trail” and the list of folders within My Folders. Unless another folder is
selected the shortcut will be saved in My Folders.
Locate the folder where the shortcut should be stored and click the radio
button. If the folder is contained inside one of the listed folders, continue to
click the folder links until the desired folder is located. If another folder needs
to be added click the New folder… link below the list of folders. This allows
the user to create a new folder before selecting where the shortcut will be
added.
Note the addition of the Scheduling folder in the second graphic.
43
4. After selecting the location where the shortcut will be stored, click Finish to
save the new shortcut.
Once saved, the shortcut is identified by the shortcut symbol in the report
item icon ( ) overlaid on the report type icon.
44
Procedures for Creating A Report View of a Report Item
A report view is a copy of a report item that has its own property settings. For
example, the base report might have a default setting of viewing the report on
screen in an HTML format, while the report view of the same report is being sent
to the printer in a PDF format. Creating a report view does not change the
original report. Since a report view shares the same report specification as the
source report, changes made to the source report will also be reflected in the
report view.
The report view can be created prior to running the report or based on the results
of running the report within Cognos Viewer.
Creating a Report View (option 1)
1. Locate the report item and click the Report View icon ( ).
45
2. Specify the name of the report view and location to store the report view and
click Finish.
46
4. Define the properties of the report view by clicking on the Report view (this
might be labeled as Query or Report) tab.
5. Define Report View properties. Change Default action to Run the Report,
click the Override the default values check box to set format, uncheck Prompt
for values and click Set to define the prompts. Click OK.
47
Creating a Report View (option 2)
1. Locate and run the report that will be set as a report view, answering any
prompts.
2. Click the menu link labeled Keep this version and select the Save as Report
View icon ( ) in the Cognos Viewer.
3. Specify the name of the Report view and location where the Report view
should be stored and click OK.
48
4. Once saved, click on the property values icon ( ) of the report view to set the
default for the report view.
5. Define the properties of the report view by clicking on the Report view tab.
49
6. Define Report View properties. Change Default action to Run the Report,
click the Override the default values check box to set format, uncheck Prompt
for values and click Set to define the prompts. Click OK.
Note: Advanced options are available when defining properties for a Report item,
a Report View item, or a Query item.
50
Setting the Home Location
Within Cognos Connection it is possible to select a home location. The home
location can be a page (portal tab) or a folder within a page. By default the home
screen is the Public Folder page.
To define the home location, open the page or folder that will be used as the
home location. Note the “Crumb Trail” indicates the current location, which in
this example will be defined as the home site.
Once the desired location is opened, click on the down arrow next to the home
icon ( ) then select the option “Set View as Home”.
The home icon is available from any page or folder in Cognos Connection as well
as in Cognos Viewer. By clicking the home icon ( ) the user automatically
opens the home location screen.
51
Using Cognos Connection Search
Users have the ability to perform searches in Cognos Connection to locate report
items or folders. There are options to search on the name of the item, the
description of the item or both. There is also an Advanced Search option to help
further define the search.
A search can be performed by typing a word or phrase in the search box and
clicking the search icon, or by clicking the search icon ( ) and first defining the
search options.
By clicking the down arrow next to the search icon ( ) options to search on
item Name, item Description, or item Name or Description are available. The
default search is by item name only.
If a search is performed from the main screen a new window with the results of
the search appear as seen below. Once report items are located they are fully
accessible.
Clicking either of the two search options can further refine the search.
52
If the search icon ( ) is clicked without defining search criteria the following
screen appears and allows the user to define search options.
Clicking the link next to “Search:” displays the following choices.
Clicking the Advanced search option link opens the following window displaying
the default selections. Clicking any selection link opens a list of options allowing
the user to make a different choice.
53
Procedures for Creating A New Page in Cognos Connection
Prerequisite: To manage custom pages, it is recommended a new folder be
created inside of My Folders where new pages will be stored. See page 34 for
more information on creating folders.
A description and screen tip can also be defined for the new page. The
default location for the new page to be stored will be My Folders. Click
to locate the custom folder where custom pages will be stored.
54
2. Click Next to set the number of columns, column width and content for the
new page.
Content items, or Portlets, for the new page are added by selecting Add at the
bottom of the window. Click on Cognos Content, Cognos Utility or the
Dashboard links to select items to be placed on the new page.
Note: Cognos Extended Applications does not apply to SMS.
55
3. Once the selected “Portlet” is open, select items to be placed on the new
page by placing a check in the checkbox of each item, then click the green
arrow ( ) to move the items to the selected entries section. Click OK to
save selections and repeat the process for each column on the new page.
4. Once each column has been defined click Next.
56
5. The screen that opens allows the user to assign a title and list instructions for
the individual components of the new page. The page style for the new page
can also be set.
6. Click Next. The next page that opens allows the user to add the new page to
the portal tabs in Cognos Connection. Click Finish.
57
Once a custom page is created, additional changes can be made by clicking the
Edit icon ( ).
A custom page can be redesigned to change the number of columns, the size
of the columns and the content type in each column.
58
Adding Content To Custom Page Components
When Cognos Navigator is added to a custom page, by default, both the Public
Folder link and the My Folders link are added.
To add content to a particular section, or change the existing content of a
particular section, click on the edit icon ( ). See the following example of
adding content.
59
Adding A Folder To Cognos Navigator
60
2. Set the properties for the section (portlet) of the new page. Define the title of
the portlet, select the folder that should appear in the portlet and indicate the
default view of the portlet. Also indicate the view options of the portlet.
Note: The properties window will differ depending on what content is being
defined on the new page.
61
3. Locate and select the correct folder to be displayed on the new page by
clicking the Select a folder… link on the properties page.
The default screen indicates that both Public Folders and My Folders will
display on the new page. Click the folder links to locate the folder that holds
the items to be displayed on the new page. Once the desired folder is located
click the radio button.
Click OK to save the folder selection and OK once again to save the property
values of the portlet. Repeat the process if more than one section or portlet
was added to the new page.
62
The items in the folders selected will be displayed on the new page. As items
are added or removed from the source folder, the changes will be displayed on
the custom page.
Managing Portal Pages
By clicking on the Tab Menu ( ) Portal Pages can be moved, hidden, or re
inserted if previously hidden. By clicking the dropdown menu, the following
options are available.
Ø Add Portal Tabs… gives the user the option of adding a portal tab
(page that has been previously hidden or a custom page that has not
yet been added as a new portal tab.
Ø Remove this Portal tab… allows the user to hide the portal tab that is
currently open.
Ø Modify the sequence… gives the user the ability to change the order
that the tabs appear in Cognos Connection.
Ø Edit this portal tab… allows the user to change the properties of the
portal tab that is currently open. This option is only available on
custom pages.
If more tabs exist than can be seen on the screen, the navigation icons ( ) at
the end of the row of tabs can be used to view the hidden tabs.
63
Creating Schedules and Jobs
Schedules are used to generate a single report on a regular basis. Jobs allow
users to run multiple reports at one time. A job can be scheduled or it can be run
upon demand. Schedules and jobs are saved in My Folders, or another personal
folder.
Procedures For Creating A Report Schedule
1. Select the Scheduling Icon ( ) for the report to be run.
Note: The report for which the schedule is being created must be housed
in My Folders. Schedules cannot be created on reports in the Public
Folders.
64
The first checkbox on the window allows for the user to “Disable the Schedule”.
Although checking this option disables the schedule, the settings are kept for
future use. Priority defaults to 3 and cannot be updated.
2. Define the frequency of the report schedule.
The top portion of the screen is where the Frequency is set. Options for
frequency are By Day, By Week, By Month, By Year or By Trigger.
Frequency ‘By Day’
65
Frequency ‘By Week’
Frequency ‘By Month’
Frequency ‘By Year’
Frequency ‘By Trigger’ (not used at this time)
66
3. Define the Start and End times of the schedule.
4. Under the Options check ‘Override the default values’ to change formats
and/or delivery options of the report.
Once checked new options appear on the screen.
Multiple formats can be selected if needed. For more information on setting PDF
options see page 23.
67
5. Select the delivery method or methods needed for the report schedule.
Delivery Methods
Ø Save the report – it is recommended that this option be unchecked.
Ø Print – printed reports will be in a PDF format. When printing reports, the
printer must be setup through Cognos. This option is not available at this
time.
Ø Email – if sending the report by email the “Edit the email options…” needs
to be selected to indicate the email addresses that are to receive the
report and if the report should be attached to the email or if the email
should include a link to the report. A subject line and the body of the email
can also be entered in the email options.
6. Check the ‘Override the default values’ check box at the bottom of the
schedule window. By checking this box a link appears that allows the report
prompts for the schedule to be addressed.
Note: If a schedule is being created on a Report View report item, the prompts
may be predefined. If this is the case, the “Override the default values”
checkbox should be left unchecked.
68
7. Once all settings are complete, click OK to start running the schedule.
Note: For information on troubleshooting problems with schedules see page 91.
69
Schedule Management
Once schedules have been created there is often a need to modify, disable or
remove the schedule completely. One way a report can be modified or disabled
is by clicking on the schedule icon ( ). Once in the schedule screen there is an
option to “Disable the schedule” that will keep the schedule from running but not
delete the schedule. Also, the schedule can be updated by simply redefining the
options in the schedule screen. To completely remove the schedule the “more”
link ( ) under the Actions menu can be clicked where the option for
“Remove the schedule” is available.
My Activities and Schedules
Another way schedules can be monitored and managed is from My Activities and
Schedules. There are options to monitor current activities and past activities as
well as seeing activities scheduled for the future. Users can also view and
manage the schedules that they have created. Each section provides a filter
section to change the focus of the listing. Also, next to every item in each section
of My Activities and Schedules there is a dropdown menu of different options
available for the item.
Menu Access: My Area icon ( ) >> My Activities and Schedules
70
Current Activities
The Current Activities area shows schedules that are executing or are about to
execute. In addition to a listing of the items there is a graphic representation
showing the number of schedules in each status. The filter section of the window
allows users to narrow the focus of the list. Activities listed here can be
cancelled or suspended. Suspended items can also be released.
The available icons for this section are:
Ø Show Details – displays details of the schedules
Ø Hide Details – hides the details of the schedules
Ø Cancel – cancels a specific schedule from running for a particular event
Ø Suspend – suspends a scheduled event until the release option is selected for the
event
Ø Release – used to allow a previously suspended even to run
The dropdown option ( ) next to each item provides the following menu:
71
Past Activities
The Past Activities section shows a history of the activity on the schedules. The
listing of the schedules will display a time and status for the schedule. The graph
at the top of the screen represents a count of the status for the listed schedules.
Filters can be set to narrow or broaden the focus of the schedule listing. For
example there is a filter option to indicate the time frame to use in searching for
past activities. There is also an option to see detail on the schedules.
The available icons for this section are
Ø Show Details – displays details of the schedules
Ø Hide Details – hides the details of the schedules
The dropdown option ( ) next to each item provides the following menu:
72
Upcoming Activities
When working in the Upcoming Activities section users can view all scheduled
activities for the date specified in the filter section. The list provides the date and
time the schedule is planned to run. The graph displays a count of each status
for the listed activities. In Upcoming Activities the status is either scheduled or
cancelled. To cancel a schedule, check the checkbox next to the schedule and
then click the Cancel icon ( ).
The available icons for this section are
Ø Show Details – displays details of the schedules
Ø Hide Details – hides the details of the schedules
Ø Cancel – cancels a schedule from running for a particular event
Ø Schedule – allows a previously canceled schedule to be reactivated
The dropdown option ( ) next to each item provides the following menu which
is dependent on the status of the item:
or
73
Schedules
The Schedules section provides a listing of all schedules that are currently
defined by the user. The listing for Schedules provides the name of the report
the schedule is created on and the current status of the report. The status will
either be listed as “enabled” or “disabled”. To disable a schedule place a check
in the checkbox next to the name of the report and click the Disable icon ( ). To
enable a schedule that has been disabled, place a check in the checkbox next to
the report name and click the Enable icon ( ).
The available icons for this section are
Ø Show Details – displays details of the schedules
Ø Hide Details – hides the details of the schedules
Ø Enable – allows a disabled schedule to be enabled
Ø Disable – allows a schedule to be disabled
The dropdown option ( ) next to each item provides the following menu:
74
Procedures for Creating a New Job
Note: The report items used when creating a New Job should be selected
from My Folders.
75
2. Add Report Items to the job by clicking the Add…link.
76
Indicate which report items should be included in the job by checking the box
next to the items. Once items are checked, click the green move ( ) button
to move the items to the Selected entries side of the screen. Click OK once all
report items have been added to the job.
NOTE: Report Items from multiple locations can be added to a job. Once all
desired items are selected from one folder, another folder can be
selected, and more items can be moved into the selected entries
section.
77
3. Define any report options or prompt values for each selected report item by
clicking the set/edit icon ( ).
Check the Override default values box on either Report options or Prompt values
to change the default values. Once either of these boxes is checked, new
options appear.
78
Under Report options, indicate the report format and delivery option.
NOTE: It is recommended that the option to Save the report not be selected.
The “Run the report to” option is used with the save option.
79
When the Prompt option box is checked, a link appears ( ) to predefine the
values for any prompts that exist in the report procedure.
Once the prompt values have been defined, options are available to view, edit or
clear the defined values.
Click the OK button once all settings for an individual report item are defined.
Repeat the process for each report item that needs to be defined.
80
4. Define the Submission of steps and Default for all steps options and click the
Next button.
NOTE: The Define for all steps option allows the report type and delivery options
(as seen on page 78) to be set for all items in the job.
5. Define the Action to be taken with the job. Click the Finish button.
v Save and run once – immediately runs the job and saves it for future use.
v Save and schedule – opens the schedule option for the job to be run on
regular intervals (see page 64 for more information on creating report
schedules) and saves the job for future use.
v Save only – the job is not run but saved for future use.
81
Cognos Connection Menu Items and Icons
The menu items that appear at the top of the Cognos Connection screen are
available within Public Folders, My Folders, and any private page created by the
user.
Note: THE CONTENTS OF THE LAUNCH MENU WILL VARY
DEPENDING ON USER ACCESS. QUERY STUDIO, WHICH IS
USED FOR REPORT AUTHORING, IS AVAILABLE UNDER THE
LAUNCH MENU.
Ø Refresh – refreshes the view of the open window. This option is
also available on custom pages.
Ø Log Off – logs user out of Cognos Connection.
Ø Home ( ) – returns user to the home page of Cognos Connection as
determined by the user under the Home Options.
Ø Home Options ( ) – there are two options when clicking the down
arrow next to the Home icon.
· Home – returns user to Cognos Connection home page.
· Set View as Home – sets current Cognos Connection page as
user’s home page.
Ø Search ( ) – allows the user to do a basic search of saved reports for
information in the Name field, the Description field or both. The desired
search criterion is entered in the dialog box next to the search icon. See
page 52 for information on searching in Cognos Connection. Clicking on
this icon without enter a search criteria will open the search results screen
with no results.
82
Ø Search Options ( ) – there are two search options available when
clicking the dropdown arrow next to the search icon.
· Search – performs a basic search.
· Advanced – opens up another screen where the search can be further
defined.
Ø – My Area icon allows access to the available tools used in Cognos
Connection.
· My Watch Items– this area of the portal is used to view and
manage watch items from a single location. Watch items are
defined based on numeric values and can be set in an HTML report
within Cognos Viewer.
· My Preferences – users can define the look and style of the
Cognos Connection screen. For example, the default view of
reports run from Cognos Connection can be adjusted from this
option. See Page 13 for more information on this option.
· My Activities and Schedules – allows a user to view and manage
the activity of a scheduled process as well as the schedule itself.
Ø – Help icon provides a variety of online help options for using
Cognos Connection.
83
Public Folders/My Folders Icons
v List View – allows items in a folder to be viewed in a list format.
This is the default setting for viewing items in a folder.
v Details View – allows items in a folder to be viewed in a format that
provides more detail on each item. This can be set as the default
view within the preferences option.
v New Folder – allows users to add new folders to My Folders or any
new page that has been created in Cognos Connection. When
adding a new folder a name, description and screen tip can be
assigned to the folder. See page 34 for information on creating
folders.
v New Job – allows user to schedule multiple reports to be run on a
regular basis and saved or sent via email. The reports being run
must be located in My Folders. See page 75 for information on
creating jobs.
v New URL – web links can be added in My Folders to easily access
frequently used web sites.
v New Page – gives user the ability to create a new page in Cognos
Connection (see page 54 for information on adding a new page).
This option is also available on custom pages.
v Cut – allows selected items in the current window to be removed
from the current location and pasted in another location.
v Copy – will copy selected items in the current window to be pasted
in another location.
v Paste – once items are cut or copied, this option will place the
items in the desired location.
84
v Delete – using this option will permanently remove an item from
Cognos Connection. Example:
To delete a folder, click the box to the left of the folder to
select it and then click the delete icon .
v Set Properties – allows users to set properties on My Folders.
Typically, the properties are set as they should be and this should
not have to be adjusted.
v Order – allows the user to change the default order of the folders
and items listed in My Folders. The default order is folders appear
first in alphabetical order, and then individual items appear in
alphabetical order.
Additional Icons
v Tab Menu – the menu options available under this icon allow
the user to add to, remove, or rearrange the order of the Portal Tabs
(pages) within Cognos Connection.
v Scroll left/Scroll right – allows the user to scroll between Portal
Tabs (pages) in Cognos Connection when there are more pages than
what can be viewed on a window.
v Edit – this icon is only available from custom pages. Users can
maintain the content for these pages by selecting this option.
85
Report Item Icons and Actions
Once a folder is selected, a listing of reports stored in that folder is displayed.
To view and/or print any report, click on the report link.
Example of Demographic Folder
Preceding each item in a folder, there is an icon that helps identify the item or
some property of the item. The icon on an item can change as different actions
are taken on that item or changes are made to the item.
ITEM ICONS
v this indicates the item is a folder. Clicking on this item will open
the folder and display the contents of the folder.
v indicates the item is a web link. Clicking on this item opens the
web page of the link.
86
v – reports with this designation can be edited in Query Studio.
v items with this icons are scheduled jobs.
v – icons with a small arrow in the lower left hand corner indicates that
the report is a shortcut. Shortcuts are links to existing reports in
another folder. Shortcuts always use the report definitions of the
source report. As the report definitions of the source report
changes, so will the report definitions for the shortcut. Also, if the
source report is deleted the shortcut will no longer work. See page
41 for more information on creating shortcuts.
v – indicates that a stored report will, by default, open in an HTML
format.
v – indicates that a stored report will, by default, open in a PDF
format.
v – indicates that a stored report will, by default, open in an Excel
2000 single sheet format.
v – indicates that a stored report will, by default, open in an Excel
2000 format.
v – indicates that a stored report will, by default, open in an Excel
2002 format.
v indicates that a stored report will, by default, open in an Excel
2007 format
v – indicates the item is a Report View, which is a reference to
another report, but has its own properties, such as prompt values,
schedules, and results. The Report View overlay can appear on
different icons. This example shows a PDF Report View.
v indicates a custom page saved in My Folders.
87
Report Action Icons
Following each item in the folder is an action or list of actions that can be taken
with that item.
v Set Properties – each item is assigned a set of properties by default
when the item is created. The owner/author of an item can change the
default property settings by selecting this option. On most items there are
general settings, run options, and permissions settings within the properties
screen. Also, default settings for a report can be set within the report
properties.
Note: Properties cannot be changed on items in the Public Folders.
v View output versions of report – this indicates that at least one version
of the actual report exists for the item. Multiple occurrences of a report can
exist as defined in the properties of the item. The item icon preceding the
name of the item generally identifies the format of the saved report. By
selecting this option, the saved reports can be viewed, downloaded or
deleted.
v Run with options – this selection gives the user different options as to
how the report should be run. The report format, time report is generated
and how the report is viewed (printed or viewed on screen) can all be
managed when running a report.
88
v Open with Query Studio – this option is available for users to open
reports in Query Studio. Users can select this option to make changes in
any report procedure created in Query Studio. Typically users will copy
these report items to “My Folders” before opening them in Query Studio.
v Create a report view – creating a report view allows the user to
generate a report, change property settings, such as report format, on the
report view without affecting the base report. For example, the base report
might have default settings of viewing the report on screen in an HTML
format, while the report view of the same report is being sent to the printer in
a PDF format. Creating a report view does not change the original report.
Since a report view shares the same report specification as the source
report, if changes are made to the source report within Query Studio, the
report view will also reflect these changes. See page 45 for information on
creating a report view.
v Schedule – indicates a schedule exists for the report. Reports or report
views can be set to run at regular intervals. The schedule option allows a
user to determine the frequency that the report is run, the formats in which
the report will be generated, the start and end time of the schedule, and how
the report should delivered (saved, printed, or emailed). If a report is
saved, the report properties determine how many versions of the report can
be stored before being overwritten. See page 64 for more information on
report schedules.
v Add to my Portal Tabs – if a custom page has not been setup as an
additional tab to a user’s Cognos Connection window, this icon will create
a new tab for the page.
v Additional actions – selecting this option provides the user
with additional actions that can be taken on an item. Some actions available
in this area give the user the ability to create shortcuts to reports, modify a
schedule, remove a schedule, move a report, or delete a report.
Example of additional actions menu
89
90
Troubleshooting Tips
I. Unable to open report in an Excel format using Internet Explorer –
If encountering problems opening a report in an Excel format when
using Internet Explorer, the following steps may have to be taken to get
Excel to open from Cognos Connection or Cognos Viewer.
Step 1: On the Internet Browser select Tools
Internet Options
Security
Trusted Sites – click the ‘Sites’ button
Uncheck “Require Server Verification”
Add site *.arkansas.gov
Step 2: On the Internet Browser select Tools
Internet Options
Security – click the “Custom Level” button
Download – Automatic Prompting for file
downloads – enable
Download – File Download – enable
Step 3: On the Internet Browser select Tools
Pop Up Blocker
Pop Up Blocker Settings
Add site *.arkansas.gov
Step 4: Add site *.arkansas.gov to any additional Pop Up Blocker
software installed on your machine.
.
– OR –
Step 1: Run the report in a PDF or HTML format.
Step 2: With the report on screen, hold the control key (Ctrl) and
click the “View in Excel…” icon.
II. Schedule Fails – If a schedule fails to run, the following items are
issues to check that are known to have caused a schedule to fail. See
page 72 for more information on reviewing the results of a scheduled
activity.
A. Password Changes – If a user makes a password change and
that user has schedules defined, the schedules will start to fail until
91
the user renews their credentials in Cognos. The user must go to
My Area ( ) >> My Preferences, select the Personal tab, and
click the Renew the credentials link.
B. Invalid Prompt Information – Occasionally it may be necessary to
review the prompt information that was defined for the report when
the schedule as set. Use the following steps to adjust the prompts
for a schedule.
2. Locate the Prompts section at the bottom of the screen and
click the Edit… link.
3. Select the correct Database Connection, and modify all
prompts with the correct information.
4. Once back on the main schedule screen click OK to run
the schedule with the new settings.
92
III. Unable to print full report – If the report will only print one screen at a
time it is usually an indication that the report is not displayed in a PDF
format. Once changed to a PDF report the printer icon ( ) should
appear in a banner directly above the report. When viewing a report in
Cognos Viewer the format of the report can be changed by clicking on
the dropdown menu next to the current display icon (typically the
HTML format ) and selecting the PDF format icon ( ).
NOTE: See page 13 for steps necessary to change the default report view
to PDF.
IV. Unable to access Cognos or unable to open folders in Cognos
Connection – One possible reason this problem exists is that a
shortcut was created that takes the user directly to the Cognos login
screen. In this situation it is possible the user will either not be able to
open the login screen OR be able to login and access Cognos but not
be able to open any folders in Cognos. Users should ALWAYS
access Cognos by going to the APSCN web page (
http://apscn.org) as noted on page 5.
93
V. Report opens in Query Studio each time it is run – By default, when
a report is created in Query Studio, the properties are set for the report
to always open in Query Studio. These reports are usually identified
by the Query Studio icon ( ) that appears next to the report link.
To fix this problem click on the Properties icon ( ) of the report and
change the Default Action under the Query tab to “Run the Report”,
then click OK.
VI. Always get a copy of an old report when clicking the report item
link – This typically indicates that the Default action in the properties is
set to “View Most Current” and there is a copy of a report stored with
the report item. This problem will generally exist in “My Folders”. The
following graphic shows how to locate report items that will produce
these results.
94
Note that the blue “Run” icon ( ) is missing next to the PDF ( ) report item and
that there is a stored version of the report as indicated by the “versions” icon ( )
located under the Actions menu.
To fix this problem click on the Properties icon ( ) of the report and change the
Default Action under the Query tab to “Run the Report”, then click OK.
95