clientSpec object

Build 1501 on 14/Nov/2017  This topic last edited on: 21/Mar/2016, at 18:34

Here is a sample clientSpec object:

  <clientSpec name="MimoPC" host="mimo-pc" >

    <scopeRef>

      <keyVal>ClientSpec</keyVal>

    </scopeRef>

    <description>Client specification of MIMO-PC </description>

    <templateRef>

      <keyVal>Windows</keyVal>

    </templateRef>

    <folderRefs>

      <ref>

        <keyVal>/system</keyVal>

        <localPath>c:\temp</localPath>

      </ref>

    </folderRefs>

  </clientSpec>

The clientSpec has some general attributes:

name: uniquely identifies the clientSpec  object

description: general (optional) description of the clientSpec

scopeRef – reference to a configScope object, used to assign access permissions to the clientSpec.

These three attributes describe the client computer:

host: the name of the client computer (or its IP address)

templateRef: reference to the clientTemplate object to use when working with this client computer

folderRefs: references to GN4 system folders, specifying for each one the corresponding directory. In the example above there is one – the folder /system, that is mapped to the directory c:\temp on the client computer.

The folderRefs attribute is used to map system folders to client compute directories. When an object is copied to a local file, this mapping is used to compute where the local file should be located. For example an object in the folder

/system/users/mimo 

using the above mapping will be copied to a file in the directory:

c:\temp\users\mimo

Note that to compose the complete directory name the system uses the folder names separated by the character defined as  the pathSeparator in the clientTemplate.

It is possible to specify multiple mappings:

    . . .

    <folderRefs>

      <ref>

        <keyVal>/system/users</keyVal>

        <localPath>e:\local\users</localPath>

      </ref>

      <ref>

        <keyVal>/system/archive</keyVal>

        <localPath>e:\archive</localPath>

      </ref>

    </folderRefs>

    . . .

In this case, objects in the folder:

/system/users/mimo 

will be copied to files in the directory:

e:\local\users\ mimo

and objects in the folder:

/system/archive/2008/12/01

will be copied to files in the directory:

e:\archive\2008\12\01

It is possible (although not recommended) to specify mappings corresponding to sub-folders of other mappings:

    . . .

    <folderRefs>

      <ref>

        <keyVal>/system</keyVal>

        <localPath>c:\temp</localPath>

      </ref>

      <ref>

        <keyVal>/system/archive</keyVal>

        <localPath>e:\archive</localPath>

      </ref>

    </folderRefs>

    . . .

In such cases the system uses the most specific mapping it can find – in the example above objects in the folder:

/system/archive

and in any of its sub-folders will be copied to files under:

e:\archive

whereas objects in any other folder under:

 /system

will be copied to files under:

c:\temp