Note also that the sample prints routing error details to the console.

((DiscoveryServiceSoapBindingStub) service)._setProperty(
             Stub.ENDPOINT_ADDRESS_PROPERTY, serverUrl);

          ((DiscoveryServiceSoapBindingStub) service).setHeader(
             new XServiceServiceLocator().getServiceName().
             getNamespaceURI(), "SessionId", sessionId);

          ((DiscoveryServiceSoapBindingStub) service).setHeader(
             new XServiceServiceLocator().getServiceName().
             getNamespaceURI(), "UserName",
             "demouser@xactlycorp.com");

          boolean routed = routeDocumentBasedOnPlan("MD_GOOD_PLAN_PN",
                 service);

          if (routed) {
             Thread.currentThread().sleep(10000);
             int pageNumber = 0;
             boolean hasMore = false;
             do {

                 hasMore = queryDocStatus("MD_GOOD_PLAN_PN",
                    pageNumber++, service);

             while (hasMore);
          }

       }
   catch (Exception exc) {

       exc.printStackTrace();
   }

}

public static boolean routeDocumentBasedOnPlan(String docName,
       XService service) throws Exception {

   boolean result = false;
   RouteDocumentRQ req = new RouteDocumentRQ();
   XDocument xdoc = new XDocument();

   // Set the name of the document

   xdoc.setName(docName);
   DocumentOwner downer = new DocumentOwner();
   downer.setFetchByType(DocumentOwnerFetchByType.OnPlan);

   downer.setRouteBy(null);
   xdoc.setOwner(downer);

   // Set the hierarchy date to the effective date for
   // fetching the document owners

   xdoc.setHierarchyDate(Calendar.getInstance());
   req.setXDocument(xdoc);

// Call the RouteDocument request
   RouteDocumentRS response = service.routeDocument(req);

   if (!response.isResult()) {
       ErrorCode[] ecArr = response.getErrorCodes();
       for (int i = 0; i < ecArr.length; i++) {

          System.out.print("Error Code = " + ecArr[i].getCode());
          System.out.println(" : Error Reason = "

             + ecArr[i].getReason());
       result = false;

   } else {
       System.out.println("Document routed successfully.");
       result = true;

}

   return result;
}

public static boolean queryDocStatus(String docName, int pageNumber,
       XService service) throws Exception {

   RouteDocumentStatusRQ statusReq = new RouteDocumentStatusRQ();
   statusReq.setDocName(docName);
   statusReq.setPageNumber(0);
   // statusReq.setRoutingStatus(

   //    RouteDocumentStatusRQRoutingStatus.Pending);

   RouteDocumentStatusRS statusRS =
       service.queryDocumentStatus(statusReq);

   if (statusRS != null && statusRS.isResult()) {
       XDocument[] xdocArr = statusRS.getXDocument();

       for (XDocument xdocOne : xdocArr) {
          System.out.println("Initiator = " + xdocOne.getInitiator());
          System.out.println("Name = " + xdocOne.getName());
          System.out.println("Reason = " + xdocOne.getReason());
          System.out.println("CompletionDate = "

             + xdocOne.getCompletionDate());
          System.out.println("HierarchyDate = "
             + xdocOne.getHierarchyDate());

          System.out.println("Owner Name = "
             + xdocOne.getOwner().getName());

          System.out.println("RouteDate = " + xdocOne.getRouteDate());
          System.out.println("RoutingStatus = "

             + xdocOne.getRoutingStatus());
          StepInfo[] sInfo = xdocOne.getStepInfo();

 for (StepInfo step : sInfo) {
                    System.out.println("Step No: " + step.getStepNo());
                    System.out.println("Step Status: "

                       + step.getStepStatus());
                    System.out.println("Step UserName: "

                       + step.getUserName());
                    System.out.println("Step Information: "

                       + step.getInformation());

} }

          } else {
             ErrorCode[] ecArr = statusRS.getErrorCodes();
             for (int i = 0; i < ecArr.length; i++) {

                 System.out.print("Error Code = " + ecArr[i].getCode());
                 System.out.println(" : Error Reason = "

                    + ecArr[i].getReason());

                                        }

             return false;
          }

          return statusRS.isHasMore();
       }

}

Step 1: Getting an Instance of XService

The first step involves getting an the instance of XService and instructing the system to maintain the session.

   XService service = new XServiceServiceLocator().
       getDiscoveryService(new java.net.URL(
       "http://www.xactlycorp.com/icm/services/DiscoveryService"));

   ((DiscoveryServiceSoapBindingStub) service).setMaintainSession(true);

Step 2: Logging into the Xactly Connect Server

