Page History

...

Expand
title IMPORTCONTENT
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. 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 = "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

Object Definitions

Expand
title AdministrationPerson
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 Password String Password of the Yellowfin user FirstName String First name of of the Yellowfin user LastName String Last name of of the Yellowfin user Initial String Middle initial of the Yellowfin user SalutationCode String Title of the Yellowfin user. Possible values include: DR MISS MR MRS MS RoleCode String Yellowfin role. The specified role here can be the Org Reference Code (YFADMIN) or the name of the role (Yellowfin Administrator) EmailAddress String Email address of the Yellowfin user LanguageCode String Two letter code for the preferred language IpId Integer Internal Yellowfin IP ID TimeZoneCode String The TimeZoneCode of the Yellowfin user.

Expand
title AdministrationReport
AdministrationReport Element Data Type ReportName String ReportDescription String ReportId Integer ExecutionObject String ReportCategory String ReportSubCategory String BirtData String SourceName String SourceId Integer AuthoringMode String ReportTemplate String DataOutput String DashboardEnabled Boolean ViewId Integer ViewName String ViewDescription String LastModifierName String LastModifierId Integer LastModifiedDate Date PublishDate Date DeliveryMode String LastRunTime Integer AverageRunTime Integer RoleCode String ChartTypeCode String Usage Integer

Expand
title AdministrationReportGroup
AdministrationReportGroup Element Data Type Description ReportGroupName String   ReportGroupDescription String   ReportGroupId Integer   ReportGroupStatus String   ReportGroupType String   ReportGroupInternalReference String   GroupReports Array (AdministrationReports) Array of AdministrationReport objects which hold report metadata. These are the reports that make up the portlets within the dashboard tab AssociatedReports Array (Integer)

Expand
title AdministrationRole
AdministrationReportGroup Element Data Type Description RoleName String The name of the Yellowfin Role RoleDescription String The business description of the Yellowfin Role RoleCode String The internal code for the Yellowfin Role that is generated and referenced in the database

Expand
title AdministrationGroup
AdministrationGroup Element Data Type Description GroupName String   GroupDescription String   GroupId Integer   GroupStatus String   GroupInternalReference String   GroupMembers Array (AdministrationGroupMember) An array of AdministrationGroupMember objects. These objects hold group member metadata

Expand
title AdministrationClientOrg
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. See appendix for valid values. DefaultOrg Boolean Boolean value that returns true if this organisation is the primary organisation

Expand
title ReportBinaryObject
ReportBinaryObject Element Data Type Description Key String Unique key used for Binary Object storage ContentType String MIME type for the Binary Object Data Array (Byte) Raw data for Binary Object

Expand
title ContentResource
ContentResource Element Data Type ResourceName String ResourceDescription String ResourceId Integer ResourceUUID Integer ResourceType String ResourceOrgId Integer ResourceCode String

Expand
title ImportOption
ImportOption Element Data Type Description ItemIndex Integer The index of the item that this option is attached too. OptionKey String The type of option. OptionValue String A value associated with this option.