Using format.file

The format.file select clauses are available to more efficiently manage on-demand synchronization.

When working with distributed file stores, you must be able to identify which of several locations holds up-to-date versions of a particular file checked into a given business object. The file.format select clauses shown below are available to more efficiently manage on-demand synchronization. Using the print bus TNR select print bus TNR select command, you can find all locations that hold up-to-date versions of a particular file to sync files using a specific location.

For example, suppose that you have three locations over a WAN and a sync needs to happen to one location because a user is requesting the file there. You can force a sync from the “nearest” synced location, that is, the location from which the traffic is fastest.

  • format.file.locations

    Finds locations that are in the current user’s preferred sites and are synchronized, and returns the first of them. If no locations satisfy both conditions, returns the first synchronized one.

  • format.file.synchronized

    Returns all locations holding synchronized versions of the checked in file or files, regardless of user preference.

  • format.file.obsolete

    Returns all locations holding a copy of the file that has been marked as obsolete (needing synchronization), regardless of user preference.

  • format.file.modified

    Returns all files of the specified format that were modified and checked in at a particular date.

For both format.file.originated and format.file.modified subselects:

  • If the filename is omitted, all files of the specified format are returned.
  • If both the format and filename are omitted, all files in all formats are returned.
  • If the format is omitted but the filename is specified, all files matching the filename are returned regardless of format.

When usingformat.file [FILENAME].*, you can use either of the following formats for the filename:

  • The complete host:/directory/filename.ext from which it was last checked in.
  • Just the filename(FILENAME.EXT), which must be unique within this object/format. This makes the extraction of data specific to a single file much easier.