Open an object

FactoryTalk Optix Studio Help

Getting started

Important user information

FactoryTalk Optix overview

FactoryTalk Optix Studio

FactoryTalk Optix Application

FactoryTalk Optix Studio interface

Start page

Main toolbar

Project view

Type view

Properties pane

Output pane

Basic concepts

Objects

Object types

Variables

Variable types

Variable values

Events and methods

Event types

Runtime method types

Information model

Terms dictionary

System log

FactoryTalk Optix configuration

Set options

Configure module log levels

Quick start project

Create a project

Configure and brand the main window

Configure the main window

Configure a logo

Configure panels

Configure panel types

Configure a navigation panel

Configure dynamic graphic objects

Add graphic objects

Associate the LED status with the switch

Associate the LED color with the spin box

Configure variables

Create variables

Import controller variables

Configure temperature controls

Configure alarms

Configure a digital alarm

Configure an alarm grid

Configure an alarm event logger

Configure a widget to display logged alarms

Configure a switch to simulate alarms

Configure recipes

Configure a recipe

Configure a recipes editor

Save and commit changes

Creating projects

Projects

Create a project

Open a project

Upgrade a project

Save a project

Duplicate a project

Restore a project

Backup a project

Close a project

Project source format

Project secrets encryption

Version control

Configure version control

User authentication

Add user authentication

Remove user authentication

Display repositories and remote projects

Create a local project

Commit changes to a local repository

Create a remote repository for a project

Create a project from a remote repository

Push changes that you make to the remote repository

Pull changes that other users make from the remote repository

Open a remote project

Pull preview

Add version control to an existing project

View changes to a project

Compare versions of a project

Restore a previous version of a project

Version history

Version history contents

Communication drivers

Communication drivers overview

RA EtherNet/IP Driver

Modbus driver

S7 TIA PROFINET driver

Configure a communication driver

Edit or synchronize the imported tags

Organize the imported tags

Add a Station Connection Status widget

Set dynamic variables polling time for controllers

Read/write operation codes

Runtime communication errors for UI controls

OPC UA

OPC UA communications security

Minimum security policy

Minimum message security mode

User identity types for a client

Certificates and keys

Certificates and keys location

OPC UA server

Project Node IDs

Add an OPC UA server

Configure firewall for an OPC UA server

OPC UA client

Add an OPC UA client

Configure the OPC UA client

Synchronize the imported nodes at design time

Edit the imported nodes at design time

Import nodes at runtime

Import nodes from NodeSet

OPC UA certificates and keys

Create a certificate

Configure OPC UA server certificates and keys

Configure OPC UA client certificates and keys

Configure the trusted certificates at design time

Configure the trusted server certificates at design time

Configure the trusted certificates at runtime

OPC UA Companion Specifications

Import Companion Specifications

Add instances of types defined in Companion Specifications

Add optional objects to a node

Add collection items to a node

OPC UA tutorial

Develop a solution for importing UI

Server project

Create project variables

Create remote panel (types)

Configure the main panel (type)

Configure the speed panel (type)

Configure the acceleration panel (type)

Implement the main panel

Create an OPC UA server for pushing UI objects

Client project

Create a client panel loader

Create a NetLogic that fetches UI

Create an OPC UA client for fetching UI objects

Develop a solution for importing translations

Server project

Add users (server)

Create a login form

Create a panel

Edit the localization dictionary

Create an OPC UA server

Client project

Add users (client)

Add a login form (type)

Create a client panel loader

Create a NetLogic that fetches panels

Create an OPC UA client

Graphic objects

Editor

Configure the editor grid

Predefined graphic objects

Base controls

Label

Text box

Spin box

Editable label

LED

Button

Switch

Checkbox

Option button

Linear gauge

Circular gauge

Date and time

Duration

Containers

Panel

Screen

Add a Screens folder

Add a screen type

Add a screen instance

Horizontal layout

Vertical layout

Scale layout

Panel loader

Navigation panel

Configure a navigation panel

Dropdown button

Configure a dropdown button

Window

Dialog box

Configure a button to open a dialog box

Configure a button to close a dialog box

Popup

Scroll view

Accordion

Contents

Web browser

Configure a web browser

Add an address bar

Add navigation buttons

Video

PDF Viewer

Configure a PDF viewer

Data controls

Combo box

Configure a combo box

List box

Configure a list box

Data grid

Configure a data grid

Trend

Configure a trend

Add a trend pen toggle

Navigate a trend chart

