Skip to content

UI Page Converters#

A converter provides an effective way of transforming available fields on a UI Page widget into other types of values or value structures through the use of variable Links in UI Pages.

Converters allow you to retrieve a value that is available in the system and adapting it to a data structure that can be delivered to another widget for display or as an input for another operation you want to perform. In order to allow extra flexibility, a converter may additionally receive a parameter that can further help expand the conversion. This means that when you define a link with a converter, the value that the output variable will receive is returned by the converter.

Available Converters#

Converter Applicable Entity Description
anyToAnyProperty Generic Given an object and a property path returns the value.
anyToEmptyArray Generic Returns an empty array. Can be used to clear an input when necessary.
anyToNull Generic Returns null in order to clean other inputs when it receives something.
anyToObjectArray Generic Given an object, returns an array in which the first and only element is the supplied object.
anyToStringProperty Generic Given an object and a property path returns the value.
arrayLength Generic Returns a length of an array.
certificationEntityOwnerRole Generic Loads the entity OwnerRole and returns a Certification with the OwnerRole entity loaded.
checkOutEmployee Resource Allows to convert to the correct output form of service. It receives the employee on the value property and the resource on the arguments and builds a map for each one of it
checkOutEmployeeFromResources Resource Allows to convert to the correct output form of service. It receives the resources array on the value property and the current Employee on the arguments and builds a map for each one of it.
deepCloneOnSuccess Generic Allows to emit a new copy of an entity (input by parameter) when a transaction finishes.
entityAdditionalInfo Generic Allows creating additional info of an entity. The additional info is based on the returned badges of the entityTileCreator function of entities. Used in the UI page header.
entityEmployeeArray Generic Creates an array of Employees from a EmployeeCertification array.
entityEmployeeCertification Generic Loads the entity OwnerRole and returns a EmployeeCertification with the OwnerRole entity loaded.
entityName Generic Allows to build a name for entities based in their current state.
entitySubtitle Generic Allows to build a subtitle for entities based in their current state.
evaluateWorkflow ChangeSet Evaluates if the ChangeSet has a workflow and if its current state is final (true) or not (false).
filterChangeSets ChangeSet Filters the ChangeSets.
filterCollectionSearchTerm ChangeSet Converts the filter collection to a search term (string).
filtersToRemoveFromNonScheduling Generic Allows the user to remove filters from the filter bar whenever the input value is Scheduling.
filtersToRemoveFromNonSchedulingStep Generic Allows the user to remove filters from the filter bar whenever the input value is false.
filterValue Generic Gets the value of a the filter given a filter collection and property name.
formatRecipeParameters Material Converts recipe parameters' value according to service FormatParameterValue.
GUIElementDefaultValue Material Used for Material Split operation. Get a default value from the GUI Default Values generic table. value holds the data of the generic table, args[0] is the key to get the default value. Example: copyFutureHolds = true will force the value in the GUI to be true.
instanceToEntityTypeName Generic Given an entity, the converter returns the Entity Type Name in a string.
isDefined Generic Checks if the input value is defined.
isEqual Generic Check if the value and the supplied parameter are strictly equal.
isFalse Generic Checks if the input value is false.
isNotDefined Generic Checks if the input value is defined.
isNotNull Generic Given an object, if not null returns true.
isNullOrEmpty Generic Checks if a list is null or empty and returns a boolean according to the result.
isPositive Generic Checks if the input value is a number and if its value is positive.
isTrue Generic Checks if the input value is true or not.
loadEntities Generic Loads all entities of an array by its id. (Parameter: levels to load).
loadEntity Generic Loads a given entity by its id. (Parameter: levels to load).
loadEntityAttributes Generic Loads a given entity attributes and custom properties.
loadEntityForEntityUIPage Generic Loads a given entity by its id given the passed UIPage entity type. (Parameter: levels to load).
loadObjectByName Generic Loads a given entity by its name. Parameter: levels to load (default is 0).
maintenanceActivityToRequestMaintenanceActivityOrderInput Maintenance Converts and array of MaintenanceActivities in to an array of RequestMaintenanceActivityOrderInput.
mapToArray Generic Places all elements of a given map into an array.
mapValueOfArray Generic Given a map sets the given key with the value given.
materialHoldReasonName Material According to any given Material Hold Reason, this converter will find the name, description of the Reason and a special field to show the desired information to be displayed on the column view widget.
materialHoldReasonRoleDisable Material According to any given Material Hold Reason, this converter will return a boolean to set if the role reason field is disabled or not.
materialHoldReasonsMerge Material According to any given Material Hold Reason, this converter will show the appropriated icon according to the Release Code and Release Role definition on the column view widget.
materialHoldReasonValue Material According to any given Material Hold Reason, this converter will show the appropriated icon according to the Release Code and Release Role definition on the column view widget.
materialMergeDuplicate Material Mainly used within the "MaterialsMerge" (fabExplorer/).
materialMergefabExpDuplicate Material Mainly used within the "MaterialsMerge" (fabExplorer/).
materialMergefabExpFinalQuan Material Mainly used within the "Final quantity" field of the filter widget for the Merge Wizard (fabExplorer/).
materialMergefabExpHasSubMaterial Material Checks if Material has SubMaterials.
materialMergeFinalQuan Material Converts the final quantity of materials selection (Merge Material wizard).
materialMergeHasContainer Material Checks if Material is associated to a Container.
materialMergeHasSubMaterial Material Checks if Material has SubMaterial.
materialMergeHeaderInstance Material Mainly used within the "MaterialsMerge" (fabExplorer/).
materialMergeInput Material Converts the Materials for merge an specific data set (MergeInput).
materialMergeTitle Material Gets title description.
materialRecordLoss Material Prepare data for the Record Loss operation. It uses a map with the Material and Loss Bonus Affected Quantity Collection.
materialRecordLossBonusStepValid Material Verify if the given step is valid for the record loss bonus operation. The step must have Step Reasons of type Loss applicable to Record Loss and/or Reasons of type Bonus to be valid.
materialRecordLossSetStepIfNot Material Set step in Material if a condition is met.
materialSplitFooter Material Used on Split Material wizard. Used to show correctly to the user the remaining primary and secondary quantities. Used in the footer of the column view and shown in red if negative (negative values are not allowed).
materialSplitHeaderInstance Material Used on Split Material wizard. On the instance info of the wizard we want the quantity with units associated.
materialSplitInput Material Set the input object for the Material split operation.
materialSplitIsPropertyBiggerThanZero Material Verify if a given property of a given object is bigger than 0.
materialSplitMode Material User in split wizard. The converter return settings about the split mode.
materialSplitName Material Used in the widget in the Split Material wizard. It return the name of the return leaf of the column view widget.
materialSplitNewMaterialName Material Used in the widget in the Split Material wizard. It return the name (with the number of SubMaterials in brackets) of the returned leaf of the column view widget.
materialSplitNewMaterialStepValid Material Used in the split wizard. The total remaining quantities must be positive.
materialSplitSetFirstMaterial Material Returns a default new Material for the Split wizard.
materialSplitShowSubMaterialContainerStep Material Used in Split wizard. Returns true if the Material has SubMaterials, false otherwise. Used to show or hide steps of the wizard.
materialSplitTransfer Material Used for the transfer Widget in the Split Material wizard. It sets the Material Container of the SubMaterials based on the default SubMaterial chosen in the first step.
materialSplitTransferData Material Used for the transfer Widget in the Split Material wizard.
materialSplitValue Material Used in the dynamic split wizard. Formats the value of the quantities to show in the column view leaf. Negative quantities are shown in red.
materialStepPropertyCheck Material Evaluates a property of the step material in an array of Materials.
nand Generic Produces an output which is false when all its inputs are true.
ngpDataSetToObjectArray Generic Given an NgpDataSet returns an array of objects.
nullOr Generic This converter is used in the OEE, Process KPI and Resource KPI UI Pages. If the value or the received parameter is different than null, it will return the value (OR operation).
nullToEmptyString Generic Given an object, returns an empty string if the object is null otherwise return the object.
nullWhenParamsNull Generic This converter is used in the OEE, Process KPI and Resource KPI UI Pages. It simply returns null to the next data source in case the received parameter is null as well. This will force the Query data source to refresh its query present all its results once again.
openProtocolIsToSelectProtocol Protocol Given a Protocol, check if it is null in order to ask for one in Open Protocol Instance wizard.
paramToOutput Generic This converter allows to emit a new copy of an args (input by parameter) when a transaction finishes.
plannedUnplannedInfoResource Generic Allows to set the planned and unplanned count in the target Resource.
plannedUnplannedInfoStep Generic This converter allows to create additional info of an entity. The additional info is based on the returned badges of the entityTileCreator function of entities. Used in the UI page header.
productionOrdersRemoveNotWantedFilters ProductionOrder This converter is used on Production Orders page at Planning and Logistics. Since the filters for PlannedEndDate and DueDate are only to show colors on the background, then when the user chooses some of this dates, the filter collection shouldn't have this information. So, instead of sending them to the query data source, they are removed and a refresh is forced whenever a change is made.
productionOrdersSetDateProperties ProductionOrder This converter is used on Production Orders page at Planning and Logistics. When the user selects a date filter, its necessary to update a page property to later be passed to other converter that will add some properties for each of the Production Orders.
productionOrdersSetTemplateProperties ProductionOrder This converter is used on Production Orders page at Planning and Logistics. He injects four properties on each of the production orders. This is necessary since its needed a custom template made with kendo. That means that angular pipes are not available. So, for due date and planned end date, the calculated TimeDate is added and the color according to the filter passed on the arguments.
protocolInstanceFilterCollectionSetCurrentEmployee Protocol Given an object sets the current Employee value as object on the target.
protocolInstanceFilterCollectionSetStateModelState Protocol Given an array of Protocol Path returns the array with new property StateName.
queryToObjectArray Generic Given a query object returns an array of objects, based on the output of the query.
relationToEntity Generic Converter to extract the source or target of a given relation. Works with collections as well.
removeCurrentScheduleJobFilterIfFalse Generic This converter removes the currentScheduleJob filter whenever it has the value false. Thus, this filter will not be part of the filterCollection that is sent to the service afterwards.
selectedItemsToText Generic Given an Array will output a number of selected items string based on it's length. If the array is empty or null it will display an empty string unless a converter parameter is passed in that case its content is returned instead.
setAreaIdFromStepList Generic This converter is meant to be used in "My Workgroup". When a step is selected, its necessary to retrieve the areaId from the original list. This converter finds the id from selected step in the list (provided in args) and returns it if found, otherwise will return null.
setEntityName Generic Given an entityName, get the respective translation.
setIfAllPropertiesEqual Generic Given an object check if all properties are equal and if they are returns their value.
setInArray Generic Converter to set a value in an array. As an optional key, the array index (parsable to integer) may be provided. In not, the value is pushed to the end of the array.
setInFIFO Generic Converter to set a value in a FIFO with a maximum size of elements.
setMapValue Generic Given a map sets the given key with the value given.
setMaterialsForStep Generic Specifically done for fabExplorer. It removes the submaterials of a list of Materials and calculates the total quantity for each one.
setPropertyOf Generic Given an object sets the given path value as object on the target.
setupProtocolInstancesData Protocol Given an DateTime, calculates the time difference between current date (now) and the given DateTime.
sort Generic This converter allows to sort any array. Important note for the args: The argument is a string that will say which attribute will be used to filter and it's sort type separated by ,. Example: name:ASC,id:desc the argument will sort the array firstly by name in ascendent order and then by id in descendent order.
stepsAndResourcesToMatrix Generic Allows StepResourcesForAreaCollection to be used by Tiles Matrix.
stringToBoolean Generic Converts a string into a boolean. Returns false if the string doesn't represent a valid boolean value.
stringToInteger Generic Converts a string into an integer. Returns NaN if the string doesn't represent a valid integer.
workgroupEntityName Generic Allows to return the name of a entity - with the prefix Resource or Step.
workgroupEntityState Generic Allows to return the current main state name of a entity - in brackets.

Table: Available UI Page Converters