HPE Haven OnDemand Salesforce Client Library

---

Overview

This library can be used to consume HPE Haven OnDemand - https://dev.havenondemand.com/apis in Salesforce.

---

What is HAVEN ONDEMAND?

Haven OnDemand is a set of over 70 APIs for handling all sorts of unstructured data. Here are just some of our APIs' capabilities:

• Speech to text
• OCR
• Text extraction
• Indexing documents
• Smart search
• Language identification
• Concept extraction
• Sentiment analysis
• Web crawlers
• Machine learning

For a full list of all the APIs and to try them out, check out https://www.havenondemand.com/developer/apis.

---

Installation

Using Unmanaged package

• Login in the Salesforce account and install package.

Using ANT

• Make sure ant is installed on the machine. Please check out this [link] (http://ant.apache.org/manual/install.html) to install the ant.
• Set username and password in build.properties. If your password is YYYY and security token in XXXX then password will be YYYYXXXX
• Open a cmd and enter follwing commands

ant -version
cd <HPE_Haven_OnDemand folder>
ant deployCode

---

Usage

Initialization

// with apikey and version
HODClient client = new HODClient(apiKey, version);

// with apikey (version will default to v2)
HODClient client = new HODClient(apiKey);

Sample post sync call (INDEX_STATUS)

try
{
      // create client
      HODClient client = new HODClient(apiKey, version);
      List<Param> params = new List<Param>(); 
      params.add(new Param('index','test'));
      // get response
      Map<String,Object> response= client.postRequest(params, HODAPP.INDEX_STATUS, HODClientConstants.REQ_MODE.SYNC);
}
catch (HODClientException ex)
{
     String message = ex.getMessage();
     System.debug(message);
}

Sample post async call (list resources)

try{
      // create client get job id
      HODClient client = new HODClient(apiKey, version);
      List<Param> params = new List<Param>(); 
      params.add(new Param('flavor',new List<String>{'standard','explorer'}));
      params.add(new Param('type',new List<String>{'content','connector'}));
      // get response
      Map<String,Object> data = client.postRequest(params, HODApp.LIST_RESOURCES, HODClientConstants.REQ_MODE.ASYNC);
      String jobId = data.get(HODClientConstants.JOB_ID);
}
catch (HODClientException ex)
{
     String message = ex.getMessage();
     System.debug(message);
}

// check job status
// if it is finished then getJobResult method can be used to get jobResult
try{
      Map<String,Object> data = client.getJobStatus(jobID);
      System.assert(data.get(HODClientConstants.JOB_RESPONSE_STATUS) == HODClientConstants.JOB_RESPONSE_FINISHED);
}
catch (HODClientException ex)
{
     String message = ex.getMessage();
     System.debug(message);
}

// get job data
try{
      Map<String,Object> data = client.getJobResult(jobID);
}
catch (HODClientException ex)
{
     String message = ex.getMessage();
     System.debug(message);
}

Sample post async call with file attachment (PREDICT API)

try{
      HODClient client = new HODClient(apiKey, version);
      // list of Param has to be passed for request with file attachment
      List<Param> params = new List<Param>(); 
      params.add(new Param('test.csv',Blob.valueOf(csvString),'application/CSV'));
      params.add(new Param('service_name','test'));
      params.add(new Param('required_label','test'));
      // call API
      Map<String,Object> data = client.postRequest(params, HODAPP.PREDICT, HODClientConstants.REQ_MODE.ASYNC);
      String jobId = data.get(HODClientConstants.JOB_ID);
}
catch (HODClientException ex)
{
     String message = ex.getMessage();
     System.debug(message);
}

Sample post async call with multiple file attachments (Text Extraction API)

try{
      HODClient client = new HODClient(apiKey, version);
      // list of Param has to be passed for request with file attachment
      List<Param> params = new List<Param>(); 
      params.add(new Param('test1.pdf',Blob.toPdf(pdfValue1),'application/pdf'));
      params.add(new Param('test2.pdf',Blob.toPdf(pdfValue2),'application/pdf'));
      // call API
      Map<String,Object> data =  client.postRequest(params, HODAPP.TEXT_EXTRACTION, HODClientConstants.REQ_MODE.ASYNC);
      String jobId = data.get(HODClientConstants.JOB_ID);
}
catch (HODClientException ex)
{
     String message = ex.getMessage();
     System.debug(message);
}

Error Handling

• All the calls throw HODClientException if there is an error

HODClient client = new HODClient(apiKey, version);
List<Multipart> params = new List<Multipart>(); 
params.add(new Multipart('test.pdf',Blob.toPdf('sample value'),'application/pdf'));
params.add(new Multipart('service_name','test'));
try
{
      String response= client.postRequestWithAttachment(params, HODAPP.PREDICT, HODClientConstants.REQ_MODE.ASYNC);
        
}
catch (HODClientException ex)
{
     String message = ex.getMessage();
     System.debug(message);
}

Parsing Response

• Method returns Map<String,Object>

// value can be type cast to appropriate class or data structure
Object value = response.get('key');

HODClient Instance Methods

    /**
     * calls POST Request
     *
     * @param params params to be passed in query string
     * @param hodApp end point to be called
     * @param mode sync/async
     * @return Map<String,Object> response
     * @throws HODClientException 
     */ 
    public Map<String,Object> postRequest(Map<String,Object> params, String hodApp, HODClientConstants.REQ_Mode mode)

    /**
     * calls POST Request with file attachments
     *
     * @param params params to be passed in post body
     * @param hodApp end point to be called
     * @param mode sync/async
     * @return Map<String,Object> response 
     * @throws HODClientException
     */ 
    public Map<String,Object> postRequestWithAttachment(List<Multipart> params, String hodApp, HODClientConstants.REQ_Mode mode)

    /**
     * Get status of the job submitted
     * @param jobId id of the job submitted
     * @throws HODClientException
     */
    public Map<String,Object> getJobStatus(String jobId)

   /**
     * Get result of the job submitted
     * @param jobId id of the job submitted
     * @throws HODClientException
     */
    public Map<String,Object> getJobResult(String jobId)