Before running the script, follow these steps:
- Download the Kaltura PHP 5.3+ API Client archive and extract onto the
BASE_DIR/kaltura-client
directory (or editaccountdump.php
to point to a different path) - Edit
accountdump.php
and set the following parameters:PARTNER_ID
: the Kaltura partner IDPARTNER_NAME
: the account name (only used logging and output filename)ADMIN_SECRET
: the partner's ADMIN secretSERVICE_URL
: the Kaltura API endpoint (https://www.kaltura.com when using SaaS)KS_EXPIRY_TIME
: Session duration; since the execution time will vary based on the number of records, be sure to set the duration accordingly.ENTRY_STATUS_IN
: defines the entry statuses to retrieveENTRY_TYPE_IN
: defines the entry types to retrieveENTRY_FIELDS
: entry object members to export (excluding custom metadata, that is set inMETADATA_PROFILE_ID
),entryId
, captions and categories will be added to the abovePARENT_CATEGORIES
: optional; IDs of Kaltura Categories you'd like to limit the export toFILTER_TAGS
: tags to filter by (tagsMultiLikeOr
)CYCLE_SIZES
: determines how many entries will be processed in each multi-request callMETADATA_PROFILE_ID
: the profile id of the custom metadata profile to get its fields per entryONLY_CAPTIONED_ENTRIES
: when set totrue
only entries with caption assets be included in the outputGET_CAPTION_URLS
: when set totrue
, caption download URLs will be includedERROR_LOG_FILE
: the name of theKalturaLogger
export fileSTOP_DATE_FOR_EXPORT
: defines a stop time for the iteration loop. Any input supported bystrtotime
can be passed e.g. '45 days ago' or '01/01/2017', etc. . If set to null or -1, it will be ignored and the script will iterate over all entries matching the other criteria.DEBUG_PRINTS
: set to true if you'd like the script to output logging to the console (this is different from theKalturaLogger
)$exportFileName
: sets the name of the output XLS file (do not include the file extension).
After setting the values for the above parameters, run the script using PHP CLI:
$ php accountdump.php
Thank you for helping Kaltura grow! If you'd like to contribute please follow these steps:
- Use the repository issues tracker to report bugs or feature requests
- If you extend or fix anything in the code, please submit your patch as a GitHub pull-request
- Sign the Kaltura Contributor License Agreement
- Read Contributing Code to the Kaltura Platform
- Join the Kaltura Community Forums to ask questions or start discussions
- Read the Code of conduct and be patient and respectful
You can learn more about Kaltura and start a free trial at: http://corp.kaltura.com
Contact us via Twitter @Kaltura or email: [email protected]
We'd love to hear from you!
All code in this project is released under the AGPLv3 license unless a different license for a particular library is specified in the applicable library path.
Copyright © Kaltura Inc. All rights reserved.
Authors and contributors: See GitHub contributors list.
Review the list of Open Source 3rd party libraries used in this project.