Installation

Using composer is the preferred way of managing your modules and themes as composer handles dependencies automatically and there is less margin for error. You can find out more about composer and how to install it here: https://getcomposer.org/. It is not recommended to edit your composer.json file manually.

Download using composer

Add Github repository source in you project composer.json. Add below is snippet under repositories in composer.json:

"acquia-pso": {
  "url": "https://github.com/acquia-pso/dst-entity-generate.git",
  "type": "git"
}

More information on adding repository can found at Modifying Repositories

Open up your terminal and navigate to your project root directory. Run the following command to require the module:

composer require acquia-pso/dst-entity-generate

DST Entity Generate module will install along with several module dependencies from drupal.org.

Important

  • In installation, you may need to provide a token.

  • You need to create a token in your github account.

You can now enable the modules via drush with the following commands:

drush pm:enable dst_entity_generate -y

Create a Google spreadsheet for defining all drupal entities like DEG sample template

Obtaining Google OAuth 2.0 Client Credentials

_images/create_new_project.png

  • After project creation, make sure your created project is selected.

_images/select_project.png

  • Then navigate to OAuth consent screen.

_images/oauth_consent_screen_link.png

  • Select User type to `Internal` and Click on `Create`.

_images/outh_consent_screen_settings.png

  • Provide required information on App Registration Page and click on `SAVE AND CONTINUE`.

_images/oauth_app_information.png

  • On `Scopes` step, no need to configure anything. Just click on `SAVE AND CONTINUE`.

  • Now, Click on `Credentials` tab to generate OAuth Credentials.

_images/credentials_creation_link.png

  • Click on `+ CREATE CREDENTIALS` button and select `Oauth client ID`.

_images/create_credentials.png

  • Select Application type as `Desktop app`, provide appropriate name and click on `CREATE`.

_images/oauth_client_application_type.png

  • Download created credentials.

_images/download_credentials.png

Enable Google Sheets APIS AND SERVICES

  • Navigate to `APIs & Services` Dashboard.

_images/apis_and_services_dashboard_link.png

  • Click on `+ ENABLE APIS AND SERVICES` button.

_images/enable_apis_and_services_button.png

  • Select “Google Sheets API” and “Enable” it.

Configure DEG on Drupal

Important

  • Private file system should be configured before configuring DEG.

  • To configure Private file system, refer Private file path section in settings.php file to configure it.

  • Login as Administrator on site

  • Go to menu Configuration -> Development -> Drupal Spec tool: Entity Generate -> Google Sheet API (/admin/config/dst_entity_generate/settings/google_sheet_api)

  • Enter Application Name. This name can be anything. Not necessary it should same as we created in Google Cloud platform in previous step.

  • Enter Google Sheets ID.

  • Upload Client Secret file that we downloaded in earlier steps.

_images/google_sheets_api_settings_form.png

  • Click on Next.

  • To complete step two, you need to valid your email account so that, it will be able to fetch data from Google Sheets.

  • Click on Click here link.

  • Select or login with Acquia email ID.

  • Allow permission to View your Google Spreadsheets.

  • Copy provided code and paste it in Step two form and submit.

  • It will redirect to General Settings (/admin/config/dst_entity_generate/settings) where we can enable the entity types.

Note

  • See Recent log messages of Drupal if any errors occur.