×

Have You Seen Workflow Lately? Click here to check out all the new features in the latest version.

Supercharge your GE solution! Download a free trial of Proficy Operations Hub, CSense analytics, and more. Learn more about the Proficy 2024 releases, by signing up for one of our upcoming events.

Home
Service Interfaces
Workflow Methods
IArchiveManagement
IArchiveManagement allows you to create an archive file and select the data to include.
ArchiveData (IArchiveManagment)
Specifies the unused runtime data that you want to archive and creates an archive record when the call method runs.

Workflow Products Documentation

Service Interfaces
- Service Interfaces
- Workflow Methods
  - Workflow Methods
    Workflow provides a set of core service interfaces and call methods for you to use when creating a workflow. This section describes these core service interfaces and the associated call methods.
  - IArchiveManagement
    IArchiveManagement allows you to create an archive file and select the data to include.
    - ArchiveData (IArchiveManagment)
      Specifies the unused runtime data that you want to archive and creates an archive record when the call method runs.
  - IAuditTrail
    IAuditTrail allows you to write entries to the audit trail.
  - IDatabaseService
    IDatabaseService provides access to relational data, such as databases.
  - IDirectorySearch
    IDirectorySearch allows you to search the Directory of Resources for a set of resources based on a search query, or for a list of resources based on a resource class.
  - IEmailService
    You can use IEmailService to send emails as part of a workflow process.
  - IEquipment
    IEquipment allows you to read from and write to the Equipment model.
  - IEquipmentConfig
    IEquipmentConfig provides methods for configuring the equipment model.
  - IEquipmentHistorian
    IEquipmentHistorian allows you to read from and write to Historian tags.
  - IEvent
    IEventManager allows you to read from the Event model and to create an event subscription for a specific event resource.
  - IExtensionData
    IExtensionData allows you to access temporary workflow data that was previously stored in a system repository. This stored data can be associated with both internal and external systems.
  - IITService
    IITService allows you to read from the Proficy System model.
  - ILicense
    The ILicense service method provides access to active licensing information.
  - IMaterial
    IMaterial allows you to read from and write to the Material model.
  - IOpcClient
    IOpcClient allows you to read from the OPC Client model.
  - IOpcUa
    IOpcUa allows you to read from the OPC UA model.
  - IPersonnel
    IPersonnel allows you to read from and write to the Personnel model.
  - IProductionModel
    IProductionModel allows you to read from or write to the Production model.
  - IProductionReport
    IProductionReport allows you to read from the Production model.
  - IProductionRuntime
    The IProductionRuntime service interface relates to production oversight.
  - IProficyHistorian
    IProficyHistorian allows you to manage Historian servers, including reading from and writing to Historian collectors and tags.
  - IPropertyGroup
    IPropertyGroup allows you to read from or write to the properties of a resource.
  - IResourceLinking
    IResourceLinking allows you to work with resource links for all types of resources. You can start, edit, end, and query links between resources in your system.
- iFix Service Provider

ArchiveData (IArchiveManagment)

Specifies the unused runtime data that you want to archive and creates an archive record when the call method runs.

Inputs	Data Type	Description
ArchiveDescription	String	Specifies a description for the archive file.
ArchiveEndTime	DateTime	Specifies the age limit for the data to be included in the archive file. That is, only unused data that is older than the specified end time will be included in the archive.
ArchiveName	String	Specifies a display name for the archive file.
Events	Boolean	Indicates whether historical event occurrence data should be archived. The default is True.
Material	Boolean	Indicates whether closed material lots and their child sublots should be archived. The default is True.
Production	Boolean	Indicates whether closed work requests and related data should be archived. The default is True.
Regulatory Compliance	Boolean	Indicates whether audit and electronic signature records should be archived. The default is True.
Resource Links	Boolean	Indicates whether user-created references should be archived. The default is True.
Workflow	Boolean	Indicates whether workflow tracking data should be archived. The default is True.

Outputs	Description
ArchiveResponse		Returns the archive result, including whether the archive failed or succeeded, and errors and messages.