FME Transformers: 2025.2
TrimbleUnityConnector
Connects to Trimble Unity or Cityworks to manage cases, inspections, service requests, and work orders.
Typical Uses
- Managing cases, inspections, service requests, and work orders
How does it work?
The TrimbleUnityConnector uses your credentials to connect to a Trimble Unity instance or on-premise Cityworks instance to perform management tasks for various Service Types:
|
Service Type |
Action | Task |
|---|---|---|
|
Case
|
Add Task |
Add a case task to the existing case workflow. |
|
Create Case |
Create a new case. This can be created as a standalone object, or linked to a case or service request. |
|
|
Delete Task |
Delete a case task from the selected case. |
|
|
List Cases |
List cases matching the filter criteria.
|
|
|
List Tasks |
List all case tasks in the selected case’s workflow. |
|
|
Update Task |
Update a case task in the selected case’s workflow. |
|
|
Inspection
|
Cancel |
Cancel the selected inspection object. |
|
Close |
Close the selected inspection object. |
|
|
Create |
Create an instance of the selected inspection object. These can be created as standalone objects, or linked to an existing object. |
|
|
Delete |
Delete the selected inspection object. |
|
|
List |
List instances of selected inspection either by using filter criteria or by selecting another object to list related types for. |
|
|
Update |
Update metadata for the selected inspection object. |
|
|
Service Request
|
Cancel |
Cancel the selected service request object. |
|
Close |
Close the selected service request object. |
|
|
Create |
Create an instance of the selected service request object. These can be created as standalone objects, or linked to an existing object. |
|
|
Delete |
Delete the selected service request object. |
|
|
List |
List instances of selected service request either by using filter criteria or by selecting another object to list related types for. |
|
|
Update |
Update metadata for the selected service request object. |
|
|
Work Order
|
Add Attachment |
Add an attachment to a work order. |
|
Add Costs |
Add a material, equipment, employee, or contractor cost to a work order. |
|
|
Cancel |
Cancel the selected work order object. |
|
|
Close |
Close the selected work order object. |
|
|
Create |
Create an instance of the selected work order object. These can be created as standalone objects, or linked to an existing object. |
|
|
Delete |
Delete the selected work order object. |
|
|
List |
List instances of selected work order either by using filter criteria or by selecting another object to list related types for. |
|
|
Update |
Update metadata for the selected work order object. |
Optional Input Port
This transformer has two modes, depending on whether a connector is attached to the Input port or not:
- Input-driven: When input features are connected, the transformer runs once for each feature it receives in the Input port.
- Run Once: When no input features are connected, the transformer runs one time.
When the Input port is in use, the Initiator output port is also enabled.
Usage Notes
-
If datetime values are provided without timezones, this transformer will treat them as though they were provided in UTC.
Configuration
Input Ports
This transformer accepts any feature.
Output Ports
Features with added attributes, as specified in parameters and according to Action:
| Action | Output - Input-Driven | Output - Run Once |
|---|---|---|
|
Add Attachment |
Input feature with details about the attachment added. |
New feature with details about the attachment added. |
|
Add Costs |
Input feature with details about the cost added. |
New feature with details about the cost added. |
|
Add Task |
Input feature with metadata details about the created case task. |
New feature with metadata details about the created case task. |
|
Cancel |
Input feature with details about the cancellation operation. |
New feature with details about the cancellation operation. |
|
Close |
Input feature with details about the close operation. |
New feature with details about the close operation. |
|
Create |
Input feature with metadata details about the created entities. |
New feature with metadata details about the created entities. |
|
Create Case |
Input feature with metadata details about the created case. |
New feature with metadata details about the created case. |
|
Delete |
Input feature with details about the delete operation. |
New feature with details about the delete operation. |
|
Delete Task |
Input feature with details about the delete operation. |
New feature with details about the delete operation. |
|
List |
Multiple features, one for each item which matches the selected criteria, with metadata details about the items. |
Multiple new features, one for each item which matches the selected criteria, with metadata details about the items. |
|
List Cases |
Multiple features, one for each case which matches the selected criteria, with metadata details about the cases. |
Multiple new features, one for each case which matches the selected criteria, with metadata details about the cases. |
|
List Tasks |
Multiple features, one for each case task associated with the case, with metadata details about the case task. |
Multiple new features, one for each case task associated with the case, with metadata details about the case task. |
|
Update |
Input feature with metadata details about the updated item. |
New feature with metadata details about the updated item. |
|
Update Task |
Input feature with metadata details about the updated case task. |
New feature with metadata details about the updated case task. |
When the optional Input port is used, input features are output here unmodified, in addition to any other output locations (Output or <Rejected>).
Features that cause the operation to fail are output through this port. An fme_rejection_code attribute describing the category of the error will be added, along with a more descriptive fme_rejection_message which contains more specific details as to the reason for the failure.
If an Input feature already has a value for fme_rejection_code, this value will be removed.
Rejected Feature Handling: can be set to either terminate the translation or continue running when it encounters a rejected feature. This setting is available both as a default FME option and as a workspace parameter.
Parameters
|
Connection |
Select or create a Web Connection, connecting to the Trimble Unity TokenWeb Service. For new Trimble Unity instances , Authorization Header should be set to bearer. |
|
Service Type |
Select a service type to perform actions on. Choices include:
|
|
Action |
Select an operation to perform. Choices include: Service Type > Case
Service Type > Inspection
Service Type > Service Request
Service Type > Work Order
|
Service Type > Case
Filter Cases
Filtering refines the cases shown when selecting a Case Object.
|
Case Type Group |
Specify the case type group to include. If blank, only case types with no associated group will be included. |
|
Case Type |
Specify the case type to include. Available case types are determined by Case Type Group. |
|
Created After |
(Optional) Include only cases created on or after this UTC date. |
|
Created Before |
(Optional) Include only cases created before or on this UTC date. |
Create Options
|
Case Object |
Select a case object to add the task to. Filter Cases will refine the available cases shown. |
|
Start Milestone |
Specify the task's workflow start milestone. |
|
End Milestone |
Specify the task's workflow end milestone. |
|
Task |
Specify the case task type ID. |
Additional Parameters
This table specifies any custom parameters to add to the API call.
Each entry consists of an API Parameter Name and Parameter Value.
|
API Parameter Name |
Specify the name of the parameter as it is expected to appear in the API call. |
|
Parameter Value |
Provide a value. Numeric values will be parsed as numbers. JSON input is supported. All other input will be treated as a string. |
Output Attributes
|
Attributes to Add |
Select any available attributes to be included on the output features:
|
Filter Cases
Filtering refines the cases shown when selecting a Case Object.
|
Case Type Group |
Specify the case type group to include. If blank, only case types with no associated group will be included. |
|
Case Type |
Specify the case type to include. Available case types are determined by Case Type Group. |
|
Created After |
(Optional) Include only cases created on or after this UTC date. |
|
Created Before |
(Optional) Include only cases created before or on this UTC date. |
Create Options
|
Create Case From |
(Optional) Select the type of object to create a case from:
|
|
Case Object |
When Create Case From is Case, select a case object. |
|
Service Request |
When Create Case From is Service Request, select a service request. |
|
Case Type Group |
When Create Case From is undefined or Service Request, select the group for the new case. |
|
Case Type |
When Create Case From is undefined or Service Request, select the type for the new case. If the type requires a subtype, provide it in Additional Parameters using API Parameter Name SubTypeId. |
|
Case Name |
(Optional) Provide a name for the new case. |
|
Location |
(Optional) Provide a location for the new case. |
Additional Parameters
This table specifies any custom parameters to add to the API call.
Each entry consists of an API Parameter Name and Parameter Value.
|
API Parameter Name |
Specify the name of the parameter as it is expected to appear in the API call. |
|
Parameter Value |
Provide a value. Numeric values will be parsed as numbers. JSON input is supported. All other input will be treated as a string. |
Output Attributes
|
Attributes to Add |
Select any available attributes to be included on the output features:
|
Filter Cases
Filtering refines the cases shown when selecting a Case Object.
|
Case Type Group |
Specify the case type group to include. If blank, only case types with no associated group will be included. |
|
Case Type |
Specify the case type to include. Available case types are determined by Case Type Group. |
|
Created After |
(Optional) Include only cases created on or after this UTC date. |
|
Created Before |
(Optional) Include only cases created before or on this UTC date. |
Case Task
|
Case Object |
Select the task's case object. |
|
Show Available Tasks Only |
Select which tasks to select the Case Task from:
|
|
Case Task |
Select the case task to delete. |
List Options
Cases must match all of the parameters specified.
If multiple values are provided for a particular parameter, the case only needs to match one value.
|
Case Type Group |
Specify the case type group to include. If blank, only case types with no associated group will be included. |
|
Case Type |
Select one or more case types to include. |
|
Case Type Description |
(Optional) Provide a string which appears in the case type description. |
|
Case Name |
(Optional) Provide a string which appears in the case name. |
|
Subtype |
(Optional) Select one or more subtypes to include. |
|
Subtype Description |
(Optional) Provide a string which appears in the subtype description. |
|
Case Number |
(Optional) Provide a string which appears in the case number. |
|
Location |
(Optional) Provide a string which appears in the location. |
|
Created After |
(Optional) Include only cases created on or after this UTC date. |
|
Created Before |
(Optional) Include only cases created before or on this UTC date. |
Output Attributes
|
Attributes to Add |
Select any available attributes to be included on the output features:
|
Filter Cases
Filtering refines the cases shown when selecting a Case Object.
|
Case Type Group |
Specify the case type group to include. If blank, only case types with no associated group will be included. |
|
Case Type |
Specify the case type to include. Available case types are determined by Case Type Group. |
|
Created After |
(Optional) Include only cases created on or after this UTC date. |
|
Created Before |
(Optional) Include only cases created before or on this UTC date. |
List Options
|
Case Object |
Select the case object to list the tasks of. |
Output Attributes
|
Attributes to Add |
Select any available attributes to be included on the output features:
|
Filter Cases
Filtering refines the cases shown when selecting a Case Object.
|
Case Type Group |
Specify the case type group to include. If blank, only case types with no associated group will be included. |
|
Case Type |
Specify the case type to include. Available case types are determined by Case Type Group. |
|
Created After |
(Optional) Include only cases created on or after this UTC date. |
|
Created Before |
(Optional) Include only cases created before or on this UTC date. |
Case Task
Only parameters with a value specified will be updated.
|
Case Object |
Select a case object to add the task to. Filter Cases will refine the available cases shown. |
|
Show Available Tasks Only |
Select which tasks to select the Case Task from:
|
|
Case Task |
Select the case task to update. |
|
Location Notes |
(Optional) Provide location notes. |
|
Target Start Date |
(Optional) Provide a UTC target start date. |
|
Target End Date |
(Optional) Provide a UTC target end date. |
|
Actual Start Date |
(Optional) Provide a UTC actual start date. |
|
Actual End Date |
(Optional) Provide a UTC actual end date. |
|
Completed Date |
(Optional) Provide a UTC completed date. |
|
Task Result |
(Optional) Provide a task result. |
Additional Parameters
This table specifies any custom parameters to add to the API call.
Each entry consists of an API Parameter Name and Parameter Value.
|
API Parameter Name |
Specify the name of the parameter as it is expected to appear in the API call. |
|
Parameter Value |
Provide a value. Numeric values will be parsed as numbers. JSON input is supported. All other input will be treated as a string. |
Output Attributes
|
Attributes to Add |
Select any available attributes to be included on the output features:
|
Service Type > Inspection
Filter Inspections
Filtering refines the inspections shown when selecting an Inspection.
|
Domain |
Specify the inspection template domain to include. |
|
Template |
Specify the inspection template or inspection type to include. |
|
Hide Closed |
Select which inspections to include:
|
|
Hide Canceled |
Select which inspections to include:
|
|
Inspected After |
(Optional) Include only inspections created on or after this UTC date. |
|
Inspected Before |
(Optional) Include only inspections created before or on this UTC date. |
Inspection
|
Inspection |
Select the inspection to cancel. |
Filter Inspections
Filtering refines the inspections shown when selecting an Inspection.
|
Domain |
Specify the inspection template domain to include. |
|
Template |
Specify the inspection template or inspection type to include. |
|
Hide Closed |
Select which inspections to include:
|
|
Hide Canceled |
Select which inspections to include:
|
|
Inspected After |
(Optional) Include only inspections created on or after this UTC date. |
|
Inspected Before |
(Optional) Include only inspections created before or on this UTC date. |
Inspection
|
Inspection |
Select the inspection to close. |
Create Options
|
Create Inspection From |
(Optional) Select the type of object to create an inspection from:
|
|
Case Object |
When Create Inspection From is Case, select a case object. |
|
Service Request |
When Create Inspection From is Service Request, select a service request. |
|
Inspection |
When Create Inspection From is Inspection, select an inspection. |
|
Work Order |
When Create Inspection From is Work Order, select a work order. |
|
Inspection Domain |
(Optional) Provide a domain for the new inspection. |
|
Template ID |
Specify the inspection type or template to use for the new inspection. |
|
Entity Type |
Specify the entity type. |
|
Address |
(Optional) Provide an address to associate with the inspection. |
|
Geocode Address |
When Address is specified, select a geocoding option:
|
|
District |
(Optional) Provide a district to associate with the inspection. |
|
Priority |
(Optional) Assign a priority to the inspection. |
|
Submit to SID |
(Optional) Designate the person the inspection is submitted to If Submit to Crew SID is specified, Submit to SID will automatically be set to the leader of that crew. |
Additional Parameters
This table specifies any custom parameters to add to the API call.
Each entry consists of an API Parameter Name and Parameter Value.
|
API Parameter Name |
Specify the name of the parameter as it is expected to appear in the API call. |
|
Parameter Value |
Provide a value. Numeric values will be parsed as numbers. JSON input is supported. All other input will be treated as a string. |
Output Attributes
|
Attributes to Add |
Select any available attributes to be included on the output features:
|
Filter Inspections
Filtering refines the inspections shown when selecting an Inspection.
|
Domain |
Specify the inspection template domain to include. |
|
Template |
Specify the inspection template or inspection type to include. |
|
Hide Closed |
Select which inspections to include:
|
|
Hide Canceled |
Select which inspections to include:
|
|
Inspected After |
(Optional) Include only inspections created on or after this UTC date. |
|
Inspected Before |
(Optional) Include only inspections created before or on this UTC date. |
Inspection
|
Inspection |
Select the inspection to delete. |
List Options
|
List Inspections By |
Select the method used to list inspections. Note that available filters vary according to this selection.
|
||||||||||||||||||||||||||||||||||||||||||||
|
Inspection |
When List Inspections By is Inspection, select an inspection. |
||||||||||||||||||||||||||||||||||||||||||||
|
Service Request |
When List Inspections By is Service Request, select a service request. |
||||||||||||||||||||||||||||||||||||||||||||
|
Work Order |
When List Inspections By is Work Order, select a work order. |
||||||||||||||||||||||||||||||||||||||||||||
|
Inspection Domain |
(Optional) When List Inspections By is Filter, select a domain. |
||||||||||||||||||||||||||||||||||||||||||||
|
Template IDs |
(Optional) When List Inspections By is Filter, select one or more inspection types or templates. |
||||||||||||||||||||||||||||||||||||||||||||
|
Statuses |
(Optional) When List Inspections By is Filter, select one or more statuses. |
||||||||||||||||||||||||||||||||||||||||||||
|
Submit To SIDs |
(Optional) When List Inspections By is Filter, select one or more people who the listed inspections should have been submitted to. |
||||||||||||||||||||||||||||||||||||||||||||
|
Submit To Crew SIDs |
(Optional) When List Inspections By is Filter, select one or more crews that the listed inspections should have been submitted to. |
||||||||||||||||||||||||||||||||||||||||||||
|
Inspected by SIDs |
(Optional) When List Inspections By is Filter, select one or more people who the listed inspections should have been inspected by. |
||||||||||||||||||||||||||||||||||||||||||||
|
Inspected After |
(Optional) When List Inspections By is Filter, include only inspections created on or after this UTC date. |
||||||||||||||||||||||||||||||||||||||||||||
|
Inspected Before |
(Optional) When List Inspections By is Filter, include only inspections created before or on this UTC date. |
||||||||||||||||||||||||||||||||||||||||||||
|
Priorities |
(Optional) When List Inspections By is Filter, select one or more priorities. |
Output Attributes
|
Attributes to Add |
Select any available attributes to be included on the output features:
|
Filter Inspections
Filtering refines the inspections shown when selecting an Inspection.
|
Domain |
Specify the inspection template domain to include. |
|
Template |
Specify the inspection template or inspection type to include. |
|
Hide Closed |
Select which inspections to include:
|
|
Hide Canceled |
Select which inspections to include:
|
|
Inspected After |
(Optional) Include only inspections created on or after this UTC date. |
|
Inspected Before |
(Optional) Include only inspections created before or on this UTC date. |
Inspection
Only parameters with a value specified will be updated.
|
Inspection |
Select the inspection to update. |
|
District |
(Optional) Provide a district. |
|
Priority |
(Optional) Provide a priority. |
|
Status |
(Optional) Provide a status. Note that statuses which require a special workflow should not be modified through Update. |
|
Resolution |
(Optional) Provide a resolution. |
|
Submit to Crew SID |
(Optional) Specify a crew the inspection is submitted to. If Submit to Crew SID is specified, Submit to SID will automatically be set to the leader of that crew. |
|
Submit to SID |
(Optional) Specify the person the inspection is submitted to. |
Additional Parameters
This table specifies any custom parameters to add to the API call.
Each entry consists of an API Parameter Name and Parameter Value.
|
API Parameter Name |
Specify the name of the parameter as it is expected to appear in the API call. |
|
Parameter Value |
Provide a value. Numeric values will be parsed as numbers. JSON input is supported. All other input will be treated as a string. |
Output Attributes
|
Attributes to Add |
Select any available attributes to be included on the output features:
|
Service Type > Service Request
Filter Service Requests
Filtering refines the items shown when selecting a Service Request.
|
Domain |
Specify the domain to include. |
|
Problem |
Specify the problem or request type to include. |
|
Hide Closed |
Select which service requests to include:
|
|
Hide Canceled |
Select which service requests to include:
|
|
Initiated After |
(Optional) Include only service requests initiated on or after this UTC date. |
|
Initiated Before |
(Optional) Include only service requests initiated before or on this UTC date. |
Service Request
|
Service Request |
Select the service request to cancel. |
Filter Service Requests
Filtering refines the items shown when selecting a Service Request.
|
Domain |
Specify the domain to include. |
|
Problem |
Specify the problem or request type to include. |
|
Hide Closed |
Select which service requests to include:
|
|
Hide Canceled |
Select which service requests to include:
|
|
Initiated After |
(Optional) Include only service requests initiated on or after this UTC date. |
|
Initiated Before |
(Optional) Include only service requests initiated before or on this UTC date. |
Service Request
|
Service Request |
Select the service request to close. |
Create Options
|
Service Request Domain |
(Optional) Specify a domain for the new service request. |
|
Problem SID |
Select the service request type or problem SID for the new request. |
|
Address |
(Optional) Provide an address to associate with the service request. |
|
Geocode Address |
When Address is specified, select a geocoding option:
|
|
Details |
(Optional) Provide details on the service request. |
|
Priority |
(Optional) Assign a priority to the service request. |
|
Status |
(Optional) Assign a status to the service request. Statuses which require a special workflow should not be set through Create. |
|
Submit to SID |
(Optional) Designate the person the service request is submitted to. |
|
Dispatch to SID |
(Optional) Designate the person the service request is dispatched to. |
|
Work Order Needed |
Specify whether a corresponding work order is needed for the new service request:
|
Additional Parameters
This table specifies any custom parameters to add to the API call.
Each entry consists of an API Parameter Name and Parameter Value.
|
API Parameter Name |
Specify the name of the parameter as it is expected to appear in the API call. |
|
Parameter Value |
Provide a value. Numeric values will be parsed as numbers. JSON input is supported. All other input will be treated as a string. |
Output Attributes
|
Attributes to Add |
Select any available attributes to be included on the output features:
|
Filter Service Requests
Filtering refines the items shown when selecting a Service Request.
|
Domain |
Specify the domain to include. |
|
Problem |
Specify the problem or request type to include. |
|
Hide Closed |
Select which service requests to include:
|
|
Hide Canceled |
Select which service requests to include:
|
|
Initiated After |
(Optional) Include only service requests initiated on or after this UTC date. |
|
Initiated Before |
(Optional) Include only service requests initiated before or on this UTC date. |
Service Request
|
Service Request |
Select the service request to delete. |
List Options
|
List Service Request By |
Select the method used to list service requests. Note that available filters vary according to this selection.
|
||||||||||||||||||||||||||||||
|
Inspection |
When List Service Request By is Inspection, select an inspection. |
||||||||||||||||||||||||||||||
|
Work Order |
When List Service Request By is Work Order, select a work order. |
||||||||||||||||||||||||||||||
|
Domain |
(Optional) When List Service Request By is Filter, select a domain. |
||||||||||||||||||||||||||||||
|
Problem SIDs |
(Optional) When List Service Request By is Filter, select one or more service request types or problem SIDs. |
||||||||||||||||||||||||||||||
|
Categories |
(Optional) When List Service Request By is Filter, select one or more categories. |
||||||||||||||||||||||||||||||
|
Submit To SIDs |
(Optional) When List Service Request By is Filter, select one or more people who the listed service requests should have been submitted to. |
||||||||||||||||||||||||||||||
|
Dispatch to SIDs |
(Optional) When List Service Request By is Filter, select one or more people who the listed service requests should have been dispatched to. |
||||||||||||||||||||||||||||||
|
Statuses |
(Optional) When List Service Request By is Filter, select one or more statuses. |
||||||||||||||||||||||||||||||
|
Address |
(Optional) When List Service Request By is Filter, specify a substring which appears in the address. |
||||||||||||||||||||||||||||||
|
Initiated After |
(Optional) When List Service Request By is Filter, include only service requests initiated on or after this UTC date. |
||||||||||||||||||||||||||||||
|
Initiated Before |
(Optional) When List Service Request By is Filter, include only service requests initiated before or on this UTC date. |
Output Attributes
|
Attributes to Add |
Select any available attributes to be included on the output features:
|
Filter Service Requests
Filtering refines the items shown when selecting a Service Request.
|
Domain |
Specify the domain to include. |
|
Problem |
Specify the problem or request type to include. |
|
Hide Closed |
Select which service requests to include:
|
|
Hide Canceled |
Select which service requests to include:
|
|
Initiated After |
(Optional) Include only service requests initiated on or after this UTC date. |
|
Initiated Before |
(Optional) Include only service requests initiated before or on this UTC date. |
Service Request
Only parameters with a value specified will be updated.
|
Service Request |
Select the service request to update. |
|
Address |
(Optional) Provide an address. |
|
Details |
(Optional) Provide details on the service request. |
|
Priority |
(Optional) Provide a priority for the service request. |
|
Status |
(Optional) Provide a status for the service request. Statuses which require a special workflow should not be modified through Update. |
|
Submit to SID |
(Optional) Designate the person the service request is submitted to. |
|
Dispatch to SID |
(Optional) Designate the person the service request is dispatched to. |
|
Work Order Needed |
Specify whether a corresponding work order is needed for the service request:
|
Additional Parameters
This table specifies any custom parameters to add to the API call.
Each entry consists of an API Parameter Name and Parameter Value.
|
API Parameter Name |
Specify the name of the parameter as it is expected to appear in the API call. |
|
Parameter Value |
Provide a value. Numeric values will be parsed as numbers. JSON input is supported. All other input will be treated as a string. |
Output Attributes
|
Attributes to Add |
Select any available attributes to be included on the output features:
|
Service Type > Work Orders
Filter Work Orders
Filtering refines the items shown when selecting a Work Order.
|
Domain |
Specify the domain to include. |
|
Entity Type |
Specify the entity type to include. |
|
Hide Closed |
Select which work orders to include:
|
|
Hide Canceled |
Select which work orders to include:
|
|
Initiated After |
(Optional) Include only work orders initiated on or after this UTC date. |
|
Initiated Before |
(Optional) Include only work orders initiated before or on this UTC date. |
Work Order
|
Work Order |
Select the work order to add an attachment to. |
Data Source
|
Upload |
Select the source type:
|
|
File to Add |
When Upload is File, specify the file to be uploaded. |
|
Attribute to Add as File |
When Upload is Attribute, specify the attribute containing the content for upload. |
Metadata
|
Add With Filename |
When Upload is Attribute, specify the filename, including extension, to contain the uploaded content. |
|
Comments |
(Optional) Provide comments. |
Filter Work Orders
Filtering refines the items shown when selecting a Work Order.
|
Domain |
Specify the domain to include. |
|
Entity Type |
Specify the entity type to include. |
|
Hide Closed |
Select which work orders to include:
|
|
Hide Canceled |
Select which work orders to include:
|
|
Initiated After |
(Optional) Include only work orders initiated on or after this UTC date. |
|
Initiated Before |
(Optional) Include only work orders initiated before or on this UTC date. |
Work Order
|
Work Order |
Select the work order to add costs to. |
Costs
|
Cost Type |
Select the type of cost to add:
|
|
Contractor |
When Cost Type is Contractor, select the contractor to add costs for. |
|
Employee |
When Cost Type is Employee , select the employee to add costs for. |
|
Equipment |
When Cost Type is Equipment , select the equipment to add costs for. |
|
Material |
When Cost Type is Material, select the material to add costs for. |
|
Units |
When Cost Type is Material or Equipment, select the quantity. |
|
Storeroom Domain |
When Cost Type is Material, select the storeroom domain. |
|
Storeroom |
When Cost Type is Material, select the storeroom. |
|
Wage Type |
When Cost Type is Employee , select the cost code or wage type. |
|
Hours |
When Cost Type is Contractor, Employee, or Equipment, specify the number of hours. |
|
Description |
(Optional) When Cost Type is Contractor or Employee, provide a description. |
Additional Parameters
This table specifies any custom parameters to add to the API call.
Each entry consists of an API Parameter Name and Parameter Value.
|
API Parameter Name |
Specify the name of the parameter as it is expected to appear in the API call. |
|
Parameter Value |
Provide a value. Numeric values will be parsed as numbers. JSON input is supported. All other input will be treated as a string. |
Output Attributes
|
Attributes to Add |
Select any available attributes to be included on the output features:
|
Filter Work Orders
Filtering refines the items shown when selecting a Work Order.
|
Domain |
Specify the domain to include. |
|
Entity Type |
Specify the entity type to include. |
|
Hide Closed |
Select which work orders to include:
|
|
Hide Canceled |
Select which work orders to include:
|
|
Initiated After |
(Optional) Include only work orders initiated on or after this UTC date. |
|
Initiated Before |
(Optional) Include only work orders initiated before or on this UTC date. |
Work Order
|
Work Order |
Select the work order to cancel. |
Filter Work Orders
Filtering refines the items shown when selecting a Work Order.
|
Domain |
Specify the domain to include. |
|
Entity Type |
Specify the entity type to include. |
|
Hide Closed |
Select which work orders to include:
|
|
Hide Canceled |
Select which work orders to include:
|
|
Initiated After |
(Optional) Include only work orders initiated on or after this UTC date. |
|
Initiated Before |
(Optional) Include only work orders initiated before or on this UTC date. |
Work Order
|
Work Order |
Select the work order to close. |
Create Options
|
Create Inspection From |
(Optional) Select the type of object to create a work order from:
|
|
Service Request |
When Create Work Order From is Service Request, select a service request. |
|
Inspection |
When Create Work Order From is Inspection, select an inspection. |
|
Work Order |
When Create Work Order From is Work Order, select a work order. |
|
Work Order Domain |
(Optional) Provide a domain for the new work order. |
|
Entity Type |
Specify the entity type. |
|
Category |
(Optional) Specify the category of the work order template. |
|
Work Order Template |
Specify the work order template to use for the new work order. Note that if Entity Type is changed, the Work Order Template needs to be reselected. |
|
Address |
(Optional) Provide an address to associate with the work order. |
|
Geocode Address |
When Address is specified, select a geocoding option:
|
|
Status |
(Optional) Assign a status to the service request. Statuses which require a special workflow should not be set through Create. |
|
Priority |
(Optional) Assign a priority to the work order. |
|
Submit to Crew SID |
(Optional) Specify a crew the inspection is submitted to. If Submit to Crew SID is specified, Submit to SID will automatically be set to the leader of that crew. |
|
Submit to SID |
(Optional) Designate the person the work order is submitted to. |
|
Projected Start Date |
(Optional) Provide a UTC start date. |
|
Instructions |
(Optional) Provide instructions. |
Additional Parameters
This table specifies any custom parameters to add to the API call.
Each entry consists of an API Parameter Name and Parameter Value.
|
API Parameter Name |
Specify the name of the parameter as it is expected to appear in the API call. |
|
Parameter Value |
Provide a value. Numeric values will be parsed as numbers. JSON input is supported. All other input will be treated as a string. |
Output Attributes
|
Attributes to Add |
Select any available attributes to be included on the output features:
|
Filter Work Orders
Filtering refines the items shown when selecting a Work Order.
|
Domain |
Specify the domain to include. |
|
Entity Type |
Specify the entity type to include. |
|
Hide Closed |
Select which work orders to include:
|
|
Hide Canceled |
Select which work orders to include:
|
|
Initiated After |
(Optional) Include only work orders initiated on or after this UTC date. |
|
Initiated Before |
(Optional) Include only work orders initiated before or on this UTC date. |
Work Order
|
Work Order |
Select the work order to delete. |
List Options
|
List Work Orders By |
Select the method used to list work orders. Note that available filters vary according to this selection.
|
||||||||||||||||||||||||||||||
|
Inspection |
When List Work Orders By is Inspection, select an inspection. |
||||||||||||||||||||||||||||||
|
Service Request |
When List Work Orders By is Service Request, select a service request. |
||||||||||||||||||||||||||||||
|
Work Order Domain |
(Optional) When List Work Orders By is Filter, select a domain. |
||||||||||||||||||||||||||||||
|
Address |
(Optional) When List Work Orders By is Filter, specify a substring which appears in the address. |
||||||||||||||||||||||||||||||
|
Entity Type |
Specify the entity type. |
||||||||||||||||||||||||||||||
|
Work Order Type |
(Optional) Specify the work order type. |
||||||||||||||||||||||||||||||
|
Category |
(Optional) When List Work Orders By is Filter, select a category. |
||||||||||||||||||||||||||||||
|
Priority |
(Optional) When List Work Orders By is Filter, select a work order priority. |
||||||||||||||||||||||||||||||
|
Status |
(Optional) When List Work Orders By is Filter, select a status. |
||||||||||||||||||||||||||||||
|
Submit To SIDs |
(Optional) When List Work Orders By is Filter, select one or more people who the listed work orders should have been submitted to. |
||||||||||||||||||||||||||||||
|
Submit to Crew SID |
(Optional) When List Work Orders By is Filter, select a crew who the listed work orders should have been submitted to. |
||||||||||||||||||||||||||||||
|
Initiated After |
(Optional) When List Work Orders By is Filter, include only work orders initiated on or after this UTC date. |
||||||||||||||||||||||||||||||
|
Initiated Before |
(Optional) When List Work Orders By is Filter, include only work orders initiated before or on this UTC date. |
Output Attributes
|
Attributes to Add |
Select any available attributes to be included on the output features:
|
Filter Work Orders
Filtering refines the items shown when selecting a Work Order.
|
Domain |
Specify the domain to include. |
|
Entity Type |
Specify the entity type to include. |
|
Hide Closed |
Select which work orders to include:
|
|
Hide Canceled |
Select which work orders to include:
|
|
Initiated After |
(Optional) Include only work orders initiated on or after this UTC date. |
|
Initiated Before |
(Optional) Include only work orders initiated before or on this UTC date. |
Work Order
Only parameters with a value specified will be updated.
|
Work Order |
Select the work order to update. |
|
Address |
(Optional) Provide an address. |
|
Priority |
(Optional) Specify a priority. |
|
Status |
(Optional) Assign a status to the service request. Statuses which require a special workflow should not be set through Update. |
|
Stage |
(Optional) Specify the stage. |
|
Instructions |
(Optional) Provide instructions. |
|
Requested By SID |
(Optional) Specify the person requesting the work order. |
|
Supervisor SID |
(Optional) Specify the supervisor. |
|
Submit to Crew SID |
(Optional) Specify the assigned crew. |
|
Submit to SID |
(Optional) Designate the person the work order is submitted to. |
|
Completed By SID |
(Optional) Specify the person who completed the work order. |
|
Projected Start Date |
(Optional) Provide a UTC projected start date. |
|
Projected Finish Date |
(Optional) Provide a UTC projected finish date. |
|
Actual Start Date |
(Optional) Provide a UTC actual start date. |
|
Actual Finish Date |
(Optional) Provide a UTC actual finish date. |
Additional Parameters
This table specifies any custom parameters to add to the API call.
Each entry consists of an API Parameter Name and Parameter Value.
|
API Parameter Name |
Specify the name of the parameter as it is expected to appear in the API call. |
|
Parameter Value |
Provide a value. Numeric values will be parsed as numbers. JSON input is supported. All other input will be treated as a string. |
Output Attributes
|
Attributes to Add |
Select any available attributes to be included on the output features:
|
Editing Transformer Parameters
Transformer parameters can be set by directly entering values, using expressions, or referencing other elements in the workspace such as attribute values or user parameters. Various editors and context menus are available to assist. To see what is available, click
beside the applicable parameter.
Defining Values
There are several ways to define a value for use in a Transformer. The simplest is to simply type in a value or string, which can include functions of various types such as attribute references, math and string functions, and workspace parameters.
Using the Text Editor
The Text Editor provides a convenient way to construct text strings (including regular expressions) from various data sources, such as attributes, parameters, and constants, where the result is used directly inside a parameter.
Using the Arithmetic Editor
The Arithmetic Editor provides a convenient way to construct math expressions from various data sources, such as attributes, parameters, and feature functions, where the result is used directly inside a parameter.
Conditional Values
Set values depending on one or more test conditions that either pass or fail.
Parameter Condition Definition Dialog
Content
Expressions and strings can include a number of functions, characters, parameters, and more.
When setting values - whether entered directly in a parameter or constructed using one of the editors - strings and expressions containing String, Math, Date/Time or FME Feature Functions will have those functions evaluated. Therefore, the names of these functions (in the form @<function_name>) should not be used as literal string values.
| These functions manipulate and format strings. | |
|
Special Characters |
A set of control characters is available in the Text Editor. |
| Math functions are available in both editors. | |
| Date/Time Functions | Date and time functions are available in the Text Editor. |
| These operators are available in the Arithmetic Editor. | |
| These return primarily feature-specific values. | |
| FME and workspace-specific parameters may be used. | |
| Creating and Modifying User Parameters | Create your own editable parameters. |
Table Tools
Transformers with table-style parameters have additional tools for populating and manipulating values.
|
Row Reordering
|
Enabled once you have clicked on a row item. Choices include:
|
|
Cut, Copy, and Paste
|
Enabled once you have clicked on a row item. Choices include:
Cut, copy, and paste may be used within a transformer, or between transformers. |
|
Filter
|
Start typing a string, and the matrix will only display rows matching those characters. Searches all columns. This only affects the display of attributes within the transformer - it does not alter which attributes are output. |
|
Import
|
Import populates the table with a set of new attributes read from a dataset. Specific application varies between transformers. |
|
Reset/Refresh
|
Generally resets the table to its initial state, and may provide additional options to remove invalid entries. Behavior varies between transformers. |
Note: Not all tools are available in all transformers.
For more information, see Transformer Parameter Menu Options.
Reference
|
Processing Behavior |
|
|
Feature Holding |
No |
| Dependencies | None |
| Aliases | |
| History | Released FME 2025.2 |
FME Online Resources
The FME Community and Support Center Knowledge Base have a wealth of information, including active forums with 35,000+ members and thousands of articles.
Search for all results about the TrimbleUnityConnector on the FME Community.
Examples may contain information licensed under the Open Government Licence – Vancouver, Open Government Licence - British Columbia, and/or Open Government Licence – Canada.