Bluebeam channel

Prev Next

Use the Bluebeam channel to integrate with Bluebeam Studio and Bluebeam Revu to automate your collaboration sessions and projects, and gather data on project files.

How to connect

  1. On the My pipelines page, select Create Pipeline.

  2. Select the Bluebeam-Beta channel from your list of channels.

  3. Select a step and Connect.

  4. You're directed in a new window to enter your Bluebeam credentials.
    bluebeam-sign-on.png

Congrats, you've successfully connected your channel and you can start using it.

How to reconnect

You may need to reconnect your account to a channel. Reasons may be (but not limited to):

  • If you need to connect a different account.

  • Authorization updates, such as a changed password.

  • Editing the access rights that Pipelines has to the channel.

To reconnect:

  1. Select a pipeline that already has this channel in it.

  2. Open a step that contains this channel.

  3. Under account, select Connect (or reconnect) and follow the process above, How to connect.

Steps

This table lists the steps you can use with the Bluebeam channel.

Type

Category

Step name

Description

query

job_result

Search Job Results

lookup

job_result

Look Up a Job Result

action

job

Cancel a Job

query

job

Search Jobs

lookup

job

Look Up a Job

action

project_file_job

Create a Combine PDF Files Job

Creates a job that combines the PDF file with a list of other PDF files.

action

project_file_job

Create a Convert Image to PDF Job

Creates a job that converts an image file to a PDF file.

action

project_file_job

Create a Convert PDF to PDF/A-1b Job

Creates a job that converts a PDF file to a PDF/A-1b file.

action

project_file_job

Create a PDF Page Counter Job

Creates a job that returns the number of pages in the PDF file.

action

project_file_job

Create a Delete PDF Pages Job

Creates a job that deletes pages from a PDF file.

action

project_file_job

Create an Export PDF Custom Column Job

Creates a job that exports the Custom Column definition of the PDF file to an .xml file.

action

project_file_job

Create an Export PDF Form Data Job

Creates a job that exports the form data from the PDF file to a .xml, .csv, or .fdf file.

action

project_file_job

Create an Export PDF Markups Job

Creates a job that exports the PDF file markups to an output file.

action

project_file_job

Create an Extract PDF Pages to Files Job

Creates a job that extracts all pages inside the PDF file to individual PDF files.

action

project_file_job

Create a Flatten PDF Annotations Job

Creates a job that flattens the annotation to be part of the page content for a given PDF file.

action

project_file_job

Create a Generate PDF Markups List Job

Creates a job that generates the list of the markups from the PDF file.

action

project_file_job

Create a Get PDF File Property Job

Creates a job that returns the value of a specified file property.

action

project_file_job

Create a Get PDF File Properties Job

Creates a job that returns the PDF file properties.

action

project_file_job

Create an Import PDF Markups Job

Creates a job that imports the markups from a list of files into the input PDF file.

action

project_file_job

Create an Insert PDF Job

Creates a job that inserts a PDF file into the active PDF file using the specified parameters to control what additional data is imported, such as bookmarks, file attachments, and file properties.

action

project_file_job

Create a Reduce PDF File Size Job

Creates a job that reduces the size of a PDF file.

action

project_file_job

Create a Replace PDF Pages Job

Creates a job that replaces the pages in the current PDF file with pages from the source PDF file.

action

project_file_job

Create a Set PDF File Property Job

Creates a job that sets the value for the specified property in the PDF file.

action

project_file_job

Retrieve Get File Property Job Results

Retrieves the value generated by the Get File Property job.

query

project_file_job

Retrieve Generate PDF Markups List Job Results

Retrieves the markups list generated by the Generate PDF Markups List job.

action

project_file_job

Retrieve Get PDF File Properties Job Results

Retrieves the file properties list generated by the Get PDF File Properties job.

action

project_file_revision

Restore a Project File Revision

query

project_file_revision

Search Project File Revisions

lookup

