Error rendering macro 'rw-search'

null

Page History

Versions Compared

Old Version 30

changes.mady.by.user user-3484a

Saved on 11 Mar, 2018

compared with

New Version 31

changes.mady.by.user user-3484a

Saved on 11 Mar, 2018

Key

This line was added.
This line was removed.
Formatting was changed.

...

Expand

title	DELUSERFROMGROUP

This function is used to remove a specific Yellowfin user from a specific user group. On doing so, the user will not appear in the group's member list at all.

This request will require the AdministrationPerson object to specify the user, and the AdministrationGroup object to define the user group.

Request Parameters

The following parameters will be passed with this request:

Request Element	Data Type	Description
LoginId	String	Yellowfin web services admin user ID. This can be the user ID or the email address, depending on the Logon ID method. This Yellowfin account must have the “web services” role enabled, and must belong to the Default (i.e. Primary) Org.
Password	String	Password of the above account.
OrgId	Integer	Default (i.e. Primary) organization ID within Yellowfin. Always set this to 1.
Function	String	Web services function. Set this to "DELUSERFROMGROUP".
Person	AdministrationPerson	Object containing details of the user who is to be deleted from the group. See table below.
Group	AdministrationGroup	Object containing details of the user group. See table below.
OrgRef	String	You may include a Client Org ID to search for this group within a specific client org. If this is not specified, then the group will be searched in the default organization.

Anchor

	deluserap
	deluserap

These are the main parameters that you need to set in the AdministrationPerson object for this function:

AdministrationPerson Element	Data Type	Description
UserId	String	An existing Yellowfin user to remove them from the group. This value could be a user ID or an email address, depending on the Logon method.

Anchor

	deluserag
	deluserag

These are the main parameters that you need to set in the AdministrationGroup object for this function:

AdministrationGroup Element	Data Type	Description
GroupName	String	Name of the group from which the user is to be deleted.

The following SOAP example shows the parameters that you can pass to this call:

Code Block

language	xml

<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>DELUSERFROMGROUP</function>
           <person>
           	<userId>binish.sheikh@yellowfin.com.au</userId>
           </person>
           <group>
           	<groupName>Administrators</groupName>
           </group>                     
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

Response Parameters

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

The service will return the below response, according to our SOAP example:

Code Block

language	xml

<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>ed4f6504e415411875b2c359b9384cf9</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

Instructions

See below for step-by-step instructions on how to perform this call, using a Java example:

Expand

title	Step-by-step instructions

Start with 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("DELUSERFROMGROUP");

You may specify a client organization to search for the group within it. But if not included, then the group will be searched in the default (that is, the primary) organization.
Code Block
language java
rsr.setOrgRef("org1");

Set parameters to identify a user who is to be deleted:

Code Block

language	java

AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("john.smith@yellowfin.com.au");  	// must be an existing Yellowfin user

rsr.setPerson(ap);

Set parameters for the group from which the user is to be deleted:

Code Block

language	java

AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Administrators");			//must be an existing 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

Complete Example

Below is a full example of this function. To use it for yourself, carry out the following the steps:

Copy the code and save it as ws_deluserfromgroup.jsp.
Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
Adjust the host, port, admin user, user to remove, and the group name according to your environment.
Run http://<host>:<port>/ws_deluserfromgroup.jsp from your Internet browser.

Code Block

language	java
theme	Eclipse