Zoom in and zoom out a trend chart

Display the details of a value

XY Chart

Configure an XY chart

Add a scale line pen

Add an array line pen

Add a polygon pen

Pie chart

Configure a Pie chart

Histogram chart

Configure a Histogram chart

Drawings

Rectangle

Ellipse

Image

Add an image

Edit an image

Multistate image

Advanced SVG image

Add an Advanced SVG image

Drawing tools

Draw a rectangle or square

Draw an oval or circle

Draw a line

Draw a polyline or polygon

Group drawing objects

Change the appearance of a drawing object

Presentation engines

Configure a presentation engine

Profile objects for different presentation engines

Style sheets

Create a style sheet

Use an existing style sheet

Configure a style sheet

Apply a style sheet

Import fonts

Size conventions

Manage graphic objects

Create a graphic object from a type

Create a graphic object type

Duplicate a graphic object

Rename a graphic object

Edit graphic object properties

Make a graphic object movable

Enable or disable a graphic object

Change graphic object visibility

Animate a graphic object

Animation properties

Lock or unlock a graphic object

Delete a graphic object

Common properties

Graphic objects layout

Resize an object

Move an object

Dock an object

Align objects

Set margins

Change objects order

Responsive user interface

Create a responsive user interface

Graphic objects tutorial

Develop a user-specific interface

Create a change user form

Create a username label

Display an object to a user group

Develop filterable data grids

Create Motor objects

Create a grid of numeric data

Create an interface for filtering numeric data

Create a grid of date and time data

Create an interface for filtering date and time data

Numeric data query examples

Develop a filterable list box

Create and configure a DataStore

Create a NetLogic that adds random data

Create an interface for filtering the list box

Create a list box

Create a button that adds random data

Develop a constrained linear gauge

Create a constrained variable

Create elements for controlling the current value

Create elements for controlling the max value

Create elements for controlling the min value

Create a switch for toggling constraints

Develop automatically generated UI

Create a Motor object

Create a Kiln object

Create a list box

Create a vertical layout

Create the UIPopulator NetLogic

Implement the UIPopulator NetLogic

Develop a UI with a responsive image

Develop a confirmation dialog

Create panels

Create a context object for the dialog

Create a confirmation dialog widget

Configure the SavePanel (type)

Configure the ValuePanel (type)

Develop an icon that changes color

Create an alarm

Create an alarm trigger

Create an Advanced SVG Image object

Libraries

Configure a local library

Configure a remote library

Create a library folder

Commit a library

Push a library

Pull a library

View and restore library versions

Delete a library

Templates

Create a template from an object or variable

Search for a template

Apply a template

Delete a template

Widgets

Add a widget to a project

Connect to remote access

Approve a remote connection from FactoryTalk Remote Access to a device

Request remote assistance

Synchronize device date and time

Configure the device on which the FactoryTalk Optix Application is running

Specify network settings

Load an application

Project nodes

Nodes

Create a folder

Move a node

Rename a node

Delete a node

Search for nodes

Navigate nodes

View node references

View type instances

Display information model graphs

Objects

Create an object

Create an object from a type

Create an object type

Open an object

Variables

Array editor

Create a variable

Create an analog variable

Create a node pointer

Create a variable type

Create a variable from a type

Set the unit of measure for a variable

Change the unit of measure for a variable

Remove the unit of measure from a variable

Add a range to a variable

Delete a range from a variable

Enumerations

Create an enumeration

Edit an enumeration

Delete an enumeration

Paths

Dynamic links

Dynamic link browser

Complex dynamic link editor

Create dynamic links

Create a dynamic link by selecting the source

Create a dynamic link by dragging the source

Create a complex dynamic link

Edit a dynamic link

Remove a dynamic link

References to dynamic link sources

Parent node format

Dynamic links tutorial

Develop a label with a localized engineering unit

Add users

Create a login form

Create variables

Create a label

Develop a gauge with a localized engineering unit

Add users

Create a login form

Create an analog variable

Create a linear gauge

Create a label

Converters

Conditional converter

Engineering unit converter

Expression evaluator

Key-value converter

Linear converter

String formatter

Create a converter type

Events

Objects predefined with events

Methods

Types of methods

Global methods for nodes

Global methods for variables

Global methods for UI

Global methods for alarms

Global methods for the information model

Global methods for user authentication

Custom methods

Add a method to an existing event

Delete a method from an event

Create a method for an object

Read the output value of a custom method

Create a custom event

Add an event to an object from another object

Configure a change event

