AdministrationServiceClient

java.lang.Object
- com.hof.mi.web.service.AdministrationServiceClient

```
public class AdministrationServiceClient
extends java.lang.Object
```
AdministrationServiceClient is an instance of a Yellowfin web services connection. This class retains the webservices session information for connecting with a Yellowfin Reporting Webservice.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`clientReferenceId`
`protected java.lang.Integer`	`ErrorCode`
`protected boolean`	`internal`
`static boolean`	`logging`
`protected java.lang.String[]`	`messages`
`protected boolean`	`secure`
`protected java.lang.String`	`sessionId`

Constructor Summary

Constructors
Constructor and Description
`AdministrationServiceClient()` Creates a non-webservices session-based connection to Yellowfin.
`AdministrationServiceClient(java.lang.String webServiceHost, int webServicePort, java.lang.String serviceURL, boolean secure, boolean internal)` Creates a webservices session-based connection to Yellowfin.
`AdministrationServiceClient(java.lang.String webServiceHost, int webServicePort, java.lang.String username, java.lang.String password)` Creates a webservices session-based connection to Yellowfin.
`AdministrationServiceClient(java.lang.String webServiceHost, int webServicePort, java.lang.String username, java.lang.String password, boolean secure)` Creates a webservices session-based connection to Yellowfin.
`AdministrationServiceClient(java.lang.String webServiceHost, int webServicePort, java.lang.String username, java.lang.String password, java.lang.String serviceURL)` Creates a webservices session-based connection to Yellowfin.
`AdministrationServiceClient(java.lang.String webServiceHost, int webServicePort, java.lang.String username, java.lang.String password, java.lang.String serviceURL, boolean secure, boolean internal)` Creates a webservices session-based connection to Yellowfin.
`AdministrationServiceClient(java.lang.String webServiceHost, int webServicePort, java.lang.String username, java.lang.String password, java.lang.String serviceURL, boolean secure, boolean internal, boolean test)` Creates a webservices session-based connection to Yellowfin.
`AdministrationServiceClient(java.lang.String username, java.lang.String password)` Creates a non-webservices session-based connection to Yellowfin.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addBirtReport(AdministrationReport birtReport)` Upload a BIRT report into Yellowfin.
`boolean`	`addColumnToViews(java.lang.Integer sourceId, java.lang.String tableName, java.lang.String columnName, java.lang.String fieldCategoryName)` Adds a column on a specific table to all views that use that table.
`boolean`	`addColumnToViews(java.lang.String dataSourceName, java.lang.String tableName, java.lang.String columnName, java.lang.String fieldCategoryName)` Adds a column on a specific table to all views that use that table.
`boolean`	`addPersonFavourite(PersonFavourite pf)`
`boolean`	`addToFavourites(AdministrationReport report, AdministrationPerson person)`
`boolean`	`addToFavourites(java.lang.Integer reportId, java.lang.String loginId)`
`boolean`	`addToUserFavourites(AdministrationPerson person, AdministrationReport report)` Assign a report to a users favourites list
`boolean`	`addUserAccess(AdministrationPerson person, AdministrationClientOrg client)` Allows a user to log in to a client organisation.
`boolean`	`addUserToGroup(AdministrationPerson person, AdministrationGroup group, boolean include)` Adds a user to a group.
`boolean`	`approveReport(java.lang.Integer reportId)`
`boolean`	`changePassword(java.lang.String userId, java.lang.String newPassword)` Change a user's password.
`boolean`	`closeConnectionPool(java.lang.Integer sourceId)`
`boolean`	`createClient(AdministrationClientOrg client)` Creates a client organisation.
`boolean`	`createGroup(AdministrationGroup group)` Create a new group.
`AdministrationPerson`	`createUniqueUser(AdministrationPerson person)` Create a new unique user.
`boolean`	`createUser(AdministrationPerson person)` Create a new user.
`boolean`	`deleteClient(AdministrationClientOrg client)` Deletes a client organisation.
`boolean`	`deleteFavourite(AdministrationReport report, AdministrationPerson person)`
`boolean`	`deleteFavourite(java.lang.Integer reportId, java.lang.String loginId)`
`boolean`	`deleteGroup(AdministrationGroup group)` Delete a group.
`void`	`deleteSchedule(java.lang.String scheduleUUID)`
`boolean`	`deleteUser(AdministrationPerson person)` Delete the specified user
`boolean`	`delGeopack(java.lang.String packId)` Force Yellowfin to remove a particular GeoPack from the geopack cache.
`protected AdministrationServiceResponse`	`doWebServicesRequest(AdministrationServiceRequest rsr)` Perform a Webservices Request (Used Internally and by methods in i4Report)
`boolean`	`editUser(AdministrationPerson person)` Update details for a user.
`boolean`	`flushBinaryClassLoaderCache()` Force Yellowfin to refresh the binary class loader cache for a particular view Used by Yellowfin to synchronise with cluster nodes
`boolean`	`flushCachedFilterCache(java.lang.Integer filterId)`
`boolean`	`flushGeometry(java.lang.Integer ViewId)` Force Yellowfin to refresh the geometry cache for a particular view Used by Yellowfin to synchronise with cluster nodes
`AdministrationClientOrg`	`getClient(AdministrationClientOrg client)` Retrieve a client organisation from the server.
`static java.lang.String`	`getClientBuild()` Returns the build version number that the client library was built against (eg.
`java.lang.String`	`getClientReferenceId()` Returns the client reference id used in web service calls.
`static java.lang.String`	`getClientRelease()` Returns the major release version that the client library was built against (eg.
`java.lang.Integer`	`getErrorCode()` Returns the error code from the most recent service call.
`AdministrationGroup`	`getGroup(AdministrationGroup group)` Fetch a group record from the server.
`java.lang.String[]`	`getMessages()` Get Messages from last service call.
`int`	`getPort()` Returns the tcp port to connect to
`AdministrationReport`	`getReportForUser(AdministrationPerson person, java.lang.Integer reportId)` Get a specified report for the given user.
`AdministrationServiceResponse`	`getRs()`
`AdministrationServiceRequest`	`getRsr()`
`java.lang.String`	`getServiceURL()` Returns the alternate service path
`java.lang.String`	`getSessionId()`
`AdministrationPerson`	`getUser(java.lang.String UserId)` Fetch the user with the given UserId from the server
`AdministrationPerson[]`	`getUserAccess(AdministrationClientOrg client)` Retrieves the users that can log into a client organisation.
`AdministrationClientOrg[]`	`getUserAccess(AdministrationPerson person)` Retrieves the clients that a user can log in to.
`AdministrationPerson`	`getUserByIp(java.lang.Integer IpId)` Fetch the user with the given IpId from the server
`java.lang.String`	`getUsername()` Returns the username of the Yellowfin user to connect to the web service
`AdministrationPerson[]`	`getUsersFromSearch(java.lang.String searchString, java.lang.Integer IpId)` Fetch the user with the given UserId from the server
`java.lang.String`	`getWebServicesHost()` Returns the host to connect to
`boolean`	`isReportFavourite(AdministrationReport report, AdministrationPerson person)`
`boolean`	`isReportFavourite(java.lang.Integer reportId, java.lang.String loginId)`
`ParentDashboard[]`	`listAllParentTabs(AdministrationPerson person, boolean loadReports)` List all dashboard tabs for the given user
`AdministrationReport[]`	`listAllReportsForUser(AdministrationPerson person)` List all reports for the given user, regardless of whether they are web-service enabled.
`AdministrationReport[]`	`listAllReportsFromRegex(java.lang.String regex, AdministrationPerson p)` List all reports that contain a string regex
`AdministrationReport[]`	`listAllReportsWithComments(AdministrationPerson person)` List all reports for the given user, regardless of whether they are web-service enabled.
`AdministrationSchedule[]`	`listAllSchedules()`
`AdministrationReportGroup[]`	`listAllTabsForUser(AdministrationPerson person)` List all dashboard tabs for the given user
`AdministrationReportGroup[]`	`listAllTabsForUser(AdministrationPerson person, boolean loadReports)` List all dashboard tabs for the given user
`AdministrationReportGroup[]`	`listAllTabsForUser(AdministrationPerson person, boolean loadReports, java.lang.Integer tabId)` List all dashboard tabs for the given user
`ParentDashboard`	`listAllTabsForUserFromParent(AdministrationPerson person, boolean loadReports, java.lang.Integer tabId)` List all dashboard subtabs for the given Dashboard id
`AdministrationClientOrg[]`	`listClients()` Retrieve a list of client organisations from the server.
`AdministrationGroup[]`	`listGroups()` Retrieve a list of groups from the server.
`ParentReportGroup[]`	`listParentsTabsWithSubTabsForUser(AdministrationPerson person, boolean loadReports, java.lang.Integer tabId)`
`PersonFavourite[]`	`listPersonFavourites(PersonFavourite pf)`
`PersonFavourite[]`	`listPersonFavourites(PersonFavourite pf, java.lang.Integer retrospectiveDays)`
`AdministrationReport[]`	`listReportsForUser(AdministrationPerson person)` List all webservice enabled reports for the given user.
`AdministrationRole[]`	`listRoles()` Retrieve a list of roles from the server.
`AdministrationReport[]`	`listUserFavourites(AdministrationPerson person)` List all favourites for the given user
`AdministrationReport[]`	`listUserInbox(AdministrationPerson person)` List all inbox reports for the given user
`AdministrationSchedule`	`loadSchedule(java.lang.String scheduleUUID)`
`java.lang.String`	`loginUser(AdministrationPerson person)` Authenticate a user and return a session token used to log in.
`java.lang.String`	`loginUser(AdministrationPerson person, java.lang.String[] loginParameters)` Authenticate a user and return a session token used to log in.
`java.lang.String`	`loginUserUnsecure(AdministrationPerson person, java.lang.String[] loginParameters)` Authenticate a user and return a session token used to log in.
`boolean`	`logoutUser(AdministrationPerson person)` Destory a users session.
`boolean`	`logoutUser(AdministrationPerson person, java.lang.String SessionId)`
`boolean`	`logoutUser(java.lang.String SessionId)` Destory a users session.
`boolean`	`logoutUserByUserIp(java.lang.Integer UserIp, java.lang.String ContainerSessionId)`
`boolean`	`logoutUserByUserIpWithErrorsSuppressed(java.lang.Integer userIp, java.lang.String containerSessionId)` Logout User by Internal Id, with error suppression
`boolean`	`logoutUserByUserName(java.lang.String UserName)`
`boolean`	`logoutUserByUserName(java.lang.String UserName, java.lang.String ContainerSessionId)`
`boolean`	`logoutUserByUserNameWithErrorsSuppressed(java.lang.String userName, java.lang.String containerSessionId)` Logout User by username, with error suppression
`boolean`	`logoutUserWithUserName(java.lang.String Username)` Destory a users session.
`boolean`	`modifyGroup(AdministrationGroup group)` Modify a group.
`AdministrationSchedule`	`pauseSchedule(java.lang.String scheduleUUID)`
`boolean`	`performCacheCommands(AdministrationCacheCommand[] commands)` Send a request to run a set of commands against system caches.
`void`	`refreshAccessLevelList(java.lang.Integer contentId)`
`boolean`	`rejectReport(java.lang.Integer reportId)`
`boolean`	`reloadCodes(java.util.ArrayList<java.lang.String> codes)` Force Yellowfin to reload reference codes Used by Yellowfin to synchronise with cluster nodes
`boolean`	`reloadLicence()`
`void`	`removeAccessLevelFromCache(java.lang.String contentKey)`
`boolean`	`removeContentManagementFromCache(java.lang.Integer contentId)` Force removal of a view from the view cache Used by Yellowfin to synchronise with cluster nodes
`boolean`	`removeDashboardFromCache(java.lang.Integer tabId)` Force removal of a tab from the dashboard definition cache Used by Yellowfin to synchronise with cluster nodes
`boolean`	`removeDocumentFromCache(java.lang.Integer documentId)` Force removal of a view from the view cache Used by Yellowfin to synchronise with cluster nodes
`boolean`	`removeFromRESTUserCache(RESTUserCacheRemovalInfo removalInfo)` Remove entries from the RESTUserCache
`boolean`	`removeGroupFromCache(java.lang.Integer groupId)` Force removal of a group from the group cache Used by Yellowfin to synchronise with cluster nodes
`boolean`	`removePersonFavourite(PersonFavourite pf)`
`boolean`	`removePersonFromCache(java.lang.Integer personId)` Force removal of a person from the person cache Used by Yellowfin to synchronise with cluster nodes
`boolean`	`removeReportFromCache(java.lang.Integer ReportId)` Force removal of a report from the report definition cache Used by Yellowfin to synchronise with cluster nodes
`boolean`	`removeTextEntityFromCache(java.lang.Integer textId)` Force removal of a text entity from the text entity cache Used by Yellowfin to synchronise with cluster nodes
`boolean`	`removeUserAccess(AdministrationPerson person, AdministrationClientOrg client)` Disallows a user to log in to a client organisation.
`boolean`	`removeUserFromGroup(AdministrationPerson person, AdministrationGroup group)` Removes a user from a group.
`boolean`	`removeViewFromCache(java.lang.Integer ViewId)` Force removal of a view from the view cache Used by Yellowfin to synchronise with cluster nodes
`boolean`	`requestPasswordReset(java.lang.String userId)` Request a password reset for the given userid.
`AdministrationSchedule`	`resumeSchedule(java.lang.String scheduleUUID)`
`ReportBinaryObject`	`retrieveAvatar(java.lang.Integer id)`
`ReportBinaryObject`	`retrieveAvatar(java.lang.String id)`
`ReportBinaryObject[]`	`retrieveAvatars(java.lang.Integer[] ids)`
`ReportBinaryObject[]`	`retrieveAvatars(java.lang.String[] ids)`
`AdministrationSchedule`	`runScheduleNow(java.lang.String scheduleUUID)`
`AdministrationSchedule`	`saveSchedule(AdministrationSchedule schedule)`
`byte[]`	`serialize(java.io.Serializable obj)` Convert an object into a byte array.
`boolean`	`setAvatarImage(AdministrationPerson person, java.lang.String base64EncodedImage)` Sets the a uses avatar image
`void`	`setClientReferenceId(java.lang.String clientReferenceId)` Sets the client reference id used in web service calls.
`void`	`setErrorCode(java.lang.Integer errorCode)`
`void`	`setRs(AdministrationServiceResponse rs)`
`void`	`setRsr(AdministrationServiceRequest rsr)`
`int`	`testConnection()` Tests the webservices connection.
`boolean`	`updateAdminMode(java.util.Map<java.lang.String,java.lang.String> functions, boolean enableAdminMode)` Send a request to enable/disable admin mode based on the enableAdminMode boolean.
`boolean`	`updateClient(AdministrationClientOrg client)` Updates a client organisation.
`boolean`	`validatePassword(java.lang.String userId, java.lang.String password)` Authenticate a user without logging them in.
`boolean`	`validateUser(java.lang.String userId, java.lang.String password)` Authenticate a user without logging them in.
`boolean`	`validateUserAllOrgs(java.lang.String userId, java.lang.String password)` Authenticate a user without logging them in but do not enfore client org This is the preferred method to check if a supplied userid/password is valid.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logging
```
public static final boolean logging
```
See Also:

Constant Field Values

sessionId
```
protected java.lang.String sessionId
```

messages
```
protected java.lang.String[] messages
```

secure
```
protected boolean secure
```

internal
```
protected boolean internal
```

ErrorCode
```
protected java.lang.Integer ErrorCode
```

clientReferenceId

protected java.lang.String clientReferenceId

Constructor Detail
- AdministrationServiceClient
```
public AdministrationServiceClient()
                            throws WebserviceException
