Laserfiche Connector for Boomi

For customers using Boomi, Laserfiche has provided an iPaaS connector that makes the interaction between Laserfiche repository and other third-parties easier. The operations supported in the Laserfiche connector are based on Laserfiche repository APIs.

The Laserfiche Integration with Boomi is helpful for:

• Viewing a document or document metadata from Laserfiche and viewing or downloading it in another system, like a CRM, ERP, or any system with relevant documents stored within Laserfiche.
• Saving a document to Laserfiche or updating Laserfiche metadata from another system. This action can be monitored to start a Laserfiche business process.
• Gathering healthcare data. You can convert a Laserfiche document's metadata into the HL7 data format before sending it to a healthcare system requiring that standard.
• AP Processing. Laserfiche’s solutions for automating invoice processing can update necessary ERP and financial systems.

Note: The Laserfiche connector for Boomi is based on Laserfiche Repository API V1 build version 3a7a49ffc2db49aecc10091994a0292be398cd51_.20221214.3

How to Configure the Laserfiche Connector for Boomi

First, configure a connection to your Laserfiche repository.

1. From the Boomi Designer, select Create New and select Connection.
2. Select Laserfiche Connector from the drop-down menu and click Create.
3. Provide a descriptive name for the Connection, and define the following
   • Platform: The Laserfiche Connector is available for both Laserfiche Cloud and self-hosted installations.

   For Laserfiche Cloud

   • Service Principal Key: Create the Service Principal Key by creating a Boomi-specific Service Principal user in your Laserfiche Account Administration. Grant this user the appropriate access rights in Laserfiche to act on behalf of the Laserfiche Connector. Then open the user you created and click Create Service Principal Keys. Ensure you save this key as you will not be able to view this key again in Laserfiche.
   • Base-64 Encoded Access Key: To create the Base-64 Encoded Access Key, in the Laserfiche Developer Console, create a Boomi app by creating a service application and selecting the Service Principal user as the Service Account. In the Boomi app you created, navigate to the Authentication tab, and click Create key next to Access Keys. Then download the key as a base-64 string and copy the key from there.

   For self-hosted installations

   • Base URL: The base URL for your Laserfiche API. E.g., https://ServerName/LFRepositoryAPI
   • Repository ID: The name of your Laserfiche repository.
   • Username: The username of an account that has the appropriate access rights to the Laserfiche repository to make changes on behalf of Boomi.
   • Password: The password for the above account.
4. Click Test Connection and choose an Atom (runtime environment) to test the connection on.

How to Use the Laserfiche Connector for Boomi

1. Open the Boomi process you want to add a Laserfiche Connector to.
2. Search for the Laserfiche Connector and drag it to the canvas.
3. In the Connector Shape pane's General tab, define the following:
• Display Name: Provide a descriptive name for your shape that describes the action the shape will take in Laserfiche
• Connector: The connector will default to the connector you selected on the canvas, but you can change that here if needed.
• Action: Select the action you want the connector to take in Laserfiche. See a list of available actions.
• Assign Entry Links
• Assign Field Values
• Assign Tags
• Cancel Operation
• Cancel or Close a Search
• Copy Entry Async
• Create Search Operation
• Create Simple Search Operation
• Create or Copy Entry
• Delete Assigned Template
• Delete Document
• Delete Entry Info
• Delete Pages
• Export Document
• Export Document with Audit Reason
• Get Audit Reasons
• Get Document Content Type
• Get Dynamic Field Values
• Get Entry
• Get Entry Listing
• Get Entry by Path
• Get Field Definition by ID
• Get Field Definitions
• Get Field Values
• Get Link Definition by ID
• Get Link Definitions
• Get Link Values from Entry
• Get Operation Status and Progress
• Get Repository List
• Get Search Context Hits
• Get Search Results
• Get Search Status
• Get Tag Definition by ID
• Get Tag Definitions
• Get Tags Assigned to Entry
• Get Template Definition by ID
• Get Template Definitions
• Get Template Field Definitions
• Get Template Field Definitions by Template Name
• Get Trustee Attribute Key Value Pairs
• Get Trustee Attribute Value by Key
• Import Document
• Move or Rename Entry
• Write Template Value to Entry
• Connection: Select the connection you configured in the How to Configure the Laserfiche Connector for Boomi section.
• Operation: Select the operation you want the action to perform. The operation specifies exactly how the action will run. For example, which repository the action will interact with and which data will be returned by the action. You can select a pre-configured operation or click the green plus button to create an operation. See How to Configure an Operation below.
4. In the Parameters tab, click the green plus button to add a parameter. The parameters available are from the request schema defined in the request profile. The Request profile corresponds with the JSON schema of the request body of the Laserfiche API call and defines the data expected by the action. To learn more about request profiles, see How to Configure an Operation below.
5. In the Dynamic Operation Properties tab, you can add values that will overwrite the default values defined in the operation. These are separate from the parameters defined in the previous tab that come from the request profile. The input parameters available here correspond with the fields in the operation's configuration. See How to Configure an Operation below.

How to Configure a Boomi Operation

An operation defines how the Laserfiche iPaaS connector will interact with your Laserfiche repository. It represents a specific action (Search, Create, Update) to perform against a specific object in your Laserfiche repository. An object can be a document, folder, type of metadata, audit reason, task, or user attribute.