Configure a transitioned event

Configure a range transitioned event

Aliases

Create an alias

Create a dynamic link using an alias

Dynamic links between aliases

Aliases in widgets

Built-in aliases

Aliases tutorial

Develop a motor management dashboard

Create Motor objects

Create a list of motors

Create a motor values widget (type)

Create a speed gauge and labels

Create an acceleration gauge and labels

Create a motor values widget instance

Alarms

Alarm types

Alarm events

Alarm variables

Custom alarm types

Create an alarm

Create an alarm type

Make an active alarm visible

Set dynamic variables polling time for alarms

Alarm grid

Create an Alarm grid

Create an Analog alarm grid

Display multiple active alarms for an object

View alarms displayed by an OPC UA server

View alarms in UTC time zone

Alarm log grids

View alarm log events in UTC time zone

Configure an alarm log

Create a dynamic alarm message

Translate an alarm message

Alarm filters

Create an alarm filter

Confirm and acknowledge alarms

Automatically confirm and acknowledge alarms

Alarms tutorial

Develop a temperature change alarm

Create a temperature alarm

Create a thermometer linear gauge

Create an alarm grid

Develop a color-coded alarm dashboard

Create alarms

Create a severity color converter

Create an alarm grid

Develop an alarm grid NetLogic

Configure the alarm grid columns

Create buttons to control alarms

Create alarm triggers

Configure a localization dictionary

Recipes

Manage recipe schemas

Configure a recipe schema

Configure a recipe schema manually

Duplicate a recipe schema

Edit a recipe schema

Delete a recipe schema

Recipes editor

Design a recipes management interface

Configure a recipes editor widget

Import or export recipes at runtime

Manage recipes at runtime

Custom recipes management interface

Reuse objects from the default recipes editor

Recipes tutorial

Develop a recipes management dashboard

Create a motor object

Create linear gauges

Logger

Data logger

Add a data logger

Duplicate a data logger

Edit a data logger

Delete a data logger

Set a deadband interval

Deadband interval configurations

Store read operation codes

Read operation codes

Store variable reading date and time

Event logger

Add an event logger

Edit an event logger

Delete an event logger

Display logger data

Logger tutorial

Develop a localized event logger

Add users

Create a login form

Create a variable

Create a key value converter

Create an alarm

Create an alarm grid

Create a linear gauge

Create a database

Create an event logger

Create a data grid

Create a refresh button

Edit the localization dictionary

Develop a data logger with an ODBC database

Create the interface elements

Develop a solution that periodically samples and stores data

Create the interface elements

Develop a solution that samples and stores data

Create the interface elements

Develop an event logger for audits

Database

Create an embedded database

Create an ODBC database

OPC UA and ODBC database data types

Configure a database table

Display database table data

Export a database table to a CSV file

SQL query

Clauses supported by the SELECT statement

JOIN clauses

WHERE clauses

EXTRACT clauses

CHAR_LENGTH clause

Compose SQL queries

Reports

Reports object

Create a report

Display information in a report footer

Apply a stylesheet to a report

Configure an event to generate a PDF

Reports tutorial

Develop a UI that generates a PDF report

Create Motor objects

Create a data grid

Create a report object

Configure the report header

Configure the report sections

Configure the report footer

Create a button that generates the report

Users and groups

Users

Add a user

Assign a user to a group

Remove a user from a group

Change user properties

Groups

Create a group

Assign a group to a user

Authentication

Configure the authentication mode

Configure password policies for a project

Translations

Localization editor

Language displayed at runtime

Change the interface language

Create a localization dictionary

Add a locale language to a localization dictionary

Translate a string

Preview translated text

Export translated strings to a CSV file

Import translated strings from a CSV file

Use translated texts in a string formatter

Translations tutorial

Develop an interface for switching locales

Create a label

Edit the localization dictionary

Create buttons for switching locales

Develop a multilingual login form

Add users

Create a login form

Edit the localization dictionary

Audit signing

Configure audit signing

Audit signing reference

Retentivity storage

Create retentivity storage

FTP

FTP Server configuration

FTP Client configuration

IoT

Push Agent

Configure a Push Agent

Push Agent properties

Brokers

Eclipse Mosquitto broker

Azure IoT Hub broker

Generate a SAS token

Communicate with Azure IoT Hub broker

Configuration examples

Push Agent configuration for Eclipse Mosquitto

Push Agent configuration for the Azure IoT Hub

Push Agent as a subscriber

Push Agent interface

Sessions and locales

