Tidbit CLI arguments

Parameters Description and comments

Parameter	Value Required	Default	Short Description	Description	Comments
-l	yes	1000	Load Factor	Load Factor is used to modify total number of records that will be created for each module. The ratio between Accounts and the other modules is fixed in install_config.php, so the loadFactor determines the number of each type of module to create.	One of the most useful parameter to check, when your are going to generate large number of records for SugarCRM instance
-u	yes	100	Number of Users	The number of Users to generate. If not specified, but loadFactor is, number of users is 1/10th of loadFactor.	Also affects on Number of Teams that are going to be generated
-o	no	false	Obliterate Mode	Turn Obliterate Mode on. All existing records and relationships in the tables populated by Tidbit script will be emptied. This includes any custom data in those tables. The administrator account will not be deleted.	Obliterate mode is recommended when testing Tidbit and play around custom data generation or extending basic functionality
-c	no	false	Cleaning Mode	Turn Clean Mode on. All existing demo data will be removed. No Data created within the app will be affected and the administrator account will not be deleted. Has no effect if Obliterate Mode is enabled.	Cleaning mode is used to removed data, that was previously generated with Tidbit before populating new one
-t	no	false	Turbo Mode	Turn Turbo Mode on. Records are produced in groups of 1000 duplicates. Users and teams are not affected. Useful for testing duplicate checking or quickly producing a large volume of test data.
-e	no	false	Existing Users Mode	Turn Existing Users Mode on. Regardless of other settings, no Users or Teams will be created or modified. Any new data created will be assigned and associated with existing Users and Teams. The number of users that would normally be created is assumed to be the number of existing users. Useful for appending data onto an existing data set.
--as_populate	no	false	Turn Activity Stream Population	Populate ActivityStream records for each user and module. See --as_last_rec --as_number and --as_buffer params
--as_last_rec	yes	all	Last N records in module	Works with --as_populate key only. Populate last N records of each module (default: all available)
--as_number	yes	10	AS per Record	Works with --as_populate key only. Number of ActivityStream records for each module record (default 10)
--as_buffer	yes	1000	AS Insert Buffer	Works with --as_populate key only. Size of ActivityStream insertion buffer (default 1000)	Increasing default is recommended but may require increasing of MySQL insert buffer size too or other storage options
--storage	yes	mysql	Storage Type	Storage name, you have next options: mysql oracle or csv	Based on your environment, you need to decide which storage type should be used
-d	no	false	Debug Mode	Turn Debug Mode on. With Debug Mode, all queries will be logged in a file called 'executedQueries.txt' in your Tidbit folder.	Need to checked by devs
-x	yes	0	Commit batch	How often to commit module records - important on DBs like DB2. Default is no batches.
-s	yes	10	TemSet Size	Specify the number of teams per team set and per record
--tba	no	false	TBA	Turn Team-based ACL Mode on. Additional ACL Rules will be generated to turn on TBA permissions.	Please note that TBA options are supported only for 7.8+ versions and require SugarCRM config.php changes (or turned on TBA on admin panel)
--tba_level	yes	medium	TBA Level	Specify restriction level for Team-based ACL. Could be (minimum/medium/maximum/full)	Please check install_config for TBA options depending on level
--fullteamset	no	false	TeamSets option	Build fully intersected teamset list.
--with-tags	no	false	Tags generation	Turn on Tags and Tags Relations generation. Works for 7.7+ SugarCRM version
**--insert_batch_size **	yes	20	Insert Buffer	Number of VALUES to be added to one INSERT statement for bean data. Does Not include relations for now. Depends on storage type	Increasing default is recommended but may require increasing of MySQL insert buffer size too
--iterator	yes	false	Iterator	This will only insert in the DB the last (count) records specified, meanwhile the iterator will continue running in the loop. Used to check for orphaned records.
--allmodules	no	false		Automatically detect all installed modules and generate data for them.	While this option exists, it's recommended to setup modules in config file
--allrelationships	no	false		Automatically detect all relationships and generate data for them.	While this option exists, it's recommended to setup relationships in config file

Parameters Combination examples

Clean out existing seed data when generating new data set:

$ php -f install_cli.php -- -c

Insert 500 users:

$ php -f install_cli.php -- -u 500

Obliterate all data when generating new records with 400 users:

$ php -f install_cli.php -- -o -u 400

Create data using a load factor of 10, automatically detecting modules and automatically adding relationships.

$ php -f install_cli.php -- -l 10 -o --allmodules --allrelationships

Generate TeamBasedACL action restrictions for chosen level

$ php -f install_cli.php -- -o --tba -tba_level full

Controlling INSERT_BATCH_SIZE (MySQL Support only for now)

$ php -f install_cli.php -- -o --insert_batch_size 1000