Operations in OData machine steps

List of different operations selectable in machine step; what do they mean and how they are identified. Refer to terminology section to what they mean.

Entities folder

Read -operation

Reading entityset is done using Read operation which is located directly under each entityset folder, example is how to read Active Work Orders (entityset ActiveSeparateSet).

Get by key -operation

Get by key operation if operation which requires entity key as only parameter. This operation does not return any reference entities, only attributes belonging to entity.

Get by key - Get one Company Employee

If the operation requires an ETag value in request header, for example when updating single Entity, the Get by key operation is the only Get operation that returns an ETag.

ETag

Insert, Update, Delete -operations

Generic operations for Create, Insert and Delete operations are located directly under each entity set folder.

<Entity>_Default (from set) -operation

Prior creating new entity user might benefit from getting default parameters to be used in Create operation.

Default values for creating new PartCatalog entity

The operation do not require any input parameters and returns a single record.

Batch Create Entity

Some entities may contain Batch Create <EntitySet> and add owned collections operation for creating single entity and reference entities in one call in flow. The example operation creates one Functional Equipment object and several reference entities in one call. These kind of operations are provided by the OData Connector and thus cannot be found from API Explorer.

In the machine step, provide required parameters for the new equipment and optional amount of reference entities.

Bound actions

Bound actions are actions that are linked to a certain entity and are located under the Entities folder. Bound actions can be generally be thought of as RMB operations executed in Aurena against an entity. For example changing status on a Work Order.

Cancel Work Order

Operation ActiveSeparate_Cancel (from entity) is called.

Example of active work order bound actions

Reference Entity CUD operations

Reference entity sets can be created, deleted or updated in the context of a certain entity. In the example; Add to Notes to Work Order.

Parameters require to identify the entity (Work Order no) to which the notes are added.

Parameters for Add to WorkOrderNotesArrst

Reference Entity Batch

Batch Add operation reduces the need to create a single entities loop in flow -> reduces execution time. These kind of operations are provided by OData Connector and thus cannot be found in the API Explorer.

Batch Add to DetailNotes

List of values related operations

Lookup LOV EntitySet

Each projection may or may not have operations prefixed with Lookup.

Lookup_IsoCountry operation

For example when you create new customer, the new Customer page in Aurena is initiated with a LOV of static list countries using Lookup_IsoCountry_EntitySet Read operation.

Reference LOV EntitySet

Projection may or may not include separate operations to fetch LOVs for references linked to entityset.

Reference operations are designed for Aurena pages to produce searchable LOVs.

Searching customer - Aurena page calls CustomerOrderHandling.svc/Reference_CustOrdCust6 operation to check user input

Reference LOV entity sets may contain default filtering compared to standard projections. For example the Reference LOV entity set may not contain entities that have a certain status (blocked); not allowed to use. When reading the same entities from a standard projection all records ,despite of status, are returned. Using Reference LOV entity sets can be beneficial since no additional LOV filtering in Flow is needed.

Reference may be static or dynamic:

• Static reference means that the IFS component is mandatory related to the entityset.

• Dynamic reference means that the IFS component is not mandatory related to the entityset.

Static Reference LOVs

Static reference LOVs refers to entities that originate from IFS components that are mandatory for the projection (EquipmentAllObjectsHandling). Depending on the reference entity business rule; filtering may be applied in Reference calls (company, site, organization..).

Reference LOVs for equipment

Dynamic Reference LOVs

Dynamic reference LOVs can be used if the IFS component, where reference entity originates from, is installed. Example DynReference_BankIdentifierCodeHrLov refers to entity BankIdentifierCode in component PAYLED. If PAYLED component is not installed, these LOVs cannot be used.

🛠️ WIP <EntitySet>Virtual

Actions/Functions folder

Unbound static actions/functions

Static actions and functions are various types of operations not linked to entity, e.g. the are no necessarily mandatory parameters to identity certain entity.

• 

  Static actions/function separated in folders
• Functions are read only operations.

• Action is an operation that change data in IFS.

Action to create service quotation

Function to get sales part info

Code -section

Code section allow developer to create C# code to call IFS APIs. See more from Missing operation and C# usage in the OData connector.

Code section

Custom Request

Custom request functionality allows developer to configure API call (in case of missing operation) instead of writing C# in Code section. Read more from here.