gd_archivefiles

Stores a list of files with some metadata into an archive

Syntax

IDs = gd_archivefiles(filepaths, [metadata], [datagroupIDs])

Description

IDs = gd_archivefiles(filepaths, [metadata], [datagroupIDs]) takes a cell array of strings representing filepaths, and archives the files to a file store (specified in the ClientConfig.xml file). A unique identifier (ID) for each archived file is returned in a cell array which can be used to retrieve the files with gd_retrievefiles.

Input Arguments

The function optionally takes a metadata structure or a cell array of metadata structures. The metadata structure specifying some user defined information about the files at can be later queried with gd_query. The optional datagroupIDs is the ID of a datagroup or a cell array of datagroup ID that the files should be added to. A datagroup is used to group together a collection of files, variables and other datagroups, see gd_datagroup and gd_datagroupadd.

For more information about the metadata, see gd_archive.

Examples

Archive two files with no user defined metadata, and add them to datagroups dgId1 and dgId2 respectively.

IDs = gd_archivefiles({'C:\file.dat', 'C:\input.txt'},[], {'dgId1', 'dgId2'})

IDs =

'file_dat_c8227861-93ae-4daa-9472-1ad77f2ff2dc'

'input_txt_bcd1e2cf-605e-4e43-baa7-2842f9ce5617'

Archive two files that share the same user defined metadata, and give user1 and user2 READ access to them.

m.model.name = 'test_design';

m.iterations = 9000;

m.standard.comment = 'This is a test.';

m.access.users = {'user1','user2'};

gd_archivefiles({'C:\file.dat', 'C:\input.txt'}, m);

Archive two files with own user defined metadata (e.g. m1 and m2 contain the metadata for file.dat and config.txt respectively), and give users 'tim', 'sam', and group 'genie' READ access. Add these two files into the datagroup 'dg3'.

m1.model.name = 'test_design_1';

m1.iterations = 9000;

m1.standard.comment = 'Comment about file.dat.';

m1.access.users = {'tom','sam'};

m2.model.name = 'test_design_2';

m2.iterations = 5000;

m2.standard.comment = 'Comment about input.txt.';

m2.access.groups = {'genie'};

gd_archivefiles({'C:\file.dat', 'C:\input.txt'}, {m1, m2}, 'dgId3');

Notes

A valid proxy certificate is required to archive a file (see gd_createproxy from the Geodise Compute Toolbox).