Sessions

Locales

Example interactive session and Presentation Engine

Session nodes

User locale configuration

Configure session and fallback locales

Configure the locale at runtime

Configure idle Timeout

Configure idle timeout for a page

Configure idle Timeout for a session

Configure a screen saver or automatic logout

Measurement systems

Configure measurement systems map

Create an engineering units dictionary

Time zones

View alarms in standard time zone

View alarms in remote local time zone

Time zones for alarm events

Time zones in trend graphs

Sessions and locales tutorial

Develop a persistent setting specific to a user

Create users

Add predefined UI elements

Create a checkbox that shows or hides the clock

Create a clock label

Create a retentivity storage

Develop buttons for closing and shutting down

Create a button that closes the application

Develop a NetLogic that shuts down the host system

Create a button that shuts down the host system

System object

Create the System object

System variables

Application variables

Date and time variables

Device variables

Display variables

Network interfaces variables

Create a button to restart the application

File signature and verification

Configure file signature and verification

Deployment

Manage client devices

Add a client device

Remove a client device

Duplicate a client device

Select a client device

Project encryption

Deploy a FactoryTalk Optix Application

Export a FactoryTalk Optix Application

Import a FactoryTalk Optix Application

Object and variable references

EngineeringUnits

EngineeringUnits

FTOptix-Alarm

DataTypes

Exclusive limit alarm state

Exclusive limit alarm transition

ObjectTypes

Alarm controller

Exclusive deviation alarm

Exclusive level alarm

Exclusive limit alarm

Exclusive rate of change alarm

Limit alarm

Non-exclusive deviation alarm

Non-exclusive level alarm

Non-exclusive limit alarm

Non-exclusive rate of change alarm

Digital alarm

Localized retained alarm container

FTOptix-AuditSigning

DataTypes

SignResult

Workflow Type

ObjectTypes

AuditSigning Signature

Workflow Completed

AuditSigningWorkflowEvent

Workflow Started

GroupInfo

Signing Workflow

SigningControllerContext

UserInfo

WorkflowStartedEvent

FTOptix-CODESYS

DataTypes

CODESYSPlcVersion

CODESYSProtocol

Encoding

ObjectTypes

CODESYS Driver

CODESYS Station

VariableTypes

CODESYS Tag

FTOptix-CommunicationDriver

DataTypes

Base PLC item

Communication operation code

Endianness

Flow control

Folder information

Generic item

Operation code

Parity

Prototype information

Read notification policy

Stop bits

Structure information

Tag array update mode

Tag attribute

Tag information

Tag to read

Tag to write

Write notification policy

ObjectTypes

Communication driver

Communication station

Driver event

Operation completed event

Tag event

Tag read event

Tag write event

Task completed event

Task event

Task failed event

VariableTypes

Tag

Structured tag

FTOptix-Core

DataTypes

AbsoluteResourceUri

AuthenticationMode

ChangePasswordResultCode

ChangeUserResultCode

Color

DeleteNodesItem

EngineeringUnitDictionaryItem

LogLevel

MeasurementSystem

MeasurementSystemMapItem

NamespaceIndex

NodePath

NodePointerNodeClass

Password

PasswordHash

PhysicalDimension

Quality

ResourceUri

UnitId

VariablePointer

ObjectTypes

AuditDeleteNodesEventType

CommandGroup

DataLog

DataModel

Group

IdentityValidatorType

LocalizationDictionariesType

LogEvent

NodeLoader

Array of objects

Password policy

Property group

RoleType

RootUserType

Scheduler

SessionType

UserLoginEvent

UserLogoutEvent

UserSessionEvent

User

VariableGroup

VariableTypes

Alias

BehaviourStartPriorityVariableType

Engineering unit dictionary

Engineering unit information

Localization dictionary

MetaProperty

Node pointer

Password

Range

RightType

UserBasedRightType

FTOptix-CoreBase

DataTypes

Engineering unit propagation

Dynamic link mode

Key-value pair data type

VariableRangeTransition

VariableTransition

ObjectTypes

Conditional converter

Converter

Core context

Engineering unit converter

Event Handler

Expression evaluator

Linear converter

Method invocation

String formatter

Key-value converter

Key-value pair

VariableChanged event

VariableCondition event

VariableCondition event dispatcher

Variable range transition event

Variable range transition event dispatcher

Variable transition event

Variable transition event dispatcher

VariableValueChanged Event

VariableTypes

Dynamic link

FTOptix-DataLogger

DataTypes

