Page History

...

Expand
title LISTCLIENTS
The following code will call the Yellowfin web service and list all client organisations within Yellowfin: Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs = null; rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("LISTCLIENTS"); rs = AdministrationService.remoteAdministrationCall(rsr); The code will return an Array of AdministrationClientOrg objects and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed. This function will list all client organisations available within Yellowfin. Request Element Data Type Description LoginId String Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au Password String Password of the account used to connect to Yellowfin webservices OrgId Integer Primary organisation ID within Yellowfin. Always set this to 1. Function = "LISTCLIENTS" String Web services function 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

Expand
title GETCLIENT
The following code will call the Yellowfin web service and get the specified client organisation within Yellowfin: Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs = null; AdministrationClientOrg aco = new AdministrationClientOrg(); aco.setClientReferenceId("CLIENTREFERENCEIDHERE"); rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("GETCLIENT"); rsr.setClient(aco); rs = AdministrationService.remoteAdministrationCall(rsr); The code will return an AdministrationClientOrg object in rs.getClient() and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

...

...

This function will retrieve details for a specified client organisation within Yellowfin

...

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();

aco.setClientName("CLIENTNAME");
aco.setClientReferenceId("CLIENTREFERENCEIDHERE");
aco.setTimeZoneCode("AUSTRALIA/SYDNEY");
aco.setDefaultOrg(false);

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("CREATECLIENT");
rsr.setClient(aco);

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

...

The following code will call the Yellowfin web service and delete the specified client organisation within Yellowfin:

...

. Request Element Data Type Description LoginId String Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au Password String Password of the account used to connect to Yellowfin webservices OrgId Integer Primary organisation ID within Yellowfin. Always set this to 1. Function = "GETCLIENT" String Web services function Client AdministrationClientOrg The AdministrationClientOrg object holding the Yellowfin client reference ID for the retrieval process These are the parameters that you need to set in the AdministrationClientOrg object: AdministrationClientOrg Element Data Type Description ClientReferenceId Integer Client Reference ID for the specified client organisation 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

Expand
title CREATECLIENT
The following code will call the Yellowfin web service and create the specified client organisation within Yellowfin: Code Block AdministrationServiceRequest rsr

...