```
  Creates a non-webservices session-based connection to Yellowfin. You only need to supply a user for the administration. This connection will only work when Yellowfin is running in the same JVM.
  
  Throws:
  
  WebserviceException
- AdministrationServiceClient
```
public AdministrationServiceClient(java.lang.String username,
                                   java.lang.String password)
                            throws WebserviceException
```
  Creates a non-webservices session-based connection to Yellowfin. You only need to supply a user for the administration. This connection will only work when Yellowfin is running in the same JVM.
  
  Parameters:
  
  username - Web Service UserName
  
  password - Web Service User Password
  
  Throws:
  
  WebserviceException
- AdministrationServiceClient
```
public AdministrationServiceClient(java.lang.String webServiceHost,
                                   int webServicePort,
                                   java.lang.String username,
                                   java.lang.String password)
                            throws WebserviceException
```
  Creates a webservices session-based connection to Yellowfin. This will use the default path to the Yellowfin WebService. You only need one webservices connection for multiple service calls.
  
  Parameters:
  
  webServiceHost - Web Service Host
  
  webServicePort - Web Service Port
  
  username - Web Service UserName
  
  password - Web Service User Password
  
  Throws:
  
  WebserviceException
- AdministrationServiceClient
```
public AdministrationServiceClient(java.lang.String webServiceHost,
                                   int webServicePort,
                                   java.lang.String username,
                                   java.lang.String password,
                                   boolean secure)
                            throws WebserviceException