Deadband mode

Sampling mode

ObjectTypes

Data logger

VariableTypes

Variable to sample

FTOptix-EventLogger

ObjectTypes

Event configuration

Event logger

VariableTypes

Path to event field

Event field to log

FTOptix-HMIProject

ObjectTypes

Alarms

Category folder

Communication drivers

Converters

Data stores

Groups

Loggers

Model

NetLogic

Template library item

Template library project folder

OPC-UA

Project folder

Project loaded event

Prototype folder

Recipes

Reports

Retentivity

Screens

Security

System

Translations

UI

Users

FTOptix-MelsecFX3U

DataTypes

Memory area

ObjectTypes

MELSEC FX3U Driver

MELSEC FX3U Station

VariableTypes

MELSEC FX3U tag

FTOptix-MelsecQ

DataTypes

Encoding

Memory area

Number base

ObjectTypes

MELSEC Q driver

MELSEC Q station

VariableTypes

MELSEC Q tag

FTOptix-Modbus

DataTypes

Memory area

Protocol

ObjectTypes

Modbus Driver

Modbus Station

VariableTypes

Modbus tag

FTOptix-NativeUI

DataTypes

Text render type

ObjectTypes

Native presentation engine

FTOptix-NetLogic

ObjectTypes

NetLogic

FTOptix-ODBCStore

DataTypes

DBMS type

ObjectTypes

ODBC database

ODBC store table

FTOptix-OmronEthernetIP

DataTypes

Encoding

ObjectTypes

OMRON EtherNet/IP driver

OMRON EtherNet/IP station

VariableTypes

OMRON EtherNet/IP tag

FTOptix-OmronFins

DataTypes

BCD format

Data conversion

Memory area

OMRON Fins driver protocol

Optimization type

ObjectTypes

OMRON Fins Driver

OMRON Fins Station

VariableTypes

OMRON Fins Tag

FTOptix-OPCUAClient

DataTypes

Asynchronous read value result

Browse direction

BrowseResult

Connection status

Content synchronization mode

Events

Message security mode

Read value

Read value result

Reference description

Security policy

User identity type

Write value

Write value result

ObjectTypes

OPC UA client

Operation completed event

Runtime configuration

FTOptix-OPCUAServer

DataTypes

Message security mode

Security policy

ObjectTypes

Configuration

OPC UA server

FTOptix-RAEtherNetIP

DataTypes

Encoding

ObjectTypes

RA EtherNet/IP Driver

RA EtherNet/IP Station

VariableTypes

RA EtherNet/IP Tag

FTOptix-Recipe

DataTypes

Copy error policy

ObjectTypes

Recipe

Recipe application event

Recipe schema

FTOptix-Report

DataTypes

PDF generation result

Page orientation

Page size

ObjectTypes

Data grid section

PDF generated

Page break

Panel section

Reports

Column layout

Data grid column

Image column

Text column

Image

Label

Panel

Rectangle

Style sheet

FTOptix-Retentivity

ObjectTypes

Retentivity storage

FTOptix-S7TCP

DataTypes

Encoding

Memory area

ObjectTypes

S7TCP driver

S7TCP Station

VariableTypes

S7TCP tag

FTOptix-S7TiaProfinet

DataTypes

Encoding

ObjectTypes

S7 TIA PROFINET driver

S7 TIA PROFINET station

VariableTypes

S7 TIA PROFINET tag

FTOptix-SerialPort

DataTypes

Communication status

ObjectTypes

Serial port

FTOptix-SQLiteStore

ObjectTypes

Embedded database

SQLite store table

FTOptix-Store

DataTypes

Store status

ObjectTypes

Store

Table

VariableTypes

Store column

FTOptix-System

DataTypes

AssistanceRequestModeEnum

CloseAssistanceRequestResultEnum

DisplayOrientationEnum

IncomingRemoteConnectionApprovalResultEnum

LoadApplicationStatusEventEnum

OpenAssistanceRequestResultEnum

ServerConnectionEnum

Time synchronization

ObjectTypes

FTRemoteAccess

LoadApplicationStatusEvent

Network interface

Remote Connection Request

System

VariableTypes

Masked IP address

FTOptix-TagImporter

ObjectTypes

Tag importer

FTOptix-TwinCAT

DataTypes

Data format

Encoding

Memory area

ObjectTypes

TwinCAT driver

TwinCAT station

VariableTypes

TwinCAT Tag

FTOptix-UI

DataTypes

Property

Colorization mode

Combo box mode

