Obia catalog customization_guidelines

OBIA Catalog Customization Guidelines
This document gives us the steps to follow for doing any customizations to the OOTB delivered
catalog content. “Rip and replace will happen “when we apply any patch related to catalog
hence customer is advised not to modify any delivered content to do any customizations.
General Steps
If customer wants to do any customizations, please create a copy of the content and move it to
a folder called Custom, which is available under shared Folders.
Even if customer wants to customize only a report, they still have to create the copy of
dashboard and the associated components.
Ex: Consider report 1 is used in dashboard 1 and if customer customized report1 and named
report as report1_Custom and saved it under Custom folder. Then they have to create a copy of
dashboard 1 and save as dashboard1_custom in Custom folder .Now dashboard1_custom has to
be modified to refer new customized report report1_Custom.
We will use the following two examples to mention the steps needed for customizing a
delivered content
Example 1: Adding a new filter to a report
Example 2: Changing graph view to a different column
Example 1 -
Objective : Executive Overview > Overview > Admissions Funnel Trends
This has currently the filters Institution, Academic Year and Term. Need to add filter Academic
Program etc
a. As we are going to do customization to an existing report first create a copy of dashboard.
To create a copy click edit dashboard on right corner

And click save Dashboard as in the right corner
Save the dashboard as Executive Overview_CUSTOM and save in a folder called Dashboards Custom
which is under shared folder.
b. As we are going to customize Admissions Funnels trends please create a copy of it .
In the dashboard click on edit analysis for Admissions Funnels Trends.

The report will be opened, now click save as button in right corner to create a copy
Save the report as Admissions Funnels Trends_CUSTOM under Shared FoldersCUSTOMSIA

c. Create a copy of dashboard prompt to include new prompt field
Go to Executive Overview_CUSTOM dashboard under Custom
Click on edit Dashboard which is available in right corner and click on EDIT for Executive
Overview Prompt Vertical
Now create a copy of the prompt by clicking save as button in right corner.

And save prompt as Executive Dashboard Prompt Vertical_CUSTOM under /Shared
Folders/CUSTOM/SIA.
d. We created all the required contents and we have to do customizations now.
e. Add new filter to Admissions Funnel Trends_CUSTOM report.
Open the Admissions Funnel Trends_CUSTOM report which is under Shared
Folders/Custom/SIA

In the report go to criteria tab
Add Prospect Academic Program as a filter by clicking filters and selecting more columns
Select Prospect Academic Program which is under Academic Program prospect
In the operator select is prompted
Click ok and save the report.

f. Add new column prompt to Executive Dashboard Prompt Vertical_CUSTOM.
Open Executive Dashboard Prompt Vertical_CUSTOM which is under Shared
Folders/CUSTOM/SIA
Click on + button and select column prompt.
Select Prospect Academic Program under Academic Program Prospect.

Expand Options
Modify the Label as Academic Program
Enable Limit values by and select Institution, Academic Year and Term
Disable “Enable user to Type Values’ and enable “Require User Input” as show below
Save the dashboard prompt.

g. Now include the customized report and prompt in customized dashboard.
Open the Executive Overview_CUSTOM dashboard and click edit dashboard button.
Delete the Executive Dashboard Prompt Vertical and include customized dashboard prompt.
In the left side navigate to Shared Folders/Custom/SIA and drag and drop customized report
to the same section where there was a prompt.
Similarly delete the Admission Funnel Trends and place the customized report.
Save the dashboard and click the run button to view the dashboard.

Now the dashboard includes new prompt with Academic Program and the report will get
filtered with the selected value.
Example 2 -
Objective : Executive Overview > Recruitment > Prospect Analysis Trends
This has Academic Year based Prospect Count. Need to change it to Academic Term basedCount.
Probably making the Academic year as the Report Parameter will be helpful.
Click on Dashboards  Go to the custom dashboard: ‘Executive Overview_CUSTOM’
On the Executive Overview_CUSTOM Dashboard, select the tab – Recruitment.

For the report Prospect Analysis Trends, click on Edit.
The Prospect Analysis Trends report will be displayed.
Click on Save As.
Save the report in the CUSTOM path (/Shared Folders/Custom/SIA) as ‘Prospect Analysis
Trends_CUSTOM’

Once saved, click on the criteria tab of the report
On the left hand side pane, expand the SIA – Admissions and Recruiting – Student Recruiting subject
area.
Select and expand the folder Academic Term.
Select the field ‘Academic Term’. Drag and drop it to the selected columns.
Click the Results tab.

To modify the Horizontal axis of the graph to display the Academic Term only,
On the Left hand side pane, select the graph view and click Edit

In the Layout section,
Bar Graph
Bars - Horizontal axis – Move ‘Academic Year’ to the Excluded Section as shown below.
Click on Done.
Save the report.

Go to the Dashboard page Executive Overview_CUSTOM – Recruitment tab
Click on the icon on the extreme top right and click Edit Dashboard

On the Left hand side pane, expand Shared Folders  Custom  SIA

Move the report Prospect Analysis Trends_CUSTOM to the dashboard to replace the original report
Prospect Analysis Trends.
Remove the original report Prospect Analysis Trends from the dashboard Executive Overview_CUSTOM

Save the Dashboard.
View the Dashboard  Go to the custom dashboard: ‘Executive Overview_CUSTOM’  Recruitment tab
The Dashboard will now display the report Prospect Analysis Trends as the prospect count by the
Academic Term instead of Academic Year.

Obia catalog customization_guidelines

More Related Content

What's hot (7)

Similar to Obia catalog customization_guidelines (20)

Recently uploaded (20)

Obia catalog customization_guidelines