```
  Creates a webservices session-based connection to Yellowfin. This will use the default path to the Yellowfin WebService. You only need one webservices connection for multiple service calls.
  
  Parameters:
  
  webServiceHost - Web Service Host
  
  webServicePort - Web Service Port
  
  username - Web Service UserName
  
  password - Web Service User Password
  
  secure - Whether or not to make an SSL connection
  
  Throws:
  
  WebserviceException
- AdministrationServiceClient
```
public AdministrationServiceClient(java.lang.String webServiceHost,
                                   int webServicePort,
                                   java.lang.String username,
                                   java.lang.String password,
                                   java.lang.String serviceURL)
                            throws WebserviceException
```
  Creates a webservices session-based connection to Yellowfin. You only need one webservices connection for multiple service calls.
  
  Parameters:
  
  webServiceHost - Web Service Host
  
  webServicePort - Web Service Port
  
  username - Web Service UserName
  
  password - Web Service User Password
  
  serviceURL - Alternate Web Service path
  
  Throws:
  
  WebserviceException
- AdministrationServiceClient
```
public AdministrationServiceClient(java.lang.String webServiceHost,
                                   int webServicePort,
                                   java.lang.String username,
                                   java.lang.String password,
                                   java.lang.String serviceURL,
                                   boolean secure,
                                   boolean internal)
                            throws WebserviceException
```
  Creates a webservices session-based connection to Yellowfin. You only need one webservices connection for mulitple service calls.
  
  Parameters:
  
  webServiceHost - Web Service Host
  
  webServicePort - Web Service Port
  
  username - Web Service UserName
  
  password - Web Service User Password
  
  serviceURL - Alternate Web Service path
  
  secure - Whether or not to make an SSL connection?
  
  internal - connect to Yellowfin within this JVM (not using web services)
  
  Throws:
  
  WebserviceException - if an error occurred connecting to the web service
- AdministrationServiceClient
```
public AdministrationServiceClient(java.lang.String webServiceHost,
                                   int webServicePort,
                                   java.lang.String username,
                                   java.lang.String password,
                                   java.lang.String serviceURL,
                                   boolean secure,
                                   boolean internal,
                                   boolean test)
                            throws WebserviceException
