Page History
Anchor | ||||
---|---|---|---|---|
|
Table of Contents | ||
---|---|---|
|
Overview
Styleclass | ||
---|---|---|
| ||
User Replication and Managment
Styleclass | ||
---|---|---|
| ||
User replication involves synchronising each user in the OEM application with a named user in Yellowfin.
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.
Functions
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service to create a user:
This code will return |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service to create a user:
This code will return |
Retrieving & Validating User Information
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.
Expand | ||
---|---|---|
| ||
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 |
Expand | ||
---|---|---|
| ||
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 |
Expand | ||
---|---|---|
| ||
Expand | ||
---|---|---|
| ||
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. |
Expand | ||
---|---|---|
| ||
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 |
Manipulating User Information
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).
Expand | ||
---|---|---|
| ||
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 |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and change the password for the specified Yellowfin user:
The code will return |
Retrieving Objects Belonging to a User
Styleclass | ||
---|---|---|
| ||
Objects belonging to a user in a Primary or Client Organisation can be retrieved with various web service calls. The objects returned in the response will be dependent on the type of call made in the request.
Expand | ||
---|---|---|
| ||
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 |
Expand | ||
---|---|---|
| ||
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 |
Expand | ||
---|---|---|
| ||
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 |
Expand | ||
---|---|---|
| ||
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 |
Expand | ||
---|---|---|
| ||
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 |
Expand | ||
---|---|---|
| ||
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 |
Expand | ||
---|---|---|
| ||
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 |
Expand | ||
---|---|---|
| ||
Group & Role Administration
Styleclass | ||
---|---|---|
| ||
Groups and Roles can be created and modified with a web service call. The objects returned in the response is dependent on the type of call made in the request.
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.
Expand | ||
---|---|---|
| ||
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 |
Expand | ||
---|---|---|
| ||
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 |
Expand | ||
---|---|---|
| ||
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 |
Expand | ||
---|---|---|
| ||
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 |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and include a specified user into a specified group in Yellowfin:
The code will return |
Expand | ||
---|---|---|
| ||
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 |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and delete a specified user from a specified group in Yellowfin:
The code will return |
Expand | ||
---|---|---|
| ||
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 |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and delete the specified group in Yellowfin:
The code will return |
Expand | ||
---|---|---|
| ||
Client Organisation Functionality
Styleclass | ||
---|---|---|
| ||
Yellowfin contains functionality called Client Organisations, which allows multiple virtual instances of Yellowfin to reside in the same server instance.
Client Organisation functionality can be managed with the available web service calls listed below.
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and list all client organizations within Yellowfin:
The code will return an Array of AdministrationClientOrg objects and |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and get the specified client organization within Yellowfin:
The code will return an AdministrationClientOrg object in |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and create the specified client organization within Yellowfin:
The code will return |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and delete the specified client organization within Yellowfin:
The code will return |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and update the specified client organization within Yellowfin:
The code will return |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and list all users belonging to the specified client organization within Yellowfin:
The code will return an Array of AdministrationPerson objects in |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and list all client organizations accessible by a specified user within Yellowfin:
The code will return an Array of AdministrationClientOrg objects in |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and add access to a specified client organization for a specified user within Yellowfin:
The code will return |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and remove access to a specified client organization for a specified user within Yellowfin:
The code will return |
Expand | ||
---|---|---|
| ||
Expand | ||
---|---|---|
| ||
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 |
Expand | ||
---|---|---|
| ||
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 |
Expand | ||
---|---|---|
| ||
Expand | ||
---|---|---|
| ||
Expand | ||
---|---|---|
| ||
Expand | ||
---|---|---|
| ||
Expand | ||
---|---|---|
| ||
Expand | ||
---|---|---|
| ||
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and clear the geometry cache in Yellowfin:
The code will return |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and remove a view's cache in Yellowfin:
The code will return |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and remove a report's cached definitions in Yellowfin:
The code will return |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and remove a dashboard's cached definitions in Yellowfin:
The code will return |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and delete a report in Yellowfin:
The code will return |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and delete a view in Yellowfin:
The code will return |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and delete a data source in Yellowfin:
The code will return { |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and delete a dashboard tab in Yellowfin:
The code will return |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and reload the licence definitions in Yellowfin:
The code will return |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and close the specified data source's connection pool in Yellowfin:
The code will return |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and flush the specified filter's filter cache in Yellowfin:
The code will return |
Expand | ||
---|---|---|
| ||
The following code will call the Yellowfin web service and approve a report in Yellowfin via the expert approval process:
The code will return |
Expand | ||
---|---|---|
| ||
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 |
Expand | ||
---|---|---|
| ||
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 |
Expand | ||
---|---|---|
| ||
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 |
Expand | ||
---|---|---|
| ||
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 |
Expand | ||
---|---|---|
| ||
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 |
Expand | ||
---|---|---|
| ||
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 |
horizontalrule |
---|
Styleclass | ||
---|---|---|
| ||