public interface ProcessAnalyticsService
extends com.appiancorp.services.ContextSensitiveService
ProcessAnalyticsService provides access to reports on entities and events throughout the process application. These reports can be configured through XML and through the interface. Each report type has an associated data set and a display specification.
Generic reports are referred to as "process reports" or simply "reports". Reports
intended for display in the processes area of the UI navigation are referred
to as "process views"; those intended for display in the tasks area of the UI are
referred to as "task views". Reports, process views, and task views are all
defined by the same ProcessReport class; they simply denote different
intended uses of this class.
Methods of service classes can all throw the runtime exception
ServiceException if any
system-level error (for example, server failure) occurs, and will in general
throw a checked exception (InvalidXXXException) when an entity
to be retrieved is inaccessible, instead of returning null.
Exceptions to this paradigm (including the use of ResultList as
described below) are noted. All checked exceptions extend
AppianException.
It may be necessary to retrieve a subset of results as opposed to an entire
collection, and also to sort the subset by some property of the returned
object. "Paging" methods which return a
ResultPage are provided in certain
instances for this purpose. The ResultPage will contain the
sorted subset of results
(via Result.getResults()), and the
total number of items in the available result set
(via ResultPage.getAvailableItems()).
It may also be necessary to retrieve some results, even if all results
cannot be retrieved (for instance, some of the entities corresponding
to a list of entity IDs may no longer exist). Methods which return a
ResultList are provided for this
purpose. The Result.getResults()
method in this case will return all results which can be retrieved. In
addition, there will be a list of result codes
(ResultList.getResultCodes()) that
represent the successful retrieval of an entity, or, if the entity could
not be retrieved, the reason for the failure. See the CODE_XXX
constants in ResultList for details.
| Modifier and Type | Method and Description |
|---|---|
void |
activateUserSession(java.lang.Long[] membership_,
java.lang.Long[] administration_,
java.lang.Long userTypeId_,
java.lang.String username)
Notifies the process analytics application that a new session has been
created for the current user, and provides information about the current
user's membership and administration rights to groups.
|
ProcessReport |
addMyProcessReport(ProcessReport spec_)
Add a process report to the My Reports folder.
|
void |
commitUpdateUsernames()
Deprecated.
|
ProcessReport |
createProcessReport(ProcessReport spec_,
java.lang.Long folderId_)
Add a process report to the specified folder.
|
java.lang.String |
evaluateExpressionForProcess(java.lang.Long processId_,
java.lang.String expression_,
boolean recursive_)
Evaluates an expression using the specified process as the context.
|
java.lang.String |
evaluateExpressionForProcessModel(java.lang.Long modelId_,
java.lang.String expression_,
boolean recursive_)
Evaluates an expression using the specified process model as the context.
|
PartialResult |
evaluateExpressionResultForProcess(java.lang.Long processId_,
java.lang.String expression_,
boolean recursive_,
NamedTypedValue[] continueParams)
Evaluates an expression using the specified process as the context.
|
PartialResult |
evaluateExpressionResultForProcessModel(java.lang.Long modelId_,
java.lang.String expression_,
boolean recursive_,
NamedTypedValue[] continueParams)
Evaluates an expression using the specified process model as the context.
|
java.lang.String[] |
evaluateExpressionsForProcess(java.lang.Long processId_,
java.lang.String[] expressions_,
boolean recursive_)
Evaluates multiple expressions using the specified process as the context.
|
PartialResult[] |
evaluateExpressionsResultForProcess(java.lang.Long processId_,
java.lang.String[] expressions_,
boolean recursive_,
NamedTypedValue[][] continueParams)
Evaluates multiple expressions using the specified process as the context.
|
ResultPage |
getAcceptedTasks(int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Gets the tasks accepted by the current user.
|
ResultPage |
getAllTasks(int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Gets all the tasks for the current user.
|
ResultPage |
getAllTasksWithExceptions(int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Gets the tasks with a state of
TaskSummary.TASK_STATUS_PAUSED_BY_EXCEPTION
that were completed by the current user. |
ResultPage |
getAssignedTasks(int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Gets the tasks assigned to the current user.
|
ResultPage |
getCancelledProcessesForProcessModel(java.lang.Long processModelId_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Retrieves all cancelled processes for a
ProcessModel. |
ResultPage |
getCompletedProcessesForProcessModel(java.lang.Long processModelId_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Retrieves all completed processes for a
ProcessModel. |
ResultPage |
getCompletedTasks(int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Gets the tasks completed by current user.
|
ProcessReport[] |
getMyProcessViews()
Retrieves the process views for the current user.
|
int |
getMyTaskCount()
Gets the total number of tasks that are either assigned to
or accepted by the current user.
|
ResultPage |
getMyTasks(int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Gets the tasks assigned to or accepted by the current user (that is with a status of
TaskSummary.TASK_STATUS_ASSIGNED or
TaskSummary.TASK_STATUS_ACCEPTED
for the current user). |
ProcessReport[] |
getMyTaskViews()
Retrieves the task views for the current user.
|
ResultPage |
getPausedProcessesForProcessModel(java.lang.Long processModelId_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Retrieves all paused processes for a
ProcessModel. |
ResultPage |
getPausedTasks(int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Retrieves all paused tasks for the current
User. |
ResultPage |
getProcessesForProcessModel(java.lang.Long processModelId_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Retrieves all processes for a
ProcessModel regardless
of their status. |
ResultPage |
getProcessesWithExceptionsForProcessModel(java.lang.Long processModelId_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Retrieves all processes which are paused by an exception for a
ProcessModel. |
ProcessReport |
getProcessReport(java.lang.Long id)
Retrieves a report specification given its id.
|
ProcessReport[] |
getProcessReports(java.lang.Long[] ids)
Retrieves a array of report specifications given their ids.
|
ReportResultPage |
getReportPage(ReportData spec_)
Deprecated.
use
getReportPageWithTypedValues(ReportData) which returns the result data in
the preferred TypedValue form. |
ReportResultPage |
getReportPage(ReportData spec_,
long timeZoneOffset_)
Deprecated.
use
getReportPageWithTypedValues(ReportData), as the timeZoneOffset_ parameter
in this method is ignored. |
ReportResultPage |
getReportPageWithTypedValues(ReportData spec)
Retrieve the data as
TypedValue cells, for a given
process report specification. |
ResultPage |
getRunningProcessesForProcessModel(java.lang.Long processModelId_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Retrieves all active processes for a
ProcessModel. |
int |
getTaskCountForUser(java.lang.String username)
Gets the total number of tasks that are either assigned to
or accepted by a particular user.
|
ProcessReport |
getTaskViewForGroup(java.lang.Long groupId_)
Get the task view that the current user wishes to use to view the tasks of the specified group.
|
ProcessReport |
getTaskViewForUser(java.lang.String username_)
Get the task view that the current user wishes to use to view the tasks of the specified user.
|
void |
notifyUserCreation(java.lang.String username_)
Deprecated.
done automatically by UserService.createUser
|
void |
notifyUsersCreation(java.lang.String[] usernames_)
Notifies the server that new users were created on the Personalization
server.
|
void |
removeTaskViewForGroup(java.lang.Long groupId_)
Clear the previously-set task view that the current user was using to view the tasks of the specified
group.
|
void |
removeTaskViewForUser(java.lang.String username_)
Clear the previously-set task view that the current user was using to view the tasks of the specified
user.
|
void |
rollbackUpdateUsernames()
Deprecated.
|
void |
setSiteLocaleSettings(SiteLocaleSettings settings_)
Registers the site locale settings on the process analytics engines only.
|
void |
setTaskViewForGroup(java.lang.Long groupId_,
ProcessReport spec_)
Set the task view that the current user wishes to use to view the tasks of the specified group.
|
void |
setTaskViewForUser(java.lang.String username_,
ProcessReport spec_)
Set the task view that the current user wishes to use to view the tasks of the specified user.
|
void |
setTimeZone(BackendTimeZoneSimple tz)
Set the time zone information using the format used by the engines to encapsulate time zone
information.
|
void |
updateProcessReport(ProcessReport spec_)
Update a process report.
|
void |
updateUsernames(java.lang.String[] oldUsernames_,
java.lang.String[] newUsernames_,
long maxExpirationTimeInSeconds_)
Deprecated.
|
boolean |
validateGroupMembership(java.lang.Long[] memGroupIds_,
java.lang.Long[] admGroupIds_,
java.lang.Long userTypeId_,
java.lang.String username)
Validates if the association of a user as 'Member' and as an 'Administrator
has changed or not.
|
static final boolean activateUserSession$UPDATES
static final boolean getMyTaskCount$UPDATES
static final boolean getTaskCountForUser$UPDATES
static final boolean getAllTasks$UPDATES
static final boolean getAssignedTasks$UPDATES
static final boolean getMyTasks$UPDATES
static final boolean getCompletedTasks$UPDATES
static final boolean getAcceptedTasks$UPDATES
static final boolean getAllTasksWithExceptions$UPDATES
static final boolean getPausedTasks$UPDATES
static final boolean getProcessesForProcessModel$UPDATES
static final boolean getCompletedProcessesForProcessModel$UPDATES
static final boolean getCancelledProcessesForProcessModel$UPDATES
static final boolean getRunningProcessesForProcessModel$UPDATES
static final boolean getPausedProcessesForProcessModel$UPDATES
static final boolean getProcessesWithExceptionsForProcessModel$UPDATES
static final boolean notifyUserCreation$UPDATES
static final boolean notifyUsersCreation$UPDATES
static final boolean validateGroupMembership$UPDATES
static final boolean updateUsernames$UPDATES
static final boolean commitUpdateUsernames$UPDATES
static final boolean rollbackUpdateUsernames$UPDATES
static final boolean getProcessReport$UPDATES
static final boolean getProcessReports$UPDATES
static final boolean getMyTaskViews$UPDATES
static final boolean getMyProcessViews$UPDATES
static final boolean updateProcessReport$UPDATES
static final boolean getReportPage$UPDATES
static final boolean getReportPageWithTypedValues$UPDATES
static final boolean addMyProcessReport$UPDATES
static final boolean createProcessReport$UPDATES
static final boolean getTaskViewForUser$UPDATES
static final boolean setTaskViewForUser$UPDATES
static final boolean removeTaskViewForUser$UPDATES
static final boolean getTaskViewForGroup$UPDATES
static final boolean setTaskViewForGroup$UPDATES
static final boolean removeTaskViewForGroup$UPDATES
static final boolean evaluateExpressionForProcessModel$UPDATES
static final boolean evaluateExpressionResultForProcessModel$UPDATES
static final boolean evaluateExpressionForProcess$UPDATES
static final boolean evaluateExpressionResultForProcess$UPDATES
static final boolean evaluateExpressionsForProcess$UPDATES
static final boolean evaluateExpressionsResultForProcess$UPDATES
static final boolean setSiteLocaleSettings$UPDATES
static final boolean setTimeZone$UPDATES
void activateUserSession(java.lang.Long[] membership_,
java.lang.Long[] administration_,
java.lang.Long userTypeId_,
java.lang.String username)
null values for membership_ or
administration_.
If the userTypeId_ is not a valid value (see below), the method will fail
but will NOT throw any exceptionsmembership_ - the list of groups of which the user is a memberadministration_ - the list of groups on which the user has
administrative rightsuserTypeId_ - this is one of
UserProfile.USER_TYPE_BASIC
or UserProfile.USER_TYPE_SYS_ADMINusername - the username of the user whose session is to be activatedcom.appiancorp.asl3.servicefw.connect.ServiceException - if any system-level error occursint getMyTaskCount()
com.appiancorp.asl3.servicefw.connect.ServiceException - if any system-level error occursint getTaskCountForUser(java.lang.String username)
username - the user namecom.appiancorp.asl3.servicefw.connect.ServiceException - if any system-level error occursResultPage getAllTasks(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws ResultPageSizeException
startIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
Should be one of the SORT_BY_XXX constants
defined in TaskSummary.sortOrder_ - The order in which to sort the results. This should be
either
Constants.SORT_ORDER_ASCENDING or
Constants.SORT_ORDER_DESCENDING.ResultPage containing a list of TaskSummary
objects. If a task is completed, then the value of the assignees field in
the corresponding TaskSummary object will be an empty array.com.appiancorp.asl3.servicefw.connect.ServiceException - if any system-level error occursResultPageSizeException - if the batchsize exceeds the limit of items
that can be retrieve per Analytics Engine
(resources.appian.analytics.application.maxreportsize / Number of Analytics Engines).
It can also be thrown if batchsize equals -1, and one Analytics Engine attempts to return
more items than the limit just mention.ResultPage getAssignedTasks(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws ResultPageSizeException
startIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
Should be one of the SORT_BY_XXX constants
defined in TaskSummary.sortOrder_ - The order in which to sort the results. This should be
either
Constants.SORT_ORDER_ASCENDING or
Constants.SORT_ORDER_DESCENDING.ResultPage containing a list of TaskSummary
objectscom.appiancorp.asl3.servicefw.connect.ServiceException - if any system-level error occursResultPageSizeException - if the batchsize exceeds the limit of items
that can be retrieve per Analytics Engine
(resources.appian.analytics.application.maxreportsize / Number of Analytics Engines).
It can also be thrown if batchsize equals -1, and one Analytics Engine attempts
to return more items than the limit just mention.ResultPage getMyTasks(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws ResultPageSizeException
TaskSummary.TASK_STATUS_ASSIGNED or
TaskSummary.TASK_STATUS_ACCEPTED
for the current user).
This does not include tasks from cancelled, paused, or deleted processes.
This is a paging function and only returns the data specified by
the startIndex and batchSizestartIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
Should be one of the SORT_BY_XXX constants
defined in TaskSummary.sortOrder_ - The order in which to sort the results. This should be
either
Constants.SORT_ORDER_ASCENDING or
Constants.SORT_ORDER_DESCENDING.ResultPage containing a list of TaskSummary
objectscom.appiancorp.asl3.servicefw.connect.ServiceException - if any system-level error occursResultPageSizeException - if the batchsize exceeds the limit of items
that can be retrieve per Analytics Engine
(resources.appian.analytics.application.maxreportsize / Number of Analytics Engines).
It can also be thrown if batchsize equals -1, and one Analytics Engine attempts
to return more items than the limit just mention.ResultPage getCompletedTasks(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws ResultPageSizeException
startIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
Should be one of the SORT_BY_XXX constants
defined in TaskSummary.sortOrder_ - The order in which to sort the results. This should be
either
Constants.SORT_ORDER_ASCENDING or
Constants.SORT_ORDER_DESCENDING.ResultPage containing a list of TaskSummary
objects. The assignee field for all summaries will be an empty array.com.appiancorp.asl3.servicefw.connect.ServiceException - if any system-level error occursResultPageSizeException - if the batchsize exceeds the limit of items
that can be retrieve per Analytics Engine
(resources.appian.analytics.application.maxreportsize / Number of Analytics Engines).
It can also be thrown if batchsize equals -1, and one Analytics Engine attempts
to return more items than the limit just mention.ResultPage getAcceptedTasks(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws ResultPageSizeException
startIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
Should be one of the SORT_BY_XXX constants
defined in TaskSummary.sortOrder_ - The order in which to sort the results. This should be
either
Constants.SORT_ORDER_ASCENDING or
Constants.SORT_ORDER_DESCENDING.ResultPage containing a list of TaskSummary
objectscom.appiancorp.asl3.servicefw.connect.ServiceException - if any system-level error occursResultPageSizeException - if the batchsize exceeds the limit of items
that can be retrieve per Analytics Engine
(resources.appian.analytics.application.maxreportsize / Number of Analytics Engines).
It can also be thrown if batchsize equals -1, and one Analytics Engine attempts
to return more items than the limit just mention.ResultPage getAllTasksWithExceptions(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws ResultPageSizeException
TaskSummary.TASK_STATUS_PAUSED_BY_EXCEPTION
that were completed by the current user.
This does not include tasks from cancelled, paused, or deleted processes.
This is a paging function and only returns the data specified by
the startIndex and batchSizestartIndex_ - The index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - The number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - The property by which the results will be sorted.
Should be one of the SORT_BY_XXX constants defined in
TaskSummary.TASK_STATUS_PAUSED_BY_EXCEPTION.sortOrder_ - The order in which to sort the results. This should be
either
Constants.SORT_ORDER_ASCENDING or
Constants.SORT_ORDER_DESCENDING.ResultPage containing a list of
TaskSummary objects . If a task is completed, then the value
of the assignees field in the corresponding TaskSummary object
will be an empty array.com.appiancorp.asl3.servicefw.connect.ServiceException - if any system-level error occursResultPageSizeException - if the batchsize exceeds the limit of items
that can be retrieve per Analytics Engine
(resources.appian.analytics.application.maxreportsize / Number of Analytics Engines).
It can also be thrown if batchsize equals -1, and one Analytics Engine attempts
to return more items than the limit just mention.ResultPage getPausedTasks(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws ResultPageSizeException
User.
This is a paging function and only returns the data specified by
the startIndex and batchSizestartIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
This is one of the SORT_BY_XXX constants.
Located in TaskSummary.TASK_STATUS_PAUSED.sortOrder_ - the order in which to sort the results.
This is one of
Constants.SORT_ORDER_ASCENDING
or Constants.SORT_ORDER_DESCENDINGResultPage containing an array of
TaskSummary objects representing all paused tasks in the
system.ResultPageSizeException - if the batchsize exceeds the limit of items
that can be retrieve per Analytics Engine
(resources.appian.analytics.application.maxreportsize / Number of Analytics Engines).
It can also be thrown if batchsize equals -1, and one Analytics Engine attempts
to return more items than the limit just mention.ResultPage getProcessesForProcessModel(java.lang.Long processModelId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidProcessModelException, PrivilegeException, ResultPageSizeException
ProcessModel regardless
of their status.
This is a paging function and only returns the data specified by
the startIndex and batchSizeprocessModelId_ - The ID of the ProcessModel for which
to retrieve all processes.startIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
This is one of the SORT_BY_XXX constants.
Located in ProcessSummary.sortOrder_ - the order in which to sort the results.
This is one of
Constants.SORT_ORDER_ASCENDING
or Constants.SORT_ORDER_DESCENDINGResultPage containing an array of
ProcessSummary objects representing all processes for the
ProcessModel specified by processModelId_ ProcessSummary are populated: id, name, initiator,
status, priority, startTime,
endTime, id, processModelVersion,
parentId, and processModelName.InvalidProcessModelException - if the ProcessModel does
not existPrivilegeException - if the current User does not have
privileges to view the ProcessModelResultPageSizeException - if the batchsize exceeds the limit of items
that can be retrieve per Analytics Engine
(resources.appian.analytics.application.maxreportsize / Number of Analytics Engines).
It can also be thrown if batchsize equals -1, and one Analytics Engine attempts
to return more items than the limit just mention.ResultPage getCompletedProcessesForProcessModel(java.lang.Long processModelId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidProcessModelException, PrivilegeException, ResultPageSizeException
ProcessModel.
This is a paging function and only returns the data specified by
the startIndex and batchSizeprocessModelId_ - The ID of the ProcessModel for which
to retrieve the completed processes.startIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
This is one of the SORT_BY_XXX constants.
Located in ProcessSummary.sortOrder_ - the order in which to sort the results.
This is one of
Constants.SORT_ORDER_ASCENDING
or Constants.SORT_ORDER_DESCENDINGResultPage containing an array of
ProcessSummary objects representing all completed processes
for the ProcessModel specified by
processModelId_ ProcessSummary are populated: id, name, initiator,
status, priority, startTime,
endTime, id, processModelVersion,
parentId, and processModelName.InvalidProcessModelException - if the ProcessModel does
not existPrivilegeException - if the current User does not have
privileges to view the ProcessModelResultPageSizeException - if the batchsize exceeds the limit of items
that can be retrieve per Analytics Engine
(resources.appian.analytics.application.maxreportsize / Number of Analytics Engines).
It can also be thrown if batchsize equals -1, and one Analytics Engine attempts
to return more items than the limit just mention.ResultPage getCancelledProcessesForProcessModel(java.lang.Long processModelId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidProcessModelException, PrivilegeException, ResultPageSizeException
ProcessModel.
This is a paging function and only returns the data specified by
the startIndex and batchSizeprocessModelId_ - The ID of the ProcessModel for which
to retrieve the cancelled processes.startIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
This is one of the SORT_BY_XXX constants.
Located in ProcessSummary.sortOrder_ - the order in which to sort the results.
This is one of
Constants.SORT_ORDER_ASCENDING
or Constants.SORT_ORDER_DESCENDINGResultPage containing an array of
ProcessSummary objects representing all cancelled processes
for the ProcessModel specified by
processModelId_ ProcessSummary are populated: id, name, initiator,
status, priority, startTime,
endTime, id, processModelVersion,
parentId, and processModelName.InvalidProcessModelException - if the ProcessModel does
not existPrivilegeException - if the current User does not have
privileges to view the ProcessModelResultPageSizeException - if the batchsize exceeds the limit of items
that can be retrieve per Analytics Engine
(resources.appian.analytics.application.maxreportsize / Number of Analytics Engines).
It can also be thrown if batchsize equals -1, and one Analytics Engine attempts
to return more items than the limit just mention.ResultPage getRunningProcessesForProcessModel(java.lang.Long processModelId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidProcessModelException, PrivilegeException, ResultPageSizeException
ProcessModel.
This is a paging function and only returns the data specified by
the startIndex and batchSizeprocessModelId_ - The ID of the ProcessModel for which
to retrieve the running processes.startIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
This is one of the SORT_BY_XXX constants.
Located in ProcessSummary.sortOrder_ - the order in which to sort the results.
This is one of
Constants.SORT_ORDER_ASCENDING
or Constants.SORT_ORDER_DESCENDINGResultPage containing an array of
ProcessSummary objects representing all running processes
for the ProcessModel specified by
processModelId_ ProcessSummary are populated: id, name, initiator,
status, priority, startTime,
endTime, id, processModelVersion,
parentId, and processModelName.InvalidProcessModelException - if the ProcessModel does
not existPrivilegeException - if the current User does not have
privileges to view the ProcessModelResultPageSizeException - if the batchsize exceeds the limit of items
that can be retrieve per Analytics Engine
(resources.appian.analytics.application.maxreportsize / Number of Analytics Engines).
It can also be thrown if batchsize equals -1, and one Analytics Engine attempts
to return more items than the limit just mention.ResultPage getPausedProcessesForProcessModel(java.lang.Long processModelId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidProcessModelException, PrivilegeException, ResultPageSizeException
ProcessModel.
This is a paging function and only returns the data specified by
the startIndex and batchSizeprocessModelId_ - The ID of the ProcessModel for which
to retrieve the paused processes.startIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
This is one of the SORT_BY_XXX constants.
Located in ProcessSummary.sortOrder_ - the order in which to sort the results.
This is one of
Constants.SORT_ORDER_ASCENDING
or Constants.SORT_ORDER_DESCENDINGResultPage containing an array of
ProcessSummary objects representing all paused processes
for the ProcessModel specified by
processModelId_ ProcessSummary are populated: id, name, initiator,
status, priority, startTime,
endTime, id, processModelVersion,
parentId, and processModelName.InvalidProcessModelException - if the ProcessModel does
not existPrivilegeException - if the current User does not have
privileges to view the ProcessModelResultPageSizeException - if the batchsize exceeds the limit of items
that can be retrieve per Analytics Engine
(resources.appian.analytics.application.maxreportsize / Number of Analytics Engines).
It can also be thrown if batchsize equals -1, and one Analytics Engine attempts
to return more items than the limit just mention.ResultPage getProcessesWithExceptionsForProcessModel(java.lang.Long processModelId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidProcessModelException, PrivilegeException, ResultPageSizeException
ProcessModel.
This is a paging function and only returns the data specified by
the startIndex and batchSizeprocessModelId_ - The ID of the ProcessModel for which
to retrieve the processes paused by exception.startIndex_ - the index into the collection of total results at which
to start. Negative numbers are treated as zeros.batchSize_ - the number of results to return.
Use Constants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_ - the property by which the results will be sorted.
This is one of the SORT_BY_XXX constants.
Located in ProcessSummary.sortOrder_ - the order in which to sort the results.
This is one of
Constants.SORT_ORDER_ASCENDING
or Constants.SORT_ORDER_DESCENDINGResultPage containing an array of
ProcessSummary objects representing all processes
which are paused by exception for the ProcessModel
specified by processModelId_ ProcessSummary are populated: id, name, initiator,
status, priority, startTime,
endTime, id, processModelVersion,
parentId, and processModelName.InvalidProcessModelException - if the ProcessModel does
not existPrivilegeException - if the current User does not have
privileges to view the ProcessModelResultPageSizeException - if the batchsize exceeds the limit of items
that can be retrieve per Analytics Engine
(resources.appian.analytics.application.maxreportsize / Number of Analytics Engines).
It can also be thrown if batchsize equals -1, and one Analytics Engine attempts
to return more items than the limit just mention.@Deprecated
void notifyUserCreation(java.lang.String username_)
throws java.lang.NullPointerException
username_ - the name of the user that was addedjava.lang.NullPointerException - if any of the usernames are nullvoid notifyUsersCreation(java.lang.String[] usernames_)
throws java.lang.NullPointerException
usernames_ - the names of the users that were addedjava.lang.NullPointerException - if any of the usernames are nullboolean validateGroupMembership(java.lang.Long[] memGroupIds_,
java.lang.Long[] admGroupIds_,
java.lang.Long userTypeId_,
java.lang.String username)
throws InvalidUserException
memGroupIds_ - Groups for which the User is a memberadmGroupIds_ - Groups for which the User is an administratoruserTypeId_ - this should be one of
UserProfile.USER_TYPE_BASIC
or UserProfile.USER_TYPE_SYS_ADMIN,
but if neither of these constants is given, or the value is null, the the method
will assume
UserProfile.USER_TYPE_BASICusername - the username of the user whose group membership is to be validatedInvalidUserException - if the user calling this method does not existcom.appiancorp.asl3.servicefw.connect.ServiceException - if any system-level error occurs@Deprecated
void updateUsernames(java.lang.String[] oldUsernames_,
java.lang.String[] newUsernames_,
long maxExpirationTimeInSeconds_)
throws java.lang.IllegalArgumentException,
DuplicateNameException,
InvalidUserException,
PrivilegeException
UserService.renameUsersByUuid(java.lang.String[], java.lang.String[])UserService.renameUsersByUuid(java.lang.String[], java.lang.String[])
Updates a list of old usernames to new usernames.
If successful, this method must be followed by
commitUpdateUsernames(). After commitUpdateUsernames
has been called, the old usernames will still be active, but will
expire after the interval specified by
maxExpirationTimeInSeconds_; if updateUsernames
is successful but commitUpdateUsernames is not called, the
new usernames will not become active.
If unsuccessful, this method should be followed by
rollbackUpdateUsernames(). This will simply free memory dedicated
to mapping old usernames to new usernames.
oldUsernames_ - the usernames to be updatednewUsernames_ - the usernames to which the old usernames will be
updatedmaxExpirationTimeInSeconds_ - the interval, in seconds, after
commitUpdateUsernames has been called, after which
the old usernames will expire. If this parameter is zero or a
negative value the old usernames will expire instantly.
After expiration, the old usernames will no longer be valid.java.lang.IllegalArgumentException - if the length of
oldUsernames_ is not the same as the length of
newUsernames_.DuplicateNameException - if any oldUsernames_ or
newUsernames_ contain any duplicates, or if an old
username is being updated to a username that already existsInvalidUserException - if oldUsernames contains an invalid user.com.appiancorp.asl3.servicefw.connect.ServiceException - if any system-level error occursPrivilegeException@Deprecated void commitUpdateUsernames()
UserService.renameUsersByUuid(java.lang.String[], java.lang.String[])UserService.renameUsersByUuid(java.lang.String[], java.lang.String[])
Commits an update of usernames.
This method should be preceded by a call to
updateUsernames(String[], String[], long). After the commit, the
old usernames will be temporarily active, and will expire after the
interval specified by maxExpirationTimeInSeconds_; if
commitUpdateUsernames is not called, the
new usernames will not become active.
com.appiancorp.asl3.servicefw.connect.ServiceException - if any system-level error occurs@Deprecated void rollbackUpdateUsernames()
UserService.renameUsersByUuid(java.lang.String[], java.lang.String[])UserService.renameUsersByUuid(java.lang.String[], java.lang.String[])
Rolls back an update of usernames.
This method should be called if
updateUsernames(String[], String[], long) is unsuccessful. The
rollback will simply free memory dedicated to mapping old usernames to
new usernames.
com.appiancorp.asl3.servicefw.connect.ServiceException - if any system-level error occursProcessReport getProcessReport(java.lang.Long id) throws PrivilegeException
id - the report idPrivilegeException - if the user does not have access to the
report.ProcessReport[] getProcessReports(java.lang.Long[] ids)
ids - the report idsPrivilegeException - if the user does not have access any
single report in the list.ProcessReport[] getMyTaskViews()
ProcessReport[] getMyProcessViews()
void updateProcessReport(ProcessReport spec_)
spec_ - the updated process report.@Deprecated ReportResultPage getReportPage(ReportData spec_, long timeZoneOffset_) throws UnsupportedReportSpecificationException, PrivilegeException, ReportComplexityException, ReportSizeException, ExpressionException
getReportPageWithTypedValues(ReportData), as the timeZoneOffset_ parameter
in this method is ignored.
The results attribute contains an array of Maps, each map representing one
row in the report. Inside each results Map, column values are keyed by cXX and drill path
values are keyed by dpXX, where XX is the id of the column. Furthermore, each row in every report
contains the following keys: permissions, mutablePriority, version, and favorite. Additionally, process
model reports will contain the keys valid and enabled; process and task reports will contain
process_status and task_status.
The value of the permissions key is an object representing the current user's permissions on the object underlying that row of the report. This object will be of one of three classes. For process models, it will be com.appiancorp.suiteapi.process.security.ProcessModelPermissions. For processes, it will be com.appiancorp.suiteapi.process.security.ProcessPermissions. For tasks, it will be com.appiancorp.suiteapi.process.security.NodePermissions.
mutablePriority is a Boolean indicating if the priority of the object can be changed. version is the process model version as a String for process model reports; otherwise, it is an empty String. favorite is a Boolean indicating whether the process model, process, or task is a favorite for the current user.
valid and and enabled will always be present and null for process model reports.
process_status is an Integer indicating the status of the process (active, canceled, completed, etc.). task_status is an Integer indicating the status of the task (assigned, accepted, completed, etc.).
The columnTypes attribute is a Map that contains type information for each
of the columns and drill paths. Column types are keyed by cXX and drill path types are keyed by dpXX,
where XX is the id of the column.
spec_ - the process report specification.timeZoneOffset_ - the time zone offset to use in computing (ignored)UnsupportedReportSpecificationException - if spec_ is invalidPrivilegeException - if the user does not have access to the report.ReportComplexityExceptionReportSizeExceptionExpressionException - if there is an exception in evaluating any
report column expression.@Deprecated ReportResultPage getReportPage(ReportData spec_) throws UnsupportedReportSpecificationException, PrivilegeException, ReportComplexityException, ReportSizeException, ExpressionException
getReportPageWithTypedValues(ReportData) which returns the result data in
the preferred TypedValue form.
The results attribute contains an array of Maps, each map representing one
row in the report. Inside each results Map, column values are keyed by cXX and drill path
values are keyed by dpXX, where XX is the id of the column. Furthermore, each row in every report
contains the following keys: permissions, mutablePriority, version, and favorite. Additionally, process
model reports will contain the keys valid and enabled; process and task reports will contain
process_status and task_status.
The value of the permissions key is an object representing the current user's permissions on the
object underlying that row of the report. This object will be of one of three classes. For process
models, it will be ProcessModelPermissions. For processes,
it will be ProcessPermissions. For tasks, it will be
NodePermissions.
mutablePriority is a Boolean indicating if the priority of the object can be changed. version is the process model version as a String for process model reports; otherwise, it is an empty String. favorite is a Boolean indicating whether the process model, process, or task is a favorite for the current user.
valid and enabled will always be present and null for process model reports.
process_status is an Integer indicating the status of the process (active, canceled, completed, etc.). task_status is an Integer indicating the status of the task (assigned, accepted, completed, etc.).
The columnTypes attribute is a Map that contains type information for each
of the columns and drill paths. Column types are keyed by cXX and drill path types are keyed by dpXX,
where XX is the id of the column.
If the report has grouping but no aggregation function is set, count will be used.
When there are no results to return, the
Result.getResults() method returns
an empty array of Row objects.
spec_ - the process report specification.UnsupportedReportSpecificationException - if spec_ is invalidPrivilegeException - if the user does not have access to the report.ReportComplexityExceptionReportSizeException - if the number of rows to return will exceed
com.appiancorp.process.analytics2.AnalyticsConfiguration#getMaxReportSizeExpressionException - if there is an exception in evaluating any
report column expression.ReportResultPage getReportPageWithTypedValues(ReportData spec) throws UnsupportedReportSpecificationException, PrivilegeException, ReportComplexityException, ReportSizeException, ExpressionException
TypedValue cells, for a given
process report specification.
The results attribute contains an array of Maps, each map representing one
row in the report. Inside each results Map, column values are keyed by cXX and drill path
values are keyed by dpXX, where XX is the id of the column. Furthermore, each row in every report
contains the following keys: permissions, mutablePriority, version, and favorite. Additionally, process
model reports will contain the keys valid and enabled; process and task reports will contain
process_status and task_status.
The value of the permissions key is an object representing the current user's permissions on the
object underlying that row of the report. This object will be of one of three classes. For process
models, it will be ProcessModelPermissions.
For processes, it will be ProcessPermissions.
For tasks, it will be NodePermissions.
mutablePriority is a Boolean indicating if the priority of the object can be changed. version is the process model version as a String for process model reports; otherwise, it is an empty String. favorite is a Boolean indicating whether the process model, process, or task is a favorite for the current user.
valid and and enabled will always be present and null for process model reports.
process_status is an Integer indicating the status of the process (active, canceled, completed, etc.). task_status is an Integer indicating the status of the task (assigned, accepted, completed, etc.).
The columnTypes attribute is a Map that contains type information for each
of the columns and drill paths. Column types are keyed by cXX and drill path types are keyed by dpXX,
where XX is the id of the column.
spec - the process report specification.TypedValueUnsupportedReportSpecificationException - if spec is invalidPrivilegeException - if the user does not have access to the report.ReportComplexityExceptionReportSizeExceptionExpressionException - if there is an exception in evaluating any
report column expression.ProcessReport addMyProcessReport(ProcessReport spec_) throws java.lang.IllegalArgumentException, PrivilegeException, InvalidUserException, StorageLimitException, java.io.IOException
spec_ - The process report specification to add.java.lang.IllegalArgumentException - if some attribute of spec_ is invalidPrivilegeException - if the current user is neither an editor nor
an administrator of the folderInvalidUserException - if the user calling this method is invalidStorageLimitException - if there is not enough space in the KC to create this report.java.io.IOException - if there is an error writing this reportProcessReport createProcessReport(ProcessReport spec_, java.lang.Long folderId_) throws java.lang.IllegalArgumentException, PrivilegeException, InvalidUserException, StorageLimitException, java.io.IOException, InvalidFolderException
spec_ - The process report specification to add.folderId_ - The id of the folder in which to store the report.java.lang.IllegalArgumentException - if some attribute of spec_ is invalidPrivilegeException - if the current user is neither an editor nor
an administrator of the folderInvalidUserException - if the user calling this method is invalidStorageLimitException - if there is not enough space in the KC to create this report.java.io.IOException - if there is an error writing this reportInvalidFolderException - if folderId does not represent a valid folderProcessReport getTaskViewForUser(java.lang.String username_) throws java.lang.Exception
username_ - the user whose tasks are to be viewed.java.lang.ExceptionsetTaskViewForUser(java.lang.String, com.appiancorp.suiteapi.process.analytics2.ProcessReport)void setTaskViewForUser(java.lang.String username_,
ProcessReport spec_)
throws java.lang.Exception
username_ - the user whose tasks are to be viewed using this task view.spec_ - the task view.java.lang.ExceptiongetTaskViewForUser(java.lang.String)void removeTaskViewForUser(java.lang.String username_)
throws InvalidUserException,
PrivilegeException,
InvalidDocumentException
username_ - the user whose tasks were being viewed using this task view.InvalidUserException - if the user calling this method is invalidPrivilegeException - if the current user is neither an editor nor
an administrator of the folderInvalidDocumentException - if no valid task view can be found for this userProcessReport getTaskViewForGroup(java.lang.Long groupId_) throws java.lang.Exception
groupId_ - the id of the group whose tasks are to be viewed.java.lang.ExceptionsetTaskViewForGroup(java.lang.Long, com.appiancorp.suiteapi.process.analytics2.ProcessReport)void setTaskViewForGroup(java.lang.Long groupId_,
ProcessReport spec_)
throws java.lang.Exception
groupId_ - the id of the group whose tasks are to be viewed using this task view.spec_ - the task view.java.lang.ExceptiongetTaskViewForGroup(java.lang.Long)void removeTaskViewForGroup(java.lang.Long groupId_)
throws InvalidUserException,
PrivilegeException,
InvalidDocumentException
groupId_ - the id of the group whose tasks were being viewed using this task view.InvalidUserException - if the user calling this method is invalidPrivilegeException - if the current user is neither an editor nor
an administrator of the folderInvalidDocumentException - if no valid task view can be found for this groupjava.lang.String evaluateExpressionForProcessModel(java.lang.Long modelId_,
java.lang.String expression_,
boolean recursive_)
modelId_ - the id of the process model. this is the context.expression_ - a valid expression for the expression engine. PV references should be valid
for the model specified by the first parameter.recursive_ - true to evaluate process variables contained in sub processes (if the transparency
flag for each sub process is checked.PartialResult evaluateExpressionResultForProcessModel(java.lang.Long modelId_, java.lang.String expression_, boolean recursive_, NamedTypedValue[] continueParams)
modelId_ - the id of the process model. this is the context.expression_ - a valid expression for the expression engine. PV references should be valid
for the model specified by the first parameter.recursive_ - true to evaluate process variables contained in sub processes (if the transparency
flag for each sub process is checked.continueParams - whenever a PartialResult with a function request is returned, append the result
of the Java function evaluation to this list, and call this method again.java.lang.String evaluateExpressionForProcess(java.lang.Long processId_,
java.lang.String expression_,
boolean recursive_)
processId_ - the id of the process. this is the context.expression_ - a valid expression for the expression engine. PV references should be valid
for the process specified by the first parameter.recursive_ - true to evaluate process variables contained in sub processes (if the transparency
flag for each sub process is checked.PartialResult evaluateExpressionResultForProcess(java.lang.Long processId_, java.lang.String expression_, boolean recursive_, NamedTypedValue[] continueParams)
processId_ - the id of the process. this is the context.expression_ - a valid expression for the expression engine. PV references should be valid
for the process specified by the first parameter.recursive_ - true to evaluate process variables contained in sub processes (if the transparency
flag for each sub process is checked.continueParams - whenever a PartialResult with a function request is returned, append the result
of the Java function evaluation to this list, and call this method again.java.lang.String[] evaluateExpressionsForProcess(java.lang.Long processId_,
java.lang.String[] expressions_,
boolean recursive_)
processId_ - the id of the process. this is the context.expressions_ - valid expressions for the expression engine. PV references should be valid
for the process specified by the first parameter.recursive_ - true to evaluate process variables contained in sub processes (if the transparency
flag for each sub process is checked.PartialResult[] evaluateExpressionsResultForProcess(java.lang.Long processId_, java.lang.String[] expressions_, boolean recursive_, NamedTypedValue[][] continueParams)
processId_ - the id of the process. this is the context.expressions_ - valid expressions for the expression engine. PV references should be valid
for the process specified by the first parameter.recursive_ - true to evaluate process variables contained in sub processes (if the transparency
flag for each sub process is checked.continueParams - whenever a PartialResult with a function request is returned, append the result
of the Java function evaluation to this list, and call this method again.void setSiteLocaleSettings(SiteLocaleSettings settings_)
GlobalizationService.setSiteLocaleSettings(com.appiancorp.suiteapi.portal.SiteLocaleSettings) to register across all engines.settings_ - The site locale settings.void setTimeZone(BackendTimeZoneSimple tz)
GlobalizationService.setTimeZone(com.appiancorp.suiteapi.portal.BackendTimeZoneSimple) to set the time zone across all engines (rarely
required).tz - The specially formatted time zone object used by the enginesCopyright © 2003-2024 Appian Corporation. All Rights Reserved.