```
  Creates a webservices session-based connection to Yellowfin. You only need one webservices connection for mulitple service calls.
  
  Parameters:
  
  webServiceHost - Web Service Host
  
  webServicePort - Web Service Port
  
  username - Web Service UserName
  
  password - Web Service User Password
  
  serviceURL - Alternate Web Service path
  
  secure - Whether or not to make an SSL connection?
  
  internal - connect to Yellowfin within this JVM (not using web services)
  
  Throws:
  
  WebserviceException - if an error occurred connecting to the web service
- AdministrationServiceClient
```
public AdministrationServiceClient(java.lang.String webServiceHost,
                                   int webServicePort,
                                   java.lang.String serviceURL,
                                   boolean secure,
                                   boolean internal)
                            throws WebserviceException
```
  Creates a webservices session-based connection to Yellowfin. You only need one webservices connection for mulitple service calls. This constructor excludes username and password for user when using the unsecure webservice option.
  
  Parameters:
  
  webServiceHost - Web Service Host
  
  webServicePort - Web Service Port
  
  serviceURL - Alternate Web Service path
  
  secure - Whether or not to make an SSL connection?
  
  internal - connect to Yellowfin within this JVM (not using web services)
  
  Throws:
  
  WebserviceException - if an error occurred connecting to the web service

Method Detail

createUser
```
public boolean createUser(AdministrationPerson person)
```
Create a new user.

Parameters:

person - the AdministrationPerson object

Returns:

creation succeeded (true/false)

createUniqueUser
```
public AdministrationPerson createUniqueUser(AdministrationPerson person)
```
Create a new unique user.

Parameters:

person - the AdministrationPerson object

Returns:

AdministrationPerson object for created person

editUser
```
public boolean editUser(AdministrationPerson person)
```
Update details for a user.

Parameters:

person - the AdministrationPerson object

Returns:

true if the update succeeded

changePassword
```
public boolean changePassword(java.lang.String userId,
                              java.lang.String newPassword)
```
Change a user's password.

Parameters:

userId - the User Id of the user to change

newPassword - the new password for the user

Returns:

true if the update succeeded

getUser
```
public AdministrationPerson getUser(java.lang.String UserId)
```
Fetch the user with the given UserId from the server

Parameters:

UserId - the user id

Returns:

AdministrationPerson object or null

getUserByIp
```
public AdministrationPerson getUserByIp(java.lang.Integer IpId)
```
Fetch the user with the given IpId from the server

Parameters:

UserId - the user id

Returns:

AdministrationPerson object or null

getUsersFromSearch

public AdministrationPerson[] getUsersFromSearch(java.lang.String searchString,
                                                 java.lang.Integer IpId)

Fetch the user with the given UserId from the server

Parameters:: UserId - the user id
Returns:: AdministrationPerson object or null

deleteUser
```
public boolean deleteUser(AdministrationPerson person)
```
Delete the specified user

Parameters:

person - the user to delete

Returns:

true if user deletion succeeded

loginUser
```
public java.lang.String loginUser(AdministrationPerson person)
```
Authenticate a user and return a session token used to log in. If the client reference id is set, the user will be authenticated against that client.

Parameters:

person - the user to login. The userId and password fields must be set.

Returns:

session token, or null on failure

See Also:

loginUser(AdministrationPerson, String[])

logoutUser
```
public boolean logoutUser(AdministrationPerson person)
```
Destory a users session.

Parameters:

person - the user to logout. Yellowfin will destory all sessions for this user

Returns:

true if the session is destroyed

See Also:

#logoutUser(AdministrationPerson, String[])

logoutUserWithUserName
```
public boolean logoutUserWithUserName(java.lang.String Username)
```
Destory a users session.

Parameters:

username - of the user to logout. Yellowfin will destory all sessions for this user

Returns:

true if the session is destroyed

See Also:

#logoutUser(AdministrationPerson, String[])

logoutUser
```
public boolean logoutUser(java.lang.String SessionId)
```
Destory a users session.

Parameters:

SessionID - this is the SessionId obtained from a web-service login. This will destroy the single session matching this id.

Returns:

true if the session is destroyed

See Also:

logoutUser(AdministrationPerson, String)

validateUser
```
public boolean validateUser(java.lang.String userId,
                            java.lang.String password)
```
Authenticate a user without logging them in. This is the preferred method to check if a supplied userid/password is valid. If the client reference id is set, the user will be authenticated against that client.

Parameters:

userId - the userId

password - the password

Returns:

true if the userId/password combination is valid

validateUserAllOrgs
```
public boolean validateUserAllOrgs(java.lang.String userId,
                                   java.lang.String password)
```
Authenticate a user without logging them in but do not enfore client org This is the preferred method to check if a supplied userid/password is valid.

Parameters:

userId - the userId

password - the password

Returns:

true if the userId/password combination is valid

validatePassword
```
public boolean validatePassword(java.lang.String userId,
                                java.lang.String password)