<%            
/*              ws_ deluserfromgroup.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");                           // set the password of the above account

rsr.setOrgId(1);

rsr.setFunction("DELUSERFROMGROUP");


//Specify the client org (if omitted, the default (primary) org groups will be searched):


rsr.setOrgRef("org1");


//Specify a user to remove from a group:


AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("john.smith@yellowfin.com.au");  		// must be an existing Yellowfin use

rsr.setPerson(ap);


//Specify which group to remove user from:

AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Administrators");                 // must be an existing user group

rsr.setGroup(group);

AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);


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

Anchor

	AssignDefaultDashboard
	AssignDefaultDashboard

Expand

title	ASSIGNDEFAULTDASHBOARD

This function is used to assign a particular dashaboard as the default dashboard for a specified user group. Use the ContentResource object to specify the dashboard and the AdministrationGroup object to identify the user group.

Request Parameters

The following parameters will be passed with this request:

Request Element	Data Type	Description
LoginId	String	Yellowfin web services admin user ID. This can be the user ID or the email address, depending on the Logon ID method. This Yellowfin account must have the “web services” role enabled, and must belong to the Default (i.e. Primary) Org.
Password	String	Password of the above account.
OrgId	Integer	Default (i.e. Primary) organization ID within Yellowfin. Always set this to 1.
Function	String	Web services function. Set this to "ASSIGNDEFAULTDASHBOARD".
Group	AdministrationGroup	Object containing details of the user group. See table below.
ContentResources	ContentResource[]	Object array containing the details of the dashboard that is to be made the default one for the group. See table below.

Anchor

	defaultdashag
	defaultdashag

These are the main parameters that you need to set in the AdministrationGroup object for this function:

AdministrationGroup Element	Data Type	Description
GroupName	String	Name of the group that is to be assigned a default dashboard.
GroupId	Integer	Unique ID of the user group.

Anchor

	defaultdashcr
	defaultdashcr

These are the main parameters that you need to set in the ContentResource object for this function:

ContentResource Element	Data Type	Description
ResourceId	Integer	ID of the dashboard.

Request Example

The following SOAP example shows the parameters that you can pass to this call:

Code Block

language	xml

<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>ASSIGNDEFAULTDASHBOARD</function>
            <group>
            	<groupName>Administrators</groupName>
            	<groupId>11950</groupId>
            </group>
            <contentResources>
            	<resourceId>61251</resourceId>
            </contentResources>
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

Response Parameters

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

The service will return the below response, according to our SOAP example:

Code Block

language	xml

<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>7b5510bf9919823f6067747b5d305984</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

Instructions

See below for step-by-step instructions on how to perform this call, using a Java example:

Expand

title	Step-by-step instructions

Start with 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("ASSIGNDEFAULTDASHBOARD");

Specify the group by using the AdministrationGroup object:

Code Block

language	java

AdministrationGroup administrationGroup = new AdministrationGroup();
administrationGroup.setGroupName("Administrators");
administrationGroup.setGroupId(11950);

Use the ContentResources object to specify a dashboard:

Code Block

language	java

ContentResource dashboardContentResource = new ContentResource();
dashboardContentResource.setResourceId(61195);

Then set this object in the request:

Code Block

language	java

rsr.setContentResources(new ContentResource[] { dashboardContentResource });

Once the request is configured, perform the call:
Code Block
language java
AdministrationServiceResponse rs = null; rs = rssbs.remoteAdministrationCall(rsr);
Initialize the Administration web service. Click here to learn how to do this.

The response returned will contain the StatusCode parameter. See the Response Parameters table above for details.

Complete Example

Below is a full example of this function. To use it for yourself, carry out the following the steps:

Copy the code and save it as ws_assigndefaultdashboard.jsp.
Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
Adjust the host, port, admin user, user to remove, and the group name according to your environment.
Run http://<host>:<port>/ws_assigndefaultdashboard.jsp from your Internet browser.

Code Block

language	java
theme	Eclipse

<%            
/*              ws_assigndefaultdashboard.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.*" %>
<%

AdministrationServiceResponse rs = null;
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();

rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(new Integer(1));
rsr.setFunction("ASSIGNDEFAULTDASHBOARD");
    
// This is the group 
AdministrationGroup administrationGroup = new AdministrationGroup();
administrationGroup.setGroupName("Administrators");
administrationGroup.setGroupId(11950);
    
rsr.setGroup(administrationGroup);

// This is the Dashboard
ContentResource dashboardContentResource = new ContentResource();
dashboardContentResource.setResourceId(61195);
    
rsr.setContentResources(new ContentResource[] { dashboardContentResource });
    
rs = rssbs.remoteAdministrationCall(rsr);

if ("SUCCESS".equals(rs.getStatusCode())) {
    out.write("Success");
} else {
    out.write("Failure");
    out.write(rs.toString());
}

...

Content

Space Tools

Page History

Versions Compared

Old Version 30

New Version 31

Key

Request Parameters

Response Parameters

Instructions

Complete Example

Request Parameters

Request Example

Response Parameters

Instructions

Complete Example