= new AdministrationServiceRequest(); AdministrationServiceResponse rs = null; AdministrationClientOrg aco = new AdministrationClientOrg(); aco.setClientName("CLIENTNAME"); aco.setClientReferenceId("CLIENTREFERENCEIDHERE"); aco.setTimeZoneCode("AUSTRALIA/SYDNEY"); aco.setDefaultOrg(false); rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("

...

CREATECLIENT"); rsr.setClient(aco); rs = AdministrationService.remoteAdministrationCall(rsr); The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

...

...

The function will create the specified client organisation

...

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();

aco.setClientName("CLIENTNAME");
aco.setClientReferenceId("CLIENTREFERENCEIDHERE");
aco.setTimeZoneCode("AUSTRALIA/SYDNEY");
aco.setDefaultOrg(false);

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("UPDATECLIENT");
rsr.setClient(aco);

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

Expand
title LISTUSERSATCLIENT
The following code will call the Yellowfin web service and list all users belonging to the specified client organisation within Yellowfin: Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs = null; AdministrationClientOrg aco = new AdministrationClientOrg(); AdministrationPerson[] people = null; aco.setClientReferenceId("CLIENTREFERENCEIDHERE"); rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("LISTUSERSATCLIENT"); rsr.setClient(aco); rs = AdministrationService.remoteAdministrationCall(rsr); people = rs.getPeople(); The code will return an Array of AdministrationPerson objects in rs.getPeople() and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

...

in Yellowfin. Request Element Data Type Description LoginId String Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au Password String Password of the account used to connect to Yellowfin webservices OrgId Integer Primary organisation ID within Yellowfin. Always set this to 1. Function = "CREATECLIENT" String Web services function Client AdministrationClientOrg The AdministrationClientOrg object holding the Yellowfin client reference ID for the retrieval process These are the parameters that you need to set in the AdministrationClientOrg object: AdministrationClientOrg Element Data Type Description ClientName String Name of the client organisation ClientReferenceID String Client Reference ID which is the unique ID used to identify a client TimeZoneCode String A client organisation's local time zone code. DefaultOrg Boolean Boolean value that returns true if this organisation is the primary organisation 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

Expand
title DELETECLIENT
The following code will call the Yellowfin web service and delete the specified client organisation within Yellowfin: Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs = null; AdministrationClientOrg aco = new AdministrationClientOrg(); aco.setClientReferenceId("CLIENTREFERENCEIDHERE"); rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("DELETECLIENT"); rsr.setClient(aco); rs = AdministrationService.remoteAdministrationCall(rsr); The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed. This function will delete the specified client organisation in Yellowfin. Request Element Data Type Description LoginId String Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au Password String Password of the account used to connect to Yellowfin webservices OrgId Integer Primary organisation ID within Yellowfin. Always set this to 1. Function = "DELETECLIENT" String Web services function Client AdministrationClientOrg The AdministrationClientOrg object holding the Yellowfin client reference ID for the retrieval process These are the parameters that you need to set in the AdministrationClientOrg object: AdministrationClientOrg Element Data Type Description ClientReferenceId Integer Client Reference ID for the specified client organisation 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

Expand
title UPDATECLIENT
The following code will call the Yellowfin web service and update the specified client organisation within Yellowfin: Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs = null; AdministrationClientOrg aco = new AdministrationClientOrg(); aco.setClientName("CLIENTNAME"); aco.setClientReferenceId("CLIENTREFERENCEIDHERE"); aco.setTimeZoneCode("AUSTRALIA/SYDNEY"); aco.setDefaultOrg(false); rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("UPDATECLIENT"); rsr.setClient(aco); rs = AdministrationService.remoteAdministrationCall(rsr); The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed. The following code will call the Yellowfin webservice and update the specified client organisation within Yellowfin. Request Element Data Type Description LoginId String Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au Password String Password of the account used to connect to Yellowfin webservices OrgId Integer Primary organisation ID within Yellowfin. Always set this to 1. Function = "UPDATECLIENT" String Web services function Client AdministrationClientOrg The AdministrationClientOrg object holding the Yellowfin client reference ID for the retrieval process These are the parameters that you can set in the AdministrationClientOrg object: AdministrationClientOrg Element Data Type Description ClientName String Name of the client organisation ClientReferenceId Integer Client Reference ID for the specified client organisation. Note that this is used for the initial retrieval process, and cannot be modified during the usage of this function TimeZoneCode String A client organisation's local time zone code. DefaultOrg Boolean Boolean value that returns true if this organisation is the primary organisation 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

Expand
title LISTUSERSATCLIENT
The following code will call the Yellowfin web service and list all users belonging to the specified client organisation within Yellowfin: Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs = null; AdministrationClientOrg aco = new AdministrationClientOrg(); AdministrationPerson[] people = null; aco.setClientReferenceId("CLIENTREFERENCEIDHERE"); rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("LISTUSERSATCLIENT"); rsr.setClient(aco); rs = AdministrationService.remoteAdministrationCall(rsr); people = rs.getPeople(); The code will return an Array of AdministrationPerson objects in rs.getPeople() and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed. This function will list all Yellowfin users belonging to the specified client organisation in Yellowfin. Request Element Data Type Description LoginId String Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au Password String Password of the account used to connect to Yellowfin webservices OrgId Integer Primary organisation ID within Yellowfin. Always set this to 1. Function = "LISTUSERSATCLIENT" String Web services function Client AdministrationClientOrg The AdministrationClientOrg object holding the Yellowfin client reference ID for the retrieval process These are the parameters that you need to set in the AdministrationClientOrg object: AdministrationClientOrg Element Data Type Description ClientReferenceId Integer Client Reference ID for the specified client organisation 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 People Array (AdministrationPerson) Array of AdministrationPerson objects. Each object holds Yellowfin user metadata.

Expand
title GETUSERACCESS
The following code will call the Yellowfin web service and list all client organisations accessible by a specified user within Yellowfin: Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs = null; AdministrationClientOrg[] clients = null; AdministrationPerson person = new AdministrationPerson(); person.setUserId("test@yellowfin.com.au"); rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("GETUSERACCESS"); rsr.setPerson(person); rs = AdministrationService.remoteAdministrationCall(rsr); clients = rs.getClients(); The code will return an Array of AdministrationClientOrg objects in rs.getClients() and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed. Request Element Data Type Description LoginId String Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au Password String Password of the account used to connect to Yellowfin webservices OrgId Integer Primary organisation ID within Yellowfin. Always set this to 1. Function = "GETUSERACCESS" String Web services function Person AdministrationPerson The AdministrationPerson object holding the Yellowfin user's User ID for the retrieval process These are the parameters that you need to set in the AdministrationClientOrg object: AdministrationPersonElement Data Type Description UserId String User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method 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 Clients Array (AdministrationClientOrg) Array of AdministrationClientOrg objects. Each object holds Yellowfin client organisation metadata

Expand
title ADDUSERACCESS
The following code will call the Yellowfin web service and add access to a specified client organisation for a specified user within Yellowfin: Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs = null; AdministrationClientOrg aco = new AdministrationClientOrg(); AdministrationPerson person = new AdministrationPerson(); person.setUserId("test@yellowfin.com.au"); aco.setClientReferenceId("CLIENTREFERENCEIDHERE"); rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("ADDUSERACCESS"); rsr.setPerson(person); rs.setClient(aco); rs = AdministrationService.remoteAdministrationCall(rsr); The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed. This function will add access to a specified client organisation for a specified user win Yellowfin. Request Element Data Type Description LoginId String Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au Password String Password of the account used to connect to Yellowfin webservices OrgId Integer Primary Organisation ID within Yellowfin. Always set this to 1. Function = "ADDUSERACCESS" String Web services function OrgRef String Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional. Person AdministrationPerson The AdministrationPerson object holding the Yellowfin user's User ID for the retrieval process Client AdministrationClientOrg The AdministrationClientOrg object holding the Yellowfin client organisation's Client Reference ID for the retrieval process These are the parameters that you need to set in the AdministrationPerson and AdministrationClientOrg objects: AdministrationPerson Element Data Type Description UserId String User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method AdministrationClientOrg Element Data Type Description ClientReferenceId Integer Client Reference ID for the specified client organisation 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

Expand
title REMOVEUSERACCESS
The following code will call the Yellowfin web service and remove access to a specified client organisation for a specified user within Yellowfin: Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs = null; AdministrationClientOrg aco = new AdministrationClientOrg(); AdministrationPerson person = new AdministrationPerson(); person.setUserId("test@yellowfin.com.au"); aco.setClientReferenceId("CLIENTREFERENCEIDHERE"); rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("REMOVEUSERACCESS"); rsr.setPerson(person); rs.setClient(aco); rs = AdministrationService.remoteAdministrationCall(rsr); The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed. This function will remove access to a specified client organisation for a specified user in Yellowfin. Request Element Data Type Description LoginId String Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au Password String Password of the account used to connect to Yellowfin webservices OrgId Integer Primary Organisation ID within Yellowfin. Always set this to 1. Function = "REMOVEUSERACCESS" String Web services function OrgRef String Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional. Person AdministrationPerson The AdministrationPerson object holding the Yellowfin user's User ID for the retrieval process Client AdministrationClientOrg The AdministrationClientOrg object holding the Yellowfin client organisation's Client Reference ID for the retrieval process These are the parameters that you need to set in the AdministrationPerson and AdministrationClientOrg objects: AdministrationPerson Element Data Type Description UserId String User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method AdministrationClientOrg Element Data Type Description ClientReferenceId Integer Client Reference ID for the specified client organisation 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

Expand
title ISREPORTFAVOURITE
This function will check if a specified report is in a specified user's favourites list in Yellowfin. Request Element Data Type Description LoginId String Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au Password String Password of the account used to connect to Yellowfin webservices OrgId Integer Primary Organisation ID within Yellowfin. Always set this to 1. Function = "ISUSERFAVOURITE" String Web services function OrgRef String Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional. Person AdministrationPerson The AdministrationPerson object holding the Yellowfin user's User ID for the retrieval process ReportId Integer Unique ID for the report These are the parameters that you need to set in the AdministrationPerson object: AdministrationPerson Element Data Type Description UserId String User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method 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

Expand
title ADDTOFAVOURITES / ADDTOFAVORITES
The following code will call the Yellowfin web service and add a specified report to a specified user's favourites list: Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs = null; AdministrationPerson person = new AdministrationPerson(); person.setUserId("test@yellowfin.com.au"); rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("ADDTOFAVOURITES"); rsr.setPerson(person); rs.setReportId(12345); rs = AdministrationService.remoteAdministrationCall(rsr); The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed. This function will add a specified report to a specified user's report favourites list. Request Element Data Type Description LoginId String Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au Password String Password of the account used to connect to Yellowfin webservices OrgId Integer Primary Organisation ID within Yellowfin. Always set this to 1. Function = "ADDTOFAVOURITES" OR "ADDTOFAVORITES" String Web services function OrgRef String Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional. Person AdministrationPerson The AdministrationPerson object holding the Yellowfin user's User ID for the retrieval process ReportId Integer Unique ID for the report These are the parameters that you need to set in the AdministrationPerson object: AdministrationPerson Element Data Type Description UserId String User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method 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

Expand
title REMOVEFAVOURITES / REMOVEFAVORITES
The following code will call the Yellowfin web service and remove a specified report to a specified user's favourites list: Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs = null; AdministrationPerson person = new AdministrationPerson(); person.setUserId("test@yellowfin.com.au"); rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("REMOVEFAVOURITE"); rsr.setPerson(person); rs.setReportId(12345); rs = AdministrationService.remoteAdministrationCall(rsr); The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed. This function will remove a specified report to a specified user's report favourites list. Request Element Data Type Description LoginId String Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au Password String Password of the account used to connect to Yellowfin webservices OrgId Integer Primary Organisation ID within Yellowfin. Always set this to 1. Function = "REMOVETOFAVOURITES" OR "REMOVETOFAVORITES" String Web services function OrgRef String Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional. Person AdministrationPerson The AdministrationPerson object holding the Yellowfin user's User ID for the retrieval process ReportId Integer Unique ID for the report These are the parameters that you need to set in the AdministrationPerson object: AdministrationPerson Element Data Type Description UserId String User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method 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

Expand
title GETAVATARS
This function will return all avatar images of specified users within Yellowfin: Request Element Data Type Description LoginId String Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au Password String Password of the account used to connect to Yellowfin webservices OrgId Integer Primary Organisation ID within Yellowfin. Always set this to 1. Function = "GETAVATARS" String Web services function Parameters Array (String) The Unique IDs of Yellowfin users 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 BinaryAttachments Array (ReportBinaryObject) Array of ReportBinary objects holding the Base64 decoded avatar images

Expand
title SETAVATARIMAGE
This function will set the avatar image of the specified user's profile within Yellowfin: Request Element Data Type Description LoginId String Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au Password String Password of the account used to connect to Yellowfin webservices OrgId Integer Primary Organisation ID within Yellowfin. Always set this to 1. Function = "SETAVATARIMAGE" String Web services function OrgRef String Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional. Person AdministrationPerson The AdministrationPerson object holding the Yellowfin user's User ID for the retrieval process Parameters Array (Bytes) Base64 encoded avatar image These are the parameters that you need to set in the AdministrationPerson object: AdministrationPerson Element Data Type Description UserId String User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method IpId Integer Unique IP ID of the Yellowfin user 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

Expand
title RELOADCODES
This function will reload the specified Org Reference Codes within Yellowfin. Request Element Data Type Description LoginId String Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au Password String Password of the account used to connect to Yellowfin webservices OrgId Integer Primary Organisation ID within Yellowfin. Always set this to 1. Function = "RELOADCODES" String Web services function Parameters Array (String) The list of Org Reference Codes 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

Expand
title GEOMETRYFLUSH

...

The following code will call the Yellowfin web service and

...

clear the geometry cache in Yellowfin: Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse

...

rs = null;

...

// This is a Yellowfin View ID String[] parameters ={ "48910" }; rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("

...

GEOMETRYFLUSH"); rsr.

...

setParameters(

...

parameters); rs = AdministrationService.remoteAdministrationCall(rsr);

...

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed. The function will clear the geometry cache in Yellowfin. Request Element Data Type Description LoginId String Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au Password String Password of the account used to connect to Yellowfin webservices OrgId Integer Primary Organisation ID within Yellowfin. Always set this to 1. Function = "GEOMETRYFLUSH" String Web services function Parameters Array (String) The list of View IDs from which the geometry objects are cached with 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

Expand
title REMOVEVIEW

The code will return an Array of AdministrationClientOrg objects in rs.getClients() and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

...

The following code will call the Yellowfin web service and

...

remove a view's cache in Yellowfin: Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs = null;

...

//

...

This

...

is

...

a Yellowfin View ID String[] parameters ={ "49283" }; rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("

...

REMOVEVIEW"); rsr.setParameters(parameters); rs = AdministrationService.remoteAdministrationCall(rsr

...

); The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed. This function will remove a view's cache in Yellowfin. Request Element Data Type Description LoginId String Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au Password String Password of the account used to connect to Yellowfin webservices OrgId Integer Primary Organisation ID within Yellowfin. Always set this to 1. Function = "REMOVEVIEW" String Web services function Parameters Array (String) The list of View IDs 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

Expand
title FLUSHREPORT

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

...

The following code will call the Yellowfin web service and remove

...

a report's cached definitions in Yellowfin: Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs = null;

...

// This is a Yellowfin Report ID String[] parameters ={ "11111" }; rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new

...

Integer(1)); rsr.setFunction("FLUSHREPORT"); rsr.setParameters(parameters); rs = AdministrationService.remoteAdministrationCall(rsr); The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed. Request Element Data Type Description LoginId String Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au Password String Password of the account used to connect to Yellowfin webservices OrgId Integer Primary Organisation ID within Yellowfin. Always set this to 1. Function = "FLUSHREPORT" String Web services function Parameters Array (String) The list of Report IDs 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

