Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/autodesk-forge/design.automation-workflow-winform-sample
Design Automation WinForm application: Perform workflow tasks from the Design Automation API such as creating custom activities, creating AppPackage, submitting work item requests and viewing downloaded results
https://github.com/autodesk-forge/design.automation-workflow-winform-sample
autocad csharo design-automation winforms
Last synced: about 5 hours ago
JSON representation
Design Automation WinForm application: Perform workflow tasks from the Design Automation API such as creating custom activities, creating AppPackage, submitting work item requests and viewing downloaded results
- Host: GitHub
- URL: https://github.com/autodesk-forge/design.automation-workflow-winform-sample
- Owner: Autodesk-Forge
- License: mit
- Created: 2014-11-13T06:09:56.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2018-10-05T19:58:48.000Z (about 6 years ago)
- Last Synced: 2024-04-09T21:50:08.496Z (7 months ago)
- Topics: autocad, csharo, design-automation, winforms
- Language: C#
- Homepage:
- Size: 1.07 MB
- Stars: 8
- Watchers: 29
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Design Automation API - WinForm sample
===========================
(Formely AutoCAD I/O)
[](http://www.microsoft.com/en-us/download/details.aspx?id=30653)
[](http://www.odata.org/documentation/)
[](http://developer.autodesk.com/)
[](https://www.visualstudio.com/)
[](http://opensource.org/licenses/MIT)
## Description
A C# WinForm application for performing workflow tasks of Design Automation on create custom activities, create AppPackage, submit workitem requests and view downloaded results.
## Thumbnail
## Setup
### Dependencies
* Download and install [Visual Studio](https://visualstudio.microsoft.com/downloads/). In the latest test, Visual Studio version is 2017.
* Ensure you have already [AWS account and S3 storage](https://aws.amazon.com/s3/).
* Get the auxiliary library project [design.automation-.net-library](https://github.com/Autodesk-Forge/design.automation-.net-library)
### Prerequisites
1. **Forge Account**: Learn how to create a Forge Account, activate subscription and create an app at [this tutorial](http://learnforge.autodesk.io/#/account/). Make sure to select the service **Design Automation**.
2. Make a note with the credentials (client id and client secret) of the app.
3. as mentioned in **Dependencies**, ensure to build the auxiliary library project and get the binary dll.
## Running locally
1. Open the project. Restore the packages of the project by [NuGet](https://www.nuget.org/. The simplest way is
* VS2012: Projects tab >> Enable NuGet Package Restore. Then right click the project>>"Manage NuGet Packages for Solution" >> "Restore" (top right of dialog)
* VS2013/VS2015/2017: right click the project>>"Manage NuGet Packages for Solution" >> "Restore" (top right of dialog)
2. Add other missing references and the library of[design.automation-.net-library](https://github.com/Autodesk-Forge/design.automation-.net-library)
3. In the project settings, provide the following details:
* Path to a local folder in your system that contains AutoCAD drawings. Put some test drawings in this folder.
* Design Automation Client Id which is from #1 of **Prerequisites**
* Design Automation Client Secret which is from #1 of **Prerequisites**
* Bucket name in your AWS S3 Storage which is from #2 of **Prerequisites**
4. Open “App.Config” file and fill in AWS credentials. This will allow the sample project to access S3 storage in your AWS profile.
5. Build the sample project
6. Run AutoCADIODemo.exe. the main window to appear. The path to the sample drawings that was provided in the project settings can also be provided by accessing “Settings” button as shown in the below screenshot.
## Demonstrations
### Demo 1: Using Shared Design Automation Activity
-----------------------------------------------------------------------------------------------------------------------------
* Design Automation provides a Shared activity which is named “PlotToPDF”. This activity is available by default. Choose this activity from the list of activities as shown in the below screenshot.Select any drawing from the list of drawings that appear at the left.
The chosen drawing will be uploaded to the S3 storage and a WorkItem will be created based on the selected activity.
The WorkItem will be submitted to AutoCAD IO for processing and the result will get displayed in the right pane.
### Demo 2: Creating and using a custom AutoCAD IO Activity
-----------------------------------------------------------------------------------------------------------------------------
To create a custom activity, click on the Activities button as shown in below screenshot and provide the details.
Important Note : The script should be implemented such that the result file is named as “result.*”.
The result file name can be any name of your choice, AutoCAD IO does not have a restriction on that.
But just to make the sample code generic and have it identify the result file automatically from the script,
the sample project looks for anything that sounds like result.pdf, Result.dwf, RESULT.DWG etc. So for custom activities
to work, please ensure that the script saves the result with an appropriate file name as result.dwg, result.pdf, result.dwf etc.
After the custom activity is created, close the Activities dialog.
The custom activity should now appear in the list of Activities alongside the shared activity as shown in the below screenshot.
Select the custom activity and choose any drawing from the list of drawings just as we did for using a Shared activity.
The result of the custom activity will be displayed in the right pane if it is a pdf. For any other outputs such as dwg, dwf,
the result file is downloaded to a local path and the path is displayed in the right pane.
### Demo 3: Creating and using a custom Design Automation Activity that is linked to an App Package
-----------------------------------------------------------------------------------------------------------------------------
Create a custom crx or .Net plugin (that does not reference acmgd.dll)
Package it in AutoCAD Bundle format
Click on “App Packages” button and provide the details as shown in below screenshot
To create a custom activity that links with the custom app package, click on the Activities button as
shown in below screenshot and provide the details.
After the custom activity is created, close the Activities dialog.
The custom activity should now appear in the list of Activities alongside the shared activity as shown in the below screenshot.
Select the custom activity and choose any drawing from the list of drawings just as we did for using a Shared activity.
The result of the custom activity will be downloaded to a local path and the path is displayed as shown in the below screenshot.
Verify that the custom command has done its task by opening the downloaded result.
## Known Issues
* as of writing, Design Automation of Forge is released with version 2. Odata is used with .NET project. In futher version, OData might not be used.
## Further Reading
* [Design Automation API help](https://forge.autodesk.com/en/docs/design-automation/v2/developers_guide/overview/)
* [ Intro to Design Automation API Video](https://www.youtube.com/watch?v=GWsJM344CJE&t=107s)
* [Working with Amazon S3 Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html)
## License
These samples are licensed under the terms of the [MIT License](http://opensource.org/licenses/MIT). Please see the [LICENSE](LICENSE) file for full details.
## Written by
Balaji Ramamoorthy
updated by Xiaodong Liang