{"id":31774,"date":"2018-04-09T20:40:16","date_gmt":"2018-04-10T04:40:16","guid":{"rendered":"https:\/\/ephesoft.com\/docs\/2019-1-2\/moduleplugin-configuration\/export-module\/export-configuring-and-using-the-box-export-plugin\/"},"modified":"2020-05-19T12:23:18","modified_gmt":"2020-05-19T19:23:18","slug":"export-configuring-and-using-the-box-export-plugin","status":"publish","type":"docs","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/moduleplugin-configuration\/export-module\/export-configuring-and-using-the-box-export-plugin\/","title":{"rendered":"Box Export Plugin"},"content":{"rendered":"
This document describes how to configure Ephesoft Transact to export batch files and metadata to the Box repository from Ephesoft Transact, with the following elements of deployment:<\/p>\n
Note: <\/b>This document includes configurations and steps to be completed on the Box website, which can be updated without warning at any time. If you try to follow the steps and notice the Box website UI no longer matches the information provided in this document, please contact the Ephesoft support group for assistance.<\/p>\n 1. Navigate to https:\/\/developer.box.com<\/a>.<\/p>\n 2. Log in to the Box account with the credentials in which the developer application is to be created.<\/p>\n 3. Create a new developer application by clicking Create New App<\/strong>.<\/p>\n If you are creating your very first Box app, the following screen is displayed:<\/p>\n <\/p>\n Figure 1. Welcome Screen<\/em><\/span><\/p>\n If you already have Box apps created, you will see the following screen:<\/p>\n <\/p>\n Figure 2. Displayed Screen for Box Applications Users<\/em><\/span><\/p>\n 4. On the Create a New Box App<\/strong> page, select Enterprise Integration<\/strong> and click Next<\/strong> to proceed.<\/p>\n <\/p>\n Figure 3. Create A New Box App Screen<\/em><\/span><\/p>\n 5. On the next page, set the authentication method to OAuth 2.0 with JWT (Server Authentication)<\/strong>. Click Next<\/strong>.<\/p>\n <\/p>\n Figure 4. Screen with Authentication Method<\/em><\/span><\/p>\n 6. Provide the name of the application (the name should be unique) and click Create App<\/strong>.<\/p>\n <\/p>\n Figure 5. Screen for User to Create Box App Name<\/span><\/em><\/p>\n Once the unique app name is provided, the following confirmation page is displayed:<\/p>\n <\/p>\n Figure 6. Box App Creation Confirmation Page<\/em><\/span><\/p>\n You are also provided with the developer token, which remains valid for one hour and can be used to make the first API call for a new app.<\/p>\n 7. Click View Your App<\/strong>. This will take you to the App Configuration<\/strong> page. It includes the same developer token shown on the previous page, which can be used for testing the app.<\/p>\n <\/p>\n Figure 7. App Configuration Page<\/span><\/em><\/p>\n 8. Under the Application Access<\/strong>, select Enterprise<\/strong>.<\/p>\n <\/p>\n Figure 8. Screen with Enterprise Enabled<\/span><\/em><\/p>\n 9. Under the Application Scopes<\/strong>, confirm that the properties are defined as shown in the snapshot below.<\/p>\n <\/p>\n Figure 9. Application Scopes with Selected Properties<\/em><\/span><\/p>\n 10. Under the Advanced Features<\/strong>, enable both options: Perform Actions as Users<\/strong> and Generate User Access Tokens<\/strong>.<\/p>\n <\/p>\n Figure 10. Enable Perform Actions as Users and Generate User Access Tokens<\/span><\/em><\/p>\n 11. Under the Add and Manage Public Keys<\/strong> section, click Generate a Public\/Private Keypair<\/strong>.<\/p>\n <\/p>\n Figure 11. Configuration Screen to Generate A Public\/Private Keypair<\/span><\/em><\/p>\n This downloads a JSON file with the Box connection details (which will be used in Ephesoft Transact during the Box plugin configuration), and the following confirmation message is displayed:<\/p>\n <\/p>\n Figure 12. Example of Confirmation Message<\/span><\/em><\/p>\n This JSON file contains the following Box app settings:<\/p>\n Note:<\/strong> You may be prompted to complete a 2-step verification with one-time password being sent to the phone number you used to register. You can set up 2-step verification using the steps found in the Enabling 2-Step Verification<\/a> section of this document.<\/p>\n <\/p>\n Figure 13. Prompt for 2-Step Verification<\/em><\/span><\/p>\n 12. Click Save Changes<\/strong>.<\/p>\n <\/p>\n Figure 14. Save Changes Option in Configurations Screen<\/span><\/em><\/p>\n Once the Box application is created and configured with the previous steps, the Box administrator must also authorize the application to be able to use it.<\/p>\n Without authorization, the following message appears in the Ephesoft Transact UI when trying to access the app:<\/p>\n <\/p>\n Figure 15. Example of Authorization Error Message<\/em><\/span><\/p>\n To authorize the app:<\/p>\n 1. On the navigation panel, select the Admin Console<\/strong> (https:\/\/app.box.com\/master<\/a>) and click Enterprise Settings<\/strong>.<\/p>\n <\/p>\n Figure 16. Admin Console on Navigation Panel<\/span><\/em><\/p>\n 2. Navigate to the Apps<\/strong> section, scroll down to Custom Applications<\/strong> and click Authorize New App<\/strong>.<\/p>\n <\/p>\n Figure 17. Authorize New App in Custom Applications Section<\/em><\/span><\/p>\n A dialog box appears in which you must provide the clientID<\/strong> from the JSON file downloaded earlier.<\/p>\n 3. Enter the clientID<\/strong> value in the API Key<\/strong> field and click Next<\/strong>.<\/p>\n <\/p>\n Figure 18. App Authorization<\/em><\/span><\/p>\n 4. In the App<\/strong> Authorization<\/strong> pop-up, click Authorize<\/strong>. If all configurations have been done correctly earlier, the authorization should be granted to All Users<\/strong>.<\/p>\n <\/p>\n Figure 19. App Authorization for All Users<\/span><\/em><\/p>\n If you get the Only App Users of this App<\/strong> option instead, review the steps above and update the settings that require modifications.<\/p>\n Important<\/strong>: If you make any changes to your dev app, you need to reauthorize it. To reauthorize your app, click ellipses (\u2026<\/strong>) button under Actions<\/strong> for the corresponding app and select Reauthorize app<\/strong>.<\/p>\n <\/p>\n Figure 20. Reauthorization of Application in Custom Applications Screen<\/span><\/em><\/p>\n 1. On the Navigation panel, click Settings<\/strong> to open the Account Settings<\/strong> screen.<\/p>\n <\/strong><\/p>\n Figure 21. Settings Option in Navigation Panel<\/span><\/em><\/p>\n 2. Under the Authentication<\/strong> section, enable Require 2-step verification for unrecognized logins<\/strong>.<\/p>\n <\/p>\n Figure 22. Authentication Screen to Enable 2-Step Verification<\/span><\/em><\/p>\n 3. When the Enable Login Verification<\/strong> dialog appears, provide the required information and click Continue<\/strong>.<\/p>\n <\/p>\n Figure 23. Enable Login Verification Dialog Screen<\/span><\/em><\/p>\n 4. Enter the Confirmation Code<\/strong> and click Continue<\/strong>.<\/p>\n <\/p>\n Figure 24. Screen with Confirmation Code Prompt<\/span><\/em><\/p>\n The system returns to the Account Settings<\/strong> screen.<\/p>\n 5. Click Save Changes<\/strong>.<\/p>\n To configure export from Ephesoft Transact to the Box repository:<\/p>\n 1. Create or open your batch class.<\/p>\n 2. Configure document types and index fields.<\/p>\n 3. In the Export<\/strong> module, add the BOX_PLUGIN plugin. You can drag and drop it from the Associated Plugins<\/strong> to the Selected Plugins<\/strong> list, or use the right arrow to move the selected plugin to the Export module.<\/p>\n Important: <\/strong>Ensure to place BOX_PLUGIN plugin before the CLEANUP plugin and click Apply<\/strong> to save the changes.<\/p>\n <\/p>\n Figure 25. Place BOX_PLUGIN before CLEANUP Plugin<\/span><\/em><\/p>\n 4. On the BOX_PLUGIN Configuration screen, select ON<\/strong>.<\/p>\n <\/p>\n Figure 26. BOX_PLUGIN Configuration Screen<\/span><\/em><\/p>\n 5. Expand the BOX_PLUGIN drop-down and select Configure<\/strong>.<\/p>\n 6. To add a new configuration, click Add<\/strong>.<\/p>\n <\/p>\n Figure 27. Adding a New Configuration<\/span><\/em><\/p>\n This opens the Box Mapping Configurations<\/strong> screen.<\/p>\n 7. In the first section, select the Document Type<\/strong> and Connection Type<\/strong>. Note that the Connection Type <\/strong>options become enabled only after you select the Document Type<\/strong>.<\/p>\n <\/p>\n Figure 28. Box Mapping Configurations Screen<\/span><\/em><\/p>\n 8. Once the Connection Type<\/strong> is selected, the Connection Details<\/strong> section opens. Provide your connection details here.<\/p>\n This section offers two types of environments:<\/p>\n<\/a>Prerequisites<\/h1>\n
\n
<\/a><\/a>Configurations: Box Platform<\/h1>\n
<\/a>Creating and Configuring a New App<\/strong><\/h2>\n
\n
<\/a>Authorizing the Box Developer Application for Access from API<\/strong><\/h2>\n
<\/a><\/a>Enabling 2-Step Verification<\/strong><\/h2>\n
<\/a>Configurations: Ephesoft Transact<\/h1>\n
<\/a>Configuring the BOX_PLUGIN Plugin<\/strong><\/h2>\n