Content horizontal alignment

Content vertical alignment

Input format

Animation

Motion curve

Elide

Fill mode

Font

Font weight

Header icon position

Horizontal alignment

Horizontal position

Input type

Tab position

Orientation

Panel loader animation

Zoom mode

Percentage

Position

Position

Reference time zone

Scale position

Scroll axes enabled

Size

Sorting

Text horizontal alignment

Text vertical alignment

Value change behavior

Vertical alignment

Vertical position

ObjectTypes

Abstract animation

Accordion

Content

Header

Accordion style

Activated

Advanced SVG Image

SVG Element Property

Base UI object type

Value change animation

Button

Button style

Chart style

Checkbox

Circular gauge

Vertical layout

Combo box

Container

Control style

Data grid

Data grid column

Editable text column

Image column

Data grid template element

Text column

Data input style

DataList style

DateTimeAxis

Date and time

Delay button

Dial

Dialog box

Dropdown button

Duration

Editable label

Ellipse

Gauge style

Histogram chart

Histogram chart style

IdleTimeoutEvent

Image

Element

Label

LED

Linear gauge

List box

MouseClick event

MouseDoubleClick event

MouseDown event

Mouse event

MouseUp event

Multistate image

MultiStateImageState

Navigation panel

Navigation panel item

Navigation panel style

Number animation

Panel

Panel loader

Parallel animation

PDF Viewer

Pie chart

Pie chart style

PolyLine

Popup

Presentation engine

Option button

Range Slider

Rectangle

Horizontal layout

Scale layout

Screen

ScrollBar style

Scroll view

Sequential animation

Spin box

Style sheet

Switch

Switch style

Text box

Toggle Button

Tooltip style

Trend

UI Session

Selection changed

Modified text

Modified value

Value axis

Video

Warning zone

Web browser

Window

XY chart

Array line pen

XY chart line

XY chart pen

Polygon pen

Scale line pen

VariableTypes

Trend pen

FTOptix-WebUI

DataTypes

Protocol

ObjectTypes

Web presentation engine

OPC-UA

DataTypes

AccessRestrictionType

AddNodesItem

AddReferencesItem

Argument

AxisInformation

AxisScaleEnumeration

BaseDataType

Boolean

Byte

ByteString

DataTypeAttributes

DataTypeDefinition

DateString

DateTime

Decimal

DecimalString

DeleteNodesItem

DeleteReferencesItem

DiagnosticInfo

Double

Duration

DurationString

EnumDefinition

Enumeration

EnumField

EnumValueType

EUInformation

EURange

ExceptionDeviationFormat

ExpandedNodeId

Float

GenericAttributes

GenericAttributeValue

Guid

IdType

Image

ImageBMP

ImageGIF

ImageJPG

ImagePNG

Int16

Int32

Int64

Integer

LocaleId

LocalizedText

MethodAttributes

ModelChangeStructureDataType

NamingRuleType

NodeClass

NodeId

NormalizedString

Number

NumericRange

ObjectAttributes

ObjectTypeAttributes

OptionSet

PermissionType

ProgramDiagnostic2DataType

QualifiedName

ReferenceTypeAttributes

RolePermissionType

SByte

SemanticChangeStructureDataType

ServerState

StatusCode

StatusResult

String

Structure

StructureDefinition

StructureField

StructureType

TimeString

TimeZoneDataType

UInt16

UInt32

UInt64

UInteger

Union

UtcTime

VariableAttributes

VariableTypeAttributes

XmlElement

XVType

ObjectTypes

AcknowledgeableConditionType

AddressSpaceFileType

AggregateConfigurationType

AlarmConditionType

AliasNameCategoryType

AliasNameType

AuditAddNodesEventType

AuditAddReferencesEventType

AuditConditionAcknowledgeEventType

AuditConditionCommentEventType

AuditConditionConfirmEventType

AuditConditionEnableEventType

AuditConditionEventType

AuditConditionOutOfServiceEventType

AuditConditionResetEventType

AuditConditionSilenceEventType

AuditConditionSuppressionEventType

AuditDeleteNodesEventType

AuditDeleteReferencesEventType

AuditEventType

AuditNodeManagementEventType

AuditUpdateEventType

AuditUpdateMethodEvent

AuditWriteUpdateEventType

BaseEventType

BaseInterfaceType

BaseModelChangeEventType

Object

ConditionType

DataTypeEncodingType

DataTypeSystemType

DiscreteAlarmType

ExclusiveDeviationAlarmType

