Deprecated API
Contents
- Terminally Deprecated
- Interfaces
- Classes
- Enum Classes
- Exception Classes
- Record Classes
- Fields
- Methods
- Constructors
- Enum Constants
-
Terminally Deprecated ElementsElementDescriptionThis format is included in 2027.2 for backwards compatibility, but will be removed in 2028.2retained solely so pre-2027 single-IdP configs can still be deserialized; new configs are written to
GlobalProps.idpsviaGlobalProps.setIdps(List).this parked a dedicated native thread for the work's entire active life, risking native-thread exhaustion when many steps blocked concurrently. UseStepController.executeUntilComplete(PausableFutureStepWork), which is callback-driven and holds no thread. The controller implementation now accepts only aPausableFutureStepWorkhere and throwsUnsupportedOperationExceptionfor any otherConsumer(since arbitrary work can no longer be run without parking a thread), so this is source/binary compatible but not behavior compatible for callers that passed a differentConsumer. It has no first-party callers.this was only meaningful for the parked-threadStepController.execute(Consumer)model and has no first-party callers. Retained for API compatibility.legacy entry point for the old parked-thread model, where the controller ran this on a dedicated thread that blocked on a monitor. The controller now drives completion off the per-episode exit signal (seePausableFutureStepWork.rearm()) viaStepController.executeUntilComplete(PausableFutureStepWork), so this is no longer invoked. Retained as a no-op only to preserve theConsumercontract.
-
Deprecated InterfacesInterfaceDescriptionno reason originally specifiedTotally unused. Cannot delete due to serialization backwards compatability.use
Historiandirectly with a query engine.useAggregateId.useAggregatedQueryOptionsorRawQueryOptions.This class was used to provide remote tag access to 7.9 gateways. But 7.9 is no longer allowed to connect to 8.0 and later gateways. But there is a single getProviders() function that is still used by 8.1 gateways to retrieve a list of available tag providers on a remote gateway (this is used in the remote tag provider setup wizard, specifically the RemoteTagProviderType.RemoteTagProviderChoicePanel class). So a skeleton version of this service will need to remain available just for that function.use the HistorianQueryEnginepipeline.use the HistorianQueryEnginepipeline.use the HistorianQueryEnginepipeline.useAggregateFunction.com.inductiveautomation.ignition.gateway.sqltags.history.query.processing.AggregationFunctionFactoryuse the aggregate catalog.use the HistorianQueryEnginepipeline.since 8.3.0
-
Deprecated ClassesClassDescriptionno reason originally specifiedno reason originally specifiedTHIS CLASS IS DEPRECATED. This is a trivial subclass of com.inductiveautomation.factorypmi.application.components.util.ColorState, simply so that applications saved before this change will still load, because in their XML the class is saved by string.THIS CLASS IS DEPRECATED. This is a trivial subclass of com.inductiveautomation.factorypmi.application.components.util.ColorState, simply so that applications saved before this change will still load, because in their XML the class is saved by string.Use VisionModule instead.for maintaining existing historians only. New historians should implement
Historiandirectly with aQueryEngineandStorageEngine.Since 8.3.0; create aTaskif you want platform managed UI for an asynchronous task.Since 8.3.0; create aTaskif you want platform managed UI for an asynchronous task.No longer needed since Java 5This class should only be used for special migration related purposes only.retained purely for pre-8.3 EAM agent backwards-compatibility.This is the older shared library concept ofapp.*user scripts; prefer the modernModuleLibraryalternative.Since 8.3.0, only in place for backwards compatibility.Since 8.3.0, only in place for backwards compatibility.useAggregatedQueryOptionsorRawQueryOptions.Use com.inductiveautomation.ignition.client.util.action.BaseAction instead.Use com.inductiveautomation.ignition.client.util.action.StateChangeAction instead.in favor ofUnderlineBorderMoved to package com.inductiveautomation.ignition.client.util in Ignition 8.0.5use the HistorianQueryEnginepipeline.use the HistorianQueryEnginepipeline.use the HistorianQueryEnginepipeline.use the HistorianQueryEnginepipeline.use the HistorianQueryEnginepipeline.use the HistorianQueryEnginepipeline.use the aggregate catalog.use the state held insideAggregateFunctionaccumulators.since 8.3.since 8.3.since 8.3.
-
Deprecated Enum ClassesEnum ClassDescriptionuse
AggregateIdwith theStandardAggregatescatalog.
-
Deprecated Exception ClassesException ClassDescription
-
Deprecated Record Classes
-
Deprecated FieldsFieldDescriptionuse
TPC.Systems.OPCinstead.This is the old security scheme. Use COMPONENT_PERMISSIONS instead.Since 8.3.0, property filters are no longer used in the Designer.Since 8.3.0, property filters are no longer used in the Designer.
-
Deprecated MethodsMethodDescriptionUse Add() method instead.no reason originally specifiedno reason originally specifiedno reason originally specifiedno reason originally specifiedno reason originally specifiedno reason originally specifiedno reason originally specifiedno reason originally specifiedno reason originally specifiedno reason originally specifiedno reason originally specifiedno reason originally specifiedno reason originally specifiedno reason originally specifiedno reason originally specifiedno reason originally specifiedno reason originally specifiedno reason originally specifiedno reason originally specifiedUse setQValue() instead. Kept for serialization.com.inductiveautomation.factorypmi.application.binding.action.ActionAdapter.setListenerProxy
(Object) Kept for backwards compatibility. UseNamedQueryAdapter.getPushPath2()Kept for backwards compatibility. UseNamedQueryAdapter.setPushPath2(String)Kept for serializationUse PropertyNode.getQValue().getValue() insteadin favor ofTemplateInfo.setSerializedBytes(byte[], SerializationEncoding)where an encoding is supplied, but still used by 7.9 resourcescom.inductiveautomation.factorypmi.application.model.WindowCache.getWindowCompressedSize(ResourceId) useWindowCache.getWindowSize(ResourceId)insteadin favor ofWindowInfo.setSerializedCode(byte[], SerializationEncoding)where an encoding is supplied. still used by 7.9 resourcesMoved to SystemUtilitiescom.inductiveautomation.factorypmi.application.script.builtin.WindowToNavAdapter.closeWindow(String) no longer used, seeAbstractClientTag.setTypeAndValue(DataType, QualifiedValue).com.inductiveautomation.historian.common.protobuf.ResultWriterOptionsProto.ObjectTypePB.valueOf(int) useImageLoader.loadImage(String, Dimension)instead.Not used anymore now that scaling is done by the ImageLoaderAs of 8.3.0, useAbstractDBUtilities.clearQueryCache(PyObject[], String[])instead.As of 8.3.0, useAbstractDBUtilities.clearQueryCache(PyObject[], String[])instead.com.inductiveautomation.ignition.client.script.ClientDBUtilities.runNamedQuery(PyObject[], String[]) As of 8.3.0, useAbstractDBUtilities.execQuery(PyObject[], String[])orAbstractDBUtilities.execUpdate(PyObject[], String[])instead.As of 8.3.0, useAbstractDBUtilities.execUpdateAsync(PyObject[], String[])instead.as the string name was expected to be an alarm property. This class is now used more generally, so * the Property based version should be used.as the string name was expected to be an alarm property. This class is now used more generally, so the Property based version should be used.Deprecated as of 7.6, in which function factories are provided by the scope contexts so that modules can extend the scripting language. This function factory is the base of those, but should not be used directly.As of 2027.2.0, preferBasicTranslationPackage.addKey(String)Since 2027.2.0.here for serialization compatibility.retained solely so pre-2027 single-IdP configs can still be deserialized; new configs are written toGlobalProps.idpsviaGlobalProps.setIdps(List).com.inductiveautomation.ignition.common.protocolbuffers.AlarmEnumsProto.AlarmPriorityPB.valueOf(int) com.inductiveautomation.ignition.common.protocolbuffers.SqlTagEnumsProto.AlertAckModePB.valueOf(int) com.inductiveautomation.ignition.common.protocolbuffers.SqlTagEnumsProto.DeadbandModePB.valueOf(int) com.inductiveautomation.ignition.common.protocolbuffers.SqlTagEnumsProto.ReturnFormatPB.valueOf(int) com.inductiveautomation.ignition.common.protocolbuffers.SqlTagEnumsProto.SQLQueryTypePB.valueOf(int) com.inductiveautomation.ignition.common.protocolbuffers.TagEnumsProto.CollisionPolicyPB.valueOf(int) com.inductiveautomation.ignition.common.rpc.proto.gen.StreamingDatasetPb.Data.ValueCase.valueOf(int) com.inductiveautomation.ignition.common.rpc.proto.gen.WebsocketProtoMessage.MessageCase.valueOf(int) Use DatasetUtilities.toCSVJava()Usesystem.date.formatinstead.UseexecQueryorAbstractDBUtilities.runPrepQuery(PyObject[], String[])for improved performance and security.UseexecQueryorAbstractDBUtilities.runScalarPrepQuery(PyObject[], String[])for improved performance and security.UseexecUpdateorAbstractDBUtilities.runPrepUpdate(PyObject[], String[])for improved performance and security.use DatasetUtilities.toDataSet()Use DatasetUtilities.toDataSet()Use DatasetUtilities.toPyDataSet()As of 8.3, use new system.historian.browse() instead.As of 8.3, use new system.historian.deleteAnnotations() instead.As of 8.3, use new system.historian.queryAnnotations() instead.As of 8.3, use new system.historian.queryAggregatedPoints() instead.As of 8.3, use new system.historian.queryAggregatedPoints() instead.As of 8.3, use new system.historian.queryRawPoints() instead.As of 8.3, use new system.historian.storeAnnotations() instead.As of 8.3, use new system.historian.storeDataPoints() instead.PyDataset implements Dataset, so there's no need for this reverse conversion method anymore.The word is 'Dataset', not 'DataSet', but backwards compatibility means this must stay forever.PyDatasets are no longer necessary, becauseDatasetPyAdapterautomatically wrapsDatasetobjects inPyDatasetobjects.UseexecQueryorAbstractIALabsDatasourceFunctions.runSFPrepUpdate(PyObject[], String[])for improved performance and security.use readAll() instead. Implementation needs to be left here for backwards compatibility.in 7.9. Implementation needs to be left here for backwards compatibility.use readAll() instead. Implementation needs to be left here for backwards compatibility.com.inductiveautomation.ignition.common.script.builtin.LegacyTagUtilities.writeToTag(String, Object) com.inductiveautomation.ignition.common.script.ScriptConfig.setTagChangeScripts(Map<String, String>) System functions should be added using one of the 'modern' addScriptModule alternatives.PreferModuleLibrary's static validation methods - you can useScriptManager.getModules()to retrieve this manager's loaded modules to check against.use getNonSubIndexPath going forward.This functionality is deprecated. You can continue to add search paths for the backwards compatibility of de-serializing, but new serialized code will not contain the shortened versions of the classnames.Prefer the overload that accepts aLoggerExinstead.Prefer the overload that accepts aLoggerExinstead.UseXMLSerializer.serializeXML()instead.useXMLSerializer.serializeXML(OutputStream, String)instead.useXMLSerializer.serializeXML(OutputStream, String)instead.useXMLSerializer.serializeXML(Writer, String)instead.useXMLSerializer.serializeXML(Writer, String)instead.useXMLSerializer.serializeXMLAndGZip()instead.useXMLSerializer.serializeXMLAndGZip(Object)instead.Replaced byParameterChoiceTable.setParams(String, Map)Replaced byParameterChoiceTable.update(String, NamedQuery)Since Ignition 8.1.34, in favor of the more appropriateresourcePathsignature. To be removed in 8.3.0.Since Ignition 8.1.34, in favor of the more appropriateresourcePathsignature. To be removed in 8.3.0.Since Ignition 8.1.34, in favor of the more appropriateresourcePathsignature. To be removed in 8.3.0.as of 8.0.5 useClipboardUtil.doCopyTransferableToClipboard(Transferable)as of 8.0.5 useClipboardUtil.doPasteTransferableFromClipboard()as of 8.0.5 useClipboardUtil.doPasteTransferableFromClipboard(DataFlavor)as of 8.0.5 useClipboardUtil.isDataFlavorAvailable(DataFlavor)retained becauseCookieStorestill declares it;NoOpCookieStore.clearExpired(Instant)is the supported entry point and is overridden separately so this deprecated path is never relied upon.Used to send "legacy" responses for requests that are older than v4.Used to send responses for requests that still need to be served for launcherAPIVersion 4 requestsUse TagProviderServiceImpl2#getProviders() insteadthis method is for providing the legacy Perspective project prop ID to the perspective project property panel in the Designer and is not intended for any other use case. avoid using this method as it may be removed in the future.Replaced by getEventManager. To be removed in 8.2.0since 8.3.0, replaced byDataSourceConfig.setConfigObject(DataSourceConfigObject)this parked a dedicated native thread for the work's entire active life, risking native-thread exhaustion when many steps blocked concurrently. UseStepController.executeUntilComplete(PausableFutureStepWork), which is callback-driven and holds no thread. The controller implementation now accepts only aPausableFutureStepWorkhere and throwsUnsupportedOperationExceptionfor any otherConsumer(since arbitrary work can no longer be run without parking a thread), so this is source/binary compatible but not behavior compatible for callers that passed a differentConsumer. It has no first-party callers.this was only meaningful for the parked-threadStepController.execute(Consumer)model and has no first-party callers. Retained for API compatibility.legacy entry point for the old parked-thread model, where the controller ran this on a dedicated thread that blocked on a monitor. The controller now drives completion off the per-episode exit signal (seePausableFutureStepWork.rearm()) viaStepController.executeUntilComplete(PausableFutureStepWork), so this is no longer invoked. Retained as a no-op only to preserve theConsumercontract.com.inductiveautomation.sfc.rpc.proto.gen.ChartStatusProto.ChartStatusPbOrBuilder.getElementStatus()Use plural(String, String, String) instead
-
Deprecated ConstructorsConstructorDescriptionThis is the old object that was used for component security. ComponentPermissions is used now instead.Reserved for the Vision XML deserializer, which instantiates rules embedded in windows saved by earlier versions. Use
KeyHashRule.IDENTITYor the canonical constructor.Use DayOfWeekDescriptionBuilder(Options) instead.
-
Deprecated Enum ConstantsEnum ConstantDescriptionThis format is included in 2027.2 for backwards compatibility, but will be removed in 2028.2