Spreadsheet Structure

Administrator User Guide

Import and Export Utilities : Spreadsheet Data Format : Spreadsheet Structure

Spreadsheet Structure

Although the import utility is flexible and allows customisation of the spreadsheet, there is a convention that needs to be followed for the data to be valid.

The first column (column A in a sheet) of every row that contains data (except for comment lines) must contain a keyword. All keywords are case sensitive.


Keyword	Data Type
TEAM	Team
USER	User
AUTHUSER	Authenticated User
DATABASE	Database
COPYFOREIGN	Foreign Copy
FOREIGN	Foreign Include
EXTRACT	Extract
WORKEXTRACT	Working Extract
MDB	MDB
ACR	ACR
ACRGROUP	ACR Group
SCOPE	Scope
ROLE	Role
PEROP	Perop

A row can also be used as a comment row. If that is the case then first populated cell in the row needs to begin with hash character (#), it does not need to be a cell in column A in the Excel sheet.

If a row does not begin with a keyword and is not a comment line then it is invalid and the Import operation will not be successful.

The following table lists the cells of a Team row:


	Column	Values
A	Keyword	TEAM
B	Name	Name of the Team consisting only of letters (A-Z). Lowercase will be automatically changed to uppercase.
C	Description	Description of the Team.

The following table lists the cells of a User row:


	Column	Values
A	Keyword	USER
B	Name	Name of the User. Avoid the use of Spaces and the following characters '$', '*', '/', '@', '\|'.
C	Description	Description of the Team.
D	Security	Security setting for the User. Valid values are: 'General', 'Restricted', 'Free'.
E	Password	A password with a maximum of 15 characters plus 1 optional slash at the beginning. The slash is added automatically if not present.
F	Access Rights	The list of ACRs and ACR Groups assigned to this User. The list consists of names delimited with a space. The list may be empty.
G	Teams	The list of Teams to which the User belongs. The list consists of team names delimited with a space.

The following table lists the cells of an Authenticated User row:


	Column	Values
A	Keyword	AUTHUSER
B	Login name	Name of the NT user.
C	Default user	Name of a Default User.
D	Other users	Users valid for this login name. The list should consist of user names delimited with a space.

The following table lists the cells of a Database row:


	Column	Values
A	Keyword	DATABASE
B	Owning team	Name of Team owning the Database.
C	Name	Name of the Database.
D	Description	Description of the Database.
E	Type	Type of Database. Must be one of: DESI, PADD, CATA, PROP, DICT, ISOD, SCHE, MANU, NSEQ.
F	Claim Mode	Determines access mode and claim mode: EXPLICIT, IMPLICIT - for multiwrite databases OVERWRITE - for overwrite databases UPDATE - for update databases
G	Number	Database number. Leave blank for default. Databases with numbers between 7001 - 10000 and 250001 - 255000 are reserved for AVEVA therefore they are allowed but there will be a warning message during the import.

The following table lists the cells of a Foreign Copy row:


	Column	Values
A	Keyword	COPYFOREIGN
B	Foreign Project	A three letter project code of the foreign project from which the database should be copied.
C	Foreign Name	Full name of the database (including team name) from the foreign project to copy.
D	Foreign User	Name of a FREE user from the foreign project. If left blank it will be asked for interactively during import along with a password.
E	Foreign Password	Password for the FREE user specified in the previous cell. It is considered only if Foreign User is specified. If user is not specified then a password and username must be input during import.
F	Target Owning Team	Name of team in which the copy should be created.
G	Target Name	Name of the database being the newly created copy.

The following table lists the cells of a Foreign Include row:


	Column	Values
A	Keyword	FOREIGN
B	Foreign Project	A three letter project code of the foreign project from which the database should be included.
C	Foreign Name	Full name of the database (including team name) from the foreign project to include.
D	Foreign User	Name of a FREE user from the foreign project. If left blank it will be asked for interactively during import along with a password.
E	Foreign Password	Password for the FREE user specified in the previous cell. It is considered only if Foreign User is specified. If user is not specified then the password and username must be input during import.

The following table lists the cells of a Extract row:


	Column	Values
A	Keyword	EXTRACT
B	Owning Team	Name of team owning the Extract.
C	Name	Name of the Extract.
D	Description	Description of the Extract.
E	Parent	Name of Database or Extract being the parent of this Extract. Only MULTIWRITE databases can be extract parents.
F	Claim Mode	Specify EXPLICIT or IMPLICIT depending on claim mode of the extract.
G	Variant	Set to "Yes" for variant extracts. Set to "No" or leave blank for normal extracts.

The following table lists the cells of a Working Extract row:


	Column	Values
A	Keyword	WORKEXTRACT
B	Owning User	Name of the User that owns the Working Extract.
C	Description	Description of the Working Extract.
D	Parent	Name of Database or Extract being the parent of this Working Extract. Only MULTIWRITE databases can be extract parents.
E	Claim Mode	Specify EXPLICIT or IMPLICIT depending on claim mode of the extract.
F	Variant	Set to "Yes" for variant extracts. Set to "No" or leave blank for normal extracts.

Note:

Names for Working Extracts are generated automatically and do not need to be stored in an exported spreadsheet or imported for that reason.

The following table lists the cells of a MDB row:


	Column	Values
A	Keyword	MDB
B	Name	Name of the MDB.
C	Description	Description of the MDB.
D	Databases	List of current databases for this MDB. The list should consist of full database names delimited with a space.

The following table lists the cells of a ACR row:


	Column	Values
A	Keyword	ACR
B	Name	Name of the ACR.
C	Description	Description of the ACR.
D	Scope	Name of the Scope assigned to this ACR.
E	Role	Name of the Role assigned to this ACR.

The following table lists the cells of a ACR Group row:


	Column	Values
A	Keyword	ACRGROUP
B	Name	Name of the ACR Group.
C	Description	Description of the ACR Group.
D	ACRs	The list of ACRs contained in this Group. The list should consist of ACR names delimited a white space.

The following table lists the cells of a Scope row:


	Column	Values
A	Keyword	SCOPE
B	Name	Name of the Scope.
C	Description	Description of the Scope.
D	Selection	A valid scope selection. This is checked by the system when importing.

The following table lists the cells of a Role row:


	Column	Values
A	Keyword	ROLE
B	Name	Name of the Role.
C	Description	Description of the Role.

The following table lists the cells of a Perop row:


	Column	Values
A	Keyword	PEROP
B	Owner	Name of the Role in which this Perop should be created.
C	Name	Name of the Perop.
D	Element types	A space delimited list of element types to which this Perop is applied.
E	Qualifying condition	A PML expression that further restricts the set of elements affected.
F	OpCreate
G	OpModify
H	OpDelete	A list of allowed and denied operations in this Perop. Keywords are: GRANT - when operation is granted DENY - when operation is denied IGNORE - when operation is ignored (or you can leave the cell blank)
I	OpClaim
J	OpIssue
K	OpDrop
L	OpOutput
M	OpExport
N	OpCopy
O	Attributes	If Modify operation is allowed the list specifies attributes that can be modified.
P	Error Message	An appropriate message which will be output when a user is refused access to an element because of this Perop.

1974 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.