```
Authenticate a user without logging them in. This is the preferred method to check if a supplied userid/password is valid. If the client reference id is set, the user will be authenticated against that client.

Parameters:

userId - the userId

password - the password

Returns:

true if the userId/password combination is valid

requestPasswordReset
```
public boolean requestPasswordReset(java.lang.String userId)
```
Request a password reset for the given userid.

Parameters:

userId - the user id to request the password reset for

Returns:

true if the password reset request was successful.

loginUser

public java.lang.String loginUser(AdministrationPerson person,
                                  java.lang.String[] loginParameters)

Authenticate a user and return a session token used to log in. If the client reference id is set, the user will be authenticated against that client.

Parameters may be passed to the login process to modify the user's session. Parameters take the form "key=value", and the following are valid parameters:

Key	Values	Description
yftoolbar	true/false	Whether or not to show the toolbar (Dashboard, Create Report, Report List and Administration links) on appropriate pages. Setting this option overrides the system-wide configuration setting.
entry	dashboard reportlist createreport administration viewreport	The initial page to redirect to upon login. The user must have the necessary functional access. The default is dashboard if the user has dashboard access, otherwise reportlist. If set to viewreport, you must also set the reportid or reportname.
reportid	ReportId	When entry=viewreport, this specifies the report to view.
reportname	Report Object Name	When entry=viewreport, this specifies the report to view.
filter<FilterId>	Filter Value	When entry=viewreport, this sets the value for a prompt filter in the report. Multiple filter values may be set, using the FilterId for each one. The Filter Ids can be retrieved from the ReportService.
disablesourcefilters	true/false	If this is set to true, source filters will be disabled on all reports run by this user during the login session. Only enable this for users who are allowed to see all data unrestricted. Note: this does not affect reports created against Stored Procedures that use a source filter for one of the parameters to the Stored Procedure.
hideheader	true/false	If this is set to true, the page header will not be shown. Setting this option overrides the system-wide configuration setting.
hidefooter	true/false	If this is set to true, the page footer will not be shown. Setting this option overrides the system-wide configuration setting.
hidesidenav	true/false	If this is set to true, the page left navigation will not be shown. Setting this option overrides the system-wide configuration setting.
hidelogoff	true/false	If this is set to true, the logoff links will not be shown.
reasoncode	reason	A reason code to include in events logged during this user's session
reasondescription	reason	A reason description to include in events logged during this user's session

For example:

   AdministrationPerson ap = asc.getUser("admin");
   ap.setPassword("password");
   String[] parameters = {
      "entry=administration",
      "disablesourcefilters=true"
   };
   String token = asc.loginUser(ap, parameters);

Parameters:: person - the user to login. The userId and password fields must be set.; loginParameters - parameters to pass to the login process
Returns:: session token, or null on failure

loginUserUnsecure

public java.lang.String loginUserUnsecure(AdministrationPerson person,
                                          java.lang.String[] loginParameters)

Authenticate a user and return a session token used to log in. If the client reference id is set, the user will be authenticated against that client.

Parameters may be passed to the login process to modify the user's session. Parameters take the form "key=value", and the following are valid parameters:

Key	Values	Description
yftoolbar	true/false	Whether or not to show the toolbar (Dashboard, Create Report, Report List and Administration links) on appropriate pages. Setting this option overrides the system-wide configuration setting.
entry	dashboard reportlist createreport administration viewreport	The initial page to redirect to upon login. The user must have the necessary functional access. The default is dashboard if the user has dashboard access, otherwise reportlist. If set to viewreport, you must also set the reportid or reportname.
reportid	ReportId	When entry=viewreport, this specifies the report to view.
reportname	Report Object Name	When entry=viewreport, this specifies the report to view.
disablesourcefilters	true/false	If this is set to true, source filters will be disabled on all reports run by this user during the login session. Only enable this for users who are allowed to see all data unrestricted. Note: this does not affect reports created against Stored Procedures that use a source filter for one of the parameters to the Stored Procedure.
hideheader	true/false	If this is set to true, the page header will not be shown. Setting this option overrides the system-wide configuration setting.
hidefooter	true/false	If this is set to true, the page footer will not be shown. Setting this option overrides the system-wide configuration setting.
hidesidenav	true/false	If this is set to true, the page left navigation will not be shown. Setting this option overrides the system-wide configuration setting.
hidelogoff	true/false	If this is set to true, the logoff links will not be shown.
reasoncode	reason	A reason code to include in events logged during this user's session
reasondescription	reason	A reason description to include in events logged during this user's session

For example:

   AdministrationPerson ap = asc.getUser("admin");
   String[] parameters = {
      "entry=administration",
      "disablesourcefilters=true"
   };
   String token = asc.loginUser(ap, parameters);

Parameters:: person - the user to login. The userId fields must be set.; loginParameters - parameters to pass to the login process
Returns:: session token, or null on failure

logoutUser

public boolean logoutUser(AdministrationPerson person,
                          java.lang.String SessionId)

listReportsForUser
```
public AdministrationReport[] listReportsForUser(AdministrationPerson person)
```
List all webservice enabled reports for the given user. If the client reference id is set, reports for that client will be returned.

Parameters:

person - the person to list reports for

Returns:

list of AdministrationReports

listAllReportsForUser
```
public AdministrationReport[] listAllReportsForUser(AdministrationPerson person)
```
List all reports for the given user, regardless of whether they are web-service enabled. If the client reference id is set, reports for that client will be returned.

Parameters:

person - the person to list reports for

Returns:

list of AdministrationReports

getReportForUser
```
public AdministrationReport getReportForUser(AdministrationPerson person,
                                             java.lang.Integer reportId)
```
Get a specified report for the given user. If the client reference id is set, reports for that client will be returned.

Parameters:

person - the person to list reports for

reportId - the report id to get

Returns:

AdministrationReports object, null if not found

listAllReportsWithComments
```
public AdministrationReport[] listAllReportsWithComments(AdministrationPerson person)
```
List all reports for the given user, regardless of whether they are web-service enabled. If the client reference id is set, reports for that client will be returned.

Parameters:

person - the person to list reports for

Returns:

list of AdministrationReports

listAllReportsFromRegex

public AdministrationReport[] listAllReportsFromRegex(java.lang.String regex,
                                                      AdministrationPerson p)

List all reports that contain a string regex

Parameters:: person - the person to list reports for, regex the string to search
Returns:: list of AdministrationReports

listAllTabsForUser
```
public AdministrationReportGroup[] listAllTabsForUser(AdministrationPerson person)
```
List all dashboard tabs for the given user

Parameters:

the - person to list reports for

Returns:

list of AdministrationReportGroups

listAllTabsForUser
```
public AdministrationReportGroup[] listAllTabsForUser(AdministrationPerson person,
                                                      boolean loadReports)
```
List all dashboard tabs for the given user

Parameters:

the - person to list reports for

loadreports - will load a list of reports present on the tab.

Returns:

list of AdministrationReportGroups

listAllTabsForUser

public AdministrationReportGroup[] listAllTabsForUser(AdministrationPerson person,
                                                      boolean loadReports,
                                                      java.lang.Integer tabId)

List all dashboard tabs for the given user

Parameters:: the - person to list reports for; loadreports - will load a list of reports present on the tab.; tabId - Tab id to load (null for all)
Returns:: list of AdministrationReportGroups

listParentsTabsWithSubTabsForUser

public ParentReportGroup[] listParentsTabsWithSubTabsForUser(AdministrationPerson person,
                                                             boolean loadReports,
                                                             java.lang.Integer tabId)

listAllParentTabs
```
public ParentDashboard[] listAllParentTabs(AdministrationPerson person,
                                           boolean loadReports)
```
List all dashboard tabs for the given user

Parameters:

the - person to list reports for

loadreports - will load a list of reports present on the tab.

tabId - Tab id to load (null for all)

Returns:

list of AdministrationReportGroups

listAllTabsForUserFromParent
```
public ParentDashboard listAllTabsForUserFromParent(AdministrationPerson person,
                                                    boolean loadReports,
                                                    java.lang.Integer tabId)
