# mulesoft Manufacturing - Full Documentation

<!-- document id=fa12ff5a9a8ecc8e056594f1f3f485441823a2816a7782235a9a6dc0a1f8b94a url=/mulesoft/current/en-us/manufacturing/latest/mfg-setup-guide.md -->

---
product: Manufacturing
version: 1.4
is-latest-version: true
---

# Accelerator Setup Guide

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This page provides guidance on configuring the various systems and products required to implement
the use cases provided by this solution.

## Salesforce Manufacturing Cloud

The following provides guidance on the custom fields that need to be created for the customer,
product, and sales order sync use cases in order to function end-to-end.

## Custom Fields

The following fields must be created in the corresponding objects.

<table><colgroup><col> <col> <col> <col> <col> <col> <col></colgroup><thead><tr><th>Salesforce Object</th><th>Field Name</th><th>Data Type</th><th>Length</th><th>Unique</th><th>ExternalId</th><th>Description</th></tr></thead><tbody><tr><td><p>Account</p></td><td><p>Global_Customer_Id__c</p></td><td><p>Text</p></td><td><p>36</p></td><td><p>Y</p></td><td><p>Y</p></td><td></td></tr><tr><td><p>Order</p></td><td><p>Global_SalesOrder_Id__c</p></td><td><p>Text</p></td><td><p>36</p></td><td><p>Y</p></td><td><p>Y</p></td><td></td></tr><tr><td><p>Order</p></td><td><p>Total_Tax__c</p></td><td><p>Currency</p></td><td><p>10,2</p></td><td><p>Y</p></td><td><p>Y</p></td><td></td></tr><tr><td><p>Order</p></td><td><p>OrderTotalAmount__c</p></td><td><p>Formula (Currency)</p></td><td><p>10,2</p></td><td><p>Y</p></td><td><p>Y</p></td><td><p>Order Total Amount is sum of Shipping<em>c, Total_Tax</em>c, and TotalAmount</p></td></tr><tr><td><p>Product2</p></td><td><p>Global_Product_Id__c</p></td><td><p>Text</p></td><td><p>36</p></td><td><p>Y</p></td><td><p>Y</p></td><td></td></tr></tbody></table>

## Anypoint MQ Configuration

