--- title: "How to: Extract Data From Unqork" slug: "how-to-extract-data-from-unqork" updated: 2025-09-25T19:27:00Z published: 2025-09-25T19:27:00Z canonical: "docs.unqork.io/how-to-extract-data-from-unqork" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.unqork.io/llms.txt > Use this file to discover all available pages before exploring further. # How to: Extract Data From Unqork Exporting configuration data lets the client control ownership of their intellectual property. In this how-to guide, you’ll learn how to copy modules stored in the [Community Resources](https://training.unqork.io/workspaces/64c9433e79dd5b7e5b9e972c) workspace of our Unqork Training environment and perform extractions on various types of environment and configuration-related data. > [!TIP] > If there is additional data you need help extracting that is not covered in this how-to guide, submit a request to Unqork Support at [support.unqork.com](http://support.unqork.com/). ### What You Can Extract Unqork has created various extraction modules in the Training environment that you can access and copy into your environment to perform the following data extractions: - Services - Express Roles - Designer Roles - Module Components ### What You Need - Access to [https://training.unqork.io](https://training.unqork.io/). - Designer Administrator permissions in your environment. > [!TIP] > To learn about the types of data you can extract from Unqork, view our [Data Extraction in Unqork](/v1/docs/data-extraction-in-unqork) article. ## Extracting Environment Data: Services The [Services Administration](/v1/docs/services-administration) page enables users to create, view, edit, and delete external APIs or authentication services. In this section, you'll configure a module that leverages an API that returns and exports a list of your configured services in the Services Administration environment settings. ### What You Can Extract You can extract a list of services from the environment in an Excel spreadsheet format. This list of services includes the Service Name, Service Title, Authentication Type, Host, and Environment Share Type for each service. ### Getting Started 1. Log in to [https://training.unqork.io](https://training.unqork.io/). 2. Navigate to the following **Data Exports - Service Administration** workspace: [https://training.unqork.io/workspaces/64c9433e79dd5b7e5b9e972c/applications/6658ddeb8cbaf6089ae44524/modules](https://training.unqork.io/workspaces/64c9433e79dd5b7e5b9e972c/applications/6658ddeb8cbaf6089ae44524/modules). 3. Open another browser tab and log in to the environment where you want to copy and paste the modules. 4. Create a new application, **API** module, and **Front-End** module in your environment to store the copied modules. 5. In the Training environment, open the **Get Services (API)** module in the Module Builder. 6. At the top right of the Module Builder, click ![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/image(33).png?sv=2026-02-06&spr=https&st=2026-11-07T22%3A07%3A59Z&se=2026-11-07T23%3A07%3A59Z&sr=c&sp=r&sig=bgWrRp2NB0TUk1ceqtmaZ77%2B7sj%2Bi7b6rDdG7XF%2BUHk%3D) **(ellipsis)** and select **Copy** **Module** **Definition**. The module definition saves to your computer’s clipboard. 7. Open your new API module in the Module Builder of your environment. 8. At the top right of the Module Builder, click the ![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/image(33).png?sv=2026-02-06&spr=https&st=2026-11-07T22%3A07%3A59Z&se=2026-11-07T23%3A07%3A59Z&sr=c&sp=r&sig=bgWrRp2NB0TUk1ceqtmaZ77%2B7sj%2Bi7b6rDdG7XF%2BUHk%3D) **(ellipsis)** and select **Paste** **Module** **Definition**. 9. In the **Module** **Definition** field, press the **Ctrl + V** keys (PC) or **Cmd + V** keys (Mac) on your keyboard to paste the module definition from your clipboard. 10. **Save** your module. 11. Repeat these steps for the **Get Service Admin Data Export** module in the Training environment, and paste it into the new **Front-End** module in your environment. 12. Open your **API** module in the Module Builder and copy the module ID from the browser URL. 13. Open your **Front-End** module in the Module Builder. 14. Open the **pluginGetServices** ![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/Screenshot 2025-09-11 151123.png?sv=2026-02-06&spr=https&st=2026-11-07T22%3A07%3A59Z&se=2026-11-07T23%3A07%3A59Z&sr=c&sp=r&sig=bgWrRp2NB0TUk1ceqtmaZ77%2B7sj%2Bi7b6rDdG7XF%2BUHk%3D) **Plug-In** component’s configuration menu. 15. In the **Data Source URL** field, replace `moduleID` with your **API** module’s module ID. 16. **Save** your module. ### Preview in Express View 1. **Preview** your **Front-End** module in **Express View**. 2. Follow the instructions on the page to generate a list of your services and export it as an Excel spreadsheet. ### Resources - [How to: Copy and Paste Module Definitions](/v1/docs/how-to-copy-and-paste-module-definitions) - [Services Administration](/v1/docs/services-administration) ## Extracting Environment Data: Express Roles The [Express Role Administration](/v1/docs/express-role-administration) page lets you create Express roles and set the permission hierarchy. In this section, you will configure a module that leverages an API that returns and exports a list of the Express roles configured in the Express Role Administration settings. ### What You Can Extract You can extract a list of Express roles in the environment in Excel spreadsheet format. The list of roles includes information like the Role Name, Parent Role, Default Permission, and Description for each role. ### Getting Started 1. Log in to [https://training.unqork.io](https://training.unqork.io/). 2. Navigate to the following **Data Exports - Role Administration** workspace: [https://training.unqork.io/workspaces/64c9433e79dd5b7e5b9e972c/applications/665a1f17f9af11820480468b/modules](https://training.unqork.io/workspaces/64c9433e79dd5b7e5b9e972c/applications/665a1f17f9af11820480468b/modules). 3. Open another browser tab and log in to the environment where you want to copy and paste the modules. 4. Create a new application, **API** module, and **Front-End** module in your environment to store the copied modules. 5. In the Training environment, open the **Get Environment Roles (API)** module in the Module Builder. 6. At the top right of the Module Builder, click ![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/image(33).png?sv=2026-02-06&spr=https&st=2026-11-07T22%3A07%3A59Z&se=2026-11-07T23%3A07%3A59Z&sr=c&sp=r&sig=bgWrRp2NB0TUk1ceqtmaZ77%2B7sj%2Bi7b6rDdG7XF%2BUHk%3D) **(ellipsis)** and select **Copy** **Module** **Definition**. The module definition saves to your computer’s clipboard. 7. Open your new **API** module in the Module Builder of your environment. 8. At the top right of the Module Builder, click the ![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/image(33).png?sv=2026-02-06&spr=https&st=2026-11-07T22%3A07%3A59Z&se=2026-11-07T23%3A07%3A59Z&sr=c&sp=r&sig=bgWrRp2NB0TUk1ceqtmaZ77%2B7sj%2Bi7b6rDdG7XF%2BUHk%3D) **(ellipsis)** and select **Paste** **Module** **Definition**. 9. In the **Module** **Definition** field, press the **Ctrl + V** keys (PC) or **Cmd + V** keys (Mac) on your keyboard to paste the module definition from your clipboard. 10. **Save** your module. 11. Repeat these steps for the **Get Environment Roles Data Export** module in the Training environment, and paste it into the new **Front-End** module in your environment. 12. Open your **API** module in the Module Builder and copy the module ID from the browser URL. 13. Open your **Front-End** module in the Module Builder. 14. Open the **pluginGetRoles** **Plug-In** component’s configuration menu. 15. In the **Data Source URL** field, replace `moduleId` with your **API** module’s module ID. 16. **Save** your module. ### Preview in Express View 1. **Preview** your **Front-End** module in **Express View**. 2. Follow the instructions on the page to generate a list of roles and export it into as an Excel spreadsheet. ### Resources - [How to: Copy and Paste Module Definitions](/v1/docs/how-to-copy-and-paste-module-definitions) - [Express Role Administration](/v1/docs/express-role-administration) ## Extracting Environment Data: Designer Roles [Creator Role Administration](/v1/docs/creator-role-administration) is where administrators can manage the RBAC for their environments and workspaces. In this section, you’ll configure a module that leverages an API that returns and exports a list of the Designer Roles configured in Creator Role Administration. ### What You Can Extract You can extract a list of Designer roles from your environment in an Excel spreadsheet format. The list of roles includes information like the Role Name, Created Date, Role Type, and Permissions for each role. ### Getting Started 1. Log in to [https://training.unqork.io](https://training.unqork.io/). 2. Navigate to the following **Data Exports - Designer Roles** workspace: [https://training.unqork.io/workspaces/64c9433e79dd5b7e5b9e972c/applications/665a1fbba168c2c5589c73ad/modules](https://training.unqork.io/workspaces/64c9433e79dd5b7e5b9e972c/applications/665a1fbba168c2c5589c73ad/modules). 3. Open another browser tab and log in to the environment where you want to copy and paste the modules. 4. Create a new application, APImodule, and **Front-End** module in your environment to store the copied modules. 5. In the Training environment, open the **Get Designer Roles (API)** module in the Module Builder. 6. At the top right of the Module Builder, click ![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/image(33).png?sv=2026-02-06&spr=https&st=2026-11-07T22%3A07%3A59Z&se=2026-11-07T23%3A07%3A59Z&sr=c&sp=r&sig=bgWrRp2NB0TUk1ceqtmaZ77%2B7sj%2Bi7b6rDdG7XF%2BUHk%3D) **(ellipsis)** and select **Copy** **Module** **Definition**. The module definition saves to your computer’s clipboard. 7. Open your new **API** module in the Module Builder of your environment. 8. At the top right of the Module Builder, click the ![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/image(33).png?sv=2026-02-06&spr=https&st=2026-11-07T22%3A07%3A59Z&se=2026-11-07T23%3A07%3A59Z&sr=c&sp=r&sig=bgWrRp2NB0TUk1ceqtmaZ77%2B7sj%2Bi7b6rDdG7XF%2BUHk%3D) **(ellipsis)** and select **Paste** **Module** **Definition**. 9. In the **Module** **Definition** field, press the **Ctrl + V** keys (PC) or **Cmd + V** keys (Mac) on your keyboard to paste the module definition from your clipboard. 10. **Save** your module. 11. Repeat these steps for the **Get Designer Roles Data Export** module in the Training environment, and paste it into the new **Front-End** module in your environment. 12. Open your **API** module in the Module Builder and copy the module ID from the browser URL. 13. Open your **Front-End** module in the Module Builder. 14. Open the **pluginGetDesignerRoles** ![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/image(41).png?sv=2026-02-06&spr=https&st=2026-11-07T22%3A07%3A59Z&se=2026-11-07T23%3A07%3A59Z&sr=c&sp=r&sig=bgWrRp2NB0TUk1ceqtmaZ77%2B7sj%2Bi7b6rDdG7XF%2BUHk%3D)Plug-In component’s configuration menu. 15. In the **Data Source URL** field, replace the `moduleId` with your **API** module’s module ID. 16. **Save** your module. ### Preview in Express View 1. **Preview** your **Front-End** module in Express View. 2. Follow the instructions on the page to generate a list of your roles and export it as an Excel spreadsheet. ### Resources - [How to: Copy and Paste Module Definitions](/v1/docs/how-to-copy-and-paste-module-definitions) - [Creator Role Administration](/v1/docs/creator-role-administration) ## Extracting Configuration Data: Components [Components](/v1/docs/module-builder-component-library) are the building blocks of your modules. In this section, you’ll configure a module that leverages an API that returns data specific to how components are configured. ### What You Can Extract You can generate component configuration data associated with the module you are inputting, and export this data as a PDF file. ### Getting Started 1. Log in to [https://training.unqork.io](https://training.unqork.io/). 2. Navigate to the following **Data Exports -** **Module** **Components** workspace: [https://training.unqork.io/workspaces/64c9433e79dd5b7e5b9e972c/applications/6658dc31d51d102bc8c91b49/modules](https://training.unqork.io/workspaces/64c9433e79dd5b7e5b9e972c/applications/6658dc31d51d102bc8c91b49/modules). 3. Open another browser tab and log in to the environment where you want to copy and paste the module. 4. Create a new application and a **Front-End** module in your environment to store the copied module. 5. In the Training environment, open the **Module****-Component-Exports** module in the Module Builder. 6. At the top right of the Module Builder, click ![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/image(33).png?sv=2026-02-06&spr=https&st=2026-11-07T22%3A07%3A59Z&se=2026-11-07T23%3A07%3A59Z&sr=c&sp=r&sig=bgWrRp2NB0TUk1ceqtmaZ77%2B7sj%2Bi7b6rDdG7XF%2BUHk%3D) **(ellipsis)** and select **Copy** **Module** **Definition**. The module definition saves to your computer’s clipboard. 7. Open your new **Front-End** module in the Module Builder of your environment. 8. At the top right of the Module Builder, click the ![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/image(33).png?sv=2026-02-06&spr=https&st=2026-11-07T22%3A07%3A59Z&se=2026-11-07T23%3A07%3A59Z&sr=c&sp=r&sig=bgWrRp2NB0TUk1ceqtmaZ77%2B7sj%2Bi7b6rDdG7XF%2BUHk%3D) **(ellipsis)** and select **Paste** **Module** **Definition**. 9. In the **Module** **Definition** field, press the **Ctrl + V** keys (PC) or **Cmd + V** keys (Mac) on your keyboard to paste the module definition from your clipboard. 10. **Save** your module. ### Preview in Express View 1. **Preview** your **Front-End** module in Express View. 2. Follow the instructions on the page to generate a list of your services and export it as a PDF file. ### Resources - [How to: Copy and Paste Module Definitions](/v1/docs/how-to-copy-and-paste-module-definitions) - [Module Builder: Component Library](/v1/docs/module-builder-component-library) APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. A place on your operating system that stores recently copied content. The clipboard only stores one item at a time. APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. Express View is how your end-user views your application. Express View also lets you preview your applications to test your configuration and view the styling. This is also the view your end-users will see when interacting with your application. After configuring a module, click Preview in the Module Builder to interact with the module in Express View.