ExclusiveLevelAlarmType

ExclusiveLimitAlarmType

ExclusiveLimitStateMachineType

ExclusiveRateOfChangeAlarmType

FileDirectoryType

FileTransferStateMachineType

FileType

FiniteStateMachineType

Folder

GeneralModelChangeEventType

HistoricalDataConfigurationType

InitialStateType

InstrumentDiagnosticAlarmType

LimitAlarmType

ModellingRuleType

NamespaceMetadataType

NonExclusiveDeviationAlarmType

NonExclusiveLevelAlarmType

NonExclusiveLimitAlarmType

NonExclusiveRateOfChangeAlarmType

OffNormalAlarmType

ProgramStateMachineType

ProgramTransitionEventType

RefreshEndEventType

RefreshStartEventType

SemanticChangeEventType

StateMachineType

StateType

SystemEventType

TemporaryFileTransferType

TransitionEventType

TransitionType

VariableTypes

Analog variable

AnalogUnitType

ArrayItemType

BaseAnalogType

Variable

BaseVariableType

ConditionVariableType

CubeItemType

DataItemType

DataTypeDescriptionType

DataTypeDictionaryType

DiscreteItemType

FiniteStateVariableType

FiniteTransitionVariableType

ImageItemType

MultiStateDiscreteType

MultiStateValueDiscreteType

NDimensionArrayItemType

ProgramDiagnostic2Type

PropertyType

StateVariableType

TransitionVariableType

TwoStateDiscreteType

TwoStateVariableType

XYArrayItemType

YArrayItemType

Extending projects

NetLogic

NetLogic templates

Manage NetLogics

Set the default code editor

Create a NetLogic

Edit a NetLogic

Run a NetLogic at design time

Open the project in an external code editor

Manage third-party .NET libraries

Add a third-party library to the Visual Studio project

Add a third-party library to the Visual Studio Code project

Add NuGet packages

Install NuGet packages in Visual Studio

Install NuGet packages in Visual Studio Code

Debug NetLogic locally

Debug NetLogic remotely

Prepare the remote machine for debugging

Start debugging on the remote machine

NetLogic tutorial

Develop a button that changes label text

Create the application interface

Develop a NetLogic that sets label text

Integrate the interface with the NetLogic

Develop a user management interface

Configure locale IDs

Create a user

Develop a NetLogic for managing user accounts

Create a widget for managing existing users

Create a widget for adding users

Integrate the interface with the NetLogic

Add retentivity storage to the project

Develop an interface for interacting with a database

Create the application interface

Create a database

Develop a NetLogic for inserting random values

Develop a NetLogic for displaying a query result

Integrate the interface with the NetLogics

Develop a contact form

Develop a NetLogic for sending emails

Create the contact form interface

Develop a files counter

Develop a NetLogic that counts files

Develop a login page

Create the login page interface

Develop a NetLogic that handles logins

Integrate the NetLogic with the interface

Develop a solution for importing objects

Create the AlarmImporter NetLogic

Configure the AlarmImporter NetLogic

Create objects from a CSV file

Configure an application as an MQTT client

Configure the message broker IP

Develop the publisher NetLogic and interface

Develop the subscriber NetLogic and interface

Arrange the interface elements

Develop an archives manager

Add the Zip Unzip NetLogic

ZipUnzip NetLogic

Create the interface elements

Develop an interface that visualizes a periodic task

Develop a process simulator logic

Create the application interface

Develop a NetLogic that exports table data to CSV

Create a database with sample data types

Create a NetLogic that generates random data

Create a NetLogic that exports table data to CSV

Create buttons for triggering methods

Create localized objects

Edit the localization dictionary

Create a NetLogic

C# project nodes

Access project nodes

LogicObject Variable: direct access to the NetLogic object

Variable Owner: direct access to the NetLogic parent object

Variable Session: directly access the session alias

Sort project nodes

Collections

Use a collection

Field variables

Methods and events in C#

Define methods in C#

Create an OPC UA method

Create an OPC UA method callable by an external OPC UA Client

Subscribe methods to events

Create a subscription

Cancel a subscription

Variables and objects generic events

IUAVariable.VariableChange

IUAObject.UAEvent

Run code asynchronously

Asynchronous task

Constructor: PeriodicTask(action, periodMilliseconds, excutingNode)

Constructor: DelayedTask(action, delayMilliseconds, executingNode)

Constructor: LongRunningTask(action, executingNode)

Call a method in an asynchronous task

Dispose of a task