project_file_revision

Look Up a Project File Revision

Gets the revision metadata of a file. Includes the DownloadUrl, which can be used to download file content.

action

project_file

Delete a Project File

action

project_file

Checkout a Project File for Modification

action

project_file

Checkout a Project File to Studio Session

Checks out a Project file to a Session. Links a Project to a Session. The Session must exist and not be linked to any other Project.

action

project_file

Copy a Project File

Copies a Project file. The file can't be copied to another Project.

query

project_file

Search Project Files

lookup

project_file

Look Up a Project File

Gets file metadata. Includes the DownloadUrl, which can be used to download file content. DownloadUrl is valid for 10 minutes to begin download.

action

project_folder

Create a Project Folder

Creates a new empty Project folder.

action

project_folder

Update a Project Folder

Updates the Project folder. To move the folder, change the parent folder ID.

action

project_folder

Delete a Project Folder

Deletes a specified folder and all of its contents.

action

project_folder

Get Project Folder Permissions

Gets Project folder permissions. Returns an empty string if permission is not set

action

project_folder

Modify Project Folder Permissions

Updates Project folder permissions.

query

project_folder

Search Project Folders

lookup

project_folder

Look Up a Project Folder

Gets Project folder metadata. Use 0 to get the Project's root folder.

action

project_shared_link

Create a Project File Shared Link

action

project_shared_link

Update a Project Shared Link

action

project_shared_link

Delete a Project Shared Link

query

project_shared_link

Search Project Shared Links

lookup

project_shared_link

Look Up a Project Shared Link

action

project_user

Update User in a Project

action

project_user

Remove User from Project

Removes a user from a Project. This action does not prevent them from re-joining if the Project has open access.

action

project_user

Add User to a Project

action

project_user

Get Project User Permissions

action

project_user

Invite User to a Project by Email

action

project_user

Modify Project User Permissions

query

project_user

Search Project Users

lookup

project_user

Look Up a Project User

action

project

Create a Project

Creates a new Project. The current user is automatically added to the Projects's users.

action

project

Update a Project

action

project

Delete a Project

action

project

Get Project Permissions

action

project

Modify Project Permissions

query

project

Search Projects

lookup

project

Look Up a Project

action

session_activity

Create a Session Activity

Creates a Session activity. Only the chat operation is supported.

query

session_activity

Search Session Activities

lookup

session_activity

Look Up a Session Activity

action

session_file

Update Project Copy

Updates Project copy. If you checked a file out from a Studio Project and added that file into a Studio Session, you can use this step to update the Studio Project copy with any changes made in the Studio Session. This step only works on files that have been checked out from the Studio Project.

action

session_file

Delete a Session File

action

session_file

Get Metadata on Session Document Snapshot Job

Returns job status ("NoSnapshot", "Requested", "InProgress", "Complete", "Error"), which may be followed by additional information. Provides the download URL and timestamp of the last completed snapshot.

action

session_file

Start Session Document Snapshot Job

Starts a session document snapshop job. The result of a "Look Up a Session File" step contains the last successful snapshot. Password protected documents, documents with complex javascript, or documents with errors in them may not work.

query

session_file

Search Session Files

lookup

session_file

Look Up a Session File

Gets file metadata. Includes the DownloadUrl which can be used to download file content. DownloadUrl is valid for 10 minutes to begin download.

action

session_user

Update User in a Session

action

session_user

Add User to a Session

action

session_user

Get Session User Permissions

action

session_user

Invite User to a Session by Email

action

session_user

Modify Session User Permissions

query

session_user

Search Session Users

lookup

session_user

Look Up a Session User

action

session

Create a Session

Creates a new Session. Current user is automatically added to the Session's users.

action

session

Update a Session

action

session

Delete a Session

action

session

Get Session Permissions

action

session

Modify Session Permissions

query

session

Search Sessions

lookup

session

Look Up a Session

query

session

