FTRemoteAccess

FactoryTalk Remote Access connection

BrowseName
FTRemoteAccess
SuperType
Object(BaseObjectType)

Properties

Name BrowseName DataType Description
Runtime version RuntimeVersion String Version of FactoryTalk Remote Access runtime
Server connection ServerConnection ServerConnectionEnum Status of the device connection to FactoryTalk Remote Access server (0=Disconnected, 1=Connecting, 2=Connected)
Registered to domain RegisteredToDomain Boolean Indicates that the device is registered to the FactoryTalk Remote Access domain
Assistance request mode AssistanceRequestMode AssistanceRequestModeEnum Submit assistance requests mode (0=Disabled, 1=Enabled, 2=ContactDetailsRequired)
Assistance requested AssistanceRequested Boolean Indicates that assistance has been requested
Remote connection count RemoteConnectionCount UInt32 Number of remote connections to the device
Anonymous id AnonymousId String ID credential needed to add device to FTRA domain
Anonymous password AnonymousPassword String Password credential required to add device to FactoryTalk Remote Access domain

Methods

Connect to server

BrowseName
ConnectToServer

Connects the device to the FactoryTalk Remote Access server

Table 1. OutputArguments
Name DataType Description
Result Boolean Result code of the connection to the FactoryTalk Remote Access server(s)

Disconnect from server

BrowseName
DisconnectFromServer

Disconnects the device from the FactoryTalk Remote Access server

Table 2. OutputArguments
Name DataType Description
Result Boolean

Open assistance request

BrowseName
OpenAssistanceRequest

Opens a request for remote assistance

Table 3. InputArguments
Name DataType Description
Name String User name of who opened the remote assistance request
ContactInformation String Contact information of who opened the remote assistance request
Description String Brief description of the assistance request
Table 4. OutputArguments
Name DataType Description
Result OpenAssistanceRequestResultEnum Result of the remote assistance request

Close assistance request

BrowseName
CloseAssistanceRequest

Closes a request for remote assistance

Table 5. OutputArguments
Name DataType Description
Result CloseAssistanceRequestResultEnum Closes an assistance request that has been previously opened from the current device

Approve incoming remote connection

BrowseName
ApproveIncomingRemoteConnection

Approves an incoming FactoryTalk Remote Access connection

Table 6. InputArguments
Name DataType Description
SupervisorId ByteString ID of the supervisor of the remote connection request
Table 7. OutputArguments
Name DataType Description
Result IncomingRemoteConnectionApprovalResultEnum Result code of the remote connection approval

Deny incoming remote connection

BrowseName
DenyIncomingRemoteConnection

Denies an incoming FactoryTalk Remote Access connection

Table 8. InputArguments
Name DataType Description
SupervisorId ByteString ID of the supervistor of the remote connection after it is denied
Table 9. OutputArguments
Name DataType Description
Result IncomingRemoteConnectionApprovalResultEnum Result code of the remote connection approval

Events

Remote Connection Request

BrowseName
Remote Connection Request

Executes a method when an incoming FactoryTalk Remote Access connection occurs