Addovation Stream - Setup Guide for IFS Cloud (Customer)

Last Updated: 2024-12-20

Overview

This customer setup guide provides a comprehensive overview and step-by-step instructions for configuring the Addovation Stream on IFS Cloud. It details the essential tasks the customer needs to perform, including gathering data and calling stream services, deploying the utility to gather data, creating a queue, importing the application configuration package, deploying the projection, and enabling communication. Each step is thoroughly explained to ensure a smooth and efficient setup process, empowering the customer to successfully configure the Addovation Stream on their IFS Cloud environment.

Setup IFS Cloud

Gather Data & Call Stream Service

Deploy Utility to Gather Data

  • Addovation's utility for gathering data and exporting as JSON allows you to use SQL and Quick Reports to fetch data from anywhere in IFS Cloud.

  • Use Create_Document method to create a document.

    • Document metadata is defined here (ex: customerId, requestId, subscriptionKey, template, etc)

  • Download the PL/SQL package file here and deploy.

Create Queue “ADDO_DOCGEN_OUT” in IFS Connect to Call the Stream Service

  • Go to Message Queues and Click on + option.

  • Provide the Instance name to continue.

  • Provide a description and select Insequence as the Execution Mode.

Import Application Configuration Package

This section explains configuring a button to call the Stream Service.

  • This package Contains,

    • Projection configurations.

    • Page Configurations for Prepare Work Order window.

  • Download the application configuration package file here

  • Now go to Solution Manager-> Configuration -> Application Configuration Packages -> Import Configuration -> Import Configuration Package.

  • Provide the package file as below.

  • After successful configuration, you can see the Create DocGen Report in Prepare Work Order as below.

Deploy Projection to Check-in the Generated Document

The IFS Projection is a self-contained web-API which implements a defined business function. The IFS cloud communicates with the database through Projections(APIs). The pages depend on Projections for retrieval of data and to perform actions. When granting access to a Projection, all client pages using that projection will become available. Projections can have four different Access Levels in relation to a Permission Set: None, Read-Only, Custom and Full. A Full grant provides read access to data sources and allows creating, updating, and deleting access to all data sources within the projection. It also enables the invocation of all actions exposed by the projection.

There is only one projection which should be deployed in order to support checking in the generated document returned from the DocGen service.

Open Up for Communication

Import Routing Addresses

  • Download the RoutingAddress_Addovation DocGen Service.xml located here

  • Go to Solution manager-> Integration -> IFS Connect -> Import Configuration.

  • Brows the downloaded file and set the Import Method as Add and click on Import.

  • Navigate to the created routing address. Set the Rest Root Endpoint to the HTTP POST URL in IFStoDocGenUtil, which was copied at the end of step 2.2.

Import Routing Rules

  • Download the RoutingRule_Addovation DocGen integration routing rule.xml file from Routing Rules

  • Go to Solution manager-> Integration -> IFS Connect -> Import Configuration and Brows the downloaded file and set the Import Method as Add and click on Import.

Allow Access from IFS to IPs

Below logic app in Addovation tenant needs access to the customer’s IFS environment.

  • IP whitelisting for Logic App (sending Queue messages /upload images to the Blob) /(inbound)

Network Configurations

Click here to read details about network configurations.