Skip to content

Upgrade Benefits

Ross Scroggs edited this page Dec 30, 2022 · 15 revisions

Upgrade Benefits

Configuration

GAMADV-XTD3 uses a configuration file, gam.cfg, to store the values of the various environment variables and signal files used by earlier versions of GAM. Configuration files client_secrets.json, oauth2.txt, oauth2service.json and extra_args.txt are moved to a version independent location. This should simplify upgrading GAM versions in the future. Additionally, if you support multiple clients/domains or have multiple users running GAM, gam.cfg lets you easily manage your configuration.

See: gam.cfg

Syntax Checking

GAMADV-XTD3 produces better error messages when syntax errors are found on the command line.

API error checking

In GAM, most API calls are made without error handling; if an API call fails for a particular item and the command was an operation on multiple items, the items after the failing item are not processed. The GAM solution is to have you produce a CSV file containing the items you want to process; as each item is an independent excution, API failures for some items do not affect other items. Capturing meaningful output from the CSV execution is hard and you have to create the CSV file as a separate step.

In GAMADV-XTD3, every API call is made with error handling; if an API call fails, a message is output and execution continues with additional items if possible.

Batch files

GAM uses multiprocessing for processing batch files and CSV files; this offers better performance than using threads. Unfortunately, one multiprocess subprocess can not create another subprocess; this prevents using gam csv commands inside GAM batch files.

GAMADV-XTD3 supports two commands for processing batch files, batch and tbatch. gam batch uses multiprocessing and gam tbatch uses threads. If you have a batch file that contains gam csv commands, gam tbatch can successfuly process the batch file.

See: Bulk Processing

CSV processing redirects

With GAM, if you want to process a CSV file and capture the output, you do one of the following:

gam csv File.csv gam <Command> > File.out 2> File.err
gam csv File.csv gam <Command> > File.out 2>&1

Multiple processes are writing to File.out(.err) simultaneously resulting in interleaved output that can be hard to read.

With GAMADV-XTD3, you can capture the output from the multiple processes such that all of the output from each process is contiguous.

gam redirect stdout ./File.out multiprocess redirect stderr ./File.err multiprocess csv File.csv gam <Command>
gam redirect stdout ./File.out multiprocess redirect stderr stderr csv File.csv gam <Command>

You can choose to have GAMADV-XTD3 bracket the output from each process with lines that show the command being executed.

gam config show_multiprocess_info true redirect stdout ./File.out multiprocess redirect stderr ./File.err multiprocess csv File.csv gam <Command>
gam config show_multiprocess_info true redirect stdout ./File.out multiprocess redirect stderr stderr csv File.csv gam <Command>

See: Meta Commands and File Redirection

Data selection

GAMADV-XTD3 has many more ways to specify collections of ChromeOS devices, Users and other items.

See: Collections of ChromeOS Devices

See: Collections of Users

See: Collections of Items

Specifying Google Drive files

GAM specifies drive files in different ways based on the command.

GAMADV-XTD3 has a consistent way of specifying Google Drive files for all commands.

See: Drive File Selection

Uploading CSV files from gam print commands to Google Drive

GAM allows no options when you use the todrive option with a gam print command; the file is always uploaded with a fixed name to the root folder of Google Drive for the Google Admin user named in oauth2.txt.

GAMADV-XTD3 allows you to specify the name, location and user for files uploaded with todrive; you can also save a local copy of the file.

See: Todrive

Calendars

GAM can manage the list of calendars a user can view; GAMADV-XTD3 can also create, modify and remove calendars.

GAM can add and delete events; GAMADV-XTD3 can also update, move, show and print events.

GAM can add, update, delete and show calendar ACLs; GAMADV-XTD3 can also get ACLs for a single calendar and print a CSV file of calendar ACLs.

See: Calendars - Access, Calendars - Events

See: Users - Calendars - List

See: Users - Calendars

See: Users - Calendars - Events

See: Users - Calendars - Transfer

Contacts

GAMADV-XTD3 supports domain shared contacts and user contacts.

See: Domain Shared Contacts

See: Users - People - Contacts & Profiles

Courses

When updating a course, GAM can only add/delete a single alias; GAMADV-XTD3 can add/delete multiple aliases.

When updating a course's membership, GAM can only add/delete a single student/teacher; GAMADV-XTD3 can add/delete multiple students/teachers.

When creating/updating courses, GAMADV-XTD3 can copy settings from another course.

See: Courses

Data Studio

GAMADV-XTD3 supports commands to display Data Studio assets and display/manage Data Studio permissions

See: Users - Data Studio

Drive File Copy and Move

GAMADV-XTD3 supports advanced file/folder copying/moving

See: Users - Drive - Copy/Move

Drive File Orphans

GAMADV-XTD3 allows collecting a user's orphaned files.

See: Users - Drive - Orphans

Drive File Ownership

GAMADV-XTD3 allows transferring ownership of selected folders of a source user to a target user.

GAMADV-XTD3 allows claiming ownership of of selected folders to which the user has access.

See: Users - Drive - Ownership

Drive File Revisions

GAMADV-XTD3 can manage drive file revisions.

Drive File Transfer

GAMADV-XTD3 has more capabilites for transferring the Google Drive of a source user to a target user.

See: Users - Drive - Transfer

See: Users - Drive - Revisions

Send email messages

GAMADV-XTD3 can send email messages.

See: Send Email

Forms

GAMADV-XTD3 supports commands to manage and display Google Forms.

See: Users - Forms

Gmail

GAMADV-XTD3 has commands for displaying Gmail messages.

GAMADV-XTD3 has commands for forwarding Gmail messages.

See: Users - Gmail - Messages/Threads

Groups

GAMADV-XTD3 allows selecting fields with info group. The output is much easier to read.

When creating/updating groups, GAMADV-XTD3 can copy settings from another group.

See: Groups

GAMADV-XTD3 has a more powerful print group-members command.

GAMADV-XTD3 has a more powerful ways of specifying changes to group membership.

See: Groups Membership

GAMADV-XTD3 has commands to display/manage a user's group membership.

See: Users - Group Membership

Keep

GAMADV-XTD3 supports commands to manage and display Google Keep notes.

See: Users - Keep

Organizational Units

GAMADV-XTD3 supports updating multiple org units in a single command.

See: Organizational Units

Resource Calendars

GAMADV-XTD3 supports managing resource calendar ACLs.

See: Resource Calendars

Shared Drives

GAMADV-XTD3 has more powerful commands for managing Shared Drives.

See: Shared Drives

See: Users - Shared Drives

Spreadsheets

GAMADV-XTD3 can manipulate Google Sheets.

See: Users - Spreadsheets

Tasks

GAMADV-XTD3 supports commands to manage and display Google Tasks.

See: Users - Tasks

Update History

Installation

Configuration

Notes and Information

Definitions

Command Processing

Collections

Client Access

Special Service Account Access

Service Account Access

Clone this wiki locally