```
List all dashboard subtabs for the given Dashboard id

Parameters:

the - person to list reports for

loadreports - will load a list of reports present on the tab.

tabId - dashboard ID

Returns:

list of AdministrationReportGroups

listUserFavourites
```
public AdministrationReport[] listUserFavourites(AdministrationPerson person)
```
List all favourites for the given user

Parameters:

person - the person to list reports for

loadreports - will load a list of reports present in the favourites list

Returns:

list of AdministrationReports

addToUserFavourites
```
public boolean addToUserFavourites(AdministrationPerson person,
                                   AdministrationReport report)
```
Assign a report to a users favourites list

Parameters:

person, - the person to list reports for

report, - the report to add

Returns:

list of AdministrationReports

listUserInbox
```
public AdministrationReport[] listUserInbox(AdministrationPerson person)
```
List all inbox reports for the given user

Parameters:

person - the person to list reports for

loadreports - will load a list of reports present in the users inbox

Returns:

list of AdministrationReports

createGroup
```
public boolean createGroup(AdministrationGroup group)
```
Create a new group. If the client reference id is set, the group will be created under that client.

Parameters:

group - the AdministrationGroup to create

Returns:

creation succeeded (true/false)

getGroup
```
public AdministrationGroup getGroup(AdministrationGroup group)
```
Fetch a group record from the server. If the client reference id is set, only a group for that client will be returned.

Parameters:

group - an AdministrationGroup object. The GroupName must be set.

Returns:

an AdministrationGroup object representing the group, or null

deleteGroup
```
public boolean deleteGroup(AdministrationGroup group)
```
Delete a group. If the client reference id is set, the group must belong to that client.

Parameters:

group - the AdministrationGroup object you want to delete

Returns:

true if deleting the group was successful

modifyGroup
```
public boolean modifyGroup(AdministrationGroup group)
```
Modify a group. If the client reference id is set, the group must belong to that client.

Parameters:

group - the AdministrationGroup object you want to modify

Returns:

true if the modification was successful

listGroups
```
public AdministrationGroup[] listGroups()
```
Retrieve a list of groups from the server. If the client reference id is set, groups for that client will be returned.

Returns:

an array of AdministrationGroup objects, or null on failure

listRoles
```
public AdministrationRole[] listRoles()
```
Retrieve a list of roles from the server.

Returns:

an array of AdministrationRole objects, or null on failure

addUserToGroup
```
public boolean addUserToGroup(AdministrationPerson person,
                              AdministrationGroup group,
                              boolean include)
```
Adds a user to a group. Use the client reference id to indicate a group at a particular client organisation.

Parameters:

person - the person to add to the group

group - the group

include - whether to include or exclude the user from the group

Returns:

true on success

removeUserFromGroup
```
public boolean removeUserFromGroup(AdministrationPerson person,
                                   AdministrationGroup group)
```
Removes a user from a group. Use the client reference id to indicate a group at a particular client organisation.

Parameters:

person - the person to remove from the group

group - the group

Returns:

true on success

listClients
```
public AdministrationClientOrg[] listClients()
```
Retrieve a list of client organisations from the server. The returned array will include the default (Primary) organisation. Note that if the Client Organisations configuration parameter is not turned on on the server, this will always return an empty array.

Returns:

an array of AdministrationClientOrg objects, or null on failure

getClient
```
public AdministrationClientOrg getClient(AdministrationClientOrg client)
```
Retrieve a client organisation from the server. Note that if the Client Organisations configuration parameter is not turned on on the server, this will always return null.

Parameters:

client - The client organisation to return.

Returns:

The client organisation

createClient
```
public boolean createClient(AdministrationClientOrg client)
```
Creates a client organisation. Note that if the Client Organisations configuration parameter is not turned on on the server, this will do nothing.

Parameters:

client - The client organisation to create.

Returns:

true on success

deleteClient
```
public boolean deleteClient(AdministrationClientOrg client)
```
Deletes a client organisation. Users will no longer be able to log into this organisation. Note that if the Client Organisations configuration parameter is not turned on on the server, this will do nothing.

Parameters:

client - The client organisation to delete.

Returns:

true on success

updateClient
```
public boolean updateClient(AdministrationClientOrg client)
```
Updates a client organisation. If the client represents the default (primary) organisation, you can update the Reference Id, Name and TimeZone parameters. Otherwise, only the Name and TimeZone can be updated, as the Reference Id is required to identify the client. Note that if the Client Organisations configuration parameter is not turned on on the server, this will do nothing.

Parameters:

client - The client organisation to update.

Returns:

true on success

getUserAccess
```
public AdministrationPerson[] getUserAccess(AdministrationClientOrg client)
```
Retrieves the users that can log into a client organisation. Note that if the Client Organisations configuration parameter is not turned on on the server, this will always an empty array.

Parameters:

client - the client organisation

Returns:

an array of AdministrationPerson objects, or null on failure

getUserAccess
```
public AdministrationClientOrg[] getUserAccess(AdministrationPerson person)
```
Retrieves the clients that a user can log in to. Note that if the Client Organisations configuration parameter is not turned on on the server, this will always return null.

Parameters:

person - the user

Returns:

an array of AdministrationClientOrg objects, or null on failure

addUserAccess
```
public boolean addUserAccess(AdministrationPerson person,
                             AdministrationClientOrg client)
```
Allows a user to log in to a client organisation. Note that if the Client Organisations configuration parameter is not turned on on the server, this will do nothing.

Parameters:

person - the user

client - the client organisation to allow access to

Returns:

true on success

removeUserAccess
```
public boolean removeUserAccess(AdministrationPerson person,
                                AdministrationClientOrg client)
