Note: all code examples here are pseudocode. The actual code you will need to use will differ from environment to environment. The examples here are purely meant as a guide.
This service connects to Yellowfin and retrieves a logon token for a given user. When this token is passed to the Yellowfin Logon URL it will disable the login screen for the authenticated users and their session will being immediately.
The LOGINUSER function will Single Sign On a given user into Yellowfin. The contents of the AdministrationPerson object will be used to define the user being logged in.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
Redirecting to Yellowfin with the login tokenUsing the token received from the webservice call (the contents of AdministrationResponse.LoginSessionId), you can forward the user to the URL:
This URL will bypass the authentication screen in Yellowfin and take the user directly into Yellowfin. The token has a limited validity period. It must be used within 5 minutes, and once it has been used, it cannot be used again. To make subsequent calls from a third party application into Yellowfin, you must call the LOGINUSER web service again. Using the token with the JavaScript APIThe SSO token can also be used with embedded JavaScript API widgets. The token is added to the scriptlet URL like this:
Specifying Session OptionsYou can pass variables/switches that toggle functionality only for the session created via this Single Sign On request. These options can be enabled by passing them via the Parameters attribute in the AdministrationRequest, or by appending them to the redirection URL. Parameters are added to the AdministrationRequest.Parameters attribute as a list of key value pairs, like:
Options passed on the login URL look like:
Here is a list of the available options:
|
This service is a drop in replacement for Options are the same as
An extra parameter needs to be added to the Configuration table of the Yellowfin database to enable this functionality:
You may need to restart Yellowfin for the database change to take affect. You will receive a web service arror |
This allows Yellowfin to identify the user who is logged in, and to apply any restrictions that may be required. Synchronisation is usually performed using web service calls from the OEM application to Yellowfin. This can also be managed manually if users in the OEM application are generally static.
This section will outline how to create, manipulate, and delete users via web services. It is assumed that the web service is called to mirror user changes immediately after a user modification is made in the OEM application.
The following code will call the Yellowfin web service to create a user:
This code will return This function will create a user in Yellowfin. The details in the AdministrationPerson object will be used in the user creation process.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service to delete a user:
This code will return This function will delete a user from Yellowfin. The details in the AdministrationPerson object will be used in the user deletion process.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
Once a user has been created, the user's details can be retrieved using a web service call. The User ID field in the AdministrationPerson object is used to identify the user. As a result, a populated AdministrationPerson object will be returned. For security reasons, passwords will not be returned and will be NULL
. User information can also be validated against the application in this section.
The following code will call the Yellowfin web service to retrieve a user’s details:
This code will return an AdministrationPerson object with the user’s details and This function will retrieve the details of a particular user in Yellowfin. The details in the AdministrationPerson object will be used in the retrieval process.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service to retrieve a user’s details via their internal IpId:
This code will return an AdministrationPerson object with the user’s details and This function will retrieve the details of a particular user in Yellowfin by looking up their IP ID. The details in the AdministrationPerson object will be used in the retrieval process.
These are the parameters that you need to set in the AdministrationPerson object:
IpId|Integer|IP ID of the Yellowfin User| The response returned will contain these parameters:
|
This function will retrieve users from Yellowfin based on a specific search string. This string is compared against the user’s first name, last name, and email address.
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service to validate a user:
This code will return an AdministrationPerson object of the particular user if successful; otherwise it will return an error message explaining why the user validation process failed. This function will validate a specified Yellowfin user, checking if the user currently exists within the application. The details in the AdministrationPerson object will be used in the user validation process.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service to validate a user’s password:
This code will check if the password is expired and will return This function will validate a Yellowfin user’s password. The details in the AdministrationPerson object will be used in the password validation process.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
A user's details can be modified at a later time using a web service call. The User ID field in the AdministrationPerson object is used to identify the user, so this cannot be changed. The rest of the fields within an AdministrationPerson object are populated with the new changes. For security reasons, the user's password cannot be changed with this web service call, but with a separate CHANGEPASSWORD function (below).
The following code will call the Yellowfin web service to edit a user’s details:
This code will return an AdministrationPerson object with the user’s details and This function will update a specified Yellowfin user’s details. The details in the AdministrationPerson object will be used in the update process.
These are the parameters that you can set in the AdministrationPerson object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and change the password for the specified Yellowfin user:
The code will return This function will change a specified Yellowfin user’s password.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and return all reports with a Web Services Name that are accessible for the particular user:
This code will return an Array of AdministrationReport objects in This function will return all reports with a webservice name that are accessible for the specified Yellowfin user.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and return all reports that are accessible for the particular user:
This code will return an Array of AdministrationReport objects in
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and return all commented reports that are accessible for the particular user:
This code will return an Array of AdministrationReport objects in This function will return all commented reports in Yellowfin that are accessible by the specified Yellowfin user.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and return all report favourites that are accessible for the particular user:
This code will return an Array of AdministrationReport objects in This function will return all the favourite reports of a specified Yellowfin user.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and return all reports that are in the particular user’s inbox:
This code will return an Array of AdministrationReport objects in This function will return the reports that are in the inbox of a specified Yellowfin user.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and return all dashboard tabs without reports that are accessible for that particular user:
This code will return an Array of AdministrationReportGroup objects in This function will return a list of dashboard tabs that are accessible by the specified Yellowfin user.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and return all dashboard tabs with reports that are accessible for that particular user:
This code will return an Array of AdministrationReportGroup objects in This function will return a list of dashboard tabs that are accessible by the specified Yellowfin user, with the reports’ metadata loaded as well. The metadata for every report in the dashboard tab is contained within the AdministrationReportGroup object.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
This function will return a list of reports contained within a specified dashboard tab, that is accessible by a specified user in Yellowfin.
These are the parameters that you need to set in the AdministrationPerson and AdministrationReportGroup object:
The response returned will contain these parameters:
|
Note: if Client Org functionality is turned on in the Configuration page, a Client Org can also be specified where applicable for certain types of calls.
The following code will call the Yellowfin web service and return all available roles within Yellowfin:
The code will return an Array of AdministrationRole objects in This function will return all the available roles within Yellowfin.
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and return all available groups within Yellowfin:
The code will return an Array of AdministrationGroup objects in This function will return all the available user groups within Yellowfin.
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and return the specified group with its members in Yellowfin:
The code will return an AdministrationGroup object in This function will return a specified Yellowfin group with a list of its members.
These are the parameters that you need to set in the AdministrationGroup object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and create the specified group in Yellowfin:
The code will return Note: you can also put existing Yellowfin users into this newly created group at the same time by populating an AdministrationGroupMember array of AdministrationPerson objects. Each AdministrationPerson object only needs the This function will create a Yellowfin group. Note that you are able to save existing Yellowfin users into the new group in this function as well.
These are the parameters that you need to set in the AdministrationGroup object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and include a specified user into a specified group in Yellowfin:
The code will return This function will include a specified Yellowfin user into a specified group.
These are the parameters that you need to set in the AdministrationGroup and AdministrationPerson objects:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and exclude a specified user from a specified group in Yellowfin. Note: this user is not deleted from the group but merely excluded from the group definition. An example of why this would be useful is when:
The code will return This function will exclude a specified Yellowfin user from a specified group. Note that this user is not deleted from the group but merely excluded from the group definition. An example of why this would be useful is when:
These are the parameters that you need to set in the AdministrationGroup and AdministrationPerson objects:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and delete a specified user from a specified group in Yellowfin:
The code will return This function will delete a specified Yellowfin user from a specified group. Note that this scenario is different from the one in EXCLUDEUSERINGROUP – in this function a user will be permanently removed from the group.
These are the parameters that you need to set in the AdministrationGroup and AdministrationPerson objects:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and modify the specified group in Yellowfin:
The code will return Note: you can also put existing Yellowfin users into this modified group at the same time by populating an AdministrationGroupMember array of AdministrationPerson objects. Each AdministrationPerson object only needs the This function will modify the details for a specified group in Yellowfin. Note that you are able to save existing Yellowfin users into the new group in this function as well.
These are the parameters that you need to set in the AdministrationGroup object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and delete the specified group in Yellowfin:
The code will return This function will delete a specified group from Yellowfin.
These are the parameters that you need to set in the AdministrationGroup object:
The response returned will contain these parameters:
|
Client Organisation functionality can be managed with the available web service calls listed below.
The following code will call the Yellowfin web service and list all client organisations within Yellowfin:
The code will return an Array of AdministrationClientOrg objects and This function will list all client organisations available within Yellowfin.
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and get the specified client organisation within Yellowfin:
The code will return an AdministrationClientOrg object in This function will retrieve details for a specified client organisation within Yellowfin.
These are the parameters that you need to set in the AdministrationClientOrg object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and create the specified client organisation within Yellowfin:
The code will return The function will create the specified client organisation in Yellowfin.
These are the parameters that you need to set in the AdministrationClientOrg object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and delete the specified client organisation within Yellowfin:
The code will return This function will delete the specified client organisation in Yellowfin.
These are the parameters that you need to set in the AdministrationClientOrg object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and update the specified client organisation within Yellowfin:
The code will return The following code will call the Yellowfin webservice and update the specified client organisation within Yellowfin.
These are the parameters that you can set in the AdministrationClientOrg object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and list all users belonging to the specified client organisation within Yellowfin:
The code will return an Array of AdministrationPerson objects in This function will list all Yellowfin users belonging to the specified client organisation in Yellowfin.
These are the parameters that you need to set in the AdministrationClientOrg object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and list all client organisations accessible by a specified user within Yellowfin:
The code will return an Array of AdministrationClientOrg objects in
These are the parameters that you need to set in the AdministrationClientOrg object:
The response returned will contain these parameters:
|
Adding to Default OrgThe following code will call the Yellowfin web service and add access to the default organisation for a specified user within Yellowfin:
The code will return This function will add access to a specified client organisation for a specified user win Yellowfin.
These are the parameters that you need to set in the AdministrationPerson and AdministrationClientOrg objects:
The response returned will contain these parameters:
Adding to Client OrgThe following code will call the Yellowfin web service and add access to a specified client organisation for a specified user within Yellowfin:
The code will return This function will add access to a specified client organisation for a specified user win Yellowfin.
These are the parameters that you need to set in the AdministrationPerson and AdministrationClientOrg objects:
The response returned will contain these parameters:
|
Remove from Default OrgThe following code will call the Yellowfin web service and remove access to the default organisation for a specified user within Yellowfin:
The code will return This function will remove access to a specified client organisation for a specified user in Yellowfin.
These are the parameters that you need to set in the AdministrationPerson and AdministrationClientOrg objects:
The response returned will contain these parameters:
Remove from Client OrgThe following code will call the Yellowfin web service and remove access to a specified client organisation for a specified user within Yellowfin:
The code will return This function will remove access to a specified client organisation for a specified user in Yellowfin.
These are the parameters that you need to set in the AdministrationPerson and AdministrationClientOrg objects:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and obtain all exportable content within Yellowfin:
The code will return an Array of ContentResource objects in
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and obtain dependencies for a specific Yellowfin artifact:
The code will return an Array of ContentResource objects in 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.
These are the parameters that you need to set in the ContentResource object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and export the specified artifacts within Yellowfin:
The code will return an Array of ReportBinaryObjects objects in This function will export the specified artifacts within Yellowfin. Note, you can execute the GETCONTENT webservices call to retrieve all exportable content metadata first.
These are the parameters that you need to set in the ContentResource object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and read a Yellowfin import file, returning the objects to be imported:
The code will return an Array of ContentResource objects in Refer to 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.
The response returned will contain these parameters:
|
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:
The code will return an Array of ImportIssue objects in Refer to 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.
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and import the specified Yellowfin import objects into the application:
The code will return Refer to
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and delete a report in Yellowfin:
The code will return
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and delete a view in Yellowfin:
The code will return
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and delete a data source in Yellowfin:
The code will return {
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and delete a dashboard tab in Yellowfin:
The code will return
The response returned will contain these parameters:
|
This function will reload the specified Org Reference Codes within Yellowfin.
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and clear the geometry cache in Yellowfin:
The code will return The function will clear the geometry cache in Yellowfin.
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and remove a view’s cache in Yellowfin:
The code will return This function will remove a view's cache in Yellowfin.
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and remove a report’s cached definitions in Yellowfin:
The code will return
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and remove a dashboard’s cached definitions in Yellowfin:
The code will return
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and reload the licence definitions in Yellowfin:
The code will return
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and close the specified data source’s connection pool in Yellowfin:
The code will return
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and flush the specified filter’s filter cache in Yellowfin:
The code will return
The response returned will contain these parameters:
|
This function will check if a specified report is in a specified user’s favourites list in Yellowfin.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and add a specified report to a specified user’s favourites list:
The code will return This function will add a specified report to a specified user’s report favourites list.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and remove a specified report to a specified user’s favourites list:
The code will return This function will remove a specified report to a specified user’s report favourites list.
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
This function will return all avatar images of specified users within Yellowfin:
The response returned will contain these parameters:
|
This function will set the avatar image of the specified user’s profile within Yellowfin:
These are the parameters that you need to set in the AdministrationPerson object:
The response returned will contain these parameters:
|
The following code will call the Yellowfin web service and approve a report in Yellowfin via the expert approval process:
The code will return
The response returned will contain these parameters:
|
|
|
|
|
|
|
|
|
|