Page History

 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteAdministrationCall>
         <arg0>
            <loginId>admin@yellowfin.com.au</loginId>
            <password>test</password>
            <orgId>1</orgId>
            <function>RENAMEGROUP</function>
            <group>
               <groupId>13001</groupId>            	
            	<groupName>Report Creators</groupName>
            	<groupDescription>Users of this group will create reports.</groupDescription>
            </group>                    
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

 <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
         <return>
            <errorCode>0</errorCode>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
            <messages>Web Service Request Complete</messages>
            <sessionId>2ca79b1696913aa7a4f8b601ac1641a4</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

• Displayed below is a basic request for this function:
  
  

  Code Block
  language java
  AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(1); rsr.setFunction("RENAMEGROUP");

  
  
  

• To search for a group within a specific client, include its Client Org ID. (If not included, then the group will be searched in the default (that is, the Primary Org) group).

  Code Block
  language java
  rsr.setOrgRef("org1");

  
  
  

• Define a group to rename it:
  
  

  Code Block
  language java
  AdministrationGroup group = new AdministrationGroup();

• Identify the group by its group ID:
  
  

  Code Block
  language java
  group.setGroupId(13002);

• Provide a new group name and description:
  
  

  Code Block
  language java
  group.setGroupName("Org 1"); group.setGroupDescription("Organization 1 user group"); rsr.setGroup(group);

  
  
  

• Once the request is configured, perform the call:
  
  

  Code Block
  language java
  AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

  Initialize the Administration web service. Click here to learn how to do this. 

• The response returned will contain these parameters:
  
  

  Response Element	Data Type	Description
  StatusCode	String	Status of the web service call. Possible values include: SUCCESS FAILURE

<%            
/*              ws_renamegroup.jsp                */
%>
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="com.hof.util.*, java.util.*, java.text.*" %> 
<%@ page import="com.hof.web.form.*" %>
<%@ page import="com.hof.mi.web.service.*" %>
<%
AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false);        // adjust host and port number

AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();

rsr.setLoginId("admin@yellowfin.com.au");          // provide your Yellowfin web services admin account
rsr.setPassword("test");                           //password of the account above
rsr.setOrgId(1);

rsr.setFunction("RENAMEGROUP");

rsr.setOrgRef("org1");                        // provide org reference if required. Default org will be searched otherwise

AdministrationGroup group = new AdministrationGroup();

group.setGroupId(13002);                         // identify the group to rename
group.setGroupName("Org1");                      // new group name

group.setGroupDescription("Organization 1 user group");               // new description

rsr.setGroup(group);


AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

if ("SUCCESS".equals(rs.getStatusCode()) ) {
	out.write("Success.<br>");
} else {
	out.write("Failure");
	out.write(" Code: " + rs.getErrorCode());
}
%>