Workspace Productivity Connector

Installing the Aras Workspace Productivity Connector 33 Client Component

Aras Workspace Productivity Connector 33 will modify Google Workspace to add the integration components.

Note
A Google account is required for installation.

Enable Google App Script API

  1. Go to Google Apps Script Settings.
  2. Click on Google Apps Script API and enable the toggle.

Create Project in Google Workspace

  1. Paste this URL in your browser: Google Cloud Console and you will land on the Google Cloud Project page.
  2. Tick the “I agree…” checkbox and click “Agree and Continue”.
  3. Once the dialog is closed, click on “Select a project”.
  4. Click “New project” and name it.
  5. In Notifications, click “Select Project”.
  6. This will take you to the dashboard page of your project.
  7. In the search box type “Apps Script API” and hit enter. You will see Apps Script API in the list.
  8. Select Apps Script API
  9. Click on it and click “Enable” button.
  10. For each of the APIs listed below, repeat steps 8 and 9, replacing “Apps Script API” with the corresponding API name:
    • Google Docs API
    • Google Sheets API
    • Google Slides API
    • Google Drive API

Workspace Connector Package Deployment on Google

PreSetup

  1. Open the WorkspaceConnectorDeploymentPackage from the Release Package into Windows Explorer
  2. Copy the directory path and open PowerShell window in administrator mode.
  3. Navigate to the copied path using following command
  4. Run the following command in the PowerShell window to install npm packages:npm install
  5. Run the following command in the PowerShell window to login to your Google account: npm run login
    • This will generate an authorization link to authorize login account.
    • It will open a login screen on the browser.
    • Select an appropriate account to login.
    • It will open a confirmation box. So, click “Continue” and the click “Allow”.
    • Once login is successful, you will see a success message.
  6. Then go back to the command prompt and locate the local path where credentials file named. clasprc.json is generated.
  7. Copy that file and paste it at the root level of the package (in case already exists then overwrite it).

Project setup at Google

Execute the following command from PowerShell (current directory path is the same as selected in the previous step): npm run setup

  1. This will create a standalone script in Google Cloud.
  2. To verify, navigate to My Projects - Apps Script (google.com) and you will see the project.
  3. Click on that project and navigate to “Project Settings”.
  4. Locate the clasp.json file in the dist folder of the packages and copy this file in the root folder of the package.
  5. From Project settings, click on “Change Project” button.
  6. It will open a section which contains steps. In Step 1, click “here”.

  1. This will take you to the Project dashboard created earlier.
  2. From the project Info card, copy “Project Number” and move back to step 4 above where there will be an input in step 10 to insert “GCP Project Number” and click on “Set Project” button.
  3. It will give you the following error.
  4. Click on “OAuth Consent details” link and it will take you to Credentials page. Click on “Configure Consent Screen”.
  5. Click Get Started.
  6. Enter the App Name as “Workspace Productivity Connector” and the context user email ID as email and click Next.
  7. Select User Type based on your preference and click on “Create”. For Organizational deployment select user type as Internal.
  8. Fill out the contact information and click Next.
  9. Select the checkbox and click Continue.
  10. Click Create.
  11. If you missed any configuration during setup, you can return to this screen anytime by visiting the OAuth consent screen settings.
  12. Go to Data Access
  13. Click on Add or remove scopesand add the following scopes under the Manually add Scope section:
  • Click on Add to table
  • Click on Update
  • Scroll down and click Save
  • Click on Audience (This step is required only if the user type is set to External.)
  • Click Add Users
  • Enter the user email ID
  • Click Save
  1. Scroll down to the bottom of the page and click “Back to Dashboard”
  2. Click Set Project

Project Deployment at Google

Open PowerShell again and make sure the current directory is set to the workspace deployment package path. Then, follow these steps:

  1. Run this command to install the tool needed to push your code to Google Apps Script:
    npm install @google/clasp
  2. Update the deployment HTML file:
    • Navigate to:WorkspaceConnectorDeploymentPackage\dist\sidebar-index-page.html.
    • Open the .html file in Notepad++.
    • Find the token <%INNOVATOR_BASE_URL%>.
    • Replace it with your actual Innovator instance URL.
    • Save the file.
  3. Run this command to push your build on the specified script in your Google project:npx clasp push
  4. Verify deployment:
    • Open the Google Apps Script project.
    • Go to the Project History section.
    • Ensure all project files and code are present, as shown below:

  5. Click “Deploy” from the top-right corner of the Google AppScripts Project
    • Select “New Deployment” from the dropdown menu.
    • In Select Type choose the Add-On, enter the name in the description field and click “Deploy”.
  6. From the “Deploy” dropdown, click “Test Deployments”. (This step is required for External user type. Internal users should follow the Marketplace deployment steps outlined in the next section.
  • Click “Install” on the dialog.
  • Click “Done”.
  • Open any Google Doc, Sheet, or Slide. In the bottom-right corner, click the arrow icon. This will open the sidebar, where you’ll see the new “Aras” add-on.
  • Click on the Aras add-on. You’ll see the Google Authorization task pane. Click on it and sign in with your Google account. The first time, you’ll need to grant access.
  • Once signed in, the Workspace Productivity Connector login task pane will appear.
  • Once you login into your Innovator all the commands will be visible on task pane.

Organizational Setup

  • Search for “Marketplace SDK” and enable it.
  • Go to App Configuration.
  • Configure the following steps:
    • App Visibility: Set to Private
    • Installation Settings: Select the options as required
    • App Integrations: Choose Google Workspace add-on and paste the Deployment ID from the Project Managed Deployment section.
  • Select the applications for which this add-on is applicable.
    • Fill in Developer information section.
    • Click on Save Draft.
  • Go to Store Listing.
    Fill in the required details and publish the app. Once it’s published, the app will appear in the “Internal Apps” section on the “Get Add-ons” page.
  • Click on it and search for “Workspace”. If the add-on is not already installed, you’ll be prompted to install it. If it is already installed, it will be shown as such.
  • On click of “Admin Install”and complete the setup.