ObjectName Property

General info

Label

Object Name

Description

The user-modifiable object name. This name overrides the name which has been supplied by the external system. It must be unique within the collection of objects of the parent object.

Data type

String

Type

Regular

Code

1

Symbolic name

MODEL_PROP_OBJECTNAME

Lua access code

syslib.model.properties.ObjectName

Available since

1.0

Parent classes

ActionItem | AdvancedTrend | AdvancedTrendPen | AdvancedTrendXAxis | AdvancedTrendYAxis | AlarmGenerator | AliasItem | AnalogMeasurement | Area | BPRPublisher | BatchEquipmentPhaseDefinition | BatchEquipmentStepDefinition | BatchOperationDefinition | BatchTracker | BatchTrackerBackfill | BinaryState | Broker | Cache | CalculatedValue | Chart | CloudSinkItem | Connector | ControlModule | Core | CustomBigTableDataStore | CustomEventDataStore | CustomProductionTrackingDataStore | CustomTimeSeriesDataStore | CustomTimeSeriesDataStore2 | DBDispatcherItem | DBObjectController | DBSinkItem | DCS | DataDocument | DataFolder | DataStoreGroup | Datasource | DiscreteState | Division | Enterprise | EquipmentModule | EventArea | EventAttribute | EventCategory | EventCondition | EventNode | EventSource | EventStream | EventSubCondition | EventType | Eventtracker | FeedbackItem | FileMonitor | GenFolder | GenItem | GenKPI | GenericEventBuffer | GenericTimeSeriesBuffer | HealthMonitor | HistoryController | HistoryExporter | HistorySinkItem | HistorySupervisor | HistoryTransportManager | HistoryTransporter | HolderItem | ITLogAnalyzer | ITLogConfigurator | ITLogGroup | InternalEventStream | IoItem | IoItemGroup | IoNode | IoProperty | ItemConfigJsonViewer | ItemConfigScriptManager | ItemConfigStateChanges | ItemConfigTablePropertyGrid | KPIBookmark | KPIDashboard | KPIEmbeddedContent | KPIGroup | KPIInstance | KPIProfile | KPIProfileGroup | KPIServer | KPITable | KPIWidget | LinkItem | MessageBroker | MessageConfiguration | MessageProcessor | OpcUaTcpServer | OpcUaTcpServerEndpoint | Parameter | PerformanceFolder | PerformanceIndex | Plant | PlantCompound | ProcessCell | Profile | RedItem | RedStream | Relay | RemoteServiceGroup | ReportGenerator | ReportItem | Root | Rule | RuleNode | SchedulerItem | ScriptEvents | SecurityPerimeter | Server | ServerEventTypeProperty | ServerEventTypes | ServerForwardedEventType | ServerTypes | Site | StandardReport | StoredCredential | StoredCredentialsGroup | System | TPMNotScheduled | TPMOEEAvailabilityIndex | TPMOEEEquipmentMonitor | TPMOEEEquipmentStops | TPMOEEIndex | TPMOEEPerformanceIndex | TPMOEEProductionRuns | TPMOEEQualityIndex | TPMOEETimeValue | TPMPresetConfiguration | TPMShiftConfiguration | TPMSiteConfiguration | TPMStopReasonConfiguration | TPMTEEPIndex | TPMUnscheduled | TPMYearConfiguration | TableHolder | TemplateNode | TextualState | TimezoneAndAvailabilityTracker | UaEventTypeAttribute | UaEventTypeNode | UaServerNode | UaTypeNode | Unit | User | UserGroup | Variable | VariableGroup | WebAPISecurityAdfs | WebAPIServer

Attributes

Name Tooltip
PROP_CONFIGURABLE The property is configurable and can be changed with DataStudio and the various inmation APIs.
PROP_VISIBLE The property is visible in DataStudio and can be read by the inmation APIs.
PROP_DETECTABLE Property is detectable by system-driven server endpoint investigation.
PROP_MANDATORY The property is a mandatory field, that means an input is necessary.
PROP_USER_TAG This property is the user modifiable object or tag name.

Capabilities

Name Description
TranslationTable The user will be able to provide a translation list for the content of this property, which will be reflected on User Interfaces

Examples

Read from or write to the ObjectName property.

  • Lua

  • C#

-- Read from the ObjectName
syslib.getvalue("<OBJECT FULL PATH>.ObjectName")

-- Write to the ObjectName
syslib.setvalue("<OBJECT FULL PATH>.ObjectName", "new value")
TcpConfig tcpcfg = new TcpConfig() { HostNameOrIp = "localhost", Port = 6512 };
SecurityCredentials sc = new SecurityCredentials() { ProfileName = "<username>", Password = "<password>" };
StatelessInterface sli = new StatelessInterface(tcpcfg);

// Read from the ObjectName
Result result = sli.ReadValue(sc, new ReadItem("<OBJECT FULL PATH>.ObjectName"));
// Write to the ObjectName
Result result = sli.WriteValue(sc, new WriteItem("new value", "<OBJECT FULL PATH>.ObjectName"));