- You have a Github account, you can create one yourself using your Hackney email.
- You have been added to the 'LBHackney-IT' team, you can request this from Rashmi Shetty.
- You have a Data Platform service account email address for your relevant domain or service area. A service account would look something like this: firstname.lastname@example.org. If you don't know which service account you should use, you can request this from the Data Platform team.
- Ensure that all columns in your file have headers. Columns without headers will be lost.
- If your XLSX file is stored on your local device, upload it to google drive.
- If the document is unnamed, name it
- You now need to share this file with the service account you've been provided. One way to do this is to open the XLSX spreadsheet you would like to import from Google drive and view it as if it were a Google Sheet. Once you've opened the document, click
Sharein the top right corner of the sheet. If your XLSX file is very large and you're having trouble opening the file in Sheets, you can right-click the file listed in Drive and click
- Paste in the service account email address you have been provided into the email box
- Ensure the suggested email matches the service account email and select it
- On the new window, choose from the dropdown on the right hand side and select
- Uncheck the
- You will be asked to confirm sharing outside the organisation, click
share anyway(Note that these service accounts are Hackney accounts, but aren't recognised by Google the same way that individual user accounts are recognised as being within Hackney.)
- Your spreadsheet is now available for import
You will need to obtain the document key from the url. The document id is the portion of the url between
/edit#gid=0. See example below
You will also need to obtain the worksheet name(s) that you wish to have imported. The worksheet name is located at the bottom left of the screen and unless it has been changed or other worksheets added, it will be called
Navigate to the main
terraformdirectory, and open
Switch to 'edit mode' (using edit button on top right)
Copy one of the modules above, paste at the bottom of the file and update the following fields:
module= "your-unique-module-name" (it is helpful to keep the same naming convention as your dataset/folder)
google_sheets_document_id= "Your document id - see the
Getting spreadsheet detailsection above"
glue_job_name= "Name that will be displayed in the data platform"
department_folder_name= "Name of the department this data belongs to"
output_folder_name= "Name of the folder where this data will be exported to"
input_file_name= "The name of the file you are importing from"
worksheets= Each worksheet that needs to be imported should be listed out in a map containing the header row number and the name of your worksheet - see the
Getting spreadsheet detailsection above. The worksheet name needs to match exactly (including any spaces or punctuation, but excluding any slashes
/), so you may want to copy and paste the name directly from your worksheet. If you need to add more sheets, you can copy and paste this section and continue numbering (e.g. sheet3, sheet4 etc). Remove any worksheet sections you don't need.
Committing your changes: The Data Platform team needs to approve any changes to the code, so your change won't happen automatically. To submit your change:
- Provide a description to explain what you've changed
- Select the option to create a
new branchfor this commit (i.e. the code you've changed). You can just use the suggested name for your branch.
- Once you click 'Propose changes' you'll have the opportunity to add even more detail if needed before submitted for review. Once finished adding details, click "Create pull request".
- You'll receive an email to confirm that your changes have been approved & then merged. After it has been merged into the main code base the job will run at the next scheduled time.