1. In the Boomi Designer, select Create New, and select Connector operation. Alternatively, when configuring a shape on the canvas, click the green plus button next to Operation to define an operation for that shape.
2. The fields available for the operation will depend on the Connector Action and will correspond with the parameters available in the Laserfiche API. See the parameters for each action here.
3. The Object field corresponds to the action's category in the Laserfiche API.
4. Click the Import button to retrieve Request and Response profiles for the operation. Select an Atom (runtime environment) and the Connection you configured above. The Request profile corresponds with the json schema of the request body of the API call. You can review the Request and Response profiles to see the type of data the action will get and return when the action runs.
5. You can also set Tracking Direction to record either input or output data in your process reporting.
6. Select Error Behavior if you want to be able to act on failed operations in your process instead of just reporting them on the Manage page.
7. The rest of the options are operation parameter fields based on the Connector action and the Laserfiche API. The values entered here become default values for the all shapes in the process that use this operation. You can override the default values in the shape's Dynamic Operation Properties tab. Some common fields are:
   • Repository ID: For Laserfiche Cloud, you can find your repository ID from your repository's URL. For example, https://app.laserfiche.com/laserfiche/browse.aspx?repo=r-123a45aa . For self-hosted Laserfiche installations, your repository ID is the name of the repository.
   • Entry ID: Enter the ID of the entry you want the operation to interact with by default.

How to Set up an Atom

See Boomi's documentation for setting up an atom.

How to Test a Laserfiche Connector Shape

See the Boomi documentation.

How to Send a Request to Boomi through a Laserfiche Web Request Rule

You can start Boomi processes from on a web service request from Laserfiche, allowing you to automatically invoke your integration from a Laserfiche workflow or business process. To start Boomi processes from Laserfiche, you must both configure Boomi to listen for the web request from Laserfiche and configure a web request rule in Laserfiche to send information to Boomi.

Configuring a Boomi Atom to Listen for a Web Request

1. Navigate to the Atom Management page in Boomi.
2. Select the Atom that will be running the Boomi process.
3. Under Settings & Configurations, select Shared Web Server.
4. In the General tab, under Basic Settings, make a note of the base URL. You'll use this value in the Laserfiche web service connection you'll create in the next section.
5. In the User Management tab, configure a user that Boomi can use to call to the web service.

Configuring the Laserfiche Web Service Connection to Connect to Boomi

1. In Laserfiche, navigate to the Process Automation landing page, and click Integrations.
2. Select Web Service Connections, and create a new connection. Learn more about web service connections.
3. Provide a descriptive name for the connection, and select to send requests directly to Boomi.
4. Click Create.
5. Enter the Boomi base URL, which can be found on the Shared Web Server page of the Boomi Atom configured in the previous section.
6. Select Basic authentication.
7. Enter the username and password of the user you configured on the Shared Web Server page of the Boomi Atom configured in the previous section.



• Username: Use the full username found in italics under the Username field in Boomi
• Password: Use the token found under Authentication Credentials in Boomi.
8. Click Test.

Note: If you click Test, you might get a 404 response since the base URL itself is not hosted on cloud. This response can be ignored and will not be an issue moving forward.

9. Click Create to create the connection.

Configuring a Boomi Operation and Shape to Listen for a Web Request

Operation

1. In Boomi, create a Connector Operation, select Web Services Server as the connection, and click Create.
2. Set the Connector Action to Listen.
3. Select the Operation Type that corresponds with information you want to pass to Boomi.
4. Next to Object, provide an object name. The value you enter here will become part of the Simple URL Path for the connector operation. You'll use this URL in your Laserfiche Web Request Rule as described in the next section.
5. Configure the expected input type for the data Boomi is expecting to receive.
6. Configure the output type to specify how the Boomi shape using this operation will format the data it exports. Depending on the output type you select, you can choose a Laserfiche request profile to further format the data.

Shape

1. Navigate to the Boomi canvas, and drag a Start Shape to the Boomi canvas.
2. Provide a descriptive display name for the shape, e.g., "Listen for Web Service Call from Laserfiche"
3. Next to Connector, select Web Services Server.
4. Next to Action, select Listen.
5. Next to Operation, select the operation you created in the previous section.

Configuring the Laserfiche Web Request Rule to Start the Boomi Process

1. Navigate to the Process Automation landing page, and click Rules.
2. Select Web Request, and create a new rule. Learn more about rules.
3. Enter a rule name and description.
4. Select Web Service Connection, and select the connection you made in theConfiguring the Laserfiche Web Service Connection section above.
5. Click Create.
6. In the Web Request Rule editor, in the Request tab, the base URI should match the base URL provided in the Laserfiche web service connection. See the Configuring the Laserfiche Web Service Connection section above.
7. Complete the request URI with the Simple URL Path provided in the Boomi operation. Append parameters in this section of the URL as needed. You can add Laserfiche tokens that can be filled in by a workflow when running the rule. E.g., /ws/simple/getExporter?entryid=%(Name:EntryID;Type:Text)
8. Under Method, select Post.
9. Under Content Type, select type of data you are sending to Boomi. E.g., application/json. The content type should match the input type specified in the Boomi operation.
10. Under Content Body, enter the data you want to send to Boomi.



11. Click Test Web Request.
12. In the Test Web Request Rule dialog, double check the Request and provide Input Parameters.
13. Click Test to proceed.
14. This test result will show when the request has been successfully sent to Boomi and has passed basic authentication.
15. You can now run this rule, which will kick off your Boomi process, from the Run Rule activity in Laserfiche workflow or a Rules Service Task in a Laserfiche business process.