Search Session File Markups

Limits

  • No triggers are provided for this channel at this time

  • File support is not provided

Note

Bluebeam tokens expire after a certain period of time, which could cause errors in pipelines. Learn more about token expiration on Bluebeam's support site.

Examples

Create a new Bluebeam project from a Quickbase record

Create a pipeline with these steps:

  1. Record created step to trigger the pipeline for any new project that is added in the respective Quickbase table.

  2. Create a Project step from the Bluebeam channel to create a new project in Bluebeam.

  3. Update Record step to record the Bluebeam project ID in the Quickbase table.

Example YAML:

# Bluebeam - Create a Project
#

# Account slugs:
#  - quickbase[<REDACTED>]: Realm Default Account <None>
#  - bluebeam[<REDACTED>]: pipelines-accounts [<REDACTED>] <None>
---
- META:
    name: Bluebeam - Create a Project
    tag_names:
    - bluebeam
    - Quickbase
    enabled: true
- TRIGGER quickbase[<REDACTED>] record on_create -> a:
    inputs-meta:
      export_fields: '"Bluebeam Project ID, Project Name" <7, 6>'
      table: '"Bluebeam Project Manager: BB Projects" <buxpzc5hu>'
- ACTION bluebeam[<REDACTED>] project create -> b:
    inputs:
      name: '{{a.project_name}}'
- a<>ACTION quickbase record update -> c:
    inputs:
      bluebeam_project_id: '{{b.id}}'
...

Delete a Bluebeam project from a Quickbase record

Create a pipeline with these steps:

  1. Record Deleted step to trigger the pipeline for any new project that is deleted from the respective Quickbase table.

  2. Look Up a Project step from the Bluebeam channel to find the project to be deleted in Bluebeam.

  3. Delete a Project step to delete the project from Bluebeam.

Example YAML:

# Bluebeam -Delete a Project
#

# Account slugs:
#  - quickbase[<REDACTED>]: Realm Default Account <None>
#  - bluebeam[<REDACTED>]: pipelines-accounts (<REDACTED>) <None>
---
- META:
    name: Bluebeam -Delete a Project
    tag_names:
    - bluebeam
    - Quickbase
    enabled: false
- TRIGGER quickbase[<REDACTED>] record on_delete -> a:
    inputs-meta:
      export_fields: '"Bluebeam Project ID" <7>'
      table: '"Bluebeam Project Manager: BB Projects" <buxpzc5hu>'
- LOOKUP bluebeam[<REDACTED>] project look_up -> b:
    inputs:
      id: '{{a.bluebeam_project_id}}'
- b<>ACTION bluebeam project delete -> c: {}
...

Invite a Project Collaborator from a Quickbase record

  1. Record created step to trigger the pipeline for any new email address that is added in the respective Quickbase table.

  2. Invite User to a Project by Email step from the Bluebeam channel to invite the new collaborator to the Bluebeam project.

Example YAML:

# Bluebeam - Invite a Project Collaborator
#

# Account slugs:
#  - quickbase[<REDACTED>]: Realm Default Account <None>
#  - bluebeam[<REDACTED>]: pipelines-accounts (<REDACTED>) <None>
---
- META:
    name: Bluebeam - Invite a Project Collaborator
    tag_names:
    - bluebeam
    - Quickbase
    enabled: true
- TRIGGER quickbase[<REDACTED>] record on_create -> a:
    inputs-meta:
      export_fields: '"Collaborator Email, BB Project - Bluebeam Project ID" <6, 9>'
      table: '"Bluebeam Project Manager: BB Project Collaborators" <buxp2namt>'
- ACTION bluebeam[<REDACTED>] project_user invite_user_to_project_by_email -> b:
    inputs-meta:
      project_id: '{{a.bb_project_bluebeam_project_id}}'
    inputs:
      email: '{{a.collaborator_email}}'
      message: Come to Pipelines and let's collaborate together!
...