Expand
title FLUSHTAB

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

...

...

The following code will call the Yellowfin web service and

...

remove a dashboard's cached definitions in Yellowfin: Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse

...

rs = null; // This is a Yellowfin Dashboard Tab ID String[] parameters ={ "12345" }; rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("

...

FLUSHTAB"); rsr.

...

setParameters(parameters); rs = AdministrationService.remoteAdministrationCall(rsr); The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed. Request Element Data Type Description LoginId String Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au Password String Password of the account used to connect to Yellowfin webservices OrgId Integer Primary Organisation ID within Yellowfin. Always set this to 1. Function = "FLUSHTAB" String Web services function Parameters Array (String) The list of Tab IDs 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

Expand
title DELETEREPORT

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

...

The following code will call the Yellowfin web service and

...

delete a

...

report in Yellowfin: Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs = null;

...

// This is a Yellowfin Report UUID String[] parameters ={ "7368e6d4-6167-4a16-ba52-ffa2440a5c8c" }; rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("

...

DELETEREPORT"); // If the report ID is not set, then the code will look for the UUID in parameters rsr.

...

setReportId(

...

12345);

...

rsr.

...

setParameters(

...

parameters); rs = AdministrationService.remoteAdministrationCall(rsr); The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

...

...

...

...

...

...

...

