[year month day hour minute second timestamp] month and day are 1 indexed
Serialized advanced search filter predicate tree.
The nested array represent nested predicate trees with boolean operators. The structure of the tree mirrors the search component.
The top level array is a conjunction (AND) of its subtrees.
The second level array is a disjunction (OR) of the leaves.
The CategoryGeneratorMetadata is a leaf node of the predicate tree containing a single query generated by AbstractSearchPredicateComponent (and by extension by a Category).
This file is single point of truth for NAE frontend configuration schema.
Holds configuration of the task content async rendering properties.
The value represents the number of elements rendered in one rendering cycle
Provides the base filter of a SearchService
Contains a list of classes that represent the default case search categories.
The default search categories can be overridden by providing this injection token with a new set of categories in the AppComponent
.
Contains a list of classes that represent the default task search categories.
The default search categories can be overridden by providing this injection token with a new set of categories in the AppComponent
.
Used for providing any additional constraints to the filter case filtering, when user filters are loaded via the UserFiltersService.
The provided filter must be of type Case
as it is used for the filtering of cases representing saved user filters.
Provides access to the FilterField instance for dependency injection inside an AbstractFilterFieldComponent implementation.
Provides necessary data for the display of immediate filter fields on panels
Holds component for dynamic routing resolution of group navigation component resolver component by the RoutingBuilderService.
Whether invalid data values should be sent to backend or not. Invalid data is NOT set to backend by default. You can use this InjectionToken to override this behavior in a specific application scope.
This token is ultimately injected by individual data fields, so this option can be in theory applied at a very low level of granularity. The library implementation doesn't allow access to such low level components, so a custom implementation is necessary to provide this token at such low level. Applying the token to individual task views is achievable with the default implementation.
Holds a navigation item task data containing the aggregated data describing the navigation item
Can be used to provide case views with configuration of the {@link CaseViewService#createNewCase}[createNewCase()] method without having to extend the service and override the method.
Contains the search categories that can be used with the SearchComponent that injects them.
The search component is universal and the categories provided with this token are what determines what query objects are going to be constructed.
The token content with the type Array<Category<any>>
has been deprecated in 5.6.0 in favor of the new type Array<Type<Category<any>>>
but remains for backwards-compatibility.
Contains configuration of the SearchComponent that injects them.
The component can be also configured by component inputs.
Injection token for injection of InjectedTabData into tabs in TabView.
Also see TabContent for more information.
Case search request page size
An InjectionToken that can be used to enable/disable process delete confirmation dialog
An InjectionToken that can be used to set the process filter in workflow view
an array of items
an observable that emits each item from the array in order.
Sets milliseconds, seconds, minutes and hours of the provided Moment object to 0
object that we want to clear time information from
Configures the provided Category instance with the provided operator and operands.
the object that should be configured
must be the same OperatorService instance as the one provided to the category's constructor
the desired operator class, must be one of the available operators for the provided category
the desired operands
Creates a mock Case instance with the given attributes.
The attributes are filled with mostly empty values, if you want to make a test that uses some of them, we recommend setting them yourself, as the returned object might change between versions.
Creates a mock CaseEventOutcome with given case, net and outcomes attributes.
If attributes are not specified, default values are used.
Creates a mock DataGroup object instance containing the provided fields and having the provided configuration.
the DataFields contained in the data group
the optional title of the data group
alignment of the fields in non-full rows within the data group (affects flow and legacy layout)
the layout type of the data group
compacting rule for the data group
row hiding rule for the data group
whether the stretch
property of the data group is enabled or not
the number of columns of the data group layout
the ID of the parent task (if the data group is task-reffed)
the ID of the parent task ref (if the data group is task-reffed)
the nesting level of the data group (if the data group is task-reffed)
Creates a mock boolean or button field, with the specified properties
if true
the fields behavior is set to editable
, if false
the fields behavior is set to hidden
position of the field in the grid layout
if a string
is provided its value will be used as the fields ID.
If a number is provided the fields ID will be set to 'fnumber
argument,
but the counter will be used to generate the number.
determines what type of field should be generated.
Currently only boolean
, button
and task ref
fields are supported. If an unsupported field type is used an error is thrown.
determines the value of the task ref field if a task ref field is generated
Creates a mock ImmediateData instance with the given attributes.
The attributes are filled with mostly empty values, if you want to make a test that uses some of them, we recommend setting them yourself, as the returned object might change between versions.
Creates a mock Net instance with the given attributes.
The attributes are filled with mostly empty values, if you want to make a test that uses some of them, we recommend setting them yourself, as the returned object might change between versions.
the contents of the page
a mock Page object with the size equivalent to the number of elements provided in the attribute.
If the content is empty the content
attribute of the returned object is set to an empty object to mimic backend behavior.
Creates a mock PetriNetEventOutcome with given net and outcomes attributes.
If attributes are not specified, default values are used.
Creates a mock TaskEventOutcome with given changedFields, task, net, case and outcomes attributes.
If attributes are not specified, default values are used.
Creates a mock Task instance with the given attributes.
The attributes are filled with mostly empty values, if you want to make a test that uses some of them, we recommend setting them yourself, as the returned object might change between versions.
Creates a mock TaskEventOutcome with given task, net, case and outcomes attributes.
If attributes are not specified, default values are used.
Creates the configuration string for use with the [PAGE_SORT]{@link PaginationParams#PAGE_SORT} configuration attribute
the name of the attribute that should be used for sorting the results
the sorting direction
affected Task object
the reported Task event
success state of the reported event
TaskEventOutcome
the notification informing about the event
Creates the default case search categories.
Depends on CategoryFactory.
The created categories cannot be used to generate any predicates, as their inner state is preemptively destroyed to avoid memory leaks caused by uncompleted Subjects. They should only be used to create new Category instances with the help of the [duplicate()]{@link Category#duplicate} method.
an Array containing the default case search categories: CaseDataset, CaseTitle, CaseCreationDate, CaseProcess, CaseTask, CaseAuthor, CaseVisualId and CaseStringId
Creates the default task search categories.
Depends on CategoryFactory.
The created categories cannot be used to generate any predicates, as their inner state is preemptively destroyed to avoid memory leaks caused by uncompleted Subjects. They should only be used to create new Category instances with the help of the [duplicate()]{@link Category#duplicate} method.
an Array containing the default task search categories: TaskAssignee, TaskTask, TaskProcess and TaskRole
Unsubscribes the provided subscription, if it exists and is still opened
the subscription that should be destroyed
Extracts field value from data
value of extracted field
Extracts the filter field from the navigation item task data.
an array containing the data groups that correspond to a single navigation entry
The extracted FilterField or undefined
if it could not be extracted.
a SimpleFilter containing the filter stored in the provided FilterField. Throws an error if this is not possible.
Extracts the item name and item icon (if any) rom a section of the navigation item task data.
an array containing the data groups that correspond to a single navigation entry
is a service to translate label name
Based on provided parameter extracts allowed or banned roles into an Array of strings from a section of the navigation item task data. Each item has format ROLE_IMPORT_ID:NET_IMPORT_ID
an array containing the data groups that correspond to a single navigation entry
ID of field containing banned or allowed role IDs
an Array of string values representing role IDs
Extracts the selected search type from enumeration field of the navigation item task data.
a SearchMode containing SearchMode.ADVANCED or SearchMode.FULLTEXT or {@link undefined} if unexpected value is found
a collection of data fields
the id of the desired field
the index of the datafield with the specified id or -1
if such datafield could not be found
a list of searched data groups
the id of the desired field
an object containing the index of the data group and the field within it corresponding to the first occurrence of a
datafield with the specified id or undefined
if such datafield could not be found
Loads all pages from the given endpoint and returns their content as one array
the method that is used to load an individual page, it must support pagination parameters
the filter/query object that is used to specify the requested objects. The source
argument must accept this filter.
configuration of the initial pagination. Pages will be loaded from the provided page number onwards, page size will be upheld.
content of all pages from the given page onwards (or from the start if no pagination
argument was provided) as a single Array
name of the mock user value
if not the user is the special ME user option
id of the mock user value
Convenience method that can be used as an allowed nets factory for views that are loaded from filter process instances. It has a dependency on this class and NAE_NAVIGATION_ITEM_TASK_DATA injection token.
Creates search categories based on the metadata stored in the filter case
task data of a navigation item task, the data must contain a filter field, that is used to generate the categories
the default case search categories that should be merged with the categories provided by the filter field, if the filter metadata allow it and the filter is a case filter
the default task search categories that should be merged with the categories provided by the filter field, if the filter metadata allow it and the filter is a task filter
Converts an NAE_NAVIGATION_ITEM_TASK_DATA injection token into NAE_BASE_FILTER
a navigation item task containing the aggregated data representing a navigation item
This function is meant to work as a call to rxjs's of
function without any arguments
a void Observable, that calls next once and then completes
Transforms a MessageResource object into a stream containing either the message or an error if the message resource contains an error.
Can be used with rxjs' switchMap
process responses from backend.
a MessageResource object
Forces a re-render of the tree backed by the datasource
Convenience method that can be used as an allowed nets factory for tabbed task views. If no allowed nets are provided in the injected data then an AllowedNetsService with no allowed nets is created. It has a dependency on this class and NAE_TAB_DATA injection token.
Convenience method that can be used as a task view configuration object factory for tabbed task views.
If the injected tab data contain information that is included in the TaskViewConfiguration interface, this factory will forward this information into the provided object.
Generated using TypeDoc
The two nested arrays represent a predicate tree with 3 levels. The root node of the tree is a predicate consisting of a conjunction (AND) of its subtrees.
The single array represents a predicate tree with 2 levels. The root node of the tree is a predicate consisting of a disjunction (OR) of its subtrees.
The CategoryGeneratorMetadata represents a predicate tree with 1 level - a leaf node.