The next step involves logging into the Xactly Connect Server.

   LoginResponse loginResult = service.login(
       "demouser@xactlycorp.com", "password", "Incent");

   if (!loginResult.isAuthenticated()) {
       System.out.println("Login failed");
       return;

   else {
       System.out.println("Login successful ");
       ((DiscoveryServiceSoapBindingStub) service).clearHeaders();
       String sessionId = loginResult.getSessionId();
       String serverUrl = loginResult.getServerUrl();

((DiscoveryServiceSoapBindingStub) service)._setProperty(
          Stub.ENDPOINT_ADDRESS_PROPERTY, serverUrl);

       ((DiscoveryServiceSoapBindingStub) service).setHeader(
          new XServiceServiceLocator().getServiceName().
          getNamespaceURI(), "SessionId", sessionId);

       ((DiscoveryServiceSoapBindingStub) service).setHeader(
          new XServiceServiceLocator().getServiceName().
          getNamespaceURI(), "UserName",
          "demouser@xactlycorp.com");

                      }

Step 3: Routing the Document and Iterating Through the Responses

This step routes the document based on the plan, and then queries the document sta- tus every ten seconds. Note that the code checks whether there are more records available, and increments the page number before invoking the queryDocStatus operation again (see Step 4 and Step 5 below for more details).

   boolean routed = routeDocumentBasedOnPlan("MD_GOOD_PLAN_PN", service);

   if (routed) {
       Thread.currentThread().sleep(10000);
       int pageNumber = 0;
       boolean hasMore = false;
       do {

hasMore = queryDocStatus(“MD_GOOD_PLAN_PN”, pageNumber++, service); while (hasMore);

}

Step 4: Routing the Document

This step uses the routeDocument operation to route the document by plan (DocumentOwnerFetchByType.OnPlan). Other routing options including the following:

• DocumentOwnerFetchByType.Person • DocumentOwnerFetchByType.Title
• DocumentOwnerFetchByType.User

Note that you need to set the RouteBy field when routing a document by person (DocumentOwnerFetchByType.Person).

   RouteDocumentRQ req = new RouteDocumentRQ();
          XDocument xdoc = new XDocument();

// Set the name of the document

xdoc.setName(docName);
DocumentOwner downer = new DocumentOwner();
downer.setFetchByType(DocumentOwnerFetchByType.OnPlan);

Determining Xactly Incent Object Information

This sample shows how to use the describeXObject method to retrieve the meta- data associated with the object. You can use the describeXObject method to retrieve the field list, object properties, and data types.

   package com.xactly.icm.xtoolkit.client;

   import com.xactly.icm.xtoolkit.service.XService;
   import com.xactly.icm.xtoolkit.service.XServiceServiceLocator;
   import com.xactly.icm.xtoolkit.service.DiscoveryServiceSoapBindingStub;
   import com.xactly.icm.xtoolkit.wso.LoginResponse;
   import com.xactly.icm.xtoolkit.wso.UserWSO;
   import com.xactly.icm.xtoolkit.wso.XField;

   public class DescribeXactlyObject {
       private static XService service;
       public static void main(String[] args) throws Exception {

service = new XServiceServiceLocator().
   getDiscoveryService(new java.net.URL(
   "http://www.xactlycorp.com/icm/services/DiscoveryService"));

((DiscoveryServiceSoapBindingStub) service).
   setMaintainSession(true);

String username = "username";
String password = "password";

LoginResponse lr = service.login(username, password, "Incent");
((DiscoveryServiceSoapBindingStub) service).clearHeaders();

String sessionId = lr.getSessionId();
String serverUrl = lr.getServerUrl();

((DiscoveryServiceSoapBindingStub) service).
   _setProperty(Stub.ENDPOINT_ADDRESS_PROPERTY, serverUrl);

((DiscoveryServiceSoapBindingStub) service).setHeader(new
   XServiceServiceLocator().getServiceName().getNamespaceURI(),
   "SessionId", sessionId);

((DiscoveryServiceSoapBindingStub) service).setHeader(new
   XServiceServiceLocator().getServiceName().getNamespaceURI(),
   "UserName", username);

if (!lr.isAuthenticated()) {
   System.out.println("Login failed!");
   System.exit(-1);

}
UserWSO user = new UserWSO();

XField [] userFields = service.describeXObject(user);
for(int i=0; i < userFields.length; i++) {

   XField field = userFields[i];
   System.out.println("------------- Field -------------");
   System.out.println("Name: " + field.getName());
   System.out.println("Data Type: " + field.getDataType());
   System.out.println("Display Label: " +

       field.getDisplayLabel());
   System.out.println("Field Length: " + field.getLength());
   System.out.println("Is Required: " +

       field.getRequired());
   System.out.println("Is Searchable: " +

Step 1: Getting an Instance of XService

The first step involves getting an the instance of XService and instructing the system to maintain the session.

   XService service = new XServiceServiceLocator().
       getDiscoveryService(new java.net.URL(
       "http://www.xactlycorp.com/icm/services/DiscoveryService"));

   ((DiscoveryServiceSoapBindingStub) service).
       setMaintainSession(true);

Step 2: Logging into the Xactly Connect Server

The next step involves logging into the Xactly Connect Server.

   String username = "demouser@xactlycorp.com";
   String password = "password";

   LoginResponse lr = service.login(username, password, "Incent");
   ((DiscoveryServiceSoapBindingStub) service).clearHeaders();

   String sessionId = lr.getSessionId();
   String serverUrl = lr.getServerUrl();

  ((DiscoveryServiceSoapBindingStub) service).
       _setProperty(Stub.ENDPOINT_ADDRESS_PROPERTY, serverUrl);

   ((DiscoveryServiceSoapBindingStub) service).setHeader(new
       XServiceServiceLocator().getServiceName().getNamespaceURI(),
       "SessionId", sessionId);

   ((DiscoveryServiceSoapBindingStub) service).setHeader(new
       XServiceServiceLocator().getServiceName().getNamespaceURI(),
       "UserName", username);

   if (!lr.isAuthenticated()) {
       System.out.println("Login Failed.");
       System.exit(-1);

}

Step 3: Extracting the Metadata Information

This step uses the describeXObject method to retrieve the metadata associated with the object, including the data type, display label, length, and whether the object is required.

   UserWSO user = new UserWSO();

   XField [] userFields = service.describeXObject(user);
   for(int i=0; i < userFields.length; i++) {

       XField field = userFields[i];
       System.out.println("------------- Field -------------");
       System.out.println("Name: " + field.getName());
       System.out.println("Data Type: " + field.getDataType());
       System.out.println("Display Label: " +

          field.getDisplayLabel());
       System.out.println("Field Length: " + field.getLength());
       System.out.println("Is Required: " +

          field.getRequired());
       System.out.println("Is Searchable: " +

          field.getSearchable());

}