Request Element Data Type Description LoginId String Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au Password String Password of the account used to connect to Yellowfin webservices OrgId Integer Primary Organisation ID within Yellowfin. Always set this to 1. Function = "DELETEREPORT" String Web services function Parameters Array (String) The UUID of the Yellowfin Report. Note, you do not need to set this if ReportId is set ReportId Integer The Yellowfin Report ID. Note, you do not need to set this if the UUID is set in the Parameter array 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

Expand
title DELETEVIEW

...

The following code will call the Yellowfin web service and

...

delete a view in Yellowfin: Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs = null; // This

...

example has a Yellowfin View UUID. The parameter value here can be either the UUID // or the Yellowfin View ID String[] parameters ={ "

...

7368e6d4-6167-4a16-ba52-ffa2440a5c8c" }; rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("

...

DELETEVIEW"); rsr.setParameters(parameters); rs = AdministrationService.remoteAdministrationCall(rsr); The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed. Request Element Data Type Description LoginId String Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au Password String Password of the account used to connect to Yellowfin webservices OrgId Integer Primary Organisation ID within Yellowfin. Always set this to 1. Function = "DELETEVIEW" String Web services function Parameters Array (String) Either the Yellowfin View ID or UUID can be set here 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

Expand
title

...

DELETESOURCE