Cancel a task

REST API Client

Configure a REST API Client

HTTP methods

Sessions and users in C#

Read or modify the session properties

C# API reference

Return known nodes

IUANode.Get(browsePath)

IUANode.GetObject(browsePath)

IUANode.GetVariable(browsePath)

IUANode.Get(browsePath)

IUANode.GetByType()

IUANode.GetNodesByType()

IUANode.GetAlias(aliasName)

Return nodes by searching

IUANode.Find(browseName)

IUANode.FindObject(browseName)

IUANode.FindVariable(browseName)

IUANode.Find(browseName)

IUANode.FindByType()

IUANode.FindNodesByType()

Add or remove nodes

IUANode.Add(child)

IUANode.Remove(child)

Create objects

InformationModel.MakeObject(browseName)

InformationModel.MakeObjectType(browseName)

InformationModel.MakeObject(browseName, objectTypeId)

InformationModel.MakeObjectType(browseName, superTypeId)

InformationModel.MakeObject(browseName)

InformationModel.MakeObjectType(browseName)

InformationModel.MakeObject(browseName, objectTypeId)

InformationModel.MakeObjectType(browseName, superTypeId)

Create variables

InformationModel.MakeAnalogItem(browseName, dataTypeId)

InformationModel.MakeVariable(browseName, dataTypeId, arrayDimensions)

InformationModel.MakeVariable(browseName, dataTypeId, variableTypeId, arrayDimensions)

InformationModel.MakeVariableType(browseName, dataTypeId, arrayDimensions)

InformationModel.MakeVariableType(browseName, dataTypeId, variableTypeId, arrayDimensions)

InformationModel.MakeVariable(browseName, dataTypeId, arrayDimensions)

InformationModel.MakeVariable(browseName, variableTypeId, dataTypeId, arrayDimensions)

InformationModel.MakeVariableType(browseName, variableTypeId, dataTypeId, arrayDimensions)

Read or write field variables

IUAVariable.RemoteRead(timeoutMilliseconds)

IUAVariable.RemoteWrite(value, timeoutMilliseconds)

InformationModel.RemoteRead(variables, timeoutMilliseconds)

InformationModel.RemoteWrite(variableValues, timeoutMilliseconds)

IUANode.ChildrenRemoteRead(timeoutMilliseconds)

IUANode.ChildrenRemoteRead(childVariables, timeoutMilliseconds)

IUANode.ChildrenRemoteWrite(childVariableValues, timeoutMilliseconds)

Keep field variables synchronized

RemoteVariableSynchronizer() constructor

RemoteVariableSynchronizer.Add(variables)

RemoteVariableSynchronizer.Remove(variables)

Write log messages

Log.Debug(message)

Log.Debug(category, message)

Log.Error(message)

Log.Error(category, message)

Log.Info(message)

Log.Info(category, message)

Log.Node(node, verbose)

Log.Warning(message)

Log.Warning(category, message)

Manage dynamic links

IUAVariable.SetDynamicLink(source, mode)

IUAVariable.SetDynamicLink(source, sourceArrayIndex, mode)

IUAVariable.ResetDynamicLink()

Manage aliases

InformationModel.MakeAlias(browseName)

LogicObject.GetAlias(string)

LogicObject.SetAlias(string, IUANode)

LogicObject.GetPanelLoader(string)

Manage file and resource paths

ResourceURI.FromAbsoluteFilePath(path)

ResourceURI.FromApplicationRelativePath(path)

ResourceURI.FromProjectRelativePath(path)

ResourceURI.FromURI(uri)

Session activity log and audit

Session.ChangeUser(username, password)

Manage translations

InformationModel.LookupTranslation(localizedText)

InformationModel.LookupTranslation(localizedText, localeIds)

InformationModel.AddTranslation(localizedText, localizationDictionary)

InformationModel.SetTranslation(localizedText)

Serial Port API

Example: Protocol configuration in request/response mode

Example: Protocol configuration in event mode

FactoryTalk Optix Release Notes

System requirements

System features

Known anomalies in this release

Corrected anomalies in this release

Application notes

FactoryTalk Optix Studio web editor

RA EtherNet/IP Driver - Ethernet communication modules support

Legal notices

Open an object

Open an object from

Project view

.

In

Project view

, double-click the object or mouse over the object and then select

Editor

.

The object opens in a separate tab if the object has a dedicated editor.

Properties

for the object also open.

Provide Feedback

Have questions or feedback about this documentation? Please submit your feedback here.