```
Disallows a user to log in to a client organisation. Note that if the Client Organisations configuration parameter is not turned on on the server, this will do nothing.

Parameters:

person - the user

client - the client organisation to disallow access to

Returns:

true on success

addBirtReport
```
public boolean addBirtReport(AdministrationReport birtReport)
```
Upload a BIRT report into Yellowfin. If the client reference id is set, the report will be created under that client.

Returns:

true if the upload was successful

flushGeometry
```
public boolean flushGeometry(java.lang.Integer ViewId)
```
Force Yellowfin to refresh the geometry cache for a particular view Used by Yellowfin to synchronise with cluster nodes

Returns:

true if service was completed successfully

delGeopack
```
public boolean delGeopack(java.lang.String packId)
```
Force Yellowfin to remove a particular GeoPack from the geopack cache. Used by Yellowfin to synchronise with cluster nodes

Returns:

true if service was completed successfully

reloadCodes
```
public boolean reloadCodes(java.util.ArrayList<java.lang.String> codes)
```
Force Yellowfin to reload reference codes Used by Yellowfin to synchronise with cluster nodes

Returns:

true if service was completed successfully

removeViewFromCache
```
public boolean removeViewFromCache(java.lang.Integer ViewId)
```
Force removal of a view from the view cache Used by Yellowfin to synchronise with cluster nodes

Returns:

true if service was completed successfully

removeDocumentFromCache
```
public boolean removeDocumentFromCache(java.lang.Integer documentId)
```
Force removal of a view from the view cache Used by Yellowfin to synchronise with cluster nodes

Returns:

true if service was completed successfully

removeContentManagementFromCache
```
public boolean removeContentManagementFromCache(java.lang.Integer contentId)
```
Force removal of a view from the view cache Used by Yellowfin to synchronise with cluster nodes

Returns:

true if service was completed successfully

removeReportFromCache
```
public boolean removeReportFromCache(java.lang.Integer ReportId)
```
Force removal of a report from the report definition cache Used by Yellowfin to synchronise with cluster nodes

Returns:

true if service was completed successfully

removeGroupFromCache
```
public boolean removeGroupFromCache(java.lang.Integer groupId)
```
Force removal of a group from the group cache Used by Yellowfin to synchronise with cluster nodes

Returns:

true if service was completed successfully

removePersonFromCache
```
public boolean removePersonFromCache(java.lang.Integer personId)
```
Force removal of a person from the person cache Used by Yellowfin to synchronise with cluster nodes

Returns:

true if service was completed successfully

removeTextEntityFromCache
```
public boolean removeTextEntityFromCache(java.lang.Integer textId)
```
Force removal of a text entity from the text entity cache Used by Yellowfin to synchronise with cluster nodes

Returns:

true if service was completed successfully

removeDashboardFromCache
```
public boolean removeDashboardFromCache(java.lang.Integer tabId)
```
Force removal of a tab from the dashboard definition cache Used by Yellowfin to synchronise with cluster nodes

Returns:

true if service was completed successfully

reloadLicence
```
public boolean reloadLicence()
```

closeConnectionPool

public boolean closeConnectionPool(java.lang.Integer sourceId)

flushCachedFilterCache

public boolean flushCachedFilterCache(java.lang.Integer filterId)

logoutUserByUserName

public boolean logoutUserByUserName(java.lang.String UserName)

logoutUserByUserIp

public boolean logoutUserByUserIp(java.lang.Integer UserIp,
                                  java.lang.String ContainerSessionId)

logoutUserByUserIpWithErrorsSuppressed
```
public boolean logoutUserByUserIpWithErrorsSuppressed(java.lang.Integer userIp,
                                                      java.lang.String containerSessionId)
```
Logout User by Internal Id, with error suppression

Parameters:

userIp - is the internal identifier of the user you wish to logout

containerSessionId - is the container sessionId to limit logout to a particular session.

Returns:

service succeeded (true/false)

logoutUserByUserName

public boolean logoutUserByUserName(java.lang.String UserName,
                                    java.lang.String ContainerSessionId)

logoutUserByUserNameWithErrorsSuppressed
```
public boolean logoutUserByUserNameWithErrorsSuppressed(java.lang.String userName,
                                                        java.lang.String containerSessionId)
```
Logout User by username, with error suppression

Parameters:

userName - is the username of the user you wish to logout

containerSessionId - is the container sessionId to limit logout to a particular session.

Returns:

service succeeded (true/false)

isReportFavourite

public boolean isReportFavourite(java.lang.Integer reportId,
                                 java.lang.String loginId)

isReportFavourite

public boolean isReportFavourite(AdministrationReport report,
                                 AdministrationPerson person)

deleteFavourite

public boolean deleteFavourite(java.lang.Integer reportId,
                               java.lang.String loginId)

deleteFavourite

public boolean deleteFavourite(AdministrationReport report,
                               AdministrationPerson person)

addToFavourites

public boolean addToFavourites(java.lang.Integer reportId,
                               java.lang.String loginId)

addToFavourites

public boolean addToFavourites(AdministrationReport report,
                               AdministrationPerson person)

addPersonFavourite

public boolean addPersonFavourite(PersonFavourite pf)

removePersonFavourite

public boolean removePersonFavourite(PersonFavourite pf)

retrieveAvatar

public ReportBinaryObject retrieveAvatar(java.lang.String id)

retrieveAvatar

public ReportBinaryObject retrieveAvatar(java.lang.Integer id)

retrieveAvatars

public ReportBinaryObject[] retrieveAvatars(java.lang.Integer[] ids)

retrieveAvatars

public ReportBinaryObject[] retrieveAvatars(java.lang.String[] ids)

listPersonFavourites

public PersonFavourite[] listPersonFavourites(PersonFavourite pf)

listPersonFavourites

public PersonFavourite[] listPersonFavourites(PersonFavourite pf,
                                              java.lang.Integer retrospectiveDays)

approveReport

public boolean approveReport(java.lang.Integer reportId)

rejectReport

public boolean rejectReport(java.lang.Integer reportId)

addColumnToViews
```
public boolean addColumnToViews(java.lang.Integer sourceId,
                                java.lang.String tableName,
                                java.lang.String columnName,
                                java.lang.String fieldCategoryName)
```
Adds a column on a specific table to all views that use that table.

Parameters:

sourceId - the Yellowfin SourceId. Only views in this source will be modified.

tableName - the name of the table on the database that the column is on.

columnName - the column name to add.

fieldCategoryName - the name of a field category to add new columns to.

Returns:

true if service was completed successfully

addColumnToViews
```
public boolean addColumnToViews(java.lang.String dataSourceName,
                                java.lang.String tableName,
                                java.lang.String columnName,
                                java.lang.String fieldCategoryName)
```
Adds a column on a specific table to all views that use that table.

Parameters:

dataSourceName - the name of a Yellowfin data source. Only views in this source will be modified.

tableName - the name of the table on the database that the column is on.

columnName - the column name to add.

fieldCategoryName - the name of a field category to add new columns to.

Returns:

true if service was completed successfully

setAvatarImage
```
public boolean setAvatarImage(AdministrationPerson person,
                              java.lang.String base64EncodedImage)