The following code will call the Yellowfin web service and

...

delete a data source in Yellowfin: Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs = null; // This is

...

the Yellowfin

...

Data

...

Source ID String[] parameters ={ "

...

23456" }; rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("

...

DELETESOURCE"); rsr.setParameters(parameters); rs = AdministrationService.remoteAdministrationCall(

...

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

...

rsr); The code will return {SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed. Request Element Data Type Description LoginId String Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au Password String Password of the account used to connect to Yellowfin webservices OrgId Integer Primary Organisation ID within Yellowfin. Always set this to 1. Function = "DELETESOURCE" String Web services function Parameters Array (String) Either the Yellowfin Data Source ID or UUID can be set here 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

Expand
title DELETETAB

...

The following code will call the Yellowfin web service and

...

delete a dashboard tab in Yellowfin: Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs = null; // This is

...

the Yellowfin

...

Dashboard Tab

...

UUID String[] parameters ={ "

...

7368e6d4-6167-4a16-ba52-ffa2440a5c8c" }; rsr.setLoginId(this.username); rsr.setPassword(

...

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

...

this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("DELETETAB"); rsr.setDashboardTabId(11223); // If the Dashboard Tab ID is not set, then the code will look for the UUID in parameters rsr.setParameters(parameters); rs = AdministrationService.remoteAdministrationCall(rsr); The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed. Request Element Data Type Description LoginId String Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au Password String Password of the account used to connect to Yellowfin webservices OrgId Integer Primary Organisation ID within Yellowfin. Always set this to 1. Function = "DELETETAB" String Web services function Parameters Array (String) UUID of the Yellowfin Dashboard Tab. Note that this does not need to be set if the DashboardTabId parameter is set DashboardTabId Integer Dashboard Tab ID 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

Expand
title RELOADLICENCE

...

The following code will call the Yellowfin web service and

...

reload the licence definitions in Yellowfin: Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs

...

...

= null; rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("

...

RELOADLICENCE");

...

...

rs = AdministrationService.remoteAdministrationCall(rsr); The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed. Request Element Data Type Description LoginId String Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au Password String Password of the account used to connect to Yellowfin webservices OrgId Integer Primary Organisation ID within Yellowfin. Always set this to 1. Function = "RELOADLICENCE" String Web services function 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

Expand
title

...

CLOSECONNECTIONPOOL

The following code will call the Yellowfin web service and

...

close the specified data source's connection pool in Yellowfin: Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs = null; // This is a Yellowfin

...

Data Source

...

ID String[] parameters ={ "

...

11111" }; rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("

...

CLOSECONNECTIONPOOL");

...

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

rsr.setParameters(parameters); rs = AdministrationService.remoteAdministrationCall(rsr); The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed. Request Element Data Type Description LoginId String Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au Password String Password of the account used to connect to Yellowfin webservices OrgId Integer Primary Organisation ID within Yellowfin. Always set this to 1. Function = "CLOSECONNECTIONPOOL" String Web services function Parameters Array (String) Yellowfin Data Source ID 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

Expand
title FLUSHCACHEDFILTERCACHE

...

The following code will call the Yellowfin web service and

...

flush the specified filter's filter cache in Yellowfin: Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs

...

= null; // This is a Yellowfin Filter ID String[] parameters ={ "

...

12345" }; rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new

...

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

Integer(1)); rsr.setFunction("FLUSHCACHEDFILTERCACHE"); rsr.setParameters(parameters); rs = AdministrationService.remoteAdministrationCall(rsr); The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed. Request Element Data Type Description LoginId String Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au Password String Password of the account used to connect to Yellowfin webservices OrgId Integer Primary Organisation ID within Yellowfin. Always set this to 1. Function = "FLUSHCACHEDFILTERCACHE" String Web services function Parameters Array (String) Filter ID 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

Expand
title APPROVEREPORT

...

The following code will call the Yellowfin web service and

...

approve a

...

report in Yellowfin via the expert approval process: Code Block

...

AdministrationServiceRequest

...

rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs = null; rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("

...

APPROVEREPORT"); rsr.

...

setReportId(

...

12345)

...

rs = AdministrationService.remoteAdministrationCall(rsr); The code will return

...

SUCCESS in rs.getStatusCode(), otherwise it will return

...

an error explaining why the process failed. Request Element Data Type Description LoginId String Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au Password String Password of the account used to connect to Yellowfin webservices OrgId Integer Primary Organisation ID within Yellowfin. Always set this to 1. Function = "APPROVEREPORT" String Web services function ReportId Integer Report ID 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

Expand
title GETCONTENT

...

The following code will call the Yellowfin web service and

...

obtain all exportable content within Yellowfin: Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs = null;

...

ContentResource[]

...

cr =

...

null; rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("

...

GETCONTENT");

...

rs = AdministrationService.remoteAdministrationCall(rsr); cr = rs.getContentResources(); The code will return an Array of ContentResource objects in rs.getContentResources() and

SUCCESS in rs.getStatusCode(), otherwise it will return an error

...

explaining why the process failed. Request Element Data Type Description LoginId String Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au Password String Password of the account used to connect to Yellowfin webservices OrgId Integer Primary Organisation ID within Yellowfin. Always set this to 1. Function = "GETCONTENT" String Web services function 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 ContentResources Array (ContentResource) Array of Content Resource objects. Each ContentResource object holds export metadata for all exportable content in Yellowfin.

Expand
title

...

GETEXPORTDEPENDENCIES

The following code will call the Yellowfin web service and

...

obtain dependencies for a specific Yellowfin artifact: Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs = null; ContentResource[] cr = null; rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("

...

GETEXPORTDEPENDENCIES"); rs = AdministrationService.remoteAdministrationCall(rsr); cr = rs.getContentResources(); The code will return an Array of ContentResource objects in rs.getContentResources() and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

Expand
title CLOSECONNECTIONPOOL
The following code will call the Yellowfin web service and close the specified data source's connection pool in Yellowfin: Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs = null; // This is a Yellowfin Data Source ID String[] parameters ={ "11111" }; rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("CLOSECONNECTIONPOOL"); rsr.setParameters(parameters); rs = AdministrationService.remoteAdministrationCall(rsr); The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

...

This function will obtain dependencies for a specific Yellowfin artifact. Note, you can execute the GETCONTENT webservices call to retrieve all exportable content metadata first. This comes in the form of an array of ContentResource objects which can be then used in this function call to retrieve their respective dependencies. Request Element Data Type Description LoginId String Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au Password String Password of the account used to connect to Yellowfin webservices OrgId Integer Primary Organisation ID within Yellowfin. Always set this to 1. Function = "GETEXPORTDEPENDENCIES" String Web services function ContentResources Array (ContentResource) Array of ContentResource objects. These objects will hold specific Yellowfin artifact metadata These are the parameters that you need to set in the ContentResource object: ContentResource Element Data Type ResourceName String ResourceDescription String ResourceType String ResourceOrgId Integer ResourceCode String 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 ContentResources Array (ContentResource) Array of ContentResource objects. These objects will hold dependency metadata

Expand
title EXPORTCONTENT

...

The following code will call the Yellowfin web service and

...

export the specified

...

artifacts within Yellowfin: Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs = null; //

...

It is advisable to run a

...

GETCONTENT web service call beforehand to retrieve the necessary ContentResource objects // This list can be copied over to the exportList array below ContentResource[] exportList; rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("

...

EXPORTCONTENT"); rsr.

...

setContentResources(

...

exportList); rs = AdministrationService.remoteAdministrationCall(rsr); rbo = rs.getBinaryAttachments(); The code will return an Array of ReportBinaryObjects objects in rs.getBinaryAttachments() and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why

...

the process failed. This function will export the specified artifacts within Yellowfin. Note, you can execute the GETCONTENT webservices call to retrieve all exportable content metadata first. Request Element Data Type Description LoginId String Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au Password String Password of the account used to connect to Yellowfin webservices OrgId Integer Primary Organisation ID within Yellowfin. Always set this to 1. Function = "EXPORTCONTENT" String Web services function ContentResources Array (ContentResource) Array of ContentResource objects. These objects will hold specific Yellowfin artifact metadata These are the parameters that you need to set in the ContentResource object: ContentResource Element Data Type ResourceName String ResourceDescription String ResourceType String ResourceOrgId Integer ResourceCode String 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 BinaryAttachments Array(ReportBinaryObjects) Array of ReportBinaryObject objects. These objects will hold the XML for exported artifacts.

Expand
title GETIMPORTCONTENT

Expand
title APPROVEREPORT
The following code will call the Yellowfin web service and approve a report in Yellowfin via the expert approval process: Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs = null; rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("APPROVEREPORT"); rsr.setReportId(12345) rs = AdministrationService.remoteAdministrationCall(rsr); The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

...

The following code will call the Yellowfin web service and

...

read a Yellowfin import file, returning the objects to be imported: Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs = null; Byte[] data = <XML import file>; ContentResource[] cr = null; rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("

...

GETIMPORTCONTENT"); rsr.setParameters( new String[] { Base64.encodeBytes(data) } ); rs = AdministrationService.remoteAdministrationCall(rsr); cr = rs.getContentResources(); The code will return an Array of ContentResource objects in rs.getContentResources() and SUCCESS

...

in rs.getStatusCode(), otherwise it will return an error explaining why the process failed. Refer to ws_admin_import.jsp in your Yellowfin web services directory Yellowfin\development\examples\web services for a more detailed example of how this function would work. This function will read a Yellowfin XML import file and return a list of objects that can be imported into the application. This function will be expecting a Base64 encoded XML file as input. Request Element Data Type Description LoginId String Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au Password String Password of the account used to connect to Yellowfin webservices OrgId Integer Primary Organisation ID within Yellowfin. Always set this to 1. Function = "GETIMPORTCONTENT" String Web services function Parameters Array (String) Array of Base64 encoded chunks of the XML import file. 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 ContentResources Array (ContentResource) Array of ContentResource objects. These objects will hold specific Yellowfin artifact metadata

Expand
title TESTIMPORTCONTENT

Expand
title GETEXPORTDEPENDENCIES
The following code will call the Yellowfin web service and obtain dependencies for a specific Yellowfin artifact: Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs = null; ContentResource[] cr = null; rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("GETEXPORTDEPENDENCIES"); rs = AdministrationService.remoteAdministrationCall(rsr); cr = rs.getContentResources(); The code will return an Array of ContentResource objects in rs.getContentResources() and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

...

The following code will call the Yellowfin web service and

...

validate the

...

Yellowfin import objects. This function usually follows after the GETIMPORTCONTENT web services call: Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs = null;

...

Byte[] data = <XML import file>; ImportIssue[] ii = null; rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("

...

TESTIMPORTCONTENT"); rsr.

...

setParameters( new String[] { Base64.encodeBytes(data) } ); rs = AdministrationService.remoteAdministrationCall(rsr);

...

ii = rs.

...

getImportIssues(); The code will return an Array of

...

ImportIssue objects in rs.

...

getImportIssues() if there are issues with the import file and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why

...

the process failed. Refer to ws_admin_import.jsp in your Yellowfin web services directory Yellowfin\development\examples\web services for a more detailed example of how this function would work. This function will validate a list of Yellowfin import objects. This function usually follows after the GETIMPORTCONTENT webservices call, where it reads a Yellowfin XML import file and returns a list of objects that can be imported into the application. In this function, it performs a validation process for every object in that list. Any issues encountered during the validation process is returned as ImportIssue objects in the response. Request Element Data Type Description LoginId String Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au Password String Password of the account used to connect to Yellowfin webservices OrgId Integer Primary Organisation ID within Yellowfin. Always set this to 1 Function = "TESTIMPORTCONTENT" String Web services function Parameters Array (String) An array of Base64 encoded chunks of the XML import file ImportOptions Array(ImportOption) An array of ImportOption objects that controls how content is imported. 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 ImportIssues Array (ImportIssue) Array of ImportIssue objects. These objects will contain error messages returned from the validation process

Expand
title IMPORTCONTENT

Expand
title GETIMPORTCONTENT
The following code will call the Yellowfin web service and read a Yellowfin import file, returning the objects to be imported: Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs = null; Byte[] data = <XML import file>; ContentResource[] cr = null; rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("GETIMPORTCONTENT"); rsr.setParameters( new String[] { Base64.encodeBytes(data) } ); rs = AdministrationService.remoteAdministrationCall(rsr); cr = rs.getContentResources(); The code will return an Array of ContentResource objects in rs.getContentResources() and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed. Refer to ws_admin_import.jsp in your Yellowfin web services directory Yellowfin\development\examples\web services for a more detailed example of how this function would work.

...

The following code will call the Yellowfin web service and

...

import the specified Yellowfin import objects

...

into the application: Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs = null; Byte[] data = <XML import file>;

...

...

rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("

...

IMPORTCONTENT"); rsr.setParameters( new String[] { Base64.encodeBytes(data) } ); rs = AdministrationService.remoteAdministrationCall(rsr);

...

The code will return

...

expand

SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed. Refer to ws_admin_import.jsp in your Yellowfin web services directory Yellowfin\development\examples\web services for a more detailed example of how this function would work. Request Element Data Type Description LoginId String Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au

Password

title IMPORTCONTENT

String Password of the account used to connect to Yellowfin webservices OrgId Integer Primary Organisation ID within Yellowfin. Always set this to 1 Function = "IMPORTCONTENT" String Web services function Parameters Array (String) An array of Base64 encoded chunks of the XML import file ImportOptions Array(ImportOption) An array of ImportOption objects that controls how content is imported. 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 following code will call the Yellowfin web service and import the specified Yellowfin import objects into the application: Code Block AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs = null; Byte[] data = <XML import file>; rsr.setLoginId(this.username); rsr.setPassword(this.password); // This is the primary organisation rsr.setOrgId(new Integer(1)); rsr.setFunction("IMPORTCONTENT"); rsr.setParameters( new String[] { Base64.encodeBytes(data) } ); rs = AdministrationService.remoteAdministrationCall(rsr); The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed. Refer to ws_admin_import.jsp in your Yellowfin web services directory Yellowfin\development\examples\web services for a more detailed example of how this function would work.