eWorksheet API

Generate eWorksheet

Pre-requisites : ewks_generator_api.jar should be available in Class path

Mandatory parameters :

• application      (String)- Application name

• reportSet        (String)- Parent folder / ReportSet name

• eWorksheet       (String)- Name of the new eWorksheet

• username         (String)- Originator

• connectionName   (String)- Connection to be used for executing the SQL Query

• sqlQuery         (String)- Query to fetch the data in the eWorksheet

• gpsServletURL    (String)- StateGps Url

Optional parameters :

• applicationId       (Double) - Application Id

• reportSetId         (Double) - ReportSet Id

• displayName         (String) - Display Name

• reportDescription   (String)-  Report Description

• groupName           (String) - Group Name

Code snippet for generateEworksheet :

     import eDynamo.ewkswizardapi.eWorksheetWizardHandler;

     eWorksheetWizardHandler  eWorksheetWizardETKHandler = new eWorksheetWizardHandler();

     eWorksheetWizardETKHandler.setConnectionName("<connectionName>");

     eWorksheetWizardETKHandler.setSQLQuery("<sqlQuery>");

     eWorksheetWizardETKHandler.setgpsURL("<gpsServletURL>");

        Hashtable<String,Object> saveModelHelperHashtable = new Hashtable<String,Object>();

saveModelHelperHashtable.put("saveasflag", false);

saveModelHelperHashtable.put("applicationId", "<applicationId>");

saveModelHelperHashtable.put("applicationName","<application>");

saveModelHelperHashtable.put("reportSetId", "<reportSetId>");

saveModelHelperHashtable.put("reportSet", "<reportSet>");

saveModelHelperHashtable.put("eWorksheet", "<eWorksheet>");

saveModelHelperHashtable.put("selectedXmlPath", "Categories");

saveModelHelperHashtable.put("username", "<userName>");

        if(displayName == null) {displayName = eWorksheet;} // If display name is null , reset to eWorksheetName                           

        if(reportDescription == null){reportDescription = eWorksheet;}   // If reportDescription  is null , reset to eWorksheetName

saveModelHelperHashtable.put("displayName", "<displayName>");

saveModelHelperHashtable.put("reportDescription", "<reportDescription>");

if(groupName != null) {saveModelHelperHashtable.put("groupName", "<groupName>");

}

  eWorksheetWizardETKHandler.startProcess(saveModelHelperHashtable);

  HashMap resultMap = eWorksheetWizardETKHandler.getResultsMap();

Result :

Ex ResultMap :  {MESSAGE=Viewer Report has been configured Successfully, OBJECT=true, viewerInstanceId=12458.0}

Test SQL query

Pre-requisites : ewks_generator_api.jar should be available in Class path

Mandatory parameters:

• connectionName (String) - Database Connection

• sqlQuery       (String) - Query to be executed

Optional parameters :

• •  recordCount    (Integer)   - Number of records to be fetched to test the query  (Default value is 10)

Code snippet for TestQuery:

       eWorksheetWizardETKHandler.setConnectionName("<connectionName>");

  eWorksheetWizardETKHandler.setSQLQuery("<sqlQuery>");

  Object queryResults = eWorksheetWizardETKHandler.testQuery("<recordCount>");

Result  :

if(queryResults instanceof Vector)

{

      Vector columnVector     = (Vector) ((Vector) queryResults).get(0);

      Vector tableDataVector = (Vector) ((Vector) queryResults).get(1);

}

Get available Roles to assign the new eWorksheet

Pre-requisites : ewks_generator_api.jar should be available in Class path

Mandatory parameters:

• application      (String)- Application name

• reportSet        (String)- Parent folder / ReportSet name

• eWorksheet       (String)- Name of the new eWorksheet

Code snippet for getting available roles:

       Hashtable rolesHashtable = eWorksheetWizardETKHandler.getRolesForSelectedeWorksheet("<application>", "<reportSet>", "<eWorksheet>");

Result  : Hashtable <String, Vector>

Ex : rolesHashtable = {Lead=[63160, false],  Manager=[63651, false]...}

      Key   :  Represents RoleName of type String

      Value :  Represents [Role_ViewerSet_Id, Assigned_Flag] of type Vector <Integer , Boolean>

Assign eWorksheet to Roles

Pre-requisites : ewks_generator_api.jar should be available in Class path

Mandatory parameters:

• viewerInstanceId (Double) - new eWorksheet Id

• rolesVector      (Vector) 

         Ex: Vector rolesVector = new Vector();

     Vector eachRole    = new Vector();

     eachRole.add("Lead");       - Role Name

     eachRole.add(Boolean.TRUE); - Boolean flag to Assign / Remove access 

     eachRole.add(63160);        - Represents Role_ViewerSet_Id

     rolesVector.add(eachRole);

Code snippet for getting available roles:

      Hashtable result = (Hashtable)eWorksheetWizardETKHandler.assigneWorksheetToRoles("<rolesVector>","<viewerInstanceId>");

Result  : Hashtable <String,String>

Ex : result = {message=Role is saved successfully.}

      Key   :  "message"

      Value :  Represents the status of the request