The Anypoint-MQ-Queues-Exchanges Postman collection in the
[MFG Common Resources project](https://anypoint.mulesoft.com/exchange/org.mule.examples/mfg-common-resources-src/)
will pre-create all MQ destinations required by the accelerator components.

The collection requires the dev environment template to be imported into your Postman workspace and
assigned proper values first. The following MQ destinations will be created upon successful
execution.

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Queue Name</th><th>Bound to Exchange</th><th>Dead Letter Queue Name</th></tr></thead><tbody><tr><td><p>mfg-customer-update-queue</p></td><td><p>accelerator-customer-update-exchange</p></td><td><p>mfg-customer-update-queue-dlq</p></td></tr><tr><td><p>mfg-product-update-queue</p></td><td><p>accelerator-product-update-exchange</p></td><td><p>mfg-product-update-queue-dlq</p></td></tr><tr><td><p>mfg-order-update-queue</p></td><td><p>accelerator-order-update-exchange</p></td><td><p>mfg-order-update-queue-dlq</p></td></tr><tr><td><p>mfg-rebatepayout-create-queue</p></td><td><p>mfg-rebatepayout-create-exchange</p></td><td><p>mfg-rebatepayout-create-dl-queue</p></td></tr></tbody></table>

## Configurations in S/4HANA

Below are all the configuration arrangements that are required for this use case:

<table><colgroup><col> <col></colgroup><thead><tr><th>Communication Arrangement</th><th>Service Name</th></tr></thead><tbody><tr><td><p>SAP_COM_0008</p></td><td><p>Business Partner - Replicate from SAP S/4HANA Cloud to Client</p></td></tr><tr><td><p>SAP_COM_0009</p></td><td><p>Product Catalog - Replicate from SAP S/4HANA Cloud to Client</p></td></tr><tr><td><p>SAP_COM_0287</p></td><td><p>Sales Order Bulk Replication Integration</p></td></tr></tbody></table>

## Configure Communication Arrangement

For communication arrangement SAP\_COM\_0287 to replicate the sales orders pricing elements, the
following configuration is required.

1.  Enter the **Communication arrangement** app to edit or create the arrangement.

2.  At outbound services sections, complete with the following:

![SAP S/4HANA communication arrangement configuration for SAP\_COM\_0287](/mulesoft/current/en-us/manufacturing/latest/_images/mfg-saphana-setup-1.png)

## Custom Fields

Create the following fields in the corresponding objects for the use case:

<table><colgroup><col> <col> <col> <col> <col> <col></colgroup><thead><tr><th>Salesforce Object</th><th>Field Name</th><th>Data Type</th><th>Length</th><th>Unique</th><th>ExternalId</th></tr></thead><tbody><tr><td><p>BusinessPartner</p></td><td><p>YY1_SME_MPARTYROLEID_M_bus</p></td><td><p>Text</p></td><td><p>40</p></td><td><p>Y</p></td><td><p>Y</p></td></tr><tr><td><p>SalesOrder</p></td><td><p>YY1_SME_MORDERID_MFG_SDH</p></td><td><p>Text</p></td><td><p>40</p></td><td><p>Y</p></td><td><p>Y</p></td></tr><tr><td><p>Product</p></td><td><p>YY1_SME_UnvProductId_M_PRD</p></td><td><p>Text</p></td><td><p>40</p></td><td><p>Y</p></td><td><p>Y</p></td></tr></tbody></table>

## Custom CDS View

- Name: YY1\_JournalEntryItem\_Info

- Representative Key: AccountingDocument

- Scenario: External API

- Data Source: I\_JournalEntryItem

- Elements:

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Alias</th><th>Path</th><th>Type</th><th>Key</th></tr></thead><tbody><tr><td><p>SourceLedger</p></td><td><p>I_JournalEntryItem.SourceLedger</p></td><td><p>CHAR (2)</p></td><td><p>Yes</p></td></tr><tr><td><p>CompanyCode</p></td><td><p>I_JournalEntryItem.CompanyCode</p></td><td><p>CHAR (4)</p></td><td><p>Yes</p></td></tr><tr><td><p>FiscalYear</p></td><td><p>I_JournalEntryItem.FiscalYear</p></td><td><p>NUMC (4)</p></td><td><p>Yes</p></td></tr><tr><td><p>AccountingDocument</p></td><td><p>I_JournalEntryItem.AccountingDocument</p></td><td><p>CHAR (10)</p></td><td><p>Yes</p></td></tr><tr><td><p>LedgerGLLineItem</p></td><td><p>I_JournalEntryItem.LedgerGLLineItem</p></td><td><p>CHAR(6)</p></td><td><p>Yes</p></td></tr><tr><td><p>Ledger</p></td><td><p>I_JournalEntryItem.Ledger</p></td><td><p>CHAR(2)</p></td><td><p>Yes</p></td></tr><tr><td><p>AccountingDocumentType</p></td><td><p>I_JournalEntryItem.AccountingDocumentType</p></td><td><p>CHAR(2)</p></td><td><p>No</p></td></tr><tr><td><p>Customer</p></td><td><p>I_JournalEntryItem.Customer</p></td><td><p>CHAR(10)</p></td><td><p>No</p></td></tr><tr><td><p>YY1_SME_ExtPaymID_MFG_JEI</p></td><td><p>I_JournalEntryItem.YY1_SME_ExtPaymID_MFG_JEI</p></td><td><p>CHAR(20)</p></td><td><p>No</p></td></tr><tr><td><p>CreationDate</p></td><td><p>I_JournalEntryItem._JournalEntry.AccountingDocumentCreationDate</p></td><td><p>DATS (8)</p></td><td><p>No</p></td></tr><tr><td><p>LastChangeDate</p></td><td><p>I_JournalEntryItem._JournalEntry.LastChangeDate</p></td><td><p>DATS (8)</p></td><td><p>No</p></td></tr><tr><td><p>IsReversed</p></td><td><p>I_JournalEntryItem._JournalEntry.IsReversed</p></td><td><p>CHAR(1)</p></td><td><p>No</p></td></tr><tr><td><p>ReversalReason</p></td><td><p>I_JournalEntryItem._JournalEntry.ReversalReason</p></td><td><p>CHAR(2)</p></td><td><p>No</p></td></tr><tr><td><p>ReverseDocument</p></td><td><p>I_JournalEntryItem._JournalEntry.ReverseDocument</p></td><td><p>CHAR(10)</p></td><td><p>No</p></td></tr><tr><td><p>ClearingDate</p></td><td><p>I_JournalEntryItem.ClearingDate</p></td><td><p>DATS (8)</p></td><td><p>No</p></td></tr><tr><td><p>ClearingAccountingDocument</p></td><td><p>I_JournalEntryItem.ClearingAccountingDocument</p></td><td><p>CHAR(10)</p></td><td><p>No</p></td></tr><tr><td><p>ClearingDocumentLastChangeDate</p></td><td><p>I_JournalEntryItem._ClearingAccountingDocument.LastChangeDate</p></td><td><p>DATS (8)</p></td><td><p>No</p></td></tr><tr><td><p>ClearingDocumentCreationDate</p></td><td><p>I_JournalEntryItem._ClearingAccountingDocument.AccountingDocumentCreationDate</p></td><td><p>DATS (8)</p></td><td><p>No</p></td></tr><tr><td><p>ClearingDocumentCreationTime</p></td><td><p>I_JournalEntryItem._ClearingAccountingDocument.CreationTime</p></td><td><p>TIMS (6)</p></td><td><p>No</p></td></tr><tr><td><p>AmountInCompanyCodeCurrency</p></td><td><p>I_JournalEntryItem._ClearingAccountingDocument._OperationalAcctgDocItem.AmountInCompanyCodeCurrency</p></td><td><p>CURR (23,2)</p></td><td><p>No</p></td></tr><tr><td><p>AmountInTransactionCurrency</p></td><td><p>I_JournalEntryItem._ClearingAccountingDocument._OperationalAcctgDocItem.AmountInTransactionCurrency</p></td><td><p>CURR (23,2)</p></td><td><p>No</p></td></tr><tr><td><p>TransactionCurrency</p></td><td><p>I_JournalEntryItem._ClearingAccountingDocument._OperationalAcctgDocItem.TransactionCurrency</p></td><td><p>CUKY (5)</p></td><td><p>No</p></td></tr><tr><td><p>CompanyCodeCurrency</p></td><td><p>I_JournalEntryItem._ClearingAccountingDocument._OperationalAcctgDocItem.CompanyCodeCurrency</p></td><td><p>CUKY (5)</p></td><td><p>No</p></td></tr></tbody></table>

A custom communication scenario has to be created adding this CDS view as an inbound service. Once
published, create a communication arrangement using that custom communication scenario. That
arrangement will have the service URL to retrieve the Journal Entry Item information.

## See Also

- [Prerequisites](https://docs.mulesoft.com/manufacturing/latest/prerequisites)

- [MuleSoft Accelerator for Manufacturing](https://docs.mulesoft.com/manufacturing/latest/)

<!-- document id=006ce7de3b48809924055f3593c9a59ee9111f8eccc3517200fe04ad8aff8901 url=/mulesoft/current/en-us/manufacturing/latest/index.md -->

---
product: Manufacturing
version: 1.4
is-latest-version: true
---

# MuleSoft Accelerator for Manufacturing

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

MuleSoft Accelerator for Manufacturing equips discrete and process manufacturers with foundational
assets for common use cases to accelerate their digital transformation journey. Our pre-built APIs,
implementation templates, reference architecture, and connectors allow IT teams to spend more time
innovating, and less time building common integrations from scratch.

## Use Cases

The following use cases are supported by the MuleSoft Accelerator for Manufacturing:

- [Account and product and order sync](https://anypoint.mulesoft.com/exchange/org.mule.examples/mulesoft-accelerator-for-manufacturing/minor/1.4/pages/qrc-zzh/Use%20case%201%20-%20Account%20and%20product%20and%20order%20sync/)
  — Streamline account forecasts by connecting critical account, product, and order data from your
  ERP to CRM. This example will show how to accomplish this using SAP S/4HANA and Salesforce
  Manufacturing Cloud.

- [Sales rebate management](https://anypoint.mulesoft.com/exchange/org.mule.examples/mulesoft-accelerator-for-manufacturing/minor/1.4/pages/Use%20case%202%20-%20Sales%20rebate%20management/)
  — This solution seamlessly syncs customer and sales order data between SAP and Salesforce
  Manufacturing Cloud, and creates a credit memo in SAP in line with program guidelines and
  calculations.

- [Total productive maintenance](https://anypoint.mulesoft.com/exchange/org.mule.examples/mulesoft-accelerator-for-manufacturing/minor/1.4/pages/Use%20case%203%20-%20Total%20productive%20maintenance/) -
  This solution seamlessly aggregates factory floor equipment data, like temperature and vibration,
  into a data visualization tool. This data visualization tool can model the data, and a business
  user can pre-define business criteria to trigger equipment maintenance work orders in a servicing
  case management system.

### Shared Use Cases

The following use cases provided by the
[MuleSoft Accelerator for SAP](https://anypoint.mulesoft.com/exchange/org.mule.examples/mulesoft-accelerator-for-sap/)
are also leveraged by this accelerator:

- [Procure-to-pay](https://anypoint.mulesoft.com/exchange/org.mule.examples/mulesoft-accelerator-for-sap/minor/1.6/pages/Use%20case%202%20-%20Procure-to-pay/) -
  Streamline your procure-to-pay process with pre-built APIs, implementation templates, and
  connectors to seamlessly move supplier, invoice, and goods receipt data.

- [Quote-to-cash: Salesforce and SAP S/4HANA](https://anypoint.mulesoft.com/exchange/org.mule.examples/mulesoft-accelerator-for-sap/minor/1.6/pages/Use%20case%203a%20-%20Quote-to-cash%20-%20Salesforce%20and%20SAP%20S4HANA/) -
  Sync order, inventory, and customer data from opportunity to close between Salesforce Sales Cloud
  (including CPQ) and SAP S/4HANA.

- [Quote-to-cash: B2B EDI](https://anypoint.mulesoft.com/exchange/org.mule.examples/mulesoft-accelerator-for-sap/minor/1.6/pages/Use%20case%203b%20-%20Quote-to-cash%20-%20B2B%20EDI/) -
  Enable the sales order/purchase order and post-purchase order transaction flows between
  businesses, with one business serving as the buyer and the other as the supplier.

- [Real-time and bulk data lakes integration](https://anypoint.mulesoft.com/exchange/org.mule.examples/mulesoft-accelerator-for-sap/minor/1.6/pages/Use%20case%204%20-%20Real-time%20and%20bulk%20data%20lakes%20integration/) -
  Send sales order, inventory, and customer information from source systems to common data lake
  storage repositories.

## See Also

- [Getting Started](https://docs.mulesoft.com/accelerators-home/getting-started)

- [Prerequisites](https://docs.mulesoft.com/manufacturing/latest/prerequisites)

- [Release Notes](https://docs.mulesoft.com/release-notes/accelerators/manufacturing/manufacturing-release-notes)

- [MuleSoft Accelerator for Manufacturing on Exchange](https://anypoint.mulesoft.com/exchange/org.mule.examples/mulesoft-accelerator-for-manufacturing/)

<!-- document id=cc32cbda08da1ca802f39ddbcd5cb430612ff5f1cc730b81ea3679008655495e url=/mulesoft/current/en-us/manufacturing/latest/osisoft-pi-setup-guide.md -->

---
product: Manufacturing
version: 1.4
is-latest-version: true
---

# OSISoft PI Setup Guide for Productive Maintenance

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This section explain how to configure several components of OSI PI in order to connect to PI servers
to retrieve time series data from PI data server.

## Configuration Steps

1.  [PI Data Server Connection](#pi-data-server-connection)

2.  [PI Web API Configuration](#pi-web-api-configuration)

3.  [Web API System Configuration](#web-api-system-configuration)

4.  [Configure PI Randomizer Interface](#configure-pi-randomizer-interface)

5.  [Configure PI Points](#configure-pi-points)

6.  [Use PI Web API to Retrieve Attributes and Values of PI Points](#use-pi-web-api-to-retrieve-attributes-and-values-of-pi-points)

7.  [PI Point Configuration for this Use Case](#pi-point-configuration-for-this-use-case)

## PI Data Server Connection

The PI data server hosts configuration of PI points, stores values of the PI points and allows PI
Web API connect to it and retrieve data from the clients. Make sure your machine can connect to the
running instance of the PI data server.

1.  Go to the Windows menu items or location of PI system typically located at
    C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\PI System.

2.  Run PI system explorer and select Servers menu.

3.  If you see Data Server (and Asset Server) are connected no further configuration is required.
    Otherwise select Tools > Options menu.

4.  Check PI Trust, uncheck Windows Security and check Allow login prompt. Then when you try to
    connect to data server it will prompt you with Windows authentication and your windows
    credentials.

## PI Web API Configuration

The PI Web API needs to be configured to retrieve PI points attributes and values using REST.

1.  Go to the Windows menu items or location of PI system typically located at
    C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\PI System.

2.  Run PI Web API Admin Utility and connects to the PI Asset Server instance.

3.  Select HTTPS port 443 and Firewall exception.

4.  Select Bypass Advanced Certification Check.

5.  Select account type and account name.

6.  Select AF server and database, and data server.

7.  Follow the screens to continue configuration and note down the PI Web API url.

## Web API System Configuration

This section talks about configuration items which are supported but not configured by default.
Follow these steps to configure Web API system:

1.  Open PI System Explorer

2.  Click on Database and select Configuration

3.  Expand Elements / OSISoft / PI Web API / PI\_Server\_Host / System Configuration, and then click
    on 'Attributes' tab

4.  Configure the following items:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Item</th><th>Details</th><th>Comments</th></tr></thead><tbody><tr><td><p>Basic Auth config</p></td><td><p>* Select AuthenticationMethods<br>* Value field click on String Array<br>* Type Basic in value and click on Add+ * Click on Check-In button</p></td><td><p>Needed to authenticate and connect client to Web API.</p></td></tr><tr><td><p>Bulk Request config</p></td><td><p>* If you see IgnoreCacheControlForBulkRequests make sure it is set to True<br>* Otherwise Click on New Attribute button on top and set the value to IgnoreCacheControlForBulkRequests, type to Boolean and value to True<br>* Click on Check-In button</p></td><td><p>Needed for value set URL to get data for multiple points</p></td></tr><tr><td><p>POST Request config</p></td><td><p>* Set EnableCSRFDefense to false</p></td><td><p>Needed for POST to work to avoid 403 suite access denied error</p></td></tr></tbody></table>

## Configure PI Randomizer Interface

Follow these steps to configure the random interface and install it as a Windows service.

1.  Run PI Interface Configuration Utility

2.  Select Interface > New Windows interface instance from a bat file or from an exe file and browse
    to Random interface installation directory typically C:\\Program Files\\PIPC\\Interfaces\\Random
    containing random.exe or random.bat file

3.  Select Host PI data server and click on add

4.  In the general section make sure the point source is R and in the scan frequency, you specify
    the frequency at which random interface will simulate PI points. You can specify multiple
    frequencies

5.  In the Service section make sure tcp/ip is selected as a dependency

## Configure PI Points

PI Interface for Random Simulator Data is installed and configured with PI Data Archive, is an
excellent source of test data. You can configure points to generate various types of randomized
data. The default point source for this interface is R.

Point builder will allow you to configure PI points. Run PI System Management Tools and select
Points > Point Builder . Click on 'New' and provide point details as described in the following
sections.

### General Tab

- Name: it must be a unique name across all points, for example, FlowLevel-M23

- Descriptor: can be used to store some important info such as machine or location where the point
  is attached

- Stored Value: how value is stored in data server, select Real-time data

- Point Source: source of value, for Random interface select R

- Point Class: select Classic

- Point Type: data type of the point such as int, float, string, timestamp, blob or digital

- Digital Set: if the data type is Digital, select the set of value defined in the Digital Set

- Eng Units: engineering unit of the point being measured, for example, PSI for flow, F for
  temperature

### Archive Tab

- Typical Value: typical value of the point, for example, 50

- Zero: minimum value of the point, for example, 10

- Span: maximum value of the point, for example, 100

- Make sure the Scan and Archiving are selected On

### Classic Tab

The values in the Location 1 to 5, depends on the Data Type, Scan Class of the random interface
being used, desired amount of change between each value, and number of value to change before
midpoint resets to current value. Note that not all location values are required for each point. For
example:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Field</th><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><p>Location1</p></td><td></td><td></td></tr><tr><td><p>Location2</p></td><td><p>10</p></td><td><p>If the span is 100, it will allow to change value by 1 in each scan (10*(100/1000)) = 1</p></td></tr><tr><td><p>Location3</p></td><td><p>25</p></td><td><p>After 25 random value it will reset to current value</p></td></tr><tr><td><p>Location4</p></td><td><p>1</p></td><td><p>Scan class of PI point. Look at random.bat or Random interface configuration. This says the PI point will be changed as per line 1, so if that is 30 sec, the PI point value will change every 30 seconds.</p></td></tr><tr><td><p>Location5</p></td><td><p>1</p></td><td><p>Number from 0 to 5 depending on point data type</p></td></tr></tbody></table>

**Digital States configuration**

When point data type is selected as Digital, its value can be one of those specified in a Digital
State.

1.  Select Points > Digital States and click on Add icon.

2.  Name the set and set of state values with state name.

The result should be a Digital State for a Maintenance Status, which can be `0=Active` and
`1=Broken`.

## Use PI Web API to Retrieve Attributes and Values of PI Points

Once PI servers, data server, Web API, random interface and PI points are configured you can use PI
Web API to retrieve and update point attributes and values from PI server. The Web API provides REST
interface to interact with PI server over the web.

The following table describes some of the common endpoints to retrieve PI point information. Note
that each points and assets in PI server is identified using a unique webId.

<table><colgroup><col> <col></colgroup><thead><tr><th>Description</th><th>Web API URL</th></tr></thead><tbody><tr><td><p>PI Web API home page</p></td><td><p><code><a href="https://host:port/piwebapi/">https://host:port/piwebapi/</a></code></p></td></tr><tr><td><p>Get attributes of all PI points</p></td><td><p><code><a href="https://host:port/piwebapi/dataservers/DataServer_webId/points">https://host:port/piwebapi/dataservers/DataServer_webId/points</a></code></p></td></tr><tr><td><p>Get attributes of multiple specified PI points</p></td><td><p><code><a href="https://host:port/piwebapi/points/multiple?webId=Point1_WebId_&amp;webId=Point2_WebId">https://host:port/piwebapi/points/multiple?webId=Point1_WebId_&amp;webId=Point2_WebId</a></code></p></td></tr><tr><td><p>Get value of a specific PI point</p></td><td><p><code><a href="https://host:port/piwebapi/streams/Point_webId/value">https://host:port/piwebapi/streams/Point_webId/value</a></code></p></td></tr><tr><td><p>Get values of multiple specified PI points</p></td><td><p><code><a href="https://host:port/piwebapi/streamsets/value?webId=Point1_webId_&amp;webId=Point2_webId">https://host:port/piwebapi/streamsets/value?webId=Point1_webId_&amp;webId=Point2_webId</a></code></p></td></tr><tr><td><p>Get attributes of multiple specified PI points using POST method</p></td><td><p>POST: <code><a href="https://host:port/piwebapi/batch">https://host:port/piwebapi/batch</a></code><br><code>Body:{ "1" : { "Method": "GET", "Resource": "https://host:port/piwebapi/points/multiple?webId=Point1_webId&amp; webId=Point2webId" } }</code></p></td></tr><tr><td><p>Get data values of multiple specified PI points using POST method</p></td><td><p>POST: <code><a href="https://host:port/piwebapi/batch">https://host:port/piwebapi/batch</a></code><br><code>Body:{ "1" : { "Method": "GET", "Resource": "https://host:port/piwebapi/streamsets/value?webId=Point1_webId&amp;webId=Point2_webId" } }</code></p></td></tr></tbody></table>

## PI Point Configuration for this Use Case

This use case measures vibration delta, temperature, oil level, noise level, and maintenance status
of several machines. The following table describes the configuration of these PI points for one
machine.

<table><colgroup><col> <col> <col> <col> <col> <col></colgroup><thead><tr><th>Attribute</th><th>Point1</th><th>Point2</th><th>Point3</th><th>Point4</th><th>Point5</th></tr></thead><tbody><tr><td colspan="6"><p><em>General Tab</em></p></td></tr><tr><td><p>Name</p></td><td><p>Vibration Delta</p></td><td><p>Temperature</p></td><td><p>Oil Level</p></td><td><p>Noise Level</p></td><td><p>Maintenance Status</p></td></tr><tr><td><p>Descriptor</p></td><td><p>Machine1</p></td><td><p>Machine1</p></td><td><p>Machine1</p></td><td><p>Machine1</p></td><td><p>Machine1</p></td></tr><tr><td><p>Stored Values</p></td><td><p>Real-time data</p></td><td><p>Real-time data</p></td><td><p>Real-time data</p></td><td><p>Real-time data</p></td><td><p>Real-time data</p></td></tr><tr><td><p>Point Source</p></td><td><p>R</p></td><td><p>R</p></td><td><p>R</p></td><td><p>R</p></td><td><p>R</p></td></tr><tr><td><p>Point Class</p></td><td><p>classic</p></td><td><p>classic</p></td><td><p>classic</p></td><td><p>classic</p></td><td><p>classic</p></td></tr><tr><td><p>Point Type</p></td><td><p>Int32</p></td><td><p>Int32</p></td><td><p>Int32</p></td><td><p>Int32</p></td><td><p>Digital</p></td></tr><tr><td><p>Digital Set</p></td><td></td><td></td><td></td><td></td><td><p>MachineStatus</p></td></tr><tr><td><p>Eng Units</p></td><td><p>Hz</p></td><td><p>F</p></td><td><p>Percentage</p></td><td><p>Decibels</p></td><td></td></tr><tr><td><p>Display Digits</p></td><td></td><td></td><td></td><td></td><td></td></tr><tr><td colspan="6"><p><em>Archive Tab</em></p></td></tr><tr><td><p>Typical Value</p></td><td><p>500</p></td><td><p>125</p></td><td><p>50</p></td><td><p>115</p></td><td><p>1</p></td></tr><tr><td><p>Span</p></td><td><p>1000</p></td><td><p>160</p></td><td><p>100</p></td><td><p>160</p></td><td><p>1</p></td></tr><tr><td><p>Zero</p></td><td><p>10</p></td><td><p>90</p></td><td><p>0</p></td><td><p>70</p></td><td><p>0</p></td></tr><tr><td><p>Scan</p></td><td><p>On</p></td><td><p>On</p></td><td><p>On</p></td><td><p>On</p></td><td><p>On</p></td></tr><tr><td><p>Archiving</p></td><td><p>On</p></td><td><p>On</p></td><td><p>On</p></td><td><p>On</p></td><td><p>On</p></td></tr><tr><td colspan="6"><p><em>Classic Tab</em></p></td></tr><tr><td><p>Location1</p></td><td></td><td></td><td></td><td></td><td></td></tr><tr><td><p>Location2</p></td><td></td><td></td><td></td><td></td><td></td></tr><tr><td><p>Location3</p></td><td><p>100</p></td><td><p>100</p></td><td><p>100</p></td><td><p>100</p></td><td></td></tr><tr><td><p>Location4</p></td><td><p>1</p></td><td><p>1</p></td><td><p>1</p></td><td><p>1</p></td><td><p>1</p></td></tr><tr><td><p>Location5</p></td><td><p>2</p></td><td><p>2</p></td><td><p>2</p></td><td><p>2</p></td><td><p>1</p></td></tr><tr><td colspan="6"><p><em>Misc</em></p></td></tr><tr><td><p>Data Type</p></td><td><p>Station Data</p></td><td><p>Station Data</p></td><td><p>Station Data</p></td><td><p>Station Data</p></td><td><p>Random Data</p></td></tr><tr><td><p>Scale</p></td><td></td><td></td><td></td><td></td><td></td></tr></tbody></table>

## See Also

- [Prerequisites](https://docs.mulesoft.com/manufacturing/latest/prerequisites)

- [MuleSoft Accelerator for Manufacturing](https://docs.mulesoft.com/manufacturing/latest/)

<!-- document id=aec459cedde635734f1ec2b725a8552321700e9c91609cee3e6667ab6499fea4 url=/mulesoft/current/en-us/manufacturing/latest/prerequisites.md -->

---
product: Manufacturing
version: 1.4
is-latest-version: true
---

# Prerequisites for MuleSoft Accelerator for Manufacturing

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This page provides a summary of the guides available for configuring the various systems and
products required to implement the use cases provided by this solution. The individual systems
needed, and amount of configuration required, depend on which assets are to be deployed in your
target environment(s) - refer to the use case pages for more details.

## Available Guides

The following setup and configuration guides are available for this accelerator:

- [Accelerator Setup Guide](https://docs.mulesoft.com/manufacturing/latest/mfg-setup-guide)

- [SFTP Setup Guide](https://docs.mulesoft.com/manufacturing/latest/sftp-setup-guide)

- [OSISoft PI Setup Guide for Productive Maintenance](https://docs.mulesoft.com/manufacturing/latest/osisoft-pi-setup-guide)

- [SAP S4HANA Setup Guide for Sales Rebate Management](https://docs.mulesoft.com/manufacturing/latest/sap-s4hana-setup-guide)

- [Tableau Setup Guide for Productive Maintenance](https://docs.mulesoft.com/manufacturing/latest/tableau-setup-guide)

Most of the implementation templates also contain details on requirements specific to those
applications.

## See Also

- [Getting Started](https://docs.mulesoft.com/accelerators-home/getting-started)

- [MuleSoft Accelerator for Manufacturing](https://docs.mulesoft.com/manufacturing/latest/)

<!-- document id=fc38d9088cc5891a1dd568d61897353f866b875590c02c2327e0959938173f61 url=/mulesoft/current/en-us/manufacturing/latest/sap-s4hana-setup-guide.md -->

---
product: Manufacturing
version: 1.4
is-latest-version: true
---

# SAP S4HANA Setup Guide for Sales Rebate Management

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## Communication Arrangements

Below are the configuration arrangements required for this use case:

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Communication Arrangement</th><th>Service Name</th><th>Protocol</th></tr></thead><tbody><tr><td><p>SAP_COM_0002</p></td><td><p>Journal Entry - Post (Synchronous)</p></td><td><p>SOAP</p></td></tr></tbody></table>

## Custom Fields

<table><colgroup><col> <col> <col> <col> <col> <col></colgroup><thead><tr><th>Salesforce Object</th><th>SAP Field Name</th><th>Data Type</th><th>Length</th><th>Unique</th><th>ExternalID</th></tr></thead><tbody><tr><td><p>Rebate Payment</p></td><td><p>YY1_SME_ExtPaymID_MFG</p></td><td><p>Text</p></td><td><p>20</p></td><td><p>Y</p></td><td><p>Y</p></td></tr></tbody></table>

This field is also enabled to be used in the SOAP Service mentioned in the previous section. To do
that, use the Fiori app Custom Fields and Logic, section SOAP APIs. Look for the service and enable
it.

## Custom CDS View

- Name: YY1\_JournalEntryItem\_Info

- Representative Key: AccountingDocument

- Scenario: External API

- Data Source: I\_JournalEntryItem

- Elements:

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Alias</th><th>Path</th><th>Type</th><th>Key</th></tr></thead><tbody><tr><td><p>SourceLedger</p></td><td><p>I_JournalEntryItem.SourceLedger</p></td><td><p>CHAR (2)</p></td><td><p>Yes</p></td></tr><tr><td><p>CompanyCode</p></td><td><p>I_JournalEntryItem.CompanyCode</p></td><td><p>CHAR (4)</p></td><td><p>Yes</p></td></tr><tr><td><p>FiscalYear</p></td><td><p>I_JournalEntryItem.FiscalYear</p></td><td><p>NUMC (4)</p></td><td><p>Yes</p></td></tr><tr><td><p>AccountingDocument</p></td><td><p>I_JournalEntryItem.AccountingDocument</p></td><td><p>CHAR (10)</p></td><td><p>Yes</p></td></tr><tr><td><p>LedgerGLLineItem</p></td><td><p>I_JournalEntryItem.LedgerGLLineItem</p></td><td><p>CHAR(6)</p></td><td><p>Yes</p></td></tr><tr><td><p>Ledger</p></td><td><p>I_JournalEntryItem.Ledger</p></td><td><p>CHAR(2)</p></td><td><p>Yes</p></td></tr><tr><td><p>AccountingDocumentType</p></td><td><p>I_JournalEntryItem.AccountingDocumentType</p></td><td><p>CHAR(2)</p></td><td><p>No</p></td></tr><tr><td><p>Customer</p></td><td><p>I_JournalEntryItem.Customer</p></td><td><p>CHAR(10)</p></td><td><p>No</p></td></tr><tr><td><p>YY1_SME_ExtPaymID_MFG_JEI</p></td><td><p>I_JournalEntryItem.YY1_SME_ExtPaymID_MFG_JEI</p></td><td><p>CHAR(20)</p></td><td><p>No</p></td></tr><tr><td><p>CreationDate</p></td><td><p>I_JournalEntryItem._JournalEntry.AccountingDocumentCreationDate</p></td><td><p>DATS (8)</p></td><td><p>No</p></td></tr><tr><td><p>LastChangeDate</p></td><td><p>I_JournalEntryItem._JournalEntry.LastChangeDate</p></td><td><p>DATS (8)</p></td><td><p>No</p></td></tr><tr><td><p>IsReversed</p></td><td><p>I_JournalEntryItem._JournalEntry.IsReversed</p></td><td><p>CHAR(1)</p></td><td><p>No</p></td></tr><tr><td><p>ReversalReason</p></td><td><p>I_JournalEntryItem._JournalEntry.ReversalReason</p></td><td><p>CHAR(2)</p></td><td><p>No</p></td></tr><tr><td><p>ReverseDocument</p></td><td><p>I_JournalEntryItem._JournalEntry.ReverseDocument</p></td><td><p>CHAR(10)</p></td><td><p>No</p></td></tr><tr><td><p>ClearingDate</p></td><td><p>I_JournalEntryItem.ClearingDate</p></td><td><p>DATS (8)</p></td><td><p>No</p></td></tr><tr><td><p>ClearingAccountingDocument</p></td><td><p>I_JournalEntryItem.ClearingAccountingDocument</p></td><td><p>CHAR(10)</p></td><td><p>No</p></td></tr><tr><td><p>ClearingDocumentLastChangeDate</p></td><td><p>I_JournalEntryItem._ClearingAccountingDocument.LastChangeDate</p></td><td><p>DATS (8)</p></td><td><p>No</p></td></tr><tr><td><p>ClearingDocumentCreationDate</p></td><td><p>I_JournalEntryItem._ClearingAccountingDocument.AccountingDocumentCreationDate</p></td><td><p>DATS (8)</p></td><td><p>No</p></td></tr><tr><td><p>ClearingDocumentCreationTime</p></td><td><p>I_JournalEntryItem._ClearingAccountingDocument.CreationTime</p></td><td><p>TIMS (6)</p></td><td><p>No</p></td></tr><tr><td><p>AmountInCompanyCodeCurrency</p></td><td><p>I_JournalEntryItem._ClearingAccountingDocument._OperationalAcctgDocItem.AmountInCompanyCodeCurrency</p></td><td><p>CURR (23,2)</p></td><td><p>No</p></td></tr><tr><td><p>AmountInTransactionCurrency</p></td><td><p>I_JournalEntryItem._ClearingAccountingDocument._OperationalAcctgDocItem.AmountInTransactionCurrency</p></td><td><p>CURR (23,2)</p></td><td><p>No</p></td></tr><tr><td><p>TransactionCurrency</p></td><td><p>I_JournalEntryItem._ClearingAccountingDocument._OperationalAcctgDocItem.TransactionCurrency</p></td><td><p>CUKY (5)</p></td><td><p>No</p></td></tr><tr><td><p>CompanyCodeCurrency</p></td><td><p>I_JournalEntryItem._ClearingAccountingDocument._OperationalAcctgDocItem.CompanyCodeCurrency</p></td><td><p>CUKY (5)</p></td><td><p>No</p></td></tr></tbody></table>

A custom communication scenario has to be created adding this CDS view as an inbound service. Once
published, create a communication arrangement using that custom communication scenario. That
arrangement will have the service URL to retrieve the Journal Entry Item information.

## See Also

- [Prerequisites](https://docs.mulesoft.com/manufacturing/latest/prerequisites)

- [MuleSoft Accelerator for Manufacturing](https://docs.mulesoft.com/manufacturing/latest/)

<!-- document id=efe01406ba3c60edee3912592aa0a67a78b58685508054a008a735aa20cb9987 url=/mulesoft/current/en-us/manufacturing/latest/sftp-setup-guide.md -->

---
product: Manufacturing
version: 1.4
is-latest-version: true
---

# SFTP Setup Guide

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This setup guide enables customers to upload existing customer, product, and order data to
Manufacturing Cloud via SFTP. Data can be exported in `` csv` `` or `xlsx` format for loading into
Salesforce.

## High-level Architecture

_Load data to Manufacturing Cloud_

![Architecture for loading customer, product, and order data into Manufacturing Cloud through SFTP](/mulesoft/current/en-us/manufacturing/latest/_images/mfg-data-load.png)

### Functional Considerations

- Customer, product and order data needs to be in csv or xlsx format.

- Customer and product data needs be loaded into Manufacturing Cloud before loading order data so
  that orders can be attached existing customers and products.

### Technical Considerations

This section lists the technical considerations and constraints on the solution design.

- The csv and xlsx files need to be in the format specified [below](#file-formats)

- MDM implementation is required in order to reference customer and product data in orders

### Systems Involved

- Salesforce Manufacturing Cloud

- SFTP Server

- PIM Database

- Anypoint MQ

- Global Data Management

### Processing Logic

- SFTP CIM handler reads the files from sftp location and converts the records to respective CIM
  structures and publishes the records to the customers, products and orders exchanges for the
  related objects.

- The corresponding process APIs process the messages in CIM format and insert the data into
  Manufacturing Cloud via the corresponding system APIs.

## SFTP Setup

In your SFTP server create inbox, archive and error folders for customers, products and orders.

## File Configuration

- The sftp integrations can only read comma separated text file with \*.csv extension or Microsoft
  Excel file with \*.xlsx extension

- For excel files, make sure all the data is in one tab and the tab names must be following:
  CustomerInfo, OrderInfo and ProductInfo respectively

### File Formats

#### Customer File Format

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Field Name</th><th>Field Description</th><th>Comments</th></tr></thead><tbody><tr><td><p>ExternalId</p></td><td><p>Customer ID in external system</p></td><td><p>Required field</p></td></tr><tr><td><p>FirstName</p></td><td><p>The first name of the Party</p></td><td><p>Required for individual</p></td></tr><tr><td><p>MiddleName</p></td><td><p>The middle initial of the Party</p></td><td><p>Optional field for individual</p></td></tr><tr><td><p>LastName</p></td><td><p>The last name of the Party</p></td><td><p>Required for individual</p></td></tr><tr><td><p>OrgAccountName</p></td><td><p>Organization name</p></td><td><p>Required for an organization</p></td></tr><tr><td><p>EmailAddress</p></td><td><p>Email address</p></td><td><p>Optional</p></td></tr><tr><td><p>EmailType</p></td><td><p>Email type (examples: Home, Work)</p></td><td><p>Optional</p></td></tr><tr><td><p>PhoneNumber</p></td><td><p>Phone number</p></td><td><p>Optional</p></td></tr><tr><td><p>InternationalCode</p></td><td><p>Phone country code</p></td><td><p>Optional the default is "001"</p></td></tr><tr><td><p>PhoneType</p></td><td><p>Phone Type</p></td><td><p>Optional the default is "Home"</p></td></tr><tr><td><p>PhoneExt</p></td><td><p>Phone extension</p></td><td><p>Optional</p></td></tr><tr><td><p>AddressLine1</p></td><td><p>Address Line</p></td><td><p>Optional</p></td></tr><tr><td><p>AddressLine2</p></td><td><p>Address Line</p></td><td><p>Optional</p></td></tr><tr><td><p>City</p></td><td><p>City name</p></td><td><p>Optional</p></td></tr><tr><td><p>State</p></td><td><p>State or province name</p></td><td><p>Optional</p></td></tr><tr><td><p>Country</p></td><td><p>Country name</p></td><td><p>Optional the default is "USA"</p></td></tr><tr><td><p>PostalCode</p></td><td><p>Postal code</p></td><td><p>Required</p></td></tr><tr><td><p>AddressType</p></td><td><p>Address type (examples: Home, Work)</p></td><td><p>Optional the default is "Home"</p></td></tr></tbody></table>

#### Order File Format

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Field Name</th><th>Field Description</th><th>Comments</th></tr></thead><tbody><tr><td><p>Id</p></td><td><p>Order ID</p></td><td><p>Optional</p></td></tr><tr><td><p>Name</p></td><td><p>Order name</p></td><td><p>Required</p></td></tr><tr><td><p>OrderNumber</p></td><td><p>Order number</p></td><td><p>Required</p></td></tr><tr><td><p>Description</p></td><td><p>Order description</p></td><td><p>Optional</p></td></tr><tr><td><p>TotalPriceAmount</p></td><td><p>Total order cost</p></td><td><p>Required</p></td></tr><tr><td><p>AccountId</p></td><td><p>Account id</p></td><td><p>Required</p></td></tr><tr><td><p>TotalDeliveryFeeAmount</p></td><td><p>Shipping fee</p></td><td><p>Optional</p></td></tr><tr><td><p>EffectiveDate</p></td><td><p>Order date</p></td><td><p>Required</p></td></tr><tr><td><p>ExternalId</p></td><td><p>Order id in external system</p></td><td><p>Optional</p></td></tr><tr><td><p>ProductCode</p></td><td><p>Product sku code of the ordered item</p></td><td><p>Required</p></td></tr><tr><td><p>ProductDescription</p></td><td><p>Product description of the ordered item</p></td><td><p>Optional</p></td></tr><tr><td><p>OrderedQuantity</p></td><td><p>Quantity ordered</p></td><td><p>Required</p></td></tr><tr><td><p>UnitPriceAmount</p></td><td><p>Unit price of the product</p></td><td><p>Required</p></td></tr><tr><td><p>TotalPriceAmount</p></td><td><p>Total cost of all items</p></td><td><p>Required</p></td></tr><tr><td><p>OrderProductNumber</p></td><td><p>Total amount including tax</p></td><td><p>Required</p></td></tr><tr><td><p>TotalTaxAmount</p></td><td><p>Total sales tax</p></td><td><p>Required</p></td></tr></tbody></table>

#### Product File Format

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Field Name</th><th>Field Description</th><th>Comments</th></tr></thead><tbody><tr><td><p>Id</p></td><td><p>Product ID</p></td><td><p>Optional</p></td></tr><tr><td><p>Name</p></td><td><p>Product name</p></td><td><p>Required</p></td></tr><tr><td><p>ProductCode</p></td><td><p>Product sku code</p></td><td><p>Required</p></td></tr><tr><td><p>ProductCategory</p></td><td><p>Product category</p></td><td><p>Optional</p></td></tr><tr><td><p>Description</p></td><td><p>Product description</p></td><td><p>Required</p></td></tr><tr><td><p>ShortDescription</p></td><td><p>Product short description</p></td><td></td></tr><tr><td><p>LongDescription</p></td><td><p>Product long description</p></td><td></td></tr><tr><td><p>Status</p></td><td><p>Product status (example: Active)</p></td><td><p>Required</p></td></tr><tr><td><p>ExternalId</p></td><td><p>Product id in the external system</p></td><td><p>Required</p></td></tr><tr><td><p>Type</p></td><td><p>Product type</p></td><td><p>Required</p></td></tr><tr><td><p>UnitListPrice</p></td><td><p>Product unit price</p></td><td><p>Required</p></td></tr></tbody></table>

## See Also

- [Prerequisites](https://docs.mulesoft.com/manufacturing/latest/prerequisites)

- [MuleSoft Accelerator for Manufacturing](https://docs.mulesoft.com/manufacturing/latest/)

<!-- document id=d3d6ce739df641d22be8540494c6a31ef30938ac344aee198027b7d2dc291e01 url=/mulesoft/current/en-us/manufacturing/latest/tableau-setup-guide.md -->

---
product: Manufacturing
version: 1.4
is-latest-version: true
---

# Tableau Setup Guide for Productive Maintenance

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

## Prerequisites

1.  Users should have an Amazon Redshift connection.

2.  Download and install Tableau Desktop.

3.  Users should have access to Tableau Online.

## Steps to Download and Install Tableau Desktop

1.  Download and install [Tableau Desktop Downloads](https://www.tableau.com/support/releases)

2.  Open Tableau desktop app from your mac or windows.

3.  Click on the **Help** button and select **Manage Product Key**.

4.  Click on **Activate**.

5.  Enter the server details and connect.

6.  Enter the username and password.

7.  Authenticate the details and verify Tableau activated successfully.

## Steps to Import workbook into Tableau Desktop

1.  Click on **File** tab, select **Import Workbook** and browse
    `mfg-tableau-workorders-exp-api/src/main/resources/workbook/FactoryEquipmentDashboard.twbx` file
    and click on the **Open** button.

2.  Edit Amazon Redshift connection details.

![Tableau dialog for editing an Amazon Redshift connection](/mulesoft/current/en-us/manufacturing/latest/_images/mfg-edit-redshift.png)

## Steps to create work order

1.  In the **Submit a Work Order** dialogue box, the user can manage the Priority, Machine Id and
    provide a Reason to submit a work order.

    ![Tableau Submit a Work Order dialog](/mulesoft/current/en-us/manufacturing/latest/_images/mfg-submit-work-order.png)

2.  Click on **Create Work Order** which will create a case in Service Cloud.

## Steps to Publish Workbook into Tableau Online.

1.  Click on **Server** and select **Publish Workbook**.

2.  Click on **Connect**, enter email address and password to sign in.

    ![Tableau Online Publish Workbook dialog](/mulesoft/current/en-us/manufacturing/latest/_images/mfg-tableau-online-publish.png)

3.  In the **Publish Workbook to Tableau Online** window, complete the **Name** and **Description**
    fields.

4.  Click on the **Publish** button.

## Steps to create an alert in Tableau Online

1.  Login into [Tableau Online](https://sso.online.tableau.com/public/idp/SSO)

2.  Click on **Watch** and select **Alerts**

    ![Tableau Online alert configuration](/mulesoft/current/en-us/manufacturing/latest/_images/mfg-tableau-online-alert.png)

3.  Click on the **Create** button on the right side which opens the 'Create Alert' dialogue box.

4.  Users can select the condition and threshold and users can provide the subject details and
    select the alert condition (for example, daily).

5.  Users can provide the recipient details in the **Recipients** field and click on **Create
    Alert**.

6.  An alert will be sent to the recipient.

    ![Email notification for a Tableau alert](/mulesoft/current/en-us/manufacturing/latest/_images/mfg-email-alert.png)

## See Also

- [Prerequisites](https://docs.mulesoft.com/manufacturing/latest/prerequisites)

- [MuleSoft Accelerator for Manufacturing](https://docs.mulesoft.com/manufacturing/latest/)