```
Sets the a uses avatar image

Parameters:

person - the person to change the avatar image for

base64EncodedImage - base64 byte array representing the image

testConnection
```
public int testConnection()
```
Tests the webservices connection. (Used Internally)

Returns:

zero on success, or the error code

doWebServicesRequest

protected AdministrationServiceResponse doWebServicesRequest(AdministrationServiceRequest rsr)
                                                      throws WebserviceException

Perform a Webservices Request (Used Internally and by methods in i4Report)

Parameters:: Report - Service Request
Returns:: Web Services Response
Throws:: WebserviceException

getServiceURL
```
public java.lang.String getServiceURL()
```
Returns the alternate service path

Returns:

the alternate service path

getPort
```
public int getPort()
```
Returns the tcp port to connect to

Returns:

the tcp port to connect to

getUsername
```
public java.lang.String getUsername()
```
Returns the username of the Yellowfin user to connect to the web service

Returns:

the username of the Yellowfin user to connect to the web service

getWebServicesHost
```
public java.lang.String getWebServicesHost()
```
Returns the host to connect to

Returns:

the host to connect to

getMessages
```
public java.lang.String[] getMessages()
```
Get Messages from last service call. Returns an array of Strings that shows debug information as the service is run on the server. Used for debugging and tracing errors.

Returns:

list of Messages.

getErrorCode
```
public java.lang.Integer getErrorCode()
```
Returns the error code from the most recent service call.

Returns:

the error code from the most recent service call.

setErrorCode

public void setErrorCode(java.lang.Integer errorCode)

getClientReferenceId
```
public java.lang.String getClientReferenceId()
```
Returns the client reference id used in web service calls.

Returns:

the client reference id used in web service calls.

getRsr

public AdministrationServiceRequest getRsr()

setRsr

public void setRsr(AdministrationServiceRequest rsr)

getRs

public AdministrationServiceResponse getRs()

setRs

public void setRs(AdministrationServiceResponse rs)

setClientReferenceId
```
public void setClientReferenceId(java.lang.String clientReferenceId)
```
Sets the client reference id used in web service calls. This reference can be used to make web service calls specific to client organisations. If this is not set, all web service calls will relate to the default (primary or parent) organisation. Note that if the Client Organisations configuration parameter is not turned on on the server, this has no effect.

Parameters:

clientReferenceId - the client reference id to use in web service calls

getSessionId

public java.lang.String getSessionId()

getClientRelease
```
public static final java.lang.String getClientRelease()
```
Returns the major release version that the client library was built against (eg. "5.0", "4.1")

getClientBuild
```
public static final java.lang.String getClientBuild()
```
Returns the build version number that the client library was built against (eg. "20100512")

flushBinaryClassLoaderCache
```
public boolean flushBinaryClassLoaderCache()
```
Force Yellowfin to refresh the binary class loader cache for a particular view Used by Yellowfin to synchronise with cluster nodes

Returns:

true if service was completed successfully

refreshAccessLevelList

public void refreshAccessLevelList(java.lang.Integer contentId)

removeAccessLevelFromCache

public void removeAccessLevelFromCache(java.lang.String contentKey)

listAllSchedules

public AdministrationSchedule[] listAllSchedules()
                                          throws WebserviceException

Throws:: WebserviceException

loadSchedule

public AdministrationSchedule loadSchedule(java.lang.String scheduleUUID)
                                    throws WebserviceException

Throws:: WebserviceException

saveSchedule

public AdministrationSchedule saveSchedule(AdministrationSchedule schedule)
                                    throws WebserviceException

Throws:: WebserviceException

deleteSchedule

public void deleteSchedule(java.lang.String scheduleUUID)
                    throws WebserviceException

Throws:: WebserviceException

runScheduleNow

public AdministrationSchedule runScheduleNow(java.lang.String scheduleUUID)
                                      throws WebserviceException

Throws:: WebserviceException

pauseSchedule

public AdministrationSchedule pauseSchedule(java.lang.String scheduleUUID)
                                     throws WebserviceException

Throws:: WebserviceException

resumeSchedule

public AdministrationSchedule resumeSchedule(java.lang.String scheduleUUID)
                                      throws WebserviceException

Throws:: WebserviceException

updateAdminMode
```
public boolean updateAdminMode(java.util.Map<java.lang.String,java.lang.String> functions,
                               boolean enableAdminMode)
```
Send a request to enable/disable admin mode based on the enableAdminMode boolean. If enabling, the functions parameter will be used to set up admin mode. The request will always be sent with a false parameter to prevent it from triggering another round of requests

performCacheCommands
```
public boolean performCacheCommands(AdministrationCacheCommand[] commands)
```
Send a request to run a set of commands against system caches. You can force yellowfin to flush or load specific caches and entities.

removeFromRESTUserCache

public boolean removeFromRESTUserCache(RESTUserCacheRemovalInfo removalInfo)

Remove entries from the RESTUserCache

serialize

public byte[] serialize(java.io.Serializable obj)
                 throws java.io.IOException

Convert an object into a byte array.

Throws:: java.io.IOException

Class AdministrationServiceClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logging

sessionId

messages

secure

internal

ErrorCode

clientReferenceId

Constructor Detail

AdministrationServiceClient

AdministrationServiceClient

AdministrationServiceClient

AdministrationServiceClient

AdministrationServiceClient

AdministrationServiceClient

AdministrationServiceClient

AdministrationServiceClient

Method Detail

createUser

createUniqueUser

editUser

changePassword

getUser

getUserByIp

getUsersFromSearch

deleteUser

loginUser

logoutUser

logoutUserWithUserName

logoutUser

validateUser

validateUserAllOrgs

validatePassword

requestPasswordReset

loginUser

loginUserUnsecure

logoutUser

listReportsForUser

listAllReportsForUser

getReportForUser

listAllReportsWithComments

listAllReportsFromRegex

listAllTabsForUser

listAllTabsForUser

listAllTabsForUser

listParentsTabsWithSubTabsForUser

listAllParentTabs

listAllTabsForUserFromParent

listUserFavourites

addToUserFavourites

listUserInbox

createGroup

getGroup

deleteGroup

modifyGroup

listGroups

listRoles

addUserToGroup

removeUserFromGroup

listClients

getClient

createClient

deleteClient

updateClient

getUserAccess

getUserAccess

addUserAccess

removeUserAccess

addBirtReport

flushGeometry

delGeopack

reloadCodes

removeViewFromCache

removeDocumentFromCache

removeContentManagementFromCache