Importing and Exporting in Studio
Studio supports the ability to import and export various project elements. The subsections that follow outline the procedures to import or export information pertaining to your Studio projects.
Importing a Mule Deployable Archive
When you export a Mule Deployable Archive from an instance of Studio, Mule restores the Studio-specific metadata included in the archive. Complete the following steps to import such a file into another instance of Mule Studio.
- Right-click the Package Explorer pane, then select Import. Alternatively, select Import from the File menu.
- In the Import wizard, click to expand the Mule folder, then select Mule Studio generated Deployable Archive (.zip), then clickNext.
- In the Zip File field, click the ellipses (...) button to explore your local drive to find, then select, the Mule Deployable Archive file (i.e. the .
zip
file) you wish to import.
- Change the Project Name, if you wish, then use the drop-down to select a Server Runtime from those you have downloaded locally.
- Click Finish. Studio loads the archive file, then displays the project in the Package Explorer under the project name you specified.
Adding and Removing User Libraries
Mule Studio leverages Eclipse’s capacity to add and remove user libraries. As an organized set of .jar
files, a user library provides an easy way to reference files across projects. Rather than individually adding files to a project, create a user library to store .jar
files, then add the library in your project’s build path.
Adding User Libraries
Included within Mule Studio are several libraries available to add to, then reference in your projects. Follow the procedure below to add a user library to your Studio project.
- In the Package Explorer pane in Studio, right-click the name of your project.
- Select Build Path, then Add Libraries...
- In the Add Library wizard, click to select the user library you wish to add, then click Next.
- Follow the wizard’s instructions to complete any required configurations or settings for the user library, then click Finish.
Removing User Libraries
Follow the procedure below to remove a user library from your Studio project.
- In the Package Explorer pane in Studio, right-click the name of your project.
- Select Build Path, then Configure Build Path...
- In the Properties panel, select Java Build Path in the left navigation bar, then click the Libraries tab.
- Click to select the user library you wish to remove, then click Remove.
- Click OK to save your user library changes.
Exporting a Studio Diagram
To easily share your project as a flow diagram outside the Studio environment, use the Export Diagram feature.
- In Studio, open the project for which you wish to export documentation.
- Under the File menu, select Export diagram to...
- Specify a location on your local drive to which you wish to export the project diagram, then click Save.
- Studio saves a
.png
file to the location you specified. The file contains the graphical representation of all the flows in your Studio project.
Exporting Studio Documentation
Studio includes a feature that enables you to easily export all the documentation you have recorded for your project. Whenever you want to easily share your project with others outside the Studio environment, you can export the project's documentation to print, email or share online. Studio's auto-generated documentation includes:
- a visual diagram of the flows in your application
- the XML configuration which corresponds to each flow in your application
- the text you entered in the Documentation tab of any building block in your flow
Complete the following steps to export all documentation as an HTML file to a directory, or folder, on your local drive.
- In Studio, open the project for which you wish to export documentation.
- Under the File menu, select Export Studio Documentation...
- In the Export Mule Studio Documentation wizard, specify a location on your local drive to which you wish to export the file, then click Generate Studio Documentation.
- Studio generates, then saves the documentation for your project as an
index.html
file on your local drive.
- On your local drive, navigate to the location you specified to store the file, then double-click to open the
index.html
file in your default Web browser. See example below.