Cmdlets
This page provides a quick overview of all PowerShell cmdlets available with the powerGate installation. They enable the integration of Autodesk Vault with ERP, PLM and other Autodesk Platform Services (APS).
Depending on the installed components, the following modules are available:
Module |
Purpose |
Cmdlet documentation |
|---|---|---|
powerGate |
Integration with ERP systems through OData services |
This page |
powerAPS |
Integration with Autodesk Platform Services (APS) |
|
powerPLM |
Integration with Autodesk Fusion Manage |
|
powerJobs |
Automations for document processing through Vault jobs |
|
powerEvents |
Automations, UI extensions, and guardrails for Vault Client, Inventor, and more. |
|
powerVault |
Automation of Vault files, items, change orders, and other Vault objects |
ERP Cmdlets
All ERP cmdlets support OData versions v1, v2, v3, and v4.
They all try to perform as less server requests as possible, in order to ensure high performance when communicating over the network or the internet with your ERP system.
Connection and service metadata
Cmdlets for connection establishment with OData services:
Name |
Description |
|---|---|
Connects to an ERP-System. |
|
Disconnects from an ERP-System. |
Cmdlets to read metadata of connected OData services:
Name |
Description |
|---|---|
Returns information about the connected services |
|
Returns information about the available entitySets |
|
Returns information about the available EntityTypes. |
Performance
When some of the services are permanently not available, you can speed up your process by disconnecting them.
Please see example Disconnect all not available services.
The following Cmdlets require a successful connection between the current application and the ERP system or powerGateServer.
For them to work properly, all the necessary ERP services (or a single CatalogService) must have been previously connected by the Connect-ERP cmdlet.
Entity transfer
Cmdlets for reading, adding, updating and removing OData entities:
Name |
Description |
|---|---|
Returns a specific entity from the ERP-System. |
|
Searches for entities depending on the passed arguments. |
|
Updates an existing entity on the ERP-System. |
|
Creates a new entity and transfers it to a ERP-System. |
|
Deletes a specific entity from the ERP-System. |
|
Returns a new default instance of the desired ERP entity or complex type. |
|
Invokes an OData action or function exposed by an ERP service. |
Media exchange
Cmdlets for downloading, uploading and updating OData media files such as images, text files or even Autodesk file formats:
Name |
Description |
|---|---|
Uploads media files to the ERP-System. |
|
Downloads media files from the ERP-System. |
|
Updates media files on the ERP-System. |
|
Additional Cmdlets for APS and PLM Integrations
The powerAPS module provides the following additional cmdlet for connecting to Autodesk Platform Services (APS).
Building on top of it, the powerPLM module provides specific cmdlets for integrating with Autodesk Fusion Manage.
Requirements
To use the cmdlets with your ACC and BIM 360 hubs, make sure that the systems are property provisioned.
For Fusion Manage, make sure that your tenant is configured correctly.
This includes whitelisting the required Client ID and assigning the necessary product access to your Autodesk ID’s.
Name |
Description |
|---|---|
Authenticates via OAuth and connects to APS. |
|
Connects to a Fusion Manage tenant. |
|
Retrieves items from an Fusion Manage workspace. |
|
Adds a new Item to a workspace in Fusion Manage. |
|
Updates properties and affected items and performs workflow actions on an existing Item in Fusion Manage. |
|
Retrieves Linked Items (or Managed Items) or Attachments for an Item in Fusion Manage. |
|
Adds an attachment to an existing Item in Fusion Manage. |
|
Downloads the specified attachment from Fusion Manage to a local path. |
|
Name |
Description |
Retrieves the BOM of an FLC Item. |
|
Manipulates the BOM of an existing Item in Fusion Manage. |