Version: 12
restore

Contents

Method

Set

ModuleStorage
LibraryCore
Action

Set or change the value of the named persistent storage table.

Parameters

Name (string): The name of the persistent storage table. Case is not significant.

Value (string): The table contents to be written to, or overwritten in, the named persistent storage table.

Return valuesName (string): The name of the new or updated persistent storage table.
Examples

A simple example.

@table = Agent.GetSummary();
Storage.Set(Name: "Agent_Summary.Oct2018", Value: @table);

The method overwrites whatever was previously in the table. If you want to accumulate data by appending, this shows an example of a task that would be run periodically to record who is logged on at that time. It also returns the accumulated data.

@loggedOnUsers = Users.GetLoggedOnUsers();
@newEntries = SELECT *, datetime("now") AS Timestamp FROM @loggedOnUsers;
@storageName = SELECT "LoggedInAudit" AS Name;
@found = Storage.Check(Name:@storageName);
IF (@found)
    @currentEntries = Storage.Get(Name:@storageName);
    @newEntries = @currentEntries + @newEntries;
ENDIF;
Storage.Set(Name:@storageName, Value:@newEntries);

Storage.Get(Name:@storageName);
Platforms
  • Windows
  • Linux
  • MacOS
  • Solaris Intel
  • Solaris Sparc
  • Android
Notes

This method can be used with the agent language's evaluate statement to abandon processing if the persistent storage table is not present.

See User Defined Persistent Storage page for guidance using persistent storage tables.

The following methods existing in the Agent Storage module:

  • Page:
    Storage.Check — Tests the existence of a user defined persistent storage table.
  • Page:
    Storage.Delete — Removes an existing user defined persistent storage table.
  • Page:
    Storage.Get — Indicate whether a persistent storage table of the specified name is present and return its contents if present.
  • Page:
    Storage.GetRemote — Retrieve the requested datum directly from the Platform central repository.
  • Page:
    Storage.Set — Set or change the value of the named persistent storage table.