Difference between revisions of "Load Account"

From PC2wiki
Jump to: navigation, search
m (added a bit more detail on the load accounts process)
m (Reworded "Steps" for readability)
Line 1: Line 1:
The '''Load''' button (on the Admin ConfigureContest>Accounts tab) loads/overwrites [[account]] information from a text file.  It can be used to load initial account information, or to update/alter account information already loaded into the system either via a previous Load Account operation or by some other means (for example, via YAML load files).
+
The '''Load''' button (on the Admin ConfigureContest>Accounts tab) loads or updates (overwrites) [[account]] information from a text file.  It can be used to load initial account information, or to update/alter account information already loaded into the system either via a previous Load Account operation or by some other means (for example, via YAML load files).
  
 
==Location==
 
==Location==
Line 6: Line 6:
 
==Steps==
 
==Steps==
  
# User creates a load accounts file (the "Save" button on the Accounts tab can be used to create a file containing the current account information).
+
# Generate [[account]]s (this can be done either with [[Generate Accounts]] or via YAML loading at startup).
# User uses [[Generate Accounts]] to generate [[account]]s
+
# Create a ''load accounts'' text file following the required format shown below.  (Note: the "Save" button on the Accounts tab can be used to create a file containing the current account information, which can then be edited as needed; or, simply create a new text file).
# On the Admin, user clicks Load button and is presented with the [[Review Accounts Loading]] screen.  This screen displays the changes which are about to be applied to accounts.
+
# Click the '''Load''' button (on the Admin ConfigureContest>Accounts tab) and select the ''load accounts'' file.  This will display a [[Review Accounts Loading]] screen which displays the changes which are about to be applied to accounts; fields to be changed are marked with an asterisk.
 
# Click Accept button to apply the changes.
 
# Click Accept button to apply the changes.
  

Revision as of 11:31, 10 November 2018

The Load button (on the Admin ConfigureContest>Accounts tab) loads or updates (overwrites) account information from a text file. It can be used to load initial account information, or to update/alter account information already loaded into the system either via a previous Load Account operation or by some other means (for example, via YAML load files).

Location

Administrator module, Accounts Tab, Load button

Steps

  1. Generate accounts (this can be done either with Generate Accounts or via YAML loading at startup).
  2. Create a load accounts text file following the required format shown below. (Note: the "Save" button on the Accounts tab can be used to create a file containing the current account information, which can then be edited as needed; or, simply create a new text file).
  3. Click the Load button (on the Admin ConfigureContest>Accounts tab) and select the load accounts file. This will display a Review Accounts Loading screen which displays the changes which are about to be applied to accounts; fields to be changed are marked with an asterisk.
  4. Click Accept button to apply the changes.

Load Accounts File format (Version 9)

In Version 9 the load account file has been made more flexible, in Version 8 the format was fixed and had 4 fields (team #, display name, active and password) and the fields were pipe "|" delimited, see below for more details and an example.

In Version 9 the field delimiter has changed to a Tab character, a number of fields have been added and the order of the fields is determined by the new required first line of the file.

The first line of the Load Account file is a list of fields (columns) separated by tabs. The list of field names are case-insensitive.

The remaining lines of the file should be the values corresponding to the fields listed on the first line.

Lines starting with # are considered comments (ignored)

Required Columns

If any of these columns are not present on the first line a error message will be displayed.

Name Description Example
site site number 4
account description of account name (short) team5

Optional Columns

Name Description Example
password password for account foobar12
group Group name associated with account North Site
displayname Name to be displayed on scoreboard CSUS Hornets
permdisplay Account displayed on scoreboard true or false
alias Alias name to be displayed for the judges Alias 54
permlogin Account permitted to login true or false
permpassword Account allowed to change their password true or false
externalid same as group CSUS Hornets
longschoolname Institution Name (long) University of Virginia
shortschoolname Institution Name (short)) U Virginia
countrycode Country Code string ISO 3166-1 alpha-3 USA

Sample Account Load file

site	account	password	displayname
1	team1	passone	Team One

Load Account (Version 8)

Version 8 load file was limited to importing team information. Version 8 load only loaded account information for the current site.

The field delimiter is a vertical bar, not a tab.

Required Columns

Name Description Example
Team Number Team account number 4
Display Name description of account name (short) team5
Active whether account shown on board true or false
Password password for account foobar12

Example File

1|Number 1|true|pass1
2|Team Number 2|true|myPass
3|My School Name|false|

See Also