Import
import com.intellica.client.common.UserInfo;
import com.intellica.client.dashboard.Dashboard;
import com.intellica.client.dashboard.DashboardManager;
import com.intellica.client.reportutils.Category;
import com.intellica.client.exception.
LayoutHandlerException;
import java.util.Vector;
import java.util.HashMap;
Get Dashboard Details
This Java API is used to get the complete detail about the Dashboard like its Category, Description, Access Rights etc
Refer to <Intellicus_Install_Path>/SampleCodes/Java APIs/DashBoard Management/ GetDashboardDetails.java for sample code of this use case.
Steps:
- Initialize Report Client.
- Initialize Requestor UserInfo.
- Create a Dashboard Manager class object for Dashboard related settings.
DashboardManager dManager = new DashboardManager();
- Get the Dashboard details whose Dashboard Id is given.
Method: getDashBoardDetails
public DashBoard getDashBoardDetails (String dashboardId, UserInfo userInfo)
This method is used to get the requested DashBoard Object whose ID is passed as an argument.
Parameters:
- param dashboardId: The unique identifier of the dashboard for which the details are to be obtained from the Report Server.
- param userInfo: {@link com.intellica.client.common.UserInfo userInfo} object for authorization to get DashBoard.
- Returns: Dashboard {@link com.intellica.client.dashboard.DashBoard2 DashBoard2} object containing dashboard details
Dashboard dashboard = dManager.getDashBoardDetails(DashboardId, requestorUserInfo);
Get Dashboard List
This Java API is used to get the complete list of Dashboards from the Intellicus Repository for the Requestor user
Refer to <Intellicus_Install_Path>/SampleCodes/Java APIs/DashBoard Management/ GetDashboardList.java for sample code of this use case.
Steps:
- Initialize Report Client.
- Initialize Requestor UserInfo.
- Create a Dashboard Manager class object for Dashboard related settings.
DashboardManager dManager = new DashboardManager();
- Get the Dashboard list.
Method: getDashBoardList
public DashBoard getDashBoardList (Filter filterObj, UserInfo userInfo);
This method is used to get the list of Dashboards.
Parameters:
- param filterObj: Filter object to set EntityType, CategoryId, Depth.
- param userInfo: {@link com.intellica.client.common.UserInfo userInfo} object for authorization to get DashBoard.
- Returns: Arraylist of Dashboards Objects
dashBoardList = dManager.getDashboardList(filterObj, requestorUserInfo);
Get Dashboard Widget List
This Java API is used to get the complete list of the Dashboard widgets from the Intellicus Repository.
Refer to <Intellicus_Install_Path>/SampleCodes/Java APIs/DashBoard Management/ GetDashboardWidgetList.java for sample code of this use case.
Steps:
- Initialize Report Client.
- Initialize Requestor UserInfo.
- Create a Dashboard Manager class object for Dashboard related settings.
DashboardManager dManager = new DashboardManager();
- Get the Dashboard widget list whose Dashboard Id is given.
Method: getDashboardWidgetList
public ArrayList getDashboardWidgetList (Filter filterObj, UserInfo userInfo)
Parameters:
- param filterObj: Filter object to set EntityType DASHBOARD_WIDGET
- param userInfo: {@link com.intellica.client.common.UserInfo userInfo} object for authorization to get DashBoard.
- Returns: Arraylist of Dashboard Widgets
dashBoardWidgetList = dManager.getDashboardWidgetList(filterObj, requestorUserInfo);
Get Dashboard Widgets for Category
This Java API is used to get the widgets present in given Category from the Intellicus Repository.
Refer to <Intellicus_Install_Path>/SampleCodes/Java APIs/DashBoard Management/ GetDashboardWidgetsForCategory.java for sample code of this use case.
Steps:
- Initialize Report Client.
- Initialize Requestor UserInfo.
- Create a Dashboard Manager class object for Dashboard related settings.
DashboardManager dManager = new DashboardManager();
- Get the Dashboard widget list whose Dashboard Id is given.
Method: getDashboardWidgetList
public ArrayList getDashboardWidgetList (Filter filterObj, UserInfo userInfo);
Parameters:
- param filterObj: Filter object to set EntityType DASHBOARD_WIDGET
- param userInfo: {@link com.intellica.client.common.UserInfo userInfo} object for authorization to get DashBoard.
- Returns: Arraylist of Dashboard Widgets.
//To get the Dashboard list
filterObj.setFilterField(Enums.Filters.EntityList.ENTITYTYPE,Enums.Filters.EntityList.EntityType.DASHBOARD_WIDGET);
//To get Widget list for given Category.
filterObj.setFilterField(Enums.Filters.EntityList.CATEGORYID, categoryId); filterObj.setFilterField(Enums.Filters.EntityList.TRAVERSAL,Enums.Filters.EntityList.Traversal.DOWN);
dashBoardWidgetList = dManager.getDashboardWidgetList(filterObj, requestorUserInfo);
Delete Dashboard
This Java API is used to delete the Dashboard from the Intellicus Repository.
Refer to <Intellicus_Install_Path>/SampleCodes/Java APIs/DashBoard Management/ DeleteDashBoard.java for sample code of this use case.
Steps:
- Initialize Report Client.
- Initialize Requestor UserInfo.
- Create a Dashboard Manager class object for Dashboard related settings.
DashboardManager dManager = new DashboardManager();
- Delete the Dashboard whose Dashboard Id is given.
Method: getDashboardWidgetList
deleteDashboard (String dashBoardId, UserInfo userInfo);
This method is used to delete the dashboard specified by the dashboard ID passed as an argument.
Parameters:
- param dashBoardId: dashboard Id of the Dashboard i.e. to be deleted
- param userInfo: {@link com.intellica.client.common.UserInfo userInfo} object for authorization to get DashBoard.
dManager.deleteDashboard(dashBoardId, requestorUserInfo);
Get Dashboard Preferences
This Java API is used to get the list of the Dashboards set in its Preferences.
Refer to <Intellicus_Install_Path>/SampleCodes/Java APIs/DashBoard Management/GetDashboardPreferences.java for sample code of this use case.
Steps:
- Initialize Report Client.
- Initialize Requestor UserInfo.
- Create a Dashboard Manager class object for Dashboard related settings.
DashboardManager dManager = new DashboardManager();
- Get the Dashboard Preferences.
Method: getDashboardPreferences
Public ArrayList getDashboardPreferences(String dashBoardId, UserInfo userInfo);
Getting Dashboard Preferences Object.
Parameters:
- param filterObj: Filter containing ONWER_APPID, OWNER_ORGID
- param userInfo: {@link com.intellica.client.common.UserInfo userInfo} object for authorization to get DashBoard.
dbPreferencesList = dManager.getDashBoardPreferences(filterObj, requestorUserInfo);