ObjectDescription Property

General info

Label

Object Description

Description

This is the user-modifiable object description. This text overrides the description which has been supplied by the external system.

Data type

String

Type

Regular

Code

198

Symbolic name

MODEL_PROP_OBJECTDESCRIPTION

Lua access code

syslib.model.properties.ObjectDescription

Available since

1.0

Parent classes

ActionItem | AdvancedTrend | AlarmGenerator | AliasItem | AnalogMeasurement | Area | BPRPublisher | BatchEquipmentPhaseDefinition | BatchEquipmentStepDefinition | BatchOperationDefinition | BatchTracker | BatchTrackerBackfill | BinaryState | CalculatedValue | Chart | CloudSinkItem | Connector | ControlModule | Core | CoreServiceInstance | CustomBigTableDataStore | CustomEventDataStore | CustomFileDataStore | 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 | FileSink | FileSource | GenClass | GenFolder | GenItem | GenKPI | GenericEventBuffer | GenericTimeSeriesBuffer | HealthMonitor | HistoryController | HistoryExporter | HistoryItemGroup | HistorySinkItem | HistorySubscriber | HistorySubscriberEventBackfiller | HistorySubscriberEventHandler | HistorySupervisor | HistoryTransportManager | HistoryTransportManagerBucketedConfiguration | HistoryTransporter | HolderItem | IP21Server | ITLogAnalyzer | ITLogConfigurator | ITLogGroup | InternalEventStream | IoItem | IoItemGroup | IoNode | IoProperty | IoTableHolder | 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 | RedundancyServiceGroup | Relay | RemoteServiceGroup | ReportGenerator | ReportItem | Rule | RuleNode | SchedulerItem | ScriptEvents | ScriptProfile | ScriptProfileGroup | SecurityPerimeter | Server | ServerEventTypeProperty | ServerEventTypes | ServerForwardedEventType | ServerTypes | Site | StoredCredential | StoredCredentialsGroup | System | TPMNotScheduled | TPMOEEAggregator | TPMOEEAvailabilityIndex | TPMOEEEquipmentMonitor | TPMOEEEquipmentStops | TPMOEEGenericIndex | TPMOEEIndex | TPMOEEPerformanceIndex | TPMOEEProductionRuns | TPMOEEQualityIndex | TPMOEERecalculator | TPMOEETimeValue | TPMPresetConfiguration | TPMShiftConfiguration | TPMSiteConfiguration | TPMStopReasonConfiguration | TPMTEEPIndex | TPMUnscheduled | TPMYearConfiguration | TableHolder | TemplateNode | TextualState | TimezoneAndAvailabilityTracker | Unit | User | UserGroup | VariableGroup | VirtualDataSource | 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.

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 ObjectDescription property.

  • Lua

  • C#

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

-- Write to the ObjectDescription
syslib.setvalue("<OBJECT FULL PATH>.SinkConfiguration.ObjectDescription", "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 ObjectDescription
Result result = sli.ReadValue(sc, new ReadItem("<OBJECT FULL PATH>.SinkConfiguration.ObjectDescription"));
// Write to the ObjectDescription
Result result = sli.WriteValue(sc, new WriteItem("new value", "<OBJECT FULL PATH>.SinkConfiguration.ObjectDescription"));